feat: enhance IssuesProcessor to return label creation date and events, add stale label event checks

.licenses/npm/@actions/http-client-3.0.1.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: "@actions/http-client"
-version: 3.0.2
+version: 3.0.1
 type: npm
 summary: Actions Http Client
 homepage: https://github.com/actions/toolkit/tree/main/packages/http-client

.licenses/npm/fast-xml-parser.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: fast-xml-parser
-version: 5.3.4
+version: 5.3.3
 type: npm
 summary: Validate XML, Parse XML, Build XML without C/C++ based libraries
 homepage:

.licenses/npm/undici-6.23.0.dep.yml

@@ -1,34 +0,0 @@
----
-name: undici
-version: 6.23.0
-type: npm
-summary: An HTTP/1.1 client, written from scratch for Node.js
-homepage: https://undici.nodejs.org
-license: mit
-licenses:
-- sources: LICENSE
-  text: |
-    MIT License
-
-    Copyright (c) Matteo Collina and Undici contributors
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE.
-- sources: README.md
-  text: MIT
-notices: []

__tests__/classes/issues-processor-mock.ts

@@ -4,6 +4,7 @@ import {IComment} from '../../src/interfaces/comment';
 import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
 import {IPullRequest} from '../../src/interfaces/pull-request';
 import {IState} from '../../src/interfaces/state/state';
