Implement keyholder test case

.gitignore

@@ -17,19 +17,20 @@
 !/package.json
 !/pnpm-lock.yaml
 !/pnpm-workspace.yaml
-!/tsconfig.json
-!/jest.config.ts
 !/.prettierrc
 !/.prettierignore
+# shared by pkgs
+!/tsconfig.json
 !/.npmignore
 
 # useful stuff
 !/.editorconfig
 !/.cruft.json
 
 # packages
-pkg/*/node_modules/
+!/pkg/*/src/**/*.ts
+!/pkg/*/test/**/*.ts
 !/pkg/*/package.json
 !/pkg/*/pnpm-lock.yaml
-!/pkg/**/*.ts
-!/pkg/**/*.test.ts
+!/pkg/*/tsconfig.json
+!/pkg/*/.npmignore

.npmignore

@@ -1,11 +1,13 @@
-# blacklist everything
 *
-*/
+!*/
 
-# useful stuff
 !/package.json
 
-# built files and types
-!/.build/*/*.js
-!/.build/*/*.js.map
-!/.build/*/*.d.ts
+!/build/esm/src/**/*.js
+!/build/esm/src/**/*.js.map
+!/build/esm/src/**/*.d.ts
+
+!/build/cjs/package.json
+!/build/cjs/src/**/*.js
+!/build/cjs/src/**/*.js.map
+!/build/cjs/src/**/*.d.ts

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "slangroom",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"description": "Enhance zencode smart contracts with your slang dialect",
 	"repository": "https://github.com/dyne/slangroom",
 	"author": {
@@ -9,27 +9,28 @@
 	},
 	"license": "AGPL-3.0-only",
 	"scripts": {
-		"lint": "eslint --ext .ts pkg/ jest.config.ts",
-		"test": "jest",
-		"coverage": "jest --coverage",
-		"clean": "rm -rf .build .coverage",
-		"ts-node": "ts-node",
-		"build": "tsc",
+		"lint": "eslint --ext .ts pkg/*/src pkg/*/test",
+		"format": "prettier --ignore-path .gitignore --write '**/*.+(js|ts|json|html)'",
+		"test": "pnpm build && pnpm -F @slangroom/* exec ava build/esm/test",
+		"coverage": "c8 -o .coverage --exclude '**/test/' pnpm test",
+		"clean": "rm -rf .coverage && pnpm -F @slangroom/* exec -- rm -rf build",
+		"build": "pnpm build:esm",
+		"build:dual": "pnpm build:esm && pnpm build:cjs",
+		"build:cjs": "pnpm -F @slangroom/* exec tsc --outDir build/cjs --module commonjs && pnpm cjs-fixup",
+		"build:esm": "pnpm -F @slangroom/* exec tsc --outdir build/esm --module node16",
 		"build-all": "pnpm build",
-		"format": "prettier --ignore-path .gitignore --write '**/*.+(js|ts|json|html)'"
+		"cjs-fixup": "pnpm -F @slangroom/* exec sh -c \"echo '{\\\"type\\\":\\\"commonjs\\\"}' >build/cjs/package.json\""
 	},
 	"devDependencies": {
-		"@types/jest": "^29.5.2",
 		"@types/node": "^20.3.1",
 		"@typescript-eslint/eslint-plugin": "^5.59.11",
 		"@typescript-eslint/parser": "^5.59.11",
+		"ava": "^5.3.1",
+		"c8": "^8.0.1",
 		"esbuild": "^0.18.4",
 		"eslint": "^8.43.0",
 		"eslint-config-prettier": "^8.8.0",
-		"jest": "29.5.0",
-		"jest-junit": "^16.0.0",
 		"prettier": "^2.8.8",
-		"ts-jest": "^29.1.0",
 		"ts-node": "^10.9.1",
 		"tslib": "^2.5.3",
 		"typedoc": "^0.24.8",

pkg/core/.npmignore

@@ -0,0 +1 @@
+../../.npmignore

pkg/core/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "@slangroom/core",
+	"version": "1.0.0",
+	"dependencies": {
+		"@slangroom/shared": "workspace:*",
+		"@slangroom/ignored": "workspace:*"
+	},
+	"repository": "https://github.com/dyne/slangroom",
+	"license": "AGPL-3.0-only",
+	"type": "module",
+	"main": "./build/cjs/src/index.js",
+	"types": "./build/cjs/src/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./build/esm/src/index.d.ts",
+				"default": "./build/esm/src/index.js"
+			},
+			"require": {
+				"types": "./build/cjs/src/index.d.ts",
+				"default": "./build/cjs/src/index.js"
+			}
+		},
+		"./*": {
+			"import": {
+				"types": "./build/esm/src/*.d.ts",
+				"default": "./build/esm/src/*.js"
+			},
+			"require": {
+				"types": "./build/cjs/src/*.d.ts",
+				"default": "./build/cjs/src/*.js"
+			}
+		}
+	}
+}

