@xyo-network/module-abstract 2.92.6 → 2.92.8

package/dist/browser/index.js

@@ -16,7 +16,7 @@ import { BoundWitnessBuilder, QueryBoundWitnessBuilder } from "@xyo-network/boun
 import { QueryBoundWitnessWrapper as QueryBoundWitnessWrapper3 } from "@xyo-network/boundwitness-wrapper";
 import { ConfigSchema } from "@xyo-network/config-payload-plugin";
 import { ModuleManifestPayloadSchema } from "@xyo-network/manifest-model";
-import { AddressPreviousHashSchema, duplicateModules, isModuleName, ModuleAddressQuerySchema, ModuleDescribeQuerySchema, ModuleDescriptionSchema, ModuleDiscoverQuerySchema, ModuleFactory, ModuleManifestQuerySchema, ModuleStateQuerySchema, ModuleSubscribeQuerySchema, serializableField } from "@xyo-network/module-model";
+import { AddressPreviousHashSchema, DeadModuleError, duplicateModules, isModuleName, ModuleAddressQuerySchema, ModuleDescribeQuerySchema, ModuleDescriptionSchema, ModuleDiscoverQuerySchema, ModuleFactory, ModuleManifestQuerySchema, ModuleStateQuerySchema, ModuleSubscribeQuerySchema, serializableField } from "@xyo-network/module-model";
 import { CompositeModuleResolver } from "@xyo-network/module-resolver";
 import { PayloadBuilder as PayloadBuilder2 } from "@xyo-network/payload-builder";
 import { QuerySchema } from "@xyo-network/query-payload-plugin";