+import {IIssueEvent} from '../../src/interfaces/issue-event';
 
 export class IssuesProcessorMock extends IssuesProcessor {
   constructor(
@@ -17,7 +18,15 @@ export class IssuesProcessorMock extends IssuesProcessor {
     getLabelCreationDate?: (
       issue: Issue,
       label: string
-    ) => Promise<string | undefined>,
+    ) =>
+      | Promise<string | undefined>
+      | Promise<{creationDate?: string; events: IIssueEvent[]}>,
+    hasOnlyStaleLabelingEventsSince?: (
+      issue: Issue,
+      sinceDate: string,
+      staleLabel: string,
+      events: IIssueEvent[]
+    ) => Promise<boolean>,
     getPullRequest?: (issue: Issue) => Promise<IPullRequest | undefined | void>
   ) {
     super(options, state);
@@ -31,7 +40,21 @@ export class IssuesProcessorMock extends IssuesProcessor {
     }
 
     if (getLabelCreationDate) {
-      this.getLabelCreationDate = getLabelCreationDate;
+      this.getLabelCreationDate = async (
+        issue: Issue,
+        label: string
+      ): Promise<{creationDate?: string; events: IIssueEvent[]}> => {
+        const result = await getLabelCreationDate(issue, label);
+        if (typeof result === 'string' || typeof result === 'undefined') {
+          return {creationDate: result, events: []};
+        }
+
+        return result;
+      };
+    }
+
+    if (hasOnlyStaleLabelingEventsSince) {
+      this.hasOnlyStaleLabelingEventsSince = hasOnlyStaleLabelingEventsSince;
     }
 
     if (getPullRequest) {

__tests__/exempt-draft-pr.spec.ts

@@ -129,6 +129,7 @@ class IssuesProcessorBuilder {
       async p => (p === 1 ? this._issues : []),
       async () => [],
       async () => new Date().toDateString(),
+      undefined,
       async (): Promise<IPullRequest> => {
         return Promise.resolve({
           number: 0,

__tests__/remove-stale-when-updated-label-events.spec.ts

@@ -0,0 +1,288 @@
+import {Issue} from '../src/classes/issue';
+import {IIssuesProcessorOptions} from '../src/interfaces/issues-processor-options';
+import {IssuesProcessorMock} from './classes/issues-processor-mock';
+import {DefaultProcessorOptions} from './constants/default-processor-options';
+import {generateIssue} from './functions/generate-issue';
+import {alwaysFalseStateMock} from './classes/state-mock';
+import {IState} from '../src/interfaces/state/state';
+import {IIssueEvent} from '../src/interfaces/issue-event';
+import {IssuesProcessor} from '../src/classes/issues-processor';
+
+describe('remove-stale-when-updated with stale label events', (): void => {
+  const markedStaleOn = '2025-01-01T00:00:00Z';
+  const updatedAt = '2025-01-01T00:01:00Z';
+
+  let options: IIssuesProcessorOptions;
+
+  beforeEach((): void => {
+    options = {
+      ...DefaultProcessorOptions,
+      removeStaleWhenUpdated: true
+    };
+  });
+
+  const buildIssue = (): Issue =>
+    generateIssue(
+      options,
+      1,
+      'dummy-title',
+      updatedAt,
+      markedStaleOn,
+      false,
+      false,
+      ['Stale']
+    );
+
+  const buildEvents = (): IIssueEvent[] => [
+    {
+      event: 'labeled',
+      created_at: markedStaleOn,
+      label: {name: 'Stale'}
+    }
+  ];
+
+  test('does not remove stale label when only stale label events occurred', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+
+    const processor = new IssuesProcessorMock(
+      options,
+      alwaysFalseStateMock,
+      async p => (p === 1 ? [issue] : []),
+      async () => [],
+      async () => ({creationDate: markedStaleOn, events: buildEvents()}),
+      async () => true
+    );
+
+    await processor.processIssues();
+
+    expect(processor.removedLabelIssues).toHaveLength(0);
+  });
+
+  test('removes stale label when updates are not just stale label events', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+
+    const processor = new IssuesProcessorMock(
+      options,
+      alwaysFalseStateMock,
+      async p => (p === 1 ? [issue] : []),
+      async () => [],
+      async () => ({creationDate: markedStaleOn, events: buildEvents()}),
+      async () => false
+    );
+
+    await processor.processIssues();
+
+    expect(processor.removedLabelIssues).toHaveLength(1);
+  });
+});
+
+class TestIssuesProcessor extends IssuesProcessor {
+  constructor(
+    options: IIssuesProcessorOptions,
+    state: IState,
+    events: IIssueEvent[]
+  ) {
+    super(options, state);
+    const client = {
+      rest: {
+        issues: {
+          listEvents: {
+            endpoint: {
+              merge: () => ({})
+            }
+          }
+        }
+      },
+      paginate: {
+        iterator: async function* () {
+          yield {data: events};
+        }
+      }
+    };
+    (this as any).client = client;
+  }
+
+  async callhasOnlyStaleLabelingEventsSince(
+    issue: Issue,
+    sinceDate: string,
+    staleLabel: string,
+    events: IIssueEvent[]
+  ): Promise<boolean> {
+    return this.hasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+  }
+}
+
+describe('hasOnlyStaleLabelingEventsSince', (): void => {
+  const staleLabel = 'Stale';
+  const sinceDate = '2025-01-01T00:00:00Z';
+  const originalRepo = process.env.GITHUB_REPOSITORY;
+
+  let options: IIssuesProcessorOptions;
+
+  beforeEach((): void => {
+    process.env.GITHUB_REPOSITORY = 'owner/repo';
+    options = {
+      ...DefaultProcessorOptions,
+      staleIssueLabel: staleLabel,
+      removeStaleWhenUpdated: true
+    };
+  });
+
+  afterEach((): void => {
+    if (originalRepo === undefined) {
+      delete process.env.GITHUB_REPOSITORY;
+    } else {
+      process.env.GITHUB_REPOSITORY = originalRepo;
+    }
+  });
+
+  const buildIssue = (): Issue =>
+    generateIssue(
+      options,
+      1,
+      'dummy-title',
+      '2025-01-01T00:02:00Z',
+      sinceDate,
+      false,
+      false,
+      [staleLabel]
+    );
+
+  test('returns true when only stale label events exist after the since date', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+    const events: IIssueEvent[] = [
+      // Event before the sinceDate should be ignored.
+      {
+        event: 'labeled',
+        created_at: '2024-12-31T23:59:00Z',
+        label: {name: staleLabel}
+      },
+      {
+        event: 'labeled',
+        created_at: '2025-01-01T00:00:10Z',
+        label: {name: staleLabel}
+      }
+    ];
+    const processor = new TestIssuesProcessor(
+      options,
+      alwaysFalseStateMock,
+      events
+    );
+    const result = await processor.callhasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+
+    expect(result).toBe(true);
+  });
+
+  test('returns false when a non-stale label event exists after the since date', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+    const events: IIssueEvent[] = [
+      {
+        event: 'labeled',
+        created_at: '2025-01-01T00:00:10Z',
+        label: {name: 'other-label'}
+      }
+    ];
+    const processor = new TestIssuesProcessor(
+      options,
+      alwaysFalseStateMock,
+      events
+    );
+    const result = await processor.callhasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+
+    expect(result).toBe(false);
+  });
+
+  test('returns false when stale label is removed after the since date', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+    const events: IIssueEvent[] = [
+      {
+        event: 'unlabeled',
+        created_at: '2025-01-01T00:00:10Z',
+        label: {name: staleLabel}
+      }
+    ];
+    const processor = new TestIssuesProcessor(
+      options,
+      alwaysFalseStateMock,
+      events
+    );
+    const result = await processor.callhasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+
+    expect(result).toBe(false);
+  });
+
+  test('returns false when a non-label event exists after the since date', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+    const events: IIssueEvent[] = [
+      {
+        event: 'commented',
+        created_at: '2025-01-01T00:00:10Z',
+        label: {name: staleLabel}
+      }
+    ];
+    const processor = new TestIssuesProcessor(
+      options,
+      alwaysFalseStateMock,
+      events
+    );
+    const result = await processor.callhasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+
+    expect(result).toBe(false);
+  });
+
+  test('includes events that occur exactly at the since date boundary', async (): Promise<void> => {
+    expect.assertions(1);
+    const issue = buildIssue();
+    const events: IIssueEvent[] = [
+      {
+        event: 'labeled',
+        created_at: sinceDate,
+        label: {name: staleLabel}
+      }
+    ];
+    const processor = new TestIssuesProcessor(
+      options,
+      alwaysFalseStateMock,
+      events
+    );
+    const result = await processor.callhasOnlyStaleLabelingEventsSince(
+      issue,
+      sinceDate,
+      staleLabel,
+      events
+    );
+
+    expect(result).toBe(true);
+  });
+});

package-lock.json

@@ -92,13 +92,13 @@
       }
     },
     "node_modules/@actions/cache/node_modules/@actions/http-client": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-3.0.2.tgz",