pkg/core/src/index.ts

@@ -0,0 +1,2 @@
+export * from '@slangroom/core/plugin';
+export * from '@slangroom/core/slangroom';

pkg/core/src/plugin.ts

@@ -0,0 +1,46 @@
+import type { ZenroomParams, JsonableObject } from '@slangroom/shared';
+
+/**
+ * A plugin that must be executed **before** the actual Zenroom execution takes
+ * place.
+ *
+ * The plugin is defined using a single parameter which is a callback,
+ * named [execute], which takes in the necessary parameters from [BeforeParams].
+ */
+export class BeforePlugin {
+	constructor(readonly execute: (params: BeforeParams) => Promise<void> | void) {}
+}
+
+/**
+ * A plugin that must be executed **after** the actual Zenroom execution takes
+ * place.
+ *
+ * The plugin is defined using a single parameter which is a callback,
+ * named [execute], which takes in the necessary parameters from [AfterParams].
+ */
+export class AfterPlugin {
+	constructor(readonly execute: (params: AfterParams) => Promise<void> | void) {}
+}
+
+/**
+ * The parameters passed down to [BeforePlugin]'s callback.
+ *
+ * [statement] is the ignored statement for each iteration.
+ * [params] is the original parameters passed to Zenroom, if any.
+ */
+export type BeforeParams = {
+	readonly statement: string;
+	readonly params: ZenroomParams | undefined;
+};
+
+/**
+ * The parameters passed down to [BeforePlugin]'s callback.
+ * [statement] is the ignored statement for each iteration.
+ * [params] is the original parameters passed to Zenroom, if any.
+ * [result] is the result of the actual Zenroom execution.
+ */
+export type AfterParams = {
+	readonly statement: string;
+	readonly params: ZenroomParams | undefined;
+	readonly result: JsonableObject;
+};

pkg/core/src/slangroom.ts

@@ -0,0 +1,84 @@
+import { BeforePlugin, AfterPlugin } from '@slangroom/core/plugin';
+import { type ZenroomParams, type ZenroomOutput, zencodeExec } from '@slangroom/shared';
+import { getIgnoredStatements } from '@slangroom/ignored';
+
+/**
+ * A helper type that disallows nested arrays.
+ */
+type Plugins =
+	| BeforePlugin
+	| AfterPlugin
+	| Set<BeforePlugin | AfterPlugin>
+	| Array<BeforePlugin | AfterPlugin | Set<BeforePlugin | AfterPlugin>>;
+
+/**
+ * A Slangroom instance.
+ */
+export class Slangroom {
+	/**
+	 * A set of plugins that needs to be executed **before** the actual Zenroom execution.
+	 */
+	private _beforeExecution = new Set<BeforePlugin>();
+	get beforeExecution() {
+		return this._beforeExecution;
+	}
+
+	/**
+	 * A set of plugins that needs to be executed **after** the actual Zenroom execution.
+	 */
+	private _afterExecution = new Set<AfterPlugin>();
+	get afterExecution() {
+		return this._afterExecution;
+	}
+
+	constructor(first: Plugins, ...rest: Plugins[]) {
+		this.addPlugins(first, ...rest);
+	}
+
+	/**
+	 * Adds a single or a list of plugins to the Slangroom instance.
+	 */
+	addPlugins(first: Plugins, ...rest: Plugins[]) {
+		const plugins = new Set<BeforePlugin | AfterPlugin>();
+		[first, ...rest].forEach(function recurse(x: Plugins) {
+			if (Array.isArray(x) || x instanceof Set) x.forEach(recurse);
+			else plugins.add(x);
+		});
+
+		for (const p of plugins) {
+			if (p instanceof BeforePlugin) this._beforeExecution.add(p);
+			if (p instanceof AfterPlugin) this._afterExecution.add(p);
+		}
+	}
+
+	/**
+	 * Executes a contract using optional parameters with custom statements.
+	 */
+	async execute(contract: string, params?: ZenroomParams): Promise<ZenroomOutput> {
+		const ignoreds = await getIgnoredStatements(contract, params);
+
+		// TODO: remove the statements when they match (decide how)
+		for (const b of this._beforeExecution) {
+			for (const ignored of ignoreds) {
+				await b.execute({
+					statement: ignored,
+					params: params,
+				});
+			}
+		}
+
+		const zout = await zencodeExec(contract, params);
+
+		for (const a of this._afterExecution) {
+			for (const ignored of ignoreds) {
+				await a.execute({
+					statement: ignored,
+					result: zout.result,
+					params: params,
+				});
+			}
+		}
+
+		return zout;
+	}
+}

