Make trend charts configurable (with Bootstrap 5)

.github/dependabot.yml

@@ -30,6 +30,9 @@ updates:
       - dependency-name: org.webjars:popper.js
         versions:
           - ">= 2.0.0"
+      - dependency-name: org.webjars:bootstrap
+        versions:
+          - ">= 5.0.0"
 
   - package-ecosystem: "github-actions"
     directory: "/"

plugin/pom.xml

@@ -33,8 +33,8 @@
     <plugin-util-api.version>2.2.0</plugin-util-api.version>
 
     <data-tables-api.version>1.10.23-3</data-tables-api.version>
-    <echarts-api.version>5.1.0-2</echarts-api.version>
     <font-awesome-api.version>5.15.3-2</font-awesome-api.version>
+    <echarts-api.version>5.1.0-3-rc464.d7d9d5650d0a</echarts-api.version>
     <jquery3-api.version>3.6.0-1</jquery3-api.version>
     <bootstrap4-api.version>4.6.0-3</bootstrap4-api.version>
     <popper-api.version>1.16.1-2</popper-api.version>
@@ -109,11 +109,6 @@
         <artifactId>script-security</artifactId>
         <version>${script-security.version}</version>
       </dependency>
-      <dependency>
-        <groupId>io.jenkins.plugins</groupId>
-        <artifactId>popper-api</artifactId>
-        <version>${popper-api.version}</version>
-      </dependency>
       <dependency>
         <groupId>com.google.errorprone</groupId>
         <artifactId>error_prone_annotations</artifactId>
