@jupiterone/integration-sdk-cli 10.5.1 → 10.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-cli",
-  "version": "10.5.1",
+  "version": "10.6.0",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -25,8 +25,8 @@
   },
   "dependencies": {
     "@jupiterone/data-model": "^0.54.0",
-    "@jupiterone/integration-sdk-core": "^10.5.1",
-    "@jupiterone/integration-sdk-runtime": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.6.0",
+    "@jupiterone/integration-sdk-runtime": "^10.6.0",
     "chalk": "^4",
     "commander": "^9.4.0",
     "fs-extra": "^10.1.0",
@@ -44,7 +44,7 @@
     "vis": "^4.21.0-EOL"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-private-test-utils": "^10.5.1",
+    "@jupiterone/integration-sdk-private-test-utils": "^10.6.0",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
@@ -56,5 +56,5 @@
     "memfs": "^3.2.0",
     "neo-forgery": "^2.0.0"
   },
-  "gitHead": "406470a2527bbf21bebbee2bea92ec225e9a4cc0"
+  "gitHead": "fd59e474ab606c422c73a3a82f9fdd9a6b10c9d1"
 }

package/src/__tests__/cli-run-failure.test.ts

@@ -2,11 +2,9 @@ import { Polly } from '@pollyjs/core';
 import NodeHttpAdapter from '@pollyjs/adapter-node-http';
 import FSPersister from '@pollyjs/persister-fs';
 import { loadProjectStructure } from '@jupiterone/integration-sdk-private-test-utils';
-import { SynchronizationJobStatus } from '@jupiterone/integration-sdk-core';
 import { generateSynchronizationJob } from './util/synchronization';
 import { createCli } from '../index';
 import { setupSynchronizerApi } from './util/synchronization';
-import * as log from '../log';
 import { createTestPolly } from './util/recording';
 
 jest.mock('../log');
