feat: implement usage quota for AI provider calls with configuration by shenxianpeng · Pull Request #136 · jenkinsci/explain-error-plugin

shenxianpeng · 2026-04-07T21:02:10Z

closes #132

Testing done

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

src/main/java/io/jenkins/plugins/explain_error/GlobalConfigurationImpl.java

Copilot

Pull request overview

Implements an optional, controller-scoped usage quota to limit real AI provider calls (while keeping cache hits free), helping administrators control cost/usage across the Jenkins controller.

Changes:

Adds global quota configuration (enable flag, window size, max calls) and UI fields in global config.
Introduces QuotaEnforcer + QuotaWindow and enforces quota checks before provider calls in ErrorExplainer.
Extends test coverage to validate quota-rejected behavior, quota-disabled behavior, and “cache hit does not consume quota”.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/main/java/io/jenkins/plugins/explain_error/GlobalConfigurationImpl.java	Stores quota settings and exposes UI binding/validation endpoints + `tryAcquireQuota()`
src/main/java/io/jenkins/plugins/explain_error/ErrorExplainer.java	Applies quota enforcement for pipeline-step and console-action provider calls
src/main/java/io/jenkins/plugins/explain_error/QuotaEnforcer.java	Thread-safe rolling-window counter for quota enforcement
src/main/java/io/jenkins/plugins/explain_error/QuotaWindow.java	Defines HOURLY/DAILY windows and their durations
src/main/resources/io/jenkins/plugins/explain_error/GlobalConfigurationImpl/config.jelly	Adds quota configuration controls to Jenkins global config UI
src/test/java/io/jenkins/plugins/explain_error/UsageTrackingTest.java	Adds quota-related usage-event assertions and cache-hit behavior validation
src/test/java/io/jenkins/plugins/explain_error/QuotaEnforcerTest.java	Adds unit tests for quota enforcement and reset behavior
src/test/java/io/jenkins/plugins/explain_error/GlobalConfigurationImplTest.java	Verifies default quota values and persistence of quota settings

Copilot · 2026-04-07T21:15:03Z

src/main/java/io/jenkins/plugins/explain_error/GlobalConfigurationImpl.java

+    public ListBoxModel doFillQuotaWindowItems() {
+        ListBoxModel items = new ListBoxModel();
+        for (QuotaWindow window : QuotaWindow.values()) {
+            items.add(window.getDisplayName(), window.name());
+        }
+        return items;
+    }
+
+    public FormValidation doCheckMaxProviderCallsPerWindow(@QueryParameter int value) {
+        if (value < 0) {
+            return FormValidation.error("Max provider calls per window must be 0 or greater.");
+        }
+        return FormValidation.ok();
+    }


doFillQuotaWindowItems and doCheckMaxProviderCallsPerWindow are exposed Stapler endpoints but currently lack the @POST annotation and any permission check/suppression. In this codebase, comparable descriptor validation endpoints use @POST (and either check Jenkins.ADMINISTER or explicitly suppress the permission-check warning). Please align these methods with that pattern to avoid CSRF / permission-audit findings.

Copilot · 2026-04-07T21:15:03Z

src/main/java/io/jenkins/plugins/explain_error/ErrorExplainer.java