pkg/core/test/slangroom.ts

@@ -0,0 +1,65 @@
+import test from 'ava';
+import { BeforePlugin, AfterPlugin, Slangroom } from '@slangroom/core';
+
+test('adding a plugin correctly falls into either before or after', (t) => {
+	const before = new BeforePlugin(() => {
+		return;
+	});
+	const after = new AfterPlugin(() => {
+		return;
+	});
+	const slang = new Slangroom(before, after);
+
+	t.is(slang.beforeExecution.size, 1);
+	t.true(slang.beforeExecution.has(before));
+
+	t.is(slang.afterExecution.size, 1);
+	t.true(slang.afterExecution.has(after));
+});
+
+test('no plugins are executed if no ignored statemnets are found', async (t) => {
+	let hasBeforeRan = false;
+	let hasAfterRan = false;
+	const before = new BeforePlugin(() => {
+		hasBeforeRan = true;
+		return;
+	});
+	const after = new BeforePlugin(() => {
+		hasAfterRan = true;
+		return;
+	});
+	const slang = new Slangroom([before, after]);
+	const contract = `Given I have nothing
+Then I print the string 'I love you'
+`;
+	await slang.execute(contract);
+	t.false(hasBeforeRan);
+	t.false(hasAfterRan);
+});
+
+test('before-plugins runs before the actual execution and after-plugins runs after', async (t) => {
+	let hasBeforeRan = false;
+	let hasAfterRan = false;
+	const before = new BeforePlugin(() => {
+		t.false(hasBeforeRan);
+		t.false(hasAfterRan);
+		hasBeforeRan = true;
+		return;
+	});
+	const after = new AfterPlugin(() => {
+		t.true(hasBeforeRan);
+		t.false(hasAfterRan);
+		hasAfterRan = true;
+		return;
+	});
+	const slang = new Slangroom(new Set([before, after]));
+	const contract = `Rule unknown ignore
+
+Given I have nothing
+Then I print the string 'I love you'
+Then this statement does not exist
+`;
+	await slang.execute(contract);
+	t.true(hasBeforeRan);
+	t.true(hasAfterRan);
+});

pkg/core/tsconfig.json

@@ -0,0 +1 @@
+../../tsconfig.json

pkg/deps/.npmignore

@@ -0,0 +1 @@
+../../.npmignore

pkg/deps/package.json

@@ -1,14 +1,35 @@
 {
 	"name": "@slangroom/deps",
-	"exports": {
-		"*": "../../.build/deps/*.js"
-	},
-	"version": "1.0.0",
-	"type": "module",
-	"repository": "https://github.com/dyne/slangroom",
-	"license": "AGPL-3.0-only",
+	"version": "1.0.3",
 	"dependencies": {
 		"chevrotain": "^10.5.0",
 		"zenroom": "^3.10.0"
+	},
+	"repository": "https://github.com/dyne/slangroom",
+	"license": "AGPL-3.0-only",
+	"type": "module",
+	"main": "./build/cjs/src/index.js",
+	"types": "./build/cjs/src/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./build/esm/src/index.d.ts",
+				"default": "./build/esm/src/index.js"
+			},
+			"require": {
+				"types": "./build/cjs/src/index.d.ts",
+				"default": "./build/cjs/src/index.js"
+			}
+		},
+		"./*": {
+			"import": {
+				"types": "./build/esm/src/*.d.ts",
+				"default": "./build/esm/src/*.js"
+			},
+			"require": {
+				"types": "./build/cjs/src/*.d.ts",
+				"default": "./build/cjs/src/*.js"
+			}
+		}
 	}
 }