@abtnode/core 1.16.15-beta-9318a201 → 1.16.15-beta-ed0db59e

package/lib/blocklet/manager/config-synchronizer.js

@@ -0,0 +1,108 @@
+const path = require('path');
+const throttle = require('lodash/throttle');
+const fs = require('fs-extra');
+const logger = require('@abtnode/logger')('@abtnode/core:config-synchronizer');
+const { encrypt } = require('@blocklet/sdk/lib/security');
+const { APP_CONFIG_FILE_PATH, APP_CONFIG_DIR, COMPONENT_ENV_FILE_NAME } = require('@blocklet/constant');
+
+const { findComponentByIdV2, getSharedConfigObj, getBlockletAppIdList } = require('@blocklet/meta/lib/util');
+const { getBlockletLanguages, getBlockletPreferences } = require('@blocklet/env/lib/util');
+const { getComponentsInternalInfo } = require('@blocklet/meta/lib/blocklet');
+const { getComponentApiKey } = require('@abtnode/util/lib/blocklet');
+
+const getValueFromEnvironments = (environments, key) => {
+  const env = (environments || []).find((x) => x.key === key);
+  return env ? env.value : undefined;
+};
+
+const isAppObj = (x) => typeof x === 'object' && x !== null && !!x.meta;
+
+class ConfigSynchronizer {
+  constructor({ manager, states, wait = 5000 }) {
+    this.manager = manager;
+    this.wait = wait;
+    this.throttles = new Map();
+    this.states = states;
+  }
+
+  async syncAppConfig(did, { serverVersion: inputServerVersion } = {}) {
+    try {
+      const app = isAppObj(did) ? did : await this.manager.getBlocklet(did);
+      const serverVersion = inputServerVersion || (await this.states.node.read()).version;
+      const env = {
+        appId: app.appDid,
+        appPid: app.appPid,
+        appIds: getBlockletAppIdList(app),
+        appName: app.meta.title,
+        appDescription: app.meta.description,
+        appUrl: getValueFromEnvironments(app.environments, 'BLOCKLET_APP_URL'),
+        appStorageEndpoint: getValueFromEnvironments(app.environments, 'BLOCKLET_APP_SPACE_ENDPOINT'),
+        languages: getBlockletLanguages(getValueFromEnvironments(app.environments, 'BLOCKLET_APP_LANGUAGES')),
+        preferences: getBlockletPreferences(
+          (app.configs || []).reduce((acc, x) => {
+            acc[x.key] = x.value;
+            return acc;
+          }, {})
+        ),
+        serverVersion,
+      };
+      const components = getComponentsInternalInfo(app);
+
+      const config = { env, components };
+
+      const dataDir = getValueFromEnvironments(app.environments, 'BLOCKLET_DATA_DIR');
+
+      await fs.outputFile(path.join(dataDir, APP_CONFIG_FILE_PATH), JSON.stringify(config));
+    } catch (error) {
+      logger.error('sync app config failed', { error });
+    }
+  }
+
+  async syncComponentConfig(did, rootDid, { serverSk }) {
+    try {
+      const app = await this.manager.getBlocklet(rootDid);
+      const component = findComponentByIdV2(app, did);
+      const env = {
+        ...component.configObj,
+        ...getSharedConfigObj(component, [app]),
+      };
+
+      const componentApiKey = getComponentApiKey({
+        serverSk,
+        app,
+        component,
+      });
+
+      const dataDir = getValueFromEnvironments(app.environments, 'BLOCKLET_DATA_DIR');
+
+      const envString = JSON.stringify(env);
+
+      await fs.outputFile(
+        path.join(dataDir, APP_CONFIG_DIR, component.meta.did, COMPONENT_ENV_FILE_NAME),
+        encrypt(envString, componentApiKey, component.meta.did)
+      );
+    } catch (error) {
+      logger.error('sync component config failed', { error });
+    }
+  }
+
+  async throttledSyncAppConfig(did) {
+    if (!this.throttles.has(did)) {
+      this.throttles.set(
+        did,
+        throttle(
+          async () => {
+            await this.syncAppConfig(did);
+            this.throttles.get(did).cancel();
+            this.throttles.delete(did);
+          },
+          this.wait,
+          { leading: false }
+        )
+      );
+    }
+    await this.throttles.get(did)();
+  }
+}
+
+module.exports = ConfigSynchronizer;

