feat(js-client)!: Adding strictes eslint and ts config to all packages [fixes DXJ-464] (#355)

* introduce eslint

* Fix all eslint errors

* Eslint fix and some touches

* Fix tests

* Fix misc errors

* change semver

* change semver #2

* Fix path

* Fix path #2

* freeze lock file in CI

* fix package install

* Fix formatting of surrounding files

* Add empty prettier config

* Fix formatting

* Fix build errors

* Remove unused deps

* remove changelog from formatting

* deps cleanup

* make resource importers async

* Refactor

* Fix error message

* remove comment

* more refactoring

* Update packages/core/js-client/src/compilerSupport/registerService.ts

Co-authored-by: shamsartem <shamsartem@gmail.com>

* refactoring

* refactoring fix

* optimize import

* Update packages/@tests/smoke/node/src/index.ts

Co-authored-by: shamsartem <shamsartem@gmail.com>

* Revert package

* Fix pnpm lock

* Lint-fix

* Fix CI

* Update tests

* Fix build

* Fix import

* Use forked threads dep

* Use fixed version

* Update threads

* Fix lint

* Fix test

* Fix test

* Add polyfill for assert

* Add subpath import

* Fix tests

* Fix deps

---------

Co-authored-by: shamsartem <shamsartem@gmail.com>
This commit is contained in:
Akim 2023-10-17 22:14:08 +07:00 committed by GitHub
parent b46933252a
commit 919c7d6ea1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
135 changed files with 10529 additions and 9167 deletions

View File

@ -1,12 +0,0 @@
# EditorConfig is awesome: https://EditorConfig.org
# top-most EditorConfig file
root = true
[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false

133
.eslintrc.json Normal file
View File

@ -0,0 +1,133 @@
{
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2022,
"project": ["./tsconfig.eslint.json"],
"sourceType": "module"
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/strict-type-checked",
"plugin:import/recommended",
"plugin:import/typescript",
"prettier"
],
"plugins": [
"@typescript-eslint",
"import",
"license-header",
"unused-imports"
],
"ignorePatterns": ["**/node_modules/**/*", "**/dist/**/*"],
"rules": {
"eqeqeq": [
"error",
"always",
{
"null": "ignore"
}
],
"no-console": ["error"],
"arrow-body-style": ["error", "always"],
"no-empty": [
"error",
{
"allowEmptyCatch": true
}
],
"curly": ["error", "all"],
"no-unused-expressions": ["error"],
"dot-notation": ["off"],
"object-curly-spacing": ["error", "always"],
"padding-line-between-statements": [
"error",
{
"blankLine": "always",
"prev": "multiline-expression",
"next": "*"
},
{
"blankLine": "always",
"prev": "*",
"next": "multiline-expression"
},
{
"blankLine": "always",
"prev": "multiline-block-like",
"next": "*"
},
{
"blankLine": "always",
"prev": "*",
"next": "multiline-block-like"
},
{
"blankLine": "always",
"prev": "multiline-const",
"next": "*"
},
{
"blankLine": "always",
"prev": "*",
"next": "multiline-const"
},
{
"blankLine": "always",
"prev": "multiline-let",
"next": "*"
},
{
"blankLine": "always",
"prev": "*",
"next": "multiline-let"
},
{
"blankLine": "any",
"prev": "case",
"next": "case"
}
],
"import/extensions": ["error", "ignorePackages"],
"import/no-unresolved": "off",
"import/no-cycle": ["error"],
"import/order": [
"error",
{
"newlines-between": "always",
"alphabetize": {
"order": "asc",
"caseInsensitive": true
}
}
],
"node/no-unsupported-features/es-syntax": "off",
"node/no-unpublished-import": "off",
"node/no-missing-import": "off",
"@typescript-eslint/explicit-member-accessibility": [
"error",
{
"accessibility": "no-public"
}
],
"@typescript-eslint/strict-boolean-expressions": [
"error",
{
"allowString": false,
"allowNumber": false,
"allowNullableObject": false,
"allowNullableBoolean": false,
"allowNullableString": false,
"allowNullableNumber": false,
"allowAny": false
}
],
"@typescript-eslint/consistent-type-assertions": [
"error",
{
"assertionStyle": "never"
}
],
"unused-imports/no-unused-imports": "error",
"license-header/header": ["error", "./resources/license-header.js"]
}
}

View File

@ -88,6 +88,11 @@ jobs:
registry-url: "https://npm.fluence.dev"
cache: "pnpm"
- run: pnpm -r i
- run: pnpm -r build
- run: pnpm lint-check
- name: Override dependencies
uses: fluencelabs/github-actions/pnpm-set-dependency@main
with:
@ -97,10 +102,8 @@ jobs:
"@fluencelabs/marine-js": "${{ inputs.marine-js-version }}"
}
- run: pnpm -r --no-frozen-lockfile i
- run: pnpm -r build
- run: pnpm -r i
- run: pnpm -r test
- name: Dump rust-peer logs
if: always()
uses: jwalton/gh-docker-logs@v2

1
.gitignore vendored
View File

@ -1,5 +1,6 @@
*.log
.idea
.eslintcache
# Dependency directories
node_modules/

View File

@ -1 +1,10 @@
.github
.eslintcache
pnpm-lock.yaml
**/node_modules
**/dist
**/build
**/public
**/CHANGELOG.md

1
.prettierrc Normal file
View File

@ -0,0 +1 @@
{}

View File

@ -1,8 +0,0 @@
module.exports = {
semi: true,
trailingComma: 'all',
singleQuote: true,
printWidth: 120,
tabWidth: 4,
useTabs: false,
};

17
ci.cjs
View File

@ -5,7 +5,7 @@ const path = require("path");
function printUsage() {
console.log(
`Usage: "ci check-consistency" or "ci bump-version %postfix%" or "ci get-version"`
`Usage: "ci check-consistency" or "ci bump-version %postfix%" or "ci get-version"`,
);
}
@ -43,18 +43,17 @@ async function getPackageJsonsRecursive(currentPath) {
(await fs.readdir(currentPath, { withFileTypes: true }))
.filter(
(file) =>
file.name !== "node_modules" && file.name !== "@tests" &&
(file.isDirectory() || file.name === "package.json")
file.name !== "node_modules" &&
file.name !== "@tests" &&
(file.isDirectory() || file.name === "package.json"),
)
.map((file) =>
file.isDirectory()
? getPackageJsonsRecursive(
path.join(currentPath, file.name)
)
? getPackageJsonsRecursive(path.join(currentPath, file.name))
: Promise.resolve([
path.join(process.cwd(), currentPath, file.name),
])
)
]),
),
)
).flat();
}
@ -103,7 +102,7 @@ async function checkConsistency(file, versionsMap) {
if (versionInDep !== version) {
console.log(
`Error, versions don't match: ${name}:${version} !== ${versionInDep}`,
file
file,
);
process.exit(1);
}

View File

@ -8,15 +8,29 @@
"node": ">=10",
"pnpm": ">=3"
},
"scripts": {
"lint-check": "pnpm run prettier --check && pnpm run eslint",
"lint-fix": "pnpm run prettier --write && pnpm run eslint --fix",
"prettier": "prettier .",
"eslint": "eslint --cache \"**/src/**/*.{js,ts}\""
},
"author": "Fluence Labs",
"license": "Apache-2.0",
"devDependencies": {
"http-server": "14.1.1",
"puppeteer": "19.7.2",
"@total-typescript/ts-reset": "0.5.1",
"@tsconfig/strictest": "2.0.2",
"@types/node": "18.13.0",
"@typescript-eslint/eslint-plugin": "6.7.3",
"@typescript-eslint/parser": "6.7.3",
"eslint": "8.50.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.28.1",
"eslint-plugin-license-header": "0.6.0",
"eslint-plugin-unused-imports": "3.0.0",
"http-server": "14.1.1",
"prettier": "3.0.3",
"puppeteer": "19.7.2",
"ts-node": "10.9.1",
"typescript": "4.7",
"@fluencelabs/aqua-lib": "0.6.0",
"@fluencelabs/aqua": "0.9.1-374"
"typescript": "5.1.6"
}
}

View File

@ -0,0 +1,6 @@
{
"ignorePatterns": ["**/*.css"],
"rules": {
"no-console": "off"
}
}

View File

@ -53,3 +53,6 @@ func marineTest(wasm64: string) -> f64:
<- res
func callHappy(a: string, b: f64, c: f64, d: string -> f64) -> f64:
res <- d("abc")
<- res

View File

@ -17,13 +17,13 @@
"author": "Fluence Labs",
"license": "Apache-2.0",
"dependencies": {
"@fluencelabs/js-client": "workspace:^",
"base64-js": "1.5.1"
},
"devDependencies": {
"@fluencelabs/cli": "0.7.2",
"@fluencelabs/registry": "0.8.2",
"@fluencelabs/aqua-lib": "0.6.0",
"@fluencelabs/cli": "0.7.2",
"@fluencelabs/js-client": "workspace:^",
"@fluencelabs/registry": "0.8.2",
"@fluencelabs/trust-graph": "3.1.2"
}
}

View File

@ -8,13 +8,14 @@
* Aqua version: 0.12.0
*
*/
import type { IFluenceClient as IFluenceClient$$, CallParams as CallParams$$ } from '@fluencelabs/js-client';
import type {
IFluenceClient as IFluenceClient$$,
CallParams as CallParams$$,
} from "@fluencelabs/js-client";
import {
v5_callFunction as callFunction$$,
v5_registerService as registerService$$,
} from '@fluencelabs/js-client';
} from "@fluencelabs/js-client";
// Services
@ -30,49 +31,42 @@ export const test_script = `
(call %init_peer_id% ("errorHandlingSrv" "error") [%last_error% 0])
)
)
`
`;
export function test(
config?: {ttl?: number}
): Promise<void>;
export function test(config?: { ttl?: number }): Promise<void>;
export function test(
peer: IFluenceClient$$,
config?: {ttl?: number}
config?: { ttl?: number },
): Promise<void>;
export function test(...args: any) {
return callFunction$$(
args,
{
"functionName" : "test",
"arrow" : {
"tag" : "arrow",
"domain" : {
"tag" : "labeledProduct",
"fields" : {
}
functionName: "test",
arrow: {
tag: "arrow",
domain: {
tag: "labeledProduct",
fields: {},
},
"codomain" : {
"tag" : "nil"
}
codomain: {
tag: "nil",
},
"names" : {
"relay" : "-relay-",
"getDataSrv" : "getDataSrv",
"callbackSrv" : "callbackSrv",
"responseSrv" : "callbackSrv",
"responseFnName" : "response",
"errorHandlingSrv" : "errorHandlingSrv",
"errorFnName" : "error"
}
},
test_script
)
},
names: {
relay: "-relay-",
getDataSrv: "getDataSrv",
callbackSrv: "callbackSrv",
responseSrv: "callbackSrv",
responseFnName: "response",
errorHandlingSrv: "errorHandlingSrv",
errorFnName: "error",
},
},
test_script,
);
}
/* eslint-enable */

File diff suppressed because it is too large Load Diff

View File

@ -1,84 +1,117 @@
import { fromByteArray } from 'base64-js';
import { Fluence } from '@fluencelabs/js-client';
import type { ClientConfig } from '@fluencelabs/js-client';
import { registerHelloWorld, helloTest, marineTest, resourceTest } from './_aqua/smoke_test.js';
import { test as particleTest } from './_aqua/finalize_particle.js';
import { wasm } from './wasmb64.js';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Fluence } from "@fluencelabs/js-client";
import type { ClientConfig } from "@fluencelabs/js-client";
import { fromByteArray } from "base64-js";
import { test as particleTest } from "./_aqua/finalize_particle.js";
import {
registerHelloWorld,
helloTest,
marineTest,
} from "./_aqua/smoke_test.js";
import { wasm } from "./wasmb64.js";
const relay = {
multiaddr: '/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
peerId: '12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
multiaddr:
"/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
peerId: "12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
};
function generateRandomUint8Array() {
const uint8Array = new Uint8Array(32);
for (let i = 0; i < uint8Array.length; i++) {
uint8Array[i] = Math.floor(Math.random() * 256);
}
return uint8Array;
}
const optsWithRandomKeyPair = (): ClientConfig => {
return {
keyPair: {
type: 'Ed25519',
type: "Ed25519",
source: generateRandomUint8Array(),
},
} as const;
};
export type TestResult = { type: 'success'; data: string } | { type: 'failure'; error: string };
export type TestResult =
| { type: "success"; data: string }
| { type: "failure"; error: string };
export const runTest = async (): Promise<TestResult> => {
try {
Fluence.onConnectionStateChange((state) => console.info('connection state changed: ', state));
Fluence.onConnectionStateChange((state) => {
console.info("connection state changed: ", state);
});
console.log('connecting to Fluence Network...');
console.log('multiaddr: ', relay.multiaddr);
console.log("connecting to Fluence Network...");
console.log("multiaddr: ", relay.multiaddr);
await Fluence.connect(relay, optsWithRandomKeyPair());
console.log('connected');
console.log("connected");
const relayPeerId = (await Fluence.getClient()).getRelayPeerId();
console.log('relay:', relayPeerId);
const relayPeerId = Fluence.getClient().getRelayPeerId();
console.log("relay:", relayPeerId);
await registerHelloWorld({
registerHelloWorld({
hello(str) {
return 'Hello, ' + str + '!';
return "Hello, " + str + "!";
},
});
const client = await Fluence.getClient();
const client = Fluence.getClient();
console.log('my peer id: ', client.getPeerId());
console.log('my sk id: ', fromByteArray(client.getPeerSecretKey()));
console.log("my peer id: ", client.getPeerId());
console.log("my sk id: ", fromByteArray(client.getPeerSecretKey()));
console.log('running hello test...');
console.log("running hello test...");
const hello = await helloTest();
console.log('hello test finished, result: ', hello);
console.log("hello test finished, result: ", hello);
console.log('running marine test...');
console.log("running marine test...");
const marine = await marineTest(wasm);
console.log('running particle test...');
console.log("running particle test...");
await particleTest();
console.log('marine test finished, result: ', marine);
console.log("marine test finished, result: ", marine);
const returnVal = {
hello,
marine,
};
return { type: 'success', data: JSON.stringify(returnVal) };
return { type: "success", data: JSON.stringify(returnVal) };
} finally {
console.log('disconnecting from Fluence Network...');
console.log("disconnecting from Fluence Network...");
await Fluence.disconnect();
console.log('disconnected');
console.log("disconnected");
}
};
export const runMain = () => {
runTest()
.then(() => console.log('done!'))
.catch((err) => console.error('error: ', err));
.then(() => {
console.log("done!");
})
.catch((err) => {
console.error("error: ", err);
});
};

File diff suppressed because one or more lines are too long

View File

@ -4,5 +4,6 @@
"outDir": "./dist",
"module": "NodeNext"
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]
}

View File

@ -1,4 +1,21 @@
import '@fluencelabs/js-client';
import { runTest } from '@test/aqua_for_test';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
runTest().then(() => console.log('Smoke tests succeed!'));
import "@fluencelabs/js-client";
import { runTest } from "@test/aqua_for_test";
await runTest();
console.log("Smoke tests succeed!");

View File

@ -4,7 +4,7 @@
"private": true,
"type": "module",
"dependencies": {
"@test/aqua_for_test": "workspace:^",
"@test/aqua_for_test": "workspace:*",
"@testing-library/jest-dom": "5.16.5",
"@testing-library/react": "13.4.0",
"@testing-library/user-event": "13.5.0",
@ -15,11 +15,10 @@
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-scripts": "5.0.1",
"typescript": "4.9.5",
"web-vitals": "2.1.4"
},
"devDependencies": {
"@test/test-utils": "workspace:^",
"@test/test-utils": "workspace:*",
"puppeteer": "19.7.2"
},
"scripts": {

View File

@ -1,7 +1,7 @@
import { runTest, TestResult } from '@test/aqua_for_test';
import React from 'react';
import logo from './logo.svg';
import './App.css';
import { runTest, TestResult } from "@test/aqua_for_test";
import React from "react";
import logo from "./logo.svg";
import "./App.css";
function App() {
const [result, setResult] = React.useState<TestResult | null>(null);
@ -12,7 +12,7 @@ function App() {
setResult(res);
})
.catch((err) => {
setResult({ type: 'failure', error: err.toString() });
setResult({ type: "failure", error: err.toString() });
});
};
@ -27,9 +27,18 @@ function App() {
Click to run test
</button>
{result && result.type === 'success' && <div id="res">{result.data}</div>}
{result && result.type === 'failure' && <div id="error">{result.error}</div>}
<a className="App-link" href="https://reactjs.org" target="_blank" rel="noopener noreferrer">
{result && result.type === "success" && (
<div id="res">{result.data}</div>
)}
{result && result.type === "failure" && (
<div id="error">{result.error}</div>
)}
<a
className="App-link"
href="https://reactjs.org"
target="_blank"
rel="noopener noreferrer"
>
Learn React
</a>
</header>

View File

@ -1,13 +1,13 @@
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen",
"Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue",
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
monospace;
}

View File

@ -1,10 +1,12 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import './index.css';
import App from './App';
import reportWebVitals from './reportWebVitals';
import React from "react";
import ReactDOM from "react-dom/client";
import "./index.css";
import App from "./App";
import reportWebVitals from "./reportWebVitals";
const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
const root = ReactDOM.createRoot(
document.getElementById("root") as HTMLElement,
);
root.render(
<React.StrictMode>
<App />

View File

@ -1,8 +1,8 @@
import { ReportHandler } from 'web-vitals';
import { ReportHandler } from "web-vitals";
const reportWebVitals = (onPerfEntry?: ReportHandler) => {
if (onPerfEntry && onPerfEntry instanceof Function) {
import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
import("web-vitals").then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
getCLS(onPerfEntry);
getFID(onPerfEntry);
getFCP(onPerfEntry);

View File

@ -2,4 +2,4 @@
// allows you to do things like:
// expect(element).toHaveTextContent(/react/i)
// learn more: https://github.com/testing-library/jest-dom
import '@testing-library/jest-dom';
import "@testing-library/jest-dom";

View File

@ -1,49 +1,53 @@
import puppeteer from 'puppeteer';
import { dirname, join } from 'path';
import { fileURLToPath } from 'url';
import puppeteer from "puppeteer";
import { dirname, join } from "path";
import { fileURLToPath } from "url";
import { CDN_PUBLIC_PATH, startContentServer, stopServer } from '@test/test-utils';
import { access, symlink } from 'fs/promises';
import {
CDN_PUBLIC_PATH,
startContentServer,
stopServer,
} from "@test/test-utils";
import { access, symlink } from "fs/promises";
const port = 3001;
const uri = `http://localhost:${port}/`;
const __dirname = dirname(fileURLToPath(import.meta.url));
const publicPath = join(__dirname, '../build/');
const publicPath = join(__dirname, "../build/");
const test = async () => {
const localServer = await startContentServer(port, publicPath);
try {
await access(join(publicPath, 'source'))
await access(join(publicPath, "source"));
} catch {
await symlink(CDN_PUBLIC_PATH, join(publicPath, 'source'));
await symlink(CDN_PUBLIC_PATH, join(publicPath, "source"));
}
console.log('starting puppeteer...');
console.log("starting puppeteer...");
const browser = await puppeteer.launch();
const page = (await browser.pages())[0];
// uncomment to debug what's happening inside the browser
// page.on('console', (msg) => console.log('// from console: ', msg.text()));
console.log('going to the page in browser...');
console.log("going to the page in browser...");
await page.goto(uri);
console.log('clicking button...');
await page.click('#btn');
console.log("clicking button...");
await page.click("#btn");
console.log('waiting for result to appear...');
const elem = await page.waitForSelector('#res');
console.log("waiting for result to appear...");
const elem = await page.waitForSelector("#res");
console.log('getting the content of result div...');
console.log("getting the content of result div...");
const content = await elem?.evaluate((x) => x.textContent);
console.log('raw result: ', content);
console.log("raw result: ", content);
await browser.close();
await stopServer(localServer);
if (!content) {
throw new Error('smoke test failed!');
throw new Error("smoke test failed!");
}
};
test().then(() => console.log('smoke tests succeed!'));
test().then(() => console.log("smoke tests succeed!"));

View File

