Merge branch 'master' into naugtur/fix-defering-errors

# By Turadg Aleahmad (11) and others # Via GitHub (4) and Kris Kowal (1) * master: docs(ses): Finish embracing permits terminology fix(ses): Clarify lockdown types feat(ses): Lockdown reporting option chore(deps): yarn dedupe chore(types): fix import tags lint: enable jsdoc/recommended-typescript-flavor chore: rm dup config key chore(deps): bump eslint-plugin-jsdoc build(deps): bump typescript (patch) chore(types): conform to verbatimModuleSyntax ci: enable verbatimModuleSyntax style: prettier chore(deps): bump prettier build(deps): bump yarn to 4.5.1 feat(compartment-mapper): Collect unretained module descriptors test(compartment-mapper): Mark and sweep unused module descriptors feat(ses): permit Promise.prototype.try (#2609) # Conflicts: # packages/compartment-mapper/NEWS.md
endojs · Nov 4, 2024 · 35dcdbc · 35dcdbc
2 parents a04f06b + 08d3945
commit 35dcdbc
Show file tree

Hide file tree

Showing 80 changed files with 740 additions and 705 deletions.
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   "engines": {
     "node": ">=16"
   },
-  "packageManager": "yarn@4.4.0",
+  "packageManager": "yarn@4.5.1",
   "devDependencies": {
     "@jessie.js/eslint-plugin": "^0.4.1",
     "@octokit/core": "^3.4.0",
@@ -18,13 +18,13 @@
     "eslint-config-jessie": "^0.0.6",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.2.5",
+    "eslint-plugin-jsdoc": "^50.4.3",
     "lerna": "^8.1.8",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.3",
     "type-coverage": "^2.29.1",
     "typedoc": "^0.26.6",
     "typedoc-plugin-markdown": "^4.2.5",
-    "typescript": "~5.6.2",
+    "typescript": "~5.6.3",
     "typescript-eslint": "^7.3.1",
     "zx": "^8.1.8"
   },