package/lib/blocklet/manager/disk.js

@@ -51,7 +51,9 @@ const { getComponentsInternalInfo } = require('@blocklet/meta/lib/blocklet');
 const { update: updateMetaFile } = require('@blocklet/meta/lib/file');
 const { titleSchema, updateMountPointSchema, environmentNameSchema } = require('@blocklet/meta/lib/schema');
 const { emailConfigSchema } = require('@blocklet/sdk/lib/validators/email');
+const { encrypt } = require('@blocklet/sdk/lib/security');
 const Lock = require('@abtnode/util/lib/lock');
+const { getComponentApiKey } = require('@abtnode/util/lib/blocklet');
 const defaults = require('lodash/defaults');
 
 const {
@@ -77,6 +79,8 @@ const {
   CHAIN_PROP_MAP_REVERSE,
   BLOCKLET_CONTROLLER_STATUS,
   SUSPENDED_REASON,
+  APP_CONFIG_DIR,
+  COMPONENT_ENV_FILE_NAME,
 } = require('@blocklet/constant');
 const isUndefined = require('lodash/isUndefined');
 const { WELLKNOWN_SERVICE_PATH_PREFIX, WELLKNOWN_BLOCKLET_ADMIN_PATH } = require('@abtnode/constant');
@@ -159,6 +163,7 @@ const { validateAddSpaceGateway, validateUpdateSpaceGateway } = require('../../v
 const { sessionConfigSchema } = require('../../validators/util');
 
 const request = require('../../util/request');
+const ConfigSynchronizer = require('./config-synchronizer');
 
 const { formatEnvironments, getBlockletMeta, validateOwner, isCLI } = util;
 
@@ -210,6 +215,8 @@ class DiskBlockletManager extends BaseBlockletManager {
 
     this._rollbackCache = new RollbackCache({ dir: this.dataDirs.tmp });
 
+    this.configSynchronizer = new ConfigSynchronizer({ manager: this, states });
+
     if (daemon) {
       blockletPm2Events.on('online', (data) => this._syncPm2Status('online', data.blockletDid, data.componentDid));
       blockletPm2Events.on('stop', (data) => this._syncPm2Status('stop', data.blockletDid, data.componentDid));
@@ -501,6 +508,8 @@ class DiskBlockletManager extends BaseBlockletManager {
       // start process
       const nodeEnvironments = await states.node.getEnvironments();
 
+      await this.configSynchronizer.syncAppConfig(blocklet);
+
       await startBlockletProcess(blocklet, {
         ...context,
         preStart: getHookFn('preStart'),
@@ -509,6 +518,7 @@ class DiskBlockletManager extends BaseBlockletManager {
         nodeInfo: await states.node.read(),
         e2eMode,
         componentDids,
+        configSynchronizer: this.configSynchronizer,
       });
 
       // check blocklet healthy
@@ -626,6 +636,7 @@ class DiskBlockletManager extends BaseBlockletManager {
         appDid: blocklet.appDid,
         components: getComponentsInternalInfo(res),
       });
+      this.configSynchronizer.throttledSyncAppConfig(blocklet.meta.did);
 
       this._createNotification(did, {
         title: '',
@@ -876,9 +887,9 @@ class DiskBlockletManager extends BaseBlockletManager {
   async deleteComponent({ did, rootDid, keepData, keepState }, context) {
     logger.info('delete blocklet component', { did, rootDid, keepData });
 
-    const blocklet = await this.getBlocklet(rootDid);
+    const app = await this.getBlocklet(rootDid);
 
-    const child = blocklet.children.find((x) => x.meta.did === did);
+    const child = app.children.find((x) => x.meta.did === did);
     if (!child) {
       throw new Error('Component does not exist');
     }
@@ -902,25 +913,25 @@ class DiskBlockletManager extends BaseBlockletManager {
     // delete process
     try {
       const skippedProcessIds = [];
-      forEachBlockletSync(blocklet, (b) => {
+      forEachBlockletSync(app, (b) => {
         if (!b.env.id.startsWith(child.env.id)) {
           skippedProcessIds.push(b.env.processId);
         }
       });
-      await deleteBlockletProcess(blocklet, { skippedProcessIds });
+      await deleteBlockletProcess(app, { skippedProcessIds });
       logger.info('delete blocklet process for deleting component', { did, rootDid });
     } catch (err) {
       logger.error('delete blocklet process for deleting component', { did, rootDid, error: err });
     }
 
     // delete storage
-    const childBlocklet = blocklet.children.find((x) => x.meta.did === did);
-    const { cacheDir, logsDir, dataDir } = childBlocklet.env;
+    const { cacheDir, logsDir, dataDir } = child.env;
     fs.removeSync(cacheDir);
     fs.removeSync(logsDir);
+    fs.removeSync(path.join(app.env.dataDir, APP_CONFIG_DIR, child.meta.did, COMPONENT_ENV_FILE_NAME));
     if (keepData === false) {
       fs.removeSync(dataDir);
-      await states.blockletExtras.delConfigs([blocklet.meta.did, child.meta.did]);
+      await states.blockletExtras.delConfigs([app.meta.did, child.meta.did]);
     }
 
     const newBlocklet = await this.getBlocklet(rootDid);
@@ -944,19 +955,20 @@ class DiskBlockletManager extends BaseBlockletManager {
     });
 
     this.emit(BlockletEvents.componentRemoved, {
-      ...blocklet,
+      ...app,
       componentDids: [child.meta.did],
     });
 
     this.emit(BlockletInternalEvents.componentRemoved, {
-      appDid: blocklet.appDid,
+      appDid: app.appDid,
       components: [{ did: child.meta.did }],
     });
     // for backward compatibility
     this.emit(BlockletInternalEvents.componentsUpdated, {
-      appDid: blocklet.appDid,
+      appDid: app.appDid,
       components: getComponentsInternalInfo(newBlocklet),
     });
+    this.configSynchronizer.throttledSyncAppConfig(app.meta.did);
 
     return { ...newBlocklet, deletedComponent: child };
   }
@@ -1225,9 +1237,21 @@ class DiskBlockletManager extends BaseBlockletManager {
         appDid: rootDid,
         configs: newConfigs.map((x) => ({ key: x.key, value: x.value })),
       });
+      this.configSynchronizer.throttledSyncAppConfig(blocklet.meta.did);
     }
 
     this.emit(BlockletEvents.updated, newState);
+    const serverSk = (await states.node.read()).sk;
+    if (childDid) {
+      const configs = JSON.stringify(newConfigs.map((x) => ({ key: x.key, value: x.value })));
+      this.emit(BlockletInternalEvents.componentConfigChanged, {
+        appDid: rootDid,
+        componentDid: childDid,
+        configs: encrypt(configs, getComponentApiKey({ serverSk, app: ancestors[0], component: blocklet }), childDid),
+      });
+
+      this.configSynchronizer.syncComponentConfig(childDid, rootDid, { serverSk });
+    }
 
     return newState;
   }
@@ -1418,6 +1442,7 @@ class DiskBlockletManager extends BaseBlockletManager {
       appDid: blocklet.appDid,
       components: getComponentsInternalInfo(blocklet),
     });
+    this.configSynchronizer.throttledSyncAppConfig(blocklet.meta.did);
 
     return this.getBlocklet(rootDid);
   }
@@ -1818,6 +1843,10 @@ class DiskBlockletManager extends BaseBlockletManager {
     }
   }
 
+  syncAppConfig(did, { serverVersion } = {}) {
+    return this.configSynchronizer.syncAppConfig(did, { serverVersion });
+  }
+
   // ============================================================================================
   // Private API that are used by self of helper function
   // ============================================================================================
@@ -2076,6 +2105,7 @@ class DiskBlockletManager extends BaseBlockletManager {
         appDid: blocklet.appDid,
         components: getComponentsInternalInfo(res),
       });
+      this.configSynchronizer.throttledSyncAppConfig(res);
 
       this.emit(BlockletEvents.statusChange, res);
       this.emit(BlockletEvents.started, { ...res, componentDids });
@@ -2274,7 +2304,7 @@ class DiskBlockletManager extends BaseBlockletManager {
     const nodeInfo = await states.node.read();
 
     const appSystemEnvironments = {
-      ...getAppSystemEnvironments(blockletWithEnv, nodeInfo),
+      ...getAppSystemEnvironments(blockletWithEnv, nodeInfo, this.dataDirs),
       ...getAppOverwrittenEnvironments(blockletWithEnv, nodeInfo),
     };
 
@@ -2770,6 +2800,7 @@ class DiskBlockletManager extends BaseBlockletManager {
         appDid: blocklet.appDid,
         components: getComponentsInternalInfo(blocklet),
       });
+      this.configSynchronizer.throttledSyncAppConfig(blocklet);
 
       return blocklet;
     } catch (err) {

package/lib/blocklet/manager/helper/install-application-from-dev.js

@@ -62,6 +62,8 @@ const installApplicationFromDev = async ({ folder, meta, states, manager } = {})
   }
   await updateBlockletFallbackLogo(blocklet);
 
+  await states.blocklet.setInstalledAt(did);
+
   blocklet = await manager.getBlocklet(did);
 
   return blocklet;

package/lib/blocklet/manager/helper/install-component-from-url.js

@@ -94,12 +94,16 @@ const installComponentFromUrl = async ({
     // if upgrade, do not update mountPoint and title
     newChild.mountPoint = blocklet.children[index].mountPoint;
     newChild.meta.title = blocklet.children[index].meta.title;
+    newChild.installedAt = blocklet.children[index].installedAt;
     blocklet.children.splice(index, 1, newChild);
   } else {
     dynamicComponents.unshift(newChild);
   }
 
-  const newChildren = filterDuplicateComponents(dynamicComponents, blocklet.children);
+  const newChildren = filterDuplicateComponents(dynamicComponents, blocklet.children).map((x) => ({
+    ...x,
+    installedAt: new Date(),
+  }));
 
   blocklet.children.push(...newChildren);
 

package/lib/index.js

@@ -273,6 +273,7 @@ function ABTNode(options) {
     backupBlocklet: blockletManager.backup.bind(blockletManager),
     restoreBlocklet: blockletManager.restoreBlocklet.bind(blockletManager),
     migrateApplicationToStructV2: blockletManager.migrateApplicationToStructV2.bind(blockletManager),
+    syncAppConfig: blockletManager.syncAppConfig.bind(blockletManager),
 
     // For diagnose purpose
     syncBlockletStatus: blockletManager.status.bind(blockletManager),

package/lib/util/blocklet.js

@@ -263,7 +263,7 @@ const ensureBlockletExpanded = async (meta, appDir) => {
   }
 };
 
-const getAppSystemEnvironments = (blocklet, nodeInfo) => {
+const getAppSystemEnvironments = (blocklet, nodeInfo, dataDirs) => {
   const { did, name, title, description } = blocklet.meta;
   const keys = Object.keys(BLOCKLET_CONFIGURABLE_KEY);
   const result = getBlockletInfo(
@@ -311,6 +311,7 @@ const getAppSystemEnvironments = (blocklet, nodeInfo) => {
     BLOCKLET_APP_NAME: appName,
     BLOCKLET_APP_DESCRIPTION: appDescription,
     BLOCKLET_APP_URL: appUrl,
+    BLOCKLET_APP_DATA_DIR: path.join(dataDirs.data, blocklet.meta.name),
   };
 };
 
@@ -491,6 +492,7 @@ const startBlockletProcess = async (
     e2eMode,
     skippedProcessIds = [],
     componentDids,
+    configSynchronizer,
   } = {}
 ) => {
   if (!blocklet) {
@@ -604,6 +606,10 @@ const startBlockletProcess = async (
         }
       }
 
+      await configSynchronizer.syncComponentConfig(b.meta.did, blocklet.meta.did, {
+        serverSk: nodeEnvironments.ABT_NODE_SK,
+      });
+
       await pm2.startAsync(options);
 
       const status = await getProcessState(processId);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.15-beta-9318a201",
+  "version": "1.16.15-beta-ed0db59e",
   "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.15-beta-9318a201",
-    "@abtnode/auth": "1.16.15-beta-9318a201",
-    "@abtnode/certificate-manager": "1.16.15-beta-9318a201",
-    "@abtnode/constant": "1.16.15-beta-9318a201",
-    "@abtnode/cron": "1.16.15-beta-9318a201",
-    "@abtnode/logger": "1.16.15-beta-9318a201",
-    "@abtnode/models": "1.16.15-beta-9318a201",
-    "@abtnode/queue": "1.16.15-beta-9318a201",
-    "@abtnode/rbac": "1.16.15-beta-9318a201",
-    "@abtnode/router-provider": "1.16.15-beta-9318a201",
-    "@abtnode/static-server": "1.16.15-beta-9318a201",
-    "@abtnode/timemachine": "1.16.15-beta-9318a201",
-    "@abtnode/util": "1.16.15-beta-9318a201",
+    "@abtnode/analytics": "1.16.15-beta-ed0db59e",
+    "@abtnode/auth": "1.16.15-beta-ed0db59e",
+    "@abtnode/certificate-manager": "1.16.15-beta-ed0db59e",
+    "@abtnode/constant": "1.16.15-beta-ed0db59e",
+    "@abtnode/cron": "1.16.15-beta-ed0db59e",
+    "@abtnode/logger": "1.16.15-beta-ed0db59e",
+    "@abtnode/models": "1.16.15-beta-ed0db59e",
+    "@abtnode/queue": "1.16.15-beta-ed0db59e",
+    "@abtnode/rbac": "1.16.15-beta-ed0db59e",
+    "@abtnode/router-provider": "1.16.15-beta-ed0db59e",
+    "@abtnode/static-server": "1.16.15-beta-ed0db59e",
+    "@abtnode/timemachine": "1.16.15-beta-ed0db59e",
+    "@abtnode/util": "1.16.15-beta-ed0db59e",
     "@arcblock/did": "1.18.89",
     "@arcblock/did-auth": "1.18.89",
     "@arcblock/did-ext": "^1.18.89",
@@ -42,10 +42,11 @@
     "@arcblock/pm2-events": "^0.0.5",
     "@arcblock/validator": "^1.18.89",
     "@arcblock/vc": "1.18.89",
-    "@blocklet/constant": "1.16.15-beta-9318a201",
-    "@blocklet/meta": "1.16.15-beta-9318a201",
-    "@blocklet/resolver": "1.16.15-beta-9318a201",
-    "@blocklet/sdk": "1.16.15-beta-9318a201",
+    "@blocklet/constant": "1.16.15-beta-ed0db59e",
+    "@blocklet/env": "1.16.15-beta-ed0db59e",
+    "@blocklet/meta": "1.16.15-beta-ed0db59e",
+    "@blocklet/resolver": "1.16.15-beta-ed0db59e",
+    "@blocklet/sdk": "1.16.15-beta-ed0db59e",
     "@did-space/client": "^0.2.163",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.89",
@@ -98,5 +99,5 @@
     "jest": "^27.5.1",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "f3722cbd4fe10c5fa083cad7e859ecff6095060d"
+  "gitHead": "647ebe45f6214ea5c284c9234f1319b6ff72f915"
 }