Remove Jackson usage as intermediary (#892)

Author: lewisbirks

.gitignore

@@ -22,3 +22,6 @@ src/main/webapp/js/bundles
 .factorypath
 
 *.dylib
+
+# macOS
+.DS_Store

src/main/java/io/jenkins/plugins/pipelinegraphview/consoleview/PipelineConsoleViewAction.java

@@ -1,7 +1,5 @@
 package io.jenkins.plugins.pipelinegraphview.consoleview;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Plugin;
@@ -37,6 +35,7 @@
 import java.util.List;
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
+import net.sf.json.JsonConfig;
 import org.jenkins.ui.icon.IconSpec;
 import org.jenkinsci.plugins.pipeline.modeldefinition.actions.RestartDeclarativePipelineAction;
 import org.jenkinsci.plugins.workflow.cps.replay.ReplayAction;
@@ -58,7 +57,12 @@ public class PipelineConsoleViewAction implements Action, IconSpec {
     public static final String URL_NAME = "pipeline-overview";
 
     private static final Logger logger = LoggerFactory.getLogger(PipelineConsoleViewAction.class);
-    private static final ObjectMapper MAPPER = new ObjectMapper();
+    private static final JsonConfig jsonConfig = new JsonConfig();
+
+    static {
+        PipelineStepList.PipelineStepListJsonProcessor.configure(jsonConfig);
+        PipelineGraph.PipelineGraphJsonProcessor.configure(jsonConfig);
+    }
 
     private final PipelineGraphApi graphApi;
     private final WorkflowRun run;
@@ -84,7 +88,7 @@ public String getUrlName() {
     // running).
     @GET
     @WebMethod(name = "steps")
-    public HttpResponse getSteps(StaplerRequest2 req) throws IOException {
+    public HttpResponse getSteps(StaplerRequest2 req) {
         String nodeId = req.getParameter("nodeId");
         if (nodeId != null) {
             return HttpResponses.okJSON(getSteps(nodeId));
@@ -93,32 +97,28 @@ public HttpResponse getSteps(StaplerRequest2 req) throws IOException {
         }
     }
 
-    private JSONObject getSteps(String nodeId) throws IOException {
+    private JSONObject getSteps(String nodeId) {
         logger.debug("getSteps was passed nodeId '{}'.", nodeId);
         PipelineStepList steps = stepApi.getSteps(nodeId);
-        String stepsJson = MAPPER.writeValueAsString(steps);
-        if (logger.isDebugEnabled()) {
-            logger.debug("Steps for {}: '{}'.", nodeId, stepsJson);
-        }
-        return JSONObject.fromObject(stepsJson);
+        JSONObject json = JSONObject.fromObject(steps, jsonConfig);
+        logger.debug("Steps for {}: '{}'.", nodeId, json);
+        return json;
     }
 
     // Return all steps to:
     // - reduce number of API calls
     // - remove dependency of getting list of stages in frontend.
     @GET
     @WebMethod(name = "allSteps")
-    public HttpResponse getAllSteps(StaplerRequest2 req) throws IOException {
+    public HttpResponse getAllSteps(StaplerRequest2 req) {
         return HttpResponses.okJSON(getAllSteps());
     }
 
-    private JSONObject getAllSteps() throws IOException {
+    private JSONObject getAllSteps() {
         PipelineStepList steps = stepApi.getAllSteps();
-        String stepsJson = MAPPER.writeValueAsString(steps);
-        if (logger.isDebugEnabled()) {
-            logger.debug("Steps: '{}'.", stepsJson);
-        }
-        return JSONObject.fromObject(stepsJson);
+        JSONObject json = JSONObject.fromObject(steps, jsonConfig);
+        logger.debug("Steps: '{}'.", json);
+        return json;
     }
 
     @WebMethod(name = "log")
@@ -148,8 +148,8 @@ public void getConsoleText(StaplerRequest2 req, StaplerResponse2 rsp) throws IOE
         // Potentially a stage, so get the log text for the stage.
         boolean foundLogs = false;
         PipelineStepList steps = stepApi.getSteps(nodeId);
-        for (PipelineStep step : steps.getSteps()) {
-            logText = getLogForNode(step.getId());
+        for (PipelineStep step : steps.steps) {
+            logText = getLogForNode(step.id);
             if (logText != null) {
                 foundLogs = true;
                 logText.writeLogTo(0L, rsp.getOutputStream());
@@ -471,14 +471,13 @@ public String getNextBuildNumber() {
 
     @GET
     @WebMethod(name = "tree")
-    public HttpResponse getTree() throws JsonProcessingException {
+    public HttpResponse getTree() {
         if (run == null) {
             return HttpResponses.errorJSON("No run to get tree for");
         }
         run.checkPermission(Item.READ);
         PipelineGraph tree = graphApi.createTree();
-        String graph = MAPPER.writeValueAsString(tree);
-        return HttpResponses.okJSON(JSONObject.fromObject(graph));
+        return HttpResponses.okJSON(JSONObject.fromObject(tree, jsonConfig));
     }
 
     // Icon related methods these may appear as unused but are used by /lib/hudson/buildCaption.jelly

src/main/java/io/jenkins/plugins/pipelinegraphview/multipipelinegraphview/MultiPipelineGraphViewAction.java

@@ -1,16 +1,14 @@
 package io.jenkins.plugins.pipelinegraphview.multipipelinegraphview;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import hudson.model.Action;
 import hudson.model.Item;
 import hudson.security.Permission;
 import hudson.util.HttpResponses;
 import hudson.util.RunList;
 import io.jenkins.plugins.pipelinegraphview.PipelineGraphViewConfiguration;
-import java.util.ArrayList;
 import java.util.List;
 import net.sf.json.JSONArray;
+import net.sf.json.JsonConfig;
 import org.jenkins.ui.icon.IconSpec;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
@@ -19,7 +17,6 @@
 import org.kohsuke.stapler.verb.GET;
 
 public class MultiPipelineGraphViewAction implements Action, IconSpec {
-    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
     private static final int MaxNumberOfElements = 10;
 
     private final WorkflowJob target;
@@ -59,24 +56,22 @@ public boolean isShowStageDurations() {
         return PipelineGraphViewConfiguration.get().isShowStageDurations();
     }
 
+    private static final JsonConfig jsonConfig = new JsonConfig();
+
+    static {
+        PipelineRun.PipelineRunJsonProcessor.configure(jsonConfig);
+    }
+
     @GET
     @WebMethod(name = "runs")
-    public HttpResponse getRuns() throws JsonProcessingException {
+    public HttpResponse getRuns() {
         RunList<WorkflowRun> runs = target.getBuilds();
-        List<PipelineRun> pipelineRuns = new ArrayList<>();
-        for (WorkflowRun run : runs) {
-            pipelineRuns.add(new PipelineRun(run));
-            if (pipelineRuns.size() >= MaxNumberOfElements) break;
-        }
-        JSONArray graph = createJson(pipelineRuns);
+        List<PipelineRun> pipelineRuns =
+                runs.stream().limit(MaxNumberOfElements).map(PipelineRun::new).toList();
+        JSONArray graph = JSONArray.fromObject(pipelineRuns, jsonConfig);
         return HttpResponses.okJSON(graph);
     }
 
-    protected JSONArray createJson(List<PipelineRun> pipelineRuns) throws JsonProcessingException {
-        String graph = OBJECT_MAPPER.writeValueAsString(pipelineRuns);
-        return JSONArray.fromObject(graph);
-    }
-
     public String getJobUrl() {
         return target.getUrl();
     }

src/main/java/io/jenkins/plugins/pipelinegraphview/multipipelinegraphview/PipelineRun.java

@@ -3,6 +3,9 @@
 import static io.jenkins.plugins.pipelinegraphview.utils.ChangesUtil.getChanges;
 
 import io.jenkins.plugins.pipelinegraphview.utils.PipelineState;
+import net.sf.json.JSONObject;
+import net.sf.json.JsonConfig;
+import net.sf.json.processors.JsonBeanProcessor;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 
 public class PipelineRun {
@@ -46,4 +49,27 @@ public int getChangesCount() {
     public PipelineState getResult() {
         return result;
     }
+
+    public static class PipelineRunJsonProcessor implements JsonBeanProcessor {
+
+        public static void configure(JsonConfig config) {
+            config.registerJsonBeanProcessor(PipelineRun.class, new PipelineRunJsonProcessor());
+            PipelineState.PipelineStateJsonProcessor.configure(config);
+        }
+
+        @Override
+        public JSONObject processBean(Object bean, JsonConfig jsonConfig) {
+            if (!(bean instanceof PipelineRun run)) {
+                return null;
+            }
+            JSONObject json = new JSONObject();
+            json.element("id", run.getId());
+            json.element("displayName", run.getDisplayName());
+            json.element("timestamp", run.getTimestamp());
+            json.element("duration", run.getDuration());
+            json.element("changesCount", run.getChangesCount());
+            json.element("result", run.getResult(), jsonConfig);
+            return json;
+        }
+    }
 }

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

@@ -1,16 +1,19 @@
 package io.jenkins.plugins.pipelinegraphview.utils;
 
 import io.jenkins.plugins.pipelinegraphview.analysis.TimingInfo;
+import net.sf.json.JSONObject;
+import net.sf.json.JsonConfig;
+import net.sf.json.processors.JsonBeanProcessor;
 
 public class AbstractPipelineNode {
-    private String name;
-    private PipelineState state;
-    private String type; // TODO enum
-    private String title;
-    private String id;
-    private long pauseDurationMillis;
-    private long totalDurationMillis;
-    private TimingInfo timingInfo;
+    final String name;
+    final PipelineState state;
+    final String type; // TODO enum
+    final String title;
+    public final String id;
+    private final long pauseDurationMillis;
+    private final long totalDurationMillis;
+    final TimingInfo timingInfo;
 
     public AbstractPipelineNode(
             String id, String name, PipelineState state, String type, String title, TimingInfo timingInfo) {
@@ -25,10 +28,6 @@ public AbstractPipelineNode(
         this.totalDurationMillis = timingInfo.getTotalDurationMillis();
     }
 
-    public long getPauseDurationMillis() {
-        return pauseDurationMillis;
-    }
-
     public long getStartTimeMillis() {
         return timingInfo.getStartTimeMillis();
     }
@@ -37,27 +36,23 @@ public Long getTotalDurationMillis() {
         return state.isInProgress() ? null : totalDurationMillis;
     }
 
-    public String getId() {
-        return id;
-    }
-
-    public String getName() {
-        return name;
-    }
-
-    public PipelineState getState() {
-        return state;
-    }
-
-    public String getType() {
-        return type;
-    }
-
-    public String getTitle() {
-        return title;
-    }
-
-    protected TimingInfo getTimingInfo() {
-        return this.timingInfo;
+    abstract static class AbstractPipelineNodeJsonProcessor implements JsonBeanProcessor {
+
+        protected static void baseConfigure(JsonConfig config) {
+            config.registerJsonValueProcessor(PipelineState.class, new PipelineState.PipelineStateJsonProcessor());
+        }
+
+        protected JSONObject create(AbstractPipelineNode node, JsonConfig config) {
+            JSONObject json = new JSONObject();
+            json.element("id", node.id);
+            json.element("name", node.name);
+            json.element("state", node.state, config);
+            json.element("type", node.type);
+            json.element("title", node.title);
+            json.element("pauseDurationMillis", node.pauseDurationMillis);
+            json.element("startTimeMillis", node.getStartTimeMillis());
+            json.element("totalDurationMillis", node.getTotalDurationMillis());
+            return json;
+        }
     }
 }

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

@@ -1,22 +1,35 @@
 package io.jenkins.plugins.pipelinegraphview.utils;
 
 import java.util.List;
+import net.sf.json.JSONObject;
+import net.sf.json.JsonConfig;
+import net.sf.json.processors.JsonBeanProcessor;
 
 public class PipelineGraph {
 
-    private List<PipelineStage> stages;
-    private boolean complete = false;
+    final List<PipelineStage> stages;
+    private final boolean complete;
 
     public PipelineGraph(List<PipelineStage> stages, boolean complete) {
         this.stages = stages;
         this.complete = complete;
     }
 
-    public boolean isComplete() {
-        return complete;
-    }
+    public static class PipelineGraphJsonProcessor implements JsonBeanProcessor {
+        public static void configure(JsonConfig config) {
+            config.registerJsonBeanProcessor(PipelineGraph.class, new PipelineGraphJsonProcessor());
+            PipelineStage.PipelineStageJsonProcessor.configure(config);
+        }
 
-    public List<PipelineStage> getStages() {
-        return stages;
+        @Override
+        public JSONObject processBean(Object bean, JsonConfig jsonConfig) {
+            if (!(bean instanceof PipelineGraph graph)) {
+                return null;
+            }
+            JSONObject json = new JSONObject();
+            json.element("complete", graph.complete);
+            json.element("stages", graph.stages, jsonConfig);
+            return json;
+        }
     }
 }

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

@@ -93,7 +93,7 @@ private PipelineGraph createTree(PipelineGraphBuilderApi builder) {
 
                     return pipelineStageInternal.toPipelineStage(children, runUrl);
                 })
-                .filter(stage -> !childNodes.contains(stage.getId()))
+                .filter(stage -> !childNodes.contains(stage.id))
                 .collect(Collectors.toList());
         return new PipelineGraph(stageResults, execution.isComplete());
     }

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

@@ -1,3 +1,27 @@
 package io.jenkins.plugins.pipelinegraphview.utils;
 
-public record PipelineInputStep(String message, String cancel, String id, String ok, boolean parameters) {}
+import net.sf.json.JSONObject;
+import net.sf.json.JsonConfig;
+import net.sf.json.processors.JsonBeanProcessor;
+
+public record PipelineInputStep(String message, String cancel, String id, String ok, boolean parameters) {
+    public static class PipelineInputStepJsonProcessor implements JsonBeanProcessor {
+        @Override
+        public JSONObject processBean(Object bean, JsonConfig jsonConfig) {
+            if (!(bean instanceof PipelineInputStep input)) {
+                return null;
+            }
+            JSONObject json = new JSONObject();
+            json.element("message", input.message());
+            json.element("cancel", input.cancel());
+            json.element("id", input.id());
+            json.element("ok", input.ok());
+            json.element("parameters", input.parameters());
+            return json;
+        }
+
+        public static void configure(JsonConfig config) {
+            config.registerJsonBeanProcessor(PipelineInputStep.class, new PipelineInputStepJsonProcessor());
+        }
+    }
+}