-      "integrity": "sha512-JP38FYYpyqvUsz+Igqlc/JG6YO9PaKuvqjM3iGvaLqFnJ7TFmcLyy2IDrY0bI0qCQug8E9K+elv5ZNfw62ZJzA==",
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-3.0.1.tgz",
+      "integrity": "sha512-SbGS8c/vySbNO3kjFgSW77n83C4MQx/Yoe+b1hAdpuvfHxnkHzDq2pWljUpAA56Si1Gae/7zjeZsV0CYjmLo/w==",
       "license": "MIT",
       "dependencies": {
         "tunnel": "^0.0.6",
-        "undici": "^6.23.0"
+        "undici": "^5.28.5"
       }
     },
     "node_modules/@actions/cache/node_modules/@actions/io": {
@@ -115,15 +115,6 @@
         "semver": "bin/semver.js"
       }
     },
-    "node_modules/@actions/cache/node_modules/undici": {
-      "version": "6.23.0",
-      "resolved": "https://registry.npmjs.org/undici/-/undici-6.23.0.tgz",
-      "integrity": "sha512-VfQPToRA5FZs/qJxLIinmU59u0r7LXqoJkCzinq3ckNJp3vKEh7jTWN589YQ5+aoAC/TGRLyJLCPKcLQbM8r9g==",
-      "license": "MIT",
-      "engines": {
-        "node": ">=18.17"
-      }
-    },
     "node_modules/@actions/core": {
       "version": "1.11.1",
       "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz",
@@ -157,22 +148,13 @@
       }
     },
     "node_modules/@actions/github/node_modules/@actions/http-client": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-3.0.2.tgz",
