Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add globalThis.VatData.passStyleOf to liveslots-hosted vat environment #9431

Closed
wants to merge 5 commits into from
Closed

add globalThis.VatData.passStyleOf to liveslots-hosted vat environment #9431

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b337eef
fix: add passStyleOf to VatData global
erights Jul 14, 2023
2ace6d9
add globalThis.VatData.passStyleOf to liveslots-hosted vat environment
warner May 31, 2024
f262d8c
use symbol-named property instead of globalThis.passStyleOf
warner May 31, 2024
978a59e
change liveslots to provide passStyleOf on a symbol-named property
warner Jul 24, 2024
9f0d4b8
move harden() back to original spot
warner Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/SwingSet/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"@endo/init": "^1.0.4",
"@endo/marshal": "^1.3.0",
"@endo/nat": "^5.0.4",
"@endo/pass-style": "^1.2.0",
"@endo/patterns": "^1.2.0",
"@endo/promise-kit": "^1.0.4",
"@endo/ses-ava": "^1.1.2",
Expand Down
2 changes: 2 additions & 0 deletions packages/SwingSet/test/test-vat-env.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ async function testForExpectedGlobals(t, workerType) {
'VatData.makeScalarBigWeakMapStore: function',
'VatData.makeScalarBigSetStore: function',
'VatData.makeScalarBigWeakSetStore: function',
'global has passStyleOf: true',
'global passStyleOf is special: true',
]);
}

Expand Down
5 changes: 5 additions & 0 deletions packages/SwingSet/test/vat-envtest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// @ts-nocheck
/* global VatData */
import { Far } from '@endo/far';
import { passStyleOf } from '@endo/pass-style';
import { PassStyleOfEndowmentSymbol } from '@endo/pass-style/endow.js';

export function buildRootObject(vatPowers) {
const log = vatPowers.testLog;
Expand All @@ -13,6 +15,9 @@ export function buildRootObject(vatPowers) {
for (const prop of Object.keys(VatData)) {
log(`VatData.${prop}: ${typeof VatData[prop]}`);
}
const globalPassStyleOf = globalThis && globalThis[PassStyleOfEndowmentSymbol];
log(`global has passStyleOf: ${!!globalPassStyleOf}`);
log(`global passStyleOf is special: ${globalPassStyleOf !== passStyleOf}`);
},
});
}
15 changes: 7 additions & 8 deletions packages/swingset-liveslots/src/liveslots.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
/* eslint @typescript-eslint/no-floating-promises: "warn" */
import {
Remotable,
passStyleOf,
getInterfaceOf,
makeMarshal,
} from '@endo/marshal';
import { Remotable, getInterfaceOf, makeMarshal } from '@endo/marshal';
import { assert, Fail } from '@agoric/assert';
import { passStyleOf } from '@endo/pass-style';
import { PassStyleOfEndowmentSymbol } from '@endo/pass-style/endow.js';
import { isPromise } from '@endo/promise-kit';
import { E, HandledPromise } from '@endo/eventual-send';
import { insistVatType, makeVatSlot, parseVatSlot } from './parseVatSlots.js';
Expand Down Expand Up @@ -1323,7 +1320,7 @@ function build(
syscall.dropImports([slot]);
}

