@abtnode/core 1.16.0-beta-8ee536d7 → 1.16.0-beta-62b42401

package/lib/blocklet/storage/restore/disk.js

@@ -0,0 +1,104 @@
+const { isValid } = require('@arcblock/did');
+const { isEmpty } = require('lodash');
+const merge = require('lodash/merge');
+const { ensureDirSync, existsSync, rmSync, copy } = require('fs-extra');
+
+const { getBackupDirs } = require('../utils/disk');
+const { BaseRestore } = require('./base');
+const { BlockletExtrasRestore } = require('./blocklet-extras');
+const { BlockletRestore } = require('./blocklet');
+const { BlockletsRestore } = require('./blocklets');
+
+class DiskRestore extends BaseRestore {
+  /**
+   *
+   * @type {import('./base').BaseRestoreInput}
+   * @memberof DiskRestore
+   */
+  input;
+
+  /**
+   * @type {string}
+   * @memberof DiskRestore
+   */
+  restoreDir;
+
+  /**
+   *
+   * @description server 的数据目录
+   * @type {string}
+   * @memberof DiskRestore
+   */
+  serverDir;
+
+  storages;
+
+  /**
+   *
+   * @param {import('./base').BaseRestoreInput} input
+   * @memberof DiskRestore
+   */
+  constructor(input) {
+    super(input);
+    this.verify(input);
+    this.input = input;
+    this.storages = [
+      new BlockletExtrasRestore(this.input),
+      new BlockletRestore(this.input),
+      new BlockletsRestore(this.input),
+    ];
+  }
+
+  /**
+   *
+   * @param {import('./base').BaseRestoreInput} input
+   * @returns {void}
+   * @memberof DiskRestore
+   */
+  verify(input) {
+    if (isEmpty(input?.appDid) || !isValid(input?.appDid)) {
+      throw new Error(`input.appDid(${input?.appDid}) is not a valid did`);
+    }
+  }
+
+  async initialize() {
+    this.serverDir = process.env.ABT_NODE_DATA_DIR;
+    this.restoreDir = getBackupDirs(this.serverDir, this.input.appDid).restoreDir;
+    if (existsSync(this.restoreDir)) {
+      rmSync(this.restoreDir, { recursive: true });
+    }
+    ensureDirSync(this.restoreDir);
+
+    this.storages.map((x) => x.ensureParams(this));
+  }
+
+  async restore() {
+    await this.initialize();
+    await this.syncFromBackupDir();
+
+    const params = await Promise.all(this.storages.map((x) => x.getImportParams()));
+    await this.import(merge(...params));
+
+    return this.storages.map((x) => x.getInstallParams());
+  }
+
+  async syncFromBackupDir() {
+    const { appDid } = this.input;
+
+    const { backupDir } = getBackupDirs(this.serverDir, appDid);
+
+    await copy(backupDir, this.restoreDir);
+  }
+
+  async import(params) {
+    await Promise.all(
+      this.storages.map((storage) => {
+        return storage.import(params);
+      })
+    );
+  }
+}
+
+module.exports = {
+  DiskRestore,
+};

package/lib/blocklet/storage/restore/spaces.js

@@ -13,18 +13,19 @@
 
 const validUrl = require('valid-url');
 const merge = require('lodash/merge');
-const { BlockletEvents } = require('@blocklet/constant');
+const { BlockletEvents, RESTORE_PROGRESS_STATUS } = require('@blocklet/constant');
 const { SpaceClient, RestoreBlockletCommand } = require('@did-space/client');
 const { ensureDirSync, existsSync, rmSync } = require('fs-extra');
-const { join, basename } = require('path');
+const { join } = require('path');
 
 const logger = require('@abtnode/logger')('@abtnode/core:storage:restore');
 
+const { BaseRestore } = require('./base');
 const { BlockletExtrasRestore } = require('./blocklet-extras');
 const { BlockletRestore } = require('./blocklet');
 const { BlockletsRestore } = require('./blocklets');
 