diff --git a/packages/base64/package.json b/packages/base64/package.json
@@ -50,8 +50,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/bundle-source/package.json b/packages/bundle-source/package.json
@@ -44,7 +44,7 @@
     "ava": "^6.1.3",
     "c8": "^7.14.0",
     "eslint": "^8.57.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "keywords": [],
   "files": [

diff --git a/packages/captp/package.json b/packages/captp/package.json
@@ -55,7 +55,7 @@
     "@endo/ses-ava": "workspace:^",
     "ava": "^6.1.3",
     "c8": "^7.14.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "dependencies": {
     "@endo/errors": "workspace:^",

diff --git a/packages/check-bundle/package.json b/packages/check-bundle/package.json
@@ -56,8 +56,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/cjs-module-analyzer/package.json b/packages/cjs-module-analyzer/package.json
@@ -40,8 +40,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -58,8 +58,8 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
     "execa": "^9.3.0",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/cli/test/_types.d.ts b/packages/cli/test/_types.d.ts
@@ -2,7 +2,7 @@ import type { Execa } from 'execa';
 
 export type Expectation = {
   stdout: RegExp | string | undefined;
-  stderr: RegExp | string | undefined;
+  stderr?: RegExp | string | undefined;
 };
 export type TestCommand = (
   command: ReturnType<Execa>,

diff --git a/packages/cli/test/demo/confined-script.js b/packages/cli/test/demo/confined-script.js
@@ -1,4 +1,4 @@
-/** @import {TestRoutine} from '../types */
+/** @import {TestRoutine} from '../_types.js'; */
 
 /** @type {TestRoutine} */
 export const section = async (execa, testLine) => {

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -51,7 +51,7 @@
     "ava": "^6.1.3",
     "c8": "^7.14.0",
     "tsd": "^0.31.2",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/compartment-mapper/NEWS.md b/packages/compartment-mapper/NEWS.md
@@ -1,7 +1,9 @@
 User-visible changes to `@endo/compartment-mapper`:
 
-# Next release
+# Next version
 
+- Omits unused module descriptors from `compartment-map.json` in archived
+  applications, potentially reducing file sizes.
 - Fixes an issue where errors thrown from exit module hooks (`importHook`) would
   be thrown at parse-time instead of at runtime. Such errors will now be thrown
   at runtime, as expected. To those who expected the previous behavior: if you

diff --git a/packages/compartment-mapper/package.json b/packages/compartment-mapper/package.json
@@ -70,8 +70,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/compartment-mapper/src/archive-lite.js b/packages/compartment-mapper/src/archive-lite.js
@@ -148,22 +148,25 @@ const translateCompartmentMap = (compartments, sources, compartmentRenames) => {
   const result = create(null);
   for (const compartmentName of keys(compartmentRenames)) {
     const compartment = compartments[compartmentName];
-    const { name, label, retained, policy } = compartment;
-    if (retained) {
+    const { name, label, retained: compartmentRetained, policy } = compartment;
+    if (compartmentRetained) {
       // rename module compartments
       /** @type {Record<string, ModuleDescriptor>} */
       const modules = create(null);
       const compartmentModules = compartment.modules;
       if (compartment.modules) {
         for (const name of keys(compartmentModules).sort()) {
-          const module = compartmentModules[name];
-          if (module.compartment !== undefined) {
-            modules[name] = {
-              ...module,
-              compartment: compartmentRenames[module.compartment],
-            };
-          } else {
-            modules[name] = module;
+          const { retained: moduleRetained, ...retainedModule } =
+            compartmentModules[name];
+          if (moduleRetained) {
+            if (retainedModule.compartment !== undefined) {
+              modules[name] = {
+                ...retainedModule,
+                compartment: compartmentRenames[retainedModule.compartment],
+              };
+            } else {
+              modules[name] = retainedModule;
+            }
           }
         }
       }

diff --git a/packages/compartment-mapper/src/compartment-map.js b/packages/compartment-mapper/src/compartment-map.js
@@ -107,7 +107,7 @@ const assertConditions = (conditions, url) => {
  * @param {string} url
  */
 const assertCompartmentModule = (allegedModule, path, url) => {
-  const { compartment, module, ...extra } = allegedModule;
+  const { compartment, module, retained, ...extra } = allegedModule;
   assertEmptyObject(
     extra,
     `${path} must not have extra properties, got ${q({
@@ -125,6 +125,13 @@ const assertCompartmentModule = (allegedModule, path, url) => {
     'string',
     `${path}.module must be a string, got ${q(module)} in ${q(url)}`,
   );
+  if (retained !== undefined) {
+    assert.typeof(
+      retained,
+      'boolean',
+      `${path}.retained must be a boolean, got ${q(retained)} in ${q(url)}`,
+    );
+  }
 };
 
 /**

diff --git a/packages/compartment-mapper/src/import-hook.js b/packages/compartment-mapper/src/import-hook.js
@@ -269,6 +269,7 @@ function* chooseModuleDescriptor(
   for (const candidateSpecifier of candidates) {
     const candidateModuleDescriptor = moduleDescriptors[candidateSpecifier];
     if (candidateModuleDescriptor !== undefined) {
+      candidateModuleDescriptor.retained = true;
       const { compartment: candidateCompartmentName = packageLocation } =
         candidateModuleDescriptor;
       const candidateCompartment = compartments[candidateCompartmentName];
@@ -339,6 +340,7 @@ function* chooseModuleDescriptor(
       // module specifier than the requested one.
       if (candidateSpecifier !== moduleSpecifier) {
         moduleDescriptors[moduleSpecifier] = {
+          retained: true,
           module: candidateSpecifier,
           compartment: packageLocation,
         };

diff --git a/packages/compartment-mapper/src/link.js b/packages/compartment-mapper/src/link.js
@@ -112,6 +112,8 @@ const makeModuleMapHook = (
 
     const moduleDescriptor = moduleDescriptors[moduleSpecifier];
     if (moduleDescriptor !== undefined) {
+      moduleDescriptor.retained = true;
+
       // "foreignCompartmentName" refers to the compartment which
       // may differ from the current compartment
       const {
@@ -193,6 +195,7 @@ const makeModuleMapHook = (
         // a moduleMapHook when we assemble compartments from the resulting
         // archive.
         moduleDescriptors[moduleSpecifier] = {
+          retained: true,
           compartment: foreignCompartmentName,
           module: foreignModuleSpecifier,
         };

diff --git a/packages/compartment-mapper/src/types.js b/packages/compartment-mapper/src/types.js
@@ -61,13 +61,14 @@ export {};
  * `package.json`, there is a corresponding module descriptor.
  *
  * @typedef {object} ModuleDescriptor
- * @property {string=} [compartment]
+ * @property {string} [compartment]
  * @property {string} [module]
  * @property {string} [location]
  * @property {Language} [parser]
  * @property {string} [sha512] in base 16, hex
  * @property {string} [exit]
  * @property {string} [deferredError]
+ * @property {boolean} [retained]
  */
 
 /**

diff --git a/packages/compartment-mapper/test/fixtures-retained/node_modules/mk1/package.json b/packages/compartment-mapper/test/fixtures-retained/node_modules/mk1/package.json
diff --git a/packages/compartment-mapper/test/retained.test.js b/packages/compartment-mapper/test/retained.test.js
@@ -32,4 +32,14 @@ test('archives only contain compartments retained by modules', async t => {
     // Notably absent:
     // 'sweep-v1.0.0',
   ]);
+  t.deepEqual(
+    Object.keys(compartmentMap.compartments['app-v1.0.0'].modules).sort(),
+    [
+      './app.js',
+      // Notably absent: 'app',
+      'mk1',
+      // Notably absent: 'mk1/bogus.js',
+      // Notably absent: 'sweep',
+    ],
+  );
 });
diff --git a/packages/daemon/package.json b/packages/daemon/package.json
@@ -75,8 +75,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/daemon/src/worker-node-powers.js b/packages/daemon/src/worker-node-powers.js
@@ -2,7 +2,7 @@
 
 import { makeNodeReader, makeNodeWriter } from '@endo/stream-node';
 
-/** @import { MignonicPowers } from './types.js' } */
+/** @import {MignonicPowers} from './types.js'; */
 
 /**
  * @param {object} modules

diff --git a/packages/env-options/package.json b/packages/env-options/package.json
@@ -41,8 +41,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/errors/package.json b/packages/errors/package.json
@@ -45,7 +45,7 @@
     "c8": "^7.14.0",
     "ses0_18_3": "npm:[email protected]",
     "tsd": "^0.31.2",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/eslint-plugin/lib/configs/style.js b/packages/eslint-plugin/lib/configs/style.js
@@ -1,5 +1,9 @@
 module.exports = {
-  extends: ['airbnb-base', 'plugin:jsdoc/recommended', 'prettier'],
+  extends: [
+    'airbnb-base',
+    'plugin:jsdoc/recommended-typescript-flavor',
+    'prettier',
+  ],
   rules: {
     quotes: [
       'error',
@@ -22,13 +26,6 @@ module.exports = {
     'prefer-regex-literals': 'off',
     'no-else-return': 'off',
     'no-console': 'off',
-    'no-unused-vars': [
-      'error',
-      {
-        argsIgnorePattern: '^_',
-        varsIgnorePattern: '^_',
-      },
-    ],
     'no-return-assign': 'off',
     'no-param-reassign': 'off',
     'no-promise-executor-return': 'off', // common to return setTimeout(), we know the value won't be accessible

diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -20,7 +20,7 @@
   "dependencies": {
     "requireindex": "~1.1.0",
     "tsutils": "~3.21.0",
-    "typescript": "~5.6.2",
+    "typescript": "~5.6.3",
     "typescript-eslint": "^7.3.1"
   },
   "devDependencies": {

diff --git a/packages/evasive-transform/package.json b/packages/evasive-transform/package.json
@@ -50,7 +50,7 @@
     "eslint": "^8.57.0",
     "rollup": "^2.79.1",
     "tsd": "^0.31.2",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/eventual-send/package.json b/packages/eventual-send/package.json
@@ -43,7 +43,7 @@
     "ava": "^6.1.3",
     "c8": "^7.14.0",
     "tsd": "^0.31.2",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "keywords": [
     "eventual send",

diff --git a/packages/exo/package.json b/packages/exo/package.json
@@ -51,8 +51,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.5",
-    "typescript": "~5.6.2"
+    "prettier": "^3.3.3",
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/far/package.json b/packages/far/package.json
@@ -42,7 +42,7 @@
     "@endo/ses-ava": "workspace:^",
     "ava": "^6.1.3",
     "c8": "^7.14.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "keywords": [
     "eventual send",

diff --git a/packages/immutable-arraybuffer/package.json b/packages/immutable-arraybuffer/package.json
@@ -40,7 +40,7 @@
     "ava": "^6.1.3",
     "c8": "^7.14.0",
     "tsd": "^0.31.2",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",

diff --git a/packages/import-bundle/package.json b/packages/import-bundle/package.json
@@ -51,7 +51,7 @@
     "@endo/ses-ava": "workspace:^",
     "ava": "^6.1.3",
     "c8": "^7.14.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.6.3"
   },
   "files": [
     "./*.d.ts",