@abtnode/core 1.7.5 → 1.7.8

package/lib/api/team.js

@@ -211,7 +211,7 @@ class TeamAPI extends EventEmitter {
 
   // Invite member
 
-  async createInvitation({ teamDid, role, remark, interfaceName }, context) {
+  async createInvitation({ teamDid, role, remark }, context) {
     await this.teamManager.checkEnablePassportIssuance(teamDid);
 
     if (!role) {
@@ -242,7 +242,6 @@ class TeamAPI extends EventEmitter {
       expireDate,
       inviter: user,
       teamDid,
-      interfaceName,
     });
 
     logger.info('Create invite member', { role, user, inviteId });
@@ -254,7 +253,6 @@ class TeamAPI extends EventEmitter {
       expireDate: new Date(expireDate).toString(),
       inviter: user,
       teamDid,
-      interfaceName,
     };
   }
 
@@ -271,7 +269,6 @@ class TeamAPI extends EventEmitter {
       expireDate: new Date(d.expireDate).toString(),
       inviter: d.inviter,
       teamDid: d.teamDid,
-      interfaceName: d.interfaceName,
     }));
   }
 

package/lib/blocklet/manager/disk.js

@@ -15,7 +15,7 @@ const { isValid: isValidDid } = require('@arcblock/did');
 const { verifyPresentation } = require('@arcblock/vc');
 const { toBase58, isHex } = require('@ocap/util');
 const { fromSecretKey } = require('@ocap/wallet');
-const { toPng: createDidLogo } =
+const { toSvg: createDidLogo } =
   process.env.NODE_ENV !== 'test' ? require('@arcblock/did-motif') : require('@arcblock/did-motif/dist/did-motif.cjs');
 
 const logger = require('@abtnode/logger')('@abtnode/core:blocklet:manager');
@@ -104,6 +104,7 @@ const blockletPm2Events = require('./pm2-events');
 const { getFactoryState } = require('../../util/chain');
 const runMigrationScripts = require('../migration');
 const hooks = require('../hooks');
