diff --git a/engine/src/main/java/org/apache/hop/core/metadata/SerializableMetadataProvider.java b/engine/src/main/java/org/apache/hop/core/metadata/SerializableMetadataProvider.java index d1c0d5e4559..2f37fc57f41 100644 --- a/engine/src/main/java/org/apache/hop/core/metadata/SerializableMetadataProvider.java +++ b/engine/src/main/java/org/apache/hop/core/metadata/SerializableMetadataProvider.java @@ -148,14 +148,24 @@ public SerializableMetadataProvider(String storeJson) throws HopException { while (jsonParser.nextToken() != JsonToken.END_OBJECT) { String classKey = jsonParser.getText(); + if (jsonParser.nextToken() != JsonToken.START_ARRAY) { + throw new HopException("Expected a metadata array for key " + classKey); + } + + // Snapshots include empty arrays for optional plugins which may not be installed here. + // There is no metadata to load, so these types don't need to be resolved. + // + if (jsonParser.nextToken() == JsonToken.END_ARRAY) { + continue; + } Class managedClass = getManagedClass(classKey); if (managedClass == null) { - // Skip this JSON Array - jsonParser.nextToken(); // skip "{" - while (jsonParser.nextToken() != JsonToken.END_ARRAY) { - // Go to END_ARRAY - } + // Skip complete objects, including nested arrays, before advancing to the next type. + // + do { + jsonParser.skipChildren(); + } while (jsonParser.nextToken() != JsonToken.END_ARRAY); continue; } @@ -166,13 +176,12 @@ public SerializableMetadataProvider(String storeJson) throws HopException { // Loop over the metadata objects in the JSON for the given class... // - jsonParser.nextToken(); // skip "{" - while (jsonParser.nextToken() != JsonToken.END_ARRAY) { + do { IHopMetadata object = metadataParser.loadJsonObject(managedClass, jsonParser); if (object != null) { serializer.save(object); } - } + } while (jsonParser.nextToken() != JsonToken.END_ARRAY); } } } catch (Exception e) { diff --git a/engine/src/test/java/org/apache/hop/core/metadata/SerializableMetadataProviderTest.java b/engine/src/test/java/org/apache/hop/core/metadata/SerializableMetadataProviderTest.java index 66b8dc0efe5..b09ba06d3ef 100644 --- a/engine/src/test/java/org/apache/hop/core/metadata/SerializableMetadataProviderTest.java +++ b/engine/src/test/java/org/apache/hop/core/metadata/SerializableMetadataProviderTest.java @@ -120,6 +120,108 @@ public IHopMetadataSerializer getSerializer( assertNotNull(roundTripped.getSerializer(HopServerMeta.class).load("server1")); } + @Test + void testEmptyUnknownTypesDoNotRequirePlugins() throws Exception { + final var json = + """ + { + "salesforceconnection": [], + "server": [{"name": "server1", "hostname": "localhost"}], + "neo4j-connection": [] + } + """; + final var provider = + new SerializableMetadataProvider(json) { + @Override + public Class getMetadataClassForKey(final String key) + throws HopException { + assertEquals("server", key, "Empty types must not require a registered plugin"); + return super.getMetadataClassForKey(key); + } + }; + + final var server = provider.getSerializer(HopServerMeta.class).load("server1"); + assertNotNull(server); + assertEquals("localhost", server.getHostname()); + } + + @Test + void testUnavailableNeo4jConnectionWithManualUrlsIsSkipped() throws Exception { + // Shape from integration-tests/neo4j/metadata/neo4j-connection/Test.json. + final var json = + """ + { + "neo4j-connection": [ + { + "server": "${NEO_HOSTNAME}", + "browserPort": "7474", + "databaseName": "", + "manualUrls": [], + "automaticVariable": "", + "usingEncryption": false, + "routing": true, + "name": "Test", + "username": "${NEO_USERNAME}" + } + ], + "server": [{"name": "server1", "hostname": "localhost"}] + } + """; + + assertServerAfterUnavailableConnection(json, "neo4j-connection"); + } + + @Test + void testUnavailableGraphDatabaseConnectionWithManualUrlsIsSkipped() throws Exception { + // Shape from plugins/tech/neo4j/src/main/samples/metadata/ + // graph-database-connection/demo-neo4j.json. + final var json = + """ + { + "graph-database-connection": [ + { + "graphDatabase": { + "NEO4J": { + "databaseName": "", + "manualUrls": [], + "automaticVariable": "", + "server": "${NEO4J_HOSTNAME}", + "boltPort": "${NEO4J_PORT}", + "automatic": true, + "protocol": "neo4j", + "routing": false, + "usingEncryption": false + } + }, + "name": "demo-neo4j" + } + ], + "server": [{"name": "server1", "hostname": "localhost"}] + } + """; + + assertServerAfterUnavailableConnection(json, "graph-database-connection"); + } + + private void assertServerAfterUnavailableConnection( + final String json, final String unavailableKey) throws Exception { + final var provider = + new SerializableMetadataProvider(json) { + @Override + public Class getMetadataClassForKey(final String key) + throws HopException { + if (unavailableKey.equals(key)) { + throw new HopException("Metadata plugin is not installed: " + key); + } + return super.getMetadataClassForKey(key); + } + }; + + final var server = provider.getSerializer(HopServerMeta.class).load("server1"); + assertNotNull(server); + assertEquals("localhost", server.getHostname()); + } + /** Delegates everything but throws when one specific object is loaded. */ private static class FailingOnLoadSerializer implements IHopMetadataSerializer {