/* * Copyright 2021 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 { Multiaddr } from 'multiaddr'; import { CallServiceData, CallServiceResult, GenericCallServiceHandler, ResultCodes } from './commonTypes'; import { PeerIdB58 } from './commonTypes'; import { FluenceConnection } from './FluenceConnection'; import { Particle, ParticleExecutionStage, ParticleQueueItem } from './Particle'; import { KeyPair } from './KeyPair'; import { throwIfNotSupported, dataToString, jsonify } from './utils'; import { concatMap, filter, pipe, Subject, tap } from 'rxjs'; import log from 'loglevel'; import { builtInServices } from './builtins/common'; import { defaultSigGuard, Sig } from './builtins/Sig'; import { registerSig } from './_aqua/services'; import Buffer from './Buffer'; import { FluenceAppService, loadDefaults, loadWasmFromFileSystem, loadWasmFromServer } from '@fluencelabs/marine-js'; import { AVM, AvmRunner } from './avm'; import { isBrowser, isNode } from 'browser-or-node'; import { InterpreterResult, LogLevel } from '@fluencelabs/avm'; /** * Node of the Fluence network specified as a pair of node's multiaddr and it's peer id */ type Node = { peerId: PeerIdB58; multiaddr: string; }; /** * Enum representing the log level used in Aqua VM. * Possible values: 'info', 'trace', 'debug', 'info', 'warn', 'error', 'off'; */ export type AvmLoglevel = LogLevel; const DEFAULT_TTL = 7000; /** * Configuration used when initiating Fluence Peer */ export interface PeerConfig { /** * Node in Fluence network to connect to. * Can be in the form of: * - string: multiaddr in string format * - Multiaddr: multiaddr object, @see https://github.com/multiformats/js-multiaddr * - Node: node structure, @see Node * If not specified the will work locally and would not be able to send or receive particles. */ connectTo?: string | Multiaddr | Node; /** * Specify log level for Aqua VM running on the peer */ avmLogLevel?: AvmLoglevel; /** * Specify the KeyPair to be used to identify the Fluence Peer. * Will be generated randomly if not specified */ KeyPair?: KeyPair; /** * When the peer established the connection to the network it sends a ping-like message to check if it works correctly. * The options allows to specify the timeout for that message in milliseconds. * If not specified the default timeout will be used */ checkConnectionTimeoutMs?: number; /** * When the peer established the connection to the network it sends a ping-like message to check if it works correctly. * If set to true, the ping-like message will be skipped * Default: false */ skipCheckConnection?: boolean; /** * The dialing timeout in milliseconds */ dialTimeoutMs?: number; /** * Sets the default TTL for all particles originating from the peer with no TTL specified. * If the originating particle's TTL is defined then that value will be used * If the option is not set default TTL will be 7000 */ defaultTtlMs?: number; /** * @deprecated. AVM run through marine-js infrastructure. * @see marineJS option to configure AVM */ avmRunner?: AvmRunner; /** * This option allows to specify the location of various dependencies needed for marine-js. * Each key specifies the location of the corresponding dependency. * If Fluence peer is started inside browser the location is treated as the path to the file relative to origin. * IF Fluence peer is started in nodejs the location is treated as the full path to file on the file system. */ marineJS?: { /** * Configures path to the marine-js worker script. */ workerScriptPath: string; /** * Configures the path to marine-js control wasm module */ marineWasmPath: string; /** * Configures the path to AVM wasm module */ avmWasmPath: string; }; /** * Enables\disabled various debugging features */ debug?: { /** * If set to true, newly initiated particle ids will be printed to console. * Useful to see what particle id is responsible for aqua function */ printParticleId?: boolean; }; } /** * Information about Fluence Peer connection */ export interface PeerStatus { /** * Is the peer initialized or not */ isInitialized: Boolean; /** * Is the peer connected to network or not */ isConnected: Boolean; /** * The Peer's identification in the Fluence network */ peerId: PeerIdB58 | null; /** * The relays's peer id to which the peer is connected to */ relayPeerId: PeerIdB58 | null; } /** * This class implements the Fluence protocol for javascript-based environments. * It provides all the necessary features to communicate with Fluence network */ export class FluencePeer { /** * Creates a new Fluence Peer instance. */ constructor() {} /** * Checks whether the object is instance of FluencePeer class * @param obj - object to check if it is FluencePeer * @returns true if the object is FluencePeer false otherwise */ static isInstance(obj: FluencePeer): boolean { if (obj && obj._isFluenceAwesome) { return true; } else { return false; } } /** * Get the peer's status */ getStatus(): PeerStatus { const hasKeyPair = this._keyPair !== undefined; return { // TODO:: use explicit mechanism for peer's state isInitialized: hasKeyPair, isConnected: this._connection !== undefined, peerId: this._keyPair?.Libp2pPeerId?.toB58String() || null, relayPeerId: this._relayPeerId || null, }; } /** * Initializes the peer: starts the Aqua VM, initializes the default call service handlers * and (optionally) connect to the Fluence network * @param config - object specifying peer configuration */ async start(config?: PeerConfig): Promise { throwIfNotSupported(); if (config?.KeyPair) { this._keyPair = config!.KeyPair; } else { this._keyPair = await KeyPair.randomEd25519(); } if (config?.debug?.printParticleId) { this._printParticleId = true; } this._defaultTTL = config?.defaultTtlMs !== undefined // don't miss value 0 (zero) ? config?.defaultTtlMs : DEFAULT_TTL; this._fluenceAppService = new FluenceAppService(config?.marineJS?.workerScriptPath); const marineDeps = config?.marineJS ? await loadMarineAndAvm(config.marineJS.marineWasmPath, config.marineJS.avmWasmPath) : await loadDefaults(); await this._fluenceAppService.init(marineDeps.marine); await this._fluenceAppService.createService(marineDeps.avm, 'avm'); this._avmRunner = config?.avmRunner || new AVM(this._fluenceAppService); await this._avmRunner.init(config?.avmLogLevel || 'off'); if (config?.connectTo) { let connectToMultiAddr: Multiaddr; let fromNode = (config.connectTo as any).multiaddr; if (fromNode) { connectToMultiAddr = new Multiaddr(fromNode); } else { connectToMultiAddr = new Multiaddr(config.connectTo as string); } this._relayPeerId = connectToMultiAddr.getPeerId(); if (this._connection) { await this._connection.disconnect(); } this._connection = await FluenceConnection.createConnection({ peerId: this._keyPair.Libp2pPeerId, relayAddress: connectToMultiAddr, dialTimeoutMs: config.dialTimeoutMs, onIncomingParticle: (p) => this._incomingParticles.next({ particle: p, onStageChange: () => {} }), }); await this._connect(); } registerDefaultServices(this); this._classServices = { sig: new Sig(this._keyPair), }; this._classServices.sig.securityGuard = defaultSigGuard(this.getStatus().peerId); registerSig(this, this._classServices.sig); registerSig(this, this.getStatus().peerId, this._classServices.sig); this._startParticleProcessing(); } getServices() { return { ...this._classServices, }; } /** * Registers marine service within the Fluence peer from wasm file. * Following helper functions can be used to load wasm files: * * loadWasmFromFileSystem * * loadWasmFromNpmPackage * * loadWasmFromServer * @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 { if (this._containsService(serviceId)) { throw new Error(`Service with '${serviceId}' id already exists`); } await this._fluenceAppService.createService(wasm, serviceId); this._marineServices.add(serviceId); } /** * Removes the specified marine service from the Fluence peer * @param serviceId - the service id to remove */ removeMarineService(serviceId: string): void { this._marineServices.delete(serviceId); } /** * Un-initializes the peer: stops all the underlying workflows, stops the Aqua VM * and disconnects from the Fluence network */ async stop() { this._keyPair = undefined; // This will set peer to non-initialized state and stop particle processing this._relayPeerId = null; this._stopParticleProcessing(); await this._disconnect(); await this._avmRunner?.terminate(); await this._fluenceAppService?.terminate(); this._avmRunner = undefined; this._fluenceAppService = undefined; this._particleSpecificHandlers.clear(); this._commonHandlers.clear(); this._marineServices.clear(); } // internal api /** * Is not intended to be used manually. Subject to change */ get internals() { return { /** * Initiates a new particle execution starting from local peer * @param particle - particle to start execution of */ initiateParticle: (particle: Particle, onStageChange: (stage: ParticleExecutionStage) => void): void => { if (!this.getStatus().isInitialized) { throw 'Cannot initiate new particle: peer is not initialized'; } if (this._printParticleId) { console.log('Particle id: ', particle.id); } if (particle.initPeerId === undefined) { particle.initPeerId = this.getStatus().peerId; } if (particle.ttl === undefined) { particle.ttl = this._defaultTTL; } this._incomingParticles.next({ particle: particle, onStageChange: onStageChange, }); }, /** * Register Call Service handler functions */ regHandler: { /** * Register handler for all particles */ common: ( // force new line serviceId: string, fnName: string, handler: GenericCallServiceHandler, ) => { this._commonHandlers.set(serviceFnKey(serviceId, fnName), handler); }, /** * Register handler which will be called only for particle with the specific id */ forParticle: ( particleId: string, serviceId: string, fnName: string, handler: GenericCallServiceHandler, ) => { let psh = this._particleSpecificHandlers.get(particleId); if (psh === undefined) { psh = new Map(); this._particleSpecificHandlers.set(particleId, psh); } psh.set(serviceFnKey(serviceId, fnName), handler); }, }, }; } // private /** * Used in `isInstance` to check if an object is of type FluencePeer. That's a hack to work around corner cases in JS type system */ private _isFluenceAwesome = true; // TODO:: make public when full connection\disconnection cycle is implemented properly private async _connect(): Promise { return this._connection?.connect(); } // TODO:: make public when full connection\disconnection cycle is implemented properly private async _disconnect(): Promise { if (this._connection) { return this._connection.disconnect(); } } // Queues for incoming and outgoing particles private _incomingParticles = new Subject(); private _outgoingParticles = new Subject(); // Call service handler private _marineServices = new Set(); private _particleSpecificHandlers = new Map>(); private _commonHandlers = new Map(); private _classServices: { sig: Sig; }; private _containsService(serviceId: string): boolean { return this._marineServices.has(serviceId) || this._commonHandlers.has(serviceId); } // Internal peer state private _printParticleId: boolean = false; private _defaultTTL: number; private _relayPeerId: PeerIdB58 | null = null; private _keyPair: KeyPair; private _connection: FluenceConnection; /** * @deprecated. AVM run through marine-js infrastructure. This field is needed for backward compatibility with the previous API */ private _avmRunner: AvmRunner; private _fluenceAppService: FluenceAppService; private _timeouts: Array = []; private _particleQueues = new Map>(); private _startParticleProcessing() { this._incomingParticles .pipe( tap((x) => { x.particle.logTo('debug', 'particle received:'); }), filterExpiredParticles(this._expireParticle.bind(this)), ) .subscribe((item) => { const p = item.particle; let particlesQueue = this._particleQueues.get(p.id); if (!particlesQueue) { particlesQueue = this._createParticlesProcessingQueue(); this._particleQueues.set(p.id, particlesQueue); const timeout = setTimeout(() => { this._expireParticle(item); }, p.actualTtl()); this._timeouts.push(timeout); } particlesQueue.next(item); }); this._outgoingParticles.subscribe(async (item) => { // Do not send particle after the peer has been stopped if (!this.getStatus().isInitialized) { return; } if (!this._connection) { item.particle.logTo('error', 'cannot send particle, peer is not connected'); item.onStageChange({ stage: 'sendingError' }); return; } await this._connection.sendParticle(item.particle); item.onStageChange({ stage: 'sent' }); }); } private _expireParticle(item: ParticleQueueItem) { const particleId = item.particle.id; log.debug( `particle ${particleId} has expired after ${item.particle.ttl}. Deleting particle-related queues and handlers`, ); this._particleQueues.delete(particleId); this._particleSpecificHandlers.delete(particleId); item.onStageChange({ stage: 'expired' }); } private _createParticlesProcessingQueue() { let particlesQueue = new Subject(); let prevData: Uint8Array = Buffer.from([]); particlesQueue .pipe( // force new line filterExpiredParticles(this._expireParticle.bind(this)), concatMap(async (item) => { // Is `.stop()` was called we need to stop particle processing immediately if (!this.getStatus().isInitialized) { return null; } // IMPORTANT! // AVM runner execution and prevData <-> newData swapping // MUST happen sequentially (in a critical section). // Otherwise the race between runner might occur corrupting the prevData const result = await runAvmRunner( this.getStatus().peerId, this._avmRunner, item.particle, prevData, ); const newData = Buffer.from(result.data); prevData = newData; return { ...item, result: result, newData: newData, }; }), ) .subscribe(async (item) => { // Is `.stop()` was called we need to stop particle processing immediately if (!this.getStatus().isInitialized) { return; } // Do not continue if there was an error in particle interpretation if (!isInterpretationSuccessful(item.result)) { item.onStageChange({ stage: 'interpreterError', errorMessage: item.result.errorMessage }); return; } setTimeout(() => { item.onStageChange({ stage: 'interpreted' }); }, 0); // send particle further if requested if (item.result.nextPeerPks.length > 0) { const newParticle = item.particle.clone(); newParticle.data = item.newData; this._outgoingParticles.next({ ...item, particle: newParticle }); } // execute call requests if needed // and put particle with the results back to queue if (item.result.callRequests.length > 0) { for (let [key, cr] of item.result.callRequests) { const req = { fnName: cr.functionName, args: cr.arguments, serviceId: cr.serviceId, tetraplets: cr.tetraplets, particleContext: item.particle.getParticleContext(), }; this._execSingleCallRequest(req) .catch( (err): CallServiceResult => ({ retCode: ResultCodes.error, result: `Handler failed. fnName="${req.fnName}" serviceId="${ req.serviceId }" error: ${err.toString()}`, }), ) .then((res) => { const serviceResult = { result: jsonify(res.result), retCode: res.retCode, }; const newParticle = item.particle.clone(); newParticle.callResults = [[key, serviceResult]]; newParticle.data = Buffer.from([]); particlesQueue.next({ ...item, particle: newParticle }); }); } } else { item.onStageChange({ stage: 'localWorkDone' }); } }); return particlesQueue; } private async _execSingleCallRequest(req: CallServiceData): Promise { log.debug('executing call service handler', jsonify(req)); const particleId = req.particleContext.particleId; if (this._marineServices.has(req.serviceId)) { const args = JSON.stringify(req.args); const rawResult = await this._fluenceAppService.callService(req.serviceId, req.fnName, args, undefined); try { const result = JSON.parse(rawResult); if (typeof result.error === 'string' && result.error.length > 0) { return { retCode: ResultCodes.error, result: result.error, }; } if (result.result === undefined) { throw 'Call to marine-js returned no error and empty result. Original request: ' + jsonify(req); } return { retCode: ResultCodes.success, result: result.result, }; } catch (e) { throw 'Call to marine-js. Result parsing error: ' + e + ', original text: ' + rawResult; } } const key = serviceFnKey(req.serviceId, req.fnName); const psh = this._particleSpecificHandlers.get(particleId); let handler: GenericCallServiceHandler; // we should prioritize handler for this particle if there is one // if particle-specific handlers 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); } // if no handler is found return useful error message to AVM if (handler === undefined) { return { retCode: ResultCodes.error, result: `No handler has been registered for serviceId='${req.serviceId}' fnName='${ req.fnName }' args='${jsonify(req.args)}'`, }; } // if we found a handler, execute it const res = await handler(req); if (res.result === undefined) { res.result = null; } log.debug('executed call service handler, req and res are: ', jsonify(req), jsonify(res)); return res; } private _stopParticleProcessing() { // do not hang if the peer has been stopped while some of the timeouts are still being executed for (let item of this._timeouts) { clearTimeout(item); } this._particleQueues.clear(); } } function isInterpretationSuccessful(result: InterpreterResult) { return result.retCode === 0; } function serviceFnKey(serviceId: string, fnName: string) { return `${serviceId}/${fnName}`; } function registerDefaultServices(peer: FluencePeer) { for (let serviceId in builtInServices) { for (let fnName in builtInServices[serviceId]) { const h = builtInServices[serviceId][fnName]; peer.internals.regHandler.common(serviceId, fnName, h); } } } async function runAvmRunner( currentPeerId: PeerIdB58, runner: AvmRunner, particle: Particle, prevData: Uint8Array, ): Promise { particle.logTo('debug', 'Sending particle to interpreter'); log.debug('prevData: ', dataToString(prevData)); const interpreterResult = await runner.run( particle.script, prevData, particle.data, { initPeerId: particle.initPeerId, currentPeerId: currentPeerId, }, particle.callResults, ); const toLog: any = { ...interpreterResult }; toLog.data = dataToString(toLog.data); if (isInterpretationSuccessful(interpreterResult)) { log.debug('Interpreter result: ', jsonify(toLog)); } else { log.error('Interpreter failed: ', jsonify(toLog)); } return interpreterResult; } function filterExpiredParticles(onParticleExpiration: (item: ParticleQueueItem) => void) { return pipe( tap((item: ParticleQueueItem) => { if (item.particle.hasExpired()) { onParticleExpiration(item); } }), filter((x: ParticleQueueItem) => !x.particle.hasExpired()), ); } async function loadMarineAndAvm( marinePath: string, avmPath: string, ): Promise<{ marine: SharedArrayBuffer | Buffer; avm: SharedArrayBuffer | Buffer; }> { let promises: [Promise, Promise]; // check if we are running inside the browser and instantiate worker with the corresponding script if (isBrowser) { promises = [ // force new line loadWasmFromServer(marinePath), loadWasmFromServer(avmPath), ]; } else if (isNode) { promises = [ // force new line loadWasmFromFileSystem(marinePath), loadWasmFromFileSystem(avmPath), ]; } else { throw new Error('Unknown environment'); } const [marine, avm] = await Promise.all(promises); return { marine, avm, }; }