@ -19,8 +19,8 @@
"author": "Fluence Labs",
"license": "Apache-2.0",
"dependencies": {
"@fluencelabs/js-client": "workspace:^",
"@test/test-utils": "workspace:../../test-utils"
"@fluencelabs/js-client": "workspace:*",
"@test/test-utils": "workspace:*"
},
"devDependencies": {
"puppeteer": "19.7.2"

View File

@ -1,8 +1,9 @@
const fluence = globalThis.fluence;
const relay = {
multiaddr: '/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
peerId: '12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
multiaddr:
"/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
peerId: "12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
};
const getRelayTime = () => {
@ -37,36 +38,36 @@ const getRelayTime = () => {
)`;
const def = {
functionName: 'getRelayTime',
functionName: "getRelayTime",
arrow: {
tag: 'arrow',
tag: "arrow",
domain: {
tag: 'labeledProduct',
tag: "labeledProduct",
fields: {
relayPeerId: {
tag: 'scalar',
name: 'string',
tag: "scalar",
name: "string",
},
},
},
codomain: {
tag: 'unlabeledProduct',
tag: "unlabeledProduct",
items: [
{
tag: 'scalar',
name: 'u64',
tag: "scalar",
name: "u64",
},
],
},
},
names: {
relay: '-relay-',
getDataSrv: 'getDataSrv',
callbackSrv: 'callbackSrv',
responseSrv: 'callbackSrv',
responseFnName: 'response',
errorHandlingSrv: 'errorHandlingSrv',
errorFnName: 'error',
relay: "-relay-",
getDataSrv: "getDataSrv",
callbackSrv: "callbackSrv",
responseSrv: "callbackSrv",
responseFnName: "response",
errorHandlingSrv: "errorHandlingSrv",
errorFnName: "error",
},
};
@ -83,28 +84,28 @@ const getRelayTime = () => {
};
const main = async () => {
console.log('starting fluence...');
fluence.defaultClient = await fluence.clientFactory(relay);
console.log('started fluence');
console.log("starting fluence...");
fluence.defaultClient = await fluence.clientFactory(relay, {});
console.log("started fluence");
console.log('getting relay time...');
console.log("getting relay time...");
const relayTime = await getRelayTime();
console.log('got relay time, ', relayTime);
console.log("got relay time, ", relayTime);
console.log('stopping fluence...');
console.log("stopping fluence...");
await fluence.defaultClient.stop();
console.log('stopped fluence...');
console.log("stopped fluence...");
return relayTime;
};
const btn = document.getElementById('btn');
const btn = document.getElementById("btn");
btn.addEventListener('click', () => {
btn.addEventListener("click", () => {
main().then((res) => {
const inner = document.createElement('div');
inner.id = 'res';
const inner = document.createElement("div");
inner.id = "res";
inner.innerText = res;
document.getElementById('res-placeholder').appendChild(inner);
document.getElementById("res-placeholder").appendChild(inner);
});
});

View File

@ -1,49 +1,76 @@
import puppeteer from 'puppeteer';
import { dirname, join } from 'path';
import { fileURLToPath } from 'url';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CDN_PUBLIC_PATH, startCdn, startContentServer, stopServer } from '@test/test-utils';
import { symlink, access } from 'fs/promises';
import { symlink, access } from "fs/promises";
import { dirname, join } from "path";
import { fileURLToPath } from "url";
import {
CDN_PUBLIC_PATH,
startContentServer,
stopServer,
} from "@test/test-utils";
import puppeteer from "puppeteer";
const port = 3000;
const uri = `http://localhost:${port}/`;
const __dirname = dirname(fileURLToPath(import.meta.url));
const publicPath = join(__dirname, '../public/');
const publicPath = join(__dirname, "../public/");
const test = async () => {
const localServer = await startContentServer(port, publicPath);
try {
await access(join(publicPath, 'source'))
await access(join(publicPath, "source"));
} catch {
await symlink(CDN_PUBLIC_PATH, join(publicPath, 'source'));
await symlink(CDN_PUBLIC_PATH, join(publicPath, "source"));
}
console.log('starting puppeteer...');
console.log("starting puppeteer...");
const browser = await puppeteer.launch();
const page = (await browser.pages())[0];
// uncomment to debug what's happening inside the browser
// page.on('console', (msg) => console.log('// from console: ', msg.text()));
console.log('going to the page in browser...');
console.log("going to the page in browser...");
await page.goto(uri);
console.log('clicking button...');
await page.click('#btn');
console.log("clicking button...");
await page.click("#btn");
console.log('waiting for result to appear...');
const elem = await page.waitForSelector('#res');
console.log("waiting for result to appear...");
const elem = await page.waitForSelector("#res");
console.log('getting the content of result div...');
const content = await elem?.evaluate((x) => x.textContent);
console.log('raw result: ', content);
console.log("getting the content of result div...");
const content = await elem?.evaluate((x) => {
return x.textContent;
});
console.log("raw result: ", content);
await browser.close();
await stopServer(localServer);
if (!content) {
throw new Error('smoke test failed!');
if (content == null) {
throw new Error("smoke test failed!");
}
};
test().then(() => console.log('smoke tests succeed!'));
void test().then(() => {
console.log("smoke tests succeed!");
});

View File

@ -3,5 +3,5 @@
"compilerOptions": {
"outDir": "./dist"
},
"exclude": ["node_modules", "dist"]
"exclude": ["node_modules", "dist", "public"]
}

View File

@ -1,31 +1,65 @@
import handler from 'serve-handler';
import { createServer } from 'http';
import type { Server } from 'http';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { dirname, join } from 'path';
import { fileURLToPath } from 'url';
import { createServer } from "http";
import type { Server } from "http";
import { dirname, join } from "path";
import { fileURLToPath } from "url";
import handler from "serve-handler";
const __dirname = dirname(fileURLToPath(import.meta.url));
export const CDN_PUBLIC_PATH = join(__dirname, '../../../core/js-client/dist/browser');
export const CDN_PUBLIC_PATH = join(
__dirname,
"../../../core/js-client/dist/browser",
);
export const startCdn = (port: number) => startContentServer(port, CDN_PUBLIC_PATH);
export const startCdn = (port: number) => {
return startContentServer(port, CDN_PUBLIC_PATH);
};
export const startContentServer = (port: number, publicDir: string): Promise<Server> => {
export const startContentServer = (
port: number,
publicDir: string,
): Promise<Server> => {
const server = createServer((request, response) => {
return handler(request, response, {
void handler(request, response, {
public: publicDir,
rewrites: [{
source: '/js-client.min.js',
destination: '/source/index.umd.cjs'
}],
headers: [{
source: '**/*',
rewrites: [
{
source: "/js-client.min.js",
destination: "/source/index.umd.cjs",
},
],
headers: [
{ key: 'Cross-Origin-Opener-Policy', value: 'same-origin' },
{ key: 'Cross-Origin-Embedder-Policy', value: 'require-corp' }
]
}]
{
source: "**/*",
headers: [
{
key: "Cross-Origin-Opener-Policy",
value: "same-origin",
},
{
key: "Cross-Origin-Embedder-Policy",
value: "require-corp",
},
],
},
],
});
});
@ -41,7 +75,7 @@ export const startContentServer = (port: number, publicDir: string): Promise<Ser
export const stopServer = (app: Server): Promise<void> => {
return new Promise<void>((resolve) => {
app.close(() => {
console.log('server stopped');
console.log("server stopped");
resolve();
});
});

View File

@ -3,5 +3,6 @@
"compilerOptions": {
"outDir": "./dist"
},
"include": ["src"],
"exclude": ["node_modules", "dist"]
}

View File

@ -0,0 +1,3 @@
{
"ignorePatterns": ["src/**/__snapshots__/**/*"]
}

View File

@ -2,9 +2,9 @@
### Dependencies
* The following workspace dependencies were updated
* devDependencies
* @fluencelabs/js-client bumped to 0.1.7
- The following workspace dependencies were updated
- devDependencies
- @fluencelabs/js-client bumped to 0.1.7
### Dependencies
@ -20,7 +20,6 @@
## 0.0.1 (2023-09-22)
### Features
* **aqua-compiler:** JS-client aqua wrapper [fixes DXJ-461] ([#347](https://github.com/fluencelabs/js-client/issues/347)) ([7fff3b1](https://github.com/fluencelabs/js-client/commit/7fff3b1c0374eef76ab4e665b13cf97b5c50ff70))
- **aqua-compiler:** JS-client aqua wrapper [fixes DXJ-461] ([#347](https://github.com/fluencelabs/js-client/issues/347)) ([7fff3b1](https://github.com/fluencelabs/js-client/commit/7fff3b1c0374eef76ab4e665b13cf97b5c50ff70))

View File

@ -25,7 +25,6 @@
"@fluencelabs/registry": "0.8.7",
"@fluencelabs/spell": "0.5.20",
"@fluencelabs/trust-graph": "0.4.7",
"typescript": "5.1.6",
"vitest": "0.29.7"
"vitest": "0.34.6"
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,85 +14,136 @@
* limitations under the License.
*/
import { ArrowType, ArrowWithoutCallbacks, NonArrowType, ProductType } from '@fluencelabs/interfaces';
import { match, P } from 'ts-pattern';
import { getFuncArgs } from './utils.js';
import { ArrowWithoutCallbacks, NonArrowType } from "@fluencelabs/interfaces";
import { match, P } from "ts-pattern";
export function genTypeName(t: NonArrowType | ProductType<NonArrowType> | ArrowWithoutCallbacks, name: string): readonly [string | undefined, string] {
import { getFuncArgs } from "./utils.js";
export function genTypeName(
t: NonArrowType | ArrowWithoutCallbacks,
name: string,
): readonly [string | undefined, string] {
const genType = typeToTs(t);
return match(t)
.with(
{ tag: 'nil' },
() => [undefined, 'void'] as const
).with(
{ tag: 'struct' },
() => [`export type ${name} = ${genType}`, name] as const
).with(
{ tag: P.union('labeledProduct', 'unlabeledProduct') },
(item) => {
const args = item.tag === 'labeledProduct'
? Object.values(item.fields)
: item.items;
.with({ tag: "nil" }, () => {
return [undefined, "void"] as const;
})
.with({ tag: "struct" }, () => {
return [`export type ${name} = ${genType}`, name] as const;
})
.with({ tag: P.union("labeledProduct", "unlabeledProduct") }, (item) => {
const args =
item.tag === "labeledProduct" ? Object.values(item.fields) : item.items;
if (args.length === 1) {
return genTypeName(args[0], name);
}
return [`export type ${name} = ${genType}`, name] as const;
},
).otherwise(() => [undefined, genType] as const);
})
.otherwise(() => {
return [undefined, genType] as const;
});
}
export function typeToTs(t: NonArrowType | ArrowWithoutCallbacks | ProductType<NonArrowType>): string {
export function typeToTs(t: NonArrowType | ArrowWithoutCallbacks): string {
return match(t)
.with({ tag: "nil" }, () => {
return "null";
})
.with({ tag: "option" }, ({ type }) => {
return typeToTs(type) + " | null";
})
.with({ tag: "scalar" }, ({ name }) => {
return match(name)
.with(
{ tag: 'nil' },
() => 'null'
).with(
{ tag: 'option' },
({ type }) => typeToTs(type) + ' | null'
).with(
{ tag: 'scalar' },
({ name }) => match(name)
.with(P.union('u8', 'u16', 'u32', 'u64', 'i8', 'i16', 'i32', 'i64', 'f32', 'f64'), () => 'number')
.with('bool', () => 'boolean')
.with('string', () => 'string')
.with(P._, () => 'any').exhaustive()
).with(
{ tag: 'array' },
({ type }) => typeToTs(type) + '[]'
).with(
{ tag: 'struct' },
({ fields }) => `{ ${Object.entries(fields).map(([field, type]) => `${field}: ${typeToTs(type)};`).join(' ')} }`
).with(
{ tag: 'labeledProduct' },
({ fields }) => `{ ${Object.entries(fields).map(([field, type]) => `${field}: ${typeToTs(type)};`).join(' ')} }`
).with(
{ tag: 'unlabeledProduct' },
({ items }) => `[${items.map(item => typeToTs(item)).join(', ')}]`
).with(
{ tag: 'arrow' },
({ tag, domain, codomain }) => {
const retType = codomain.tag === 'nil'
? 'void'
P.union(
"u8",
"u16",
"u32",
"u64",
"i8",
"i16",
"i32",
"i64",
"f32",
"f64",
),
() => {
return "number";
},
)
.with("bool", () => {
return "boolean";
})
.with("string", () => {
return "string";
})
.with(P._, () => {
return "any";
})
.exhaustive();
})
.with({ tag: "array" }, ({ type }) => {
return typeToTs(type) + "[]";
})
.with({ tag: "struct" }, ({ fields }) => {
return `{ ${Object.entries(fields)
.map(([field, type]) => {
return `${field}: ${typeToTs(type)};`;
})
.join(" ")} }`;
})
.with({ tag: "labeledProduct" }, ({ fields }) => {
return `{ ${Object.entries(fields)
.map(([field, type]) => {
return `${field}: ${typeToTs(type)};`;
})
.join(" ")} }`;
})
.with({ tag: "unlabeledProduct" }, ({ items }) => {
return `[${items
.map((item) => {
return typeToTs(item);
})
.join(", ")}]`;
})
.with({ tag: "arrow" }, ({ domain, codomain }) => {
const retType =
codomain.tag === "nil"
? "void"
: codomain.items.length === 1
? typeToTs(codomain.items[0])
: typeToTs(codomain);
const args = getFuncArgs(domain).map(([name, type]) => ([name, typeToTs(type)]));
const args = getFuncArgs(domain).map(([name, type]) => {
return [name, typeToTs(type)];
});
const generic = args.length === 0 ? 'null' : args.map(([name]) => `'${name}'`).join(' | ');
args.push(['callParams', `CallParams$$<${generic}>`]);
const generic =
args.length === 0
? "null"
: args
.map(([name]) => {
return `'${name}'`;
})
.join(" | ");
const funcArgs = args.map(([name, type]) => `${name}: ${type}`).join(', ');
args.push(["callParams", `CallParams$$<${generic}>`]);
const funcArgs = args
.map(([name, type]) => {
return `${name}: ${type}`;
})
.join(", ");
return `(${funcArgs}) => ${retType} | Promise<${retType}>`;
}
).with(
{ tag: 'topType' },
() => 'unknown'
).with(
{ tag: 'bottomType' },
() => 'never'
).exhaustive();
})
.with({ tag: "topType" }, () => {
return "unknown";
})
.with({ tag: "bottomType" }, () => {
return "never";
})
.exhaustive();
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,4 +14,4 @@
* limitations under the License.
*/
export const CLIENT = 'IFluenceClient$$';
export const CLIENT = "IFluenceClient$$";

View File

@ -1,61 +0,0 @@
/*
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
ArrayType,
BottomType, LabeledProductType,
NilType,
NonArrowType,
OptionType,
ScalarType,
StructType,
TopType, UnlabeledProductType
} from '@fluencelabs/interfaces';
// Type definitions for inferring ts types from air json definition
// In the future we may remove string type declaration and move to type inference.
type GetTsTypeFromScalar<T extends ScalarType> = T['name'] extends 'u8' | 'u16' | 'u32' | 'u64' | 'i8' | 'i16' | 'i32' | 'i64' | 'f32' | 'f64'
? number
: T['name'] extends 'bool'
? boolean
: T['name'] extends 'string'
? string
: never;
type MapTuple<T> = { [K in keyof T]: T[K] extends NonArrowType ? GetTsType<T[K]> : never }
type GetTsType<T extends NonArrowType> = T extends NilType
? null
: T extends ArrayType
? GetTsType<T['type']>[]
: T extends StructType
? { [K in keyof T]: GetTsType<T> }
: T extends OptionType
? GetTsType<T['type']> | null
: T extends ScalarType
? GetTsTypeFromScalar<T>
: T extends TopType
? unknown
: T extends BottomType
? never
: T extends Exclude<UnlabeledProductType<infer H>, NilType>
? MapTuple<H>
: T extends Exclude<LabeledProductType<infer H>, NilType>
? H extends NonArrowType
? { [K in keyof T['fields']]: GetTsType<H> }
: never
: never;

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,35 +14,39 @@
* limitations under the License.
*/
import { describe, expect, it } from 'vitest';
import { generateTypes, generateSources } from '../index.js';
import { compileFromPath } from '@fluencelabs/aqua-api';
import url from 'url';
import { getPackageJsonContent, PackageJson } from '../../utils.js';
import url from "url";
describe('Aqua to js/ts compiler', () => {
it('compiles smoke tests successfully', async () => {
import { compileFromPath } from "@fluencelabs/aqua-api";
import { describe, expect, it } from "vitest";
import { getPackageJsonContent, PackageJson } from "../../utils.js";
import { generateTypes, generateSources } from "../index.js";
describe("Aqua to js/ts compiler", () => {
it("compiles smoke tests successfully", async () => {
const res = await compileFromPath({
filePath: url.fileURLToPath(new URL('./sources/smoke_test.aqua', import.meta.url)),
imports: ['./node_modules'],
targetType: 'air'
filePath: url.fileURLToPath(
new URL("./sources/smoke_test.aqua", import.meta.url),
),
imports: ["./node_modules"],
targetType: "air",
});
const pkg: PackageJson = {
...(await getPackageJsonContent()),
version: '0.0.0',
version: "0.0.0",
devDependencies: {
'@fluencelabs/aqua-api': '0.0.0'
"@fluencelabs/aqua-api": "0.0.0",
},
};
const jsResult = await generateSources(res, 'js', pkg);
const jsTypes = await generateTypes(res, pkg);
const jsResult = generateSources(res, "js", pkg);
const jsTypes = generateTypes(res, pkg);
expect(jsResult).toMatchSnapshot();
expect(jsTypes).toMatchSnapshot();
const tsResult = await generateSources(res, 'ts', pkg);
const tsResult = generateSources(res, "ts", pkg);
expect(tsResult).toMatchSnapshot();
});

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,24 +14,38 @@
* limitations under the License.
*/
import { recursiveRenameLaquaProps } from '../utils.js';
import { AquaFunction, TypeGenerator } from './interfaces.js';
import { recursiveRenameLaquaProps } from "../utils.js";
export function generateFunctions(typeGenerator: TypeGenerator, functions: Record<string, AquaFunction>) {
return Object.values(functions).map(func => generateFunction(typeGenerator, func)).join('\n\n');
import { AquaFunction, TypeGenerator } from "./interfaces.js";
export function generateFunctions(
typeGenerator: TypeGenerator,
functions: Record<string, AquaFunction>,
) {
return Object.values(functions)
.map((func) => {
return generateFunction(typeGenerator, func);
})
.join("\n\n");
}
type DeepToType<T> = { [K in keyof T]: DeepToType<T[K]> };
function generateFunction(typeGenerator: TypeGenerator, func: AquaFunction) {
const scriptConstName = func.funcDef.functionName + '_script';
const funcDef: DeepToType<typeof func.funcDef> = func.funcDef;
const scriptConstName = func.funcDef.functionName + "_script";
return `export const ${scriptConstName} = \`
${func.script}\`;
${typeGenerator.funcType(func)}
export function ${func.funcDef.functionName}(${typeGenerator.type('...args', 'any[]')}) {
export function ${func.funcDef.functionName}(${typeGenerator.type(
"...args",
"any[]",
)}) {
return callFunction$$(
args,
${JSON.stringify(recursiveRenameLaquaProps(func.funcDef), null, 4)},
${JSON.stringify(recursiveRenameLaquaProps(funcDef), null, 4)},
${scriptConstName}
);
}`
}`;
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,22 +14,30 @@
* limitations under the License.
*/
import { OutputType } from './interfaces.js';
import { PackageJson } from '../utils.js';
import { PackageJson } from "../utils.js";
export default function generateHeader({ version, devDependencies }: PackageJson, outputType: OutputType) {
import { OutputType } from "./interfaces.js";
export default function generateHeader(
{ version, devDependencies }: PackageJson,
outputType: OutputType,
) {
return `/* eslint-disable */
// @ts-nocheck
/**
*
* This file is generated using:
* @fluencelabs/aqua-api version: ${devDependencies['@fluencelabs/aqua-api']}
* @fluencelabs/aqua-api version: ${devDependencies["@fluencelabs/aqua-api"]}
* @fluencelabs/aqua-to-js version: ${version}
* If you find any bugs in generated AIR, please write an issue on GitHub: https://github.com/fluencelabs/aqua/issues
* If you find any bugs in generated JS/TS, please write an issue on GitHub: https://github.com/fluencelabs/js-client/issues
*
*/
${outputType === 'ts' ? 'import type { IFluenceClient as IFluenceClient$$, CallParams as CallParams$$ } from \'@fluencelabs/js-client\';' : ''}
${
outputType === "ts"
? "import type { IFluenceClient as IFluenceClient$$, CallParams as CallParams$$ } from '@fluencelabs/js-client';"
: ""
}
import {
v5_callFunction as callFunction$$,

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,46 +14,80 @@
* limitations under the License.
*/
import { CompilationResult, JSTypeGenerator, OutputType, TSTypeGenerator, TypeGenerator } from './interfaces.js';
import { PackageJson } from '../utils.js';
import { generateServices } from './service.js';
import { generateFunctions } from './function.js';
import header from './header.js';
import { PackageJson } from "../utils.js";
import { generateFunctions } from "./function.js";
import header from "./header.js";
import {
CompilationResult,
JSTypeGenerator,
OutputType,
TSTypeGenerator,
TypeGenerator,
} from "./interfaces.js";
import { generateServices } from "./service.js";
const typeGenerators: Record<OutputType, TypeGenerator> = {
'js': new JSTypeGenerator(),
'ts': new TSTypeGenerator()
js: new JSTypeGenerator(),
ts: new TSTypeGenerator(),
};
export async function generateSources({ services, functions }: CompilationResult, outputType: OutputType, packageJson: PackageJson) {
export function generateSources(
{ services, functions }: CompilationResult,
outputType: OutputType,
packageJson: PackageJson,
) {
const typeGenerator = typeGenerators[outputType];
return `${header(packageJson, outputType)}
${Object.entries(services).length > 0 ? `// Services
${
Object.entries(services).length > 0
? `// Services
${generateServices(typeGenerator, services)}
` : ''}
${Object.entries(functions).length > 0 ? `// Functions
`
: ""
}
${
Object.entries(functions).length > 0
? `// Functions
${generateFunctions(typeGenerator, functions)}
`: ''}`
`
: ""
}`;
}
export async function generateTypes({ services, functions }: CompilationResult, packageJson: PackageJson) {
const typeGenerator = typeGenerators['ts'];
export function generateTypes(
{ services, functions }: CompilationResult,
packageJson: PackageJson,
) {
const typeGenerator = typeGenerators["ts"];
const generatedServices = Object.entries(services)
.map(([srvName, srvDef]) => typeGenerator.serviceType(srvName, srvDef))
.join('\n');
.map(([srvName, srvDef]) => {
return typeGenerator.serviceType(srvName, srvDef);
})
.join("\n");
const generatedFunctions = Object.entries(functions)
.map(([funcName, funcDef]) => typeGenerator.funcType(funcDef))
.join('\n');
.map(([, funcDef]) => {
return typeGenerator.funcType(funcDef);
})
.join("\n");
return `${header(packageJson, 'ts')}
return `${header(packageJson, "ts")}
${Object.entries(services).length > 0 ? `// Services
${
Object.entries(services).length > 0
? `// Services
${generatedServices}
` : ''}
${Object.entries(functions).length > 0 ? `// Functions
${generatedFunctions}
`: ''}`
`
: ""
}
${
Object.entries(functions).length > 0
? `// Functions
${generatedFunctions}
`
: ""
}`;
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,10 +14,11 @@
* limitations under the License.
*/
import { CLIENT } from '../constants.js';
import { FunctionCallDef, ServiceDef } from '@fluencelabs/interfaces';
import { genTypeName, typeToTs } from '../common.js';
import { capitalize, getFuncArgs } from '../utils.js';
import { FunctionCallDef, ServiceDef } from "@fluencelabs/interfaces";
import { genTypeName, typeToTs } from "../common.js";
import { CLIENT } from "../constants.js";
import { capitalize, getFuncArgs } from "../utils.js";
export interface TypeGenerator {
type(field: string, type: string): string;
@ -42,58 +43,94 @@ export class TSTypeGenerator implements TypeGenerator {
funcType({ funcDef }: AquaFunction): string {
const args = getFuncArgs(funcDef.arrow.domain).map(([name, type]) => {
const [typeDesc, t] = genTypeName(type, capitalize(funcDef.functionName) + 'Arg' + capitalize(name));
const [typeDesc, t] = genTypeName(
type,
capitalize(funcDef.functionName) + "Arg" + capitalize(name),
);
return [typeDesc, `${name}: ${t}`] as const;
});
args.push([undefined, `config?: {ttl?: number}`]);
const argsDefs = args.map(([, def]) => " " + def);
const argsDesc = args.filter(([desc]) => desc !== undefined).map(([desc]) => desc);
const argsDefs = args.map(([, def]) => {
return " " + def;
});
const argsDesc = args
.filter(([desc]) => {
return desc !== undefined;
})
.map(([desc]) => {
return desc;
});
const functionOverloads = [
argsDefs.join(',\n'),
[` peer: ${CLIENT}`, ...argsDefs].join(',\n')
argsDefs.join(",\n"),
[` peer: ${CLIENT}`, ...argsDefs].join(",\n"),
];
const [resTypeDesc, resType] = genTypeName(funcDef.arrow.codomain, capitalize(funcDef.functionName) + "Result");
const [resTypeDesc, resType] = genTypeName(
funcDef.arrow.codomain,
capitalize(funcDef.functionName) + "Result",
);
return [
argsDesc.join('\n'),
resTypeDesc || "",
functionOverloads.flatMap(fo => [
argsDesc.join("\n"),
resTypeDesc ?? "",
functionOverloads
.flatMap((fo) => {
return [
`export function ${funcDef.functionName}(`,
fo,
`): Promise<${resType}>;`,
''
]).join('\n')
].filter(s => s !== '').join('\n\n');
"",
];
})
.join("\n"),
]
.filter((s) => {
return s !== "";
})
.join("\n\n");
}
serviceType(srvName: string, srvDef: ServiceDef): string {
const members = srvDef.functions.tag === 'nil' ? [] : Object.entries(srvDef.functions.fields);
const members =
srvDef.functions.tag === "nil"
? []
: Object.entries(srvDef.functions.fields);
const interfaceDefs = members
.map(([name, arrow]) => {
return ` ${name}: ${typeToTs(arrow)};`;
})
.join('\n');
.join("\n");
const interfaces = [`export interface ${srvName}Def {`, interfaceDefs, '}'].join('\n');
const interfaces = [
`export interface ${srvName}Def {`,
interfaceDefs,
"}",
].join("\n");
const peerDecl = `peer: ${CLIENT}`;
const serviceDecl = `service: ${srvName}Def`;
const serviceIdDecl = `serviceId: string`;
const registerServiceArgs = [
[serviceDecl],
[serviceIdDecl, serviceDecl],
[peerDecl, serviceDecl],
[peerDecl, serviceIdDecl, serviceDecl]
[peerDecl, serviceIdDecl, serviceDecl],
];
return [interfaces, ...registerServiceArgs.map(registerServiceArg => {
const args = registerServiceArg.join(', ');
return `export function register${srvName}(${args}): void;`
})].join('\n');
return [
interfaces,
...registerServiceArgs.map((registerServiceArg) => {
const args = registerServiceArg.join(", ");
return `export function register${srvName}(${args}): void;`;
}),
].join("\n");
}
}
@ -102,20 +139,20 @@ export class JSTypeGenerator implements TypeGenerator {
return field;
}
generic(field: string, type: string): string {
generic(field: string): string {
return field;
}
type(field: string, type: string): string {
type(field: string): string {
return field;
}
funcType(): string {
return '';
return "";
}
serviceType(): string {
return '';
return "";
}
}
@ -133,4 +170,4 @@ export interface EntityGenerator {
generate(compilationResult: CompilationResult): string;
}
export type OutputType = 'js' | 'ts';
export type OutputType = "js" | "ts";

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,45 +14,74 @@
* limitations under the License.
*/
import { ServiceDef } from '@fluencelabs/interfaces';
import { recursiveRenameLaquaProps } from '../utils.js';
import { TypeGenerator } from './interfaces.js';
import { ServiceDef } from "@fluencelabs/interfaces";
import { recursiveRenameLaquaProps } from "../utils.js";
import { TypeGenerator } from "./interfaces.js";
interface DefaultServiceId {
s_Some__f_value?: string
s_Some__f_value?: string;
}
export function generateServices(typeGenerator: TypeGenerator, services: Record<string, ServiceDef>) {
const generated = Object.entries(services).map(([srvName, srvDef]) => generateService(typeGenerator, srvName, srvDef)).join('\n\n');
export function generateServices(
typeGenerator: TypeGenerator,
services: Record<string, ServiceDef>,
) {
const generated = Object.entries(services)
.map(([srvName, srvDef]) => {
return generateService(typeGenerator, srvName, srvDef);
})
.join("\n\n");
return generated + '\n';
return generated + "\n";
}
function generateService(typeGenerator: TypeGenerator, srvName: string, srvDef: ServiceDef) {
function generateService(
typeGenerator: TypeGenerator,
srvName: string,
srvDef: ServiceDef,
) {
return [
typeGenerator.serviceType(srvName, srvDef),
generateRegisterServiceOverload(typeGenerator, srvName, srvDef)
].join('\n');
generateRegisterServiceOverload(typeGenerator, srvName, srvDef),
].join("\n");
}
function generateRegisterServiceOverload(typeGenerator: TypeGenerator, srvName: string, srvDef: ServiceDef) {
function generateRegisterServiceOverload(
typeGenerator: TypeGenerator,
srvName: string,
srvDef: ServiceDef,
) {
return [
`export function register${srvName}(${typeGenerator.type('...args', 'any[]')}) {`,
' registerService$$(',
' args,',
`export function register${srvName}(${typeGenerator.type(
"...args",
"any[]",
)}) {`,
" registerService$$(",
" args,",
` ${serviceToJson(srvDef)}`,
' );',
'}'
].join('\n');
" );",
"}",
].join("\n");
}
function serviceToJson(service: ServiceDef): string {
return JSON.stringify({
...(
(service.defaultServiceId as DefaultServiceId)?.s_Some__f_value
? { defaultServiceId: (service.defaultServiceId as DefaultServiceId).s_Some__f_value }
: {}
),
functions: recursiveRenameLaquaProps(service.functions)
}, null, 4);
return JSON.stringify(
{
// This assertion is required because aqua-api gives bad types
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
...((service.defaultServiceId as DefaultServiceId).s_Some__f_value != null
? {
defaultServiceId:
// This assertion is required because aqua-api gives bad types
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
(service.defaultServiceId as DefaultServiceId).s_Some__f_value,
}
: {}),
functions: recursiveRenameLaquaProps(service.functions),
},
null,
4,
);
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,12 +14,9 @@
* limitations under the License.
*/
import {
generateSources,
generateTypes,
} from './generate/index.js';
import { CompilationResult, OutputType } from './generate/interfaces.js';
import { getPackageJsonContent } from './utils.js';
import { generateSources, generateTypes } from "./generate/index.js";
import { CompilationResult, OutputType } from "./generate/interfaces.js";
import { getPackageJsonContent } from "./utils.js";
interface JsOutput {
sources: string;
@ -31,17 +28,33 @@ interface TsOutput {
}
type LanguageOutput = {
"js": JsOutput,
"ts": TsOutput
js: JsOutput;
ts: TsOutput;
};
export default async function aquaToJs<T extends OutputType>(res: CompilationResult, outputType: T): Promise<LanguageOutput[T]> {
type NothingToGenerate = null;
export default async function aquaToJs<T extends OutputType>(
res: CompilationResult,
outputType: T,
): Promise<LanguageOutput[T] | NothingToGenerate> {
if (
Object.keys(res.services).length === 0 &&
Object.keys(res.functions).length === 0
) {
return null;
}
const packageJson = await getPackageJsonContent();
return outputType === 'js' ? {
sources: await generateSources(res, 'js', packageJson),
types: await generateTypes(res, packageJson)
} : {
sources: await generateSources(res, 'ts', packageJson),
} as LanguageOutput[T];
};
return outputType === "js"
? {
sources: generateSources(res, "js", packageJson),
types: generateTypes(res, packageJson),
}
: // TODO: probably there is a way to remove this type assert
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
({
sources: generateSources(res, "ts", packageJson),
} as LanguageOutput[T]);
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,53 +14,90 @@
* limitations under the License.
*/
import { ArrowWithoutCallbacks, NonArrowType, ProductType } from '@fluencelabs/interfaces';
import { readFile } from 'fs/promises';
import path from 'path';
import assert from "assert";
import { readFile } from "fs/promises";
import path from "path";
import {
ArrowType,
ArrowWithoutCallbacks,
JSONValue,
LabeledProductType,
NilType,
SimpleTypes,
UnlabeledProductType,
} from "@fluencelabs/interfaces";
export interface PackageJson {
name: string;
version: string;
devDependencies: {
['@fluencelabs/aqua-api']: string
}
["@fluencelabs/aqua-api"]: string;
};
}
export async function getPackageJsonContent(): Promise<PackageJson> {
const content = await readFile(new URL(path.join('..', 'package.json'), import.meta.url), 'utf-8');
return JSON.parse(content);
const content = await readFile(
new URL(path.join("..", "package.json"), import.meta.url),
"utf-8",
);
// TODO: Add validation here
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
return JSON.parse(content) as PackageJson;
}
export function getFuncArgs(domain: ProductType<NonArrowType | ArrowWithoutCallbacks>): [string, NonArrowType | ArrowWithoutCallbacks][] {
if (domain.tag === 'labeledProduct') {
return Object.entries(domain.fields).map(([label, type]) => [label, type]);
} else if (domain.tag === 'unlabeledProduct') {
return domain.items.map((type, index) => ['arg' + index, type]);
export function getFuncArgs(
domain:
| LabeledProductType<SimpleTypes | ArrowType<UnlabeledProductType>>
| UnlabeledProductType
| NilType,
): [string, SimpleTypes | ArrowWithoutCallbacks][] {
if (domain.tag === "labeledProduct") {
return Object.entries(domain.fields).map(([label, type]) => {
return [label, type];
});
} else if (domain.tag === "unlabeledProduct") {
return domain.items.map((type, index) => {
return ["arg" + index, type];
});
} else {
return [];
}
}
export function recursiveRenameLaquaProps(obj: unknown): unknown {
if (typeof obj !== 'object' || obj === null) return obj;
export function recursiveRenameLaquaProps(obj: JSONValue): unknown {
if (typeof obj !== "object" || obj === null) {
return obj;
}
if (Array.isArray(obj)) {
return obj.map(item => recursiveRenameLaquaProps(item));
return obj.map((item) => {
return recursiveRenameLaquaProps(item);
});
}
return Object.getOwnPropertyNames(obj).reduce((acc, prop) => {
let accessProp = prop;
if (prop.includes('Laqua_js')) {
if (prop.includes("Laqua_js")) {
// Last part of the property separated by "_" is a correct name
const refinedProperty = prop.split('_').pop()!;
const refinedProperty = prop.split("_").pop();
if (refinedProperty == null) {
throw new Error(`Bad property name: ${prop}.`);
}
if (refinedProperty in obj) {
accessProp = refinedProperty;
}
}
assert(accessProp in obj);
return {
...acc,
[accessProp]: recursiveRenameLaquaProps(obj[accessProp as keyof typeof obj])
[accessProp]: recursiveRenameLaquaProps(obj[accessProp]),
};
}, {});
}

View File

@ -6,5 +6,5 @@
"outDir": "./dist"
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist", "src/**/__test__"],
"exclude": ["node_modules", "dist", "src/**/__test__"]
}

View File

@ -2,85 +2,74 @@
## [0.8.2](https://github.com/fluencelabs/js-client/compare/interfaces-v0.8.1...interfaces-v0.8.2) (2023-08-24)
### Features
* use marine-js 0.7.2 ([#321](https://github.com/fluencelabs/js-client/issues/321)) ([c99a509](https://github.com/fluencelabs/js-client/commit/c99a509c8743471856b0beb25696ffe7357d5399))
- use marine-js 0.7.2 ([#321](https://github.com/fluencelabs/js-client/issues/321)) ([c99a509](https://github.com/fluencelabs/js-client/commit/c99a509c8743471856b0beb25696ffe7357d5399))
## [0.8.1](https://github.com/fluencelabs/js-client/compare/interfaces-v0.8.0...interfaces-v0.8.1) (2023-08-08)
### Bug Fixes
* **deps:** update dependency @fluencelabs/avm to v0.43.1 ([#322](https://github.com/fluencelabs/js-client/issues/322)) ([c1d1fa6](https://github.com/fluencelabs/js-client/commit/c1d1fa6659b6dc2c6707786748b3410fab7f1bcd))
- **deps:** update dependency @fluencelabs/avm to v0.43.1 ([#322](https://github.com/fluencelabs/js-client/issues/322)) ([c1d1fa6](https://github.com/fluencelabs/js-client/commit/c1d1fa6659b6dc2c6707786748b3410fab7f1bcd))
## [0.8.0](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.6...interfaces-v0.8.0) (2023-06-29)
### ⚠ BREAKING CHANGES
* **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315)
- **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315)
### Features
* **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315) ([8bae6e2](https://github.com/fluencelabs/js-client/commit/8bae6e24e62153b567f320ccecc7bce76bc826d1))
- **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315) ([8bae6e2](https://github.com/fluencelabs/js-client/commit/8bae6e24e62153b567f320ccecc7bce76bc826d1))
## [0.7.6](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.5...interfaces-v0.7.6) (2023-06-20)
### Features
* support signatures [fixes DXJ-389] ([#310](https://github.com/fluencelabs/js-client/issues/310)) ([a60dfe0](https://github.com/fluencelabs/js-client/commit/a60dfe0d680b4d9ac5092dec64e2ebf478bf80eb))
- support signatures [fixes DXJ-389] ([#310](https://github.com/fluencelabs/js-client/issues/310)) ([a60dfe0](https://github.com/fluencelabs/js-client/commit/a60dfe0d680b4d9ac5092dec64e2ebf478bf80eb))
## [0.7.5](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.4...interfaces-v0.7.5) (2023-04-04)
### Features
* Cleaning up technical debts ([#295](https://github.com/fluencelabs/js-client/issues/295)) ([0b2f12d](https://github.com/fluencelabs/js-client/commit/0b2f12d8ac223db341d6c30ff403166b3eae2e56))
- Cleaning up technical debts ([#295](https://github.com/fluencelabs/js-client/issues/295)) ([0b2f12d](https://github.com/fluencelabs/js-client/commit/0b2f12d8ac223db341d6c30ff403166b3eae2e56))
## [0.7.4](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.3...interfaces-v0.7.4) (2023-03-31)
### Features
* **logs:** Use `debug.js` library for logging [DXJ-327] ([#285](https://github.com/fluencelabs/js-client/issues/285)) ([e95c34a](https://github.com/fluencelabs/js-client/commit/e95c34a79220bd8ecdcee806802ac3d69a2af0cb))
- **logs:** Use `debug.js` library for logging [DXJ-327] ([#285](https://github.com/fluencelabs/js-client/issues/285)) ([e95c34a](https://github.com/fluencelabs/js-client/commit/e95c34a79220bd8ecdcee806802ac3d69a2af0cb))
## [0.7.3](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.2...interfaces-v0.7.3) (2023-02-16)
### Bug Fixes
* Trigger release to publish packages that were built ([#262](https://github.com/fluencelabs/js-client/issues/262)) ([47abf38](https://github.com/fluencelabs/js-client/commit/47abf3882956ffbdc52df372db26ba6252e8306b))
- Trigger release to publish packages that were built ([#262](https://github.com/fluencelabs/js-client/issues/262)) ([47abf38](https://github.com/fluencelabs/js-client/commit/47abf3882956ffbdc52df372db26ba6252e8306b))
## [0.7.2](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.1...interfaces-v0.7.2) (2023-02-16)
### Features
* Add `getRelayPeerId` method for `IFluenceClient` ([#260](https://github.com/fluencelabs/js-client/issues/260)) ([a10278a](https://github.com/fluencelabs/js-client/commit/a10278afaa782a307feb10c4eac060094c101230))
- Add `getRelayPeerId` method for `IFluenceClient` ([#260](https://github.com/fluencelabs/js-client/issues/260)) ([a10278a](https://github.com/fluencelabs/js-client/commit/a10278afaa782a307feb10c4eac060094c101230))
## [0.7.1](https://github.com/fluencelabs/js-client/compare/interfaces-v0.7.0...interfaces-v0.7.1) (2023-02-16)
### Features
* Simplify JS Client public API ([#257](https://github.com/fluencelabs/js-client/issues/257)) ([9daaf41](https://github.com/fluencelabs/js-client/commit/9daaf410964d43228192c829c7ff785db6e88081))
- Simplify JS Client public API ([#257](https://github.com/fluencelabs/js-client/issues/257)) ([9daaf41](https://github.com/fluencelabs/js-client/commit/9daaf410964d43228192c829c7ff785db6e88081))
## [0.7.0](https://github.com/fluencelabs/fluence-js/compare/interfaces-v0.6.0...interfaces-v0.7.0) (2023-02-15)
### ⚠ BREAKING CHANGES
* Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246))
* Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243))
- Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246))
- Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243))
### Features
* Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246)) ([d4bb8fb](https://github.com/fluencelabs/fluence-js/commit/d4bb8fb42964b3ba25154232980b9ae82c21e627))
* Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243)) ([9667c4f](https://github.com/fluencelabs/fluence-js/commit/9667c4fec6868f984bba13249f3c47d293396406))
- Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246)) ([d4bb8fb](https://github.com/fluencelabs/fluence-js/commit/d4bb8fb42964b3ba25154232980b9ae82c21e627))
- Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243)) ([9667c4f](https://github.com/fluencelabs/fluence-js/commit/9667c4fec6868f984bba13249f3c47d293396406))
### Bug Fixes
* NodeJS package building ([#248](https://github.com/fluencelabs/fluence-js/issues/248)) ([0d05e51](https://github.com/fluencelabs/fluence-js/commit/0d05e517d89529af513fcb96cfa6c722ccc357a7))
- NodeJS package building ([#248](https://github.com/fluencelabs/fluence-js/issues/248)) ([0d05e51](https://github.com/fluencelabs/fluence-js/commit/0d05e517d89529af513fcb96cfa6c722ccc357a7))

View File

@ -51,6 +51,6 @@
"devDependencies": {
"@multiformats/multiaddr": "11.3.0",
"@fluencelabs/avm": "0.48.0",
"@fluencelabs/marine-js": "0.7.2"
"hotscript": "1.0.13"
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,7 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { SecurityTetraplet } from '@fluencelabs/avm';
import type { SecurityTetraplet } from "@fluencelabs/avm";
import { InterfaceToType, MaybePromise } from "./utils.js";
/**
* Peer ID's id as a base58 string (multihash/CIDv0).
@ -32,7 +35,7 @@ export type Node = {
* Additional information about a service call
* @typeparam ArgName
*/
export interface CallParams<ArgName extends string | null> {
export type CallParams<ArgName extends string | null> = {
/**
* The identifier of particle which triggered the call
*/
@ -61,5 +64,24 @@ export interface CallParams<ArgName extends string | null> {
/**
* Security tetraplets
*/
tetraplets: ArgName extends string ? Record<ArgName, SecurityTetraplet[]> : Record<string, never>;
}
tetraplets: ArgName extends string
? Record<ArgName, InterfaceToType<SecurityTetraplet>[]>
: Record<string, never>;
};
export type ServiceImpl = Record<
string,
(
...args: [...JSONArray, CallParams<string>]
) => MaybePromise<JSONValue | undefined>
>;
export type JSONValue =
| string
| number
| boolean
| null
| { [x: string]: JSONValue }
| Array<JSONValue>;
export type JSONArray = Array<JSONValue>;
export type JSONObject = { [x: string]: JSONValue };

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,77 +13,85 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
type SimpleTypes = ScalarType | OptionType | ArrayType | StructType | TopType | BottomType | NilType;
export type NonArrowType = SimpleTypes | ProductType<SimpleTypes>;
export type SimpleTypes =
| ScalarType
| OptionType
| ArrayType
| StructType
| TopType
| BottomType
| NilType;
export type NonArrowType = SimpleTypes | ProductType;
export type TopType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'topType';
tag: "topType";
};
export type BottomType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'bottomType';
tag: "bottomType";
};
export type OptionType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'option';
tag: "option";
/**
* Underlying type of the option
*/
type: NonArrowType;
type: SimpleTypes;
};
export type NilType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'nil';
tag: "nil";
};
export type ArrayType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'array';
tag: "array";
/**
* Type of array elements
*/
type: NonArrowType;
type: SimpleTypes;
};
/**
* All possible scalar type names
*/
export type ScalarNames =
| 'u8'
| 'u16'
| 'u32'
| 'u64'
| 'i8'
| 'i16'
| 'i32'
| 'i64'
| 'f32'
| 'f64'
| 'bool'
| 'string';
| "u8"
| "u16"
| "u32"
| "u64"
| "i8"
| "i16"
| "i32"
| "i64"
| "f32"
| "f64"
| "bool"
| "string";
export type ScalarType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'scalar';
tag: "scalar";
/**
* Name of the scalar type
@ -95,7 +103,7 @@ export type StructType = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'struct';
tag: "struct";
/**
* Struct name
@ -105,65 +113,75 @@ export type StructType = {
/**
* Struct fields
*/
fields: { [key: string]: NonArrowType };
fields: { [key: string]: SimpleTypes };
};
export type LabeledProductType<T> = {
export type LabeledProductType<
T extends
| SimpleTypes
| ArrowType<LabeledProductType<SimpleTypes> | UnlabeledProductType> =
| SimpleTypes
| ArrowType<LabeledProductType<SimpleTypes> | UnlabeledProductType>,
K extends { [key: string]: T } = { [key: string]: T },
> = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'labeledProduct';
tag: "labeledProduct";
/**
* Labelled product fields
*/
fields: { [key: string]: T };
fields: K;
};
export type UnlabeledProductType<T> = {
export type UnlabeledProductType<T extends Array<SimpleTypes> = SimpleTypes[]> =
{
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'unlabeledProduct';
tag: "unlabeledProduct";
/**
* Items in unlabelled product
*/
items: Array<T>;
};
items: T;
};
export type ProductType<T> = UnlabeledProductType<T> | LabeledProductType<T> | NilType;
export type ProductType = UnlabeledProductType | LabeledProductType;
/**
* ArrowType is a profunctor pointing its domain to codomain.
* Profunctor means variance: Arrow is contravariant on domain, and variant on codomain.
*/
export type ArrowType<T> = {
export type ArrowType<T extends LabeledProductType | UnlabeledProductType> = {
/**
* Type descriptor. Used for pattern-matching
*/
tag: 'arrow';
tag: "arrow";
/**
* Where this Arrow is defined
*/
domain: ProductType<T>;
domain: T | NilType;
/**
* Where this Arrow points to
*/
codomain: UnlabeledProductType<NonArrowType> | NilType;
codomain: UnlabeledProductType | NilType;
};
/**
* Arrow which domain contains only non-arrow types
*/
export type ArrowWithoutCallbacks = ArrowType<NonArrowType>;
export type ArrowWithoutCallbacks = ArrowType<
UnlabeledProductType | LabeledProductType<SimpleTypes>
>;
/**
* Arrow which domain does can contain both non-arrow types and arrows (which themselves cannot contain arrows)
*/
export type ArrowWithCallbacks = ArrowType<NonArrowType | ArrowWithoutCallbacks>;
export type ArrowWithCallbacks = ArrowType<LabeledProductType>;
export interface FunctionCallConstants {
/**
@ -214,7 +232,9 @@ export interface FunctionCallDef {
/**
* Underlying arrow which represents function in aqua
*/
arrow: ArrowWithCallbacks;
arrow: ArrowType<
LabeledProductType<SimpleTypes | ArrowType<UnlabeledProductType>>
>;
/**
* Names of the different entities used in generated air script
@ -234,7 +254,9 @@ export interface ServiceDef {
/**
* List of functions which the service consists of
*/
functions: LabeledProductType<ArrowWithoutCallbacks> | NilType;
functions:
| LabeledProductType<ArrowType<LabeledProductType<SimpleTypes>>>
| NilType;
}
/**
@ -253,17 +275,17 @@ export const getArgumentTypes = (
): {
[key: string]: NonArrowType | ArrowWithoutCallbacks;
} => {
if (def.arrow.domain.tag !== 'labeledProduct') {
throw new Error('Should be impossible');
if (def.arrow.domain.tag !== "labeledProduct") {
throw new Error("Should be impossible");
}
return def.arrow.domain.fields;
};
export const isReturnTypeVoid = (def: FunctionCallDef): boolean => {
if (def.arrow.codomain.tag === 'nil') {
if (def.arrow.codomain.tag === "nil") {
return true;
}
return def.arrow.codomain.items.length == 0;
return def.arrow.codomain.items.length === 0;
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,13 +13,27 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { IFluenceInternalApi } from '../fluenceClient.js';
import { FnConfig, FunctionCallDef, ServiceDef } from './aquaTypeDefinitions.js';
import { JSONValue } from "../commonTypes.js";
import { IFluenceInternalApi } from "../fluenceClient.js";
import {
FnConfig,
FunctionCallDef,
ServiceDef,
} from "./aquaTypeDefinitions.js";
/**
* Type for callback passed as aqua function argument
*/
export type ArgCallbackFunction = (
...args: JSONValue[]
) => JSONValue | Promise<JSONValue>;
/**
* Arguments passed to Aqua function
*/
export type PassedArgs = { [key: string]: any };
export type PassedArgs = { [key: string]: JSONValue | ArgCallbackFunction };
/**
* Arguments for callAquaFunction function
@ -54,7 +68,9 @@ export interface CallAquaFunctionArgs {
/**
* Call a function from Aqua script
*/
export type CallAquaFunctionType = (args: CallAquaFunctionArgs) => Promise<unknown>;
export type CallAquaFunctionType = (
args: CallAquaFunctionArgs,
) => Promise<unknown>;
/**
* Arguments for registerService function
@ -78,7 +94,7 @@ export interface RegisterServiceArgs {
/**
* Service implementation
*/
service: any;
service: unknown;
}
/**

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,7 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { Node } from './commonTypes.js';
import type { Node } from "./commonTypes.js";
/**
* A node in Fluence network a client can connect to.
@ -26,14 +27,14 @@ export type RelayOptions = string | Node;
/**
* Fluence Peer's key pair types
*/
export type KeyTypes = 'RSA' | 'Ed25519' | 'secp256k1';
export type KeyTypes = "RSA" | "Ed25519" | "secp256k1";
/**
* Options to specify key pair used in Fluence Peer
*/
export type KeyPairOptions = {
type: 'Ed25519';
source: 'random' | Uint8Array;
type: "Ed25519";
source: "random" | Uint8Array;
};
/**
@ -97,7 +98,12 @@ export interface ClientConfig {
/**
* Fluence JS Client connection states as string literals
*/
export const ConnectionStates = ['disconnected', 'connecting', 'connected', 'disconnecting'] as const;
export const ConnectionStates = [
"disconnected",
"connecting",
"connected",
"disconnecting",
] as const;
/**
* Fluence JS Client connection states
@ -108,7 +114,7 @@ export interface IFluenceInternalApi {
/**
* Internal API
*/
internals: any;
internals: unknown;
}
/**
@ -128,7 +134,9 @@ export interface IFluenceClient extends IFluenceInternalApi {
/**
* Handle connection state changes. Immediately returns current connection state
*/
onConnectionStateChange(handler: (state: ConnectionState) => void): ConnectionState;
onConnectionStateChange(
handler: (state: ConnectionState) => void,
): ConnectionState;
/**
* Return peer's secret key as byte array.
@ -145,7 +153,3 @@ export interface IFluenceClient extends IFluenceInternalApi {
*/
getRelayPeerId(): string;
}

View File

@ -0,0 +1,90 @@
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
ArrayType,
ArrowType,
LabeledProductType,
NilType,
OptionType,
ScalarType,
SimpleTypes,
StructType,
TopType,
UnlabeledProductType,
} from "@fluencelabs/interfaces";
import { Call, Pipe, Objects, Tuples, Unions, Fn } from "hotscript";
// Type definitions for inferring ts types from air json definition
// In the future we may remove string type declaration and move to type inference.
type GetTsTypeFromScalar<T extends ScalarType> = [T["name"]] extends [
"u8" | "u16" | "u32" | "u64" | "i8" | "i16" | "i32" | "i64" | "f32" | "f64",
]
? number
: [T["name"]] extends ["bool"]
? boolean
: [T["name"]] extends ["string"]
? string
: never;
type MapTuple<T> = {
[K in keyof T]: [T[K]] extends [SimpleTypes] ? GetSimpleType<T[K]> : never;
};
type UnpackIfSingle<T> = [T] extends [[infer R]] ? R : T;
type GetSimpleType<T> = [T] extends [NilType]
? null
: [T] extends [ArrayType]
? GetSimpleType<T["type"]>[]
: [T] extends [StructType]
? { [K in keyof T["fields"]]: GetSimpleType<T["fields"][K]> }
: [T] extends [OptionType]
? GetSimpleType<T["type"]> | null
: [T] extends [ScalarType]
? GetTsTypeFromScalar<T>
: [T] extends [TopType]
? unknown
: never;
interface Access<T> extends Fn {
return: __GetTsType<Call<Objects.Get<this["arg0"]>, T>>;
}
type __GetTsType<T> = [T] extends [SimpleTypes]
? GetSimpleType<T>
: [T] extends [UnlabeledProductType]
? MapTuple<T["items"]>
: [T] extends [LabeledProductType]
? { [K in keyof T["fields"]]: __GetTsType<T["fields"][K]> }
: [T] extends [ArrowType<infer H>]
? (
...t: [H] extends [UnlabeledProductType<infer K>]
? MapTuple<K>
: [H] extends [LabeledProductType<infer _V, infer K>]
? Pipe<K, [Objects.Keys, Unions.ToTuple, Tuples.Map<Access<K>>]>
: []
) => [T["codomain"]] extends [UnlabeledProductType]
? UnpackIfSingle<MapTuple<T["codomain"]["items"]>>
: undefined
: never;
type DeepMutable<T> = {
-readonly [K in keyof T]: DeepMutable<T[K]>;
};
export type GetTsType<T> = __GetTsType<DeepMutable<T>>;

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,7 +13,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export * from './compilerSupport/aquaTypeDefinitions.js';
export * from './compilerSupport/compilerSupportInterface.js';
export * from './commonTypes.js';
export * from './fluenceClient.js';
export * from "./compilerSupport/aquaTypeDefinitions.js";
export * from "./compilerSupport/compilerSupportInterface.js";
export * from "./commonTypes.js";
export * from "./fluenceClient.js";
export * from "./future.js";

View File

@ -0,0 +1,21 @@
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export type InterfaceToType<T extends object> = {
[K in keyof T]: T[K];
};
export type MaybePromise<T> = T | Promise<T>;

View File

@ -1,7 +1,8 @@
{
"extends": "../../../tsconfig.json",
"compilerOptions": {
"outDir": "./dist"
"outDir": "./dist",
"rootDir": "src"
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]

View File

@ -25,271 +25,234 @@
## [0.1.7](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.6...js-client-v0.1.7) (2023-09-22)
### Bug Fixes
* **deps:** update dependency @fluencelabs/avm to v0.48.0 ([#350](https://github.com/fluencelabs/js-client/issues/350)) ([945908a](https://github.com/fluencelabs/js-client/commit/945908a992976f2ad953bcaa3918741f890ffeeb))
- **deps:** update dependency @fluencelabs/avm to v0.48.0 ([#350](https://github.com/fluencelabs/js-client/issues/350)) ([945908a](https://github.com/fluencelabs/js-client/commit/945908a992976f2ad953bcaa3918741f890ffeeb))
### Dependencies
* The following workspace dependencies were updated
* devDependencies
* @fluencelabs/marine-worker bumped to 0.3.3
- The following workspace dependencies were updated
- devDependencies
- @fluencelabs/marine-worker bumped to 0.3.3
## [0.1.6](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.5...js-client-v0.1.6) (2023-09-15)
### Bug Fixes
* **deps:** update dependency @fluencelabs/avm to v0.47.0 ([#341](https://github.com/fluencelabs/js-client/issues/341)) ([f186f20](https://github.com/fluencelabs/js-client/commit/f186f209366c29f12e6677e03564ee2fa14b51ae))
- **deps:** update dependency @fluencelabs/avm to v0.47.0 ([#341](https://github.com/fluencelabs/js-client/issues/341)) ([f186f20](https://github.com/fluencelabs/js-client/commit/f186f209366c29f12e6677e03564ee2fa14b51ae))
### Dependencies
* The following workspace dependencies were updated
* devDependencies
* @fluencelabs/marine-worker bumped to 0.3.2
- The following workspace dependencies were updated
- devDependencies
- @fluencelabs/marine-worker bumped to 0.3.2
## [0.1.5](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.4...js-client-v0.1.5) (2023-09-14)
### Bug Fixes
* **libp2p:** Add fluence protocol to local peer store protocols [fixes DXJ-471] ([#343](https://github.com/fluencelabs/js-client/issues/343)) ([88fcf02](https://github.com/fluencelabs/js-client/commit/88fcf02d5fd3d28db619427c31b38154646f7ad2))
- **libp2p:** Add fluence protocol to local peer store protocols [fixes DXJ-471] ([#343](https://github.com/fluencelabs/js-client/issues/343)) ([88fcf02](https://github.com/fluencelabs/js-client/commit/88fcf02d5fd3d28db619427c31b38154646f7ad2))
## [0.1.4](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.3...js-client-v0.1.4) (2023-09-14)
### Bug Fixes
* Fire and forget [fixes DXJ-446] ([#336](https://github.com/fluencelabs/js-client/issues/336)) ([e0a970d](https://github.com/fluencelabs/js-client/commit/e0a970d86a13f1617778a461c1c4d558d7dbafcb))
- Fire and forget [fixes DXJ-446] ([#336](https://github.com/fluencelabs/js-client/issues/336)) ([e0a970d](https://github.com/fluencelabs/js-client/commit/e0a970d86a13f1617778a461c1c4d558d7dbafcb))
## [0.1.3](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.2...js-client-v0.1.3) (2023-09-07)
### Bug Fixes
* **deps:** update dependency @fluencelabs/avm to v0.46.0 ([#338](https://github.com/fluencelabs/js-client/issues/338)) ([8e6918c](https://github.com/fluencelabs/js-client/commit/8e6918c4da5bc4cdfe1c840312f477d782d9ca20))
- **deps:** update dependency @fluencelabs/avm to v0.46.0 ([#338](https://github.com/fluencelabs/js-client/issues/338)) ([8e6918c](https://github.com/fluencelabs/js-client/commit/8e6918c4da5bc4cdfe1c840312f477d782d9ca20))
### Dependencies
* The following workspace dependencies were updated
* devDependencies
* @fluencelabs/marine-worker bumped to 0.3.1
- The following workspace dependencies were updated
- devDependencies
- @fluencelabs/marine-worker bumped to 0.3.1
## [0.1.2](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.1...js-client-v0.1.2) (2023-09-05)
### Features
* remove obsolete packages [fixes DXJ-462] ([#337](https://github.com/fluencelabs/js-client/issues/337)) ([e7e6176](https://github.com/fluencelabs/js-client/commit/e7e617661f39e1df36a703d5dad93ba52a338919))
- remove obsolete packages [fixes DXJ-462] ([#337](https://github.com/fluencelabs/js-client/issues/337)) ([e7e6176](https://github.com/fluencelabs/js-client/commit/e7e617661f39e1df36a703d5dad93ba52a338919))
### Bug Fixes
* **logger:** Change formatter that collides with new libp2p version [fixes DXJ-459] ([#334](https://github.com/fluencelabs/js-client/issues/334)) ([18a972b](https://github.com/fluencelabs/js-client/commit/18a972b573559d0717ec93a95b8c63dd1cbcd93b))
- **logger:** Change formatter that collides with new libp2p version [fixes DXJ-459] ([#334](https://github.com/fluencelabs/js-client/issues/334)) ([18a972b](https://github.com/fluencelabs/js-client/commit/18a972b573559d0717ec93a95b8c63dd1cbcd93b))
## [0.1.1](https://github.com/fluencelabs/js-client/compare/js-client-v0.1.0...js-client-v0.1.1) (2023-08-25)
### Bug Fixes
* Use info log level instead trace [Fixes DXJ-457] ([#328](https://github.com/fluencelabs/js-client/issues/328)) ([477c6f0](https://github.com/fluencelabs/js-client/commit/477c6f0c151ef6759aaa2802c5e9907065d58e17))
- Use info log level instead trace [Fixes DXJ-457] ([#328](https://github.com/fluencelabs/js-client/issues/328)) ([477c6f0](https://github.com/fluencelabs/js-client/commit/477c6f0c151ef6759aaa2802c5e9907065d58e17))
## [0.1.0](https://github.com/fluencelabs/js-client/compare/js-client-v0.0.10...js-client-v0.1.0) (2023-08-24)
### ⚠ BREAKING CHANGES
* Unify all packages ([#327](https://github.com/fluencelabs/js-client/issues/327))
- Unify all packages ([#327](https://github.com/fluencelabs/js-client/issues/327))
### Features
* Unify all packages ([#327](https://github.com/fluencelabs/js-client/issues/327)) ([97c2491](https://github.com/fluencelabs/js-client/commit/97c24918d84b34e7ac58337838dc8343cbd44b19))
- Unify all packages ([#327](https://github.com/fluencelabs/js-client/issues/327)) ([97c2491](https://github.com/fluencelabs/js-client/commit/97c24918d84b34e7ac58337838dc8343cbd44b19))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.8.1 to 0.8.2
* devDependencies
* @fluencelabs/marine-worker bumped to 0.3.0
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.8.1 to 0.8.2
- devDependencies
- @fluencelabs/marine-worker bumped to 0.3.0
## [0.9.1](https://github.com/fluencelabs/js-client/compare/js-peer-v0.9.0...js-peer-v0.9.1) (2023-08-08)
### Bug Fixes
* **deps:** update dependency @fluencelabs/avm to v0.43.1 ([#322](https://github.com/fluencelabs/js-client/issues/322)) ([c1d1fa6](https://github.com/fluencelabs/js-client/commit/c1d1fa6659b6dc2c6707786748b3410fab7f1bcd))
- **deps:** update dependency @fluencelabs/avm to v0.43.1 ([#322](https://github.com/fluencelabs/js-client/issues/322)) ([c1d1fa6](https://github.com/fluencelabs/js-client/commit/c1d1fa6659b6dc2c6707786748b3410fab7f1bcd))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.8.0 to 0.8.1
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.8.0 to 0.8.1
## [0.9.0](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.10...js-peer-v0.9.0) (2023-06-29)
### ⚠ BREAKING CHANGES
* **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315)
- **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315)
### Features
* **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315) ([8bae6e2](https://github.com/fluencelabs/js-client/commit/8bae6e24e62153b567f320ccecc7bce76bc826d1))
- **avm:** avm 0.40.0 (https://github.com/fluencelabs/js-client/pull/315) ([8bae6e2](https://github.com/fluencelabs/js-client/commit/8bae6e24e62153b567f320ccecc7bce76bc826d1))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.6 to 0.8.0
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.6 to 0.8.0
## [0.8.10](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.9...js-peer-v0.8.10) (2023-06-20)
### Features
* support signatures [fixes DXJ-389] ([#310](https://github.com/fluencelabs/js-client/issues/310)) ([a60dfe0](https://github.com/fluencelabs/js-client/commit/a60dfe0d680b4d9ac5092dec64e2ebf478bf80eb))
- support signatures [fixes DXJ-389] ([#310](https://github.com/fluencelabs/js-client/issues/310)) ([a60dfe0](https://github.com/fluencelabs/js-client/commit/a60dfe0d680b4d9ac5092dec64e2ebf478bf80eb))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.5 to 0.7.6
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.5 to 0.7.6
## [0.8.9](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.8...js-peer-v0.8.9) (2023-06-14)
### Features
* Add tracing service [fixes DXJ-388] ([#307](https://github.com/fluencelabs/js-client/issues/307)) ([771086f](https://github.com/fluencelabs/js-client/commit/771086fddf52b7a5a1280894c7238e409cdf6a64))
* improve ttl error message ([#300](https://github.com/fluencelabs/js-client/issues/300)) ([9821183](https://github.com/fluencelabs/js-client/commit/9821183d53870240cb5700be67cb8d57533b954b))
- Add tracing service [fixes DXJ-388] ([#307](https://github.com/fluencelabs/js-client/issues/307)) ([771086f](https://github.com/fluencelabs/js-client/commit/771086fddf52b7a5a1280894c7238e409cdf6a64))
- improve ttl error message ([#300](https://github.com/fluencelabs/js-client/issues/300)) ([9821183](https://github.com/fluencelabs/js-client/commit/9821183d53870240cb5700be67cb8d57533b954b))
## [0.8.8](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.7...js-peer-v0.8.8) (2023-05-30)
### Features
* add run-console ([#305](https://github.com/fluencelabs/js-client/issues/305)) ([cf1f029](https://github.com/fluencelabs/js-client/commit/cf1f02963c1d7e1a17866f5798901a0f61b8bc31))
- add run-console ([#305](https://github.com/fluencelabs/js-client/issues/305)) ([cf1f029](https://github.com/fluencelabs/js-client/commit/cf1f02963c1d7e1a17866f5798901a0f61b8bc31))
## [0.8.7](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.6...js-peer-v0.8.7) (2023-04-04)
### Features
* Cleaning up technical debts ([#295](https://github.com/fluencelabs/js-client/issues/295)) ([0b2f12d](https://github.com/fluencelabs/js-client/commit/0b2f12d8ac223db341d6c30ff403166b3eae2e56))
- Cleaning up technical debts ([#295](https://github.com/fluencelabs/js-client/issues/295)) ([0b2f12d](https://github.com/fluencelabs/js-client/commit/0b2f12d8ac223db341d6c30ff403166b3eae2e56))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.4 to 0.7.5
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.4 to 0.7.5
## [0.8.6](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.5...js-peer-v0.8.6) (2023-03-31)
### Features
* **logs:** Use `debug.js` library for logging [DXJ-327] ([#285](https://github.com/fluencelabs/js-client/issues/285)) ([e95c34a](https://github.com/fluencelabs/js-client/commit/e95c34a79220bd8ecdcee806802ac3d69a2af0cb))
* **test:** Automate smoke tests for JS Client [DXJ-293] ([#282](https://github.com/fluencelabs/js-client/issues/282)) ([10d7eae](https://github.com/fluencelabs/js-client/commit/10d7eaed809dde721b582d4b3228a48bbec50884))
- **logs:** Use `debug.js` library for logging [DXJ-327] ([#285](https://github.com/fluencelabs/js-client/issues/285)) ([e95c34a](https://github.com/fluencelabs/js-client/commit/e95c34a79220bd8ecdcee806802ac3d69a2af0cb))
- **test:** Automate smoke tests for JS Client [DXJ-293] ([#282](https://github.com/fluencelabs/js-client/issues/282)) ([10d7eae](https://github.com/fluencelabs/js-client/commit/10d7eaed809dde721b582d4b3228a48bbec50884))
### Bug Fixes
* **test:** All tests are working with vitest [DXJ-306] ([#291](https://github.com/fluencelabs/js-client/issues/291)) ([58ad3ca](https://github.com/fluencelabs/js-client/commit/58ad3ca6f666e8580997bb47609947645903436d))
- **test:** All tests are working with vitest [DXJ-306] ([#291](https://github.com/fluencelabs/js-client/issues/291)) ([58ad3ca](https://github.com/fluencelabs/js-client/commit/58ad3ca6f666e8580997bb47609947645903436d))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.3 to 0.7.4
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.3 to 0.7.4
## [0.8.5](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.4...js-peer-v0.8.5) (2023-03-03)
### Bug Fixes
* Increase number of inbound and outbound streams to 1024 ([#280](https://github.com/fluencelabs/js-client/issues/280)) ([1ccc483](https://github.com/fluencelabs/js-client/commit/1ccc4835328426b546f31e1646d3a49ed042fdf9))
- Increase number of inbound and outbound streams to 1024 ([#280](https://github.com/fluencelabs/js-client/issues/280)) ([1ccc483](https://github.com/fluencelabs/js-client/commit/1ccc4835328426b546f31e1646d3a49ed042fdf9))
## [0.8.4](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.3...js-peer-v0.8.4) (2023-02-22)
### Bug Fixes
* `nodenext` moduleResolution for js peer ([#271](https://github.com/fluencelabs/js-client/issues/271)) ([78d98f1](https://github.com/fluencelabs/js-client/commit/78d98f15c12431dee9fdd7b9869d57760503f8c7))
- `nodenext` moduleResolution for js peer ([#271](https://github.com/fluencelabs/js-client/issues/271)) ([78d98f1](https://github.com/fluencelabs/js-client/commit/78d98f15c12431dee9fdd7b9869d57760503f8c7))
## [0.8.3](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.2...js-peer-v0.8.3) (2023-02-16)
### Bug Fixes
* Trigger release to publish packages that were built ([#262](https://github.com/fluencelabs/js-client/issues/262)) ([47abf38](https://github.com/fluencelabs/js-client/commit/47abf3882956ffbdc52df372db26ba6252e8306b))
- Trigger release to publish packages that were built ([#262](https://github.com/fluencelabs/js-client/issues/262)) ([47abf38](https://github.com/fluencelabs/js-client/commit/47abf3882956ffbdc52df372db26ba6252e8306b))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.2 to 0.7.3
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.2 to 0.7.3
## [0.8.2](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.1...js-peer-v0.8.2) (2023-02-16)
### Features
* Add `getRelayPeerId` method for `IFluenceClient` ([#260](https://github.com/fluencelabs/js-client/issues/260)) ([a10278a](https://github.com/fluencelabs/js-client/commit/a10278afaa782a307feb10c4eac060094c101230))
- Add `getRelayPeerId` method for `IFluenceClient` ([#260](https://github.com/fluencelabs/js-client/issues/260)) ([a10278a](https://github.com/fluencelabs/js-client/commit/a10278afaa782a307feb10c4eac060094c101230))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.1 to 0.7.2
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.1 to 0.7.2
## [0.8.1](https://github.com/fluencelabs/js-client/compare/js-peer-v0.8.0...js-peer-v0.8.1) (2023-02-16)
### Features
* Simplify JS Client public API ([#257](https://github.com/fluencelabs/js-client/issues/257)) ([9daaf41](https://github.com/fluencelabs/js-client/commit/9daaf410964d43228192c829c7ff785db6e88081))
- Simplify JS Client public API ([#257](https://github.com/fluencelabs/js-client/issues/257)) ([9daaf41](https://github.com/fluencelabs/js-client/commit/9daaf410964d43228192c829c7ff785db6e88081))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.7.0 to 0.7.1
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.7.0 to 0.7.1
## [0.8.0](https://github.com/fluencelabs/fluence-js/compare/js-peer-v0.7.0...js-peer-v0.8.0) (2023-02-15)
### ⚠ BREAKING CHANGES
* Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246))
* Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243))
- Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246))
- Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243))
### Features
* Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246)) ([d4bb8fb](https://github.com/fluencelabs/fluence-js/commit/d4bb8fb42964b3ba25154232980b9ae82c21e627))
* Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243)) ([9667c4f](https://github.com/fluencelabs/fluence-js/commit/9667c4fec6868f984bba13249f3c47d293396406))
- Expose updated JS Client API via `js-client.api` package ([#246](https://github.com/fluencelabs/fluence-js/issues/246)) ([d4bb8fb](https://github.com/fluencelabs/fluence-js/commit/d4bb8fb42964b3ba25154232980b9ae82c21e627))
- Standalone web JS Client ([#243](https://github.com/fluencelabs/fluence-js/issues/243)) ([9667c4f](https://github.com/fluencelabs/fluence-js/commit/9667c4fec6868f984bba13249f3c47d293396406))
### Bug Fixes
* NodeJS package building ([#248](https://github.com/fluencelabs/fluence-js/issues/248)) ([0d05e51](https://github.com/fluencelabs/fluence-js/commit/0d05e517d89529af513fcb96cfa6c722ccc357a7))
- NodeJS package building ([#248](https://github.com/fluencelabs/fluence-js/issues/248)) ([0d05e51](https://github.com/fluencelabs/fluence-js/commit/0d05e517d89529af513fcb96cfa6c722ccc357a7))
### Dependencies
* The following workspace dependencies were updated
* dependencies
* @fluencelabs/interfaces bumped from 0.6.0 to 0.7.0
- The following workspace dependencies were updated
- dependencies
- @fluencelabs/interfaces bumped from 0.6.0 to 0.7.0

View File

@ -17,6 +17,12 @@
"node": "./dist/index.js",
"default": "./dist/browser/index.js"
},
"imports": {
"#fetcher": {
"node": "./dist/fetchers/node.js",
"default": "./dist/fetchers/browser.js"
}
},
"type": "module",
"scripts": {
"build": "tsc && vite build",
@ -28,6 +34,7 @@
"dependencies": {
"@chainsafe/libp2p-noise": "13.0.0",
"@chainsafe/libp2p-yamux": "5.0.0",
"@fluencelabs/avm": "0.48.0",
"@fluencelabs/interfaces": "workspace:*",
"@fluencelabs/marine-worker": "0.3.3",
"@libp2p/crypto": "2.0.3",
@ -36,6 +43,7 @@
"@libp2p/peer-id-factory": "3.0.3",
"@libp2p/websockets": "7.0.4",
"@multiformats/multiaddr": "11.3.0",
"assert": "2.1.0",
"async": "3.2.4",
"bs58": "5.0.0",
"buffer": "6.0.3",
@ -47,22 +55,23 @@
"libp2p": "0.46.6",
"multiformats": "11.0.1",
"rxjs": "7.5.5",
"threads": "1.7.0",
"threads": "fluencelabs/threads.js#b00a5342380b0278d3ae56dcfb170effb3cad7cd",
"ts-pattern": "3.3.3",
"uint8arrays": "4.0.3",
"uuid": "8.3.2"
"uuid": "8.3.2",
"zod": "3.22.4"
},
"devDependencies": {
"@fluencelabs/aqua-api": "0.9.3",
"@fluencelabs/avm": "0.48.0",
"@fluencelabs/marine-js": "0.7.2",
"@rollup/plugin-inject": "5.0.3",
"@types/bs58": "4.0.1",
"@types/debug": "4.1.7",
"@types/node": "20.7.0",
"@types/uuid": "8.3.2",
"vite": "4.0.4",
"hotscript": "1.0.13",
"vite": "4.4.11",
"vite-tsconfig-paths": "4.0.3",
"vitest": "0.29.7"
"vitest": "0.34.6"
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,13 +14,22 @@
* limitations under the License.
*/
import type { FnConfig, FunctionCallDef, ServiceDef } from '@fluencelabs/interfaces';
import type { IFluenceClient } from '@fluencelabs/interfaces';
import { getArgumentTypes } from '@fluencelabs/interfaces';
import { callAquaFunction, Fluence, registerService } from './index.js';
import { FluencePeer } from './jsPeer/FluencePeer.js';
import type {
FnConfig,
FunctionCallDef,
ServiceDef,
PassedArgs,
ServiceImpl,
} from "@fluencelabs/interfaces";
import { getArgumentTypes } from "@fluencelabs/interfaces";
export const isFluencePeer = (fluencePeerCandidate: unknown): fluencePeerCandidate is IFluenceClient => {
import { FluencePeer } from "./jsPeer/FluencePeer.js";
import { callAquaFunction, Fluence, registerService } from "./index.js";
export const isFluencePeer = (
fluencePeerCandidate: unknown,
): fluencePeerCandidate is FluencePeer => {
return fluencePeerCandidate instanceof FluencePeer;
};
@ -33,18 +42,18 @@ export const isFluencePeer = (fluencePeerCandidate: unknown): fluencePeerCandida
* @param script - air script with function execution logic generated by the Aqua compiler
*/
export const v5_callFunction = async (
rawFnArgs: Array<any>,
rawFnArgs: unknown[],
def: FunctionCallDef,
script: string,
): Promise<unknown> => {
const { args, client: peer, config } = await extractFunctionArgs(rawFnArgs, def);
const { args, client: peer, config } = extractFunctionArgs(rawFnArgs, def);
return callAquaFunction({
args,
def,
script,
config: config || {},
peer: peer,
config,
peer,
});
};
@ -52,12 +61,17 @@ export const v5_callFunction = async (
* Convenience function to support Aqua `service` generation backend
* The compiler only need to generate a call the function and provide the corresponding definitions and the air script
* @param args - raw arguments passed by user to the generated function
* TODO: dont forget to add jsdoc for new arg
* @param def - service definition generated by the Aqua compiler
*/
export const v5_registerService = async (args: any[], def: ServiceDef): Promise<unknown> => {
const { peer, service, serviceId } = await extractServiceArgs(args, def.defaultServiceId);
export const v5_registerService = (args: unknown[], def: ServiceDef): void => {
// TODO: Support this in aqua-to-js package
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
const service: ServiceImpl = args.pop() as ServiceImpl;
return registerService({
const { peer, serviceId } = extractServiceArgs(args, def.defaultServiceId);
registerService({
def,
service,
serviceId,
@ -65,6 +79,10 @@ export const v5_registerService = async (args: any[], def: ServiceDef): Promise<
});
};
function isConfig(arg: unknown): arg is FnConfig {
return typeof arg === "object" && arg !== null;
}
/**
* Arguments could be passed in one these configurations:
* [...actualArgs]
@ -75,48 +93,60 @@ export const v5_registerService = async (args: any[], def: ServiceDef): Promise<
* This function select the appropriate configuration and returns
* arguments in a structured way of: { peer, config, args }
*/
const extractFunctionArgs = async (
args: any[],
function extractFunctionArgs(
args: unknown[],
def: FunctionCallDef,
): Promise<{
client: IFluenceClient;
config?: FnConfig;
args: { [key: string]: any };
}> => {
): {
client: FluencePeer;
config: FnConfig;
args: PassedArgs;
} {
const argumentTypes = getArgumentTypes(def);
const argumentNames = Object.keys(argumentTypes);
const numberOfExpectedArgs = argumentNames.length;
let peer: IFluenceClient;
let structuredArgs: any[];
let peer: FluencePeer;
let config: FnConfig;
if (isFluencePeer(args[0])) {
peer = args[0];
structuredArgs = args.slice(1, numberOfExpectedArgs + 1);
config = args[numberOfExpectedArgs + 1];
args = args.slice(1);
} else {
if (!Fluence.defaultClient) {
if (Fluence.defaultClient == null) {
throw new Error(
'Could not register Aqua service because the client is not initialized. Did you forget to call Fluence.connect()?',
"Could not register Aqua service because the client is not initialized. Did you forget to call Fluence.connect()?",
);
}
peer = Fluence.defaultClient;
structuredArgs = args.slice(0, numberOfExpectedArgs);
config = args[numberOfExpectedArgs];
}
const maybeConfig = args[numberOfExpectedArgs];
if (isConfig(maybeConfig)) {
config = maybeConfig;
} else {
config = {};
}
const structuredArgs = args.slice(0, numberOfExpectedArgs);
if (structuredArgs.length !== numberOfExpectedArgs) {
throw new Error(`Incorrect number of arguments. Expecting ${numberOfExpectedArgs}`);
throw new Error(
`Incorrect number of arguments. Expecting ${numberOfExpectedArgs}`,
);
}
const argsRes = argumentNames.reduce((acc, name, index) => ({ ...acc, [name]: structuredArgs[index] }), {});
const argsRes = argumentNames.reduce((acc, name, index) => {
return { ...acc, [name]: structuredArgs[index] };
}, {});
return {
client: peer,
config: config,
args: argsRes,
config: config,
};
};
}
/**
* Arguments could be passed in one these configurations:
@ -130,48 +160,37 @@ const extractFunctionArgs = async (
* This function select the appropriate configuration and returns
* arguments in a structured way of: { peer, serviceId, service }
*/
const extractServiceArgs = async (
args: any[],
const extractServiceArgs = (
args: unknown[],
defaultServiceId?: string,
): Promise<{ peer: IFluenceClient; serviceId: string; service: any }> => {
let peer: IFluenceClient;
let serviceId: any;
let service: any;
): {
peer: FluencePeer;
serviceId: string | undefined;
} => {
let peer: FluencePeer;
let serviceId: string | undefined;
if (isFluencePeer(args[0])) {
peer = args[0];
args = args.slice(1);
} else {
if (!Fluence.defaultClient) {
if (Fluence.defaultClient == null) {
throw new Error(
'Could not register Aqua service because the client is not initialized. Did you forget to call Fluence.connect()?',
"Could not register Aqua service because the client is not initialized. Did you forget to call Fluence.connect()?",
);
}
peer = Fluence.defaultClient;
}
if (typeof args[0] === 'string') {
if (typeof args[0] === "string") {
serviceId = args[0];
} else if (typeof args[1] === 'string') {
serviceId = args[1];
} else {
serviceId = defaultServiceId;
}
// Figuring out which overload is the service.
// If the first argument is not Fluence Peer and it is an object, then it can only be the service def
// If the first argument is peer, we are checking further. The second argument might either be
// an object, that it must be the service object
// or a string, which is the service id. In that case the service is the third argument
if (!isFluencePeer(args[0]) && typeof args[0] === 'object') {
service = args[0];
} else if (typeof args[1] === 'object') {
service = args[1];
} else {
service = args[2];
}
return {
peer: peer,
serviceId: serviceId,
service: service,
peer,
serviceId,
};
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,16 +13,26 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClientConfig, ConnectionState, IFluenceClient, PeerIdB58, RelayOptions } from '@fluencelabs/interfaces';
import { RelayConnection, RelayConnectionConfig } from '../connection/RelayConnection.js';
import { fromOpts, KeyPair } from '../keypair/index.js';
import { FluencePeer, PeerConfig } from '../jsPeer/FluencePeer.js';
import { relayOptionToMultiaddr } from '../util/libp2pUtils.js';
import { IAvmRunner, IMarineHost } from '../marine/interfaces.js';
import { JsServiceHost } from '../jsServiceHost/JsServiceHost.js';
import { logger } from '../util/logger.js';
const log = logger('client');
import {
ClientConfig,
ConnectionState,
IFluenceClient,
RelayOptions,
} from "@fluencelabs/interfaces";
import {
RelayConnection,
RelayConnectionConfig,
} from "../connection/RelayConnection.js";
import { FluencePeer, PeerConfig } from "../jsPeer/FluencePeer.js";
import { JsServiceHost } from "../jsServiceHost/JsServiceHost.js";
import { fromOpts, KeyPair } from "../keypair/index.js";
import { IMarineHost } from "../marine/interfaces.js";
import { relayOptionToMultiaddr } from "../util/libp2pUtils.js";
import { logger } from "../util/logger.js";
const log = logger("client");
const DEFAULT_TTL_MS = 7000;
const MAX_OUTBOUND_STREAMS = 1024;
@ -31,24 +41,34 @@ const MAX_INBOUND_STREAMS = 1024;
export const makeClientPeerConfig = async (
relay: RelayOptions,
config: ClientConfig,
): Promise<{ peerConfig: PeerConfig; relayConfig: RelayConnectionConfig; keyPair: KeyPair }> => {
const opts = config?.keyPair || { type: 'Ed25519', source: 'random' };
): Promise<{
peerConfig: PeerConfig;
relayConfig: RelayConnectionConfig;
keyPair: KeyPair;
}> => {
const opts = config.keyPair ?? { type: "Ed25519", source: "random" };
const keyPair = await fromOpts(opts);
const relayAddress = relayOptionToMultiaddr(relay);
return {
peerConfig: {
debug: {
printParticleId: config?.debug?.printParticleId || false,
printParticleId: config.debug?.printParticleId ?? false,
},
defaultTtlMs: config?.defaultTtlMs || DEFAULT_TTL_MS,
defaultTtlMs: config.defaultTtlMs ?? DEFAULT_TTL_MS,
},
relayConfig: {
peerId: keyPair.getLibp2pPeerId(),
relayAddress: relayAddress,
dialTimeoutMs: config?.connectionOptions?.dialTimeoutMs,
maxInboundStreams: config?.connectionOptions?.maxInboundStreams || MAX_OUTBOUND_STREAMS,
maxOutboundStreams: config?.connectionOptions?.maxOutboundStreams || MAX_INBOUND_STREAMS,
...(config.connectionOptions?.dialTimeoutMs != null
? {
dialTimeout: config.connectionOptions.dialTimeoutMs,
}
: {}),
maxInboundStreams:
config.connectionOptions?.maxInboundStreams ?? MAX_OUTBOUND_STREAMS,
maxOutboundStreams:
config.connectionOptions?.maxOutboundStreams ?? MAX_INBOUND_STREAMS,
},
keyPair: keyPair,
};
@ -61,7 +81,13 @@ export class ClientPeer extends FluencePeer implements IFluenceClient {
keyPair: KeyPair,
marine: IMarineHost,
) {
super(peerConfig, keyPair, marine, new JsServiceHost(), new RelayConnection(relayConfig));
super(
peerConfig,
keyPair,
marine,
new JsServiceHost(),
new RelayConnection(relayConfig),
);
}
getPeerId(): string {
@ -72,14 +98,16 @@ export class ClientPeer extends FluencePeer implements IFluenceClient {
return this.keyPair.toEd25519PrivateKey();
}
connectionState: ConnectionState = 'disconnected';
connectionState: ConnectionState = "disconnected";
connectionStateChangeHandler: (state: ConnectionState) => void = () => {};
getRelayPeerId(): string {
return this.internals.getRelayPeerId();
}
onConnectionStateChange(handler: (state: ConnectionState) => void): ConnectionState {
onConnectionStateChange(
handler: (state: ConnectionState) => void,
): ConnectionState {
this.connectionStateChangeHandler = handler;
return this.connectionState;
@ -104,20 +132,20 @@ export class ClientPeer extends FluencePeer implements IFluenceClient {
return this.stop();
}
async start(): Promise<void> {
log.trace('connecting to Fluence network');
this.changeConnectionState('connecting');
override async start(): Promise<void> {
log.trace("connecting to Fluence network");
this.changeConnectionState("connecting");
await super.start();
// TODO: check connection (`checkConnection` function) here
this.changeConnectionState('connected');
log.trace('connected');
this.changeConnectionState("connected");
log.trace("connected");
}
async stop(): Promise<void> {
log.trace('disconnecting from Fluence network');
this.changeConnectionState('disconnecting');
override async stop(): Promise<void> {
log.trace("disconnecting from Fluence network");
this.changeConnectionState("disconnecting");
await super.stop();
this.changeConnectionState('disconnected');
log.trace('disconnected');
this.changeConnectionState("disconnected");
log.trace("disconnected");
}
}

View File

@ -1,13 +1,32 @@
import { it, describe, expect } from 'vitest';
import { handleTimeout } from '../../particle/Particle.js';
import { doNothing } from '../../jsServiceHost/serviceUtils.js';
import { registerHandlersHelper, withClient } from '../../util/testUtils.js';
import { checkConnection } from '../checkConnection.js';
import { nodes, RELAY } from './connection.js';
import { CallServiceData } from '../../jsServiceHost/interfaces.js';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
describe('FluenceClient usage test suite', () => {
it('should make a call through network', async () => {
import { JSONValue } from "@fluencelabs/interfaces";
import { it, describe, expect } from "vitest";
import { CallServiceData } from "../../jsServiceHost/interfaces.js";
import { doNothing } from "../../jsServiceHost/serviceUtils.js";
import { handleTimeout } from "../../particle/Particle.js";
import { registerHandlersHelper, withClient } from "../../util/testUtils.js";
import { checkConnection } from "../checkConnection.js";
import { nodes, RELAY } from "./connection.js";
describe("FluenceClient usage test suite", () => {
it("should make a call through network", async () => {
await withClient(RELAY, {}, async (peer) => {
// arrange
@ -28,9 +47,10 @@ describe('FluenceClient usage test suite', () => {
const particle = await peer.internals.createNewParticle(script);
const result = await new Promise<string>((resolve, reject) => {
const result = await new Promise<JSONValue>((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
@ -40,11 +60,11 @@ describe('FluenceClient usage test suite', () => {
},
},
callback: {
callback: (args: any) => {
callback: (args): undefined => {
const [val] = args;
resolve(val);
},
error: (args: any) => {
error: (args): undefined => {
const [error] = args;
reject(error);
},
@ -54,11 +74,11 @@ describe('FluenceClient usage test suite', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(result).toBe('hello world!');
expect(result).toBe("hello world!");
});
});
it('check connection should work', async function () {
it("check connection should work", async function () {
await withClient(RELAY, {}, async (peer) => {
const isConnected = await checkConnection(peer);
@ -66,7 +86,7 @@ describe('FluenceClient usage test suite', () => {
});
});
it('check connection should work with ttl', async function () {
it("check connection should work with ttl", async function () {
await withClient(RELAY, {}, async (peer) => {
const isConnected = await checkConnection(peer, 10000);
@ -74,17 +94,21 @@ describe('FluenceClient usage test suite', () => {
});
});
it('two clients should work inside the same time javascript process', async () => {
it("two clients should work inside the same time javascript process", async () => {
await withClient(RELAY, {}, async (peer1) => {
await withClient(RELAY, {}, async (peer2) => {
const res = new Promise((resolve) => {
peer2.internals.regHandler.common('test', 'test', (req: CallServiceData) => {
peer2.internals.regHandler.common(
"test",
"test",
(req: CallServiceData) => {
resolve(req.args[0]);
return {
result: {},
retCode: 0,
};
});
},
);
});
const script = `
@ -93,6 +117,7 @@ describe('FluenceClient usage test suite', () => {
(call "${peer2.getPeerId()}" ("test" "test") ["test"])
)
`;
const particle = await peer1.internals.createNewParticle(script);
if (particle instanceof Error) {
@ -101,13 +126,13 @@ describe('FluenceClient usage test suite', () => {
peer1.internals.initiateParticle(particle, doNothing);
expect(await res).toEqual('test');
expect(await res).toEqual("test");
});
});
});
describe('should make connection to network', () => {
it('address as string', async () => {
describe("should make connection to network", () => {
it("address as string", async () => {
await withClient(nodes[0].multiaddr, {}, async (peer) => {
const isConnected = await checkConnection(peer);
@ -115,7 +140,7 @@ describe('FluenceClient usage test suite', () => {
});
});
it('address as node', async () => {
it("address as node", async () => {
await withClient(nodes[0], {}, async (peer) => {
const isConnected = await checkConnection(peer);
@ -123,23 +148,31 @@ describe('FluenceClient usage test suite', () => {
});
});
it('With connection options: dialTimeout', async () => {
await withClient(RELAY, { connectionOptions: { dialTimeoutMs: 100000 } }, async (peer) => {
it("With connection options: dialTimeout", async () => {
await withClient(
RELAY,
{ connectionOptions: { dialTimeoutMs: 100000 } },
async (peer) => {
const isConnected = await checkConnection(peer);
expect(isConnected).toBeTruthy();
});
},
);
});
it('With connection options: skipCheckConnection', async () => {
await withClient(RELAY, { connectionOptions: { skipCheckConnection: true } }, async (peer) => {
it("With connection options: skipCheckConnection", async () => {
await withClient(
RELAY,
{ connectionOptions: { skipCheckConnection: true } },
async (peer) => {
const isConnected = await checkConnection(peer);
expect(isConnected).toBeTruthy();
});
},
);
});
it('With connection options: defaultTTL', async () => {
it("With connection options: defaultTTL", async () => {
await withClient(RELAY, { defaultTtlMs: 1 }, async (peer) => {
const isConnected = await checkConnection(peer);
@ -148,22 +181,25 @@ describe('FluenceClient usage test suite', () => {
});
});
it.skip('Should throw correct error when the client tries to send a particle not to the relay', async () => {
it.skip("Should throw correct error when the client tries to send a particle not to the relay", async () => {
await withClient(RELAY, {}, async (peer) => {
const script = `
(xor
(call "incorrect_peer_id" ("any" "service") [])
(call %init_peer_id% ("callback" "error") [%last_error%])
)`;
const particle = await peer.internals.createNewParticle(script);
const promise = new Promise((resolve, reject) => {
const promise = new Promise((_resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
callback: {
error: (args: any) => {
error: (args): undefined => {
const [error] = args;
reject(error);
},
@ -171,7 +207,7 @@ describe('FluenceClient usage test suite', () => {
});
peer.internals.initiateParticle(particle, (stage) => {
if (stage.stage === 'sendingError') {
if (stage.stage === "sendingError") {
reject(stage.errorMessage);
}
});
@ -180,7 +216,7 @@ describe('FluenceClient usage test suite', () => {
await promise;
await expect(promise).rejects.toMatch(
'Particle is expected to be sent to only the single peer (relay which client is connected to)',
"Particle is expected to be sent to only the single peer (relay which client is connected to)",
);
});
});

View File

@ -1,7 +1,24 @@
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export const nodes = [
{
multiaddr: '/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
peerId: '12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR',
multiaddr:
"/ip4/127.0.0.1/tcp/9991/ws/p2p/12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
peerId: "12D3KooWBM3SdXWqGaawQDGQ6JprtwswEg3FWGvGhmgmMez1vRbR",
},
];

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,19 +13,25 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClientPeer } from './ClientPeer.js';
import { logger } from '../util/logger.js';
import { WrapFnIntoServiceCall } from '../jsServiceHost/serviceUtils.js';
import { handleTimeout } from '../particle/Particle.js';
import { JSONValue } from "@fluencelabs/interfaces";
const log = logger('connection');
import { WrapFnIntoServiceCall } from "../jsServiceHost/serviceUtils.js";
import { handleTimeout } from "../particle/Particle.js";
import { logger } from "../util/logger.js";
import { ClientPeer } from "./ClientPeer.js";
const log = logger("connection");
/**
* Checks the network connection by sending a ping-like request to relay node
* @param { ClientPeer } peer - The Fluence Client instance.
*/
export const checkConnection = async (peer: ClientPeer, ttl?: number): Promise<boolean> => {
export const checkConnection = async (
peer: ClientPeer,
ttl?: number,
): Promise<boolean> => {
const msg = Math.random().toString(36).substring(7);
const script = `
@ -45,17 +51,19 @@ export const checkConnection = async (peer: ClientPeer, ttl?: number): Promise<b
(call %init_peer_id% ("callback" "error") [%last_error%])
)
)`;
const particle = await peer.internals.createNewParticle(script, ttl);
const promise = new Promise<string>((resolve, reject) => {
const promise = new Promise<JSONValue>((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
peer.internals.regHandler.forParticle(
particle.id,
'load',
'relay',
"load",
"relay",
WrapFnIntoServiceCall(() => {
return peer.getRelayPeerId();
}),
@ -63,8 +71,8 @@ export const checkConnection = async (peer: ClientPeer, ttl?: number): Promise<b
peer.internals.regHandler.forParticle(
particle.id,
'load',
'msg',
"load",
"msg",
WrapFnIntoServiceCall(() => {
return msg;
}),
@ -72,26 +80,30 @@ export const checkConnection = async (peer: ClientPeer, ttl?: number): Promise<b
peer.internals.regHandler.forParticle(
particle.id,
'callback',
'callback',
"callback",
"callback",
WrapFnIntoServiceCall((args) => {
const [val] = args;
setTimeout(() => {
resolve(val);
}, 0);
return {};
}),
);
peer.internals.regHandler.forParticle(
particle.id,
'callback',
'error',
"callback",
"error",
WrapFnIntoServiceCall((args) => {
const [error] = args;
setTimeout(() => {
reject(error);
}, 0);
return {};
}),
);
@ -99,19 +111,28 @@ export const checkConnection = async (peer: ClientPeer, ttl?: number): Promise<b
peer.internals.initiateParticle(
particle,
handleTimeout(() => {
reject('particle timed out');
reject("particle timed out");
}),
);
});
try {
const result = await promise;
if (result != msg) {
log.error("unexpected behavior. 'identity' must return the passed arguments.");
if (result !== msg) {
log.error(
"unexpected behavior. 'identity' must return the passed arguments.",
);
}
return true;
} catch (e) {
log.error('error on establishing connection. Relay: %s error: %j', peer.getRelayPeerId(), e);
log.error(
"error on establishing connection. Relay: %s error: %j",
peer.getRelayPeerId(),
e,
);
return false;
}
};

View File

@ -1,19 +1,37 @@
import { it, describe, expect, test } from 'vitest';
import { aqua2ts, ts2aqua } from '../conversions.js';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const i32 = { tag: 'scalar', name: 'i32' } as const;
import { JSONValue, NonArrowType } from "@fluencelabs/interfaces";
import { it, describe, expect, test } from "vitest";
import { aqua2ts, ts2aqua } from "../conversions.js";
const i32 = { tag: "scalar", name: "i32" } as const;
const opt_i32 = {
tag: 'option',
tag: "option",
type: i32,
} as const;
const array_i32 = { tag: 'array', type: i32 };
const array_i32 = { tag: "array", type: i32 };
const array_opt_i32 = { tag: 'array', type: opt_i32 };
const array_opt_i32 = { tag: "array", type: opt_i32 };
const labeledProduct = {
tag: 'labeledProduct',
tag: "labeledProduct",
fields: {
a: i32,
b: opt_i32,
@ -22,8 +40,8 @@ const labeledProduct = {
};
const struct = {
tag: 'struct',
name: 'someStruct',
tag: "struct",
name: "someStruct",
fields: {
a: i32,
b: opt_i32,
@ -61,7 +79,7 @@ const structs = [
];
const labeledProduct2 = {
tag: 'labeledProduct',
tag: "labeledProduct",
fields: {
x: i32,
y: i32,
@ -69,15 +87,15 @@ const labeledProduct2 = {
};
const nestedLabeledProductType = {
tag: 'labeledProduct',
tag: "labeledProduct",
fields: {
a: labeledProduct2,
b: {
tag: 'option',
tag: "option",
type: labeledProduct2,
},
c: {
tag: 'array',
tag: "array",
type: labeledProduct2,
},
},
@ -151,7 +169,13 @@ const nestedStructs = [
},
];
describe('Conversion from aqua to typescript', () => {
interface ConversionTestArgs {
aqua: JSONValue;
ts: JSONValue;
type: NonArrowType;
}
describe("Conversion from aqua to typescript", () => {
test.each`
aqua | ts | type
${1} | ${1} | ${i32}
@ -171,8 +195,8 @@ describe('Conversion from aqua to typescript', () => {
${nestedStructs[1].aqua} | ${nestedStructs[1].ts} | ${nestedLabeledProductType}
`(
//
'aqua: $aqua. ts: $ts. type: $type',
async ({ aqua, ts, type }) => {
"aqua: $aqua. ts: $ts. type: $type",
({ aqua, ts, type }: ConversionTestArgs) => {
// arrange
// act
@ -186,11 +210,11 @@ describe('Conversion from aqua to typescript', () => {
);
});
describe('Conversion corner cases', () => {
it('Should accept undefined in object entry', () => {
describe("Conversion corner cases", () => {
it("Should accept undefined in object entry", () => {
// arrange
const type = {
tag: 'labeledProduct',
tag: "labeledProduct",
fields: {
x: opt_i32,
y: opt_i32,
@ -200,6 +224,7 @@ describe('Conversion corner cases', () => {
const valueInTs = {
x: 1,
};
const valueInAqua = {
x: [1],
y: [],

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,7 +13,19 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CallAquaFunctionType, getArgumentTypes, isReturnTypeVoid } from '@fluencelabs/interfaces';
import assert from "assert";
import {
FnConfig,
FunctionCallDef,
getArgumentTypes,
isReturnTypeVoid,
PassedArgs,
} from "@fluencelabs/interfaces";
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import { logger } from "../util/logger.js";
import {
errorHandlingService,
@ -23,12 +35,9 @@ import {
responseService,
ServiceDescription,
userHandlerService,
} from './services.js';
} from "./services.js";
import { logger } from '../util/logger.js';
import { IParticle } from '../particle/interfaces.js';
const log = logger('aqua');
const log = logger("aqua");
/**
* Convenience function which does all the internal work of creating particles
@ -41,25 +50,55 @@ const log = logger('aqua');
* @param args - args in the form of JSON where each key corresponds to the name of the argument
* @returns
*/
export const callAquaFunction: CallAquaFunctionType = async ({ def, script, config, peer, args }) => {
log.trace('calling aqua function %j', { def, script, config, args });
type CallAquaFunctionArgs = {
def: FunctionCallDef;
script: string;
config: FnConfig;
peer: FluencePeer;
args: PassedArgs;
};
export const callAquaFunction = async ({
def,
script,
config,
peer,
args,
}: CallAquaFunctionArgs) => {
// TODO: this function should be rewritten. We can remove asserts if we wont check definition there
log.trace("calling aqua function %j", { def, script, config, args });
const argumentTypes = getArgumentTypes(def);
const particle = await peer.internals.createNewParticle(script, config?.ttl);
const particle = await peer.internals.createNewParticle(script, config.ttl);
return new Promise((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
}
for (let [name, argVal] of Object.entries(args)) {
for (const [name, argVal] of Object.entries(args)) {
const type = argumentTypes[name];
let service: ServiceDescription;
if (type.tag === 'arrow') {
service = userHandlerService(def.names.callbackSrv, [name, type], argVal);
if (type.tag === "arrow") {
// TODO: Add validation here
assert(
typeof argVal === "function",
"Should not be possible, bad types",
);
service = userHandlerService(
def.names.callbackSrv,
[name, type],
argVal,
);
} else {
// TODO: Add validation here
assert(
typeof argVal !== "function",
"Should not be possible, bad types",
);
service = injectValueService(def.names.getDataSrv, name, type, argVal);
}
registerParticleScopeService(peer, particle, service);
}
@ -67,31 +106,40 @@ export const callAquaFunction: CallAquaFunctionType = async ({ def, script, conf
registerParticleScopeService(peer, particle, injectRelayService(def, peer));
registerParticleScopeService(peer, particle, errorHandlingService(def, reject));
registerParticleScopeService(
peer,
particle,
errorHandlingService(def, reject),
);
peer.internals.initiateParticle(particle, (stage: any) => {
peer.internals.initiateParticle(particle, (stage) => {
// If function is void, then it's completed when one of the two conditions is met:
// 1. The particle is sent to the network (state 'sent')
// 2. All CallRequests are executed, e.g., all variable loading and local function calls are completed (state 'localWorkDone')
if (isReturnTypeVoid(def) && (stage.stage === 'sent' || stage.stage === 'localWorkDone')) {
if (
isReturnTypeVoid(def) &&
(stage.stage === "sent" || stage.stage === "localWorkDone")
) {
resolve(undefined);
}
if (stage.stage === 'sendingError') {
reject(`Could not send particle for ${def.functionName}: not connected (particle id: ${particle.id})`);
if (stage.stage === "sendingError") {
reject(
`Could not send particle for ${def.functionName}: not connected (particle id: ${particle.id})`,
);
}
if (stage.stage === 'expired') {
if (stage.stage === "expired") {
reject(
`Particle expired after ttl of ${particle.ttl}ms for function ${def.functionName} (particle id: ${particle.id})`,
);
}
if (stage.stage === 'interpreterError') {
if (stage.stage === "interpreterError") {
reject(
`Script interpretation failed for ${def.functionName}: ${stage.errorMessage} (particle id: ${particle.id})`,
);
}
});
})
});
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,10 +13,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { jsonify } from '../util/utils.js';
import { match } from 'ts-pattern';
import type { ArrowType, ArrowWithoutCallbacks, NonArrowType } from '@fluencelabs/interfaces';
import { CallServiceData } from '../jsServiceHost/interfaces.js';
// TODO: This file is a mess. Need to refactor it later
/* eslint-disable */
// @ts-nocheck
import assert from "assert";
import type {
ArrowType,
ArrowWithoutCallbacks,
JSONArray,
JSONValue,
NonArrowType,
} from "@fluencelabs/interfaces";
import { match } from "ts-pattern";
import { CallServiceData } from "../jsServiceHost/interfaces.js";
import { jsonify } from "../util/utils.js";
/**
* Convert value from its representation in aqua language to representation in typescript
@ -24,38 +38,42 @@ import { CallServiceData } from '../jsServiceHost/interfaces.js';
* @param type - definition of the aqua type
* @returns value represented in typescript
*/
export const aqua2ts = (value: any, type: NonArrowType): any => {
export const aqua2ts = (value: JSONValue, type: NonArrowType): JSONValue => {
const res = match(type)
.with({ tag: 'nil' }, () => {
.with({ tag: "nil" }, () => {
return null;
})
.with({ tag: 'option' }, (opt) => {
.with({ tag: "option" }, (opt) => {
assert(Array.isArray(value), "Should not be possible, bad types");
if (value.length === 0) {
return null;
} else {
return aqua2ts(value[0], opt.type);
}
})
// @ts-ignore
.with({ tag: 'scalar' }, { tag: 'bottomType' }, { tag: 'topType' }, () => {
.with({ tag: "scalar" }, { tag: "bottomType" }, { tag: "topType" }, () => {
return value;
})
.with({ tag: 'array' }, (arr) => {
return value.map((y: any) => aqua2ts(y, arr.type));
.with({ tag: "array" }, (arr) => {
assert(Array.isArray(value), "Should not be possible, bad types");
return value.map((y) => {
return aqua2ts(y, arr.type);
});
})
.with({ tag: 'struct' }, (x) => {
.with({ tag: "struct" }, (x) => {
return Object.entries(x.fields).reduce((agg, [key, type]) => {
const val = aqua2ts(value[key], type);
return { ...agg, [key]: val };
}, {});
})
.with({ tag: 'labeledProduct' }, (x) => {
.with({ tag: "labeledProduct" }, (x) => {
return Object.entries(x.fields).reduce((agg, [key, type]) => {
const val = aqua2ts(value[key], type);
return { ...agg, [key]: val };
}, {});
})
.with({ tag: 'unlabeledProduct' }, (x) => {
.with({ tag: "unlabeledProduct" }, (x) => {
return x.items.map((type, index) => {
return aqua2ts(value[index], type);
});
@ -63,8 +81,9 @@ export const aqua2ts = (value: any, type: NonArrowType): any => {
// uncomment to check that every pattern in matched
// .exhaustive();
.otherwise(() => {
throw new Error('Unexpected tag: ' + jsonify(type));
throw new Error("Unexpected tag: " + jsonify(type));
});
return res;
};
@ -74,25 +93,30 @@ export const aqua2ts = (value: any, type: NonArrowType): any => {
* @param arrow - aqua type definition
* @returns arguments in typescript representation
*/
export const aquaArgs2Ts = (req: CallServiceData, arrow: ArrowWithoutCallbacks) => {
export const aquaArgs2Ts = (
req: CallServiceData,
arrow: ArrowWithoutCallbacks,
): JSONArray => {
const argTypes = match(arrow.domain)
.with({ tag: 'labeledProduct' }, (x) => {
.with({ tag: "labeledProduct" }, (x) => {
return Object.values(x.fields);
})
.with({ tag: 'unlabeledProduct' }, (x) => {
.with({ tag: "unlabeledProduct" }, (x) => {
return x.items;
})
.with({ tag: 'nil' }, (x) => {
.with({ tag: "nil" }, (x) => {
return [];
})
// uncomment to check that every pattern in matched
// .exhaustive()
.otherwise(() => {
throw new Error('Unexpected tag: ' + jsonify(arrow.domain));
throw new Error("Unexpected tag: " + jsonify(arrow.domain));
});
if (req.args.length !== argTypes.length) {
throw new Error(`incorrect number of arguments, expected: ${argTypes.length}, got: ${req.args.length}`);
throw new Error(
`incorrect number of arguments, expected: ${argTypes.length}, got: ${req.args.length}`,
);
}
return req.args.map((arg, index) => {
@ -106,38 +130,40 @@ export const aquaArgs2Ts = (req: CallServiceData, arrow: ArrowWithoutCallbacks)
* @param type - definition of the aqua type
* @returns value represented in aqua
*/
export const ts2aqua = (value: any, type: NonArrowType): any => {
export const ts2aqua = (value: JSONValue, type: NonArrowType): JSONValue => {
const res = match(type)
.with({ tag: 'nil' }, () => {
.with({ tag: "nil" }, () => {
return null;
})
.with({ tag: 'option' }, (opt) => {
.with({ tag: "option" }, (opt) => {
if (value === null || value === undefined) {
return [];
} else {
return [ts2aqua(value, opt.type)];
}
})
// @ts-ignore
.with({ tag: 'scalar' }, { tag: 'bottomType' }, { tag: 'topType' }, () => {
.with({ tag: "scalar" }, { tag: "bottomType" }, { tag: "topType" }, () => {
return value;
})
.with({ tag: 'array' }, (arr) => {
return value.map((y: any) => ts2aqua(y, arr.type));
.with({ tag: "array" }, (arr) => {
assert(Array.isArray(value), "Should not be possible, bad types");
return value.map((y) => {
return ts2aqua(y, arr.type);
});
})
.with({ tag: 'struct' }, (x) => {
.with({ tag: "struct" }, (x) => {
return Object.entries(x.fields).reduce((agg, [key, type]) => {
const val = ts2aqua(value[key], type);
return { ...agg, [key]: val };
}, {});
})
.with({ tag: 'labeledProduct' }, (x) => {
.with({ tag: "labeledProduct" }, (x) => {
return Object.entries(x.fields).reduce((agg, [key, type]) => {
const val = ts2aqua(value[key], type);
return { ...agg, [key]: val };
}, {});
})
.with({ tag: 'unlabeledProduct' }, (x) => {
.with({ tag: "unlabeledProduct" }, (x) => {
return x.items.map((type, index) => {
return ts2aqua(value[index], type);
});
@ -145,7 +171,7 @@ export const ts2aqua = (value: any, type: NonArrowType): any => {
// uncomment to check that every pattern in matched
// .exhaustive()
.otherwise(() => {
throw new Error('Unexpected tag: ' + jsonify(type));
throw new Error("Unexpected tag: " + jsonify(type));
});
return res;
@ -157,8 +183,11 @@ export const ts2aqua = (value: any, type: NonArrowType): any => {
* @param arrowType - the arrow type which describes the service
* @returns - value represented in aqua
*/
export const returnType2Aqua = (returnValue: any, arrowType: ArrowType<NonArrowType>) => {
if (arrowType.codomain.tag === 'nil') {
export const returnType2Aqua = (
returnValue: any,
arrowType: ArrowType<NonArrowType>,
) => {
if (arrowType.codomain.tag === "nil") {
return {};
}
@ -181,21 +210,26 @@ export const returnType2Aqua = (returnValue: any, arrowType: ArrowType<NonArrowT
* @param arrow - aqua type definition
* @returns response value in typescript representation
*/
export const responseServiceValue2ts = (req: CallServiceData, arrow: ArrowType<any>) => {
export const responseServiceValue2ts = (
req: CallServiceData,
arrow: ArrowType<any>,
) => {
return match(arrow.codomain)
.with({ tag: 'nil' }, () => {
return undefined;
.with({ tag: "nil" }, () => {
return null;
})
.with({ tag: 'unlabeledProduct' }, (x) => {
.with({ tag: "unlabeledProduct" }, (x) => {
if (x.items.length === 0) {
return undefined;
return null;
}
if (x.items.length === 1) {
return aqua2ts(req.args[0], x.items[0]);
}
return req.args.map((y, index) => aqua2ts(y, x.items[index]));
return req.args.map((y, index) => {
return aqua2ts(y, x.items[index]);
});
})
.exhaustive();
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,43 +13,72 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { RegisterServiceType } from '@fluencelabs/interfaces';
import { registerGlobalService, userHandlerService } from './services.js';
import { logger } from '../util/logger.js';
import type { ServiceDef, ServiceImpl } from "@fluencelabs/interfaces";
const log = logger('aqua');
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import { logger } from "../util/logger.js";
export const registerService: RegisterServiceType = ({ peer, def, serviceId, service }) => {
log.trace('registering aqua service %o', { def, serviceId, service });
import { registerGlobalService, userHandlerService } from "./services.js";
const log = logger("aqua");
interface RegisterServiceArgs {
peer: FluencePeer;
def: ServiceDef;
serviceId: string | undefined;
service: ServiceImpl;
}
export const registerService = ({
peer,
def,
serviceId = def.defaultServiceId,
service,
}: RegisterServiceArgs) => {
// TODO: Need to refactor this. We can compute function types from service implementation, making func more type safe
log.trace("registering aqua service %o", { def, serviceId, service });
// Checking for missing keys
const requiredKeys = def.functions.tag === 'nil' ? [] : Object.keys(def.functions.fields);
const incorrectServiceDefinitions = requiredKeys.filter((f) => !(f in service));
if (!!incorrectServiceDefinitions.length) {
const requiredKeys =
def.functions.tag === "nil" ? [] : Object.keys(def.functions.fields);
const incorrectServiceDefinitions = requiredKeys.filter((f) => {
return !(f in service);
});
if (serviceId == null) {
throw new Error("Service ID must be specified");
}
if (incorrectServiceDefinitions.length > 0) {
throw new Error(
`Error registering service ${serviceId}: missing functions: ` +
incorrectServiceDefinitions.map((d) => "'" + d + "'").join(', '),
incorrectServiceDefinitions
.map((d) => {
return "'" + d + "'";
})
.join(", "),
);
}
if (!serviceId) {
serviceId = def.defaultServiceId;
}
const singleFunctions =
def.functions.tag === "nil" ? [] : Object.entries(def.functions.fields);
if (!serviceId) {
throw new Error('Service ID must be specified');
}
const singleFunctions = def.functions.tag === 'nil' ? [] : Object.entries(def.functions.fields);
for (let singleFunction of singleFunctions) {
let [name, type] = singleFunction;
for (const singleFunction of singleFunctions) {
const [name] = singleFunction;
// The function has type of (arg1, arg2, arg3, ... , callParams) => CallServiceResultType | void
// Account for the fact that user service might be defined as a class - .bind(...)
const userDefinedHandler = service[name].bind(service);
const serviceDescription = userHandlerService(serviceId, singleFunction, userDefinedHandler);
const serviceDescription = userHandlerService(
serviceId,
singleFunction,
userDefinedHandler,
);
registerGlobalService(peer, serviceDescription);
}
log.trace('aqua service registered %s', serviceId);
log.trace("aqua service registered %s", serviceId);
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,22 +13,33 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { SecurityTetraplet } from '@fluencelabs/avm';
import { match } from 'ts-pattern';
import { Particle } from '../particle/Particle.js';
import { aquaArgs2Ts, responseServiceValue2ts, returnType2Aqua, ts2aqua } from './conversions.js';
import { SecurityTetraplet } from "@fluencelabs/avm";
import {
CallParams,
ArrowWithoutCallbacks,
FunctionCallConstants,
FunctionCallDef,
NonArrowType,
IFluenceInternalApi,
} from '@fluencelabs/interfaces';
import { CallServiceData, GenericCallServiceHandler, ResultCodes } from '../jsServiceHost/interfaces.js';
import { fromUint8Array } from 'js-base64';
ServiceImpl,
JSONValue,
} from "@fluencelabs/interfaces";
import { fromUint8Array } from "js-base64";
import { match } from "ts-pattern";
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import {
CallServiceData,
GenericCallServiceHandler,
ResultCodes,
} from "../jsServiceHost/interfaces.js";
import { Particle } from "../particle/Particle.js";
import {
aquaArgs2Ts,
responseServiceValue2ts,
returnType2Aqua,
ts2aqua,
} from "./conversions.js";
export interface ServiceDescription {
serviceId: string;
@ -39,7 +50,7 @@ export interface ServiceDescription {
/**
* Creates a service which injects relay's peer id into aqua space
*/
export const injectRelayService = (def: FunctionCallDef, peer: IFluenceInternalApi) => {
export const injectRelayService = (def: FunctionCallDef, peer: FluencePeer) => {
return {
serviceId: def.names.getDataSrv,
fnName: def.names.relay,
@ -55,7 +66,12 @@ export const injectRelayService = (def: FunctionCallDef, peer: IFluenceInternalA
/**
* Creates a service which injects plain value into aqua space
*/
export const injectValueService = (serviceId: string, fnName: string, valueType: NonArrowType, value: any) => {
export const injectValueService = (
serviceId: string,
fnName: string,
valueType: NonArrowType,
value: JSONValue,
) => {
return {
serviceId: serviceId,
fnName: fnName,
@ -71,7 +87,10 @@ export const injectValueService = (serviceId: string, fnName: string, valueType:
/**
* Creates a service which is used to return value from aqua function into typescript space
*/
export const responseService = (def: FunctionCallDef, resolveCallback: Function) => {
export const responseService = (
def: FunctionCallDef,
resolveCallback: (val: JSONValue) => void,
) => {
return {
serviceId: def.names.responseSrv,
fnName: def.names.responseFnName,
@ -93,15 +112,20 @@ export const responseService = (def: FunctionCallDef, resolveCallback: Function)
/**
* Creates a service which is used to return errors from aqua function into typescript space
*/
export const errorHandlingService = (def: FunctionCallDef, rejectCallback: Function) => {
export const errorHandlingService = (
def: FunctionCallDef,
rejectCallback: (err: JSONValue) => void,
) => {
return {
serviceId: def.names.errorHandlingSrv,
fnName: def.names.errorFnName,
handler: (req: CallServiceData) => {
const [err, _] = req.args;
const [err] = req.args;
setTimeout(() => {
rejectCallback(err);
}, 0);
return {
retCode: ResultCodes.success,
result: {},
@ -116,15 +140,19 @@ export const errorHandlingService = (def: FunctionCallDef, rejectCallback: Funct
export const userHandlerService = (
serviceId: string,
arrowType: [string, ArrowWithoutCallbacks],
userHandler: (...args: Array<unknown>) => Promise<unknown>,
userHandler: ServiceImpl[string],
) => {
const [fnName, type] = arrowType;
return {
serviceId,
fnName,
handler: async (req: CallServiceData) => {
const args = [...aquaArgs2Ts(req, type), extractCallParams(req, type)];
const rawResult = await userHandler.apply(null, args);
const args: [...JSONValue[], CallParams<string>] = [
...aquaArgs2Ts(req, type),
extractCallParams(req, type),
];
const rawResult = await userHandler.bind(null)(...args);
const result = returnType2Aqua(rawResult, type);
return {
@ -135,44 +163,34 @@ export const userHandlerService = (
};
};
/**
* Converts argument of aqua function to a corresponding service.
* For arguments of non-arrow types the resulting service injects the argument into aqua space.
* For arguments of arrow types the resulting service calls the corresponding function.
*/
export const argToServiceDef = (
arg: any,
argName: string,
argType: NonArrowType | ArrowWithoutCallbacks,
names: FunctionCallConstants,
): ServiceDescription => {
if (argType.tag === 'arrow') {
return userHandlerService(names.callbackSrv, [argName, argType], arg);
} else {
return injectValueService(names.getDataSrv, argName, arg, argType);
}
};
/**
* Extracts call params from from call service data according to aqua type definition
*/
const extractCallParams = (req: CallServiceData, arrow: ArrowWithoutCallbacks): CallParams<any> => {
const names = match(arrow.domain)
.with({ tag: 'nil' }, () => {
return [] as string[];
const extractCallParams = (
req: CallServiceData,
arrow: ArrowWithoutCallbacks,
): CallParams<string> => {
const names: (string | undefined)[] = match(arrow.domain)
.with({ tag: "nil" }, () => {
return [];
})
.with({ tag: 'labeledProduct' }, (x) => {
.with({ tag: "unlabeledProduct" }, (x) => {
return x.items.map((_, index) => {
return "arg" + index;
});
})
.with({ tag: "labeledProduct" }, (x) => {
return Object.keys(x.fields);
})
.with({ tag: 'unlabeledProduct' }, (x) => {
return x.items.map((_, index) => 'arg' + index);
})
.exhaustive();
const tetraplets: Record<string, SecurityTetraplet[]> = {};
for (let i = 0; i < req.args.length; i++) {
if (names[i]) {
tetraplets[names[i]] = req.tetraplets[i];
const name = names[i];
if (name != null) {
tetraplets[name] = req.tetraplets[i];
}
}
@ -186,13 +204,25 @@ const extractCallParams = (req: CallServiceData, arrow: ArrowWithoutCallbacks):
};
export const registerParticleScopeService = (
peer: IFluenceInternalApi,
peer: FluencePeer,
particle: Particle,
service: ServiceDescription,
) => {
peer.internals.regHandler.forParticle(particle.id, service.serviceId, service.fnName, service.handler);
peer.internals.regHandler.forParticle(
particle.id,
service.serviceId,
service.fnName,
service.handler,
);
};
export const registerGlobalService = (peer: IFluenceInternalApi, service: ServiceDescription) => {
peer.internals.regHandler.common(service.serviceId, service.fnName, service.handler);
export const registerGlobalService = (
peer: FluencePeer,
service: ServiceDescription,
) => {
peer.internals.regHandler.common(
service.serviceId,
service.fnName,
service.handler,
);
};

View File

@ -1,5 +1,5 @@
/*
* Copyright 2020 Fluence Labs Limited
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -13,38 +13,41 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { PeerIdB58 } from '@fluencelabs/interfaces';
import { pipe } from 'it-pipe';
import { decode, encode } from 'it-length-prefixed';
import type { PeerId } from '@libp2p/interface/peer-id';
import { createLibp2p, Libp2p } from 'libp2p';
import { noise } from '@chainsafe/libp2p-noise';
import { yamux } from '@chainsafe/libp2p-yamux';
import { webSockets } from '@libp2p/websockets';
import { all } from '@libp2p/websockets/filters';
import { multiaddr, type Multiaddr } from '@multiformats/multiaddr';
import { noise } from "@chainsafe/libp2p-noise";
import { yamux } from "@chainsafe/libp2p-yamux";
import { PeerIdB58 } from "@fluencelabs/interfaces";
import { Stream } from "@libp2p/interface/connection";
import type { PeerId } from "@libp2p/interface/peer-id";
import { peerIdFromString } from "@libp2p/peer-id";
import { webSockets } from "@libp2p/websockets";
import { all } from "@libp2p/websockets/filters";
import { multiaddr, type Multiaddr } from "@multiformats/multiaddr";
import { decode, encode } from "it-length-prefixed";
import map from "it-map";
import { pipe } from "it-pipe";
import { createLibp2p, Libp2p } from "libp2p";
import { identifyService } from "libp2p/identify";
import { pingService } from "libp2p/ping";
import { Subject } from "rxjs";
import { fromString } from "uint8arrays/from-string";
import { toString } from "uint8arrays/to-string";
import map from 'it-map';
import { fromString } from 'uint8arrays/from-string';
import { toString } from 'uint8arrays/to-string';
import { KeyPair } from "../keypair/index.js";
import { IParticle } from "../particle/interfaces.js";
import {
buildParticleMessage,
Particle,
serializeToString,
} from "../particle/Particle.js";
import { throwHasNoPeerId } from "../util/libp2pUtils.js";
import { logger } from "../util/logger.js";
import { logger } from '../util/logger.js';
import { Subject } from 'rxjs';
import { throwIfHasNoPeerId } from '../util/libp2pUtils.js';
import { IConnection } from './interfaces.js';
import { IParticle } from '../particle/interfaces.js';
import { buildParticleMessage, Particle, serializeToString, verifySignature } from '../particle/Particle.js';
import { identifyService } from 'libp2p/identify';
import { pingService } from 'libp2p/ping';
import { unmarshalPublicKey } from '@libp2p/crypto/keys';
import { peerIdFromString } from '@libp2p/peer-id';
import { Stream } from '@libp2p/interface/connection';
import { KeyPair } from '../keypair/index.js';
import { IConnection } from "./interfaces.js";
const log = logger('connection');
const log = logger("connection");
export const PROTOCOL_NAME = '/fluence/particle/2.0.0';
export const PROTOCOL_NAME = "/fluence/particle/2.0.0";
/**
* Options to configure fluence relay connection
@ -84,15 +87,21 @@ export interface RelayConnectionConfig {
export class RelayConnection implements IConnection {
private relayAddress: Multiaddr;
private lib2p2Peer: Libp2p | null = null;
private relayPeerId: string;
constructor(private config: RelayConnectionConfig) {
this.relayAddress = multiaddr(this.config.relayAddress);
throwIfHasNoPeerId(this.relayAddress);
const peerId = this.relayAddress.getPeerId();
if (peerId == null) {
throwHasNoPeerId(this.relayAddress);
}
this.relayPeerId = peerId;
}
getRelayPeerId(): string {
// since we check for peer id in constructor, we can safely use ! here
return this.relayAddress.getPeerId()!;
return this.relayPeerId;
}
supportsRelay(): boolean {
@ -117,11 +126,17 @@ export class RelayConnection implements IConnection {
streamMuxers: [yamux()],
connectionEncryption: [noise()],
connectionManager: {
...(this.config.dialTimeoutMs != null
? {
dialTimeout: this.config.dialTimeoutMs,
}
: {}),
},
connectionGater: {
// By default, this function forbids connections to private peers. For example multiaddr with ip 127.0.0.1 isn't allowed
denyDialMultiaddr: () => Promise.resolve(false),
denyDialMultiaddr: () => {
return Promise.resolve(false);
},
},
services: {
identify: identifyService(),
@ -129,7 +144,10 @@ export class RelayConnection implements IConnection {
},
});
const supportedProtocols = (await this.lib2p2Peer.peerStore.get(this.lib2p2Peer.peerId)).protocols;
const supportedProtocols = (
await this.lib2p2Peer.peerStore.get(this.lib2p2Peer.peerId)
).protocols;
await this.lib2p2Peer.peerStore.patch(this.lib2p2Peer.peerId, {
protocols: [...supportedProtocols, PROTOCOL_NAME],
});
@ -147,9 +165,12 @@ export class RelayConnection implements IConnection {
await this.lib2p2Peer.stop();
}
async sendParticle(nextPeerIds: PeerIdB58[], particle: IParticle): Promise<void> {
async sendParticle(
nextPeerIds: PeerIdB58[],
particle: IParticle,
): Promise<void> {
if (this.lib2p2Peer === null) {
throw new Error('Relay connection is not started');
throw new Error("Relay connection is not started");
}
if (nextPeerIds.length !== 1 && nextPeerIds[0] !== this.getRelayPeerId()) {
@ -160,29 +181,44 @@ export class RelayConnection implements IConnection {
);
}
log.trace('sending particle...');
log.trace("sending particle...");
// Reusing active connection here
const stream = await this.lib2p2Peer.dialProtocol(this.relayAddress, PROTOCOL_NAME);
log.trace('created stream with id ', stream.id);
const stream = await this.lib2p2Peer.dialProtocol(
this.relayAddress,
PROTOCOL_NAME,
);
log.trace("created stream with id ", stream.id);
const sink = stream.sink;
await pipe([fromString(serializeToString(particle))], encode(), sink);
log.trace('data written to sink');
log.trace("data written to sink");
}
// Await will appear after uncommenting lines in func body
// eslint-disable-next-line @typescript-eslint/require-await
private async processIncomingMessage(msg: string, stream: Stream) {
let particle: Particle | undefined;
try {
particle = Particle.fromString(msg);
log.trace('got particle from stream with id %s and particle id %s', stream.id, particle.id);
log.trace(
"got particle from stream with id %s and particle id %s",
stream.id,
particle.id,
);
const initPeerId = peerIdFromString(particle.initPeerId);
if (initPeerId.publicKey === undefined) {
log.error(
'cannot retrieve public key from init_peer_id. particle id: %s. init_peer_id: %s',
"cannot retrieve public key from init_peer_id. particle id: %s. init_peer_id: %s",
particle.id,
particle.initPeerId,
);
return;
}
@ -191,57 +227,67 @@ export class RelayConnection implements IConnection {
buildParticleMessage(particle),
particle.signature,
);
if (isVerified) {
this.particleSource.next(particle);
} else {
log.trace('particle signature is incorrect. rejecting particle with id: %s', particle.id);
log.trace(
"particle signature is incorrect. rejecting particle with id: %s",
particle.id,
);
}
} catch (e) {
const particleId = particle?.id;
const particleIdMessage = typeof particleId === 'string' ? `. particle id: ${particleId}` : '';
log.error(`error on handling an incoming message: %O%s`, e, particleIdMessage);
const particleIdMessage =
typeof particleId === "string" ? `. particle id: ${particleId}` : "";
log.error(
`error on handling an incoming message: %O%s`,
e,
particleIdMessage,
);
}
}
private async connect() {
if (this.lib2p2Peer === null) {
throw new Error('Relay connection is not started');
throw new Error("Relay connection is not started");
}
await this.lib2p2Peer.handle(
[PROTOCOL_NAME],
async ({ connection, stream }) =>
pipe(
({ stream }) => {
void pipe(
stream.source,
decode(),
(source) => map(source, (buf) => toString(buf.subarray())),
(source) => {
return map(source, (buf) => {
return toString(buf.subarray());
});
},
async (source) => {
try {
for await (const msg of source) {
await this.processIncomingMessage(msg, stream);
}
} catch (e) {
log.error('connection closed: %j', e);
log.error("connection closed: %j", e);
}
},
),
);
},
{
maxInboundStreams: this.config.maxInboundStreams,
maxOutboundStreams: this.config.maxOutboundStreams,
},
);
log.debug("dialing to the node with client's address: %s", this.lib2p2Peer.peerId.toString());
log.debug(
"dialing to the node with client's address: %s",
this.lib2p2Peer.peerId.toString(),
);
try {
await this.lib2p2Peer.dial(this.relayAddress);
} catch (e: any) {
if (e.name === 'AggregateError' && e._errors?.length === 1) {
const error = e._errors[0];
throw new Error(`Error dialing node ${this.relayAddress}:\n${error.code}\n${error.message}`);
} else {
throw e;
}
}
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,10 +13,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { PeerIdB58 } from '@fluencelabs/interfaces';
import type { Subscribable } from 'rxjs';
import { IParticle } from '../particle/interfaces.js';
import { IStartable } from '../util/commonTypes.js';
import type { PeerIdB58 } from "@fluencelabs/interfaces";
import type { Subscribable } from "rxjs";
import { IParticle } from "../particle/interfaces.js";
import { IStartable } from "../util/commonTypes.js";
/**
* Interface for connection used in Fluence Peer.

View File

@ -1,17 +1,33 @@
import { it, describe, expect, beforeEach, afterEach } from 'vitest';
import { DEFAULT_CONFIG, FluencePeer } from '../../jsPeer/FluencePeer.js';
import { CallServiceData, ResultCodes } from '../../jsServiceHost/interfaces.js';
import { KeyPair } from '../../keypair/index.js';
import { EphemeralNetworkClient } from '../client.js';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { EphemeralNetwork, defaultConfig } from '../network.js';
import { it, describe, expect, beforeEach, afterEach } from "vitest";
import { DEFAULT_CONFIG, FluencePeer } from "../../jsPeer/FluencePeer.js";
import { ResultCodes } from "../../jsServiceHost/interfaces.js";
import { KeyPair } from "../../keypair/index.js";
import { EphemeralNetworkClient } from "../client.js";
import { EphemeralNetwork, defaultConfig } from "../network.js";
let en: EphemeralNetwork;
let client: FluencePeer;
const relay = defaultConfig.peers[0].peerId;
// TODO: race condition here. Needs to be fixed
describe.skip('Ephemeral networks tests', () => {
describe.skip("Ephemeral networks tests", () => {
beforeEach(async () => {
en = new EphemeralNetwork(defaultConfig);
await en.up();
@ -22,17 +38,15 @@ describe.skip('Ephemeral networks tests', () => {
});
afterEach(async () => {
if (client) {
await client.stop();
}
if (en) {
await en.down();
}
});
it('smoke test', async function () {
it("smoke test", async function () {
// arrange
const peers = defaultConfig.peers.map((x) => x.peerId);
const peers = defaultConfig.peers.map((x) => {
return x.peerId;
});
const script = `
(seq
@ -62,19 +76,24 @@ describe.skip('Ephemeral networks tests', () => {
const particle = await client.internals.createNewParticle(script);
const promise = new Promise<string>((resolve) => {
client.internals.regHandler.forParticle(particle.id, 'test', 'test', (req: CallServiceData) => {
resolve('success');
client.internals.regHandler.forParticle(
particle.id,
"test",
"test",
() => {
resolve("success");
return {
result: 'test',
result: "test",
retCode: ResultCodes.success,
};
});
},
);
});
// act
client.internals.initiateParticle(particle, () => {});
// assert
await expect(promise).resolves.toBe('success');
await expect(promise).resolves.toBe("success");
});
});

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,24 +13,46 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { PeerIdB58 } from '@fluencelabs/interfaces';
import { FluencePeer, PeerConfig } from '../jsPeer/FluencePeer.js';
import { KeyPair } from '../keypair/index.js';
import { WasmLoaderFromNpm } from '../marine/deps-loader/node.js';
import { WorkerLoader } from '../marine/worker-script/workerLoader.js';
import { MarineBackgroundRunner } from '../marine/worker/index.js';
import { EphemeralNetwork } from './network.js';
import { JsServiceHost } from '../jsServiceHost/JsServiceHost.js';
import { PeerIdB58 } from "@fluencelabs/interfaces";
import { FluencePeer, PeerConfig } from "../jsPeer/FluencePeer.js";
import { JsServiceHost } from "../jsServiceHost/JsServiceHost.js";
import { KeyPair } from "../keypair/index.js";
import { WasmLoaderFromNpm } from "../marine/deps-loader/node.js";
import { MarineBackgroundRunner } from "../marine/worker/index.js";
import { WorkerLoader } from "../marine/worker-script/workerLoader.js";
import { EphemeralNetwork } from "./network.js";
/**
* Ephemeral network client is a FluencePeer that connects to a relay peer in an ephemeral network.
*/
export class EphemeralNetworkClient extends FluencePeer {
constructor(config: PeerConfig, keyPair: KeyPair, network: EphemeralNetwork, relay: PeerIdB58) {
constructor(
config: PeerConfig,
keyPair: KeyPair,
network: EphemeralNetwork,
relay: PeerIdB58,
) {
const workerLoader = new WorkerLoader();
const controlModuleLoader = new WasmLoaderFromNpm('@fluencelabs/marine-js', 'marine-js.wasm');
const avmModuleLoader = new WasmLoaderFromNpm('@fluencelabs/avm', 'avm.wasm');
const marine = new MarineBackgroundRunner(workerLoader, controlModuleLoader, avmModuleLoader);
const controlModuleLoader = new WasmLoaderFromNpm(
"@fluencelabs/marine-js",
"marine-js.wasm",
);
const avmModuleLoader = new WasmLoaderFromNpm(
"@fluencelabs/avm",
"avm.wasm",
);
const marine = new MarineBackgroundRunner(
workerLoader,
controlModuleLoader,
avmModuleLoader,
);
const conn = network.getRelayConnection(keyPair.getPeerId(), relay);
super(config, keyPair, marine, new JsServiceHost(), conn);
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,23 +13,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { PeerIdB58 } from '@fluencelabs/interfaces';
import { fromBase64Sk, KeyPair } from '../keypair/index.js';
import { MarineBackgroundRunner } from '../marine/worker/index.js';
import { WorkerLoaderFromFs } from '../marine/deps-loader/node.js';
import { PeerIdB58 } from "@fluencelabs/interfaces";
import { Subject } from "rxjs";
import { logger } from '../util/logger.js';
import { Subject } from 'rxjs';
import { Particle } from '../particle/Particle.js';
import { IConnection } from "../connection/interfaces.js";
import { DEFAULT_CONFIG, FluencePeer } from "../jsPeer/FluencePeer.js";
import { JsServiceHost } from "../jsServiceHost/JsServiceHost.js";
import { fromBase64Sk, KeyPair } from "../keypair/index.js";
import {
WorkerLoaderFromFs,
WasmLoaderFromNpm,
} from "../marine/deps-loader/node.js";
import { IMarineHost } from "../marine/interfaces.js";
import { MarineBackgroundRunner } from "../marine/worker/index.js";
import { Particle } from "../particle/Particle.js";
import { logger } from "../util/logger.js";
import { WasmLoaderFromNpm } from '../marine/deps-loader/node.js';
import { DEFAULT_CONFIG, FluencePeer } from '../jsPeer/FluencePeer.js';
import { IConnection } from '../connection/interfaces.js';
import { IAvmRunner, IMarineHost } from '../marine/interfaces.js';
import { JsServiceHost } from '../jsServiceHost/JsServiceHost.js';
const log = logger('ephemeral');
const log = logger("ephemeral");
interface EphemeralConfig {
peers: Array<{
@ -41,84 +42,84 @@ interface EphemeralConfig {
export const defaultConfig = {
peers: [
{
peerId: '12D3KooWJankP2PcEDYCZDdJ26JsU8BMRfdGWyGqbtFiWyoKVtmx',
sk: 'dWNAHhDVuFj9bEieILMu6TcCFRxBJdOPIvAWmf4sZQI=',
peerId: "12D3KooWJankP2PcEDYCZDdJ26JsU8BMRfdGWyGqbtFiWyoKVtmx",
sk: "dWNAHhDVuFj9bEieILMu6TcCFRxBJdOPIvAWmf4sZQI=",
},
{
peerId: '12D3KooWSBTB5sYxdwayUyTnqopBwABsnGFY3p4dTx5hABYDtJjV',
sk: 'dOmaxAeu4Th+MJ22vRDLMFTNbiDgKNXar9fW9ofAMgQ=',
peerId: "12D3KooWSBTB5sYxdwayUyTnqopBwABsnGFY3p4dTx5hABYDtJjV",
sk: "dOmaxAeu4Th+MJ22vRDLMFTNbiDgKNXar9fW9ofAMgQ=",
},
{
peerId: '12D3KooWQjwf781DJ41moW5RrZXypLdnTbo6aMsoA8QLctGGX8RB',
sk: 'TgzaLlxXuOMDNuuuTKEHUKsW0jM4AmX0gahFvkB1KgE=',
peerId: "12D3KooWQjwf781DJ41moW5RrZXypLdnTbo6aMsoA8QLctGGX8RB",
sk: "TgzaLlxXuOMDNuuuTKEHUKsW0jM4AmX0gahFvkB1KgE=",
},
{
peerId: '12D3KooWCXWTLFyY1mqKnNAhLQTsjW1zqDzCMbUs8M4a8zdz28HK',
sk: 'hiO2Ta8g2ibMQ7iu5yj9CfN+qQCwE8oRShjr7ortKww=',
peerId: "12D3KooWCXWTLFyY1mqKnNAhLQTsjW1zqDzCMbUs8M4a8zdz28HK",
sk: "hiO2Ta8g2ibMQ7iu5yj9CfN+qQCwE8oRShjr7ortKww=",
},
{
peerId: '12D3KooWPmZpf4ng6GMS39HLagxsXbjiTPLH5CFJpFAHyN6amw6V',
sk: 'LzJtOHTqxfrlHDW40BKiLfjai8JU4yW6/s2zrXLCcQE=',
peerId: "12D3KooWPmZpf4ng6GMS39HLagxsXbjiTPLH5CFJpFAHyN6amw6V",
sk: "LzJtOHTqxfrlHDW40BKiLfjai8JU4yW6/s2zrXLCcQE=",
},
{
peerId: '12D3KooWKrx8PZxM1R9A8tp2jmrFf6c6q1ZQiWfD4QkNgh7fWSoF',
sk: 'XMhlk/xr1FPcp7sKQhS18doXlq1x16EMhBC2NGW2LQ4=',
peerId: "12D3KooWKrx8PZxM1R9A8tp2jmrFf6c6q1ZQiWfD4QkNgh7fWSoF",
sk: "XMhlk/xr1FPcp7sKQhS18doXlq1x16EMhBC2NGW2LQ4=",
},
{
peerId: '12D3KooWCbJHvnzSZEXjR1UJmtSUozuJK13iRiCYHLN1gjvm4TZZ',
sk: 'KXPAIqxrSHr7v0ngv3qagcqivFvnQ0xd3s1/rKmi8QU=',
peerId: "12D3KooWCbJHvnzSZEXjR1UJmtSUozuJK13iRiCYHLN1gjvm4TZZ",
sk: "KXPAIqxrSHr7v0ngv3qagcqivFvnQ0xd3s1/rKmi8QU=",
},
{
peerId: '12D3KooWEvKe7WQHp42W4xhHRgTAWQjtDWyH38uJbLHAsMuTtYvD',
sk: 'GCYMAshGnsrNtrHhuT7ayzh5uCzX99J03PmAXoOcCgw=',
peerId: "12D3KooWEvKe7WQHp42W4xhHRgTAWQjtDWyH38uJbLHAsMuTtYvD",
sk: "GCYMAshGnsrNtrHhuT7ayzh5uCzX99J03PmAXoOcCgw=",
},
{
peerId: '12D3KooWSznSHN3BGrSykBXkLkFsqo9SYB73wVauVdqeuRt562cC',
sk: 'UP+SEuznS0h259VbFquzyOJAQ4W5iIwhP+hd1PmUQQ0=',
peerId: "12D3KooWSznSHN3BGrSykBXkLkFsqo9SYB73wVauVdqeuRt562cC",
sk: "UP+SEuznS0h259VbFquzyOJAQ4W5iIwhP+hd1PmUQQ0=",
},
{
peerId: '12D3KooWF57jwbShfnT3c4dNfRDdGjr6SQ3B71m87UVpEpSWHFwi',
sk: '8dl+Crm5RSh0eh+LqLKwX8/Eo4QLpvIjfD8L0wzX4A4=',
peerId: "12D3KooWF57jwbShfnT3c4dNfRDdGjr6SQ3B71m87UVpEpSWHFwi",
sk: "8dl+Crm5RSh0eh+LqLKwX8/Eo4QLpvIjfD8L0wzX4A4=",
},
{
peerId: '12D3KooWBWrzpSg9nwMLBCa2cJubUjTv63Mfy6PYg9rHGbetaV5C',
sk: 'qolc1FcpJ+vHDon0HeXdUYnstjV1wiVx2p0mjblrfAg=',
peerId: "12D3KooWBWrzpSg9nwMLBCa2cJubUjTv63Mfy6PYg9rHGbetaV5C",
sk: "qolc1FcpJ+vHDon0HeXdUYnstjV1wiVx2p0mjblrfAg=",
},
{
peerId: '12D3KooWNkLVU6juM8oyN2SVq5nBd2kp7Rf4uzJH1hET6vj6G5j6',
sk: 'vN6QzWILTM7hSHp+iGkKxiXcqs8bzlnH3FPaRaDGSQY=',
peerId: "12D3KooWNkLVU6juM8oyN2SVq5nBd2kp7Rf4uzJH1hET6vj6G5j6",
sk: "vN6QzWILTM7hSHp+iGkKxiXcqs8bzlnH3FPaRaDGSQY=",
},
{
peerId: '12D3KooWKo1YwGL5vivPiKJMJS7wjtB6B2nJNdSXPkSABT4NKBUU',
sk: 'YbDQ++bsor2kei7rYAsu2SbyoiOYPRzFRZWnNRUpBgQ=',
peerId: "12D3KooWKo1YwGL5vivPiKJMJS7wjtB6B2nJNdSXPkSABT4NKBUU",
sk: "YbDQ++bsor2kei7rYAsu2SbyoiOYPRzFRZWnNRUpBgQ=",
},
{
peerId: '12D3KooWLUyBKmmNCyxaPkXoWcUFPcy5qrZsUo2E1tyM6CJmGJvC',
sk: 'ptB9eSFMKudAtHaFgDrRK/1oIMrhBujxbMw2Pzwx/wA=',
peerId: "12D3KooWLUyBKmmNCyxaPkXoWcUFPcy5qrZsUo2E1tyM6CJmGJvC",
sk: "ptB9eSFMKudAtHaFgDrRK/1oIMrhBujxbMw2Pzwx/wA=",
},
{
peerId: '12D3KooWAEZXME4KMu9FvLezsJWDbYFe2zyujyMnDT1AgcAxgcCk',
sk: 'xtwTOKgAbDIgkuPf7RKiR7gYyZ1HY4mOgFMv3sOUcAQ=',
peerId: "12D3KooWAEZXME4KMu9FvLezsJWDbYFe2zyujyMnDT1AgcAxgcCk",
sk: "xtwTOKgAbDIgkuPf7RKiR7gYyZ1HY4mOgFMv3sOUcAQ=",
},
{
peerId: '12D3KooWEhXetsFVAD9h2dRz9XgFpfidho1TCZVhFrczX8h8qgzY',
sk: '1I2MGuiKG1F4FDMiRihVOcOP2mxzOLWJ99MeexK27A4=',
peerId: "12D3KooWEhXetsFVAD9h2dRz9XgFpfidho1TCZVhFrczX8h8qgzY",
sk: "1I2MGuiKG1F4FDMiRihVOcOP2mxzOLWJ99MeexK27A4=",
},
{
peerId: '12D3KooWDBfVNdMyV3hPEF4WLBmx9DwD2t2SYuqZ2mztYmDzZWM1',
sk: 'eqJ4Bp7iN4aBXgPH0ezwSg+nVsatkYtfrXv9obI0YQ0=',
peerId: "12D3KooWDBfVNdMyV3hPEF4WLBmx9DwD2t2SYuqZ2mztYmDzZWM1",
sk: "eqJ4Bp7iN4aBXgPH0ezwSg+nVsatkYtfrXv9obI0YQ0=",
},
{
peerId: '12D3KooWSyY7wiSiR4vbXa1WtZawi3ackMTqcQhEPrvqtagoWPny',
sk: 'UVM3SBJhPYIY/gafpnd9/q/Fn9V4BE9zkgrvF1T7Pgc=',
peerId: "12D3KooWSyY7wiSiR4vbXa1WtZawi3ackMTqcQhEPrvqtagoWPny",
sk: "UVM3SBJhPYIY/gafpnd9/q/Fn9V4BE9zkgrvF1T7Pgc=",
},
{
peerId: '12D3KooWFZmBMGG9PxTs9s6ASzkLGKJWMyPheA5ruaYc2FDkDTmv',
sk: '8RbZfEVpQhPVuhv64uqxENDuSoyJrslQoSQJznxsTQ0=',
peerId: "12D3KooWFZmBMGG9PxTs9s6ASzkLGKJWMyPheA5ruaYc2FDkDTmv",
sk: "8RbZfEVpQhPVuhv64uqxENDuSoyJrslQoSQJznxsTQ0=",
},
{
peerId: '12D3KooWBbhUaqqur6KHPunnKxXjY1daCtqJdy4wRji89LmAkVB4',
sk: 'RbgKmG6soWW9uOi7yRedm+0Qck3f3rw6MSnDP7AcBQs=',
peerId: "12D3KooWBbhUaqqur6KHPunnKxXjY1daCtqJdy4wRji89LmAkVB4",
sk: "RbgKmG6soWW9uOi7yRedm+0Qck3f3rw6MSnDP7AcBQs=",
},
],
};
@ -160,7 +161,7 @@ export class EphemeralConnection implements IEphemeralConnection {
}
disconnectFromAll() {
for (let other of this.connections.values()) {
for (const other of this.connections.values()) {
this.disconnectFromOther(other);
}
}
@ -168,29 +169,36 @@ export class EphemeralConnection implements IEphemeralConnection {
particleSource = new Subject<Particle>();
receiveParticle(particle: Particle): void {
this.particleSource.next(Particle.fromString(particle.toString()));
this.particleSource.next(particle);
}
async sendParticle(nextPeerIds: string[], particle: Particle): Promise<void> {
sendParticle(nextPeerIds: string[], particle: Particle): Promise<void> {
const from = this.selfPeerId;
for (let to of nextPeerIds) {
for (const to of nextPeerIds) {
const destConnection = this.connections.get(to);
if (destConnection === undefined) {
log.error('peer %s has no connection with %s', from, to);
log.error("peer %s has no connection with %s", from, to);
continue;
}
// log.trace(`Sending particle from %s, to %j, particleId %s`, from, to, particle.id);
destConnection.receiveParticle(particle);
}
return Promise.resolve();
}
getRelayPeerId(): string {
if (this.connections.size === 1) {
return this.connections.keys().next().value;
const firstMapKey = this.connections.keys().next();
// Empty map
if (firstMapKey.done === true) {
throw new Error("relay is not supported in this Ephemeral network peer");
}
throw new Error('relay is not supported in this Ephemeral network peer');
return firstMapKey.value;
}
supportsRelay(): boolean {
@ -220,25 +228,42 @@ export class EphemeralNetwork {
controlModuleLoader: WasmLoaderFromNpm;
avmModuleLoader: WasmLoaderFromNpm;
constructor(public readonly config: EphemeralConfig) {
constructor(readonly config: EphemeralConfig) {
// shared worker for all the peers
this.workerLoader = new WorkerLoaderFromFs('../../marine/worker-script');
this.controlModuleLoader = new WasmLoaderFromNpm('@fluencelabs/marine-js', 'marine-js.wasm');
this.avmModuleLoader = new WasmLoaderFromNpm('@fluencelabs/avm', 'avm.wasm');
this.workerLoader = new WorkerLoaderFromFs("../../marine/worker-script");
this.controlModuleLoader = new WasmLoaderFromNpm(
"@fluencelabs/marine-js",
"marine-js.wasm",
);
this.avmModuleLoader = new WasmLoaderFromNpm(
"@fluencelabs/avm",
"avm.wasm",
);
}
/**
* Starts the Ephemeral network up
*/
async up(): Promise<void> {
log.trace('starting ephemeral network up...');
log.trace("starting ephemeral network up...");
const promises = this.config.peers.map(async (x) => {
const kp = await fromBase64Sk(x.sk);
const marine = new MarineBackgroundRunner(this.workerLoader, this.controlModuleLoader, this.avmModuleLoader);
const marine = new MarineBackgroundRunner(
this.workerLoader,
this.controlModuleLoader,
this.avmModuleLoader,
);
const peerId = kp.getPeerId();
if (peerId !== x.peerId) {
throw new Error(`Invalid config: peer id ${x.peerId} does not match the secret key ${x.sk}`);
throw new Error(
`Invalid config: peer id ${x.peerId} does not match the secret key ${x.sk}`,
);
}
return new EphemeralPeer(kp, marine);
@ -252,14 +277,19 @@ export class EphemeralNetwork {
continue;
}
peers[i].ephemeralConnection.connectToOther(peers[j].ephemeralConnection);
peers[i].ephemeralConnection.connectToOther(
peers[j].ephemeralConnection,
);
}
}
const startPromises = peers.map((x) => x.start());
const startPromises = peers.map((x) => {
return x.start();
});
await Promise.all(startPromises);
for (let p of peers) {
for (const p of peers) {
this.peers.set(p.keyPair.getPeerId(), p);
}
}
@ -268,16 +298,17 @@ export class EphemeralNetwork {
* Shuts the ephemeral network down. Will disconnect all connected peers.
*/
async down(): Promise<void> {
log.trace('shutting down ephemeral network...');
log.trace("shutting down ephemeral network...");
const peers = Array.from(this.peers.entries());
const promises = peers.map(async ([k, p]) => {
await p.ephemeralConnection.disconnectFromAll();
const promises = peers.map(async ([, p]) => {
p.ephemeralConnection.disconnectFromAll();
await p.stop();
});
await Promise.all(promises);
this.peers.clear();
log.trace('ephemeral network shut down');
log.trace("ephemeral network shut down");
}
/**
@ -285,6 +316,7 @@ export class EphemeralNetwork {
*/
getRelayConnection(peerId: PeerIdB58, relayPeerId: PeerIdB58): IConnection {
const relay = this.peers.get(relayPeerId);
if (relay === undefined) {
throw new Error(`Peer ${relayPeerId} is not found`);
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -21,20 +21,41 @@ interface PackageJsonContent {
// This will be substituted in build phase
const packageJsonContentString = `__PACKAGE_JSON_CONTENT__`;
let parsedPackageJsonContent: PackageJsonContent;
let parsedPackageJsonContent: PackageJsonContent | undefined;
const PRIMARY_CDN = "https://unpkg.com/";
export async function fetchResource(pkg: string, assetPath: string) {
const packageJsonContent = parsedPackageJsonContent || (parsedPackageJsonContent = JSON.parse(packageJsonContentString));
const version = packageJsonContent.dependencies[pkg] || packageJsonContent.devDependencies[pkg];
const packageJsonContent =
parsedPackageJsonContent ??
// TODO: Should be validated
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
(parsedPackageJsonContent = JSON.parse(
packageJsonContentString,
) as PackageJsonContent);
const version =
packageJsonContent.dependencies[pkg] ??
packageJsonContent.devDependencies[pkg];
if (version === undefined) {
const availableDeps = [...Object.keys(packageJsonContent.dependencies), ...Object.keys(packageJsonContent.devDependencies)];
throw new Error(`Cannot find version of ${pkg} in package.json. Available versions: ${availableDeps.join(',')}`);
const availableDeps = [
...Object.keys(packageJsonContent.dependencies),
...Object.keys(packageJsonContent.devDependencies),
];
throw new Error(
`Cannot find version of ${pkg} in package.json. Available versions: ${availableDeps.join(
",",
)}`,
);
}
const refinedAssetPath = assetPath.startsWith('/') ? assetPath.slice(1) : assetPath;
const refinedAssetPath = assetPath.startsWith("/")
? assetPath.slice(1)
: assetPath;
return fetch(new globalThis.URL(`${pkg}@${version}/` + refinedAssetPath, PRIMARY_CDN));
return fetch(
new globalThis.URL(`${pkg}@${version}/` + refinedAssetPath, PRIMARY_CDN),
);
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,17 +14,20 @@
* limitations under the License.
*/
import { fetchResource as fetchResourceBrowser } from './browser.js';
import { fetchResource as fetchResourceNode } from './node.js';
import process from 'process';
import process from "process";
const isNode = typeof process !== 'undefined' && process?.release?.name === 'node';
import { fetchResource as fetchResourceIsomorphic } from "#fetcher";
const isNode =
// process.release is undefined in browser env
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
typeof process !== "undefined" && process.release?.name === "node";
export async function fetchResource(pkg: string, path: string) {
switch (true) {
case isNode:
return fetchResourceNode(pkg, path);
return fetchResourceIsomorphic(pkg, path);
default:
return fetchResourceBrowser(pkg, path);
return fetchResourceIsomorphic(pkg, path);
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,9 +14,9 @@
* limitations under the License.
*/
import fs from 'fs';
import path from 'path';
import module from 'module';
import fs from "fs";
import module from "module";
import path from "path";
export async function fetchResource(pkg: string, assetPath: string) {
const require = module.createRequire(import.meta.url);
@ -29,7 +29,7 @@ export async function fetchResource(pkg: string, assetPath: string) {
const packagePath = matches?.[0];
if (!packagePath) {
if (packagePath == null) {
throw new Error(`Cannot find dependency ${pkg} in path ${posixPath}`);
}
@ -38,22 +38,22 @@ export async function fetchResource(pkg: string, assetPath: string) {
const file = await new Promise<ArrayBuffer>((resolve, reject) => {
// Cannot use 'fs/promises' with current vite config. This module is not polyfilled by default.
fs.readFile(pathToResource, (err, data) => {
if (err) {
if (err != null) {
reject(err);
return;
}
resolve(data);
});
});
return new Response(file, {
headers: {
'Content-type':
assetPath.endsWith('.wasm')
? 'application/wasm'
: assetPath.endsWith('.js')
? 'application/javascript'
: 'application/text'
}
"Content-type": assetPath.endsWith(".wasm")
? "application/wasm"
: assetPath.endsWith(".js")
? "application/javascript"
: "application/text",
},
});
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,41 +13,82 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { ClientConfig, IFluenceClient, RelayOptions, ConnectionState, CallAquaFunctionType, RegisterServiceType } from '@fluencelabs/interfaces';
import { ClientPeer, makeClientPeerConfig } from './clientPeer/ClientPeer.js';
import { callAquaFunction } from './compilerSupport/callFunction.js';
import { registerService } from './compilerSupport/registerService.js';
import { MarineBackgroundRunner } from './marine/worker/index.js';
// @ts-ignore
import { BlobWorker, Worker } from 'threads';
import { doRegisterNodeUtils } from './services/NodeUtils.js';
import { fetchResource } from './fetchers/index.js';
import process from 'process';
import path from 'path';
import url from 'url';
import module from 'module';
const isNode = typeof process !== 'undefined' && process?.release?.name === 'node';
import module from "module";
import path from "path";
import process from "process";
import url from "url";
const fetchWorkerCode = () => fetchResource('@fluencelabs/marine-worker', '/dist/browser/marine-worker.umd.cjs').then(res => res.text());
const fetchMarineJsWasm = () => fetchResource('@fluencelabs/marine-js', '/dist/marine-js.wasm').then(res => res.arrayBuffer());
const fetchAvmWasm = () => fetchResource('@fluencelabs/avm', '/dist/avm.wasm').then(res => res.arrayBuffer());
import type {
ClientConfig,
ConnectionState,
RelayOptions,
} from "@fluencelabs/interfaces";
import { BlobWorker, Worker } from "threads/master";
const createClient = async (relay: RelayOptions, config: ClientConfig): Promise<IFluenceClient> => {
import { ClientPeer, makeClientPeerConfig } from "./clientPeer/ClientPeer.js";
import { callAquaFunction } from "./compilerSupport/callFunction.js";
import { registerService } from "./compilerSupport/registerService.js";
import { fetchResource } from "./fetchers/index.js";
import { MarineBackgroundRunner } from "./marine/worker/index.js";
import { doRegisterNodeUtils } from "./services/NodeUtils.js";
const isNode =
// process.release is undefined in browser env
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
typeof process !== "undefined" && process.release?.name === "node";
const fetchWorkerCode = async () => {
const resource = await fetchResource(
"@fluencelabs/marine-worker",
"/dist/browser/marine-worker.umd.cjs",
);
return resource.text();
};
const fetchMarineJsWasm = async () => {
const resource = await fetchResource(
"@fluencelabs/marine-js",
"/dist/marine-js.wasm",
);
return resource.arrayBuffer();
};
const fetchAvmWasm = async () => {
const resource = await fetchResource("@fluencelabs/avm", "/dist/avm.wasm");
return resource.arrayBuffer();
};
const createClient = async (
relay: RelayOptions,
config: ClientConfig,
): Promise<ClientPeer> => {
const marineJsWasm = await fetchMarineJsWasm();
const avmWasm = await fetchAvmWasm();
const marine = new MarineBackgroundRunner({
const marine = new MarineBackgroundRunner(
{
async getValue() {
if (isNode) {
const require = module.createRequire(import.meta.url);
const pathToThisFile = path.dirname(url.fileURLToPath(import.meta.url));
const pathToWorker = require.resolve('@fluencelabs/marine-worker');
const relativePathToWorker = path.relative(pathToThisFile, pathToWorker);
const pathToThisFile = path.dirname(
url.fileURLToPath(import.meta.url),
);
const pathToWorker = require.resolve("@fluencelabs/marine-worker");
const relativePathToWorker = path.relative(
pathToThisFile,
pathToWorker,
);
return new Worker(relativePathToWorker);
} else {
const workerCode = await fetchWorkerCode();
return BlobWorker.fromText(workerCode)
return BlobWorker.fromText(workerCode);
}
},
start() {
@ -56,28 +97,42 @@ const createClient = async (relay: RelayOptions, config: ClientConfig): Promise<
stop() {
return Promise.resolve(undefined);
},
}, {
},
{
getValue() {
return marineJsWasm;
}, start(): Promise<void> {
},
start(): Promise<void> {
return Promise.resolve(undefined);
}, stop(): Promise<void> {
},
stop(): Promise<void> {
return Promise.resolve(undefined);
}
}, {
},
},
{
getValue() {
return avmWasm;
}, start(): Promise<void> {
},
start(): Promise<void> {
return Promise.resolve(undefined);
}, stop(): Promise<void> {
},
stop(): Promise<void> {
return Promise.resolve(undefined);
}
});
const { keyPair, peerConfig, relayConfig } = await makeClientPeerConfig(relay, config);
const client: IFluenceClient = new ClientPeer(peerConfig, relayConfig, keyPair, marine);
},
},
);
const { keyPair, peerConfig, relayConfig } = await makeClientPeerConfig(
relay,
config,
);
const client = new ClientPeer(peerConfig, relayConfig, keyPair, marine);
if (isNode) {
doRegisterNodeUtils(client);
}
await client.connect();
return client;
};
@ -85,22 +140,31 @@ const createClient = async (relay: RelayOptions, config: ClientConfig): Promise<
/**
* Public interface to Fluence Network
*/
export const Fluence = {
defaultClient: undefined as (IFluenceClient | undefined),
interface FluencePublicApi {
defaultClient: ClientPeer | undefined;
connect: (relay: RelayOptions, config: ClientConfig) => Promise<void>;
disconnect: () => Promise<void>;
onConnectionStateChange: (
handler: (state: ConnectionState) => void,
) => ConnectionState;
getClient: () => ClientPeer;
}
export const Fluence: FluencePublicApi = {
defaultClient: undefined,
/**
* Connect to the Fluence network
* @param relay - relay node to connect to
* @param config - client configuration
*/
connect: async function(relay: RelayOptions, config: ClientConfig): Promise<void> {
const client = await createClient(relay, config);
this.defaultClient = client;
connect: async function (relay, config) {
this.defaultClient = await createClient(relay, config);
},
/**
* Disconnect from the Fluence network
*/
disconnect: async function(): Promise<void> {
disconnect: async function (): Promise<void> {
await this.defaultClient?.disconnect();
this.defaultClient = undefined;
},
@ -108,23 +172,32 @@ export const Fluence = {
/**
* Handle connection state changes. Immediately returns the current connection state
*/
onConnectionStateChange(handler: (state: ConnectionState) => void): ConnectionState {
return this.defaultClient?.onConnectionStateChange(handler) || 'disconnected';
onConnectionStateChange(handler) {
return (
this.defaultClient?.onConnectionStateChange(handler) ?? "disconnected"
);
},
/**
* Low level API. Get the underlying client instance which holds the connection to the network
* @returns IFluenceClient instance
*/
getClient: async function(): Promise<IFluenceClient> {
if (!this.defaultClient) {
throw new Error('Fluence client is not initialized. Call Fluence.connect() first');
getClient: function () {
if (this.defaultClient == null) {
throw new Error(
"Fluence client is not initialized. Call Fluence.connect() first",
);
}
return this.defaultClient;
},
};
export type { IFluenceClient, ClientConfig, CallParams } from '@fluencelabs/interfaces';
export type {
IFluenceClient,
ClientConfig,
CallParams,
} from "@fluencelabs/interfaces";
export type {
ArrayType,
@ -151,14 +224,14 @@ export type {
FnConfig,
RegisterServiceType,
RegisterServiceArgs,
} from '@fluencelabs/interfaces';
} from "@fluencelabs/interfaces";
export { v5_callFunction, v5_registerService } from './api.js';
export { v5_callFunction, v5_registerService } from "./api.js";
// @ts-ignore
// @ts-expect-error Writing to global object like this prohibited by ts
globalThis.new_fluence = Fluence;
// @ts-ignore
// @ts-expect-error Writing to global object like this prohibited by ts
globalThis.fluence = {
clientFactory: createClient,
callAquaFunction,
@ -166,4 +239,9 @@ globalThis.fluence = {
};
export { createClient, callAquaFunction, registerService };
export { getFluenceInterface, getFluenceInterfaceFromGlobalThis } from './util/loadClient.js';
export {
KeyPair,
fromBase64Sk,
fromBase58Sk,
fromOpts,
} from "./keypair/index.js";

View File

@ -1,5 +1,5 @@
/*
* Copyright 2021 Fluence Labs Limited
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -13,10 +13,44 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { KeyPair } from '../keypair/index.js';
import type { PeerIdB58 } from '@fluencelabs/interfaces';
import { deserializeAvmResult, InterpreterResult, KeyPairFormat, serializeAvmArgs } from '@fluencelabs/avm';
import { Buffer } from "buffer";
import {
deserializeAvmResult,
InterpreterResult,
KeyPairFormat,
serializeAvmArgs,
} from "@fluencelabs/avm";
import { defaultCallParameters } from "@fluencelabs/marine-js/dist/types";
import { fromUint8Array } from "js-base64";
import {
concatMap,
filter,
groupBy,
lastValueFrom,
mergeMap,
pipe,
Subject,
tap,
Unsubscribable,
} from "rxjs";
import { IConnection } from "../connection/interfaces.js";
import {
CallServiceData,
CallServiceResult,
IJsServiceHost,
ResultCodes,
} from "../jsServiceHost/interfaces.js";
import {
getParticleContext,
registerDefaultServices,
ServiceError,
} from "../jsServiceHost/serviceUtils.js";
import { KeyPair } from "../keypair/index.js";
import { IMarineHost } from "../marine/interfaces.js";
import { IParticle } from "../particle/interfaces.js";
import {
cloneWithNewData,
getActualTTL,
@ -24,50 +58,18 @@ import {
Particle,
ParticleExecutionStage,
ParticleQueueItem,
} from '../particle/Particle.js';
import { defaultCallParameters } from '@fluencelabs/marine-js/dist/types'
import { jsonify, isString } from '../util/utils.js';
import {
concatAll,
concatMap,
filter,
from,
groupBy,
lastValueFrom,
mergeAll,
mergeMap,
Observable,
pipe,
Subject,
tap,
Unsubscribable
} from 'rxjs';
import { defaultSigGuard, Sig } from '../services/Sig.js';
import { registerSig } from '../services/_aqua/services.js';
import { registerSrv } from '../services/_aqua/single-module-srv.js';
import { registerTracing } from '../services/_aqua/tracing.js';
import { Buffer } from 'buffer';
} from "../particle/Particle.js";
import { registerSig } from "../services/_aqua/services.js";
import { registerSrv } from "../services/_aqua/single-module-srv.js";
import { registerTracing } from "../services/_aqua/tracing.js";
import { defaultSigGuard, Sig } from "../services/Sig.js";
import { Srv } from "../services/SingleModuleSrv.js";
import { Tracing } from "../services/Tracing.js";
import { logger } from "../util/logger.js";
import { jsonify, isString, getErrorMessage } from "../util/utils.js";
import { Srv } from '../services/SingleModuleSrv.js';
import { Tracing } from '../services/Tracing.js';
import { logger } from '../util/logger.js';
import { getParticleContext, registerDefaultServices, ServiceError } from '../jsServiceHost/serviceUtils.js';
import { IParticle } from '../particle/interfaces.js';
import { IConnection } from '../connection/interfaces.js';
import { IAvmRunner, IMarineHost } from '../marine/interfaces.js';
import {
CallServiceData,
CallServiceResult,
GenericCallServiceHandler,
IJsServiceHost,
ResultCodes,
} from '../jsServiceHost/interfaces.js';
import { JSONValue } from '../util/commonTypes.js';
import { fromUint8Array } from 'js-base64';
const log_particle = logger('particle');
const log_peer = logger('peer');
const log_particle = logger("particle");
const log_peer = logger("peer");
export type PeerConfig = {
/**
@ -103,7 +105,7 @@ export const DEFAULT_CONFIG: PeerConfig = {
export abstract class FluencePeer {
constructor(
protected readonly config: PeerConfig,
public readonly keyPair: KeyPair,
readonly keyPair: KeyPair,
protected readonly marineHost: IMarineHost,
protected readonly jsServiceHost: IJsServiceHost,
protected readonly connection: IConnection,
@ -112,16 +114,18 @@ export abstract class FluencePeer {
}
async start(): Promise<void> {
log_peer.trace('starting Fluence peer');
if (this.config?.debug?.printParticleId) {
log_peer.trace("starting Fluence peer");
if (this.config.debug.printParticleId) {
this.printParticleId = true;
}
await this.marineHost.start();
this._startParticleProcessing();
this.isInitialized = true;
await this.connection.start();
log_peer.trace('started Fluence peer');
log_peer.trace("started Fluence peer");
}
/**
@ -129,20 +133,20 @@ export abstract class FluencePeer {
* and disconnects from the Fluence network
*/
async stop() {
log_peer.trace('stopping Fluence peer');
log_peer.trace("stopping Fluence peer");
this._particleSourceSubscription?.unsubscribe();
log_peer.trace('Waiting for all particles to finish execution');
log_peer.trace("Waiting for all particles to finish execution");
this._incomingParticles.complete();
await this._incomingParticlePromise;
log_peer.trace('All particles finished execution');
log_peer.trace("All particles finished execution");
this._stopParticleProcessing();
await this.marineHost.stop();
await this.connection.stop();
this.isInitialized = false;
log_peer.trace('stopped Fluence peer');
log_peer.trace("stopped Fluence peer");
}
/**
@ -154,11 +158,10 @@ export abstract class FluencePeer {
* @param wasm - buffer with the wasm file for service
* @param serviceId - the service id by which the service can be accessed in aqua
*/
async registerMarineService(wasm: SharedArrayBuffer | Buffer, serviceId: string): Promise<void> {
if (!this.marineHost) {
throw new Error("Can't register marine service: peer is not initialized");
}
async registerMarineService(
wasm: SharedArrayBuffer | Buffer,
serviceId: string,
): Promise<void> {
if (this.jsServiceHost.hasService(serviceId)) {
throw new Error(`Service with '${serviceId}' id already exists`);
}
@ -174,35 +177,47 @@ export abstract class FluencePeer {
await this.marineHost.removeService(serviceId);
}
// internal api
/**
* @private Is not intended to be used manually. Subject to change
*/
get internals() {
return {
getServices: () => this._classServices,
getServices: () => {
return this._classServices;
},
getRelayPeerId: () => {
if (this.connection.supportsRelay()) {
return this.connection.getRelayPeerId();
}
throw new Error('Relay is not supported by the current connection');
throw new Error("Relay is not supported by the current connection");
},
parseAst: async (air: string): Promise<{ success: boolean; data: any }> => {
parseAst: async (
air: string,
): Promise<{ success: boolean; data: unknown }> => {
if (!this.isInitialized) {
new Error("Can't use avm: peer is not initialized");
}
const res = await this.marineHost.callService('avm', 'ast', [air], defaultCallParameters);
const res = await this.marineHost.callService(
"avm",
"ast",
[air],
defaultCallParameters,
);
if (!isString(res)) {
throw new Error(`Call to avm:ast expected to return string. Actual return: ${res}`);
throw new Error(
`Call to avm:ast expected to return string. Actual return: ${JSON.stringify(
res,
)}`,
);
}
try {
if (res.startsWith('error')) {
if (res.startsWith("error")) {
return {
success: false,
data: res,
@ -214,12 +229,25 @@ export abstract class FluencePeer {
};
}
} catch (err) {
throw new Error('Failed to call avm. Result: ' + res + '. Error: ' + err);
throw new Error(
"Failed to call avm. Result: " +
res +
". Error: " +
getErrorMessage(err),
);
}
},
createNewParticle: (script: string, ttl: number = this.config.defaultTtlMs): Promise<IParticle> => {
return Particle.createNew(script, this.keyPair.getPeerId(), ttl, this.keyPair);
createNewParticle: (
script: string,
ttl: number = this.config.defaultTtlMs,
): Promise<IParticle> => {
return Particle.createNew(
script,
this.keyPair.getPeerId(),
ttl,
this.keyPair,
);
},
/**
@ -227,13 +255,20 @@ export abstract class FluencePeer {
* @param particle - particle to start execution of
* @param onStageChange - callback for reacting on particle state changes
*/
initiateParticle: (particle: IParticle, onStageChange: (stage: ParticleExecutionStage) => void): void => {
initiateParticle: (
particle: IParticle,
onStageChange: (stage: ParticleExecutionStage) => void,
): void => {
if (!this.isInitialized) {
throw new Error('Cannot initiate new particle: peer is not initialized');
throw new Error(
"Cannot initiate new particle: peer is not initialized",
);
}
if (this.printParticleId) {
console.log('Particle id: ', particle.id);
// This is intended console-log
// eslint-disable-next-line no-console
console.log("Particle id: ", particle.id);
}
this._incomingParticles.next({
@ -250,11 +285,15 @@ export abstract class FluencePeer {
/**
* Register handler for all particles
*/
common: this.jsServiceHost.registerGlobalHandler.bind(this.jsServiceHost),
common: this.jsServiceHost.registerGlobalHandler.bind(
this.jsServiceHost,
),
/**
* Register handler which will be called only for particle with the specific id
*/
forParticle: this.jsServiceHost.registerParticleScopeHandler.bind(this.jsServiceHost),
forParticle: this.jsServiceHost.registerParticleScopeHandler.bind(
this.jsServiceHost,
),
},
};
}
@ -290,36 +329,54 @@ export abstract class FluencePeer {
registerDefaultServices(this);
this._classServices.sig.securityGuard = defaultSigGuard(peerId);
registerSig(this, 'sig', this._classServices.sig);
registerSig(this, "sig", this._classServices.sig);
registerSig(this, peerId, this._classServices.sig);
registerSrv(this, 'single_module_srv', this._classServices.srv);
registerTracing(this, 'tracingSrv', this._classServices.tracing);
registerSrv(this, "single_module_srv", this._classServices.srv);
registerTracing(this, "tracingSrv", this._classServices.tracing);
}
private _startParticleProcessing() {
this._particleSourceSubscription = this.connection.particleSource.subscribe({
this._particleSourceSubscription = this.connection.particleSource.subscribe(
{
next: (p) => {
this._incomingParticles.next({ particle: p, callResults: [], onStageChange: () => {} });
},
this._incomingParticles.next({
particle: p,
callResults: [],
onStageChange: () => {},
});
},
},
);
this._incomingParticlePromise = lastValueFrom(this._incomingParticles
.pipe(
this._incomingParticlePromise = lastValueFrom(
this._incomingParticles.pipe(
tap((item) => {
log_particle.debug('id %s. received:', item.particle.id);
log_particle.trace('id %s. data: %j', item.particle.id, {
log_particle.debug("id %s. received:", item.particle.id);
log_particle.trace("id %s. data: %j", item.particle.id, {
initPeerId: item.particle.initPeerId,
timestamp: item.particle.timestamp,
ttl: item.particle.ttl,
signature: item.particle.signature,
});
log_particle.trace('id %s. script: %s', item.particle.id, item.particle.script);
log_particle.trace('id %s. call results: %j', item.particle.id, item.callResults);
log_particle.trace(
"id %s. script: %s",
item.particle.id,
item.particle.script,
);
log_particle.trace(
"id %s. call results: %j",
item.particle.id,
item.callResults,
);
}),
filterExpiredParticles(this._expireParticle.bind(this)),
groupBy(item => fromUint8Array(item.particle.signature)),
mergeMap(group$ => {
groupBy((item) => {
return fromUint8Array(item.particle.signature);
}),
mergeMap((group$) => {
let prevData: Uint8Array = Buffer.from([]);
let firstRun = true;
@ -334,7 +391,7 @@ export abstract class FluencePeer {
firstRun = false;
}
if (!this.isInitialized || this.marineHost === undefined) {
if (!this.isInitialized) {
// If `.stop()` was called return null to stop particle processing immediately
return null;
}
@ -344,8 +401,16 @@ export abstract class FluencePeer {
// MUST happen sequentially (in a critical section).
// Otherwise the race might occur corrupting the prevData
log_particle.debug('id %s. sending particle to interpreter', item.particle.id);
log_particle.trace('id %s. prevData: %s', item.particle.id, this.decodeAvmData(prevData).slice(0, 50));
log_particle.debug(
"id %s. sending particle to interpreter",
item.particle.id,
);
log_particle.trace(
"id %s. prevData: %s",
item.particle.id,
this.decodeAvmData(prevData).slice(0, 50),
);
const args = serializeAvmArgs(
{
@ -364,14 +429,24 @@ export abstract class FluencePeer {
);
let avmCallResult: InterpreterResult | Error;
try {
const res = await this.marineHost.callService('avm', 'invoke', args, defaultCallParameters);
const res = await this.marineHost.callService(
"avm",
"invoke",
args,
defaultCallParameters,
);
avmCallResult = deserializeAvmResult(res);
} catch (e) {
avmCallResult = e instanceof Error ? e : new Error(String(e));
}
if (!(avmCallResult instanceof Error) && avmCallResult.retCode === 0) {
if (
!(avmCallResult instanceof Error) &&
avmCallResult.retCode === 0
) {
const newData = Buffer.from(avmCallResult.data);
prevData = newData;
}
@ -381,8 +456,14 @@ export abstract class FluencePeer {
result: avmCallResult,
};
}),
filter((item): item is NonNullable<typeof item> => item !== null),
filterExpiredParticles<ParticleQueueItem & {result: Error | InterpreterResult }>(this._expireParticle.bind(this)),
filter((item): item is NonNullable<typeof item> => {
return item !== null;
}),
filterExpiredParticles<
ParticleQueueItem & {
result: Error | InterpreterResult;
}
>(this._expireParticle.bind(this)),
mergeMap(async (item) => {
// If peer was stopped, do not proceed further
if (!this.isInitialized) {
@ -391,60 +472,89 @@ export abstract class FluencePeer {
// Do not continue if there was an error in particle interpretation
if (item.result instanceof Error) {
log_particle.error('id %s. interpreter failed: %s', item.particle.id, item.result.message);
item.onStageChange({ stage: 'interpreterError', errorMessage: item.result.message });
log_particle.error(
"id %s. interpreter failed: %s",
item.particle.id,
item.result.message,
);
item.onStageChange({
stage: "interpreterError",
errorMessage: item.result.message,
});
return;
}
if (item.result.retCode !== 0) {
log_particle.error(
'id %s. interpreter failed: retCode: %d, message: %s',
"id %s. interpreter failed: retCode: %d, message: %s",
item.particle.id,
item.result.retCode,
item.result.errorMessage,
);
log_particle.trace('id %s. avm data: %s', item.particle.id, this.decodeAvmData(item.result.data));
item.onStageChange({ stage: 'interpreterError', errorMessage: item.result.errorMessage });
log_particle.trace(
"id %s. avm data: %s",
item.particle.id,
this.decodeAvmData(item.result.data),
);
item.onStageChange({
stage: "interpreterError",
errorMessage: item.result.errorMessage,
});
return;
}
log_particle.trace(
'id %s. interpreter result: retCode: %d, avm data: %s',
"id %s. interpreter result: retCode: %d, avm data: %s",
item.particle.id,
item.result.retCode,
this.decodeAvmData(item.result.data)
this.decodeAvmData(item.result.data),
);
setTimeout(() => {
item.onStageChange({ stage: 'interpreted' });
item.onStageChange({ stage: "interpreted" });
}, 0);
let connectionPromise: Promise<void> = Promise.resolve();
// send particle further if requested
if (item.result.nextPeerPks.length > 0) {
const newParticle = cloneWithNewData(item.particle, Buffer.from(item.result.data));
// Do not send particle after the peer has been stopped
if (!this.isInitialized) {
return;
}
const newParticle = cloneWithNewData(
item.particle,
Buffer.from(item.result.data),
);
log_particle.debug(
'id %s. sending particle into network. Next peer ids: %s',
"id %s. sending particle into network. Next peer ids: %s",
newParticle.id,
item.result.nextPeerPks.toString(),
);
connectionPromise = this.connection
?.sendParticle(item.result.nextPeerPks, newParticle)
.sendParticle(item.result.nextPeerPks, newParticle)
.then(() => {
log_particle.trace('id %s. send successful', newParticle.id);
item.onStageChange({ stage: 'sent' });
log_particle.trace(
"id %s. send successful",
newParticle.id,
);
item.onStageChange({ stage: "sent" });
})
.catch((e: any) => {
log_particle.error('id %s. send failed %j', newParticle.id, e);
item.onStageChange({ stage: 'sendingError', errorMessage: e.toString() });
.catch((e: unknown) => {
log_particle.error(
"id %s. send failed %j",
newParticle.id,
e,
);
item.onStageChange({
stage: "sendingError",
errorMessage: getErrorMessage(e),
});
});
}
@ -460,7 +570,7 @@ export abstract class FluencePeer {
particleContext: getParticleContext(item.particle),
};
this._execSingleCallRequest(req)
void this._execSingleCallRequest(req)
.catch((err): CallServiceResult => {
if (err instanceof ServiceError) {
return {
@ -471,9 +581,11 @@ export abstract class FluencePeer {
return {
retCode: ResultCodes.error,
result: `Service call failed. fnName="${req.fnName}" serviceId="${
result: `Service call failed. fnName="${
req.fnName
}" serviceId="${
req.serviceId
}" error: ${err.toString()}`,
}" error: ${getErrorMessage(err)}`,
};
})
.then((res) => {
@ -482,7 +594,11 @@ export abstract class FluencePeer {
retCode: res.retCode,
};
const newParticle = cloneWithNewData(item.particle, Buffer.from([]));
const newParticle = cloneWithNewData(
item.particle,
Buffer.from([]),
);
this._incomingParticles.next({
...item,
particle: newParticle,
@ -491,45 +607,59 @@ export abstract class FluencePeer {
});
}
} else {
item.onStageChange({ stage: 'localWorkDone' });
item.onStageChange({ stage: "localWorkDone" });
}
return connectionPromise;
}),
)
})
), { defaultValue: undefined });
);
}),
),
{ defaultValue: undefined },
);
}
private _expireParticle(item: ParticleQueueItem) {
const particleId = item.particle.id;
log_particle.debug(
'id %s. particle has expired after %d. Deleting particle-related queues and handlers',
"id %s. particle has expired after %d. Deleting particle-related queues and handlers",
item.particle.id,
item.particle.ttl,
);
this.jsServiceHost.removeParticleScopeHandlers(particleId);
item.onStageChange({ stage: 'expired' });
item.onStageChange({ stage: "expired" });
}
private decodeAvmData(data: Uint8Array) {
return new TextDecoder().decode(data.buffer);
}
private async _execSingleCallRequest(req: CallServiceData): Promise<CallServiceResult> {
private async _execSingleCallRequest(
req: CallServiceData,
): Promise<CallServiceResult> {
const particleId = req.particleContext.particleId;
log_particle.trace('id %s. executing call service handler %j', particleId, req);
if (this.marineHost && await this.marineHost.hasService(req.serviceId)) {
log_particle.trace(
"id %s. executing call service handler %j",
particleId,
req,
);
if (await this.marineHost.hasService(req.serviceId)) {
// TODO build correct CallParameters instead of default ones
const result = await this.marineHost.callService(req.serviceId, req.fnName, req.args, defaultCallParameters);
const result = await this.marineHost.callService(
req.serviceId,
req.fnName,
req.args,
defaultCallParameters,
);
return {
retCode: ResultCodes.success,
result: result as JSONValue,
result: result,
};
}
@ -538,13 +668,19 @@ export abstract class FluencePeer {
if (res === null) {
res = {
retCode: ResultCodes.error,
result: `No service found for service call: serviceId='${req.serviceId}', fnName='${
req.fnName
}' args='${jsonify(req.args)}'`,
result: `No service found for service call: serviceId='${
req.serviceId
}', fnName='${req.fnName}' args='${jsonify(req.args)}'`,
};
}
log_particle.trace('id %s. executed call service handler, req: %j, res: %j ', particleId, req, res);
log_particle.trace(
"id %s. executed call service handler, req: %j, res: %j ",
particleId,
req,
res,
);
return res;
}
@ -556,13 +692,17 @@ export abstract class FluencePeer {
}
}
function filterExpiredParticles<T extends ParticleQueueItem>(onParticleExpiration: (item: T) => void) {
function filterExpiredParticles<T extends ParticleQueueItem>(
onParticleExpiration: (item: T) => void,
) {
return pipe(
tap((item: T) => {
if (hasExpired(item.particle)) {
onParticleExpiration(item);
}
}),
filter((x) => !hasExpired(x.particle)),
filter((x) => {
return !hasExpired(x.particle);
}),
);
}

View File

@ -1,23 +1,43 @@
import { it, describe, expect } from 'vitest';
import { registerHandlersHelper, withPeer } from '../../util/testUtils.js';
import { handleTimeout } from '../../particle/Particle.js';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
describe('Basic AVM functionality in Fluence Peer tests', () => {
it('Simple call', async () => {
import { JSONValue } from "@fluencelabs/interfaces";
import { it, describe, expect } from "vitest";
import { handleTimeout } from "../../particle/Particle.js";
import { registerHandlersHelper, withPeer } from "../../util/testUtils.js";
describe("Basic AVM functionality in Fluence Peer tests", () => {
it("Simple call", async () => {
await withPeer(async (peer) => {
const script = `
(call %init_peer_id% ("print" "print") ["1"])
`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise<string>((resolve, reject) => {
const res = await new Promise<JSONValue>((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
print: {
print: (args: Array<string>) => {
print: (args): undefined => {
const [res] = args;
resolve(res);
},
@ -27,11 +47,11 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(res).toBe('1');
expect(res).toBe("1");
});
});
it('Par call', async () => {
it("Par call", async () => {
await withPeer(async (peer) => {
const script = `
(seq
@ -42,20 +62,23 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
(call %init_peer_id% ("print" "print") ["2"])
)
`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise<string[]>((resolve, reject) => {
const res: any[] = [];
const res = await new Promise<JSONValue[]>((resolve, reject) => {
const res: JSONValue[] = [];
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
print: {
print: (args: any) => {
print: (args): undefined => {
res.push(args[0]);
if (res.length == 2) {
if (res.length === 2) {
resolve(res);
}
},
@ -65,11 +88,11 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(res).toStrictEqual(['1', '2']);
expect(res).toStrictEqual(["1", "2"]);
});
});
it('Timeout in par call: race', async () => {
it("Timeout in par call: race", async () => {
await withPeer(async (peer) => {
const script = `
(seq
@ -86,16 +109,18 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
)
)
`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
return: {
return: (args: any) => {
return: (args): undefined => {
resolve(args[0]);
},
},
@ -104,11 +129,11 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(res).toBe('fast_result');
expect(res).toBe("fast_result");
});
});
it('Timeout in par call: wait', async () => {
it("Timeout in par call: wait", async () => {
await withPeer(async (peer) => {
const script = `
(seq
@ -136,16 +161,18 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
)
)
`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
return: {
return: (args: any) => {
return: (args): undefined => {
resolve(args[0]);
},
},
@ -154,7 +181,7 @@ describe('Basic AVM functionality in Fluence Peer tests', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(res).toBe('failed_with_timeout');
expect(res).toBe("failed_with_timeout");
});
});
});

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,13 +13,21 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, expect, it } from 'vitest';
import { registerHandlersHelper, withPeer } from '../../util/testUtils.js';
import { handleTimeout } from '../../particle/Particle.js';
import { CallServiceData, ResultCodes } from '../../jsServiceHost/interfaces.js';
describe('FluencePeer flow tests', () => {
it('should execute par instruction in parallel', async function () {
import assert from "assert";
import { JSONValue } from "@fluencelabs/interfaces";
import { describe, expect, it } from "vitest";
import {
CallServiceData,
ResultCodes,
} from "../../jsServiceHost/interfaces.js";
import { handleTimeout } from "../../particle/Particle.js";
import { registerHandlersHelper, withPeer } from "../../util/testUtils.js";
describe("FluencePeer flow tests", () => {
it("should execute par instruction in parallel", async function () {
await withPeer(async (peer) => {
const script = `
(par
@ -36,9 +44,14 @@ describe('FluencePeer flow tests', () => {
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise<any>((resolve, reject) => {
peer.internals.regHandler.forParticle(particle.id, 'flow', 'timeout', (req: CallServiceData) => {
const res = await new Promise((resolve, reject) => {
peer.internals.regHandler.forParticle(
particle.id,
"flow",
"timeout",
(req: CallServiceData) => {
const [timeout, message] = req.args;
assert(typeof timeout === "number");
return new Promise((resolve) => {
setTimeout(() => {
@ -46,29 +59,34 @@ describe('FluencePeer flow tests', () => {
result: message,
retCode: ResultCodes.success,
};
resolve(res);
}, timeout);
});
});
},
);
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
const values: any[] = [];
const values: JSONValue[] = [];
registerHandlersHelper(peer, particle, {
callback: {
callback1: (args: any) => {
callback1: (args): undefined => {
const [val] = args;
values.push(val);
if (values.length === 2) {
resolve(values);
}
},
callback2: (args: any) => {
callback2: (args): undefined => {
const [val] = args;
values.push(val);
if (values.length === 2) {
resolve(values);
}
@ -79,7 +97,7 @@ describe('FluencePeer flow tests', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
await expect(res).toEqual(expect.arrayContaining(["test1", "test1"]));
expect(res).toEqual(expect.arrayContaining(["test1", "test1"]));
});
}, 1500);
});

View File

@ -1,10 +1,26 @@
import { it, describe, expect } from 'vitest';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { withPeer } from '../../util/testUtils.js';
import { it, describe, expect } from "vitest";
describe('Parse ast tests', () => {
it('Correct ast should be parsed correctly', async () => {
withPeer(async (peer) => {
import { withPeer } from "../../util/testUtils.js";
describe("Parse ast tests", () => {
it("Correct ast should be parsed correctly", async () => {
await withPeer(async (peer) => {
const air = `(null)`;
const res = await peer.internals.parseAst(air);
@ -15,14 +31,15 @@ describe('Parse ast tests', () => {
});
});
it('Incorrect ast should result in corresponding error', async () => {
withPeer(async (peer) => {
it("Incorrect ast should result in corresponding error", async () => {
await withPeer(async (peer) => {
const air = `(null`;
const res = await peer.internals.parseAst(air);
expect(res).toStrictEqual({
success: false,
data: expect.stringContaining('error'),
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
data: expect.stringContaining("error"),
});
});
});

View File

@ -1,16 +1,36 @@
import { it, describe, expect } from 'vitest';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { isFluencePeer } from '../../api.js';
import { mkTestPeer, registerHandlersHelper, withPeer } from '../../util/testUtils.js';
import { handleTimeout } from '../../particle/Particle.js';
import { FluencePeer } from '../FluencePeer.js';
import { it, describe, expect } from "vitest";
describe('FluencePeer usage test suite', () => {
it('should perform test for FluencePeer class correctly', async () => {
import { isFluencePeer } from "../../api.js";
import { handleTimeout } from "../../particle/Particle.js";
import {
mkTestPeer,
registerHandlersHelper,
withPeer,
} from "../../util/testUtils.js";
import { FluencePeer } from "../FluencePeer.js";
describe("FluencePeer usage test suite", () => {
it("should perform test for FluencePeer class correctly", async () => {
// arrange
const peer = await mkTestPeer();
const number = 1;
const object = { str: 'Hello!' };
const object = { str: "Hello!" };
const undefinedVal = undefined;
// act
@ -26,7 +46,7 @@ describe('FluencePeer usage test suite', () => {
expect(isUndefinedPeer).toBe(false);
});
it('Should successfully call identity on local peer', async function () {
it("Should successfully call identity on local peer", async function () {
await withPeer(async (peer) => {
const script = `
(seq
@ -34,16 +54,18 @@ describe('FluencePeer usage test suite', () => {
(call %init_peer_id% ("callback" "callback") [res])
)
`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise<string>((resolve, reject) => {
const res = await new Promise((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
callback: {
callback: async (args: any) => {
callback: (args): undefined => {
const [res] = args;
resolve(res);
},
@ -53,15 +75,16 @@ describe('FluencePeer usage test suite', () => {
peer.internals.initiateParticle(particle, handleTimeout(reject));
});
expect(res).toBe('test');
expect(res).toBe("test");
});
});
it('Should throw correct message when calling non existing local service', async function () {
it("Should throw correct message when calling non existing local service", async function () {
await withPeer(async (peer) => {
const res = callIncorrectService(peer);
await expect(res).rejects.toMatchObject({
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
message: expect.stringContaining(
`"No service found for service call: serviceId='incorrect', fnName='incorrect' args='[]'"`,
),
@ -70,7 +93,7 @@ describe('FluencePeer usage test suite', () => {
});
});
it('Should not crash if undefined is passed as a variable', async () => {
it("Should not crash if undefined is passed as a variable", async () => {
await withPeer(async (peer) => {
const script = `
(seq
@ -80,23 +103,27 @@ describe('FluencePeer usage test suite', () => {
(call %init_peer_id% ("callback" "callback") [res])
)
)`;
const particle = await peer.internals.createNewParticle(script);
const res = await new Promise<any>((resolve, reject) => {
const res = await new Promise((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
load: {
arg: () => undefined,
arg: () => {
return undefined;
},
},
callback: {
callback: (args: any) => {
callback: (args): undefined => {
const [val] = args;
resolve(val);
},
error: (args: any) => {
error: (args): undefined => {
const [error] = args;
reject(error);
},
@ -110,28 +137,30 @@ describe('FluencePeer usage test suite', () => {
});
});
it('Should not crash if an error ocurred in user-defined handler', async () => {
it("Should not crash if an error ocurred in user-defined handler", async () => {
await withPeer(async (peer) => {
const script = `
(xor
(call %init_peer_id% ("load" "arg") [] arg)
(call %init_peer_id% ("callback" "error") [%last_error%])
)`;
const particle = await peer.internals.createNewParticle(script);
const promise = new Promise<any>((_resolve, reject) => {
const promise = new Promise<never>((_resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
load: {
arg: () => {
throw new Error('my super custom error message');
throw new Error("my super custom error message");
},
},
callback: {
error: (args: any) => {
error: (args): undefined => {
const [error] = args;
reject(error);
},
@ -142,31 +171,34 @@ describe('FluencePeer usage test suite', () => {
});
await expect(promise).rejects.toMatchObject({
message: expect.stringContaining('my super custom error message'),
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
message: expect.stringContaining("my super custom error message"),
});
});
});
});
async function callIncorrectService(peer: FluencePeer): Promise<string[]> {
async function callIncorrectService(peer: FluencePeer) {
const script = `
(xor
(call %init_peer_id% ("incorrect" "incorrect") [] res)
(call %init_peer_id% ("callback" "error") [%last_error%])
)`;
const particle = await peer.internals.createNewParticle(script);
return new Promise<any[]>((resolve, reject) => {
return new Promise<unknown[]>((resolve, reject) => {
if (particle instanceof Error) {
return reject(particle.message);
reject(particle.message);
return;
}
registerHandlersHelper(peer, particle, {
callback: {
callback: (args: any) => {
callback: (args): undefined => {
resolve(args);
},
error: (args: any) => {
error: (args): undefined => {
const [error] = args;
reject(error);
},

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,17 +13,29 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CallServiceData, CallServiceResult, GenericCallServiceHandler, IJsServiceHost } from './interfaces.js';
import {
CallServiceData,
CallServiceResult,
GenericCallServiceHandler,
IJsServiceHost,
} from "./interfaces.js";
export class JsServiceHost implements IJsServiceHost {
private particleScopeHandlers = new Map<string, Map<string, GenericCallServiceHandler>>();
private particleScopeHandlers = new Map<
string,
Map<string, GenericCallServiceHandler>
>();
private commonHandlers = new Map<string, GenericCallServiceHandler>();
/**
* Returns true if any handler for the specified serviceId is registered
*/
hasService(serviceId: string): boolean {
return this.commonHandlers.has(serviceId) || this.particleScopeHandlers.has(serviceId);
return (
this.commonHandlers.has(serviceId) ||
this.particleScopeHandlers.has(serviceId)
);
}
/**
@ -40,31 +52,28 @@ export class JsServiceHost implements IJsServiceHost {
* @param fnName Function name as specified in `call` air instruction
* @param particleId Particle ID
*/
getHandler(serviceId: string, fnName: string, particleId: string): GenericCallServiceHandler | null {
getHandler(
serviceId: string,
fnName: string,
particleId: string,
): GenericCallServiceHandler | null {
const key = serviceFnKey(serviceId, fnName);
const psh = this.particleScopeHandlers.get(particleId);
let handler: GenericCallServiceHandler | undefined = undefined;
// we should prioritize handler for this particle if there is one
// if particle-scoped handler exist for this particle try getting handler there
if (psh !== undefined) {
handler = psh.get(key);
}
// then try to find a common handler for all particles with this service-fn key
// if there is no particle-specific handler, get one from common map
if (handler === undefined) {
handler = this.commonHandlers.get(key);
}
return handler || null;
return (
this.particleScopeHandlers.get(particleId)?.get(key) ??
this.commonHandlers.get(key) ??
null
);
}
/**
* Execute service call for specified call service data. Return null if no handler was found
*/
async callService(req: CallServiceData): Promise<CallServiceResult | null> {
const handler = this.getHandler(req.serviceId, req.fnName, req.particleContext.particleId);
const handler = this.getHandler(
req.serviceId,
req.fnName,
req.particleContext.particleId,
);
if (handler === null) {
return null;
@ -73,6 +82,7 @@ export class JsServiceHost implements IJsServiceHost {
const result = await handler(req);
// Otherwise AVM might break
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (result.result === undefined) {
result.result = null;
}
@ -83,7 +93,11 @@ export class JsServiceHost implements IJsServiceHost {
/**
* Register handler for all particles
*/
registerGlobalHandler(serviceId: string, fnName: string, handler: GenericCallServiceHandler): void {
registerGlobalHandler(
serviceId: string,
fnName: string,
handler: GenericCallServiceHandler,
): void {
this.commonHandlers.set(serviceFnKey(serviceId, fnName), handler);
}
@ -97,6 +111,7 @@ export class JsServiceHost implements IJsServiceHost {
handler: GenericCallServiceHandler,
): void {
let psh = this.particleScopeHandlers.get(particleId);
if (psh === undefined) {
psh = new Map<string, GenericCallServiceHandler>();
this.particleScopeHandlers.set(particleId, psh);

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,9 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { PeerIdB58 } from '@fluencelabs/interfaces';
import type { SecurityTetraplet } from '@fluencelabs/avm';
import { JSONValue } from '../util/commonTypes.js';
import type { SecurityTetraplet } from "@fluencelabs/avm";
import type { PeerIdB58 } from "@fluencelabs/interfaces";
import { JSONArray, JSONValue } from "@fluencelabs/interfaces";
/**
* JS Service host a low level interface for managing pure javascript services.
@ -33,7 +34,11 @@ export interface IJsServiceHost {
* @param fnName Function name as specified in `call` air instruction
* @param particleId Particle ID
*/
getHandler(serviceId: string, fnName: string, particleId: string): GenericCallServiceHandler | null;
getHandler(
serviceId: string,
fnName: string,
particleId: string,
): GenericCallServiceHandler | null;
/**
* Execute service call for specified call service data
@ -43,7 +48,11 @@ export interface IJsServiceHost {
/**
* Register handler for all particles
*/
registerGlobalHandler(serviceId: string, fnName: string, handler: GenericCallServiceHandler): void;
registerGlobalHandler(
serviceId: string,
fnName: string,
handler: GenericCallServiceHandler,
): void;
/**
* Register handler which will be called only for particle with the specific id
@ -114,7 +123,7 @@ export interface CallServiceData {
/**
* Arguments as specified in `call` air instruction
*/
args: any[];
args: JSONArray;
/**
* Security Tetraplets received from AVM
@ -135,7 +144,9 @@ export type CallServiceResultType = JSONValue;
/**
* Generic call service handler
*/
export type GenericCallServiceHandler = (req: CallServiceData) => CallServiceResult | Promise<CallServiceResult>;
export type GenericCallServiceHandler = (
req: CallServiceData,
) => CallServiceResult | Promise<CallServiceResult>;
/**
* Represents the result of the `call` air instruction to be returned into AVM

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,25 +13,35 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FluencePeer } from '../jsPeer/FluencePeer.js';
import { IParticle } from '../particle/interfaces.js';
import { builtInServices } from '../services/builtins.js';
import { JSONArray } from "@fluencelabs/interfaces";
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import { IParticle } from "../particle/interfaces.js";
import { builtInServices } from "../services/builtins.js";
import {
CallServiceData,
CallServiceResult,
CallServiceResultType,
ParticleContext,
ResultCodes,
} from './interfaces.js';
} from "./interfaces.js";
export const doNothing = (..._args: Array<unknown>) => undefined;
export const doNothing = () => {
return undefined;
};
export const WrapFnIntoServiceCall =
(fn: (args: any[]) => CallServiceResultType) =>
(req: CallServiceData): CallServiceResult => ({
export const WrapFnIntoServiceCall = (
fn: (args: JSONArray) => CallServiceResultType | undefined,
) => {
return (req: CallServiceData): CallServiceResult => {
return {
retCode: ResultCodes.success,
result: fn(req.args),
});
result: fn(req.args) ?? null,
};
};
};
export class ServiceError extends Error {
constructor(message: string) {

View File

@ -15,11 +15,11 @@
*/
import bs58 from "bs58";
import { fromUint8Array, toUint8Array } from 'js-base64';
import { fromUint8Array, toUint8Array } from "js-base64";
import { it, describe, expect } from "vitest";
import { fromBase64Sk, KeyPair } from '../index.js';
import { Particle, serializeToString, buildParticleMessage } from '../../particle/Particle.js';
import { Particle, buildParticleMessage } from "../../particle/Particle.js";
import { fromBase64Sk, KeyPair } from "../index.js";
const key = "+cmeYlZKj+MfSa9dpHV+BmLPm6wq4inGlsPlQ1GvtPk=";
const keyBytes = toUint8Array(key);
@ -27,8 +27,9 @@ const keyBytes = toUint8Array(key);
const testData = Uint8Array.from([1, 2, 3, 4, 5, 6, 7, 9, 10]);
const testDataSig = Uint8Array.from([
224, 104, 245, 206, 140, 248, 27, 72, 68, 133, 111, 10, 164, 197, 242, 132, 107, 77, 224, 67, 99, 106, 76, 29, 144,
121, 122, 169, 36, 173, 58, 80, 170, 102, 137, 253, 157, 247, 168, 87, 162, 223, 188, 214, 203, 220, 52, 246, 29,
224, 104, 245, 206, 140, 248, 27, 72, 68, 133, 111, 10, 164, 197, 242, 132,
107, 77, 224, 67, 99, 106, 76, 29, 144, 121, 122, 169, 36, 173, 58, 80, 170,
102, 137, 253, 157, 247, 168, 87, 162, 223, 188, 214, 203, 220, 52, 246, 29,
86, 77, 71, 224, 248, 16, 213, 254, 75, 78, 239, 243, 222, 241, 15,
]);
@ -112,24 +113,49 @@ describe("KeyPair tests", () => {
});
it("validates particle signature checks", async function () {
const keyPair = await fromBase64Sk("7h48PQ/f1rS9TxacmgODxbD42Il9B3KC117jvOPppPE=");
expect(bs58.encode(keyPair.getLibp2pPeerId().toBytes())).toBe("12D3KooWANqfCDrV79MZdMnMqTvDdqSAPSxdgFY1L6DCq2DVGB4D");
const keyPair = await fromBase64Sk(
"7h48PQ/f1rS9TxacmgODxbD42Il9B3KC117jvOPppPE=",
);
expect(bs58.encode(keyPair.getLibp2pPeerId().toBytes())).toBe(
"12D3KooWANqfCDrV79MZdMnMqTvDdqSAPSxdgFY1L6DCq2DVGB4D",
);
const message = toUint8Array(btoa("message"));
const signature = await keyPair.signBytes(message);
const verified = await keyPair.verify(message, signature);
expect(verified).toBe(true);
expect(fromUint8Array(signature)).toBe("sBW7H6/1fwAwF86ldwVm9BDu0YH3w30oFQjTWX0Tiu9yTVZHmxkV2OX4GL5jn0Iz0CrasGcOfozzkZwtJBPMBg==");
const particle = await Particle.createNew("abc", keyPair.getPeerId(), 7000, keyPair, "2883f959-e9e7-4843-8c37-205d393ca372", 1696934545662);
expect(fromUint8Array(signature)).toBe(
"sBW7H6/1fwAwF86ldwVm9BDu0YH3w30oFQjTWX0Tiu9yTVZHmxkV2OX4GL5jn0Iz0CrasGcOfozzkZwtJBPMBg==",
);
const particle = await Particle.createNew(
"abc",
keyPair.getPeerId(),
7000,
keyPair,
"2883f959-e9e7-4843-8c37-205d393ca372",
1696934545662,
);
const particle_bytes = buildParticleMessage(particle);
expect(fromUint8Array(particle_bytes)).toBe("Mjg4M2Y5NTktZTllNy00ODQzLThjMzctMjA1ZDM5M2NhMzcy/kguGYsBAABYGwAAYWJj");
const isParticleVerified = await KeyPair.verifyWithPublicKey(keyPair.getPublicKey(), particle_bytes, particle.signature);
expect(fromUint8Array(particle_bytes)).toBe(
"Mjg4M2Y5NTktZTllNy00ODQzLThjMzctMjA1ZDM5M2NhMzcy/kguGYsBAABYGwAAYWJj",
);
const isParticleVerified = await KeyPair.verifyWithPublicKey(
keyPair.getPublicKey(),
particle_bytes,
particle.signature,
);
expect(isParticleVerified).toBe(true);
expect(fromUint8Array(particle.signature)).toBe("KceXDnOfqe0dOnAxiDsyWBIvUq6WHoT0ge+VMHXOZsjZvCNH7/10oufdlYfcPomfv28On6E87ZhDcHGBZcb7Bw==");
expect(fromUint8Array(particle.signature)).toBe(
"KceXDnOfqe0dOnAxiDsyWBIvUq6WHoT0ge+VMHXOZsjZvCNH7/10oufdlYfcPomfv28On6E87ZhDcHGBZcb7Bw==",
);
});
});

View File

@ -1,31 +1,55 @@
import { it, describe, expect, beforeAll } from 'vitest';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as fs from 'fs';
import * as url from 'url';
import * as path from 'path';
import { compileAqua, withPeer } from '../../util/testUtils.js';
import * as fs from "fs";
import * as path from "path";
import * as url from "url";
let aqua: any;
const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
import { it, describe, expect, beforeAll } from "vitest";
describe('Marine js tests', () => {
import { compileAqua, CompiledFnCall, withPeer } from "../../util/testUtils.js";
let aqua: Record<string, CompiledFnCall>;
const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
describe("Marine js tests", () => {
beforeAll(async () => {
const pathToAquaFiles = path.join(__dirname, '../../../aqua_test/marine-js.aqua');
const { services, functions } = await compileAqua(pathToAquaFiles);
const pathToAquaFiles = path.join(
__dirname,
"../../../aqua_test/marine-js.aqua",
);
const { functions } = await compileAqua(pathToAquaFiles);
aqua = functions;
});
it('should call marine service correctly', async () => {
it("should call marine service correctly", async () => {
await withPeer(async (peer) => {
// arrange
const wasm = await fs.promises.readFile(path.join(__dirname, '../../../data_for_test/greeting.wasm'));
await peer.registerMarineService(wasm, 'greeting');
const wasm = await fs.promises.readFile(
path.join(__dirname, "../../../data_for_test/greeting.wasm"),
);
await peer.registerMarineService(wasm, "greeting");
// act
const res = await aqua.call(peer, { arg: 'test' });
const res = await aqua["call"](peer, { arg: "test" });
// assert
expect(res).toBe('Hi, Hi, Hi, test');
expect(res).toBe("Hi, Hi, Hi, test");
});
});
});

View File

@ -1,40 +0,0 @@
/*
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// @ts-ignore
import { BlobWorker } from 'threads';
import { fromBase64, toUint8Array } from 'js-base64';
// @ts-ignore
import type { WorkerImplementation } from 'threads/dist/types/master';
import { Buffer } from 'buffer';
import { LazyLoader } from '../interfaces.js';
export class InlinedWorkerLoader extends LazyLoader<WorkerImplementation> {
constructor(b64script: string) {
super(() => {
const script = fromBase64(b64script);
return BlobWorker.fromText(script);
});
}
}
export class InlinedWasmLoader extends LazyLoader<Buffer> {
constructor(b64wasm: string) {
super(() => {
const wasm = toUint8Array(b64wasm);
return Buffer.from(wasm);
});
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,16 +13,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { createRequire } from 'module';
// @ts-ignore
import type { WorkerImplementation } from 'threads/dist/types/master';
// @ts-ignore
import { Worker } from 'threads';
import { Buffer } from 'buffer';
import * as fs from 'fs';
import * as path from 'path';
import { LazyLoader } from '../interfaces.js';
import { Buffer } from "buffer";
import fs from "fs";
import { createRequire } from "module";
import path from "path";
import { Worker, type Worker as WorkerImplementation } from "threads/master";
import { LazyLoader } from "../interfaces.js";
const require = createRequire(import.meta.url);
@ -39,7 +38,10 @@ const bufferToSharedArrayBuffer = (buffer: Buffer): SharedArrayBuffer => {
* @param source - object specifying the source of the file. Consist two fields: package name and file path.
* @returns SharedArrayBuffer with the wasm file
*/
export const loadWasmFromNpmPackage = async (source: { package: string; file: string }): Promise<SharedArrayBuffer> => {
export const loadWasmFromNpmPackage = async (source: {
package: string;
file: string;
}): Promise<SharedArrayBuffer> => {
const packagePath = require.resolve(source.package);
const filePath = path.join(path.dirname(packagePath), source.file);
return loadWasmFromFileSystem(filePath);
@ -51,26 +53,34 @@ export const loadWasmFromNpmPackage = async (source: { package: string; file: st
* @param filePath - path to the wasm file
* @returns SharedArrayBuffer with the wasm fileWorker
*/
export const loadWasmFromFileSystem = async (filePath: string): Promise<SharedArrayBuffer> => {
export const loadWasmFromFileSystem = async (
filePath: string,
): Promise<SharedArrayBuffer> => {
const buffer = await fs.promises.readFile(filePath);
return bufferToSharedArrayBuffer(buffer);
};
export class WasmLoaderFromFs extends LazyLoader<SharedArrayBuffer> {
constructor(filePath: string) {
super(() => loadWasmFromFileSystem(filePath));
super(() => {
return loadWasmFromFileSystem(filePath);
});
}
}
export class WasmLoaderFromNpm extends LazyLoader<SharedArrayBuffer> {
constructor(pkg: string, file: string) {
super(() => loadWasmFromNpmPackage({ package: pkg, file: file }));
super(() => {
return loadWasmFromNpmPackage({ package: pkg, file: file });
});
}
}
export class WorkerLoaderFromFs extends LazyLoader<WorkerImplementation> {
constructor(scriptPath: string) {
super(() => new Worker(scriptPath));
super(() => {
return new Worker(scriptPath);
});
}
}

View File

@ -1,63 +0,0 @@
/*
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Buffer } from 'buffer';
import { LazyLoader } from '../interfaces.js';
// @ts-ignore
import type { WorkerImplementation } from 'threads/dist/types/master';
const bufferToSharedArrayBuffer = (buffer: Buffer): SharedArrayBuffer => {
const sab = new SharedArrayBuffer(buffer.length);
const tmp = new Uint8Array(sab);
tmp.set(buffer, 0);
return sab;
};
/**
* Load wasm file from the server. Only works in browsers.
* The function will try load file into SharedArrayBuffer if the site is cross-origin isolated.
* Otherwise the return value fallbacks to Buffer which is less performant but is still compatible with FluenceAppService methods.
* We strongly recommend to set-up cross-origin headers. For more details see: See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements
* Filename is relative to current origin.
* @param filePath - path to the wasm file relative to current origin
* @returns Either SharedArrayBuffer or Buffer with the wasm file
*/
export const loadWasmFromUrl = async (filePath: string): Promise<SharedArrayBuffer | Buffer> => {
const fullUrl = window.location.origin + '/' + filePath;
const res = await fetch(fullUrl);
const ab = await res.arrayBuffer();
new Uint8Array(ab);
const buffer = Buffer.from(ab);
// only convert to shared buffers if necessary CORS headers have been set:
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements
if (crossOriginIsolated) {
return bufferToSharedArrayBuffer(buffer);
}
return buffer;
};
export class WasmLoaderFromUrl extends LazyLoader<SharedArrayBuffer | Buffer> {
constructor(filePath: string) {
super(() => loadWasmFromUrl(filePath));
}
}
export class WorkerLoaderFromUrl extends LazyLoader<WorkerImplementation> {
constructor(scriptPath: string) {
super(() => new Worker(scriptPath));
}
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,10 +13,16 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CallResultsArray, InterpreterResult, RunParameters } from '@fluencelabs/avm';
import { IStartable, JSONArray, JSONObject, CallParameters } from '../util/commonTypes.js';
// @ts-ignore
import type { WorkerImplementation } from 'threads/dist/types/master';
import {
CallResultsArray,
InterpreterResult,
RunParameters,
} from "@fluencelabs/avm";
import { JSONObject, JSONValue, JSONArray } from "@fluencelabs/interfaces";
import type { Worker as WorkerImplementation } from "threads/master";
import { IStartable, CallParameters } from "../util/commonTypes.js";
/**
* Contract for marine host implementations. Marine host is responsible for creating calling and removing marine services
@ -25,7 +31,10 @@ export interface IMarineHost extends IStartable {
/**
* Creates marine service from the given module and service id
*/
createService(serviceModule: ArrayBuffer | SharedArrayBuffer, serviceId: string): Promise<void>;
createService(
serviceModule: ArrayBuffer | SharedArrayBuffer,
serviceId: string,
): Promise<void>;
/**
* Removes marine service with the given service id
@ -45,7 +54,7 @@ export interface IMarineHost extends IStartable {
functionName: string,
args: JSONArray | JSONObject,
callParams: CallParameters,
): Promise<unknown>;
): Promise<JSONValue>;
}
/**
@ -74,12 +83,16 @@ export interface IValueLoader<T> {
/**
* Interface for something which can load wasm files
*/
export interface IWasmLoader extends IValueLoader<ArrayBuffer | SharedArrayBuffer>, IStartable {}
export interface IWasmLoader
extends IValueLoader<ArrayBuffer | SharedArrayBuffer>,
IStartable {}
/**
* Interface for something which can thread.js based worker
*/
export interface IWorkerLoader extends IValueLoader<WorkerImplementation>, IStartable {}
export interface IWorkerLoader
extends IValueLoader<WorkerImplementation | Promise<WorkerImplementation>>,
IStartable {}
/**
* Lazy loader for some value. Value is loaded only when `start` method is called
@ -91,7 +104,9 @@ export class LazyLoader<T> implements IStartable, IValueLoader<T> {
getValue(): T {
if (this.value == null) {
throw new Error('Value has not been loaded. Call `start` method to load the value.');
throw new Error(
"Value has not been loaded. Call `start` method to load the value.",
);
}
return this.value;

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,14 +13,17 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// @ts-ignore
import type { WorkerImplementation } from 'threads/dist/types/master';
// @ts-ignore
import { Worker } from 'threads';
import { LazyLoader } from '../interfaces.js';
import { Worker, type Worker as WorkerImplementation } from "threads/master";
import { LazyLoader } from "../interfaces.js";
export class WorkerLoader extends LazyLoader<WorkerImplementation> {
constructor() {
super(() => new Worker('../../../node_modules/@fluencelabs/marine-worker/dist/index.js'));
super(() => {
return new Worker(
"../../../node_modules/@fluencelabs/marine-worker/dist/index.js",
);
});
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2022 Fluence Labs Limited
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -14,41 +14,49 @@
* limitations under the License.
*/
import type { JSONArray, JSONObject, CallParameters } from '@fluencelabs/marine-js/dist/types';
import { LogFunction, logLevelToEnv } from '@fluencelabs/marine-js/dist/types';
import type { MarineBackgroundInterface } from '@fluencelabs/marine-worker';
// @ts-ignore
import { ModuleThread, spawn, Thread } from 'threads';
import { JSONValue } from "@fluencelabs/interfaces";
import type {
JSONArray,
JSONObject,
CallParameters,
} from "@fluencelabs/marine-js/dist/types";
import { LogFunction, logLevelToEnv } from "@fluencelabs/marine-js/dist/types";
import type { MarineBackgroundInterface } from "@fluencelabs/marine-worker";
import { ModuleThread, Thread, spawn } from "threads/master";
import { MarineLogger, marineLogger } from '../../util/logger.js';
import { IMarineHost, IWasmLoader, IWorkerLoader } from '../interfaces.js';
import { MarineLogger, marineLogger } from "../../util/logger.js";
import { IMarineHost, IWasmLoader, IWorkerLoader } from "../interfaces.js";
export class MarineBackgroundRunner implements IMarineHost {
private workerThread?: MarineBackgroundInterface;
private workerThread?: ModuleThread<MarineBackgroundInterface>;
private loggers = new Map<string, MarineLogger>();
constructor(private workerLoader: IWorkerLoader, private controlModuleLoader: IWasmLoader, private avmWasmLoader: IWasmLoader) {}
constructor(
private workerLoader: IWorkerLoader,
private controlModuleLoader: IWasmLoader,
private avmWasmLoader: IWasmLoader,
) {}
async hasService(serviceId: string) {
if (!this.workerThread) {
throw new Error('Worker is not initialized');
if (this.workerThread == null) {
throw new Error("Worker is not initialized");
}
return this.workerThread.hasService(serviceId);
}
async removeService(serviceId: string) {
if (!this.workerThread) {
throw new Error('Worker is not initialized');
if (this.workerThread == null) {
throw new Error("Worker is not initialized");
}
await this.workerThread.removeService(serviceId);
}
async start(): Promise<void> {
if (this.workerThread) {
throw new Error('Worker thread already initialized');
if (this.workerThread != null) {
throw new Error("Worker thread already initialized");
}
await this.controlModuleLoader.start();
@ -59,28 +67,36 @@ export class MarineBackgroundRunner implements IMarineHost {
await this.workerLoader.start();
const worker = await this.workerLoader.getValue();
const workerThread = await spawn<MarineBackgroundInterface>(worker);
const workerThread: ModuleThread<MarineBackgroundInterface> =
await spawn<MarineBackgroundInterface>(worker);
const logfn: LogFunction = (message) => {
const serviceLogger = this.loggers.get(message.service);
if (!serviceLogger) {
if (serviceLogger == null) {
return;
}
serviceLogger[message.level](message.message);
};
workerThread.onLogMessage().subscribe(logfn);
await workerThread.init(wasm);
this.workerThread = workerThread;
await this.createService(this.avmWasmLoader.getValue(), 'avm');
await this.createService(this.avmWasmLoader.getValue(), "avm");
}
async createService(serviceModule: ArrayBuffer | SharedArrayBuffer, serviceId: string): Promise<void> {
if (!this.workerThread) {
throw new Error('Worker is not initialized');
async createService(
serviceModule: ArrayBuffer | SharedArrayBuffer,
serviceId: string,
): Promise<void> {
if (this.workerThread == null) {
throw new Error("Worker is not initialized");
}
// The logging level is controlled by the environment variable passed to enable debug logs.
// We enable all possible log levels passing the control for exact printouts to the logger
const env = logLevelToEnv('info');
const env = logLevelToEnv("info");
this.loggers.set(serviceId, marineLogger(serviceId));
await this.workerThread.createService(serviceModule, serviceId, env);
}
@ -90,16 +106,21 @@ export class MarineBackgroundRunner implements IMarineHost {
functionName: string,
args: JSONArray | JSONObject,
callParams: CallParameters,
): Promise<unknown> {
if (!this.workerThread) {
throw 'Worker is not initialized';
): Promise<JSONValue> {
if (this.workerThread == null) {
throw new Error("Worker is not initialized");
}
return this.workerThread.callService(serviceId, functionName, args, callParams);
return this.workerThread.callService(
serviceId,
functionName,
args,
callParams,
);
}
async stop(): Promise<void> {
if (!this.workerThread) {
if (this.workerThread == null) {
return;
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2020 Fluence Labs Limited
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -18,21 +18,32 @@ import { CallResultsArray } from "@fluencelabs/avm";
import { fromUint8Array, toUint8Array } from "js-base64";
import { concat } from "uint8arrays/concat";
import { v4 as uuidv4 } from "uuid";
import { z } from "zod";
import { KeyPair } from "../keypair/index.js";
import { numberToLittleEndianBytes } from "../util/bytes.js";
import { IParticle } from "./interfaces.js";
const particleSchema = z.object({
id: z.string(),
timestamp: z.number().positive(),
script: z.string(),
data: z.string(),
ttl: z.number().positive(),
init_peer_id: z.string(),
signature: z.array(z.number()),
});
export class Particle implements IParticle {
constructor(
public readonly id: string,
public readonly timestamp: number,
public readonly script: string,
public readonly data: Uint8Array,
public readonly ttl: number,
public readonly initPeerId: string,
public readonly signature: Uint8Array
readonly id: string,
readonly timestamp: number,
readonly script: string,
readonly data: Uint8Array,
readonly ttl: number,
readonly initPeerId: string,
readonly signature: Uint8Array,
) {}
static async createNew(
@ -62,17 +73,28 @@ export class Particle implements IParticle {
static fromString(str: string): Particle {
const json = JSON.parse(str);
const res = new Particle(
json.id,
json.timestamp,
json.script,
toUint8Array(json.data),
json.ttl,
json.init_peer_id,
new Uint8Array(json.signature)
);
return res;
const res = particleSchema.safeParse(json);
if (!res.success) {
throw new Error(
`Particle format invalid. Errors: ${JSON.stringify(
res.error.flatten(),
)}`,
);
}
const data = res.data;
return new Particle(
data.id,
data.timestamp,
data.script,
toUint8Array(data.data),
data.ttl,
data.init_peer_id,
new Uint8Array(data.signature),
);
}
}
@ -109,16 +131,6 @@ export const hasExpired = (particle: IParticle): boolean => {
return getActualTTL(particle) <= 0;
};
/**
* Validates that particle signature is correct
*/
export const verifySignature = async (particle: IParticle, publicKey: Uint8Array): Promise<boolean> => {
// TODO: Uncomment this when nox roll out particle signatures
return true;
// const message = buildParticleMessage(particle);
// return unmarshalPublicKey(publicKey).verify(message, particle.signature);
}
/**
* Creates a particle clone with new data
*/
@ -182,5 +194,5 @@ export const handleTimeout = (fn: () => void) => {
if (stage.stage === "expired") {
fn();
}
}
}
};
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,7 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { PeerIdB58 } from '@fluencelabs/interfaces';
import { PeerIdB58 } from "@fluencelabs/interfaces";
/**
* Immutable part of the particle.

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,26 +14,30 @@
* limitations under the License.
*/
import { CallParams, IFluenceInternalApi } from '@fluencelabs/interfaces';
import { defaultGuard } from './SingleModuleSrv.js';
import { NodeUtilsDef, registerNodeUtils } from './_aqua/node-utils.js';
import { SecurityGuard } from './securityGuard.js';
import * as fs from 'fs';
import { FluencePeer } from '../jsPeer/FluencePeer.js';
import { Buffer } from 'buffer';
import { Buffer } from "buffer";
import * as fs from "fs";
import { CallParams } from "@fluencelabs/interfaces";
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import { getErrorMessage } from "../util/utils.js";
import { NodeUtilsDef, registerNodeUtils } from "./_aqua/node-utils.js";
import { SecurityGuard } from "./securityGuard.js";
import { defaultGuard } from "./SingleModuleSrv.js";
export class NodeUtils implements NodeUtilsDef {
constructor(private peer: FluencePeer) {
this.securityGuard_readFile = defaultGuard(this.peer);
}
securityGuard_readFile: SecurityGuard<'path'>;
securityGuard_readFile: SecurityGuard<"path">;
async read_file(path: string, callParams: CallParams<'path'>) {
async read_file(path: string, callParams: CallParams<"path">) {
if (!this.securityGuard_readFile(callParams)) {
return {
success: false,
error: 'Security guard validation failed',
error: "Security guard validation failed",
content: null,
};
}
@ -42,22 +46,26 @@ export class NodeUtils implements NodeUtilsDef {
// Strange enough, but Buffer type works here, while reading with encoding 'utf-8' doesn't
const data = await new Promise<Buffer>((resolve, reject) => {
fs.readFile(path, (err, data) => {
if (err) {
if (err != null) {
reject(err);
return;
}
resolve(data);
})
});
});
return {
success: true,
// TODO: this is strange bug.
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
content: data as unknown as string,
error: null,
};
} catch (err: any) {
} catch (err: unknown) {
return {
success: false,
error: err.message,
error: getErrorMessage(err),
content: null,
};
}
@ -65,6 +73,6 @@ export class NodeUtils implements NodeUtilsDef {
}
// HACK:: security guard functions must be ported to user API
export const doRegisterNodeUtils = (peer: any) => {
registerNodeUtils(peer, 'node_utils', new NodeUtils(peer));
export const doRegisterNodeUtils = (peer: FluencePeer) => {
registerNodeUtils(peer, "node_utils", new NodeUtils(peer));
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,33 +14,52 @@
* limitations under the License.
*/
import { CallParams, PeerIdB58 } from '@fluencelabs/interfaces';
import { KeyPair } from '../keypair/index.js';
import { FluencePeer } from '../jsPeer/FluencePeer.js';
import { SigDef } from './_aqua/services.js';
import { allowOnlyParticleOriginatedAt, allowServiceFn, and, or, SecurityGuard } from './securityGuard.js';
import { CallParams, PeerIdB58 } from "@fluencelabs/interfaces";
import { KeyPair } from "../keypair/index.js";
import { SigDef } from "./_aqua/services.js";
import {
allowOnlyParticleOriginatedAt,
allowServiceFn,
and,
or,
SecurityGuard,
} from "./securityGuard.js";
export const defaultSigGuard = (peerId: PeerIdB58) => {
return and<'data'>(
return and<"data">(
allowOnlyParticleOriginatedAt(peerId),
or(
allowServiceFn('trust-graph', 'get_trust_bytes'),
allowServiceFn('trust-graph', 'get_revocation_bytes'),
allowServiceFn('registry', 'get_key_bytes'),
allowServiceFn('registry', 'get_record_bytes'),
allowServiceFn('registry', 'get_record_metadata_bytes'),
allowServiceFn('registry', 'get_tombstone_bytes'),
allowServiceFn("trust-graph", "get_trust_bytes"),
allowServiceFn("trust-graph", "get_revocation_bytes"),
allowServiceFn("registry", "get_key_bytes"),
allowServiceFn("registry", "get_record_bytes"),
allowServiceFn("registry", "get_record_metadata_bytes"),
allowServiceFn("registry", "get_tombstone_bytes"),
),
);
};
type SignReturnType =
| {
error: null;
signature: number[];
success: true;
}
| {
error: string;
signature: null;
success: false;
};
export class Sig implements SigDef {
constructor(private keyPair: KeyPair) {}
/**
* Configurable security guard for sign method
*/
securityGuard: SecurityGuard<'data'> = (params) => {
securityGuard: SecurityGuard<"data"> = () => {
return true;
};
@ -56,12 +75,12 @@ export class Sig implements SigDef {
*/
async sign(
data: number[],
callParams: CallParams<'data'>,
): Promise<{ error: string | null; signature: number[] | null; success: boolean }> {
callParams: CallParams<"data">,
): Promise<SignReturnType> {
if (!this.securityGuard(callParams)) {
return {
success: false,
error: 'Security guard validation failed',
error: "Security guard validation failed",
signature: null,
};
}
@ -79,10 +98,9 @@ export class Sig implements SigDef {
* Verifies the signature. Required by aqua
*/
verify(signature: number[], data: number[]): Promise<boolean> {
return this.keyPair.verify(Uint8Array.from(data), Uint8Array.from(signature))
return this.keyPair.verify(
Uint8Array.from(data),
Uint8Array.from(signature),
);
}
}
export const getDefaultSig = (peer: FluencePeer) => {
peer.registerMarineService;
};

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,15 +14,22 @@
* limitations under the License.
*/
import { v4 as uuidv4 } from 'uuid';
import { SrvDef } from './_aqua/single-module-srv.js';
import { FluencePeer } from '../jsPeer/FluencePeer.js';
import { CallParams } from '@fluencelabs/interfaces';
import { Buffer } from 'buffer';
import { allowOnlyParticleOriginatedAt, SecurityGuard } from './securityGuard.js';
import { Buffer } from "buffer";
import { CallParams } from "@fluencelabs/interfaces";
import { v4 as uuidv4 } from "uuid";
import { FluencePeer } from "../jsPeer/FluencePeer.js";
import { getErrorMessage } from "../util/utils.js";
import { SrvDef } from "./_aqua/single-module-srv.js";
import {
allowOnlyParticleOriginatedAt,
SecurityGuard,
} from "./securityGuard.js";
export const defaultGuard = (peer: FluencePeer) => {
return allowOnlyParticleOriginatedAt<any>(peer.keyPair.getPeerId());
return allowOnlyParticleOriginatedAt(peer.keyPair.getPeerId());
};
export class Srv implements SrvDef {
@ -33,20 +40,23 @@ export class Srv implements SrvDef {
this.securityGuard_remove = defaultGuard(this.peer);
}
securityGuard_create: SecurityGuard<'wasm_b64_content'>;
securityGuard_create: SecurityGuard<"wasm_b64_content">;
async create(wasm_b64_content: string, callParams: CallParams<'wasm_b64_content'>) {
async create(
wasm_b64_content: string,
callParams: CallParams<"wasm_b64_content">,
) {
if (!this.securityGuard_create(callParams)) {
return {
success: false,
error: 'Security guard validation failed',
error: "Security guard validation failed",
service_id: null,
};
}
try {
const newServiceId = uuidv4();
const buffer = Buffer.from(wasm_b64_content, 'base64');
const buffer = Buffer.from(wasm_b64_content, "base64");
// TODO:: figure out why SharedArrayBuffer is not working here
// const sab = new SharedArrayBuffer(buffer.length);
// const tmp = new Uint8Array(sab);
@ -59,22 +69,22 @@ export class Srv implements SrvDef {
service_id: newServiceId,
error: null,
};
} catch (err: any) {
} catch (err: unknown) {
return {
success: true,
service_id: null,
error: err.message,
error: getErrorMessage(err),
};
}
}
securityGuard_remove: SecurityGuard<'service_id'>;
securityGuard_remove: SecurityGuard<"service_id">;
async remove(service_id: string, callParams: CallParams<'service_id'>) {
async remove(service_id: string, callParams: CallParams<"service_id">) {
if (!this.securityGuard_remove(callParams)) {
return {
success: false,
error: 'Security guard validation failed',
error: "Security guard validation failed",
service_id: null,
};
}

View File

@ -1,4 +1,4 @@
/*
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,11 +14,18 @@
* limitations under the License.
*/
import { CallParams } from '@fluencelabs/interfaces';
import { TracingDef } from './_aqua/tracing.js';
import { CallParams } from "@fluencelabs/interfaces";
import { TracingDef } from "./_aqua/tracing.js";
export class Tracing implements TracingDef {
tracingEvent(arrowName: string, event: string, callParams: CallParams<'arrowName' | 'event'>): void {
console.log('[%s] (%s) %s', callParams.particleId, arrowName, event);
tracingEvent(
arrowName: string,
event: string,
callParams: CallParams<"arrowName" | "event">,
): void {
// This console log is intentional
// eslint-disable-next-line no-console
console.log("[%s] (%s) %s", callParams.particleId, arrowName, event);
}
}

View File

@ -1,12 +1,30 @@
import { it, describe, expect, test } from 'vitest';
/**
* Copyright 2023 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CallParams } from '@fluencelabs/interfaces';
import { toUint8Array } from 'js-base64';
import { KeyPair } from '../../keypair/index.js';
import { Sig, defaultSigGuard } from '../Sig.js';
import { allowServiceFn } from '../securityGuard.js';
import { builtInServices } from '../builtins.js';
import { CallServiceData } from '../../jsServiceHost/interfaces.js';
import assert from "assert";
import { CallParams, JSONArray } from "@fluencelabs/interfaces";
import { toUint8Array } from "js-base64";
import { it, describe, expect, test } from "vitest";
import { CallServiceData } from "../../jsServiceHost/interfaces.js";
import { KeyPair } from "../../keypair/index.js";
import { builtInServices } from "../builtins.js";
import { allowServiceFn } from "../securityGuard.js";
import { Sig, defaultSigGuard } from "../Sig.js";
const a10b20 = `{
"a": 10,
@ -20,97 +38,105 @@ const oneTwoThreeFour = `[
4
]`;
describe('Tests for default handler', () => {
interface ServiceCallType {
serviceId: string;
fnName: string;
args: JSONArray;
retCode: 0 | 1;
result: unknown;
}
describe("Tests for default handler", () => {
test.each`
serviceId | fnName | args | retCode | result
${'op'} | ${'identity'} | ${[]} | ${0} | ${{}}
${'op'} | ${'identity'} | ${[1]} | ${0} | ${1}
${'op'} | ${'identity'} | ${[1, 2]} | ${1} | ${'identity accepts up to 1 arguments, received 2 arguments'}
${'op'} | ${'noop'} | ${[1, 2]} | ${0} | ${{}}
${'op'} | ${'array'} | ${[1, 2, 3]} | ${0} | ${[1, 2, 3]}
${'op'} | ${'array_length'} | ${[[1, 2, 3]]} | ${0} | ${3}
${'op'} | ${'array_length'} | ${[]} | ${1} | ${'array_length accepts exactly one argument, found: 0'}
${'op'} | ${'concat'} | ${[[1, 2], [3, 4], [5, 6]]} | ${0} | ${[1, 2, 3, 4, 5, 6]}
${'op'} | ${'concat'} | ${[[1, 2]]} | ${0} | ${[1, 2]}
${'op'} | ${'concat'} | ${[]} | ${0} | ${[]}
${'op'} | ${'concat'} | ${[1, [1, 2], 1]} | ${1} | ${"All arguments of 'concat' must be arrays: arguments 0, 2 are not"}
${'op'} | ${'string_to_b58'} | ${['test']} | ${0} | ${'3yZe7d'}
${'op'} | ${'string_to_b58'} | ${['test', 1]} | ${1} | ${'string_to_b58 accepts only one string argument'}
${'op'} | ${'string_from_b58'} | ${['3yZe7d']} | ${0} | ${'test'}
${'op'} | ${'string_from_b58'} | ${['3yZe7d', 1]} | ${1} | ${'string_from_b58 accepts only one string argument'}
${'op'} | ${'bytes_to_b58'} | ${[[116, 101, 115, 116]]} | ${0} | ${'3yZe7d'}
${'op'} | ${'bytes_to_b58'} | ${[[116, 101, 115, 116], 1]} | ${1} | ${'bytes_to_b58 accepts only single argument: array of numbers'}
${'op'} | ${'bytes_from_b58'} | ${['3yZe7d']} | ${0} | ${[116, 101, 115, 116]}
${'op'} | ${'bytes_from_b58'} | ${['3yZe7d', 1]} | ${1} | ${'bytes_from_b58 accepts only one string argument'}
${'op'} | ${'sha256_string'} | ${['hello, world!']} | ${0} | ${'QmVQ8pg6L1tpoWYeq6dpoWqnzZoSLCh7E96fCFXKvfKD3u'}
${'op'} | ${'sha256_string'} | ${['hello, world!', true]} | ${0} | ${'84V7ZxLW7qKsx1Qvbd63BdGaHxUc3TfT2MBPqAXM7Wyu'}
${'op'} | ${'sha256_string'} | ${[]} | ${1} | ${'sha256_string accepts 1-3 arguments, found: 0'}
${'op'} | ${'concat_strings'} | ${[]} | ${0} | ${''}
${'op'} | ${'concat_strings'} | ${['a', 'b', 'c']} | ${0} | ${'abc'}
${'peer'} | ${'timeout'} | ${[200, []]} | ${0} | ${[]}
${'peer'} | ${'timeout'} | ${[200, ['test']]} | ${0} | ${['test']}
${'peer'} | ${'timeout'} | ${[]} | ${1} | ${'timeout accepts exactly two arguments: timeout duration in ms and a message string'}
${'peer'} | ${'timeout'} | ${[200, 'test', 1]} | ${1} | ${'timeout accepts exactly two arguments: timeout duration in ms and a message string'}
${'debug'} | ${'stringify'} | ${[]} | ${0} | ${'"<empty argument list>"'}
${'debug'} | ${'stringify'} | ${[{ a: 10, b: 20 }]} | ${0} | ${a10b20}
${'debug'} | ${'stringify'} | ${[1, 2, 3, 4]} | ${0} | ${oneTwoThreeFour}
${'math'} | ${'add'} | ${[2, 2]} | ${0} | ${4}
${'math'} | ${'add'} | ${[2]} | ${1} | ${'Expected 2 argument(s). Got 1'}
${'math'} | ${'sub'} | ${[2, 2]} | ${0} | ${0}
${'math'} | ${'sub'} | ${[2, 3]} | ${0} | ${-1}
${'math'} | ${'mul'} | ${[2, 2]} | ${0} | ${4}
${'math'} | ${'mul'} | ${[2, 0]} | ${0} | ${0}
${'math'} | ${'mul'} | ${[2, -1]} | ${0} | ${-2}
${'math'} | ${'fmul'} | ${[10, 0.66]} | ${0} | ${6}
${'math'} | ${'fmul'} | ${[0.5, 0.5]} | ${0} | ${0}
${'math'} | ${'fmul'} | ${[100.5, 0.5]} | ${0} | ${50}
${'math'} | ${'div'} | ${[2, 2]} | ${0} | ${1}
${'math'} | ${'div'} | ${[2, 3]} | ${0} | ${0}
${'math'} | ${'div'} | ${[10, 5]} | ${0} | ${2}
${'math'} | ${'rem'} | ${[10, 3]} | ${0} | ${1}
${'math'} | ${'pow'} | ${[2, 2]} | ${0} | ${4}
${'math'} | ${'pow'} | ${[2, 0]} | ${0} | ${1}
${'math'} | ${'log'} | ${[2, 2]} | ${0} | ${1}
${'math'} | ${'log'} | ${[2, 4]} | ${0} | ${2}
${'cmp'} | ${'gt'} | ${[2, 4]} | ${0} | ${false}
${'cmp'} | ${'gte'} | ${[2, 4]} | ${0} | ${false}
${'cmp'} | ${'gte'} | ${[4, 2]} | ${0} | ${true}
${'cmp'} | ${'gte'} | ${[2, 2]} | ${0} | ${true}
${'cmp'} | ${'lt'} | ${[2, 4]} | ${0} | ${true}
${'cmp'} | ${'lte'} | ${[2, 4]} | ${0} | ${true}
${'cmp'} | ${'lte'} | ${[4, 2]} | ${0} | ${false}
${'cmp'} | ${'lte'} | ${[2, 2]} | ${0} | ${true}
${'cmp'} | ${'cmp'} | ${[2, 4]} | ${0} | ${-1}
${'cmp'} | ${'cmp'} | ${[2, -4]} | ${0} | ${1}
${'cmp'} | ${'cmp'} | ${[2, 2]} | ${0} | ${0}
${'array'} | ${'sum'} | ${[[1, 2, 3]]} | ${0} | ${6}
${'array'} | ${'dedup'} | ${[['a', 'a', 'b', 'c', 'a', 'b', 'c']]} | ${0} | ${['a', 'b', 'c']}
${'array'} | ${'intersect'} | ${[['a', 'b', 'c'], ['c', 'b', 'd']]} | ${0} | ${['b', 'c']}
${'array'} | ${'diff'} | ${[['a', 'b', 'c'], ['c', 'b', 'd']]} | ${0} | ${['a']}
${'array'} | ${'sdiff'} | ${[['a', 'b', 'c'], ['c', 'b', 'd']]} | ${0} | ${['a', 'd']}
${'json'} | ${'obj'} | ${['a', 10, 'b', 'string', 'c', null]} | ${0} | ${{ a: 10, b: 'string', c: null }}
${'json'} | ${'obj'} | ${['a', 10, 'b', 'string', 'c']} | ${1} | ${'Expected even number of argument(s). Got 5'}
${'json'} | ${'obj'} | ${[]} | ${0} | ${{}}
${'json'} | ${'put'} | ${[{}, 'a', 10]} | ${0} | ${{ a: 10 }}
${'json'} | ${'put'} | ${[{ b: 11 }, 'a', 10]} | ${0} | ${{ a: 10, b: 11 }}
${'json'} | ${'put'} | ${['a', 'a', 11]} | ${1} | ${'Argument 0 expected to be of type object, Got string'}
${'json'} | ${'put'} | ${[{}, 'a', 10, 'b', 20]} | ${1} | ${'Expected 3 argument(s). Got 5'}
${'json'} | ${'put'} | ${[{}]} | ${1} | ${'Expected 3 argument(s). Got 1'}
${'json'} | ${'puts'} | ${[{}, 'a', 10]} | ${0} | ${{ a: 10 }}
${'json'} | ${'puts'} | ${[{ b: 11 }, 'a', 10]} | ${0} | ${{ a: 10, b: 11 }}
${'json'} | ${'puts'} | ${[{}, 'a', 10, 'b', 'string', 'c', null]} | ${0} | ${{ a: 10, b: 'string', c: null }}
${'json'} | ${'puts'} | ${[{ x: 'text' }, 'a', 10, 'b', 'string']} | ${0} | ${{ a: 10, b: 'string', x: 'text' }}
${'json'} | ${'puts'} | ${[{}]} | ${1} | ${'Expected more than 3 argument(s). Got 1'}
${'json'} | ${'puts'} | ${['a', 'a', 11]} | ${1} | ${'Argument 0 expected to be of type object, Got string'}
${'json'} | ${'stringify'} | ${[{ a: 10, b: 'string', c: null }]} | ${0} | ${'{"a":10,"b":"string","c":null}'}
${'json'} | ${'stringify'} | ${[1]} | ${1} | ${'Argument 0 expected to be of type object, Got number'}
${'json'} | ${'parse'} | ${['{"a":10,"b":"string","c":null}']} | ${0} | ${{ a: 10, b: 'string', c: null }}
${'json'} | ${'parse'} | ${['incorrect']} | ${1} | ${'Unexpected token i in JSON at position 0'}
${'json'} | ${'parse'} | ${[10]} | ${1} | ${'Argument 0 expected to be of type string, Got number'}
${"op"} | ${"identity"} | ${[]} | ${0} | ${{}}
${"op"} | ${"identity"} | ${[1]} | ${0} | ${1}
${"op"} | ${"identity"} | ${[1, 2]} | ${1} | ${"identity accepts up to 1 arguments, received 2 arguments"}
${"op"} | ${"noop"} | ${[1, 2]} | ${0} | ${{}}
${"op"} | ${"array"} | ${[1, 2, 3]} | ${0} | ${[1, 2, 3]}
${"op"} | ${"array_length"} | ${[[1, 2, 3]]} | ${0} | ${3}
${"op"} | ${"array_length"} | ${[]} | ${1} | ${"array_length accepts exactly one argument, found: 0"}
${"op"} | ${"concat"} | ${[[1, 2], [3, 4], [5, 6]]} | ${0} | ${[1, 2, 3, 4, 5, 6]}
${"op"} | ${"concat"} | ${[[1, 2]]} | ${0} | ${[1, 2]}
${"op"} | ${"concat"} | ${[]} | ${0} | ${[]}
${"op"} | ${"concat"} | ${[1, [1, 2], 1]} | ${1} | ${"All arguments of 'concat' must be arrays: arguments 0, 2 are not"}
${"op"} | ${"string_to_b58"} | ${["test"]} | ${0} | ${"3yZe7d"}
${"op"} | ${"string_to_b58"} | ${["test", 1]} | ${1} | ${"string_to_b58 accepts only one string argument"}
${"op"} | ${"string_from_b58"} | ${["3yZe7d"]} | ${0} | ${"test"}
${"op"} | ${"string_from_b58"} | ${["3yZe7d", 1]} | ${1} | ${"string_from_b58 accepts only one string argument"}
${"op"} | ${"bytes_to_b58"} | ${[[116, 101, 115, 116]]} | ${0} | ${"3yZe7d"}
${"op"} | ${"bytes_to_b58"} | ${[[116, 101, 115, 116], 1]} | ${1} | ${"bytes_to_b58 accepts only single argument: array of numbers"}
${"op"} | ${"bytes_from_b58"} | ${["3yZe7d"]} | ${0} | ${[116, 101, 115, 116]}
${"op"} | ${"bytes_from_b58"} | ${["3yZe7d", 1]} | ${1} | ${"bytes_from_b58 accepts only one string argument"}
${"op"} | ${"sha256_string"} | ${["hello, world!"]} | ${0} | ${"QmVQ8pg6L1tpoWYeq6dpoWqnzZoSLCh7E96fCFXKvfKD3u"}
${"op"} | ${"sha256_string"} | ${["hello, world!", true]} | ${1} | ${"sha256_string accepts 1 argument, found: 2"}
${"op"} | ${"sha256_string"} | ${[]} | ${1} | ${"sha256_string accepts 1 argument, found: 0"}
${"op"} | ${"concat_strings"} | ${[]} | ${0} | ${""}
${"op"} | ${"concat_strings"} | ${["a", "b", "c"]} | ${0} | ${"abc"}
${"peer"} | ${"timeout"} | ${[200, []]} | ${1} | ${"timeout accepts exactly two arguments: timeout duration in ms and a message string"}
${"peer"} | ${"timeout"} | ${[200, "test"]} | ${0} | ${"test"}
${"peer"} | ${"timeout"} | ${[]} | ${1} | ${"timeout accepts exactly two arguments: timeout duration in ms and a message string"}
${"peer"} | ${"timeout"} | ${[200, "test", 1]} | ${1} | ${"timeout accepts exactly two arguments: timeout duration in ms and a message string"}
${"debug"} | ${"stringify"} | ${[]} | ${0} | ${'"<empty argument list>"'}
${"debug"} | ${"stringify"} | ${[{ a: 10, b: 20 }]} | ${0} | ${a10b20}
${"debug"} | ${"stringify"} | ${[1, 2, 3, 4]} | ${0} | ${oneTwoThreeFour}
${"math"} | ${"add"} | ${[2, 2]} | ${0} | ${4}
${"math"} | ${"add"} | ${[2]} | ${1} | ${"Expected 2 argument(s). Got 1"}
${"math"} | ${"sub"} | ${[2, 2]} | ${0} | ${0}
${"math"} | ${"sub"} | ${[2, 3]} | ${0} | ${-1}
${"math"} | ${"mul"} | ${[2, 2]} | ${0} | ${4}
${"math"} | ${"mul"} | ${[2, 0]} | ${0} | ${0}
${"math"} | ${"mul"} | ${[2, -1]} | ${0} | ${-2}
${"math"} | ${"fmul"} | ${[10, 0.66]} | ${0} | ${6}
${"math"} | ${"fmul"} | ${[0.5, 0.5]} | ${0} | ${0}
${"math"} | ${"fmul"} | ${[100.5, 0.5]} | ${0} | ${50}
${"math"} | ${"div"} | ${[2, 2]} | ${0} | ${1}
${"math"} | ${"div"} | ${[2, 3]} | ${0} | ${0}
${"math"} | ${"div"} | ${[10, 5]} | ${0} | ${2}
${"math"} | ${"rem"} | ${[10, 3]} | ${0} | ${1}
${"math"} | ${"pow"} | ${[2, 2]} | ${0} | ${4}
${"math"} | ${"pow"} | ${[2, 0]} | ${0} | ${1}
${"math"} | ${"log"} | ${[2, 2]} | ${0} | ${1}
${"math"} | ${"log"} | ${[2, 4]} | ${0} | ${2}
${"cmp"} | ${"gt"} | ${[2, 4]} | ${0} | ${false}
${"cmp"} | ${"gte"} | ${[2, 4]} | ${0} | ${false}
${"cmp"} | ${"gte"} | ${[4, 2]} | ${0} | ${true}
${"cmp"} | ${"gte"} | ${[2, 2]} | ${0} | ${true}
${"cmp"} | ${"lt"} | ${[2, 4]} | ${0} | ${true}
${"cmp"} | ${"lte"} | ${[2, 4]} | ${0} | ${true}
${"cmp"} | ${"lte"} | ${[4, 2]} | ${0} | ${false}
${"cmp"} | ${"lte"} | ${[2, 2]} | ${0} | ${true}
${"cmp"} | ${"cmp"} | ${[2, 4]} | ${0} | ${-1}
${"cmp"} | ${"cmp"} | ${[2, -4]} | ${0} | ${1}
${"cmp"} | ${"cmp"} | ${[2, 2]} | ${0} | ${0}
${"array"} | ${"sum"} | ${[[1, 2, 3]]} | ${0} | ${6}
${"array"} | ${"dedup"} | ${[["a", "a", "b", "c", "a", "b", "c"]]} | ${0} | ${["a", "b", "c"]}
${"array"} | ${"intersect"} | ${[["a", "b", "c"], ["c", "b", "d"]]} | ${0} | ${["b", "c"]}
${"array"} | ${"diff"} | ${[["a", "b", "c"], ["c", "b", "d"]]} | ${0} | ${["a"]}
${"array"} | ${"sdiff"} | ${[["a", "b", "c"], ["c", "b", "d"]]} | ${0} | ${["a", "d"]}
${"json"} | ${"obj"} | ${["a", 10, "b", "string", "c", null]} | ${0} | ${{ a: 10, b: "string", c: null }}
${"json"} | ${"obj"} | ${["a", 10, "b", "string", "c"]} | ${1} | ${"Expected even number of argument(s). Got 5"}
${"json"} | ${"obj"} | ${[]} | ${0} | ${{}}
${"json"} | ${"put"} | ${[{}, "a", 10]} | ${0} | ${{ a: 10 }}
${"json"} | ${"put"} | ${[{ b: 11 }, "a", 10]} | ${0} | ${{ a: 10, b: 11 }}
${"json"} | ${"put"} | ${["a", "a", 11]} | ${1} | ${"Argument 0 expected to be of type object, Got string"}
${"json"} | ${"put"} | ${[{}, "a", 10, "b", 20]} | ${1} | ${"Expected 3 argument(s). Got 5"}
${"json"} | ${"put"} | ${[{}]} | ${1} | ${"Expected 3 argument(s). Got 1"}
${"json"} | ${"puts"} | ${[{}, "a", 10]} | ${0} | ${{ a: 10 }}
${"json"} | ${"puts"} | ${[{ b: 11 }, "a", 10]} | ${0} | ${{ a: 10, b: 11 }}
${"json"} | ${"puts"} | ${[{}, "a", 10, "b", "string", "c", null]} | ${0} | ${{ a: 10, b: "string", c: null }}
${"json"} | ${"puts"} | ${[{ x: "text" }, "a", 10, "b", "string"]} | ${0} | ${{ a: 10, b: "string", x: "text" }}
${"json"} | ${"puts"} | ${[{}]} | ${1} | ${"Expected more than 3 argument(s). Got 1"}
${"json"} | ${"puts"} | ${["a", "a", 11]} | ${1} | ${"Argument 0 expected to be of type object, Got string"}
${"json"} | ${"stringify"} | ${[{ a: 10, b: "string", c: null }]} | ${0} | ${'{"a":10,"b":"string","c":null}'}
${"json"} | ${"stringify"} | ${[1]} | ${1} | ${"Argument 0 expected to be of type object, Got number"}
${"json"} | ${"parse"} | ${['{"a":10,"b":"string","c":null}']} | ${0} | ${{ a: 10, b: "string", c: null }}
${"json"} | ${"parse"} | ${["incorrect"]} | ${1} | ${"Unexpected token i in JSON at position 0"}
${"json"} | ${"parse"} | ${[10]} | ${1} | ${"Argument 0 expected to be of type string, Got number"}
`(
//
'$fnName with $args expected retcode: $retCode and result: $result',
async ({ serviceId, fnName, args, retCode, result }) => {
"$fnName with $args expected retcode: $retCode and result: $result",
async ({ serviceId, fnName, args, retCode, result }: ServiceCallType) => {
// arrange
const req: CallServiceData = {
serviceId: serviceId,
@ -118,8 +144,8 @@ describe('Tests for default handler', () => {
args: args,
tetraplets: [],
particleContext: {
particleId: 'some',
initPeerId: 'init peer id',
particleId: "some",
initPeerId: "init peer id",
timestamp: 595951200,
ttl: 595961200,
signature: new Uint8Array([]),
@ -132,8 +158,10 @@ describe('Tests for default handler', () => {
// Our test cases above depend on node error message. In node 20 error message for JSON.parse has changed.
// Simple and fast solution for this specific case is to unify both variations into node 18 version error format.
if (res.result === 'Unexpected token \'i\', "incorrect" is not valid JSON') {
res.result = 'Unexpected token i in JSON at position 0';
if (
res.result === "Unexpected token 'i', \"incorrect\" is not valid JSON"
) {
res.result = "Unexpected token i in JSON at position 0";
}
// assert
@ -144,16 +172,16 @@ describe('Tests for default handler', () => {
},
);
it('should return correct error message for identiy service', async () => {
it("should return correct error message for identiy service", async () => {
// arrange
const req: CallServiceData = {
serviceId: 'peer',
fnName: 'identify',
serviceId: "peer",
fnName: "identify",
args: [],
tetraplets: [],
particleContext: {
particleId: 'some',
initPeerId: 'init peer id',
particleId: "some",
initPeerId: "init peer id",
timestamp: 595951200,
ttl: 595961200,
signature: new Uint8Array([]),
@ -169,22 +197,27 @@ describe('Tests for default handler', () => {
retCode: 0,
result: {
external_addresses: [],
node_version: expect.stringContaining('js'),
air_version: expect.stringContaining('js'),
// stringContaining method returns any for some reason
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
node_version: expect.stringContaining("js"),
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
air_version: expect.stringContaining("js"),
},
});
});
});
const key = '+cmeYlZKj+MfSa9dpHV+BmLPm6wq4inGlsPlQ1GvtPk=';
const key = "+cmeYlZKj+MfSa9dpHV+BmLPm6wq4inGlsPlQ1GvtPk=";
const context = (async () => {
const keyBytes = toUint8Array(key);
const kp = await KeyPair.fromEd25519SK(keyBytes);
const res = {
peerKeyPair: kp,
peerId: kp.getPeerId(),
};
return res;
})();
@ -192,44 +225,58 @@ const testData = [1, 2, 3, 4, 5, 6, 7, 9, 10];
// signature produced by KeyPair created from key above (`key` variable)
const testDataSig = [
224, 104, 245, 206, 140, 248, 27, 72, 68, 133, 111, 10, 164, 197, 242, 132, 107, 77, 224, 67, 99, 106, 76, 29, 144,
121, 122, 169, 36, 173, 58, 80, 170, 102, 137, 253, 157, 247, 168, 87, 162, 223, 188, 214, 203, 220, 52, 246, 29,
224, 104, 245, 206, 140, 248, 27, 72, 68, 133, 111, 10, 164, 197, 242, 132,
107, 77, 224, 67, 99, 106, 76, 29, 144, 121, 122, 169, 36, 173, 58, 80, 170,
102, 137, 253, 157, 247, 168, 87, 162, 223, 188, 214, 203, 220, 52, 246, 29,
86, 77, 71, 224, 248, 16, 213, 254, 75, 78, 239, 243, 222, 241, 15,
];
// signature produced by KeyPair created from some random KeyPair
const testDataWrongSig = [
116, 247, 189, 118, 236, 53, 147, 123, 219, 75, 176, 105, 101, 108, 233, 137, 97, 14, 146, 132, 252, 70, 51, 153,
237, 167, 156, 150, 36, 90, 229, 108, 166, 231, 255, 137, 8, 246, 125, 0, 213, 150, 83, 196, 237, 221, 131, 159,
157, 159, 25, 109, 95, 160, 181, 65, 254, 238, 47, 156, 240, 151, 58, 14,
116, 247, 189, 118, 236, 53, 147, 123, 219, 75, 176, 105, 101, 108, 233, 137,
97, 14, 146, 132, 252, 70, 51, 153, 237, 167, 156, 150, 36, 90, 229, 108, 166,
231, 255, 137, 8, 246, 125, 0, 213, 150, 83, 196, 237, 221, 131, 159, 157,
159, 25, 109, 95, 160, 181, 65, 254, 238, 47, 156, 240, 151, 58, 14,
];
const makeTetraplet = (initPeerId: string, serviceId?: string, fnName?: string): CallParams<'data'> => {
const makeTestTetraplet = (
initPeerId: string,
serviceId: string,
fnName: string,
): CallParams<"data"> => {
return {
particleId: "",
timestamp: 0,
ttl: 0,
initPeerId: initPeerId,
tetraplets: {
data: [
{
peer_pk: initPeerId,
function_name: fnName,
service_id: serviceId,
json_path: "",
},
],
},
} as any;
};
};
describe('Sig service tests', () => {
it('sig.sign should create the correct signature', async () => {
describe("Sig service tests", () => {
it("sig.sign should create the correct signature", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
const res = await sig.sign(testData, makeTetraplet(ctx.peerId));
const res = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "any_service", "any_func"),
);
expect(res.success).toBe(true);
expect(res.signature).toStrictEqual(testDataSig);
});
it('sig.verify should return true for the correct signature', async () => {
it("sig.verify should return true for the correct signature", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
@ -238,7 +285,7 @@ describe('Sig service tests', () => {
expect(res).toBe(true);
});
it('sig.verify should return false for the incorrect signature', async () => {
it("sig.verify should return false for the incorrect signature", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
@ -247,63 +294,93 @@ describe('Sig service tests', () => {
expect(res).toBe(false);
});
it('sign-verify call chain should work', async () => {
it("sign-verify call chain should work", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
const signature = await sig.sign(testData, makeTetraplet(ctx.peerId));
const res = await sig.verify(signature.signature as number[], testData);
const signature = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "any_service", "any_func"),
);
expect(signature.success).toBe(true);
assert(signature.success);
const res = await sig.verify(signature.signature, testData);
expect(res).toBe(true);
});
it('sig.sign with defaultSigGuard should work for correct callParams', async () => {
it("sig.sign with defaultSigGuard should work for correct callParams", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
sig.securityGuard = defaultSigGuard(ctx.peerId);
const signature = await sig.sign(testData, makeTetraplet(ctx.peerId, 'registry', 'get_route_bytes'));
const signature = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "registry", "get_route_bytes"),
);
await expect(signature).toBeDefined();
expect(signature).toBeDefined();
});
it('sig.sign with defaultSigGuard should not allow particles initiated from incorrect service', async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
sig.securityGuard = defaultSigGuard(ctx.peerId);
const res = await sig.sign(testData, makeTetraplet(ctx.peerId, 'other_service', 'other_fn'));
await expect(res.success).toBe(false);
await expect(res.error).toBe('Security guard validation failed');
});
it('sig.sign with defaultSigGuard should not allow particles initiated from other peers', async () => {
it("sig.sign with defaultSigGuard should not allow particles initiated from incorrect service", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
sig.securityGuard = defaultSigGuard(ctx.peerId);
const res = await sig.sign(
testData,
makeTetraplet((await KeyPair.randomEd25519()).getPeerId(), 'registry', 'get_key_bytes'),
makeTestTetraplet(ctx.peerId, "other_service", "other_fn"),
);
await expect(res.success).toBe(false);
await expect(res.error).toBe('Security guard validation failed');
expect(res.success).toBe(false);
expect(res.error).toBe("Security guard validation failed");
});
it('changing securityGuard should work', async () => {
it("sig.sign with defaultSigGuard should not allow particles initiated from other peers", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
sig.securityGuard = allowServiceFn('test', 'test');
sig.securityGuard = defaultSigGuard(ctx.peerId);
const successful1 = await sig.sign(testData, makeTetraplet(ctx.peerId, 'test', 'test'));
const unSuccessful1 = await sig.sign(testData, makeTetraplet(ctx.peerId, 'wrong', 'wrong'));
const res = await sig.sign(
testData,
makeTestTetraplet(
(await KeyPair.randomEd25519()).getPeerId(),
"registry",
"get_key_bytes",
),
);
sig.securityGuard = allowServiceFn('wrong', 'wrong');
expect(res.success).toBe(false);
expect(res.error).toBe("Security guard validation failed");
});
const successful2 = await sig.sign(testData, makeTetraplet(ctx.peerId, 'wrong', 'wrong'));
const unSuccessful2 = await sig.sign(testData, makeTetraplet(ctx.peerId, 'test', 'test'));
it("changing securityGuard should work", async () => {
const ctx = await context;
const sig = new Sig(ctx.peerKeyPair);
sig.securityGuard = allowServiceFn("test", "test");
const successful1 = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "test", "test"),
);
const unSuccessful1 = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "wrong", "wrong"),
);
sig.securityGuard = allowServiceFn("wrong", "wrong");
const successful2 = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "wrong", "wrong"),
);
const unSuccessful2 = await sig.sign(
testData,
makeTestTetraplet(ctx.peerId, "test", "test"),
);
expect(successful1.success).toBe(true);
expect(successful2.success).toBe(true);

Some files were not shown because too many files have changed in this diff Show More