-class SpacesRestore {
+class SpacesRestore extends BaseRestore {
   /**
    *
    * @type {SpaceRestoreInput}
@@ -55,6 +56,7 @@ class SpacesRestore {
    * @memberof SpacesRestore
    */
   constructor(input) {
+    super(input);
     this.verify(input);
     this.input = input;
     this.storages = [
@@ -120,7 +122,8 @@ class SpacesRestore {
           logger.info('restore progress', { appDid: this.input.appDid, data });
           this.input.event.emit(BlockletEvents.restoreProgress, {
             appDid: this.input.appDid,
-            message: `Downloaded file ${basename(data.key)} (${data.completed}/${data.total})`,
+            status: RESTORE_PROGRESS_STATUS.downloading,
+            data,
           });
         },
 
@@ -137,8 +140,9 @@ class SpacesRestore {
   async import(params) {
     this.input.event.emit(BlockletEvents.restoreProgress, {
       appDid: this.input.appDid,
-      message: 'Preparing to import data...',
+      status: RESTORE_PROGRESS_STATUS.importData,
     });
+
     await Promise.all(
       this.storages.map((storage) => {
         return storage.import(params);
@@ -146,7 +150,7 @@ class SpacesRestore {
     );
     this.input.event.emit(BlockletEvents.restoreProgress, {
       appDid: this.input.appDid,
-      message: 'Importing data successfully...',
+      status: RESTORE_PROGRESS_STATUS.importDataSuccess,
     });
   }
 }

package/lib/blocklet/storage/utils/disk.js

@@ -0,0 +1,61 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+const logger = require('@abtnode/logger')('@abtnode/core:storage:utils:disk');
+
+const backupDirName = '_abtnode/backup';
+const restoreDirName = 'tmp/restore-disk';
+
+const getBackupList = (dataDir) => {
+  const baseBackupDir = path.join(dataDir, backupDirName);
+  const backupList = [];
+  const appDidList = fs.readdirSync(baseBackupDir);
+
+  appDidList.forEach((appDid) => {
+    const metaFile = path.join(baseBackupDir, appDid, 'meta.json');
+    if (fs.existsSync(metaFile)) {
+      try {
+        const meta = fs.readJsonSync(metaFile);
+        if (meta.appDid === appDid) {
+          backupList.push(meta);
+        }
+      } catch (error) {
+        logger.error('read meta.json error', error);
+      }
+    }
+  });
+
+  return backupList;
+};
+
+const removeBackup = async (dataDir, appDid) => {
+  try {
+    const baseBackupDir = path.join(dataDir, backupDirName);
+    const backupDir = path.join(baseBackupDir, appDid);
+    if (fs.existsSync(backupDir)) {
+      await fs.remove(backupDir);
+      return true;
+    }
+    return false;
+  } catch (error) {
+    logger.error('remove backup error', error);
+    return false;
+  }
+};
+
+const getBackupDirs = (serverDir, appDid) => {
+  const baseBackupDir = path.join(serverDir, 'data', backupDirName, appDid);
+  const backupDir = path.join(baseBackupDir, appDid);
+  const restoreDir = path.join(serverDir, restoreDirName, appDid);
+  return {
+    baseBackupDir,
+    backupDir,
+    restoreDir,
+  };
+};
+
+module.exports = {
+  getBackupList,
+  removeBackup,
+  getBackupDirs,
+};

package/lib/event.js

@@ -257,7 +257,13 @@ module.exports = ({
     }
 
     if (
-      ![BlockletEvents.removed, BlockletEvents.dataCleaned].includes(eventName) &&
+      [
+        BlockletEvents.started,
+        BlockletEvents.startFailed,
+        BlockletEvents.stopped,
+        BlockletEvents.reloaded,
+        BlockletEvents.statusChange,
+      ].includes(eventName) &&
       blocklet.status &&
       !isBeforeInstalled(blocklet.status)
     ) {

package/lib/index.js

@@ -230,11 +230,12 @@ function ABTNode(options) {
     deleteBlockletProcess: blockletManager.deleteProcess.bind(blockletManager),
     configPublicToStore: blockletManager.configPublicToStore.bind(blockletManager),
     configNavigations: blockletManager.configNavigations.bind(blockletManager),
+    configOAuth: blockletManager.configOAuth.bind(blockletManager),
     updateWhoCanAccess: blockletManager.updateWhoCanAccess.bind(blockletManager),
     updateComponentTitle: blockletManager.updateComponentTitle.bind(blockletManager),
     updateComponentMountPoint: blockletManager.updateComponentMountPoint.bind(blockletManager),
-    backupToSpaces: blockletManager.backupToSpaces.bind(blockletManager),
-    restoreFromSpaces: blockletManager.restoreFromSpaces.bind(blockletManager),
+    backupBlocklet: blockletManager.backup.bind(blockletManager),
+    restoreBlocklet: blockletManager.restore.bind(blockletManager),
     migrateApplicationToStructV2: blockletManager.migrateApplicationToStructV2.bind(blockletManager),
 
     // For diagnose purpose
@@ -243,6 +244,7 @@ function ABTNode(options) {
     updateBlockletStatus: states.blocklet.setBlockletStatus.bind(states.blocklet),
 
     getBlocklets: blockletManager.list.bind(blockletManager),
+    getBlockletsFromBackup: blockletManager.listBackups.bind(blockletManager),
     getBlocklet: blockletManager.detail.bind(blockletManager),
     getBlockletDiff: blockletManager.diff.bind(blockletManager),
     hasBlocklet: blockletManager.hasBlocklet.bind(blockletManager),

package/lib/states/audit-log.js

@@ -127,6 +127,8 @@ const getLogContent = async (action, args, context, result, info, node) => {
       return `updated following navigations for blocklet ${getBlockletInfo(result, info)}:\n${args.navigations.map(
         (x) => `- ${x.title}: ${x.link}\n`
       )}`;
+    case 'configOAuth':
+      return `updated following OAuth for blocklet ${getBlockletInfo(result, info)}:\n${args.oauth}`;
     case 'updateComponentTitle':
       return `update component title to **${args.title}** for blocklet ${getBlockletInfo(result, info)}`;
     case 'updateComponentMountPoint':
@@ -271,6 +273,7 @@ const getLogCategory = (action) => {
     case 'upgradeComponents':
     case 'configPublicToStore':
     case 'configNavigations':
+    case 'configOAuth':
     case 'updateComponentTitle':
     case 'updateComponentMountPoint':
       return 'blocklet';

package/lib/states/user.js

@@ -9,6 +9,42 @@ const { validateOwner } = require('../util');
 
 const isNullOrUndefined = (x) => x === undefined || x === null;
 
+/**
+ * UserPassport
+ * @typedef {Object} UserPassport
+ * @property {string} id - id
+ * @property {string[]} [type] - passport's type
+ * @property {string[]} [issuer] - passport's issuer
+ * @property {Date} [issuanceDate] - passport's issuanceDate
+ * @property {string} [specVersion] - passport's specVersion
+ * @property {string} name - passport's name
+ * @property {string} [title] - passport's title
+ * @property {string} [endpoint] - passport's endpoint
+ * @property {string} [status] - passport's status
+ * @property {string} role - passport's role
+ */
+
+/**
+ * The Data structure of blocklet-service user
+ * @typedef {Object} BlockletUser - Blocklet Service User Table
+ * @property {string} _id - id
+ * @property {('profile')} type - type of user
+ * @property {string} fullName - user profile's name
+ * @property {string} avatar - url of user's avatar, eg: bn://avatar/7f8848569405f8cdf8b1b2788ebf7d0f.jpg
+ * @property {string} did - user's did
+ * @property {('owner'|'admin'|'member'|'guest'|string)} role - user's role
+ * @property {UserPassport[]} passports - user's passport list
+ * @property {string} pk - user's publicKey
+ * @property {boolean} approved - enable user to login
+ * @property {string} locale - locale
+ * @property {Object} extra - extra data of user
+ * @property {Date} firstLoginAt - firstLoginAt
+ * @property {Date} lastLoginAt - lastLoginAt
+ * @property {string} lastLoginIp - lastLoginIp
+ * @property {Date} createdAt - createdAt
+ * @property {Date} updatedAt - updatedAt
+ */
+
 class User extends BaseState {
   constructor(baseDir, config = {}) {
     super(baseDir, { filename: 'user.db', ...config });
@@ -22,6 +58,11 @@ class User extends BaseState {
     });
   }
 
+  /**
+   * Add a new user
+   * @param {BlockletUser} user - user data
+   * @returns {Promise<number>}
+   */
   async add(user) {
     if (!validateOwner(user)) {
       throw new Error('user is invalid');
@@ -33,7 +74,14 @@ class User extends BaseState {
     });
   }
 
+  /**
+   * Update a user
+   * @param {BlockletUser} user - user data
+   * @returns {BlockletUser}
+   */
   async update(user) {
+    // FIXME: @zhanghan 这里为什么要限制？
+    // 限制后也无法更新 lastLoginAt ?
     if (!validateOwner(user)) {
       throw new Error('user is invalid');
     }
@@ -59,6 +107,11 @@ class User extends BaseState {
     return this._setPassportStatusById({ did, id, status: PASSPORT_STATUS.VALID });
   }
 
+  /**
+   * remove a user by user's did
+   * @param {string} did - the did of user
+   * @returns {number} deleted count
+   */
   async remove({ did }) {
     const num = await super.remove({ did });
 
@@ -69,6 +122,12 @@ class User extends BaseState {
     return num;
   }
 
+  /**
+   * enable/disable user login
+   * @param {string} did user's did
+   * @param {boolean} approved enable/disable user login
+   * @returns {BlockletUser}
+   */
   async updateApproved({ did, approved }) {
     const [num, doc] = await super.update({ did }, { $set: { approved } });
 
@@ -79,6 +138,12 @@ class User extends BaseState {
     return doc;
   }
 
+  /**
+   * update user's role
+   * @param {string} did user's did
+   * @param {BlockletUser.role} role user's rolel
+   * @returns {BlockletUser}
+   */
   async updateRole({ did, role }) {
     const [num, doc] = await super.update({ did }, { $set: { role } });
 
@@ -89,8 +154,15 @@ class User extends BaseState {
     return doc;
   }
 
+  /**
+   * Get blocklet service user list
+   * @param {Object} query query params
+   * @param {('asc'|'desc')} sort query sort
+   * @param {any} paging query paging
+   * @returns {{list: BlockletUser[]; paging: any;}}
+   */
   async getUsers({ query, sort, paging: inputPaging } = {}) {
-    const { approved, role, search } = query || {};
+    const { approved, role, search, derivedDid } = query || {};
 
     // make query param
     const queryParam = {};
@@ -121,6 +193,11 @@ class User extends BaseState {
       }
     }
 
+    // 根据 derivedDid 查询 user 信息（wallet 账户绑定 oauth 账户后，会有该字段）
+    if (derivedDid) {
+      queryParam['derivedAccount.did'] = derivedDid;
+    }
+
     const sortParam = pickBy(sort, (x) => !isNullOrUndefined(x));
 
     if (!Object.keys(sortParam).length) {
@@ -136,6 +213,11 @@ class User extends BaseState {
     };
   }
 
+  /**
+   * get user list by did list
+   * @param {string[]} dids user did list
+   * @returns {BlockletUser[]}
+   */
   async getUsersByDids({ dids, query } = {}) {
     const { approved } = query || {};
     const didList = dids || [];
@@ -152,6 +234,11 @@ class User extends BaseState {
     return this.find(queryParam);
   }
 
+  /**
+   * get user by did
+   * @param {string} did user's did
+   * @returns {BlockletUser}
+   */
   async getUser(did) {
     const doc = await this.findOne({ did });
     return doc;

package/lib/util/blocklet.js

@@ -72,6 +72,7 @@ const {
   getSharedConfigObj,
   getComponentName,
   isEnvShareable,
+  getBlockletAppIdList,
 } = require('@blocklet/meta/lib/util');
 const toBlockletDid = require('@blocklet/meta/lib/did');
 const { titleSchema, descriptionSchema, logoSchema } = require('@blocklet/meta/lib/schema');
@@ -429,6 +430,8 @@ const getRuntimeEnvironments = (blocklet, nodeEnvironments, ancestors) => {
     ? getBlockletWallet(blocklet.meta.did, nodeEnvironments.ABT_NODE_SK, undefined, 1)
     : null;
 
+  const BLOCKLET_APP_IDS = getBlockletAppIdList(root).join(',');
+
   const env = {
     ...blocklet.configObj,
     ...getSharedConfigObj(blocklet, ancestors),
@@ -439,6 +442,7 @@ const getRuntimeEnvironments = (blocklet, nodeEnvironments, ancestors) => {
     BLOCKLET_MODE: blocklet.mode || BLOCKLET_MODES.PRODUCTION,
     BLOCKLET_APP_EK: tmp?.secretKey,
     BLOCKLET_APP_VERSION: root.meta.version,
+    BLOCKLET_APP_IDS,
     ...nodeEnvironments,
     ...safeNodeEnvironments,
   };
@@ -1825,6 +1829,38 @@ const getBlockletKnownAs = (blocklet) => {
   return alsoKnownAs.filter(Boolean).map(toDid);
 };
 
+const getFixedBundleSource = (component) => {
+  if (!component) {
+    return null;
+  }
+
+  if (component.bundleSource) {
+    return component.bundleSource;
+  }
+
+  const { source, deployedFrom, meta: { bundleName } = {} } = component;
+
+  if (!deployedFrom) {
+    return null;
+  }
+
+  if (source === BlockletSource.registry && bundleName) {
+    return {
+      store: deployedFrom,
+      name: bundleName,
+      version: 'latest',
+    };
+  }
+
+  if (source === BlockletSource.url) {
+    return {
+      url: deployedFrom,
+    };
+  }
+
+  return null;
+};
+
 module.exports = {
   consumeServerlessNFT,
   forEachBlocklet,
@@ -1879,4 +1915,5 @@ module.exports = {
   checkVersionCompatibility,
   validateBlockletMeta,
   getBlockletKnownAs,
+  getFixedBundleSource,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.0-beta-8ee536d7",
+  "version": "1.16.0-beta-62b42401",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,34 +19,34 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/auth": "1.16.0-beta-8ee536d7",
-    "@abtnode/certificate-manager": "1.16.0-beta-8ee536d7",
-    "@abtnode/constant": "1.16.0-beta-8ee536d7",
-    "@abtnode/cron": "1.16.0-beta-8ee536d7",
-    "@abtnode/db": "1.16.0-beta-8ee536d7",
-    "@abtnode/logger": "1.16.0-beta-8ee536d7",
-    "@abtnode/queue": "1.16.0-beta-8ee536d7",
-    "@abtnode/rbac": "1.16.0-beta-8ee536d7",
-    "@abtnode/router-provider": "1.16.0-beta-8ee536d7",
-    "@abtnode/static-server": "1.16.0-beta-8ee536d7",
-    "@abtnode/timemachine": "1.16.0-beta-8ee536d7",
-    "@abtnode/util": "1.16.0-beta-8ee536d7",
-    "@arcblock/did": "1.18.62",
+    "@abtnode/auth": "1.16.0-beta-62b42401",
+    "@abtnode/certificate-manager": "1.16.0-beta-62b42401",
+    "@abtnode/constant": "1.16.0-beta-62b42401",
+    "@abtnode/cron": "1.16.0-beta-62b42401",
+    "@abtnode/db": "1.16.0-beta-62b42401",
+    "@abtnode/logger": "1.16.0-beta-62b42401",
+    "@abtnode/queue": "1.16.0-beta-62b42401",
+    "@abtnode/rbac": "1.16.0-beta-62b42401",
+    "@abtnode/router-provider": "1.16.0-beta-62b42401",
+    "@abtnode/static-server": "1.16.0-beta-62b42401",
+    "@abtnode/timemachine": "1.16.0-beta-62b42401",
+    "@abtnode/util": "1.16.0-beta-62b42401",
+    "@arcblock/did": "1.18.63",
     "@arcblock/did-motif": "^1.1.10",
-    "@arcblock/did-util": "1.18.62",
-    "@arcblock/event-hub": "1.18.62",
-    "@arcblock/jwt": "^1.18.62",
+    "@arcblock/did-util": "1.18.63",
+    "@arcblock/event-hub": "1.18.63",
+    "@arcblock/jwt": "^1.18.63",
     "@arcblock/pm2-events": "^0.0.5",
-    "@arcblock/vc": "1.18.62",
-    "@blocklet/constant": "1.16.0-beta-8ee536d7",
-    "@blocklet/meta": "1.16.0-beta-8ee536d7",
-    "@blocklet/sdk": "1.16.0-beta-8ee536d7",
-    "@did-space/client": "^0.2.33",
+    "@arcblock/vc": "1.18.63",
+    "@blocklet/constant": "1.16.0-beta-62b42401",
+    "@blocklet/meta": "1.16.0-beta-62b42401",
+    "@blocklet/sdk": "1.16.0-beta-62b42401",
+    "@did-space/client": "^0.2.40",
     "@fidm/x509": "^1.2.1",
-    "@ocap/client": "1.18.62",
-    "@ocap/mcrypto": "1.18.62",
-    "@ocap/util": "1.18.62",
-    "@ocap/wallet": "1.18.62",
+    "@ocap/client": "1.18.63",
+    "@ocap/mcrypto": "1.18.63",
+    "@ocap/util": "1.18.63",
+    "@ocap/wallet": "1.18.63",
     "@slack/webhook": "^5.0.4",
     "archiver": "^5.3.1",
     "axios": "^0.27.2",
@@ -91,5 +91,5 @@
     "express": "^4.18.2",
     "jest": "^27.5.1"
   },
-  "gitHead": "57d0c45be311a5fbc1c0fffa2814b62c1a3ee34c"
+  "gitHead": "6ef1c3601d0cfdcf5da0b55b4c54ef1fa9fce7d2"
 }