add doc

finos · Nov 14, 2023 · 431dede · 431dede
1 parent 0f5afed
commit 431dede
Show file tree

Hide file tree

Showing 10 changed files with 161 additions and 49 deletions.
diff --git a/docs/connection/new-connection-framework.md b/docs/connection/new-connection-framework.md
diff --git a/...g/finos/legend/engine/language/pure/compiler/toPureGraph/ConnectionCompilerExtension.java b/...g/finos/legend/engine/language/pure/compiler/toPureGraph/ConnectionCompilerExtension.java
@@ -41,6 +41,7 @@ public Iterable<? extends Processor<?>> getExtraProcessors()
                 Connection.class,
                 (element, context) ->
                 {
+                    // @HACKY: new-connection-framework
                     Root_meta_pure_metamodel_connection_Connection metamodel = new Root_meta_pure_metamodel_connection_Connection_Impl(element.name, null, context.pureModel.getClass("meta::pure::metamodel::connection::Connection"))._name(element.name);
                     connectionsIndex.put(context.pureModel.buildPackageString(element._package, element.name), metamodel);
                     metamodel._rawValue(element);

diff --git a/.../org/finos/legend/engine/language/pure/grammar/to/ConnectionGrammarComposerExtension.java b/.../org/finos/legend/engine/language/pure/grammar/to/ConnectionGrammarComposerExtension.java
@@ -68,7 +68,7 @@ private static String renderElement(Connection element, PureGrammarComposerConte
         String value;
         try
         {
-            // This is very super hacky!
+            // @HACKY: new-connection-framework
             element.sourceInformation = null;
             ObjectMapper objectMapper = PureProtocolObjectMapperFactory.getNewObjectMapper();
             objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

diff --git a/...-xt-connection-pure-metamodel/src/main/resources/core_connection_metamodel/metamodel.pure b/...-xt-connection-pure-metamodel/src/main/resources/core_connection_metamodel/metamodel.pure
@@ -14,5 +14,6 @@
 
 Class meta::pure::metamodel::connection::Connection extends PackageableElement
 {
+    // @HACKY: new-connection-framework
     rawValue: Any[1];
 }
diff --git a/...finos/legend/engine/language/pure/compiler/toPureGraph/AuthenticationStrategyBuilder.java b/...finos/legend/engine/language/pure/compiler/toPureGraph/AuthenticationStrategyBuilder.java
@@ -59,6 +59,7 @@ public Root_meta_pure_alloy_connections_alloy_authentication_AuthenticationStrat
             Root_meta_pure_alloy_connections_alloy_authentication_AuthenticationConfigurationWrapper wrapper = new Root_meta_pure_alloy_connections_alloy_authentication_AuthenticationConfigurationWrapper_Impl("", null, context.pureModel.getClass("meta::pure::alloy::connections::alloy::authentication::AuthenticationConfigurationWrapper"));
             try
             {
+                // @HACKY: new-connection-framework
                 ObjectMapper objectMapper = PureProtocolObjectMapperFactory.getNewObjectMapper();
                 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
                 objectMapper.enable(SerializationFeature.INDENT_OUTPUT);

diff --git a/...inos/legend/engine/language/pure/compiler/toPureGraph/DatasourceSpecificationBuilder.java b/...inos/legend/engine/language/pure/compiler/toPureGraph/DatasourceSpecificationBuilder.java
@@ -51,6 +51,7 @@ public Root_meta_pure_alloy_connections_alloy_specification_DatasourceSpecificat
         if (datasourceSpecification instanceof ConnectionSpecificationWrapper)
         {
             Root_meta_pure_alloy_connections_alloy_specification_ConnectionSpecificationWrapper wrapper = new Root_meta_pure_alloy_connections_alloy_specification_ConnectionSpecificationWrapper_Impl("", null, context.pureModel.getClass("meta::pure::alloy::connections::alloy::specification::ConnectionSpecificationWrapper"));
+            // @HACKY: new-connection-framework
             try
             {
                 ObjectMapper objectMapper = PureProtocolObjectMapperFactory.getNewObjectMapper();

diff --git a/...ava/org/finos/legend/engine/language/pure/grammar/to/HelperRelationalGrammarComposer.java b/...ava/org/finos/legend/engine/language/pure/grammar/to/HelperRelationalGrammarComposer.java
@@ -650,7 +650,7 @@ public static String visitRelationalDatabaseConnectionDatasourceSpecification(Da
             String value;
             try
             {
-                // This is very super hacky!
+                // @HACKY: new-connection-framework
                 _spec.sourceInformation = null;
                 ObjectMapper objectMapper = PureProtocolObjectMapperFactory.getNewObjectMapper();
                 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
@@ -713,7 +713,7 @@ public static String visitRelationalDatabaseConnectionAuthenticationStrategy(Aut
             String value;
             try
             {
-                // This is very super hacky!
+                // @HACKY: new-connection-framework
                 _auth.sourceInformation = null;
                 ObjectMapper objectMapper = PureProtocolObjectMapperFactory.getNewObjectMapper();
                 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

diff --git a/...lement/store/relational/connection/authentication/AuthenticationConfigurationWrapper.java b/...lement/store/relational/connection/authentication/AuthenticationConfigurationWrapper.java
@@ -43,6 +43,8 @@ public AuthenticationConfigurationWrapper deserialize(JsonParser jsonParser, Des
             AuthenticationConfigurationWrapper wrapper = new AuthenticationConfigurationWrapper();
             JsonNode node = jsonParser.getCodec().readTree(jsonParser);
             JsonNode valueNode = node.get("value");
+            // @HACKY: new-connection-framework
+            // NOTE: we do this so we can be lazy about compilation, Pure metamodel graph will treat the content as a string
             if (valueNode.isTextual())
             {
                 wrapper.value = PureProtocolObjectMapperFactory.getNewObjectMapper().readValue(valueNode.asText(), AuthenticationConfiguration.class);

diff --git a/...ableElement/store/relational/connection/specification/ConnectionSpecificationWrapper.java b/...ableElement/store/relational/connection/specification/ConnectionSpecificationWrapper.java
@@ -43,6 +43,8 @@ public ConnectionSpecificationWrapper deserialize(JsonParser jsonParser, Deseria
             ConnectionSpecificationWrapper wrapper = new ConnectionSpecificationWrapper();
             JsonNode node = jsonParser.getCodec().readTree(jsonParser);
             JsonNode valueNode = node.get("value");
+            // @HACKY: new-connection-framework
+            // NOTE: we do this so we can be lazy about compilation, Pure metamodel graph will treat the content as a string
             if (valueNode.isTextual())
             {
                 wrapper.value = PureProtocolObjectMapperFactory.getNewObjectMapper().readValue(valueNode.asText(), ConnectionSpecification.class);

diff --git a/...sources/core_relational/relational/protocols/pure/vX_X_X/models/metamodel_connection.pure b/...sources/core_relational/relational/protocols/pure/vX_X_X/models/metamodel_connection.pure
@@ -66,6 +66,7 @@ Class meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::a
 
 Class meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::alloy::authentication::AuthenticationConfigurationWrapper extends meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::alloy::authentication::AuthenticationStrategy
 {
+    // @HACKY: new-connection-framework
     value : String[1];
 }
 
@@ -84,6 +85,7 @@ Class meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::a
 
 Class meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::alloy::specification::ConnectionSpecificationWrapper extends meta::protocols::pure::vX_X_X::metamodel::store::relational::connection::alloy::specification::DatasourceSpecification
 {
+    // @HACKY: new-connection-framework
     value : String[1];
 }