feat(@jsii/spec): add loadAssemblyFromBuffer function (#3634)

Usage is demonstrated here: cdklabs/construct-hub#920 Two implementations were considered to fit the use case in construct hub, `loadAssemblyFromBuffer` and `loadAssemblyFromTarball`. I went with loading from a buffer because it allows us to utilize prior art in construct hub for parsing tarballs, does not need an added dependency on `tar`, and causes minimal impact when refactoring the ingestion lambda to use this function. Also includes a small refactoring of the test suite. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
aws · Jul 6, 2022 · 4f3a0d1 · 4f3a0d1
1 parent e13ef56
commit 4f3a0d1
Show file tree

Hide file tree

Showing 113 changed files with 559 additions and 288 deletions.
diff --git a/eslint-config.yaml b/eslint-config.yaml
@@ -8,6 +8,7 @@ plugins:
   - '@typescript-eslint'
   - import
   - prettier
+  - unicorn
 
 parser: '@typescript-eslint/parser'
 parserOptions:
@@ -43,6 +44,9 @@ rules:
   'prettier/prettier':
     - error
 
+  'unicorn/prefer-node-protocol':
+    - error
+
   '@typescript-eslint/array-type':
     - error
     - default: array-simple
@@ -152,7 +156,9 @@ rules:
 
   'import/no-extraneous-dependencies':
     - error
-    - devDependencies: ['**/test/**'] # Only allow importing devDependencies from tests
+    - devDependencies: # Only allow importing devDependencies from tests
+        - '**/test/**'
+        - '**/*.test.ts'
       optionalDependencies: false # Disallow importing optional dependencies (those shouldn't be used here)
       peerDependencies: false # Disallow importing peer dependencies (those shouldn't be used here)
 

diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
     "eslint-import-resolver-typescript": "^2.7.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-unicorn": "^43.0.0",
     "jest": "^28.1.1",
     "jest-circus": "^28.1.1",
     "jest-config": "^28.1.1",

diff --git a/packages/@jsii/benchmarks/bin/benchmark.ts b/packages/@jsii/benchmarks/bin/benchmark.ts
@@ -1,5 +1,5 @@
 import * as fs from 'fs-extra';
-import * as path from 'path';
+import * as path from 'node:path';
 import * as yargs from 'yargs';
 
 import { benchmarks } from '../lib';

diff --git a/packages/@jsii/benchmarks/lib/benchmark.ts b/packages/@jsii/benchmarks/lib/benchmark.ts
@@ -1,5 +1,9 @@
-import { Profiler, Session } from 'inspector';
-import { performance, PerformanceObserver, PerformanceEntry } from 'perf_hooks';
+import { Profiler, Session } from 'node:inspector';
+import {
+  performance,
+  PerformanceObserver,
+  PerformanceEntry,
+} from 'node:perf_hooks';
 
 /**
  * Result of a single run of the subject

diff --git a/packages/@jsii/benchmarks/lib/constants.ts b/packages/@jsii/benchmarks/lib/constants.ts
@@ -1,4 +1,4 @@
-import * as path from 'path';
+import * as path from 'node:path';
 
 export const fixturesDir = path.resolve(__dirname, '..', 'fixtures');
 

diff --git a/packages/@jsii/benchmarks/scripts/snapshot-package.ts b/packages/@jsii/benchmarks/scripts/snapshot-package.ts
@@ -1,8 +1,8 @@
-import * as cp from 'child_process';
 import * as fs from 'fs-extra';
 import * as glob from 'glob';
-import * as os from 'os';
-import * as path from 'path';
+import * as cp from 'node:child_process';
+import * as os from 'node:os';
+import * as path from 'node:path';
 import * as tar from 'tar';
 import * as ts from 'typescript';
 

diff --git a/packages/@jsii/check-node/src/constants.ts b/packages/@jsii/check-node/src/constants.ts
@@ -1,4 +1,4 @@
-import * as process from 'process';
+import * as process from 'node:process';
 import { Range, SemVer } from 'semver';
 
 const ONE_DAY_IN_MILLISECONDS = 86_400_000;

diff --git a/packages/@jsii/check-node/src/index.ts b/packages/@jsii/check-node/src/index.ts
@@ -1,6 +1,6 @@
 import { Chalk, bgYellow, bgYellowBright, bgRed } from 'chalk';
-import { error } from 'console';
-import { version } from 'process';
+import { error } from 'node:console';
+import { version } from 'node:process';
 
 import { NodeRelease } from './constants';
 

diff --git a/packages/@jsii/integ-test/test/build-cdk.test.ts b/packages/@jsii/integ-test/test/build-cdk.test.ts
@@ -1,8 +1,8 @@
 import { Octokit } from '@octokit/rest';
 import * as dotenv from 'dotenv';
 import { mkdtemp, readdir, remove } from 'fs-extra';
-import { tmpdir } from 'os';
-import * as path from 'path';
+import { tmpdir } from 'node:os';
+import * as path from 'node:path';
 
 import {
   downloadReleaseAsset,

diff --git a/packages/@jsii/integ-test/utils/index.ts b/packages/@jsii/integ-test/utils/index.ts
@@ -1,7 +1,7 @@
-import * as cp from 'child_process';
-import { IncomingMessage } from 'http';
-import * as https from 'https';
-import { Readable } from 'stream';
+import * as cp from 'node:child_process';
+import { IncomingMessage } from 'node:http';
+import * as https from 'node:https';
+import { Readable } from 'node:stream';
 import { extract } from 'tar';
 
 /**

diff --git a/packages/@jsii/kernel/src/kernel.test.ts b/packages/@jsii/kernel/src/kernel.test.ts
@@ -1,9 +1,9 @@
-import * as childProcess from 'child_process';
 import * as fs from 'fs-extra';
-import * as os from 'os';
-import { join } from 'path';
-import * as path from 'path';
-import * as vm from 'vm';
+import * as childProcess from 'node:child_process';
+import * as os from 'node:os';
+import { join } from 'node:path';
+import * as path from 'node:path';
+import * as vm from 'node:vm';
 
 import * as api from './api';
 import {

diff --git a/packages/@jsii/kernel/src/kernel.ts b/packages/@jsii/kernel/src/kernel.ts
@@ -1,11 +1,11 @@
 import * as spec from '@jsii/spec';
 import { loadAssemblyFromPath } from '@jsii/spec';
-import * as cp from 'child_process';
 import * as fs from 'fs-extra';
-import * as os from 'os';
-import * as path from 'path';
+import * as cp from 'node:child_process';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import * as vm from 'node:vm';
 import * as tar from 'tar';
-import * as vm from 'vm';
 
 import * as api from './api';
 import { TOKEN_REF } from './api';
@@ -49,7 +49,7 @@ export class Kernel {
     // I wonder if webpack has some pragma that allows opting-out at certain points
     // in the code.
     // eslint-disable-next-line @typescript-eslint/no-require-imports,@typescript-eslint/no-var-requires
-    const moduleLoad = require('module').Module._load;
+    const moduleLoad = require('node:module').Module._load;
     const nodeRequire = (p: string) => moduleLoad(p, module, false);
 
     this.sandbox = vm.createContext({

diff --git a/packages/@jsii/kernel/src/on-exit.ts b/packages/@jsii/kernel/src/on-exit.ts
@@ -1,5 +1,5 @@
 import * as fs from 'fs-extra';
-import * as process from 'process';
+import * as process from 'node:process';
 
 const removeSyncPaths = new Array<string>();
 

diff --git a/packages/@jsii/runtime/bin/jsii-runtime.ts b/packages/@jsii/runtime/bin/jsii-runtime.ts
@@ -1,10 +1,10 @@
 import '@jsii/check-node/run';
 
-import { spawn } from 'child_process';
-import { error } from 'console';
-import { constants as os } from 'os';
-import { resolve } from 'path';
-import { Duplex } from 'stream';
+import { spawn } from 'node:child_process';
+import { error } from 'node:console';
+import { constants as os } from 'node:os';
+import { resolve } from 'node:path';
+import { Duplex } from 'node:stream';
 
 // Spawn another node process, with the following file descriptor setup:
 // - No STDIN will be provided

diff --git a/packages/@jsii/runtime/lib/host.ts b/packages/@jsii/runtime/lib/host.ts
@@ -1,5 +1,5 @@
 import { api, Kernel } from '@jsii/kernel';
-import { EventEmitter } from 'events';
+import { EventEmitter } from 'node:events';
 
 import { Input, IInputOutput } from './in-out';
 

diff --git a/packages/@jsii/runtime/lib/sync-stdio.ts b/packages/@jsii/runtime/lib/sync-stdio.ts
@@ -1,4 +1,4 @@
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 
 const INPUT_BUFFER_SIZE = 1_048_576; // 1MiB (aka: 1024 * 1024), not related to max line length
 

diff --git a/packages/@jsii/runtime/test/kernel-host.test.ts b/packages/@jsii/runtime/test/kernel-host.test.ts
@@ -1,9 +1,9 @@
 import { api } from '@jsii/kernel';
 import * as spec from '@jsii/spec';
 import { loadAssemblyFromPath } from '@jsii/spec';
-import * as child from 'child_process';
-import * as fs from 'fs';
-import * as path from 'path';
+import * as child from 'node:child_process';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 
 import { KernelHost, IInputOutput, Input, Output } from '../lib';
 

diff --git a/packages/@jsii/runtime/test/playback.test.ts b/packages/@jsii/runtime/test/playback.test.ts
@@ -1,7 +1,7 @@
-import * as child from 'child_process';
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
+import * as child from 'node:child_process';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
 
 import { IInputOutput, Input, KernelHost, Output } from '../lib';
 

diff --git a/packages/@jsii/spec/build-tools/generate-json-schema.sh b/packages/@jsii/spec/build-tools/generate-json-schema.sh
@@ -1,20 +1,42 @@
 #!/bin/bash
 set -euo pipefail
 
-# Input
-INPUT_FILE='lib/assembly.d.ts'
-
-# Output
-OUTPUT_DIR='schema'
-OUTPUT_FILE="${OUTPUT_DIR}/jsii-spec.schema.json"
-
-mkdir -p ${OUTPUT_DIR}
-
-echo "Generating JSON schema into ${OUTPUT_FILE}"
-typescript-json-schema                   \
-    ${INPUT_FILE}      'Assembly'        \
-    --out              ${OUTPUT_FILE}    \
-    --refs             true              \
-    --required         true              \
-    --strictNullChecks true              \
-    --topRef           true
+{
+    # Input
+    INPUT_FILE='lib/assembly.d.ts'
+
+    # Output
+    OUTPUT_DIR='schema'
+    OUTPUT_FILE="${OUTPUT_DIR}/jsii-spec.schema.json"
+
+    mkdir -p ${OUTPUT_DIR}
+
+    echo "Generating JSON schema into ${OUTPUT_FILE}"
+    typescript-json-schema                   \
+        ${INPUT_FILE}      'Assembly'        \
+        --out              ${OUTPUT_FILE}    \
+        --refs             true              \
+        --required         true              \
+        --strictNullChecks true              \
+        --topRef           true
+}
+
+{
+    # Input
+    INPUT_FILE='lib/redirect.d.ts'
+
+    # Output
+    OUTPUT_DIR='schema'
+    OUTPUT_FILE="${OUTPUT_DIR}/assembly-redirect.schema.json"
+
+    mkdir -p ${OUTPUT_DIR}
+
+    echo "Generating JSON schema into ${OUTPUT_FILE}"
+    typescript-json-schema                   \
+        ${INPUT_FILE}      'AssemblyRedirect'\
+        --out              ${OUTPUT_FILE}    \
+        --refs             true              \
+        --required         true              \
+        --strictNullChecks true              \
+        --topRef           true
+}
diff --git a/packages/@jsii/spec/package.json b/packages/@jsii/spec/package.json
@@ -31,10 +31,10 @@
     "package": "package-js"
   },
   "dependencies": {
-    "ajv": "^8.11.0",
-    "fs-extra": "^10.1.0"
+    "ajv": "^8.11.0"
   },
   "devDependencies": {
+    "fs-extra": "^10.1.0",
     "jsii-build-tools": "^0.0.0",
     "typescript-json-schema": "^0.53.1"
   }