Include synthetic stages in graph and console logs (#86)

Author: mikedld

src/main/frontend/pipeline-console-view/pipeline-console/main/DataTreeView.tsx

@@ -35,6 +35,10 @@ export interface TreeItemData {
   children: TreeItemData[];
 }
 
+interface StageTreeItemProps extends TreeItemProps {
+  synthetic?: boolean;
+}
+
 // Tree Item for stages
 const StageTreeItem = withStyles((theme: Theme) =>
   createStyles({
@@ -49,8 +53,12 @@ const StageTreeItem = withStyles((theme: Theme) =>
       paddingLeft: 18,
       borderLeft: `1px dashed ${fade(theme.palette.text.primary, 0.4)}`,
     },
+    label: {
+      fontStyle: (props: StageTreeItemProps) =>
+        props.synthetic ? "italic" : "inherit",
+    },
   })
-)((props: TreeItemProps) => <TreeItem {...props} />);
+)((props: StageTreeItemProps) => <TreeItem {...props} />);
 
 // Tree Item for steps
 const StepTreeItem = withStyles((theme: Theme) =>
@@ -93,6 +101,7 @@ const getTreeItemsFromStage = (
         nodeId={String(stageItemData.id)}
         label={stageItemData.name}
         children={children}
+        synthetic={stageItemData.synthetic}
       />
     );
   });

src/main/frontend/pipeline-graph-view/pipeline-graph/main/PipelineGraphModel.tsx

@@ -53,6 +53,7 @@ export interface StageInfo {
   children: Array<StageInfo>; // Used by the top-most stages with parallel branches
   nextSibling?: StageInfo; // Used within a parallel branch to denote sequential stages
   isSequential?: boolean;
+  synthetic?: boolean;
 }
 
 interface BaseNodeInfo {

src/main/frontend/pipeline-graph-view/pipeline-graph/main/support/labels.tsx

@@ -77,6 +77,9 @@ export function BigLabel({
   ) {
     classNames.push("selected");
   }
+  if (details.stage && details.stage.synthetic) {
+    classNames.push("synthetic");
+  }
 
   return (
     <TruncatingLabel

src/main/frontend/pipeline-graph-view/pipeline-graph/styles/PipelineGraphWidget.scss

@@ -142,6 +142,10 @@ circle.halo {
   font-weight: bold;
 }
 
+.PWGx-pipeline-big-label.synthetic {
+  font-style: italic;
+}
+
 .PWGx-pipeline-small-label.selected {
   font-weight: bold;
   margin-top: 3px;

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/FlowNodeWrapper.java

@@ -277,4 +277,8 @@ public void setPipelineActions(Collection<Action> pipelineActions) {
   public String getArgumentsAsString() {
     return PipelineNodeUtil.getArgumentsAsString(node);
   }
+
+  public boolean isSynthetic() {
+    return PipelineNodeUtil.isSyntheticStage(node);
+  }
 }

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineGraphApi.java

@@ -46,8 +46,8 @@ private List<PipelineStageInternal> getPipelineNodes() {
                   50, // TODO how ???
                   flowNodeWrapper.getType().name(),
                   flowNodeWrapper
-                      .getDisplayName() // TODO blue ocean uses timing information: "Passed in 0s"
-                  );
+                      .getDisplayName(), // TODO blue ocean uses timing information: "Passed in 0s"
+                  flowNodeWrapper.isSynthetic());
             })
         .collect(Collectors.toList());
   }

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineNodeGraphVisitor.java

@@ -137,9 +137,6 @@ public void chunkStart(
               startNode.getId(), startNode.getDisplayName(), startNode.getDisplayFunctionName()));
     }
 
-    if (PipelineNodeUtil.isSyntheticStage(startNode)) {
-      return;
-    }
     if (NotExecutedNodeAction.isExecuted(startNode)) {
       firstExecuted = startNode;
     }