@@ -118,6 +118,17 @@ String explainError(Run<?, ?> run, TaskListener listener, String logPattern, int
            String effectiveCustomContext = StringUtils.isNotBlank(customContext) ? customContext : GlobalConfigurationImpl.get().getCustomContext();
            logToConsole(listener, "Custom context source: " + resolveCustomContextSource(customContext) + ".");

+            // Check quota before making a real provider call
+            if (!GlobalConfigurationImpl.get().tryAcquireQuota()) {
+                GlobalConfigurationImpl config = GlobalConfigurationImpl.get();
+                String msg = "Provider call quota exceeded. Limit: " + config.getMaxProviderCallsPerWindow()
+                        + " calls per " + config.getQuotaWindow().getDisplayName().toLowerCase() + " window.";
+                logToConsole(listener, msg);
+                recordUsage(entryPoint, UsageEvent.Result.QUOTA_REJECTED, provider, startTimeNanos,
+                        inputLogLineCount, collectDownstreamLogs);
+                return null;
+            }


Quota is checked only after running log extraction/filtering. When quota is exhausted, this still performs potentially expensive PipelineLogExtractor work even though the provider call will be rejected. Consider moving the quota check earlier (before extracting logs) so quota-rejected requests are cheap and reduce controller load under sustained quota exhaustion.

Copilot · 2026-04-07T21:15:03Z

src/test/java/io/jenkins/plugins/explain_error/QuotaEnforcerTest.java

+    void windowRolloverResetsCount() throws InterruptedException {
+        // Use a very short custom duration to simulate window rollover without waiting an hour.
+        // We do this by resetting the enforcer, which simulates a fresh window.
+        QuotaEnforcer enforcer = new QuotaEnforcer();
+
+        // Fill up the window
+        assertTrue(enforcer.tryAcquire(QuotaWindow.HOURLY, 1));
+        assertFalse(enforcer.tryAcquire(QuotaWindow.HOURLY, 1));
+
+        // Simulate rollover by resetting
+        enforcer.reset();
+


This test’s comment says it uses a “very short custom duration” to simulate rollover, but the implementation actually just calls reset(). Also, the test declares throws InterruptedException without sleeping/waiting. Please update the comment/signature so the test accurately reflects the behavior being verified.

src/main/java/io/jenkins/plugins/explain_error/BillingReconciliationManagementLink.java

src/main/java/io/jenkins/plugins/explain_error/ExplainErrorFolderProperty.java

…options

…provider usage statistics

…perty in ExplainErrorFolderProperty

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>

…ction" This reverts commit 0a43b02.

shenxianpeng added the enhancement For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Apr 7, 2026

github-advanced-security bot found potential problems Apr 7, 2026

View reviewed changes

src/main/java/io/jenkins/plugins/explain_error/GlobalConfigurationImpl.java Fixed Show fixed Hide fixed

src/main/java/io/jenkins/plugins/explain_error/GlobalConfigurationImpl.java Fixed Show fixed Hide fixed

shenxianpeng requested a review from Copilot April 7, 2026 21:10

Copilot started reviewing on behalf of shenxianpeng April 7, 2026 21:11 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

shenxianpeng force-pushed the fix-132 branch from 796c3d3 to 099cc3b Compare April 7, 2026 21:22

shenxianpeng marked this pull request as ready for review April 7, 2026 22:18

shenxianpeng requested a review from a team as a code owner April 7, 2026 22:18

github-code-quality bot found potential problems Apr 8, 2026

View reviewed changes

src/main/java/io/jenkins/plugins/explain_error/BillingReconciliationManagementLink.java Fixed Show fixed Hide fixed

src/main/java/io/jenkins/plugins/explain_error/ExplainErrorFolderProperty.java Fixed Show fixed Hide fixed

shenxianpeng added 2 commits April 8, 2026 14:31

feat: implement usage quota for AI provider calls with configuration …

181f0fc

…options

feat: add billing reconciliation management link and recorder for AI …

992a351

…provider usage statistics

shenxianpeng force-pushed the fix-132 branch from d458a95 to 992a351 Compare April 8, 2026 11:31

shenxianpeng and others added 5 commits April 8, 2026 14:55

refactor: remove redundant method declaration for findActiveFolderPro…

c91a5b4

…perty in ExplainErrorFolderProperty

Potential fix for pull request finding 'Useless parameter'

7c49080

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>

fix: address spotbugs findings in billing recorder

b0a68ba

fix: restore config validation endpoints and cheap quota rejection

0a43b02

Revert "fix: restore config validation endpoints and cheap quota reje…

8ab8f6e

…ction" This reverts commit 0a43b02.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: implement usage quota for AI provider calls with configuration#136

feat: implement usage quota for AI provider calls with configuration#136
shenxianpeng wants to merge 7 commits intomainfrom
fix-132

shenxianpeng commented Apr 7, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

shenxianpeng commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing done

Submitter checklist

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shenxianpeng commented Apr 7, 2026 •

edited

Loading