refactor(gms): reorganize GMS factory namespace

Fixes #1658
datahub-project · Oct 6, 2020 · e838767 · e838767
1 parent 8d30bd4
commit e838767
Show file tree

Hide file tree

Showing 21 changed files with 61 additions and 499 deletions.
diff --git a/datahub-web/yarn.lock b/datahub-web/yarn.lock
diff --git a/docs/how/entity-onboarding.md b/docs/how/entity-onboarding.md
@@ -29,7 +29,7 @@ Refer to [graph onboarding](graph-onboarding.md) if you need to perform graph qu
 See [`CorpUsers`] for an example of top-level [resource endpoint]. Optionally add an aspect-specific [sub-resource endpoint] such as [`CorpUsersEditableInfoResource`].
 
 ## 6. Configure dependency injection
-GMS uses [Spring Framework](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) for dependency injection. You'll need to add [various factories](https://github.com/linkedin/datahub/tree/master/gms/factories/src/main/java/com/linkedin/identity/factory) to create any custom DAOs used by the rest.li endpoint. You'll also need to add any custom package to the `base-package` of `<context:component-scan>` tag in [beans.xml](https://github.com/linkedin/datahub/blob/master/gms/war/src/main/webapp/WEB-INF/beans.xml)
+GMS uses [Spring Framework](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) for dependency injection. You'll need to add [various factories](https://github.com/linkedin/datahub/tree/master/gms/factories/src/main/java/com/linkedin/gms/factory) to create any custom DAOs used by the rest.li endpoint. You'll also need to add any custom package to the `base-package` of `<context:component-scan>` tag in [beans.xml](https://github.com/linkedin/datahub/blob/master/gms/war/src/main/webapp/WEB-INF/beans.xml)
 
 ## 7. UI for entity onboarding [WIP]
 

diff --git a/...on/factory/KafkaEventProducerFactory.java → ...ory/common/KafkaEventProducerFactory.java b/...on/factory/KafkaEventProducerFactory.java → ...ory/common/KafkaEventProducerFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.common.factory;
+package com.linkedin.gms.factory.common;
 
 import io.confluent.kafka.serializers.KafkaAvroSerializer;
 import io.confluent.kafka.serializers.AbstractKafkaAvroSerDeConfig;

diff --git a/...actory/LocalEbeanServerConfigFactory.java → ...common/LocalEbeanServerConfigFactory.java b/...actory/LocalEbeanServerConfigFactory.java → ...common/LocalEbeanServerConfigFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.common.factory;
+package com.linkedin.gms.factory.common;
 
 import io.ebean.config.ServerConfig;
 import io.ebean.datasource.DataSourceConfig;

diff --git a/...in/common/factory/Neo4jDriverFactory.java → ...ms/factory/common/Neo4jDriverFactory.java b/...in/common/factory/Neo4jDriverFactory.java → ...ms/factory/common/Neo4jDriverFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.common.factory;
+package com.linkedin.gms.factory.common;
 
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Driver;

diff --git a/...n/factory/RestHighLevelClientFactory.java → ...ry/common/RestHighLevelClientFactory.java b/...n/factory/RestHighLevelClientFactory.java → ...ry/common/RestHighLevelClientFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.common.factory;
+package com.linkedin.gms.factory.common;
 
 import javax.annotation.Nonnull;
 

diff --git a/...ommon/factory/TopicConventionFactory.java → ...actory/common/TopicConventionFactory.java b/...ommon/factory/TopicConventionFactory.java → ...actory/common/TopicConventionFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.common.factory;
+package com.linkedin.gms.factory.common;
 
 import com.linkedin.mxe.TopicConvention;
 import com.linkedin.mxe.TopicConventionImpl;

diff --git a/.../factory/DataPlatformLocalDaoFactory.java → ...platform/DataPlatformLocalDaoFactory.java b/.../factory/DataPlatformLocalDaoFactory.java → ...platform/DataPlatformLocalDaoFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.dataplatform.factory;
+package com.linkedin.gms.factory.dataplatform;
 
 import com.linkedin.common.urn.DataPlatformUrn;
 import com.linkedin.metadata.aspect.DataPlatformAspect;

diff --git a/...rocess/factory/DataProcessDAOFactory.java → ...ry/dataprocess/DataProcessDAOFactory.java b/...rocess/factory/DataProcessDAOFactory.java → ...ry/dataprocess/DataProcessDAOFactory.java
@@ -1,6 +1,6 @@
-package com.linkedin.dataprocess.factory;
+package com.linkedin.gms.factory.dataprocess;
 
-import com.linkedin.common.factory.TopicConventionFactory;
+import com.linkedin.gms.factory.common.TopicConventionFactory;
 import com.linkedin.common.urn.DataProcessUrn;
 import com.linkedin.metadata.aspect.DataProcessAspect;
 import com.linkedin.metadata.dao.EbeanLocalDAO;

diff --git a/.../factory/DataProcessSearchDAOFactory.java → ...aprocess/DataProcessSearchDAOFactory.java b/.../factory/DataProcessSearchDAOFactory.java → ...aprocess/DataProcessSearchDAOFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.dataprocess.factory;
+package com.linkedin.gms.factory.dataprocess;
 
 import com.linkedin.metadata.configs.DataProcessSearchConfig;
 import com.linkedin.metadata.dao.search.ESSearchDAO;

diff --git a/...aset/factory/DatasetBrowseDAOFactory.java → ...tory/dataset/DatasetBrowseDAOFactory.java b/...aset/factory/DatasetBrowseDAOFactory.java → ...tory/dataset/DatasetBrowseDAOFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.dataset.factory;
+package com.linkedin.gms.factory.dataset;
 
 import com.linkedin.metadata.configs.DatasetBrowseConfig;
 import com.linkedin.metadata.dao.browse.ESBrowseDAO;

diff --git a/...in/dataset/factory/DatasetDaoFactory.java → ...ms/factory/dataset/DatasetDaoFactory.java b/...in/dataset/factory/DatasetDaoFactory.java → ...ms/factory/dataset/DatasetDaoFactory.java
@@ -1,6 +1,6 @@
-package com.linkedin.dataset.factory;
+package com.linkedin.gms.factory.dataset;
 
-import com.linkedin.common.factory.TopicConventionFactory;
+import com.linkedin.gms.factory.common.TopicConventionFactory;
 import com.linkedin.common.urn.DatasetUrn;
 import com.linkedin.metadata.aspect.DatasetAspect;
 import com.linkedin.metadata.dao.EbeanLocalDAO;

diff --git a/...taset/factory/DatasetQueryDaoFactory.java → ...ctory/dataset/DatasetQueryDaoFactory.java b/...taset/factory/DatasetQueryDaoFactory.java → ...ctory/dataset/DatasetQueryDaoFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.dataset.factory;
+package com.linkedin.gms.factory.dataset;
 
 import com.linkedin.metadata.dao.Neo4jQueryDAO;
 import org.neo4j.driver.Driver;

diff --git a/...aset/factory/DatasetSearchDAOFactory.java → ...tory/dataset/DatasetSearchDAOFactory.java b/...aset/factory/DatasetSearchDAOFactory.java → ...tory/dataset/DatasetSearchDAOFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.dataset.factory;
+package com.linkedin.gms.factory.dataset;
 
 import com.linkedin.metadata.configs.DatasetSearchConfig;
 import com.linkedin.metadata.dao.search.ESSearchDAO;

diff --git a/...identity/factory/CorpGroupDaoFactory.java → ...factory/identity/CorpGroupDaoFactory.java b/...identity/factory/CorpGroupDaoFactory.java → ...factory/identity/CorpGroupDaoFactory.java
@@ -1,6 +1,6 @@
-package com.linkedin.identity.factory;
+package com.linkedin.gms.factory.identity;
 
-import com.linkedin.common.factory.TopicConventionFactory;
+import com.linkedin.gms.factory.common.TopicConventionFactory;
 import com.linkedin.common.urn.CorpGroupUrn;
 import com.linkedin.metadata.aspect.CorpGroupAspect;
 import com.linkedin.metadata.dao.EbeanLocalDAO;

diff --git a/...ty/factory/CorpGroupSearchDaoFactory.java → ...y/identity/CorpGroupSearchDaoFactory.java b/...ty/factory/CorpGroupSearchDaoFactory.java → ...y/identity/CorpGroupSearchDaoFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.identity.factory;
+package com.linkedin.gms.factory.identity;
 
 import com.linkedin.metadata.configs.CorpGroupSearchConfig;
 import com.linkedin.metadata.dao.search.ESSearchDAO;

diff --git a/.../identity/factory/CorpUserDaoFactory.java → .../factory/identity/CorpUserDaoFactory.java b/.../identity/factory/CorpUserDaoFactory.java → .../factory/identity/CorpUserDaoFactory.java
@@ -1,6 +1,6 @@
-package com.linkedin.identity.factory;
+package com.linkedin.gms.factory.identity;
 
-import com.linkedin.common.factory.TopicConventionFactory;
+import com.linkedin.gms.factory.common.TopicConventionFactory;
 import com.linkedin.common.urn.CorpuserUrn;
 import com.linkedin.metadata.aspect.CorpUserAspect;
 import com.linkedin.metadata.dao.EbeanLocalDAO;

diff --git a/...ity/factory/CorpUserSearchDaoFactory.java → ...ry/identity/CorpUserSearchDaoFactory.java b/...ity/factory/CorpUserSearchDaoFactory.java → ...ry/identity/CorpUserSearchDaoFactory.java
@@ -1,4 +1,4 @@
-package com.linkedin.identity.factory;
+package com.linkedin.gms.factory.identity;
 
 import com.linkedin.metadata.configs.CorpUserSearchConfig;
 import com.linkedin.metadata.dao.search.ESSearchDAO;

diff --git a/gms/war/src/main/webapp/WEB-INF/beans.xml b/gms/war/src/main/webapp/WEB-INF/beans.xml
@@ -4,7 +4,7 @@
        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"
        default-lazy-init="true">
 
-    <context:component-scan base-package="com.linkedin.common.factory,com.linkedin.dataset.factory,com.linkedin.identity.factory,com.linkedin.dataprocess.factory" />
+    <context:component-scan base-package="com.linkedin.gms.factory" />
 
     <!-- An InjectResourceFactory must be created.  It is ApplicationContextAware so
     must be instantiated via spring and then passed into rest.li -->

diff --git a/...ae-consumer-job/src/main/java/com/linkedin/metadata/kafka/config/ElasticSearchConfig.java b/...ae-consumer-job/src/main/java/com/linkedin/metadata/kafka/config/ElasticSearchConfig.java
@@ -5,7 +5,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 
-import com.linkedin.common.factory.RestHighLevelClientFactory;
+import com.linkedin.gms.factory.common.RestHighLevelClientFactory;
 import com.linkedin.metadata.builders.search.RegisteredIndexBuilders;
 import com.linkedin.metadata.builders.search.SnapshotProcessor;
 import com.linkedin.metadata.utils.elasticsearch.ElasticsearchConnector;

diff --git a/...a-jobs/mae-consumer-job/src/main/java/com/linkedin/metadata/kafka/config/Neo4jConfig.java b/...a-jobs/mae-consumer-job/src/main/java/com/linkedin/metadata/kafka/config/Neo4jConfig.java
@@ -5,7 +5,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 
-import com.linkedin.common.factory.Neo4jDriverFactory;
+import com.linkedin.gms.factory.common.Neo4jDriverFactory;
 import com.linkedin.metadata.dao.internal.BaseGraphWriterDAO;
 import com.linkedin.metadata.dao.internal.Neo4jGraphWriterDAO;