const vatGlobals = harden({
const vatGlobals = {
VatData: {
defineKind: vom.defineKind,
defineKindMulti: vom.defineKindMulti,
Expand All @@ -1338,7 +1335,9 @@ function build(
makeScalarBigSetStore: collectionManager.makeScalarBigSetStore,
makeScalarBigWeakSetStore: collectionManager.makeScalarBigWeakSetStore,
},
});
[PassStyleOfEndowmentSymbol]: passStyleOf,
};
harden(vatGlobals);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objection to doing the harden here. But curious about your motivation for moving it? There's no mutation between the initialization and the harden, so the more traditional harden around the object literal should still be equivalent.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember why I moved it.. I'll move it back.


const inescapableGlobalProperties = harden({
WeakMap: vom.VirtualObjectAwareWeakMap,
Expand Down
1 change: 1 addition & 0 deletions packages/swingset-liveslots/src/vatDataTypes.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ export type VatData = {
options?: StoreOptions,
) => WeakSetStore<K>;
canBeDurable: (specimen: unknown) => boolean;
passStyleOf: (specimen: unknown) => string;
};

// The JSDoc is repeated here and at the function definition so it appears
Expand Down
60 changes: 60 additions & 0 deletions packages/swingset-liveslots/test/test-vat-environment.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import '@endo/init/debug.js';
import test from 'ava';
import { Far } from '@endo/marshal';
import { kser } from '@agoric/kmarshal';
import { passStyleOf } from '@endo/pass-style';
import { PassStyleOfEndowmentSymbol } from '@endo/pass-style/endow.js';
import { makeLiveSlots } from '../src/index.js';
import { makeStartVat } from './util.js';
import { buildSyscall } from './liveslots-helpers.js';
import { makeMockGC } from './mock-gc.js';

test('vat globals', async t => {
const { syscall } = buildSyscall();
const gcTools = makeMockGC();
const buildRootObject = () => Far('root', {});
let called = 0;
let vatGlobals;
let inescapableGlobalProperties;
const vatNS = harden({ buildRootObject });
// buildVatNamespace
const bVN = async (vG, iGP) => {
called += 1;
vatGlobals = vG;
inescapableGlobalProperties = iGP;
return vatNS;
};

const ls = makeLiveSlots(syscall, 'vatA', {}, {}, gcTools, undefined, bVN);
t.is(called, 0); // not called yet
await ls.dispatch(makeStartVat(kser()));
t.is(called, 1);
t.truthy(vatGlobals);

// 'harden' is provided by SES (installed by the supervisor), not liveslots
t.is(typeof vatGlobals.harden, 'undefined');

// but liveslots provides VatData
t.is(typeof vatGlobals.VatData, 'object');
t.is(typeof vatGlobals.VatData, 'object');
t.is(typeof vatGlobals.VatData.defineKind, 'function');
t.is(typeof vatGlobals.VatData.defineKindMulti, 'function');
t.is(typeof vatGlobals.VatData.defineDurableKind, 'function');
t.is(typeof vatGlobals.VatData.defineDurableKindMulti, 'function');
t.is(typeof vatGlobals.VatData.makeKindHandle, 'function');
t.is(typeof vatGlobals.VatData.canBeDurable, 'function');
t.is(typeof vatGlobals.VatData.providePromiseWatcher, 'function');
t.is(typeof vatGlobals.VatData.watchPromise, 'function');
t.is(typeof vatGlobals.VatData.makeScalarBigMapStore, 'function');
t.is(typeof vatGlobals.VatData.makeScalarBigWeakMapStore, 'function');
t.is(typeof vatGlobals.VatData.makeScalarBigSetStore, 'function');
t.is(typeof vatGlobals.VatData.makeScalarBigWeakSetStore, 'function');
t.is(typeof vatGlobals[PassStyleOfEndowmentSymbol], 'function');
// this is the passStyleOf created by liveslots, with a real WeakMap
t.is(vatGlobals[PassStyleOfEndowmentSymbol], passStyleOf);

t.is(typeof inescapableGlobalProperties.WeakMap, 'function');
t.not(inescapableGlobalProperties.WeakMap, WeakMap);
t.is(typeof inescapableGlobalProperties.WeakSet, 'function');
t.not(inescapableGlobalProperties.WeakSet, WeakSet);
});
2 changes: 2 additions & 0 deletions packages/swingset-liveslots/tools/setup-vat-data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// This file produces the globalThis.VatData property outside of a running
// SwingSet so that it can be used by '@agoric/vat-data' (which only *consumes*
// `globalThis.VatData`) in code under test.
import { passStyleOf } from '@endo/pass-style';
import { makeFakeVirtualStuff } from './fakeVirtualSupport.js';

const { WeakMap, WeakSet } = globalThis;
Expand Down Expand Up @@ -35,6 +36,7 @@ globalThis.VatData = harden({
fakeVomKit.cm.makeScalarBigSetStore(...args),
makeScalarBigWeakSetStore: (...args) =>
fakeVomKit.cm.makeScalarBigWeakSetStore(...args),
passStyleOf,
});

export const reincarnate = (options = {}) => {
Expand Down
1 change: 1 addition & 0 deletions packages/vat-data/src/vat-data-bindings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ if ('VatData' in globalThis) {
makeScalarBigSetStore: unavailable,
makeScalarBigWeakSetStore: unavailable,
canBeDurable: unavailable,
passStyleOf: unavailable, // not exported from here in any case
};
}

Expand Down
1 change: 1 addition & 0 deletions packages/vats/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"@endo/import-bundle": "^1.0.4",
"@endo/marshal": "^1.3.0",
"@endo/nat": "^5.0.4",
"@endo/pass-style": "^1.2.0",
"@endo/patterns": "^1.2.0",
"@endo/promise-kit": "^1.0.4",
"import-meta-resolve": "^2.2.1",
Expand Down
Loading