feat(resolutions): support resolutions ignoring until given date (#291)

Author: padamczewski

README.md

@@ -93,6 +93,19 @@ steps:
       ignore-resolutions: resolution-package-to-ignore
 ```
 
+Specify `ignore-resolutions-until` to skip resolution validation entirely for certain amount of time. You can use any format supported by Date constructor [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
+
+```yaml
+steps:
+  - name: Checkout
+    uses: actions/checkout@v3
+
+  - uses: ExpediaGroup/package-json-validator@v1
+    with:
+      rules: resolutions
+      ignore-resolutions-until: 2000-01-01
+```
+
 ### Keys
 
 The "keys" rule validates that your package.json does not contain duplicate dependency keys.

action.yml

@@ -21,6 +21,9 @@ inputs:
   ignore-resolutions:
     description: 'Line-separated list of dependencies to skip validation for resolutions field.'
     required: false
+  ignore-resolutions-until:
+    description: 'Date string to skip validation for resolutions field for a specific amount of time.'
+    required: false
 runs:
   using: 'node20'
   main: 'dist/main.js'

dist/main.js

@@ -18102,6 +18102,15 @@ var dependencySatisfiesAllowedTags = (packageName, version, allowedTags) => {
 // src/rules/resolutions.ts
 var core5 = __toESM(require_core(), 1);
 var validateResolutions = (packageJson) => {
+  const ignoreResolutionsUntil = core5.getInput("ignore-resolutions-until");
+  if (packageJson.resolutions && ignoreResolutionsUntil) {
+    const ignoreUntilDate = new Date(ignoreResolutionsUntil);
+    const now = new Date;
+    if (ignoreUntilDate > now) {
+      core5.info(`Ignoring resolutions until ${ignoreUntilDate.toISOString()}`);
+      return;
+    }
+  }
   const ignoredResolutions = core5.getMultilineInput("ignore-resolutions");
   if (packageJson.resolutions && !ignoredResolutions.length) {
     core5.setFailed("Resolutions may not be set. Please investigate the root cause of your dependency issues!");
@@ -18203,4 +18212,4 @@ export {
   RULES_MAP
 };
 
-//# debugId=86CF08E55347CA0C64756e2164756e21
+//# debugId=653C660A130B963164756e2164756e21

dist/main.js.map

@@ -15,8 +15,19 @@ import * as core from '@actions/core';
 import { PackageJson } from 'type-fest';
 
 export const validateResolutions = (packageJson: PackageJson) => {
-  const ignoredResolutions = core.getMultilineInput('ignore-resolutions');
+  const ignoreResolutionsUntil = core.getInput('ignore-resolutions-until');
+
+  if (packageJson.resolutions && ignoreResolutionsUntil) {
+    const ignoreUntilDate = new Date(ignoreResolutionsUntil);
+    const now = new Date();
+
+    if (ignoreUntilDate > now) {
+      core.info(`Ignoring resolutions until ${ignoreUntilDate.toISOString()}`);
+      return;
+    }
+  }
 
+  const ignoredResolutions = core.getMultilineInput('ignore-resolutions');
   if (packageJson.resolutions && !ignoredResolutions.length) {
     core.setFailed(
       'Resolutions may not be set. Please investigate the root cause of your dependency issues!'

src/rules/resolutions.ts

@@ -2,13 +2,21 @@ import {PackageJson} from 'type-fest';
 import {validateResolutions} from '../../src/rules/resolutions';
 import * as core from '@actions/core';
 
+// Inputs
 jest.mock('@actions/core');
-
 beforeEach(() => {
     // N.B: Ensure we return empty array to match the default behavior of getMultilineInput
     (core.getMultilineInput as jest.Mock).mockImplementation(()=> []);
 })
 
+// Timers
+beforeEach(() => {
+    jest.useFakeTimers();
+});
+afterEach(() => {
+    jest.useRealTimers();
+});
+
 describe('resolutions only', () => {
     it('should fail when resolutions are present',  () => {
         const packageJson: PackageJson = {
@@ -80,3 +88,101 @@ describe('ignore-resolutions', () => {
         expect(core.setFailed).not.toHaveBeenCalled();
     });
 })
+
+describe("ignore-resolutions-until", () => {
+    it('should not fail when some resolutions are provided and ignore-resolutions-until is set with date in the future',  () => {
+        // 1. Arrange
+        jest.setSystemTime(new Date("2020-12-31"));
+        (core.getInput as jest.Mock).mockImplementation(input => input === 'ignore-resolutions-until' ? "2021-01-01" : "");
+
+        // 2. Act
+        const packageJson: PackageJson = {
+            dependencies: {},
+            resolutions: {
+                "@test/package-foo": 'resolution',
+                "@test/package-bar": 'resolution'
+            }
+        };
+        validateResolutions(packageJson);
+
+        // 3. Assert
+        expect(core.getInput).toHaveBeenCalledWith("ignore-resolutions-until");
+        expect(core.getMultilineInput).not.toHaveBeenCalledWith("ignore-resolutions");
+
+        expect(core.setFailed).not.toHaveBeenCalled();
+        expect(core.info).toHaveBeenCalledWith("Ignoring resolutions until 2021-01-01T00:00:00.000Z");
+    });
+
+      it('should fail when some resolutions are provided and ignore-resolutions-until is set with date in the past',  () => {
+        // 1. Arrange
+        jest.setSystemTime(new Date("2021-01-31"));
+        (core.getInput as jest.Mock).mockImplementation(input => input === 'ignore-resolutions-until' ? "2021-01-01" : "");
+
+        // 2. Act
+        const packageJson: PackageJson = {
+            dependencies: {},
+            resolutions: {
+                "@test/package-foo": 'resolution',
+                "@test/package-bar": 'resolution'
+            }
+        };
+        validateResolutions(packageJson);
+
+        // 3. Assert
+        expect(core.getInput).toHaveBeenCalledWith("ignore-resolutions-until");
+        expect(core.getMultilineInput).toHaveBeenCalledWith("ignore-resolutions");
+
+        expect(core.setFailed).toHaveBeenCalledWith('Resolutions may not be set. Please investigate the root cause of your dependency issues!');
+        expect(core.info).not.toHaveBeenCalledWith();
+    });
+
+    it('should fail when some resolutions are provided and ignore-resolutions-until is not set',  () => {
+        // 1. Arrange
+        jest.setSystemTime(new Date("2021-01-31"));
+        (core.getInput as jest.Mock).mockImplementation(input => input === 'ignore-resolutions-until' ? "" : "");
+
+        // 2. Act
+        const packageJson: PackageJson = {
+            dependencies: {},
+            resolutions: {
+                "@test/package-foo": 'resolution',
+                "@test/package-bar": 'resolution'
+            }
+        };
+        validateResolutions(packageJson);
+
+        // 3. Assert
+        expect(core.getInput).toHaveBeenCalledWith("ignore-resolutions-until");
+        expect(core.getMultilineInput).toHaveBeenCalledWith("ignore-resolutions");
+
+        expect(core.setFailed).toHaveBeenCalledWith('Resolutions may not be set. Please investigate the root cause of your dependency issues!');
+        expect(core.info).not.toHaveBeenCalledWith();
+    });
+
+    it('should not fail when matching resolution is present in package.json and ignore list, while ignore-resolutions-until is provided with date in the past',  () => {
+        // 1. Arrange
+        jest.setSystemTime(new Date("2021-01-31"));
+        (core.getInput as jest.Mock).mockImplementation(input => input === 'ignore-resolutions-until' ? "2021-01-01" : "");
+        (core.getMultilineInput as jest.Mock).mockImplementation(input => input === 'ignore-resolutions' ? [
+            "@test/package-foo",
+            "@test/package-bar",
+        ] : []);
+
+        // 2. Act
+        const packageJson: PackageJson = {
+            dependencies: {},
+            resolutions: {
+                "@test/package-foo": 'resolution',
+                "@test/package-bar": 'resolution'
+            }
+        };
+        validateResolutions(packageJson);
+
+        // 3. Assert
+        expect(core.getInput).toHaveBeenCalledWith("ignore-resolutions-until");
+        expect(core.getMultilineInput).toHaveBeenCalledWith("ignore-resolutions");
+
+        expect(core.setFailed).not.toHaveBeenCalled()
+        expect(core.info).not.toHaveBeenCalled()
+    });
+});