@@ -37,6 +35,14 @@ test('aborts synchronization job if an error occurs', async () => {
 
   setupSynchronizerApi({ polly, job, baseUrl: 'https://api.us.jupiterone.io' });
 
+  let calledAbort = false;
+  polly.server
+    .post(
+      `https://api.us.jupiterone.io/persister/synchronization/jobs/${job.id}/abort`,
+    )
+    .intercept((req, res) => {
+      calledAbort = true;
+    });
   await createCli().parseAsync([
     'node',
     'j1-integration',
@@ -44,10 +50,5 @@ test('aborts synchronization job if an error occurs', async () => {
     '--integrationInstanceId',
     'test',
   ]);
-
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
-  expect(log.displaySynchronizationResults).toHaveBeenCalledWith({
-    ...job,
-    status: SynchronizationJobStatus.ABORTED,
-  });
+  expect(calledAbort).toBe(true);
 });

package/src/__tests__/cli-run.test.ts

@@ -10,12 +10,6 @@ import {
   setupSynchronizerApi,
 } from './util/synchronization';
 
-import {
-  StepResultStatus,
-  SynchronizationJobStatus,
-} from '@jupiterone/integration-sdk-core';
-
-import * as log from '../log';
 import { createTestPolly } from './util/recording';
 
 jest.mock('../log');
@@ -80,92 +74,19 @@ test('disables graph object schema validation', async () => {
   expect(process.env.ENABLE_GRAPH_OBJECT_SCHEMA_VALIDATION).toBeUndefined();
 });
 
-test('step should fail if enableSchemaValidation = true', async () => {
-  loadProjectStructure('instanceWithNonValidatingSteps');
-  const job = generateSynchronizationJob();
-
-  setupSynchronizerApi({
-    polly,
-    job,
-    baseUrl: 'https://api.us.jupiterone.io',
-  });
-
-  await createCli().parseAsync([
-    'node',
-    'j1-integration',
-    'run',
-    '--integrationInstanceId',
-    'test',
-  ]);
-
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
-
-  expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
-  expect(log.displayExecutionResults).toHaveBeenCalledWith({
-    integrationStepResults: [
-      {
-        id: 'fetch-users',
-        name: 'Fetch Users',
-        declaredTypes: ['my_user'],
-        partialTypes: [],
-        encounteredTypes: [],
-        status: StepResultStatus.FAILURE,
-      },
-    ],
-    metadata: {
-      partialDatasets: {
-        types: ['my_user'],
-      },
-    },
-  });
-});
-
-test('step should pass if enableSchemaValidation = false', async () => {
-  loadProjectStructure('instanceWithNonValidatingSteps');
-  const job = generateSynchronizationJob();
-
-  setupSynchronizerApi({
-    polly,
-    job,
-    baseUrl: 'https://api.us.jupiterone.io',
-  });
-
-  await createCli().parseAsync([
-    'node',
-    'j1-integration',
-    'run',
-    '--integrationInstanceId',
-    'test',
-    '--disable-schema-validation',
-  ]);
-
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
-
-  expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
-  expect(log.displayExecutionResults).toHaveBeenCalledWith({
-    integrationStepResults: [
-      {
-        id: 'fetch-users',
-        name: 'Fetch Users',
-        declaredTypes: ['my_user'],
-        partialTypes: [],
-        encounteredTypes: ['my_user'],
-        status: StepResultStatus.SUCCESS,
-      },
-    ],
-    metadata: {
-      partialDatasets: {
-        types: [],
-      },
-    },
-  });
-});
-
 test('executes integration and performs upload', async () => {
   const job = generateSynchronizationJob();
 
   setupSynchronizerApi({ polly, job, baseUrl: 'https://api.us.jupiterone.io' });
 
+  let calledFinalize = false;
+  polly.server
+    .post(
+      `https://api.us.jupiterone.io/persister/synchronization/jobs/${job.id}/finalize`,
+    )
+    .intercept((req, res) => {
+      calledFinalize = true;
+    });
   await createCli().parseAsync([
     'node',
     'j1-integration',
@@ -174,43 +95,7 @@ test('executes integration and performs upload', async () => {
     'test',
   ]);
 
-  expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
-  expect(log.displayExecutionResults).toHaveBeenCalledWith({
-    integrationStepResults: [
-      {
-        id: 'fetch-accounts',
-        name: 'Fetch Accounts',
-        declaredTypes: ['my_account'],
-        partialTypes: [],
-        encounteredTypes: ['my_account'],
-        status: StepResultStatus.SUCCESS,
-      },
-      {
-        id: 'fetch-users',
-        name: 'Fetch Users',
-        declaredTypes: ['my_user', 'my_account_has_user'],
-        partialTypes: [],
-        encounteredTypes: ['my_user', 'my_account_has_user'],
-        status: StepResultStatus.SUCCESS,
-      },
-    ],
-    metadata: {
-      partialDatasets: {
-        types: [],
-      },
-    },
-  });
-
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
-  expect(log.displaySynchronizationResults).toHaveBeenCalledWith({
-    ...job,
-    status: SynchronizationJobStatus.FINALIZE_PENDING,
-    // These are the expected number of entities and relationships
-    // collected when executing the
-    // 'typeScriptIntegrationProject' fixture
-    numEntitiesUploaded: 2,
-    numRelationshipsUploaded: 1,
-  });
+  expect(calledFinalize).toBe(true);
 });
 
 test('executes integration and skips finalization with skip-finalize', async () => {
@@ -222,6 +107,15 @@ test('executes integration and skips finalization with skip-finalize', async ()
     baseUrl: 'https://api.us.jupiterone.io',
   });
 
+  let calledFinalize = false;
+  polly.server
+    .post(
+      `https://api.us.jupiterone.io/persister/synchronization/jobs/${job.id}/finalize`,
+    )
+    .intercept((req, res) => {
+      calledFinalize = true;
+    });
+
   await createCli().parseAsync([
     'node',
     'j1-integration',
@@ -230,19 +124,7 @@ test('executes integration and skips finalization with skip-finalize', async ()
     'test',
     '--skip-finalize',
   ]);
-
-  expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
-
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
-  expect(log.displaySynchronizationResults).toHaveBeenCalledWith({
-    ...job,
-    status: SynchronizationJobStatus.AWAITING_UPLOADS,
-    // These are the expected number of entities and relationships
-    // collected when executing the
-    // 'typeScriptIntegrationProject' fixture
-    numEntitiesUploaded: 2,
-    numRelationshipsUploaded: 1,
-  });
+  expect(calledFinalize).toBe(false);
 });
 
 test('does not publish events for source "api" since there is no integrationJobId', async () => {
@@ -256,7 +138,9 @@ test('does not publish events for source "api" since there is no integrationJobI
 
   let eventsPublished = false;
   polly.server
-    .post(`https://example.com/persister/synchronization/jobs/${job.id}/events`)
+    .post(
+      `https://api.us.jupiterone.io/persister/synchronization/jobs/${job.id}/events`,
+    )
     .intercept((req, res) => {
       eventsPublished = true;
     });
@@ -272,8 +156,6 @@ test('does not publish events for source "api" since there is no integrationJobI
   ]);
 
   expect(eventsPublished).toBe(false);
-  expect(log.displayExecutionResults).toHaveBeenCalledTimes(1);
-  expect(log.displaySynchronizationResults).toHaveBeenCalledTimes(1);
 });
 
 test('should use JUPITERONE_API_KEY value in Authorization request header', async () => {

package/src/__tests__/util/synchronization.ts

@@ -97,8 +97,14 @@ export function generateSynchronizationJob(
     id: 'test',
     source: options?.source || 'integration-managed',
     scope: options?.scope,
-    integrationJobId: options?.integrationJobId || 'test-job-id',
-    integrationInstanceId: options?.integrationInstanceId || 'test-instance-id',
+    integrationJobId:
+      options?.source === 'api'
+        ? undefined
+        : options?.integrationJobId || 'test-job-id',
+    integrationInstanceId:
+      options?.source === 'api'
+        ? undefined
+        : options?.integrationInstanceId || 'test-instance-id',
     status: SynchronizationJobStatus.AWAITING_UPLOADS,
     startTimestamp: Date.now(),
     numEntitiesUploaded: 0,

package/src/commands/run.ts

@@ -17,7 +17,6 @@ import {
 import { createPersisterApiStepGraphObjectDataUploader } from '@jupiterone/integration-sdk-runtime/dist/src/execution/uploader';
 
 import { loadConfig } from '../config';
-import * as log from '../log';
 import {
   addApiClientOptionsToCommand,
   addLoggingOptions,
@@ -52,15 +51,19 @@ export function run(): Command {
 
       const clientApiOptions = getApiClientOptions(actionCommand.opts());
       const apiClient = createApiClient(clientApiOptions);
-      log.debug(
-        `Configured JupiterOne API client. (apiBaseUrl: '${clientApiOptions.apiBaseUrl}', account: ${clientApiOptions.account})`,
-      );
 
       let logger = createIntegrationLogger({
         name: 'local',
         pretty: !options.noPretty,
       });
 
+      logger.info(
+        {
+          apiBaseUrl: clientApiOptions.apiBaseUrl,
+        },
+        `Configured JupiterOne API Client`,
+      );
+
       const synchronizationContext = await initiateSynchronization({
         logger,
         apiClient,
@@ -116,20 +119,23 @@ export function run(): Command {
 
         await eventPublishingQueue.onIdle();
 
-        log.displayExecutionResults(executionResults);
-
         if (options.skipFinalize) {
-          log.info(
+          logger.info(
             'Skipping synchronization finalization. Job will remain in "AWAITING_UPLOADS" state.',
           );
-          const jobStatus = await synchronizationStatus(synchronizationContext);
-          log.displaySynchronizationResults(jobStatus);
+          const synchronizationJob = await synchronizationStatus(
+            synchronizationContext,
+          );
+          logger.info({ synchronizationJob }, 'Synchronization job status.');
         } else {
-          const synchronizationResult = await finalizeSynchronization({
+          const synchronizationJob = await finalizeSynchronization({
             ...synchronizationContext,
             partialDatasets: executionResults.metadata.partialDatasets,
           });
-          log.displaySynchronizationResults(synchronizationResult);
+          logger.info(
+            { synchronizationJob },
+            'Synchronization finalization result.',
+          );
         }
       } catch (err) {
         await eventPublishingQueue.onIdle();
@@ -144,8 +150,7 @@ export function run(): Command {
           ...synchronizationContext,
           reason: err.message,
         });
-
-        log.displaySynchronizationResults(abortResult);
+        logger.error({ abortResult }, 'Synchronization job abort result.');
       } finally {
         logger.publishMetric({
           name: 'duration-total',

package/src/generator/template/.github/workflows/build.yml.hbs

@@ -40,7 +40,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          token: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          token: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -49,5 +49,5 @@ jobs:
       - name: Build and Release
         uses: jupiterone/action-npm-build-release@v1
         with:
-          npm_auth_token: ${{ secrets.NPM_AUTH_TOKEN }}
-          gh_token: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          npm_auth_token: $\{{ secrets.NPM_AUTH_TOKEN }}
+          gh_token: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}

package/src/generator/template/.github/workflows/codeql-analysis.yml.hbs

@@ -42,7 +42,7 @@ jobs:
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         with:
-          languages: ${{ matrix.language }}
+          languages: $\{{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
           # By default, queries listed here will override any specified in a config file.
           # Prefix the list here with "+" to use these queries and those in the config file.

package/src/generator/template/.github/workflows/integration-deployment.yml.hbs

@@ -29,8 +29,8 @@ jobs:
         uses: JupiterOne/integration-github-actions/create-integration-deployment@v1
         with:
           integrationName:
-            ${{ steps.get-integration-name.outputs.integrationName }}
-          releaseNotes: ${{ github.event.release.body }}
-          version: ${{ steps.get-version-number.outputs.versionNumber }}
-          githubToken: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
-          npmAuthToken: ${{ secrets.NPM_AUTH_TOKEN }}
+            $\{{ steps.get-integration-name.outputs.integrationName }}
+          releaseNotes: $\{{ github.event.release.body }}
+          version: $\{{ steps.get-version-number.outputs.versionNumber }}
+          githubToken: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          npmAuthToken: $\{{ secrets.NPM_AUTH_TOKEN }}

package/src/generator/template/.github/workflows/peril.yml.hbs

@@ -41,7 +41,7 @@ jobs:
       - name: Configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:
-          role-to-assume: ${{ steps.get-vars.outputs.aws-oidc-role }}
+          role-to-assume: $\{{ steps.get-vars.outputs.aws-oidc-role }}
           role-session-name: pr-role-session
           aws-region: us-east-1
 
@@ -53,8 +53,8 @@ jobs:
         uses: docker/login-action@v2
         with:
           registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.PACKAGE_TOKEN }}
+          username: $\{{ github.actor }}
+          password: $\{{ secrets.PACKAGE_TOKEN }}
 
       - name: Pull security-scan
         run: |
@@ -66,9 +66,9 @@ jobs:
           --user root \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -v `pwd`:`pwd` \
-          -e AWS_ACCESS_KEY_ID=${{ env.AWS_ACCESS_KEY_ID }} \
-          -e AWS_SECRET_ACCESS_KEY=${{ env.AWS_SECRET_ACCESS_KEY }} \
-          -e AWS_SESSION_TOKEN=${{ env.AWS_SESSION_TOKEN }} \
+          -e AWS_ACCESS_KEY_ID=$\{{ env.AWS_ACCESS_KEY_ID }} \
+          -e AWS_SECRET_ACCESS_KEY=$\{{ env.AWS_SECRET_ACCESS_KEY }} \
+          -e AWS_SESSION_TOKEN=$\{{ env.AWS_SESSION_TOKEN }} \
           -e GITHUB_REPOSITORY=$GITHUB_REPOSITORY \
           -e GITHUB_REF_NAME=$GITHUB_REF_NAME \
           -e GITHUB_RUN_NUMBER=$GITHUB_RUN_NUMBER \
@@ -84,7 +84,7 @@ jobs:
       - name: Run transponder
         run: |
           docker run --rm -v `pwd`:`pwd` -w `pwd` \
-          -e J1_API_KEY=${{ secrets.J1_API_KEY_TRANSPONDER }} \
-          -e J1_API_DOMAIN=${{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
-          -e J1_ACCOUNT_ID=${{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
+          -e J1_API_KEY=$\{{ secrets.J1_API_KEY_TRANSPONDER }} \
+          -e J1_API_DOMAIN=$\{{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
+          -e J1_ACCOUNT_ID=$\{{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
           $TRANSPONDER_DOCKER_IMAGE

package/src/generator/template/.github/workflows/questions.yml.hbs

@@ -14,8 +14,8 @@ jobs:
       - name: Check out target branch questions
         uses: actions/checkout@v3
         with:
-          ref: ${{github.event.pull_request.head.ref}}
-          repository: ${{github.event.pull_request.head.repo.full_name}}
+          ref: $\{{github.event.pull_request.head.ref}}
+          repository: $\{{github.event.pull_request.head.repo.full_name}}
           path: target
 
       - id: setup-node
@@ -30,9 +30,9 @@ jobs:
       - name: Validate questions on target branch
         env:
           MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID:
-            ${{ secrets.MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID }}
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID }}
           MANAGED_QUESTIONS_JUPITERONE_API_KEY:
-            ${{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
         run:
           yarn --cwd source j1-integration validate-question-file -a
           --frozen-lockfile $MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID -k

package/src/generator/template/package.json.hbs

@@ -36,12 +36,12 @@
     "postversion": "cp package.json ./dist/package.json"
   },
   "peerDependencies": {
-    "@jupiterone/integration-sdk-core": "^9.0.0"
+    "@jupiterone/integration-sdk-core": "^10.5.0"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-core": "^9.0.0",
-    "@jupiterone/integration-sdk-dev-tools": "^9.0.0",
-    "@jupiterone/integration-sdk-testing": "^9.0.0",
+    "@jupiterone/integration-sdk-core": "^10.5.0",
+    "@jupiterone/integration-sdk-dev-tools": "^10.5.0",
+    "@jupiterone/integration-sdk-testing": "^10.5.0",
     "auto": "^10.36.5"
   },
   "auto": {

package/src/generator/template/src/config.ts.hbs

@@ -2,20 +2,19 @@ import {
   IntegrationExecutionContext,
   {{#if configFields}}IntegrationValidationError,{{/if}}
   IntegrationInstanceConfigFieldMap,
-  IntegrationInstanceConfig,
 } from '@jupiterone/integration-sdk-core';
 import { createAPIClient } from './client';
 
-export const instanceConfigFields: IntegrationInstanceConfigFieldMap = {
+export const instanceConfigFields = {
   {{#each configFields}}
   {{camelCase field}}: {
     type: '{{type}}',
     mask: {{mask}}
   },
   {{/each}}
-};
+} satisfies IntegrationInstanceConfigFieldMap;
 
-export interface IntegrationConfig extends IntegrationInstanceConfig {
+export interface IntegrationConfig {
   {{#each configFields}}
   {{camelCase field}}: {{ type }};
   {{/each}}

package/src/generator/template/src/steps/constants.ts.hbs

@@ -4,14 +4,13 @@ import {
   StepRelationshipMetadata,
 } from '@jupiterone/integration-sdk-core';
 
-export const Steps: Record<{{#unless steps}}string{{/unless}}{{#each steps}}'{{constantCase name}}'{{#unless @last}}|{{/unless}}{{/each}}, string> = {
+export const Steps = {
   {{#each steps}}
   {{constantCase name}}: '{{kebabCase name}}',
   {{/each}}
-};
+} satisfies Record<string, string>;
 
-export const Entities: Record<{{#unless entities}}string{{/unless}}{{#each entities}}'{{constantCase resourceName}}'{{#unless @last}}|{{/unless}}{{/each}}
-, StepEntityMetadata > = {
+export const Entities = {
   {{#each entities}}
   {{constantCase resourceName}}: {
     resourceName: '{{resourceName}}',
@@ -19,10 +18,9 @@ export const Entities: Record<{{#unless entities}}string{{/unless}}{{#each entit
     _class: [{{#each _class}}'{{this}}'{{#unless @last}},{{/unless}}{{/each}}],
   },
   {{/each}}
-};
+} satisfies Record<string, StepEntityMetadata>;
 
-export const Relationships: Record<{{#unless relationships}}string{{/unless}}{{#each relationships}}'{{constantCase (generateRelationshipName this)}}'{{#unless @last}}|{{/unless}}{{/each}},
-StepRelationshipMetadata> = {
+export const Relationships = {
   {{#each relationships}}
   {{constantCase (generateRelationshipName this)}}: {
     sourceType: Entities.{{ constantCase from.resourceName }}._type,
@@ -31,4 +29,4 @@ StepRelationshipMetadata> = {
     _class: RelationshipClass.{{_class}},
   },
   {{/each}}
-};
+} satisfies Record<string, StepRelationshipMetadata>;