[
https://issues.apache.org/jira/browse/GOBBLIN-1724?focusedWorklogId=818626&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-818626
]
ASF GitHub Bot logged work on GOBBLIN-1724:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 19/Oct/22 23:01
Start Date: 19/Oct/22 23:01
Worklog Time Spent: 10m
Work Description: Will-Lo commented on code in PR #3583:
URL: https://github.com/apache/gobblin/pull/3583#discussion_r1000002942
##########
gobblin-service/src/main/java/org/apache/gobblin/service/modules/flowgraph/SharedFlowGraphHelper.java:
##########
@@ -0,0 +1,126 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.gobblin.service.modules.flowgraph;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URI;
+import java.util.Map;
+
+import org.apache.commons.io.FilenameUtils;
+import org.apache.hadoop.fs.Path;
+
+import com.google.common.base.Optional;
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+import com.typesafe.config.ConfigValueFactory;
+
+import lombok.extern.slf4j.Slf4j;
+
+import org.apache.gobblin.runtime.api.TopologySpec;
+import
org.apache.gobblin.service.modules.template_catalog.FSFlowTemplateCatalog;
+import org.apache.gobblin.util.ConfigUtils;
+import org.apache.gobblin.util.reflection.GobblinConstructorUtils;
+
+
+/**
+ * Supports a configuration of a flowgraph where it can support multiple
sub-flowgraphs within its directory
+ * Node definitions are shared between each subgraph, but can be overwritten
within the subgraph
+ * Edge definitions are only defined in the subgraphs
+ * e.g.
+ * /gobblin-flowgraph
+ * /subgraphA
+ * /nodeA
+ * /nodeB
+ * edgeAB.properties
+ * /subgraphB
+ * /nodeA
+ * /nodeB
+ * edgeAB.properties
+ * A.properties
+ * /nodes
+ * A.properties
+ * B.properties
+ */
+@Slf4j
+public class SharedFlowGraphHelper extends BaseFlowGraphHelper {
+
+ protected String sharedNodeFolder;
+ private static String NODE_FILE_SUFFIX = ".properties";
+ private static String SHARED_NODE_FOLDER_NAME = "nodes";
+ private static int NODE_FOLDER_DEPTH = 2;
+
+ public SharedFlowGraphHelper(Optional<? extends FSFlowTemplateCatalog>
flowTemplateCatalog,
+ Map<URI, TopologySpec> topologySpecMap, String baseDirectory, String
flowGraphFolderName,
+ String javaPropsExtentions, String hoconFileExtensions, boolean
instrumentationEnabled, Config config) {
+ super(flowTemplateCatalog, topologySpecMap, baseDirectory,
flowGraphFolderName, javaPropsExtentions, hoconFileExtensions,
instrumentationEnabled, config);
+ this.sharedNodeFolder = baseDirectory + File.separator +
SHARED_NODE_FOLDER_NAME;
+ }
+
+ /**
+ * Looks into the sharedNodeFolder to use those configurations as fallbacks
for the node to add
+ * Otherwise if the shared node does not exist, attempt to add the node in
the same manner as {@link BaseFlowGraphHelper}
+ * @param graph
+ * @param path of node folder in the subgraph, so path is expected to be a
directory
+ */
+ @Override
+ protected void addDataNode(FlowGraph graph, java.nio.file.Path path) {
+ try {
+ // Load node from shared folder first if it exists
+ Config sharedNodeConfig = ConfigFactory.empty();
+ String nodePropertyFile = path.getFileName().toString() +
NODE_FILE_SUFFIX;
+ File sharedNodeFile = new File(this.sharedNodeFolder, nodePropertyFile);
+ if (sharedNodeFile.exists()) {
+ sharedNodeConfig = loadNodeFileWithOverrides(new
Path(sharedNodeFile.getPath()));
+ }
+ File nodeFilePath = new File(path.toString(), nodePropertyFile);
+ Config nodeConfig = sharedNodeConfig;
+ if (nodeFilePath.exists()) {
+ nodeConfig = loadNodeFileWithOverrides(new
Path(nodeFilePath.getPath())).withFallback(sharedNodeConfig);
+ }
+ if (nodeConfig.isEmpty()) {
+ throw new IOException(String.format("Cannot find expected property
file %s in %s or %s", nodePropertyFile, sharedNodeFolder, path));
+ }
+ Class dataNodeClass = Class.forName(ConfigUtils.getString(nodeConfig,
FlowGraphConfigurationKeys.DATA_NODE_CLASS,
+ FlowGraphConfigurationKeys.DEFAULT_DATA_NODE_CLASS));
+ DataNode dataNode = (DataNode)
GobblinConstructorUtils.invokeLongestConstructor(dataNodeClass, nodeConfig);
+ if (!graph.addDataNode(dataNode)) {
+ log.warn("Could not add DataNode {} to FlowGraph; skipping",
dataNode.getId());
+ } else {
+ log.info("Added Datanode {} to FlowGraph", dataNode.getId());
+ }
+ } catch (Exception e) {
+ if (this.flowGraphUpdateFailedMeter.isPresent()) {
+ this.flowGraphUpdateFailedMeter.get().mark();
+ }
+ log.warn("Could not add DataNode defined in {} due to exception {}",
path, e);
Review Comment:
The datanode name could be undefined here if there's an exception
Issue Time Tracking
-------------------
Worklog Id: (was: 818626)
Time Spent: 1h 20m (was: 1h 10m)
> Support a flowgraph layout for shared node configurations
> ---------------------------------------------------------
>
> Key: GOBBLIN-1724
> URL: https://issues.apache.org/jira/browse/GOBBLIN-1724
> Project: Apache Gobblin
> Issue Type: Improvement
> Reporter: William Lo
> Priority: Major
> Time Spent: 1h 20m
> Remaining Estimate: 0h
>
> Currently the GaaS Flowgraph assumes that there will be one separate
> flowgraph for each configured use case, but this adds for a large amount of
> duplication when supporting multiple flowgraphs.
> We should support a layout where there can be a directory for shared nodes
> between each flowgraph, and each flowgraph can overwrite properties for these
> nodes if needed.
> e.g.
> {code:java}
> /flowgraph
> ../nodeA
> ..../nodeB
> ......edgeAB.properties
> ../nodeB
> ....nodeB.properties
> /nodes
> ..nodeA.properties
> ..nodeB.properties{code}
> Where nodeA will use the shared properties, and nodeB will use the union of
> the properties in /flowgraph and the shared properties.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
