Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion packages/shims/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"changelog:validate": "../../scripts/validate-changelog.sh @ocap/shims",
"clean": "rimraf --glob ./dist './*.tsbuildinfo'",
"publish:preview": "yarn npm publish --tag preview",
"test": "vitest run --config vitest.config.ts --passWithNoTests",
"test": "yarn build && ava && vitest run --config vitest.config.ts --passWithNoTests",
"test:clean": "yarn test --no-cache --coverage.clean",
"test:dev": "yarn test --coverage false",
"test:verbose": "yarn test --reporter verbose",
Expand All @@ -40,8 +40,10 @@
"devDependencies": {
"@endo/bundle-source": "^3.3.0",
"@metamask/auto-changelog": "^3.4.4",
"ava": "^6.1.3",
"deepmerge": "^4.3.1",
"rimraf": "^6.0.1",
"vite": "^5.3.5",
"vitest": "^2.0.5"
},
"engines": {
Expand Down
56 changes: 31 additions & 25 deletions packages/shims/scripts/bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,47 @@ import 'ses';
import '@endo/lockdown/commit.js';

import bundleSource from '@endo/bundle-source';
import { copyFile, mkdir, writeFile } from 'fs/promises';
import { createReadStream, createWriteStream } from 'fs';
import { mkdir } from 'fs/promises';
import path from 'path';
import { rimraf } from 'rimraf';
import { Readable } from 'stream';
import { fileURLToPath } from 'url';

console.log('Bundling shims...');

const rootDir = path.resolve(import.meta.dirname, '..');
const rootDir = fileURLToPath(new URL('..', import.meta.url));
const src = path.resolve(rootDir, 'src');
const dist = path.resolve(rootDir, 'dist');
const fileNames = {
endoify: 'endoify.mjs',
eventualSend: 'eventual-send.mjs',
applyLockdown: 'apply-lockdown.mjs',
};

await mkdir(dist, { recursive: true });
await rimraf(`${dist}/*`);

for (const fileName of [fileNames.endoify, fileNames.applyLockdown]) {
await copyFile(path.resolve(src, fileName), path.resolve(dist, fileName));
}

const eventualSendSourcePath = fileURLToPath(
import.meta.resolve('@endo/eventual-send/shim.js'),
);
await rimraf(`${dist}/*`, { glob: true });

/**
* Bundles the target file as endoScript and returns the content as a readable stream.
*
* @param {string} specifier - Import path to the file to bundle, e.g. '@endo/eventual-send/shim.js'.
* @returns {Promise<Readable>} A readable stream of the bundle contents.
*/
const createEndoBundleReadStream = async (specifier) => {
const filePath = fileURLToPath(import.meta.resolve(specifier));
const { source: bundle } = await bundleSource(filePath, {
format: 'endoScript',
});
return Readable.from(bundle);
};

const { source: eventualSendBundleSource } = await bundleSource(
eventualSendSourcePath,
{ format: 'endoScript' },
);
const sources = [
createReadStream(
path.resolve(rootDir, '../../node_modules/ses/dist/ses.mjs'),
),
await createEndoBundleReadStream('@endo/eventual-send/shim.js'),
createReadStream(path.resolve(src, 'endoify.mjs')),
];

await writeFile(
path.resolve(dist, fileNames.eventualSend),
eventualSendBundleSource,
);
const target = createWriteStream(path.resolve(dist, 'endoify.mjs'));

console.log('Success!');
sources[0].pipe(target, { end: false });
sources[0].on('end', () => sources[1].pipe(target, { end: false }));
sources[1].on('end', () => sources[2].pipe(target, { end: true }));
sources[2].on('end', () => console.log('Success!'));
14 changes: 14 additions & 0 deletions packages/shims/src/endoify-shimmed.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import '@ocap/shims/endoify';
import test from 'ava';

/* eslint-disable id-length */

test('endoify calls lockdown', (t) => {
t.assert(Object.isFrozen(Array.prototype)); // Due to `lockdown()`, and therefore `ses`
});

test('endoify loads eventual-send', (t) => {
t.assert(typeof HandledPromise !== 'undefined'); // Due to eventual send
});

/* eslint-enable id-length */
13 changes: 13 additions & 0 deletions packages/shims/src/endoify-unshimmed.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import test from 'ava';

/* eslint-disable id-length */

test('lockdown not called', (t) => {
t.assert(!Object.isFrozen(Array.prototype)); // Due to `lockdown()`, and therefore `ses`
});

test('eventual-send not loaded', (t) => {
t.assert(typeof HandledPromise === 'undefined'); // Due to eventual send
});

/* eslint-enable id-length */
7 changes: 4 additions & 3 deletions packages/shims/src/endoify.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import './ses.mjs';
import './eventual-send.mjs';

/* eslint-disable import-x/unambiguous */
// @inline './ses.mjs';
// @inline './eventual-send.mjs';
lockdown({
consoleTaming: 'unsafe',
errorTaming: 'unsafe',
Expand All @@ -9,3 +9,4 @@ lockdown({
domainTaming: 'unsafe',
overrideTaming: 'severe',
});
/* eslint-enable import-x/unambiguous */
14 changes: 13 additions & 1 deletion packages/shims/vitest.config.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
// eslint-disable-next-line spaced-comment
/// <reference types="vitest" />

import { defineConfig, mergeConfig } from 'vite';

import { getDefaultConfig } from '../../vitest.config.packages.js';

const config = getDefaultConfig();
const defaultConfig = getDefaultConfig();

const config = mergeConfig(
defaultConfig,
defineConfig({
test: {
exclude: ['endoify-*shimmed.test.*'],
},
}),
);

// @ts-expect-error We can and will delete this.
delete config.test.coverage.thresholds;
export default config;
Loading