feat(ses): Module descriptors for XS parity #2345

kriskowal · 2024-07-11T20:29:28Z

Description

This change introduces support for XS-compatible module descriptors with the discriminating properties source and namespace, including support for loading a module from the parent compartment.

Security Considerations

None.

Scaling Considerations

None.

Documentation Considerations

This change is additive.

Testing Considerations

Covered.

Compatibility Considerations

Some usage patterns are now deprecated but continue to be supported without complaint.

Upgrade Considerations

None.

erights · 2024-07-14T22:33:05Z

packages/ses/README.md


 ```js
 import 'ses';
-import { StaticModuleRecord } from '@endo/static-module-record';
+import { StaticModuleRecord as ModuleSource } from '@endo/static-module-record';


Could you move this renaming into @endo/static-module-record , if necessary still continuing to export the old name for now, but deprecated?

Actually, could we also rename the package from static-module-record to module-source?

I’ll follow-up. This is a good time.

erights · 2024-07-15T02:19:46Z

packages/ses/README.md

+default `importMeta` object is an empty object.
+
+Compartments copy the `importMeta` object properties into the module
+`import.meta` object like `Object.assign`.


Does it actually use Object.assign semantics, as in https://github.com/endojs/endo/blob/master/packages/pass-style/doc/enumerating-properties.md ?

This is copypasta from XS docs. We don’t actually implement importMeta yet, but if we did, we’d use Object.assign.

erights · 2024-07-15T02:34:38Z

packages/ses/README.md

+
+- Otherwise, the value of `namespace` property must be an object. The module is
+  loaded and initialized from the object according to the [virtual module
+  namespace](#VirtualModuleNamespace) pattern.


What does #VirtualModuleNamespace link to? I don't see it.

It’s an internal anchor to the corresponding heading.

Where is that corresponding heading? I did not see it.

erights · 2024-07-15T02:37:42Z

packages/ses/README.md

-  'c2': c2.module('./main.js'),
+const compartment = new Compartment({}, {
+  c: {
+    source: new StaticModuleRecord(''),


Suggested change

source: new StaticModuleRecord(''),

source: new ModuleSource(''),

please do a global search for stale names

I’ll do a follow-up.

erights · 2024-07-15T02:39:08Z

packages/ses/README.md

    const moduleText = fs.readFileSync(moduleLocation);
-    return new StaticModuleRecord(moduleText, moduleLocation);
+    return {
+      source: new StaticModuleRecord(moduleText, moduleLocation),


Suggested change

source: new StaticModuleRecord(moduleText, moduleLocation),

source: new ModuleSource(moduleText, moduleLocation),

packages/ses/README.md

erights · 2024-07-15T02:42:13Z

packages/ses/src/module-load.js

+        aliasDescriptor = weakmapGet(moduleAliases, namespace);
+        if (aliasDescriptor !== undefined) {
+          moduleDescriptor = aliasDescriptor;
+          // Fall through to processing the reesulting {compartment, specifier}


Suggested change

// Fall through to processing the reesulting {compartment, specifier}

// Fall through to processing the resulting {compartment, specifier}

erights

LGTM

The README.md is an awesome guide for stating this stuff precisely. Should already be much of the work towards spec text!

kriskowal · 2024-07-15T19:10:33Z

LGTM

The README.md is an awesome guide for stating this stuff precisely. Should already be much of the work towards spec text!

Credit where due https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/xs/XS%20Compartment.md#-module-descriptor

kriskowal changed the title ~~Kriskowal ses module descriptors xs parity~~ feat(ses): Module descriptors for XS parity Jul 11, 2024

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from 2a29262 to d3d8b9f Compare July 11, 2024 20:32

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 29e3f8d to 3147a5d Compare July 11, 2024 20:32

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from d3d8b9f to d3b447f Compare July 11, 2024 20:49

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 3147a5d to 319c8e1 Compare July 11, 2024 20:49

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from d3b447f to 91c3cd3 Compare July 11, 2024 21:06

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 319c8e1 to 8c74126 Compare July 11, 2024 21:06

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from 91c3cd3 to caf80a9 Compare July 12, 2024 23:33

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 8c74126 to c7fdfb2 Compare July 12, 2024 23:33

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from caf80a9 to db465e4 Compare July 12, 2024 23:58

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from c7fdfb2 to 6320908 Compare July 12, 2024 23:58

kriskowal requested a review from erights July 12, 2024 23:59

kriskowal marked this pull request as ready for review July 12, 2024 23:59

kriskowal mentioned this pull request Jul 13, 2024

Using XS native Compartments for Agoric Vat Workers #400

Open

29 tasks

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 6320908 to 68d8f93 Compare July 13, 2024 00:27

erights reviewed Jul 15, 2024

View reviewed changes

packages/ses/README.md Show resolved Hide resolved

erights reviewed Jul 15, 2024

View reviewed changes

erights approved these changes Jul 15, 2024

View reviewed changes

kriskowal force-pushed the kriskowal-ses-module-descriptors-refactor branch from db465e4 to 5df0f1a Compare July 15, 2024 22:54

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 68d8f93 to 984d3d2 Compare July 15, 2024 22:54

Base automatically changed from kriskowal-ses-module-descriptors-refactor to master July 15, 2024 23:05

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch 2 times, most recently from debd810 to 5998c1b Compare July 15, 2024 23:58

feat(ses): Module descriptor parity with XS

11f1345

kriskowal added 7 commits July 15, 2024 17:05

test(ses): Coverage for module source descriptors

018910b

docs(ses): Update modules in README

7e5a237

docs(ses): News on module descriptor parity

73f0615

types(ses): Add new module descriptor shapes

c2b87fa

refactor(ses): Internally rename StaticModuleRecord to ModuleSource

8f75b56

refactor: Rename static-module-record to module-source pervasively

38867fe

chore: Update yarn.lock

18796bc

kriskowal force-pushed the kriskowal-ses-module-descriptors-xs-parity branch from 5998c1b to 18796bc Compare July 16, 2024 00:05

kriskowal enabled auto-merge July 16, 2024 00:12

kriskowal merged commit d7c6639 into master Jul 16, 2024
17 checks passed

kriskowal deleted the kriskowal-ses-module-descriptors-xs-parity branch July 16, 2024 00:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ses): Module descriptors for XS parity #2345

feat(ses): Module descriptors for XS parity #2345

kriskowal commented Jul 11, 2024 •

edited

Loading

erights Jul 14, 2024

erights Jul 15, 2024

kriskowal Jul 15, 2024

erights Jul 15, 2024

kriskowal Jul 15, 2024

erights Jul 15, 2024

kriskowal Jul 15, 2024

erights Jul 15, 2024

erights Jul 15, 2024

erights Jul 15, 2024 •

edited

Loading

kriskowal Jul 15, 2024

erights Jul 15, 2024

erights Jul 15, 2024

erights left a comment

kriskowal commented Jul 15, 2024

	source: new StaticModuleRecord(''),
	source: new ModuleSource(''),

	source: new StaticModuleRecord(moduleText, moduleLocation),
	source: new ModuleSource(moduleText, moduleLocation),

	// Fall through to processing the reesulting {compartment, specifier}
	// Fall through to processing the resulting {compartment, specifier}

feat(ses): Module descriptors for XS parity #2345

feat(ses): Module descriptors for XS parity #2345

Conversation

kriskowal commented Jul 11, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Compatibility Considerations

Upgrade Considerations

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erights Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erights left a comment

Choose a reason for hiding this comment

kriskowal commented Jul 15, 2024

kriskowal commented Jul 11, 2024 •

edited

Loading

erights Jul 15, 2024 •

edited

Loading