@@ -174,13 +169,12 @@
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
-      <artifactId>bootstrap4-api</artifactId>
-      <version>${bootstrap4-api.version}</version>
+      <artifactId>bootstrap5-api</artifactId>
+      <version>${bootstrap5-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>jquery3-api</artifactId>
-      <version>${jquery3-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>

plugin/src/main/java/io/jenkins/plugins/analysis/core/model/AggregatedTrendAction.java

@@ -22,15 +22,16 @@
 import io.jenkins.plugins.analysis.core.charts.JenkinsBuild;
 import io.jenkins.plugins.analysis.core.charts.ToolsTrendChart;
 import io.jenkins.plugins.analysis.core.util.AnalysisBuildResult;
-import io.jenkins.plugins.echarts.AsyncTrendChart;
+import io.jenkins.plugins.echarts.AsyncConfigurableTrendChart;
 
 /**
  * Project action that renders a combined trend chart of all tools in the job.
  *
  * @author Ullrich Hafner
  */
-public class AggregatedTrendAction implements Action, AsyncTrendChart {
+public class AggregatedTrendAction implements Action, AsyncConfigurableTrendChart {
     private static final int MIN_TOOLS = 2;
+    private static final String EMPTY = "{}";
 
     private final Job<?, ?> owner;
 
@@ -75,19 +76,38 @@ private Set<AnalysisHistory> createBuildHistory() {
         }
     }
 
+    /**
+     * Returns the trend chart model that renders the aggregated build results.
+     *
+     * @return the trend chart
+     * @deprecated replaced {@link #getConfigurableBuildTrendModel(String)}
+     */
+    @Deprecated
+    public String getBuildTrendModel() {
+        return getConfigurableBuildTrendModel(EMPTY);
+    }
+
+    /**
+     * Returns the trend chart model that renders the aggregated build results.
+     *
+     * @param configuration
+     *         JSON configuration of the chart (number of builds, etc.)
+     *
+     * @return the trend chart
+     */
+    @Override
     @JavaScriptMethod
     @SuppressWarnings("unused") // Called by jelly view
-    @Override
-    public String getBuildTrendModel() {
-        return new JacksonFacade().toJson(createChartModel());
+    public String getConfigurableBuildTrendModel(final String configuration) {
+        return new JacksonFacade().toJson(createChartModel(ChartModelConfiguration.fromJson(configuration)));
     }
 
-    private LinesChartModel createChartModel() {
+    private LinesChartModel createChartModel(final ChartModelConfiguration configuration) {
         Run<?, ?> lastBuild = owner.getLastBuild();
         if (lastBuild == null) {
             return new LinesChartModel();
         }
-        return new ToolsTrendChart().create(new CompositeBuildResultsIterable(lastBuild), new ChartModelConfiguration());
+        return new ToolsTrendChart().create(new CompositeBuildResultsIterable(lastBuild), configuration);
     }
 
     @Override
@@ -115,7 +135,8 @@ private static class CompositeBuildResultsIterable implements Iterable<BuildResu
             this.lastBuild = lastBuild;
         }
 
-        @Override @NonNull
+        @Override
+        @NonNull
         public Iterator<BuildResult<AnalysisBuildResult>> iterator() {
             return new CompositeIterator(lastBuild);
         }

plugin/src/main/java/io/jenkins/plugins/analysis/core/model/FileNameRenderer.java

@@ -92,8 +92,8 @@ public DomContent createAffectedFileLink(final Issue issue, final String prefix)
         else if (facade.canAccessAffectedFileOf(build, issue)) {
             return a().withHref(prefix + getSourceCodeUrl(issue))
                     .withText(getFileNameAtLine(issue))
-                    .attr("data-toggle", "tooltip")
-                    .attr("data-placement", "bottom")
+                    .attr("data-bs-toggle", "tooltip")
+                    .attr("data-bs-placement", "left")
                     .withTitle(issue.getFileName());
         }
         else {

plugin/src/main/java/io/jenkins/plugins/analysis/core/model/IssuesDetail.java

@@ -16,7 +16,6 @@
 import edu.hm.hafner.analysis.Report;
 import edu.hm.hafner.analysis.Severity;
 import edu.hm.hafner.echarts.ChartModelConfiguration;
-import edu.hm.hafner.echarts.ChartModelConfiguration.AxisType;
 import edu.hm.hafner.echarts.JacksonFacade;
 
 import org.kohsuke.stapler.StaplerRequest;
@@ -48,10 +47,11 @@
  *
  * @author Ullrich Hafner
  */
-@SuppressWarnings({"PMD.ExcessiveImports", "ClassDataAbstractionCoupling", "ClassFanOutComplexity"})
+@SuppressWarnings({"PMD.ExcessiveImports", "PMD.GodClass", "ClassDataAbstractionCoupling", "ClassFanOutComplexity"})
 public class IssuesDetail extends DefaultAsyncTableContentProvider implements ModelObject {
     private static final ResetQualityGateCommand RESET_QUALITY_GATE_COMMAND = new ResetQualityGateCommand();
     private static final JacksonFacade JACKSON_FACADE = new JacksonFacade();
+    private static final String DEFAULT_CONFIGURATION = "{}";
 
     private final Run<?, ?> owner;
 
@@ -299,15 +299,25 @@ public String getTrendModel() {
      *         determines whether the Jenkins build number should be used on the X-axis or the date
      *
      * @return the UI model as JSON
+     * @deprecated replaced by {@link #getBuildTrend(String)}
      */
-    @JavaScriptMethod
-    @SuppressWarnings("unused") // Called by jelly view
+    @Deprecated @SuppressWarnings("unused")
     public String getBuildTrend(final boolean isBuildOnXAxis) {
-        return createTrendAsJson(new SeverityTrendChart(), isBuildOnXAxis);
+        return createTrendAsJson(new SeverityTrendChart(), DEFAULT_CONFIGURATION);
     }
 
-    private ChartModelConfiguration createChartConfiguration(final boolean isBuildOnXAxis) {
-        return new ChartModelConfiguration(isBuildOnXAxis ? AxisType.BUILD : AxisType.DATE);
+    /**
+     * Returns the UI model for an ECharts line chart that shows the issues stacked by severity.
+     *
+     * @param configuration
+     *         determines whether the Jenkins build number should be used on the X-axis or the date
+     *
+     * @return the UI model as JSON
+     */
+    @JavaScriptMethod
+    @SuppressWarnings("unused") // Called by jelly view
+    public String getBuildTrend(final String configuration) {
+        return createTrendAsJson(new SeverityTrendChart(), configuration);
     }
 
     /**
@@ -317,11 +327,25 @@ private ChartModelConfiguration createChartConfiguration(final boolean isBuildOn
      *         determines whether the Jenkins build number should be used on the X-axis or the date
      *
      * @return the UI model as JSON
+     * @deprecated replaced by {@link #getToolsTrend(String)}
+     */
+    @Deprecated @SuppressWarnings("unused")
+    public String getToolsTrend(final boolean isBuildOnXAxis) {
+        return createTrendAsJson(new ToolsTrendChart(), DEFAULT_CONFIGURATION);
+    }
+
+    /**
+     * Returns the UI model for an ECharts line chart that shows the issues by tool.
+     *
+     * @param configuration
+     *         determines whether the Jenkins build number should be used on the X-axis or the date
+     *
+     * @return the UI model as JSON
      */
     @JavaScriptMethod
     @SuppressWarnings("unused") // Called by jelly view
-    public String getToolsTrend(final boolean isBuildOnXAxis) {
-        return createTrendAsJson(new ToolsTrendChart(), isBuildOnXAxis);
+    public String getToolsTrend(final String configuration) {
+        return createTrendAsJson(new ToolsTrendChart(), configuration);
     }
 
     /**
@@ -331,11 +355,25 @@ public String getToolsTrend(final boolean isBuildOnXAxis) {
      *         determines whether the Jenkins build number should be used on the X-axis or the date
      *
      * @return the UI model as JSON
+     * @deprecated replaced by {@link #getNewVersusFixedTrend(String)}
+     */
+    @Deprecated @SuppressWarnings("unused")
+    public String getNewVersusFixedTrend(final boolean isBuildOnXAxis) {
+        return createTrendAsJson(new NewVersusFixedTrendChart(), DEFAULT_CONFIGURATION);
+    }
+
+    /**
+     * Returns the UI model for an ECharts line chart that shows the new and fixed issues.
+     *
+     * @param configuration
+     *         determines whether the Jenkins build number should be used on the X-axis or the date
+     *
+     * @return the UI model as JSON
      */
     @JavaScriptMethod
     @SuppressWarnings("unused") // Called by jelly view
-    public String getNewVersusFixedTrend(final boolean isBuildOnXAxis) {
-        return createTrendAsJson(new NewVersusFixedTrendChart(), isBuildOnXAxis);
+    public String getNewVersusFixedTrend(final String configuration) {
+        return createTrendAsJson(new NewVersusFixedTrendChart(), configuration);
     }
 
     /**
@@ -345,11 +383,25 @@ public String getNewVersusFixedTrend(final boolean isBuildOnXAxis) {
      *         determines whether the Jenkins build number should be used on the X-axis or the date
      *
      * @return the UI model as JSON
+     * @deprecated replaced by {@link #getHealthTrend(String)}
+     */
+    @Deprecated @SuppressWarnings("unused")
+    public String getHealthTrend(final boolean isBuildOnXAxis) {
+        return createTrendAsJson(new HealthTrendChart(healthDescriptor), DEFAULT_CONFIGURATION);
+    }
+
+    /**
+     * Returns the UI model for an ECharts line chart that shows the issues by tool.
+     *
+     * @param configuration
+     *         determines whether the Jenkins build number should be used on the X-axis or the date
+     *
+     * @return the UI model as JSON
      */
     @JavaScriptMethod
     @SuppressWarnings("unused") // Called by jelly view
-    public String getHealthTrend(final boolean isBuildOnXAxis) {
-        return createTrendAsJson(new HealthTrendChart(healthDescriptor), isBuildOnXAxis);
+    public String getHealthTrend(final String configuration) {
+        return createTrendAsJson(new HealthTrendChart(healthDescriptor), configuration);
     }
 
     /**
@@ -362,10 +414,10 @@ public boolean isHealthReportEnabled() {
         return healthDescriptor.isEnabled();
     }
 
-    private String createTrendAsJson(final TrendChart trendChart, final boolean isBuildOnXAxis) {
+    private String createTrendAsJson(final TrendChart trendChart, final String configuration) {
         History history = new AnalysisHistory(owner, new ByIdResultSelector(result.getId()));
 
-        return new JacksonFacade().toJson(trendChart.create(history, createChartConfiguration(isBuildOnXAxis)));
+        return new JacksonFacade().toJson(trendChart.create(history, ChartModelConfiguration.fromJson(configuration)));
     }
 
     /**

plugin/src/main/java/io/jenkins/plugins/analysis/core/model/JobAction.java

@@ -6,7 +6,6 @@
 import edu.hm.hafner.echarts.BuildResult;
 import edu.hm.hafner.echarts.ChartModelConfiguration;
 import edu.hm.hafner.echarts.JacksonFacade;
-import edu.hm.hafner.echarts.LinesChartModel;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 
 import org.kohsuke.stapler.StaplerRequest;
@@ -17,19 +16,23 @@
 import hudson.model.Run;
 import jenkins.model.Jenkins;
 
+import io.jenkins.plugins.analysis.core.charts.HealthTrendChart;
+import io.jenkins.plugins.analysis.core.charts.NewVersusFixedTrendChart;
 import io.jenkins.plugins.analysis.core.charts.SeverityTrendChart;
 import io.jenkins.plugins.analysis.core.charts.ToolsTrendChart;
+import io.jenkins.plugins.analysis.core.charts.TrendChart;
 import io.jenkins.plugins.analysis.core.util.AnalysisBuildResult;
 import io.jenkins.plugins.analysis.core.util.TrendChartType;
-import io.jenkins.plugins.echarts.AsyncTrendChart;
+import io.jenkins.plugins.echarts.AsyncConfigurableTrendChart;
 
 /**
  * A job action displays a link on the side panel of a job. This action also is responsible to render the historical
- * trend via its associated 'floatingBox.jelly' view.
+ * trend via its associated 'charts.jelly' view.
  *
  * @author Ullrich Hafner
  */
-public class JobAction implements Action, AsyncTrendChart {
+public class JobAction implements Action, AsyncConfigurableTrendChart {
+    private static final JacksonFacade JACKSON_FACADE = new JacksonFacade();
     private final Job<?, ?> owner;
     private final StaticAnalysisLabelProvider labelProvider;
     private final int numberOfTools;
@@ -42,6 +45,7 @@ public class JobAction implements Action, AsyncTrendChart {
      *         the job that owns this action
      * @param labelProvider
      *         the label provider
+     *
      * @deprecated use {@link #JobAction(Job, StaticAnalysisLabelProvider, int)}
      */
     @Deprecated
@@ -178,18 +182,50 @@ public Optional<ResultAction> getLatestAction() {
         return createBuildHistory().getBaselineAction();
     }
 
-    @JavaScriptMethod
-    @Override
+    /**
+     * Returns the trend chart model that renders the aggregated build results.
+     *
+     * @return the trend chart
+     * @deprecated replaced {@link #getConfigurableBuildTrendModel(String)}
+     */
+    @Deprecated
     public String getBuildTrendModel() {
-        return new JacksonFacade().toJson(createChartModel());
+        return getConfigurableBuildTrendModel("{}");
+    }
+
+    /**
+     * Returns the trend chart model that renders the build results for a specific action.
+     *
+     * @param configuration
+     *         JSON configuration of the chart (number of builds, etc.)
+     *
+     * @return the trend chart
+     */
+    @Override
+    @JavaScriptMethod
+    @SuppressWarnings("unused") // Called by jelly view
+    public String getConfigurableBuildTrendModel(final String configuration) {
+        String chartType = JACKSON_FACADE.getString(configuration, "chartType", "severity");
+
+        return new JacksonFacade().toJson(selectChart(chartType).create(
+                createBuildHistory(), ChartModelConfiguration.fromJson(configuration)));
     }
 
-    private LinesChartModel createChartModel() {
+    private TrendChart selectChart(final String chartType) {
+        if ("new".equals(chartType)) {
+            return new NewVersusFixedTrendChart();
+        }
+        if ("health".equals(chartType)) {
+            Optional<ResultAction> latestAction = getLatestAction();
+            if (latestAction.isPresent()) {
+                return new HealthTrendChart(latestAction.get().getHealthDescriptor());
+            }
+        }
         if (numberOfTools > 1) {
-            return new ToolsTrendChart().create(createBuildHistory(), new ChartModelConfiguration());
+            return new ToolsTrendChart();
         }
         else {
-            return new SeverityTrendChart().create(createBuildHistory(), new ChartModelConfiguration());
+            return new SeverityTrendChart();
         }
     }
 

plugin/src/main/java/io/jenkins/plugins/analysis/core/model/ResultAction.java

@@ -195,6 +195,10 @@ public HealthReport getBuildHealth() {
                 getResult().getSizePerSeverity());
     }
 
+    HealthDescriptor getHealthDescriptor() {
+        return healthDescriptor;
+    }
+
     @Override
     public Collection<? extends Action> getProjectActions() {
         return Collections.singleton(