@@ -68,7 +68,7 @@ var BaseEmitter = class extends Base {
 import { assertEx } from "@xylabs/assert";
 import { Account } from "@xyo-network/account";
 var isDetermineAccountFromAccountParams = /* @__PURE__ */ __name((params) => {
-  assertEx(!params.accountPath, "accountPath may not be provided when account is provided");
+  assertEx(!params.accountPath, () => "accountPath may not be provided when account is provided");
   return !!params.account;
 }, "isDetermineAccountFromAccountParams");
 var isDetermineAccountFromWalletParams = /* @__PURE__ */ __name((params) => {
@@ -77,13 +77,13 @@ var isDetermineAccountFromWalletParams = /* @__PURE__ */ __name((params) => {
 async function determineAccount(params, allowRandomAccount = true) {
   if (isDetermineAccountFromAccountParams(params)) {
     if (params.account === "random") {
-      assertEx(allowRandomAccount, "Random address not allowed");
+      assertEx(allowRandomAccount, () => "Random address not allowed");
       return Account.randomSync();
     }
     return params.account;
   }
   if (isDetermineAccountFromWalletParams(params)) {
-    return assertEx(params.accountPath ? await params.wallet.derivePath(params.accountPath) : params.wallet, "Failed to derive account from path");
+    return assertEx(params.accountPath ? await params.wallet.derivePath(params.accountPath) : params.wallet, () => "Failed to derive account from path");
   }
   console.warn("AbstractModule.determineAccount: No account or wallet provided - Creating Random account");
   return Account.randomSync();
@@ -234,6 +234,7 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     [ModuleStateQuerySchema]: "6",
     [ModuleSubscribeQuerySchema]: "3"
   };
+  _lastError;
   _queryAccounts = {
     [ModuleAddressQuerySchema]: void 0,
     [ModuleDescribeQuerySchema]: void 0,
@@ -247,8 +248,9 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
   moduleConfigQueryValidator;
   supportedQueryValidator;
   _busyCount = 0;
+  _status = "stopped";
   constructor(privateConstructorKey, params, account) {
-    assertEx2(_AbstractModule.privateConstructorKey === privateConstructorKey, "Use create function instead of constructor");
+    assertEx2(_AbstractModule.privateConstructorKey === privateConstructorKey, () => "Use create function instead of constructor");
     const mutatedParams = {
       ...params
     };
@@ -261,7 +263,7 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     return this.configSchemas[0];
   }
   get account() {
-    return assertEx2(this._account, "Missing account");
+    return assertEx2(this._account, () => "Missing account");
   }
   get address() {
     return this.account.address;
@@ -272,6 +274,9 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
   get config() {
     return this.params.config;
   }
+  get dead() {
+    return this.status === "dead";
+  }
   get ephemeralQueryAccountEnabled() {
     return !!this.params.ephemeralQueryAccountEnabled;
   }
@@ -297,6 +302,9 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
   get queryAccounts() {
     return this._queryAccounts;
   }
+  get status() {
+    return this._status;
+  }
   get timestamp() {
     return this.config.timestamp ?? false;
   }
@@ -306,6 +314,11 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
   get logger() {
     return this.params?.logger ?? _AbstractModule.defaultLogger ?? Base2.defaultLogger;
   }
+  set status(value) {
+    if (this._status !== "dead") {
+      this._status = value;
+    }
+  }
   static _getRootFunction(funcName) {
     let anyThis = this;
     while (anyThis.__proto__[funcName]) {
@@ -316,14 +329,14 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
   static _noOverride(functionName) {
     const thisFunc = this[functionName];
     const rootFunc = this._getRootFunction(functionName);
-    assertEx2(thisFunc === rootFunc, `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
+    assertEx2(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
   }
   static async create(params) {
     this._noOverride("create");
     if (!this.configSchemas || this.configSchemas.length === 0) {
       throw new Error(`Missing configSchema [${params?.config?.schema}][${this.name}]`);
     }
-    assertEx2(params?.config?.name === void 0 || isModuleName(params.config.name), `Invalid module name: ${params?.config?.name}`);
+    assertEx2(params?.config?.name === void 0 || isModuleName(params.config.name), () => `Invalid module name: ${params?.config?.name}`);
     const { account } = params ?? {};
     const schema = params?.config?.schema ?? this.configSchema;
     const allowedSchemas = this.configSchemas;
@@ -362,11 +375,6 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     }
     return anyThis[funcName];
   }
-  _noOverride(functionName) {
-    const thisFunc = this[functionName];
-    const rootFunc = this._getRootFunction(functionName);
-    assertEx2(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
-  }
   async busy(closure) {
     if (this._busyCount <= 0) {
       this._busyCount = 0;
@@ -395,11 +403,13 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     return super.emit(eventName, eventArgs);
   }
   previousHash() {
+    this._checkDead();
     return this.account.previousHash;
   }
   async query(query, payloads, queryConfig) {
+    this._checkDead();
     this._noOverride("query");
-    const sourceQuery = await PayloadBuilder2.build(assertEx2(QueryBoundWitnessWrapper3.unwrap(query), "Invalid query"));
+    const sourceQuery = await PayloadBuilder2.build(assertEx2(QueryBoundWitnessWrapper3.unwrap(query), () => "Invalid query"));
     return await this.busy(async () => {
       const resultPayloads = [];
       const errorPayloads = [];
@@ -409,9 +419,14 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
         if (!this.allowAnonymous && query.addresses.length === 0) {
           throw new Error(`Anonymous Queries not allowed, but running anyway [${this.config.name}], [${this.address}]`);
         }
+        if (queryConfig?.allowedQueries) {
+          assertEx2(queryConfig?.allowedQueries.includes(sourceQuery.schema), () => `Query not allowed [${sourceQuery.schema}]`);
+        }
         resultPayloads.push(...await this.queryHandler(sourceQuery, payloads, queryConfig));
       } catch (ex) {
         await handleErrorAsync(ex, async (error) => {
+          this._lastError = error;
+          this.status = "dead";
           errorPayloads.push(await new ModuleErrorBuilder().sources([
             sourceQuery.$hash
           ]).name(this.config.name ?? "<Unknown>").query(sourceQuery.schema).message(error.message).build());
@@ -438,6 +453,9 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     });
   }
   async queryable(query, payloads, queryConfig) {
+    if (this.dead) {
+      return false;
+    }
     if (!await this.started("warn"))
       return false;
     const configValidator = queryConfig ? new ModuleConfigQueryValidator(Object.assign({}, this.config, queryConfig)).queryable : this.moduleConfigQueryValidator;
@@ -447,7 +465,7 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     ];
     return validators.every((validator) => validator(query, payloads));
   }
-  async resolve(idOrFilter, { required = "log", ...options } = {}) {
+  async resolve(idOrFilter = "*", { required = "log", ...options } = {}) {
     const childOptions = {
       ...options,
       required: false
@@ -456,41 +474,44 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
     const up = direction === "up" || direction === "all";
     const down = direction === "down" || direction === "all";
     let result;
-    switch (typeof idOrFilter) {
-      case "string": {
-        result = (down ? await this.downResolver.resolve(idOrFilter, childOptions) : void 0) ?? (up ? await this.upResolver.resolve(idOrFilter, childOptions) : void 0);
-        break;
+    if (idOrFilter === "*") {
+      if (this.dead) {
+        return [];
       }
-      default: {
-        const filter = idOrFilter;
-        result = [
-          ...down ? await this.downResolver.resolve(filter, childOptions) : [],
-          ...up ? await this.upResolver.resolve(filter, childOptions) : []
-        ].filter(duplicateModules);
-        break;
-      }
-    }
-    if (required && (result === void 0 || Array.isArray(result) && result.length > 0)) {
-      switch (required) {
-        case "warn": {
-          this.logger.warn("resolve failed", idOrFilter);
-          break;
-        }
-        case "log": {
-          this.logger.log("resolve failed", idOrFilter);
+      return [
+        ...down ? await this.downResolver.resolve("*", childOptions) : [],
+        ...up ? await this.upResolver.resolve("*", childOptions) : []
+      ].filter(duplicateModules);
+    } else {
+      switch (typeof idOrFilter) {
+        case "string": {
+          if (this.dead) {
+            return void 0;
+          }
+          result = (down ? await this.downResolver.resolve(idOrFilter, childOptions) : void 0) ?? (up ? await this.upResolver.resolve(idOrFilter, childOptions) : void 0);
           break;
         }
         default: {
-          this.logger.error("resolve failed", idOrFilter);
+          if (this.dead) {
+            return [];
+          }
+          const filter = idOrFilter;
+          result = [
+            ...down ? await this.downResolver.resolve(filter, childOptions) : [],
+            ...up ? await this.upResolver.resolve(filter, childOptions) : []
+          ].filter(duplicateModules);
           break;
         }
       }
     }
+    this.validateRequiredResolve(required, result, idOrFilter);
     return result;
   }
   start(_timeout) {
     this._startPromise = this._startPromise ?? this.startHandler();
-    return this._startPromise;
+    const result = this._startPromise;
+    this.status = result ? "started" : "dead";
+    return result;
   }
   async started(notStartedAction = "log", tryStart = true) {
     const started = await this._started;
@@ -543,9 +564,20 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
       const result = await this.stopHandler();
       this._started = void 0;
       this._startPromise = void 0;
+      this.status = result ? "stopped" : "dead";
       return result;
     });
   }
+  _checkDead() {
+    if (this.dead) {
+      throw new DeadModuleError(this.id, this._lastError);
+    }
+  }
+  _noOverride(functionName) {
+    const thisFunc = this[functionName];
+    const rootFunc = this._getRootFunction(functionName);
+    assertEx2(thisFunc === rootFunc, () => `Override not allowed for [${functionName}] - override ${functionName}Handler instead`);
+  }
   bindHashes(hashes, schema, account) {
     const promise = new PromiseEx((resolve) => {
       const result = this.bindHashesInternal(hashes, schema, account);
@@ -819,6 +851,24 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
       }
     }, true);
   }
+  validateRequiredResolve(required, result, idOrFilter) {
+    if (required && (result === void 0 || Array.isArray(result) && result.length > 0)) {
+      switch (required) {
+        case "warn": {
+          this.logger.warn("resolve failed", idOrFilter);
+          break;
+        }
+        case "log": {
+          this.logger.log("resolve failed", idOrFilter);
+          break;
+        }
+        default: {
+          this.logger.error("resolve failed", idOrFilter);
+          break;
+        }
+      }
+    }
+  }
 };
 
 // src/AbstractModuleInstance.ts
@@ -828,7 +878,7 @@ var AbstractModuleInstance = class extends AbstractModule {
     __name(this, "AbstractModuleInstance");
   }
   constructor(privateConstructorKey, params, account) {
-    assertEx3(AbstractModule.privateConstructorKey === privateConstructorKey, "Use create function instead of constructor");
+    assertEx3(AbstractModule.privateConstructorKey === privateConstructorKey, () => "Use create function instead of constructor");
     const mutatedParams = {
       ...params
     };
@@ -837,31 +887,37 @@ var AbstractModuleInstance = class extends AbstractModule {
     this.downResolver.add(this);
   }
   describe() {
+    this._checkDead();
     return this.busy(async () => {
       return await this.describeHandler();
     });
   }
   discover() {
+    this._checkDead();
     return this.busy(async () => {
       return await this.discoverHandler();
     });
   }
   manifest(maxDepth, ignoreAddresses) {
+    this._checkDead();
     return this.busy(async () => {
       return await this.manifestHandler(maxDepth, ignoreAddresses);
     });
   }
   moduleAddress() {
+    this._checkDead();
     return this.busy(async () => {
       return await this.moduleAddressHandler();
     });
   }
   state() {
+    this._checkDead();
     return this.busy(async () => {
       return await this.stateHandler();
     });
   }
   subscribe(_queryAccount) {
+    this._checkDead();
     return this.subscribeHandler();
   }
 };