@abtnode/core 1.16.17-beta-6f0c7674 → 1.16.17-beta-952ef53d

package/lib/api/team.js

@@ -1100,10 +1100,28 @@ class TeamAPI extends EventEmitter {
     return this.teamManager.getRoles(teamDid);
   }
 
-  async createRole({ teamDid, name, description, title, childName, permissions = [] }) {
-    logger.info('create role', { teamDid, name, description, childName, permissions });
+  async getRole({ teamDid, role: { name } = {} }) {
+    if (!name) {
+      throw new Error('role name is invalid');
+    }
+    const rbac = await this.getRBAC(teamDid);
+    const role = await rbac.getRole(name);
+    return role ? pick(role, ['name', 'grants', 'title', 'description', 'extra']) : null;
+  }
+
+  async createRole({ teamDid, name, description, title, childName, permissions = [], extra: raw }) {
+    logger.info('create role', { teamDid, name, description, childName, permissions, raw });
+    const attrs = { name, title, description, childName, permissions };
 
-    await validateCreateRole({ name, title, description });
+    if (raw) {
+      try {
+        attrs.extra = JSON.parse(raw);
+      } catch (err) {
+        throw new Error('extra should be a valid json string');
+      }
+    }
+
+    await validateCreateRole(pick(attrs, ['name', 'title', 'description', 'extra']));
 
     validateReservedRole(name);
 
@@ -1111,8 +1129,8 @@ class TeamAPI extends EventEmitter {
 
     let role;
     try {
-      role = await rbac.createRole({ name, title, description, childName, permissions });
-      return pick(role, ['name', 'grants', 'title', 'description']);
+      role = await rbac.createRole(attrs);
+      return pick(role, ['name', 'title', 'grants', 'description', 'extra']);
     } catch (err) {
       if (new RegExp(`Item ${name} already exists`).test(err.message)) {
         throw new Error(`Id ${name} already exists`);
@@ -1121,16 +1139,23 @@ class TeamAPI extends EventEmitter {
     }
   }
 
-  async updateRole({ teamDid, role: { name, title, description } = {} }) {
-    logger.info('update role', { teamDid, name, title, description });
-
-    await validateUpdateRole({ name, title, description });
+  async updateRole({ teamDid, role: { name, title, description, extra: raw } = {} }) {
+    logger.info('update role', { teamDid, name, title, description, raw });
 
-    const rbac = await this.getRBAC(teamDid);
+    const attrs = { name, title, description };
 
-    const state = await rbac.updateRole({ name, title, description });
+    if (raw) {
+      try {
+        attrs.extra = JSON.parse(raw);
+      } catch (err) {
+        throw new Error('extra should be a valid json string');
+      }
+    }
 
-    return pick(state, ['name', 'title', 'grants', 'description']);
+    await validateUpdateRole(attrs);
+    const rbac = await this.getRBAC(teamDid);
+    const state = await rbac.updateRole(attrs);
+    return pick(state, ['name', 'title', 'grants', 'description', 'extra']);
   }
 
   async getPermissions({ teamDid }) {

package/lib/blocklet/manager/disk.js

@@ -162,7 +162,12 @@ const UpgradeComponents = require('./helper/upgrade-components');
 const BlockletDownloader = require('../downloader/blocklet-downloader');
 const RollbackCache = require('./helper/rollback-cache');
 const { migrateApplicationToStructV2 } = require('./helper/migrate-application-to-struct-v2');
-const { getBackupFilesUrlFromEndpoint, getBackupEndpoint, getSpaceNameByEndpoint } = require('../../util/spaces');
+const {
+  getBackupFilesUrlFromEndpoint,
+  getBackupEndpoint,
+  getSpaceNameByEndpoint,
+  getBackupJobId,
+} = require('../../util/spaces');
 const { validateAddSpaceGateway, validateUpdateSpaceGateway } = require('../../validators/space-gateway');
 const { sessionConfigSchema } = require('../../validators/util');
 
@@ -221,12 +226,19 @@ class DiskBlockletManager extends BaseBlockletManager {
     this.teamManager = teamManager;
 
     if (isFunction(this.backupQueue.on)) {
-      const handleBackupComplete = async ({ id, job }) => {
-        await this.backupQueue.delete(id);
-
-        const autoBackup = await this.getAutoBackup({ did: id });
+      /**
+       *
+       * @param {{
+       *  id: string,
+       *  job: { blocklet: import('@abtnode/client').BlockletState }
+       * }} param0
+       */
+      const handleBackupComplete = async ({ id: jobId, job }) => {
+        await this.backupQueue.delete(jobId);
+
+        const autoBackup = await this.getAutoBackup({ did: job.blocklet.meta.did });
         if (autoBackup?.enabled) {
-          this.backupQueue.push(job, id, true, BACKUPS.JOB.INTERVAL);
+          this.backupQueue.push(job, jobId, true, BACKUPS.JOB.INTERVAL);
         }
       };
       this.backupQueue.on('finished', handleBackupComplete).on('failed', handleBackupComplete);
@@ -1898,12 +1910,14 @@ class DiskBlockletManager extends BaseBlockletManager {
     const value = { ...autoBackup };
     await states.blockletExtras.setSettings(did, { autoBackup: value });
 
-    await this.backupQueue.delete(did);
+    const jobId = getBackupJobId(did);
+    await this.backupQueue.delete(jobId);
 
     logger.info('updateAutoBackup.$value', value);
 
     if (value.enabled) {
       const blocklet = await states.blocklet.getBlocklet(did);
+
       this.backupQueue.push(
         {
           entity: 'blocklet',
@@ -1911,7 +1925,7 @@ class DiskBlockletManager extends BaseBlockletManager {
           blocklet,
           context,
         },
-        did,
+        jobId,
         true,
         BACKUPS.JOB.INTERVAL
       );
@@ -3568,7 +3582,8 @@ class DiskBlockletManager extends BaseBlockletManager {
     try {
       const { did } = blocklet.meta;
 
-      await this.backupQueue.delete(did);
+      const jobId = getBackupJobId(did);
+      await this.backupQueue.delete(jobId);
 
       this.backupQueue.push(
         {
@@ -3580,7 +3595,7 @@ class DiskBlockletManager extends BaseBlockletManager {
             strategy: BACKUPS.STRATEGY.MANUAL,
           },
         },
-        did
+        jobId
       );
 
       return blocklet;

package/lib/event/auto-backup-handler.js

@@ -1,5 +1,6 @@
 const debounce = require('lodash/debounce');
 const logger = require('@abtnode/logger')('@abtnode/core:event/auto-backup-handler');
+const { getBackupJobId } = require('../util/spaces');
 
 /**
  * @description
@@ -15,7 +16,8 @@ async function autoBackupHandler(eventName, payload, blockletManager) {
   logger.info('autoBackupHandler.$Boolean(payload.context)', Boolean(payload.context));
 
   if (autoBackup.enabled && payload.context) {
-    await blockletManager.backupQueue.delete(did);
+    const jobId = getBackupJobId(did);
+    await blockletManager.backupQueue.delete(jobId);
 
     blockletManager.backupQueue.push(
       {
@@ -24,7 +26,7 @@ async function autoBackupHandler(eventName, payload, blockletManager) {
         blocklet: payload,
         context: payload.context,
       },
-      did
+      jobId
     );
   }
 }

package/lib/index.js

@@ -399,6 +399,7 @@ function ABTNode(options) {
     getRBAC: (did = options.nodeDid) => teamManager.getRBAC(did),
 
     getRoles: teamAPI.getRoles.bind(teamAPI),
+    getRole: teamAPI.getRole.bind(teamAPI),
     createRole: teamAPI.createRole.bind(teamAPI),
     updateRole: teamAPI.updateRole.bind(teamAPI),
     deleteRole: teamAPI.deleteRole.bind(teamAPI),

package/lib/states/blocklet.js

@@ -234,7 +234,7 @@ class BlockletState extends BaseState {
   } = {}) {
     let doc = await this.getBlocklet(meta.did);
     if (doc) {
-      throw new Error('Blocklet already added');
+      throw new Error(`Blocklet already added: ${meta.did}`);
     }
 
     try {
@@ -288,7 +288,7 @@ class BlockletState extends BaseState {
   async updateBlocklet(did, updates) {
     const doc = await this.getBlocklet(did);
     if (!doc) {
-      throw new Error('Blocklet does not exist');
+      throw new Error(`Blocklet does not exist on update: ${did}`);
     }
 
     const formatted = formatBlocklet(cloneDeep(updates), 'onUpdate', this.config.dek);
@@ -302,7 +302,7 @@ class BlockletState extends BaseState {
   async upgradeBlocklet({ meta, source, deployedFrom = '', children } = {}) {
     const doc = await this.getBlocklet(meta.did);
     if (!doc) {
-      throw new Error('Blocklet does not exist');
+      throw new Error(`Blocklet does not exist on upgrade: ${meta.did}`);
     }
 
     try {
@@ -427,7 +427,7 @@ class BlockletState extends BaseState {
   async refreshBlockletPorts(did, componentDids = []) {
     const blocklet = await this.getBlocklet(did);
     if (!blocklet) {
-      throw new Error('Blocklet does not exist');
+      throw new Error(`Blocklet does not exist on refresh: ${did}`);
     }
 
     const { occupiedExternalPorts, occupiedInternalPorts } = await this._getOccupiedPorts();
@@ -626,7 +626,7 @@ class BlockletState extends BaseState {
   async addChildren(did, children) {
     const parent = await this.getBlocklet(did);
     if (!parent) {
-      throw new Error('Blocklet does not exist');
+      throw new Error(`Blocklet does not exist on addChildren: ${did}`);
     }
 
     const oldChildren = parent.children || [];

package/lib/team/manager.js

@@ -326,7 +326,7 @@ class TeamManager extends EventEmitter {
   async getRoles(did) {
     const rbac = await this.getRBAC(did);
     const roles = await rbac.getRoles();
-    return roles.map((d) => pick(d, ['name', 'grants', 'title', 'description']));
+    return roles.map((d) => pick(d, ['name', 'grants', 'title', 'description', 'extra']));
   }
 
   async initTeam(did) {

package/lib/util/blocklet.js

@@ -12,6 +12,7 @@ const toLower = require('lodash/toLower');
 const isEmpty = require('lodash/isEmpty');
 const streamToPromise = require('stream-to-promise');
 const { Throttle } = require('stream-throttle');
+const { slugify } = require('transliteration');
 const ssri = require('ssri');
 const diff = require('deep-diff');
 const createArchive = require('archiver');
@@ -19,6 +20,7 @@ const isUrl = require('is-url');
 const semver = require('semver');
 const { chainInfo: chainInfoSchema } = require('@arcblock/did-auth/lib/schema');
 
+const urlPathFriendly = require('@blocklet/meta/lib/url-path-friendly').default;
 const { fromSecretKey, fromPublicKey } = require('@ocap/wallet');
 const { toHex, isHex, toDid, toAddress, toBuffer } = require('@ocap/util');
 const { isValid: isValidDid, isEthereumDid } = require('@arcblock/did');
@@ -309,6 +311,7 @@ const getAppSystemEnvironments = (blocklet, nodeInfo, dataDirs) => {
     BLOCKLET_APP_PSK: appPsk, // permanent sk even the blocklet has been migrated
     BLOCKLET_APP_PID: appPid, // permanent did even the blocklet has been migrated
     BLOCKLET_APP_NAME: appName,
+    BLOCKLET_APP_NAME_SLUG: urlPathFriendly(slugify(appName)),
     BLOCKLET_APP_DESCRIPTION: appDescription,
     BLOCKLET_APP_URL: appUrl,
     BLOCKLET_APP_DATA_DIR: path.join(dataDirs.data, blocklet.meta.name),

package/lib/util/spaces.js

@@ -72,9 +72,19 @@ async function getSpaceNameByEndpoint(endpoint, defaultValue = '') {
   }
 }
 
+/**
+ * @description
+ * @param {string} did
+ * @return {string}
+ */
+function getBackupJobId(did) {
+  return `${did}.backupToSpaces`;
+}
+
 module.exports = {
   getBackupEndpoint,
   getBackupFilesUrlFromEndpoint,
   getDIDSpacesUrlFromEndpoint,
   getSpaceNameByEndpoint,
+  getBackupJobId,
 };

package/lib/validators/role.js

@@ -1,8 +1,8 @@
 /* eslint-disable newline-per-chained-call */
-const JOI = require('joi');
+const Joi = require('joi');
 const { getMultipleLangParams } = require('./util');
 
-const roleNameSchema = JOI.string()
+const roleNameSchema = Joi.string()
   .trim()
   .max(64)
   .custom((value) => {
@@ -17,19 +17,41 @@ const roleNameSchema = JOI.string()
     return value;
   });
 
-const titleSchema = JOI.string().trim().max(25);
-const descriptionSchema = JOI.string().trim().max(600);
+const roleAcquireSchema = Joi.object({
+  pay: Joi.string().optional().allow(''),
+  exchange: Joi.string().optional().allow(''),
+  invite: Joi.boolean().optional(),
+  transfer: Joi.boolean().optional(),
+  request: Joi.boolean().optional(),
+}).default({
+  pay: '',
+  exchange: '',
+  invite: true,
+  transfer: false,
+  request: false,
+});
+
+const titleSchema = Joi.string().trim().max(25);
+const descriptionSchema = Joi.string().trim().max(600);
 
-const createRoleSchema = JOI.object({
+const createRoleSchema = Joi.object({
   name: roleNameSchema.required(),
   title: titleSchema.required(),
   description: descriptionSchema.required(),
+  extra: Joi.object({
+    acquire: roleAcquireSchema,
+    payment: Joi.any().optional(),
+  }).optional(),
 });
 
-const updateRoleSchema = JOI.object({
+const updateRoleSchema = Joi.object({
   name: roleNameSchema.required(),
   title: titleSchema,
   description: descriptionSchema,
+  extra: Joi.object({
+    acquire: roleAcquireSchema,
+    payment: Joi.any().optional(),
+  }).optional(),
 });
 
 module.exports = {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.17-beta-6f0c7674",
+  "version": "1.16.17-beta-952ef53d",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,19 +19,19 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/analytics": "1.16.17-beta-6f0c7674",
-    "@abtnode/auth": "1.16.17-beta-6f0c7674",
-    "@abtnode/certificate-manager": "1.16.17-beta-6f0c7674",
-    "@abtnode/constant": "1.16.17-beta-6f0c7674",
-    "@abtnode/cron": "1.16.17-beta-6f0c7674",
-    "@abtnode/logger": "1.16.17-beta-6f0c7674",
-    "@abtnode/models": "1.16.17-beta-6f0c7674",
-    "@abtnode/queue": "1.16.17-beta-6f0c7674",
-    "@abtnode/rbac": "1.16.17-beta-6f0c7674",
-    "@abtnode/router-provider": "1.16.17-beta-6f0c7674",
-    "@abtnode/static-server": "1.16.17-beta-6f0c7674",
-    "@abtnode/timemachine": "1.16.17-beta-6f0c7674",
-    "@abtnode/util": "1.16.17-beta-6f0c7674",
+    "@abtnode/analytics": "1.16.17-beta-952ef53d",
+    "@abtnode/auth": "1.16.17-beta-952ef53d",
+    "@abtnode/certificate-manager": "1.16.17-beta-952ef53d",
+    "@abtnode/constant": "1.16.17-beta-952ef53d",
+    "@abtnode/cron": "1.16.17-beta-952ef53d",
+    "@abtnode/logger": "1.16.17-beta-952ef53d",
+    "@abtnode/models": "1.16.17-beta-952ef53d",
+    "@abtnode/queue": "1.16.17-beta-952ef53d",
+    "@abtnode/rbac": "1.16.17-beta-952ef53d",
+    "@abtnode/router-provider": "1.16.17-beta-952ef53d",
+    "@abtnode/static-server": "1.16.17-beta-952ef53d",
+    "@abtnode/timemachine": "1.16.17-beta-952ef53d",
+    "@abtnode/util": "1.16.17-beta-952ef53d",
     "@arcblock/did": "1.18.92",
     "@arcblock/did-auth": "1.18.92",
     "@arcblock/did-ext": "^1.18.92",
@@ -42,11 +42,11 @@
     "@arcblock/pm2-events": "^0.0.5",
     "@arcblock/validator": "^1.18.92",
     "@arcblock/vc": "1.18.92",
-    "@blocklet/constant": "1.16.17-beta-6f0c7674",
-    "@blocklet/env": "1.16.17-beta-6f0c7674",
-    "@blocklet/meta": "1.16.17-beta-6f0c7674",
-    "@blocklet/resolver": "1.16.17-beta-6f0c7674",
-    "@blocklet/sdk": "1.16.17-beta-6f0c7674",
+    "@blocklet/constant": "1.16.17-beta-952ef53d",
+    "@blocklet/env": "1.16.17-beta-952ef53d",
+    "@blocklet/meta": "1.16.17-beta-952ef53d",
+    "@blocklet/resolver": "1.16.17-beta-952ef53d",
+    "@blocklet/sdk": "1.16.17-beta-952ef53d",
     "@did-space/client": "^0.3.11",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.92",
@@ -101,5 +101,5 @@
     "jest": "^27.5.1",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "8123f54b0f572c47f1ea704607aae113576c2a76"
+  "gitHead": "a575050c7ffd08961a5f4072f4048f6e37976810"
 }