@@ -174,8 +171,6 @@ public void chunkEnd(
     // if block stage node push it to stack as it may have nested stages
     if (parallelEnds.isEmpty()
         && endNode instanceof StepEndNode
-        && !PipelineNodeUtil.isSyntheticStage(
-            ((StepEndNode) endNode).getStartNode()) // skip synthetic stages
         && PipelineNodeUtil.isStage(((StepEndNode) endNode).getStartNode())) {
 
       // XXX: There seems to be bug in eventing, chunkEnd is sent twice for the same FlowNode
@@ -214,10 +209,6 @@ protected void handleChunkDone(@NonNull MemoryFlowChunk chunk) {
               chunk.getFirstNode().getDisplayFunctionName()));
     }
 
-    if (PipelineNodeUtil.isSyntheticStage(chunk.getFirstNode())) {
-      return;
-    }
-
     boolean parallelNestedStages = false;
 
     // it's nested stages inside parallel so let's collect them later

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineNodeUtil.java

@@ -27,14 +27,20 @@
 /** @author Vivek Pandey */
 public class PipelineNodeUtil {
 
+  private static final String DECLARATIVE_DISPLAY_NAME_PREFIX = "Declarative: ";
+
   public static String getDisplayName(@NonNull FlowNode node) {
     ThreadNameAction threadNameAction = node.getAction(ThreadNameAction.class);
-    return threadNameAction != null ? threadNameAction.getThreadName() : node.getDisplayName();
+    String name =
+        threadNameAction != null ? threadNameAction.getThreadName() : node.getDisplayName();
+    return isSyntheticStage(node) && name.startsWith(DECLARATIVE_DISPLAY_NAME_PREFIX)
+        ? name.substring(DECLARATIVE_DISPLAY_NAME_PREFIX.length())
+        : name;
   }
 
   public static boolean isStage(FlowNode node) {
     return node != null
-        && ((node.getAction(StageAction.class) != null && !isSyntheticStage(node))
+        && ((node.getAction(StageAction.class) != null)
             || (node.getAction(LabelAction.class) != null
                 && node.getAction(ThreadNameAction.class) == null));
   }

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineStage.java

@@ -14,6 +14,7 @@ public class PipelineStage {
   private String seqContainerName;
   private final PipelineStage nextSibling;
   private boolean sequential;
+  private boolean synthetic;
 
   public PipelineStage(
       String id,
@@ -25,7 +26,8 @@ public PipelineStage(
       String title,
       String seqContainerName,
       PipelineStage nextSibling,
-      boolean sequential) {
+      boolean sequential,
+      boolean synthetic) {
     this.id = id;
     this.name = name;
     this.children = children;
@@ -36,6 +38,7 @@ public PipelineStage(
     this.seqContainerName = seqContainerName;
     this.nextSibling = nextSibling;
     this.sequential = sequential;
+    this.synthetic = synthetic;
   }
 
   public PipelineStage getNextSibling() {
@@ -79,4 +82,8 @@ public String getType() {
   public String getTitle() {
     return title;
   }
+
+  public boolean isSynthetic() {
+    return synthetic;
+  }
 }

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineStageInternal.java

@@ -15,6 +15,7 @@ public class PipelineStageInternal {
   private String seqContainerName;
   private PipelineStageInternal nextSibling;
   private boolean sequential;
+  private boolean synthetic;
 
   public PipelineStageInternal(
       String id,
@@ -23,14 +24,16 @@ public PipelineStageInternal(
       String state,
       int completePercent,
       String type,
-      String title) {
+      String title,
+      boolean synthetic) {
     this.id = id;
     this.name = name;
     this.parents = parents;
     this.state = state;
     this.completePercent = completePercent;
     this.type = type;
     this.title = title;
+    this.synthetic = synthetic;
   }
 
   public boolean isSequential() {
@@ -105,6 +108,14 @@ public String getTitle() {
     return title;
   }
 
+  public boolean isSynthetic() {
+    return synthetic;
+  }
+
+  public void setSynthetic(boolean synthetic) {
+    this.synthetic = synthetic;
+  }
+
   public PipelineStage toPipelineStage(List<PipelineStage> children) {
     return new PipelineStage(
         id,
@@ -116,6 +127,7 @@ public PipelineStage toPipelineStage(List<PipelineStage> children) {
         title,
         seqContainerName,
         nextSibling != null ? nextSibling.toPipelineStage(Collections.emptyList()) : null,
-        sequential);
+        sequential,
+        synthetic);
   }
 }