INT-3349 - Upgrade Polly.JS

The following packages have been upgraded: - `@pollyjs/adapter-node-http` - `@pollyjs/core` - `@pollyjs/persister-fs` The new Polly.JS packages ship with TypeScript definition files, so the old `@type/pollyjs__` packages have been removed! Additionally, `fs-extra` has been pinned to semver range `^9.0.0` because there a change was released in `^10.0.0` that caused a regression. See: jprichardson/node-fs-extra#953.
JupiterOne · Apr 16, 2022 · a663060 · a663060
1 parent dcd4477
commit a663060
Show file tree

Hide file tree

Showing 10 changed files with 155 additions and 192 deletions.
diff --git a/package.json b/package.json
@@ -35,5 +35,8 @@
     "ts-jest": "^27.1.0",
     "typescript": "^4.2.4"
   },
+  "resolutions": {
+    "fs-extra": "^9.0.0"
+  },
   "version": "0.0.0"
 }
diff --git a/packages/integration-sdk-cli/package.json b/packages/integration-sdk-cli/package.json
@@ -38,16 +38,13 @@
   },
   "devDependencies": {
     "@jupiterone/integration-sdk-private-test-utils": "^8.11.0",
-    "@pollyjs/adapter-node-http": "^5.1.1",
-    "@pollyjs/core": "^5.1.1",
-    "@pollyjs/persister-fs": "^5.1.1",
+    "@pollyjs/adapter-node-http": "^6.0.5",
+    "@pollyjs/core": "^6.0.5",
+    "@pollyjs/persister-fs": "^6.0.5",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.3",
     "@types/json-diff": "^0.5.1",
     "@types/lodash": "^4.14.158",
-    "@types/pollyjs__adapter-node-http": "^2.0.1",
-    "@types/pollyjs__core": "^4.3.3",
-    "@types/pollyjs__persister": "^4.3.1",
     "@types/vis": "^4.21.20",
     "memfs": "^3.2.0",
     "neo-forgery": "^2.0.0",

diff --git a/packages/integration-sdk-cli/src/__tests__/cli-run-failure.test.ts b/packages/integration-sdk-cli/src/__tests__/cli-run-failure.test.ts
@@ -20,6 +20,7 @@ import { createCli } from '../index';
 import { setupSynchronizerApi } from './util/synchronization';
 
 import * as log from '../log';
+import { createTestPolly } from './util/recording';
 
 jest.mock('../log');
 
@@ -37,14 +38,7 @@ beforeEach(() => {
   process.env.JUPITERONE_ACCOUNT = 'mochi';
   loadProjectStructure('validationFailure');
 
-  polly = new Polly('run-cli-failure', {
-    adapters: ['node-http'],
-    persister: 'fs',
-    logging: false,
-    matchRequestsBy: {
-      headers: false,
-    },
-  });
+  polly = createTestPolly('run-cli-failure');
 
   mocked(mockCreateIntegrationLogger).mockReturnValue(
     createIntegrationLogger({ name: 'test' }),

diff --git a/packages/integration-sdk-cli/src/__tests__/cli-run.test.ts b/packages/integration-sdk-cli/src/__tests__/cli-run.test.ts
@@ -16,6 +16,7 @@ import {
 } from '@jupiterone/integration-sdk-core';
 
 import * as log from '../log';
+import { createTestPolly } from './util/recording';
 
 jest.mock('../log');
 
@@ -28,15 +29,7 @@ beforeEach(() => {
   process.env.JUPITERONE_API_KEY = 'testing-key';
   process.env.JUPITERONE_ACCOUNT = 'mochi';
 
-  polly = new Polly('run-cli', {
-    adapters: ['node-http'],
-    persister: 'fs',
-    logging: false,
-    matchRequestsBy: {
-      headers: false,
-    },
-  });
-
+  polly = createTestPolly('run-cli');
   loadProjectStructure('typeScriptIntegrationProject');
 
   jest.spyOn(process, 'exit').mockImplementation((code: number | undefined) => {

diff --git a/packages/integration-sdk-cli/src/__tests__/cli-sync.test.ts b/packages/integration-sdk-cli/src/__tests__/cli-sync.test.ts
@@ -13,6 +13,7 @@ import {
 } from './util/synchronization';
 
 import * as log from '../log';
+import { createTestPolly } from './util/recording';
 
 jest.mock('../log');
 
@@ -25,15 +26,7 @@ beforeEach(() => {
   process.env.JUPITERONE_API_KEY = 'testing-key';
   process.env.JUPITERONE_ACCOUNT = 'mochi';
 
-  polly = new Polly('sync-cli', {
-    adapters: ['node-http'],
-    persister: 'fs',
-    logging: false,
-    matchRequestsBy: {
-      headers: false,
-    },
-  });
-
+  polly = createTestPolly('sync-cli');
   loadProjectStructure('synchronization');
 
   jest.spyOn(process, 'exit').mockImplementation((code: number | undefined) => {

diff --git a/packages/integration-sdk-cli/src/__tests__/util/recording.ts b/packages/integration-sdk-cli/src/__tests__/util/recording.ts
@@ -0,0 +1,16 @@
+import { Polly, PollyConfig } from '@pollyjs/core';
+
+export function createTestPolly(
+  recordingName: string,
+  pollyConfigOverrides?: PollyConfig,
+) {
+  return new Polly(recordingName, {
+    adapters: ['node-http'],
+    persister: 'fs',
+    logLevel: 'silent',
+    matchRequestsBy: {
+      headers: false,
+    },
+    ...pollyConfigOverrides,
+  });
+}
diff --git a/packages/integration-sdk-cli/src/__tests__/util/synchronization.ts b/packages/integration-sdk-cli/src/__tests__/util/synchronization.ts
@@ -22,7 +22,7 @@ export function setupSynchronizerApi({ polly, job, baseUrl }: SetupOptions) {
     .post(`${baseUrl}/persister/synchronization/jobs/${job.id}/entities`)
     .intercept((req, res) => {
       allowCrossOrigin(req, res);
-      job.numEntitiesUploaded += JSON.parse(req.body).entities.length;
+      job.numEntitiesUploaded += JSON.parse(req.body!).entities.length;
       res.status(200).json({ job });
     });
 
@@ -37,7 +37,9 @@ export function setupSynchronizerApi({ polly, job, baseUrl }: SetupOptions) {
     .post(`${baseUrl}/persister/synchronization/jobs/${job.id}/relationships`)
     .intercept((req, res) => {
       allowCrossOrigin(req, res);
-      job.numRelationshipsUploaded += JSON.parse(req.body).relationships.length;
+      job.numRelationshipsUploaded += JSON.parse(
+        req.body!,
+      ).relationships.length;
       res.status(200).json({ job });
     });
 

diff --git a/packages/integration-sdk-testing/package.json b/packages/integration-sdk-testing/package.json
@@ -25,13 +25,9 @@
   "dependencies": {
     "@jupiterone/integration-sdk-core": "^8.11.0",
     "@jupiterone/integration-sdk-runtime": "^8.11.0",
-    "@pollyjs/adapter-node-http": "^5.1.1",
-    "@pollyjs/core": "^5.1.1",
-    "@pollyjs/persister-fs": "^5.1.1",
-    "@types/har-format": "^1.2.4",
-    "@types/pollyjs__adapter-node-http": "^2.0.1",
-    "@types/pollyjs__core": "^4.3.3",
-    "@types/pollyjs__persister": "^4.3.1",
+    "@pollyjs/adapter-node-http": "^6.0.5",
+    "@pollyjs/core": "^6.0.5",
+    "@pollyjs/persister-fs": "^6.0.5",
     "deepmerge": "^4.2.2",
     "lodash": "^4.17.15"
   },

diff --git a/packages/integration-sdk-testing/src/recording.ts b/packages/integration-sdk-testing/src/recording.ts
@@ -1,16 +1,16 @@
-import { Har, Entry } from 'har-format';
 import defaultsDeep from 'lodash/defaultsDeep';
 import { gunzipSync } from 'zlib';
 
 import NodeHttpAdapter from '@pollyjs/adapter-node-http';
 import { Polly, PollyConfig } from '@pollyjs/core';
 import FSPersister from '@pollyjs/persister-fs';
+import { HarEntry, Har } from '@pollyjs/persister';
 
 Polly.register(NodeHttpAdapter);
 Polly.register(FSPersister);
 
 export type Recording = Polly;
-export type RecordingEntry = Entry;
+export type RecordingEntry = HarEntry;
 
 export interface SetupRecordingInput {
   directory: string;
@@ -78,7 +78,7 @@ export function setupRecording({
       return 'JupiterOneIntegationFSPersister';
     }
 
-    saveRecording(recordingId: number, data: Har): void {
+    async onSaveRecording(recordingId: string, data: Har): Promise<void> {
       data.log.entries.forEach((entry) => {
         // Redact tokens, even though they expire
         entry.request.headers = entry.request.headers.map((header) => ({
@@ -104,7 +104,7 @@ export function setupRecording({
         mutateEntry?.(entry);
       });
 
-      super.saveRecording(recordingId, data);
+      return super.onSaveRecording(recordingId, data);
     }
   }