+const { formatName } = require('../../util/get-domain-for-blocklet');
 
 const {
   isInProgress,
@@ -279,9 +280,9 @@ class BlockletManager extends BaseBlockletManager {
     return this._installFromStore({ did, registry }, { ...context, blockletPurchaseVerified: true });
   }
 
-  async start({ did, checkHealthImmediately = false, throwOnError }, context) {
+  async start({ did, throwOnError, checkHealthImmediately = false, e2eMode = false }, context) {
     logger.info('start blocklet', { did });
-    const blocklet = await this.ensureBlocklet(did);
+    const blocklet = await this.ensureBlocklet(did, e2eMode);
 
     try {
       if (!hasRunnableComponent(blocklet)) {
@@ -319,6 +320,7 @@ class BlockletManager extends BaseBlockletManager {
           }),
         nodeEnvironments,
         nodeInfo: await states.node.read(),
+        e2eMode,
       });
 
       // check blocklet healthy
@@ -481,6 +483,40 @@ class BlockletManager extends BaseBlockletManager {
     }
   }
 
+  async reset({ did }, context = {}) {
+    logger.info('reset blocklet', { did });
+
+    const blocklet = await this.ensureBlocklet(did);
+
+    if (isInProgress(blocklet.status)) {
+      throw new Error('Cannot reset when blocklet is in progress');
+    }
+
+    try {
+      await this.deleteProcess({ did }, context);
+    } catch {
+      // do nothing
+    }
+
+    // Cleanup disk storage
+    const { name } = blocklet.meta;
+    const dataDir = path.join(this.dataDirs.data, name);
+    const logsDir = path.join(this.dataDirs.logs, name);
+    const cacheDir = path.join(this.dataDirs.cache, name);
+    fs.removeSync(cacheDir);
+    fs.removeSync(dataDir);
+    fs.removeSync(logsDir);
+
+    // Reset config in db
+    await this._delExtras(did);
+    await this._setConfigs(did);
+    await this.updateBlockletEnvironment(did);
+    await this.resetSiteByDid(did, context);
+
+    logger.info('blocklet reset', { did });
+    return blocklet;
+  }
+
   async deleteComponent({ did, rootDid }, context) {
     logger.info('delete blocklet component', { did, rootDid });
 
@@ -928,14 +964,22 @@ class BlockletManager extends BaseBlockletManager {
    * After the dev function finished, the caller should send a BlockletEvents.deployed event to the daemon
    * @returns {Object} blocklet
    */
-  async dev(folder) {
-    logger.info('dev blocklet', { folder });
+  async dev(folder, { rootDid, mountPoint } = {}) {
+    logger.info('dev component', { folder, rootDid, mountPoint });
 
     const meta = getBlockletMeta(folder);
     if (meta.group !== 'static' && (!meta.scripts || !meta.scripts.dev)) {
       throw new Error('Incorrect blocklet manifest: missing `scripts.dev` field');
     }
 
+    if (rootDid) {
+      return this._devComponent({ folder, meta, rootDid, mountPoint });
+    }
+
+    return this._devBlocklet({ folder, meta });
+  }
+
+  async _devBlocklet({ folder, meta }) {
     const { did, version } = meta;
 
     const exist = await states.blocklet.getBlocklet(did);
@@ -985,10 +1029,63 @@ class BlockletManager extends BaseBlockletManager {
 
     const blocklet = await this.ensureBlocklet(did);
 
+    await fs.writeFile(path.join(blocklet.env.dataDir, 'logo.svg'), createDidLogo(blocklet.meta.did));
+
     return blocklet;
   }
 
-  async ensureBlocklet(did) {
+  async _devComponent({ folder, meta, rootDid, mountPoint }) {
+    const { did, version } = meta;
+
+    const existRoot = await states.blocklet.getBlocklet(rootDid);
+    if (!existRoot) {
+      throw new Error('Root blocklet does not exist');
+    }
+
+    const exist = existRoot.children.find((x) => x.meta.did === meta.did);
+    if (exist) {
+      if (exist.mode === BLOCKLET_MODES.PRODUCTION) {
+        throw new Error('The blocklet component of production mode already exists, please remove it before developing');
+      }
+
+      const status = fromBlockletStatus(exist.status);
+      if (['starting', 'running'].includes(status)) {
+        throw new Error(`The blocklet component is already on ${status}, please stop it before developing`);
+      }
+
+      logger.info('remove blocklet component for dev', { did, version });
+
+      await this.deleteComponent({ did, rootDid });
+    }
+
+    const defaultPath = formatName(meta.name);
+    const children = await parseChildren(existRoot.meta, {
+      children: [
+        {
+          meta,
+          mountPoint: mountPoint || `/${defaultPath}`,
+          source: BlockletSource.local,
+          deployedFrom: folder,
+          status: BlockletStatus.installed,
+          mode: BLOCKLET_MODES.DEVELOPMENT,
+        },
+      ],
+      dynamic: true,
+    });
+    await states.blocklet.addChildren(rootDid, children);
+
+    logger.info('add blocklet component for dev', { did, version, meta });
+
+    // Add environments
+    await this._setConfigs(rootDid);
+    await this.updateBlockletEnvironment(rootDid);
+
+    const rootBlocklet = await this.ensureBlocklet(rootDid);
+
+    return rootBlocklet;
+  }
+
+  async ensureBlocklet(did, e2eMode = false) {
     if (!isValidDid(did)) {
       throw new Error(`Blocklet did is invalid: ${did}`);
     }
@@ -1006,6 +1103,7 @@ class BlockletManager extends BaseBlockletManager {
       ...getBlockletDirs(blocklet, {
         dataDirs: this.dataDirs,
         ensure: true,
+        e2eMode,
       }),
     };
 
@@ -1734,7 +1832,7 @@ class BlockletManager extends BaseBlockletManager {
       meta,
       mountPoint,
       source: BlockletSource.upload,
-      deployedFrom: `Upload by ${context.user.did}`,
+      deployedFrom: `Upload by ${context.user.fullName}`,
       sourceUrl: '',
       dynamic: true,
     };
@@ -2216,7 +2314,7 @@ class BlockletManager extends BaseBlockletManager {
       blocklet = await this.ensureBlocklet(did);
       logger.info('blocklet installed', { source, did: meta.did });
 
-      await fs.writeFile(path.join(blocklet.env.dataDir, 'logo.png'), createDidLogo(blocklet.meta.did));
+      await fs.writeFile(path.join(blocklet.env.dataDir, 'logo.svg'), createDidLogo(blocklet.meta.did));
 
       this.emit(BlockletEvents.installed, { blocklet, context });
 
@@ -2344,7 +2442,7 @@ class BlockletManager extends BaseBlockletManager {
 
       blocklet = await this.ensureBlocklet(did, context);
 
-      await fs.writeFile(path.join(blocklet.env.dataDir, 'logo.png'), createDidLogo(blocklet.meta.did));
+      await fs.writeFile(path.join(blocklet.env.dataDir, 'logo.svg'), createDidLogo(blocklet.meta.did));
 
       this.refreshListCache();
 

package/lib/event.js

@@ -30,6 +30,8 @@ module.exports = ({
   const nodeState = states.node;
 
   const events = new EventEmitter();
+  events.setMaxListeners(0);
+
   // HACK: do not emit any events from CLI
   if (isCLI() && process.env.NODE_ENV !== 'test') {
     events.emit = (name) => logger.debug('stopped core state event in CLI', name);

package/lib/index.js

@@ -133,11 +133,13 @@ function ABTNode(options) {
     registry: blockletRegistry,
     daemon: options.daemon,
   });
+  blockletManager.setMaxListeners(0);
 
   const {
     handleRouting,
     getRoutingRulesByDid,
     getSiteByDid,
+    resetSiteByDid,
     updateNodeRouting,
     takeRoutingSnapshot,
     getRoutingSites,
@@ -159,6 +161,7 @@ function ABTNode(options) {
 
   blockletManager.getRoutingRulesByDid = getRoutingRulesByDid;
   blockletManager.getSiteByDid = getSiteByDid;
+  blockletManager.resetSiteByDid = resetSiteByDid;
 
   // Generate an on node ready callback
   const onStatesReady = createStateReadyQueue({ states, options, dataDirs });
@@ -216,6 +219,7 @@ function ABTNode(options) {
     updateChildBlocklets: blockletManager.updateChildren.bind(blockletManager),
     getLatestBlockletVersion: blockletManager.getLatestBlockletVersion.bind(blockletManager),
     getBlockletMetaFromUrl: blockletManager.getMetaFromUrl.bind(blockletManager),
+    resetBlocklet: blockletManager.reset.bind(blockletManager),
 
     deleteBlockletProcess: blockletManager.deleteProcess.bind(blockletManager),
 

package/lib/migrations/1.0.21-update-config.js

@@ -7,7 +7,7 @@ module.exports = async ({ states, config, configFile, printInfo }) => {
   printInfo('Try to update node config to 1.0.21...');
   let changed = false;
 
-  const rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+  const rawConfig = yaml.load(fs.readFileSync(configFile).toString());
   const info = await states.node.read();
 
   const updates = [

package/lib/migrations/1.0.22-max-memory.js

@@ -13,7 +13,7 @@ module.exports = async ({ states, config, configFile, printInfo }) => {
   printInfo('Try to update node config to 1.0.22...');
   let changed = false;
 
-  const rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+  const rawConfig = yaml.load(fs.readFileSync(configFile).toString());
   const info = await states.node.read();
 
   const updates = [

package/lib/migrations/1.0.25.js

@@ -10,7 +10,7 @@ module.exports = async ({ states, config, configFile, printInfo }) => {
   printInfo('Try to update node config to 1.0.25...');
   let changed = false;
 
-  const rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+  const rawConfig = yaml.load(fs.readFileSync(configFile).toString());
   const info = await states.node.read();
 
   const updates = [

package/lib/migrations/1.0.32-update-config.js

@@ -7,7 +7,7 @@ module.exports = async ({ states, config, configFile, printInfo }) => {
   printInfo('Try to update node config to 1.0.32...');
   let changed = false;
 
-  const rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+  const rawConfig = yaml.load(fs.readFileSync(configFile).toString());
   const info = await states.node.read();
 
   const updates = [{ key: 'routing.https', value: true }];

package/lib/migrations/1.6.21-rename-ip-echo-domain.js

@@ -22,7 +22,7 @@ module.exports = async ({ states, printInfo, configFile }) => {
   await states.node.updateNodeInfo(info);
 
   if (process.env.NODE_ENV !== 'development') {
-    let rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+    let rawConfig = yaml.load(fs.readFileSync(configFile).toString());
     set(rawConfig, 'node.routing.ipWildcardDomain', info.routing.ipWildcardDomain);
     set(rawConfig, 'node.routing.wildcardCertHost', DEFAULT_WILDCARD_CERT_HOST);
     set(rawConfig, 'node.didDomain', DEFAULT_DID_DOMAIN);

package/lib/migrations/1.6.4-security.js

@@ -19,7 +19,7 @@ module.exports = async ({ states, configFile, dataDir }) => {
   try {
     fs.writeFileSync(file, crypto.randomBytes(32), { encoding: 'binary', mode: '0600' });
 
-    const config = yaml.safeLoad(fs.readFileSync(configFile).toString(), { json: true });
+    const config = yaml.load(fs.readFileSync(configFile).toString(), { json: true });
     config.node.sk = security.encrypt(config.node.sk, config.node.did, fs.readFileSync(file));
     fs.writeFileSync(configFile, yaml.dump(config));
     await states.node.updateNodeInfo({ sk: config.node.sk });

package/lib/migrations/README.md

@@ -41,7 +41,7 @@ module.exports = async ({ states, config, configFile, printInfo }) => {
   printInfo('Try to update node config to 1.0.21...');
   let changed = false;
 
-  const rawConfig = yaml.safeLoad(fs.readFileSync(configFile).toString());
+  const rawConfig = yaml.load(fs.readFileSync(configFile).toString());
   const info = await states.node.read();
 
   const updates = [

package/lib/router/helper.js

@@ -1131,6 +1131,16 @@ module.exports = function getRouterHelpers({ dataDirs, routingSnapshot, routerMa
     return (sites || []).find((x) => x.domain === domain);
   }
 
+  async function resetSiteByDid(did, { refreshRouterProvider = true } = {}) {
+    const blocklet = await states.blocklet.getBlocklet(did);
+    await removeBlockletRouting(blocklet);
+    await ensureBlockletRouting(blocklet);
+    if (refreshRouterProvider) {
+      const hash = await takeRoutingSnapshot({ message: `Reset blocklet ${did}`, dryRun: false });
+      logger.info('reset blocklet routing rules', { did, hash });
+    }
+  }
+
   const providers = {}; // we need to keep reference for different router instances
   const handleRouting = async (nodeInfo) => {
     const providerName = get(nodeInfo, 'routing.provider', null);
@@ -1382,6 +1392,7 @@ module.exports = function getRouterHelpers({ dataDirs, routingSnapshot, routerMa
     handleRouting,
     getRoutingRulesByDid,
     getSiteByDid,
+    resetSiteByDid,
     updateNodeRouting,
     takeRoutingSnapshot,
     getRoutingSites,

package/lib/states/blocklet.js

@@ -66,6 +66,16 @@ const formatBlocklet = (blocklet, phase, dek) => {
   return blocklet;
 };
 
+const fixChildren = (children) => {
+  if (!children) {
+    return;
+  }
+
+  children.forEach((child) => {
+    child.mode = child.mode || BLOCKLET_MODES.PRODUCTION;
+  });
+};
+
 class BlockletState extends BaseState {
   /**
    * Creates an instance of BlockletState
@@ -163,6 +173,8 @@ class BlockletState extends BaseState {
               defaultPort: getMaxPort(ports),
             });
 
+            fixChildren(children);
+
             // add to db
             this.db.insert(
               {
@@ -244,6 +256,8 @@ class BlockletState extends BaseState {
             logger.info('Fill children ports when when upgrading blocklet', { name: doc.meta.name, did: doc.meta.did });
             await this.fillChildrenPorts(children, { oldChildren: doc.children, defaultPort: getMaxPort(ports) });
 
+            fixChildren(children);
+
             // add to db
             const newDoc = await this.updateBlocklet(meta.did, {
               meta: omit(sanitized, ['htmlAst']),
@@ -506,7 +520,7 @@ class BlockletState extends BaseState {
 
     const newChildren = [...oldChildren];
     for (const child of children) {
-      const { meta, mountPoint, sourceUrl = '', source = '', deployedFrom = '' } = child;
+      const { meta, mountPoint, sourceUrl = '', source = '', deployedFrom = '', mode } = child;
 
       if (!mountPoint) {
         throw new Error(`mountPoint is required when adding component ${getDisplayName(child, true)}`);
@@ -524,9 +538,12 @@ class BlockletState extends BaseState {
         sourceUrl,
         source,
         deployedFrom,
+        mode,
         dynamic: true,
         status: BlockletStatus.added,
       });
+
+      fixChildren(newChildren);
     }
 
     // use upgradeBlocklet to assign ports to children and write new data to db

package/lib/util/blocklet.js

@@ -104,7 +104,7 @@ const PRIVATE_NODE_ENVS = [
  * appMain: app entry file or script (run appMain to start blocklet process)
  * appCwd: cwd of appMain
  */
-const getBlockletDirs = (blocklet, { rootBlocklet, dataDirs, ensure = false } = {}) => {
+const getBlockletDirs = (blocklet, { rootBlocklet, dataDirs, ensure = false, e2eMode = false } = {}) => {
   if (!rootBlocklet) {
     // eslint-disable-next-line no-param-reassign
     rootBlocklet = blocklet;
@@ -126,8 +126,13 @@ const getBlockletDirs = (blocklet, { rootBlocklet, dataDirs, ensure = false } =
 
   const { main, group } = blocklet.meta;
 
-  const startFromDevEntry =
-    blocklet.mode === BLOCKLET_MODES.DEVELOPMENT && blocklet.meta.scripts && blocklet.meta.scripts.dev;
+  let startFromDevEntry = '';
+  if (blocklet.mode === BLOCKLET_MODES.DEVELOPMENT && blocklet.meta.scripts) {
+    startFromDevEntry = blocklet.meta.scripts.dev;
+    if (e2eMode && blocklet.meta.scripts.e2eDev) {
+      startFromDevEntry = blocklet.meta.scripts.e2eDev;
+    }
+  }
 
   if (!main && !startFromDevEntry && group !== BlockletGroup.gateway) {
     throw new Error('Incorrect blocklet manifest: missing `main` field');
@@ -174,7 +179,7 @@ const getBlockletDirs = (blocklet, { rootBlocklet, dataDirs, ensure = false } =
   let appMain = null;
   let appCwd = null;
   if (startFromDevEntry) {
-    appMain = blocklet.meta.scripts.dev;
+    appMain = startFromDevEntry;
     appCwd = appDir;
   } else if (group === 'dapp') {
     appMain = getBlockletEngine(blocklet.meta).script || BLOCKLET_ENTRY_FILE;
@@ -414,7 +419,7 @@ const getBlockletMetaFromUrl = async (url) => {
  * Start all precesses of a blocklet
  * @param {*} blocklet should contain env props
  */
-const startBlockletProcess = async (blocklet, { preStart = noop, nodeEnvironments, nodeInfo } = {}) => {
+const startBlockletProcess = async (blocklet, { preStart = noop, nodeEnvironments, nodeInfo, e2eMode } = {}) => {
   if (!blocklet) {
     throw new Error('blocklet should not be empty');
   }
@@ -463,7 +468,7 @@ const startBlockletProcess = async (blocklet, { preStart = noop, nodeEnvironment
       }
 
       if (b.mode === BLOCKLET_MODES.DEVELOPMENT) {
-        options.env.NODE_ENV = 'development';
+        options.env.NODE_ENV = e2eMode ? 'e2e' : 'development';
         options.env.BROWSER = 'none';
         options.env.PORT = options.env[BLOCKLET_DEFAULT_PORT_NAME];
         options.script = appMain;

package/lib/util/get-domain-for-blocklet.js

@@ -23,4 +23,4 @@ const getDidDomainForBlocklet = ({ name, daemonDid, didDomain }) => {
   return `${prefix}-${daemonDid.toLowerCase()}.${didDomain}`;
 };
 
-module.exports = { getIpDnsDomainForBlocklet, getDidDomainForBlocklet };
+module.exports = { getIpDnsDomainForBlocklet, getDidDomainForBlocklet, formatName };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.5",
+  "version": "1.7.8",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,32 +19,32 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/certificate-manager": "1.7.5",
-    "@abtnode/constant": "1.7.5",
-    "@abtnode/cron": "1.7.5",
-    "@abtnode/db": "1.7.5",
-    "@abtnode/logger": "1.7.5",
-    "@abtnode/queue": "1.7.5",
-    "@abtnode/rbac": "1.7.5",
-    "@abtnode/router-provider": "1.7.5",
-    "@abtnode/static-server": "1.7.5",
-    "@abtnode/timemachine": "1.7.5",
-    "@abtnode/util": "1.7.5",
-    "@arcblock/did": "^1.15.7",
-    "@arcblock/did-motif": "^1.1.3",
-    "@arcblock/event-hub": "1.15.7",
+    "@abtnode/certificate-manager": "1.7.8",
+    "@abtnode/constant": "1.7.8",
+    "@abtnode/cron": "1.7.8",
+    "@abtnode/db": "1.7.8",
+    "@abtnode/logger": "1.7.8",
+    "@abtnode/queue": "1.7.8",
+    "@abtnode/rbac": "1.7.8",
+    "@abtnode/router-provider": "1.7.8",
+    "@abtnode/static-server": "1.7.8",
+    "@abtnode/timemachine": "1.7.8",
+    "@abtnode/util": "1.7.8",
+    "@arcblock/did": "^1.16.3",
+    "@arcblock/did-motif": "^1.1.5",
+    "@arcblock/event-hub": "1.16.3",
     "@arcblock/pm2-events": "^0.0.5",
-    "@arcblock/vc": "^1.15.7",
-    "@blocklet/meta": "1.7.5",
+    "@arcblock/vc": "^1.16.3",
+    "@blocklet/meta": "1.7.8",
     "@fidm/x509": "^1.2.1",
     "@nedb/core": "^1.2.2",
     "@nedb/multi": "^1.2.2",
-    "@ocap/mcrypto": "^1.15.7",
-    "@ocap/util": "^1.15.7",
-    "@ocap/wallet": "^1.15.7",
+    "@ocap/mcrypto": "^1.16.3",
+    "@ocap/util": "^1.16.3",
+    "@ocap/wallet": "^1.16.3",
     "@slack/webhook": "^5.0.3",
     "ajv": "^7.0.3",
-    "axios": "^0.25.0",
+    "axios": "^0.26.1",
     "axon": "^2.0.3",
     "chalk": "^4.0.0",
     "deep-diff": "^1.0.2",
@@ -56,7 +56,7 @@
     "is-ip": "^3.1.0",
     "is-url": "^1.2.4",
     "joi": "^17.6.0",
-    "js-yaml": "^3.14.0",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "lru-cache": "^6.0.0",
     "pm2": "^5.1.2",
@@ -78,5 +78,5 @@
     "express": "^4.17.1",
     "jest": "^27.4.5"
   },
-  "gitHead": "b17d83773e5a4c06bae390fc70398d49d6dd86b3"
+  "gitHead": "ae75dd20b4750a31dc53c88b75ed1d95c8f15397"
 }