chore: upgrade to typescript 4.8

Upgrade typescript from 3.9.10 to 4.8.4
Includes necessary upgrades to these packages as well:
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
eslint
eslint-config-prettier
eslint-plugin-jest
jest
tap
ts-jest
ts-loader
ts-node

Signed-off-by: Craig Andrews <candrews@integralblue.com>

.eslintrc.json

@@ -13,8 +13,7 @@
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
-    "prettier",
-    "prettier/@typescript-eslint"
+    "prettier"
   ],
   "rules": {
     "@typescript-eslint/explicit-function-return-type": "off",
@@ -52,7 +51,6 @@
         "jest/no-done-callback": "warn",
         "jest/valid-title": "warn",
         "jest/no-conditional-expect": "warn",
-        "jest/no-try-expect": "warn",
         "jest/no-identical-title": "warn",
         "@typescript-eslint/ban-ts-comment": "warn"
       }

package.json

@@ -135,27 +135,27 @@
     "@types/cross-spawn": "^6.0.2",
     "@types/express": "^4.17.13",
     "@types/fs-extra": "^9.0.11",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^29.1.2",
     "@types/lodash": "^4.14.161",
     "@types/needle": "^2.0.4",
     "@types/node": "^14.14.31",
     "@types/sarif": "^2.1.2",
     "@types/sinon": "^7.5.0",
-    "@typescript-eslint/eslint-plugin": "^4.30.0",
-    "@typescript-eslint/parser": "^4.30.0",
+    "@typescript-eslint/eslint-plugin": "^5.38.1",
+    "@typescript-eslint/parser": "^5.38.1",
     "ajv": "^6.12.6",
     "body-parser": "^1.19.0",
     "conventional-changelog-cli": "^2.2.2",
     "copy-webpack-plugin": "^9.0.1",
     "cross-spawn": "^6.0.5",
     "danger": "10.9.0",
     "depcheck": "^1.4.3",
-    "eslint": "6.8.0",
-    "eslint-config-prettier": "^6.1.0",
-    "eslint-plugin-jest": "^24.4.0",
+    "eslint": "8.24.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "^27.1.1",
     "express": "^4.17.1",
     "fs-extra": "^9.1.0",
-    "jest": "^27.4.7",
+    "jest": "^29.1.2",
     "lodash": "^4.17.20",
     "mock-fs": "^4.13.0",
     "nock": "^10.0.6",
@@ -165,11 +165,11 @@
     "prettier": "^1.18.2",
     "proxyquire": "^1.7.4",
     "sinon": "^4.0.0",
-    "tap": "^12.6.1",
-    "ts-jest": "^27.0.4",
-    "ts-loader": "^9.0.2",
-    "ts-node": "^8.0.0",
-    "typescript": "^3.9.9",
+    "tap": "^16.3.0",
+    "ts-jest": "^29.0.3",
+    "ts-loader": "^9.4.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4",
     "webpack": "^5.34.0",
     "webpack-cli": "^4.6.0",
     "webpack-license-plugin": "^4.2.0",

packages/cli-alert/package.json

@@ -16,6 +16,6 @@
     "@octokit/rest": "^18.0.5",
     "@pagerduty/pdjs": "^2.2.0",
     "@slack/webhook": "^5.0.3",
-    "typescript": "^4.0.2"
+    "typescript": "^4.8.4"
   }
 }

packages/iac-cli-alert/package.json

@@ -14,6 +14,6 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@slack/webhook": "^5.0.3",
-    "typescript": "^4.0.2"
+    "typescript": "^4.8.4"
   }
 }

packages/snyk-fix/src/plugins/python/handlers/pip-requirements/index.ts