-      "integrity": "sha512-JP38FYYpyqvUsz+Igqlc/JG6YO9PaKuvqjM3iGvaLqFnJ7TFmcLyy2IDrY0bI0qCQug8E9K+elv5ZNfw62ZJzA==",
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-3.0.1.tgz",
+      "integrity": "sha512-SbGS8c/vySbNO3kjFgSW77n83C4MQx/Yoe+b1hAdpuvfHxnkHzDq2pWljUpAA56Si1Gae/7zjeZsV0CYjmLo/w==",
       "license": "MIT",
       "dependencies": {
         "tunnel": "^0.0.6",
-        "undici": "^6.23.0"
-      }
-    },
-    "node_modules/@actions/github/node_modules/@actions/http-client/node_modules/undici": {
-      "version": "6.23.0",
-      "resolved": "https://registry.npmjs.org/undici/-/undici-6.23.0.tgz",
-      "integrity": "sha512-VfQPToRA5FZs/qJxLIinmU59u0r7LXqoJkCzinq3ckNJp3vKEh7jTWN589YQ5+aoAC/TGRLyJLCPKcLQbM8r9g==",
-      "license": "MIT",
-      "engines": {
-        "node": ">=18.17"
+        "undici": "^5.28.5"
       }
     },
     "node_modules/@actions/glob": {
@@ -1155,11 +1137,10 @@
       }
     },
     "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": {
-      "version": "3.14.2",
-      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz",
-      "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==",
+      "version": "3.14.1",
+      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+      "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
         "argparse": "^1.0.7",
         "esprima": "^4.0.0"
@@ -3928,9 +3909,9 @@
       "dev": true
     },
     "node_modules/fast-xml-parser": {
-      "version": "5.3.4",
-      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.3.4.tgz",
-      "integrity": "sha512-EFd6afGmXlCx8H8WTZHhAoDaWaGyuIBoZJ2mknrNxug+aZKjkp0a0dlars9Izl+jF+7Gu1/5f/2h68cQpe0IiA==",
+      "version": "5.3.3",
+      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.3.3.tgz",
+      "integrity": "sha512-2O3dkPAAC6JavuMm8+4+pgTk+5hoAs+CjZ+sWcQLkX9+/tHRuTkQh/Oaifr8qDmZ8iEHb771Ea6G8CdwkrgvYA==",
       "funding": [
         {
           "type": "github",
@@ -5650,11 +5631,10 @@
       }
     },
     "node_modules/lodash": {
-      "version": "4.17.23",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz",
-      "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==",
-      "dev": true,
-      "license": "MIT"
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
+      "dev": true
     },
     "node_modules/lodash.deburr": {
       "version": "4.1.0",

src/classes/issues-processor.ts

@@ -608,7 +608,7 @@ export class IssuesProcessor {
   async getLabelCreationDate(
     issue: Issue,
     label: string
-  ): Promise<string | undefined> {
+  ): Promise<{creationDate?: string; events: IIssueEvent[]}> {
     const issueLogger: IssueLogger = new IssueLogger(issue);
 
     issueLogger.info(`Checking for label on this $$type`);
@@ -623,6 +623,7 @@ export class IssuesProcessor {
     });
 
     const events: IIssueEvent[] = await this.client.paginate(options);
+
     const reversedEvents = events.reverse();
 
     const staleLabeledEvent = reversedEvents.find(
@@ -633,10 +634,51 @@ export class IssuesProcessor {
 
     if (!staleLabeledEvent) {
       // Must be old rather than labeled
-      return undefined;
+      return {creationDate: undefined, events};
     }
 
-    return staleLabeledEvent.created_at;
+    return {creationDate: staleLabeledEvent.created_at, events};
+  }
+
+  protected async hasOnlyStaleLabelingEventsSince(
+    issue: Issue,
+    sinceDate: string,
+    staleLabel: string,
+    events: IIssueEvent[]
+  ): Promise<boolean> {
+    const issueLogger: IssueLogger = new IssueLogger(issue);
+
+    issueLogger.info(
+      `Checking if only stale label added events on $$type since: ${LoggerService.cyan(
+        sinceDate
+      )}`
+    );
+
+    if (!sinceDate) {
+      return false;
+    }
+
+    const sinceTimestamp = new Date(sinceDate).getTime();
+    if (Number.isNaN(sinceTimestamp)) {
+      return false;
+    }
+
+    const relevantEvents = events.filter(event => {
+      const eventTimestamp = new Date(event.created_at).getTime();
+      return !Number.isNaN(eventTimestamp) && eventTimestamp >= sinceTimestamp;
+    });
+
+    if (relevantEvents.length === 0) {
+      return false;
+    }
+
+    return relevantEvents.every(event => {
+      if (event.event !== 'labeled') {
+        return false;
+      }
+
+      return cleanLabel(event.label.name) === cleanLabel(staleLabel);
+    });
   }
 
   async getPullRequest(issue: Issue): Promise<IPullRequest | undefined | void> {
@@ -691,8 +733,11 @@ export class IssuesProcessor {
     closeLabel?: string
   ) {
     const issueLogger: IssueLogger = new IssueLogger(issue);
-    const markedStaleOn: string =
-      (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
+    const {creationDate, events} = await this.getLabelCreationDate(
+      issue,
+      staleLabel
+    );
+    const markedStaleOn: string = creationDate || issue.updated_at;
     issueLogger.info(
       `$$type marked stale on: ${LoggerService.cyan(markedStaleOn)}`
     );
@@ -744,12 +789,33 @@ export class IssuesProcessor {
 
     // The issue.updated_at and markedStaleOn are not always exactly in sync (they can be off by a second or 2)
     // isDateMoreRecentThan makes sure they are not the same date within a certain tolerance (15 seconds in this case)
-    const issueHasUpdateSinceStale = isDateMoreRecentThan(
+    let issueHasUpdateSinceStale = isDateMoreRecentThan(
       new Date(issue.updated_at),
       new Date(markedStaleOn),
       15
     );
 
+    // Check if the only update was the stale label being added
+    if (
+      issueHasUpdateSinceStale &&
+      shouldRemoveStaleWhenUpdated &&
+      !issue.markedStaleThisRun
+    ) {
+      const onlyStaleLabelAdded = await this.hasOnlyStaleLabelingEventsSince(
+        issue,
+        markedStaleOn,
+        staleLabel,
+        events
+      );
+
+      if (onlyStaleLabelAdded) {
+        issueHasUpdateSinceStale = false;
+        issueLogger.info(
+          `Ignoring $$type update since only the stale label was added`
+        );
+      }
+    }
+
     issueLogger.info(
       `$$type has been updated since it was marked stale: ${LoggerService.cyan(
         issueHasUpdateSinceStale