@@ -234,7 +234,7 @@ function filterOutAppliedUpgrades(
   const normalizedAppliedRemediation = upgradeChanges
     .map((c) => {
       if (c.success && c.from) {
-        const [pkgName, versionAndMore] = c.from?.split('@');
+        const [pkgName, versionAndMore] = c.from.split('@');
         return `${standardizePackageName(pkgName)}@${versionAndMore}`;
       }
       return false;

packages/snyk-fix/src/plugins/python/handlers/poetry/update-dependencies/generate-upgrades.ts

@@ -56,8 +56,6 @@ export async function generateUpgrades(
       // transitive and it could have come from a dev or prod dep
       // since we can't tell right now let be pinned into production deps
       upgrades.push(upgrade);
-    } else if (prodTopLevelDeps.includes(pkgName)) {
-      upgrades.push(upgrade);
     } else if (entity.options.dev && devTopLevelDeps.includes(pkgName)) {
       devUpgrades.push(upgrade);
     } else {

src/cli/commands/describe.ts

@@ -15,9 +15,13 @@ import { findAndLoadPolicy } from '../../lib/policy';
 import { DescribeRequiredArgumentError } from '../../lib/errors/describe-required-argument-error';
 import help from './help';
 import { DCTL_EXIT_CODES, runDriftCTL } from '../../lib/iac/drift/driftctl';
+import { DescribeOptions } from '../../lib/iac/types';
+import { PolicyOptions } from '../../lib/types';
 
 export default async (...args: MethodArgs): Promise<any> => {
-  const { options } = processCommandArgs(...args);
+  const { options } = processCommandArgs<DescribeOptions & PolicyOptions>(
+    ...args,
+  );
 
   // Ensure that this describe command can only be runned when using `snyk iac describe`
   // Avoid `snyk describe` direct usage

src/cli/commands/monitor/index.ts

@@ -72,7 +72,7 @@ async function promiseOrCleanup<T>(
 // Returns an array of Registry responses (one per every sub-project scanned), a single response,
 // or an error message.
 export default async function monitor(...args0: MethodArgs): Promise<any> {
-  const { options, paths } = processCommandArgs(...args0);
+  const { options, paths } = processCommandArgs<MonitorOptions>(...args0);
   const results: Array<GoodResult | BadResult> = [];
 
   if (options.id) {

src/cli/commands/update-exclude-policy.ts

@@ -12,9 +12,10 @@ import {
 } from '../../lib/iac/drift';
 import { Policy } from '../../lib/policy/find-and-load-policy';
 import * as analytics from '../../lib/analytics';
+import { GenDriftIgnoreOptions } from '../../lib/iac/types';
 
 export default async (...args: MethodArgs): Promise<any> => {
-  const { options } = processCommandArgs(...args);
+  const { options } = processCommandArgs<GenDriftIgnoreOptions>(...args);
 
   // Ensure that this update-exclude-policy command can only be runned when using `snyk iac update-exclude-policy`
   // Avoid `snyk update-exclude-policy` direct usage

src/lib/yarn.ts

@@ -22,7 +22,7 @@ export function yarn(
 
   method += ' ' + flags.join(' ');
 
-  return new Promise((resolve, reject) => {
+  return new Promise<void>((resolve, reject) => {
     const cmd = 'yarn ' + method + ' ' + packages.join(' ');
     if (!cwd) {
       cwd = process.cwd();

test/createJestConfig.js

@@ -10,6 +10,11 @@ const createJestConfig = (config) => {
   ];
 
   return {
+    snapshotFormat: {
+      // Jest 29 changed these defaults, see: https://jestjs.io/docs/upgrading-to-jest29#snapshot-format
+      escapeString: true,
+      printBasicPrototype: true,
+    },
     preset: 'ts-jest',
     testRegex: '\\.spec\\.ts$',
     testPathIgnorePatterns: [...ignorePatterns],

test/jest/acceptance/config.spec.ts

@@ -15,15 +15,15 @@ describe('config', () => {
 
   beforeAll(() => {
     server = fakeServer(baseURL, '123456789');
-    return new Promise((resolve) => server.listen(port, resolve));
+    return new Promise<void>((resolve) => server.listen(port, resolve));
   });
 
   afterEach(() => {
     jest.resetAllMocks();
     server.restore();
   });
 
-  afterAll(() => new Promise(server.close));
+  afterAll(() => new Promise<void>(server.close));
 
   it('loads API_REST_URL from config key if set', async () => {
     const env = {

test/jest/acceptance/iac/helpers.ts

@@ -15,7 +15,7 @@ export async function startMockServer() {
   const server = fakeServer(BASE_API, SNYK_TOKEN);
 
   // Use port of 0 to find a free port.
-  await new Promise((resolve) => server.listen(0, resolve));
+  await new Promise<void>((resolve) => server.listen(0, resolve));
 
   const SNYK_HOST = 'http://localhost:' + server.getPort();
   const SNYK_API = SNYK_HOST + BASE_API;
@@ -37,7 +37,7 @@ export async function startMockServer() {
       overrides?: Record<string, string>,
       cwd?: string,
     ) => run(cmd, { ...env, ...overrides }, cwd),
-    teardown: async () => new Promise((resolve) => server.close(resolve)),
+    teardown: async () => new Promise<void>((resolve) => server.close(resolve)),
     apiUrl: SNYK_API,
   };
 }

test/jest/unit/cli/commands/test/iac/v2/index.spec.ts

@@ -209,7 +209,7 @@ describe('test', () => {
   describe('with issues', () => {
     it('throws the expected error', async () => {
       // Act + Assert
-      await expect(test(['path/to/test'], {})).rejects.toThrowError(
+      await expect(test(['path/to/test'], {})).rejects.toThrow(
         FoundIssuesError,
       );
     });

test/jest/unit/iac/file-utils.spec.ts

@@ -34,7 +34,7 @@ describe('extractBundle', () => {
     mockBundleStream.end();
 
     await expect(extractBundlePromise).resolves.toEqual(undefined);
-    expect(tarSpy).toBeCalledWith({
+    expect(tarSpy).toHaveBeenCalledWith({
       C: expect.stringMatching(LOCAL_POLICY_ENGINE_DIR),
     });
     expect(receivedBundleData).toEqual('zipped data');
@@ -83,6 +83,6 @@ describe('makeFileAndDirectoryGenerator', () => {
 
   it('throws an error if the path provided is not a directory', () => {
     const it = makeFileAndDirectoryGenerator('missing_path');
-    expect(() => Array.from(it)).toThrowError();
+    expect(() => Array.from(it)).toThrow();
   });
 });

test/jest/unit/iac/usage-tracking.spec.ts

@@ -2,13 +2,12 @@ import {
   trackUsage,
   TestLimitReachedError,
 } from '../../../../src/cli/commands/test/iac/local-execution/usage-tracking';
-import { mocked } from 'ts-jest/utils';
 import { NeedleResponse } from 'needle';
 import { makeRequest } from '../../../../src/lib/request/request';
 import { CustomError } from '../../../../src/lib/errors';
 
 jest.mock('../../../../src/lib/request/request');
-const mockedMakeRequest = mocked(makeRequest);
+const mockedMakeRequest = jest.mocked(makeRequest);
 
 const results = [
   {

test/jest/unit/lib/analytics/index.spec.ts

@@ -20,7 +20,7 @@ describe('analytics module', () => {
       args: argsFrom({}),
     });
 
-    expect(requestSpy).toBeCalledTimes(1);
+    expect(requestSpy).toHaveBeenCalledTimes(1);
     expect(requestSpy.mock.calls[0][0]).not.toHaveProperty(
       'headers.authorization',
     );

test/jest/unit/lib/ecosystems/common.spec.ts

@@ -26,7 +26,7 @@ describe('handleProcessingStatus fn', () => {
     ({ actual, expected }) => {
       expect(() => {
         handleProcessingStatus({ status: actual } as any);
-      }).toThrowError(new FailedToRunTestError(expected));
+      }).toThrow(new FailedToRunTestError(expected));
     },
   );
 });

test/jest/unit/lib/ecosystems/resolve-monitor.facts.spec.ts

@@ -274,7 +274,7 @@ describe('resolve and test facts', () => {
       'project-lifecycle': 'development',
     } as unknown) as Options);
     expect(httpClientSpy).toHaveBeenCalledTimes(1);
-    expect(httpClientSpy).toBeCalledWith(
+    expect(httpClientSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         body: expect.objectContaining({
           tags: [

test/jest/unit/lib/feature-flags/feature-flags.spec.ts

@@ -25,13 +25,13 @@ describe('hasFeatureFlag fn', () => {
 
     await expect(
       hasFeatureFlag('test-ff', { path: 'test-path' }),
-    ).rejects.toThrowError('Unauthorized');
+    ).rejects.toThrow('Unauthorized');
 
     jest.spyOn(request, 'makeRequest').mockResolvedValue({
       body: { code: 403, error: 'Forbidden', ok: false },
     } as any);
     await expect(
       hasFeatureFlag('test-ff', { path: 'test-path' }),
-    ).rejects.toThrowError('Forbidden');
+    ).rejects.toThrow('Forbidden');
   });
 });

test/jest/unit/lib/iac/test/v2/setup/local-cache/policy-engine/lookup-local.spec.ts

@@ -41,13 +41,13 @@ describe('lookupLocalPolicyEngine', () => {
     await lookupLocalPolicyEngine(testConfig);
 
     // Assert
-    expect(lookupLocalySpy).toBeCalledWith(
+    expect(lookupLocalySpy).toHaveBeenCalledWith(
       testConfig.iacCachePath,
       policyEngineFileName,
       undefined,
       expect.any(Function),
     );
-    expect(isExeSpy).toBeCalledWith(cachedPolicyEnginePath);
+    expect(isExeSpy).toHaveBeenCalledWith(cachedPolicyEnginePath);
   });
 
   it('returns undefined when the policy engine is not present locally', async () => {

test/jest/unit/lib/iac/test/v2/setup/local-cache/rules-bundle/lookup-local.spec.ts

@@ -36,14 +36,14 @@ describe('lookupLocalRulesBundle', () => {
     await lookupLocalRulesBundle(testConfig);
 
     // Assert
-    expect(lookupLocalySpy).toBeCalledWith(
+    expect(lookupLocalySpy).toHaveBeenCalledWith(
       testConfig.iacCachePath,
       rulesBundleName,
       undefined,
       expect.any(Function),
     );
-    expect(isFileSpy).toBeCalledWith(cachedRulesBundlePath);
-    expect(isArchiveSpy).toBeCalledWith(cachedRulesBundlePath);
+    expect(isFileSpy).toHaveBeenCalledWith(cachedRulesBundlePath);
+    expect(isArchiveSpy).toHaveBeenCalledWith(cachedRulesBundlePath);
   });
 
   it('returns undefined when the rules bundle is not present locally', async () => {

test/jest/unit/lib/iac/test/v2/setup/local-cache/utils.spec.ts

@@ -141,9 +141,7 @@ describe('fetchCacheResource', () => {
       jest.spyOn(requestLib, 'makeRequest').mockRejectedValue(new Error());
 
       // Act + Assert
-      await expect(
-        fetchCacheResource(testCacheResourceUrl),
-      ).rejects.toThrowError();
+      await expect(fetchCacheResource(testCacheResourceUrl)).rejects.toThrow();
     });
   });
   describe('when an error response is received', () => {

test/jest/unit/npm-modules-parser.spec.ts

@@ -1,10 +1,8 @@
-import { mocked } from 'ts-jest/utils';
-
 import { parse } from '../../../src/lib/plugins/nodejs-plugin/npm-modules-parser';
 import { getFileContents } from '../../../src/lib/get-file-contents';
 
 jest.mock('../../../src/lib/get-file-contents');
-const mockedGetFileContents = mocked(getFileContents, true);
+const mockedGetFileContents = jest.mocked(getFileContents, { shallow: true });
 
 afterEach(() => {
   jest.clearAllMocks();

test/jest/unit/python/snyk-test-pyproject.spec.ts

@@ -1,4 +1,3 @@
-import { mocked } from 'ts-jest/utils';
 import { NeedleResponse } from 'needle';
 import test from '../../../../src/cli/commands/test';
 import { loadPlugin } from '../../../../src/lib/plugins/index';
@@ -11,8 +10,8 @@ import { getFixturePath } from '../../util/getFixturePath';
 jest.mock('../../../../src/lib/plugins/index');
 jest.mock('../../../../src/lib/request/request');
 
-const mockedLoadPlugin = mocked(loadPlugin, true);
-const mockedMakeRequest = mocked(makeRequest);
+const mockedLoadPlugin = jest.mocked(loadPlugin, { shallow: true });
+const mockedMakeRequest = jest.mocked(makeRequest);
 
 describe('snyk test for python project', () => {
   afterEach(() => {

test/jest/unit/snyk-code/snyk-code-test.spec.ts

@@ -85,9 +85,7 @@ describe('Test snyk code', () => {
         code: true,
         ...options,
       }),
-    ).rejects.toThrowError(
-      /Authentication failed. Please check the API token on/,
-    );
+    ).rejects.toThrow(/Authentication failed. Please check the API token on/);
   });
 
   it('should fail - when we do not support files', async () => {
@@ -610,7 +608,7 @@ describe('Test snyk code', () => {
       // exit code 1
       expect(error.code).toBe('VULNS');
       expect(errMessage).toBe(expectedOutput);
-      expect(analyticSend).toBeCalledTimes(2);
+      expect(analyticSend).toHaveBeenCalledTimes(2);
     }
   });
 
@@ -858,7 +856,7 @@ describe('Test snyk code', () => {
         sastSettings,
         'test-id',
       ),
-    ).rejects.toThrowError(
+    ).rejects.toThrow(
       'Missing configuration for Snyk Code Local Engine. Refer to our docs on https://docs.snyk.io/products/snyk-code/deployment-options/snyk-code-local-engine/cli-and-ide to learn more',
     );
   });