@abtnode/core 1.16.16-beta-e038cde7 → 1.16.16-beta-740ea329

package/lib/blocklet/extras.js

@@ -6,15 +6,26 @@ const { BLOCKLET_CONFIGURABLE_KEY } = require('@blocklet/constant');
 const removeDeletedMetaConfigs = (oldConfigs, newConfigs) =>
   oldConfigs.filter((old) => newConfigs.some(({ key, name }) => [key, name].includes(old.key)));
 
+/**
+ * 从 blocklet.yml:environment 中导入配置：配置项字段是 name
+ * 主动配置：配置项字段是 key
+ *
+ * 自定义配置(customConfigs): 配置项的 custom 为 true
+ * 系统配置(appConfigs): 系统保留的配置项名，且 custom 为 false
+ * 组件配置(metaConfigs): 配置项的 custom 为 false, 且不是系统保留的配置项名
+ *   如果从 blocklet.yml 中导入组件配置，会删除已经删除的配置项
+ */
 const mergeConfigs = ({ old: oldConfigs, cur: newConfigs = [], did = '', dek = '' }) => {
   const enableSecurity = dek && did;
-  const isUpdatingCustomConfig = newConfigs.every((x) => x.key);
+
+  const isConfigFromMeta = newConfigs.every((x) => x.key);
 
   const customConfigs = (oldConfigs || []).filter((x) => x.custom);
   const appConfigs = (oldConfigs || []).filter((x) => !x.custom && !!BLOCKLET_CONFIGURABLE_KEY[x.key]);
 
   const allMetaConfigs = (oldConfigs || []).filter((x) => !x.custom && !BLOCKLET_CONFIGURABLE_KEY[x.key]);
-  const metaConfigs = isUpdatingCustomConfig ? allMetaConfigs : removeDeletedMetaConfigs(allMetaConfigs, newConfigs);
+
+  const metaConfigs = isConfigFromMeta ? allMetaConfigs : removeDeletedMetaConfigs(allMetaConfigs, newConfigs);
 
   // oldConfig 表示从数据库中可以用的字段
   const oldConfig = [...metaConfigs, ...appConfigs, ...customConfigs].reduce((acc, x) => {

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

@@ -64,7 +64,7 @@ class ConfigSynchronizer {
       const component = findComponentByIdV2(app, did);
       const env = {
         ...component.configObj,
-        ...getSharedConfigObj(component, [app]),
+        ...getSharedConfigObj(app, component),
       };
 
       const componentApiKey = getComponentApiKey({

package/lib/blocklet/manager/disk.js

@@ -115,7 +115,6 @@ const {
   filterDuplicateComponents,
   getBundleDir,
   getBlocklet,
-  ensureEnvDefault,
   getConfigFromPreferences,
   validateAppConfig,
   checkDuplicateMountPoint,
@@ -132,6 +131,9 @@ const {
   ensureAppPortsNotOccupied,
   getComponentNamesWithVersion,
   updateDidDocument: updateBlockletDocument,
+  getAppConfigsFromComponent,
+  removeAppConfigsFromComponent,
+  getConfigsFromInput,
 } = require('../../util/blocklet');
 const { getDidDomainForBlocklet } = require('../../util/get-domain-for-blocklet');
 const states = require('../../states');
@@ -472,7 +474,7 @@ class DiskBlockletManager extends BaseBlockletManager {
       // check required config
       for (const component of blocklet1.children) {
         if (!shouldSkipComponent(component.meta.did, componentDids)) {
-          const missingProps = getComponentMissingConfigs(component, [blocklet1]);
+          const missingProps = getComponentMissingConfigs(component, blocklet1);
           if (missingProps.length) {
             throw new Error(
               `Missing required configuration to start ${component.meta.title}: ${missingProps
@@ -931,7 +933,13 @@ class DiskBlockletManager extends BaseBlockletManager {
     fs.removeSync(path.join(app.env.dataDir, APP_CONFIG_DIR, child.meta.did, COMPONENT_ENV_FILE_NAME));
     if (keepData === false) {
       fs.removeSync(dataDir);
+
+      const componentEnvs = await states.blockletExtras.getConfigs([app.meta.did, child.meta.did]);
       await states.blockletExtras.delConfigs([app.meta.did, child.meta.did]);
+
+      // remove app configs if no component use it
+      const tmpApp = await this.getBlocklet(rootDid);
+      await removeAppConfigsFromComponent(componentEnvs, tmpApp, states.blockletExtras);
     }
 
     const newBlocklet = await this.getBlocklet(rootDid);
@@ -1149,9 +1157,17 @@ class DiskBlockletManager extends BaseBlockletManager {
         }
         await validateAppConfig(x, states);
       } else if (!BLOCKLET_CONFIGURABLE_KEY[x.key] && !isPreferenceKey(x)) {
-        if (!(blocklet.meta.environments || []).some((y) => y.name === x.key)) {
+        const hasEnvInMeta = (b) => (b.meta.environments || []).some((y) => y.name === x.key);
+        if (!hasEnvInMeta(blocklet)) {
           // forbid unknown format key
-          throw new Error(`unknown format key: ${x.key}`);
+          if (
+            // config should in component.meta.environments
+            childDid ||
+            // config should in app.meta.environments and or in one of component.meta.environments
+            !(blocklet.children || []).some(hasEnvInMeta)
+          ) {
+            throw new Error(`unknown format key: ${x.key}`);
+          }
         }
       }
 
@@ -1183,7 +1199,18 @@ class DiskBlockletManager extends BaseBlockletManager {
     Object.assign(blocklet.configObj, configObj);
 
     // update db
-    await states.blockletExtras.setConfigs([rootMetaDid, childDid].filter(Boolean), newConfigs);
+    if (childDid) {
+      const { sharedConfigs, selfConfigs } = getConfigsFromInput(newConfigs, blocklet.configs);
+
+      if (sharedConfigs.length) {
+        await states.blockletExtras.setConfigs([rootMetaDid], sharedConfigs);
+      }
+      if (selfConfigs.length) {
+        await states.blockletExtras.setConfigs([rootMetaDid, childDid], selfConfigs);
+      }
+    } else {
+      await states.blockletExtras.setConfigs([rootMetaDid], newConfigs);
+    }
 
     if (willAppSkChange) {
       const info = await states.node.read();
@@ -2693,17 +2720,19 @@ class DiskBlockletManager extends BaseBlockletManager {
       logger.info('start migration on upgrading', { did, componentDids });
       {
         const oldVersions = {};
-        forEachBlockletSync(oldBlocklet, (b, { id }) => {
-          oldVersions[id] = b.meta.version;
+        forEachComponentV2Sync(oldBlocklet, (b) => {
+          if (componentDids.includes(b.meta.did)) {
+            oldVersions[b.meta.did] = b.meta.version;
+          }
         });
         const nodeEnvironments = await states.node.getEnvironments();
-        const runMigration = async (b, { id, ancestors }) => {
+        const runMigration = async (b) => {
           try {
             await runMigrationScripts({
               blocklet: b,
               appDir: b.env.appDir,
-              env: getRuntimeEnvironments(b, nodeEnvironments, ancestors),
-              oldVersion: oldVersions[id],
+              env: getRuntimeEnvironments(b, nodeEnvironments, [blocklet]),
+              oldVersion: oldVersions[b.meta.did],
               newVersion: b.meta.version,
               ...getHooksOutputFiles(b),
             });
@@ -2713,7 +2742,7 @@ class DiskBlockletManager extends BaseBlockletManager {
             throw error;
           }
         };
-        await forEachBlocklet(blocklet, runMigration, { parallel: true, concurrencyLimit: 2 });
+        await forEachComponentV2(blocklet, runMigration, { parallel: true, concurrencyLimit: 2 });
       }
       logger.info('done migration on upgrading', { did, componentDids });
 
@@ -2994,38 +3023,40 @@ class DiskBlockletManager extends BaseBlockletManager {
   async _setConfigsFromMeta(did, childDid) {
     const blocklet = await getBlocklet({ states, dataDirs: this.dataDirs, did });
 
-    if (!childDid) {
-      await forEachBlocklet(blocklet, async (b, { ancestors }) => {
-        const environments = [...get(b.meta, 'environments', []), ...getConfigFromPreferences(b)];
+    const setConfig = async (app, component) => {
+      const b = component || app;
+      const environments = [...get(b.meta, 'environments', []), ...getConfigFromPreferences(b)];
 
-        // remove default if ancestors has a value
-        ensureEnvDefault(environments, ancestors);
+      // write configs to db
+      await states.blockletExtras.setConfigs([app.meta.did, component?.meta?.did].filter(Boolean), environments);
 
-        // write configs to db
-        await states.blockletExtras.setConfigs([...ancestors.map((x) => x.meta.did), b.meta.did], environments);
+      if (component) {
+        const envsInApp = await states.blockletExtras.getConfigs([app.appPid]);
+        const envsInComponent = await states.blockletExtras.getConfigs([app.meta.did, component.meta.did]);
 
-        // chain config
-        await this._ensureAppChainConfig(
-          blocklet.meta.did,
-          environments.map((x) => ({ key: x.name, value: x.default })),
-          { force: false }
-        );
+        const configs = getAppConfigsFromComponent({ environments }, envsInApp, envsInComponent);
+        if (configs.length) {
+          await states.blockletExtras.setConfigs(app.meta.did, configs);
+        }
+      }
+
+      // chain config
+      await this._ensureAppChainConfig(
+        blocklet.appPid,
+        environments.map((x) => ({ key: x.name, value: x.default })),
+        { force: false }
+      );
+    };
+
+    if (!childDid) {
+      await setConfig(blocklet);
+      await forEachComponentV2(blocklet, async (component) => {
+        await setConfig(blocklet, component);
       });
     } else {
-      const child = blocklet.children.find((x) => x.meta.did === childDid);
-      await forEachBlocklet(child, async (b, { ancestors }) => {
-        await states.blockletExtras.setConfigs(
-          [blocklet.meta.did, ...ancestors.map((x) => x.meta.did), b.meta.did],
-          [...get(b.meta, 'environments', []), ...getConfigFromPreferences(child)]
-        );
+      const component = blocklet.children.find((x) => x.meta.did === childDid);
 
-        // chain config
-        await this._ensureAppChainConfig(
-          blocklet.meta.did,
-          get(b.meta, 'environments', []).map((x) => ({ key: x.name, value: x.default })),
-          { force: false }
-        );
-      });
+      await setConfig(blocklet, component);
     }
   }
 

package/lib/blocklet/manager/helper/migrate-application-to-struct-v2.js

@@ -1,6 +1,7 @@
 const path = require('path');
 const fs = require('fs-extra');
 const pick = require('lodash/pick');
+const get = require('lodash/get');
 const pRetry = require('p-retry');
 const urlPathFriendly = require('@blocklet/meta/lib/url-path-friendly').default;
 const { slugify } = require('transliteration');
@@ -9,12 +10,7 @@ const { getChainClient } = require('@abtnode/util/lib/get-chain-client');
 
 const logger = require('@abtnode/logger')('@abtnode/core:migrate-application-to-struct-v2');
 
-const {
-  forEachBlockletSync,
-  getSharedConfigObj,
-  getBlockletChainInfo,
-  isInProgress,
-} = require('@blocklet/meta/lib/util');
+const { forEachBlockletSync, getBlockletChainInfo, isInProgress } = require('@blocklet/meta/lib/util');
 const { SLOT_FOR_IP_DNS_SITE, MAIN_CHAIN_ENDPOINT } = require('@abtnode/constant');
 
 const {
@@ -33,6 +29,7 @@ const {
   BLOCKLET_CONFIGURABLE_KEY,
   BLOCKLET_META_FILE,
   BLOCKLET_UPLOADS_DIR,
+  CHAIN_PROP_MAP,
 } = require('@blocklet/constant');
 const { update: updateMetaFile } = require('@blocklet/meta/lib/file');
 const getBlockletWallet = require('@blocklet/meta/lib/wallet');
@@ -363,7 +360,55 @@ const migrateApplicationToStructV2 = async ({ did, appSk: newAppSk, context = {}
       configs: component.configs || [],
     });
 
-    const sharedConfigObj = getSharedConfigObj(component, ancestors);
+    const getSharedConfigObj = () => {
+      const res = {};
+
+      if (!ancestors || !ancestors.length) {
+        return res;
+      }
+
+      for (let i = ancestors.length - 1; i >= 0; i--) {
+        const ancestor = ancestors[i];
+
+        if (Array.isArray(ancestor.configs)) {
+          // eslint-disable-next-line no-loop-func
+          ancestor.configs.forEach(({ key, value, secure, shared }) => {
+            if (res[key]) {
+              return;
+            }
+            if (!value || secure !== false || shared === false || BLOCKLET_CONFIGURABLE_KEY[key]) {
+              return;
+            }
+            const config = (component.configs || []).find((x) => x.key === key);
+
+            if (config && config.value) {
+              return;
+            }
+            res[key] = get(ancestor, `configObj.${key}`) || value;
+          });
+        }
+      }
+
+      // share blocklet app chain config
+      const ancestor = ancestors[0];
+      (ancestor.configs || []).forEach(({ key, value }) => {
+        if (
+          ![
+            BLOCKLET_CONFIGURABLE_KEY.BLOCKLET_APP_CHAIN_HOST,
+            BLOCKLET_CONFIGURABLE_KEY.BLOCKLET_APP_CHAIN_ID,
+            BLOCKLET_CONFIGURABLE_KEY.BLOCKLET_APP_CHAIN_TYPE,
+          ].includes(key)
+        ) {
+          return;
+        }
+
+        res[CHAIN_PROP_MAP[key]] = value;
+      });
+
+      return res;
+    };
+
+    const sharedConfigObj = getSharedConfigObj();
     if (sharedConfigObj) {
       Object.entries(sharedConfigObj).forEach(([key, value]) => {
         if (!extraData.configs.some((x) => x.key === key)) {

package/lib/util/blocklet.js

@@ -85,12 +85,12 @@ const {
   forEachComponentV2Sync,
   getSharedConfigObj,
   getComponentName,
-  isEnvShareable,
   getBlockletAppIdList,
   getChainInfo,
   isInProgress,
   isRunning,
   hasStartEngine,
+  isEnvShareable,
 } = require('@blocklet/meta/lib/util');
 const { getComponentsInternalInfo } = require('@blocklet/meta/lib/blocklet');
 const { titleSchema, descriptionSchema, logoSchema } = require('@blocklet/meta/lib/schema');
@@ -419,7 +419,7 @@ const getRuntimeEnvironments = (blocklet, nodeEnvironments, ancestors) => {
 
   const env = {
     ...blocklet.configObj,
-    ...getSharedConfigObj(blocklet, ancestors),
+    ...getSharedConfigObj((ancestors || [])[0], blocklet),
     ...blocklet.environmentObj,
     ...devEnvironments,
     BLOCKLET_WEB_PORTS: JSON.stringify(ports),
@@ -1293,35 +1293,6 @@ const getBlocklet = async ({
   return blocklet;
 };
 
-/**
- * this function has side effect on environments
- */
-const ensureEnvDefault = (environments, ancestors) => {
-  // remove default if ancestors has a value
-  const envMap = environments.reduce((o, env) => {
-    o[env.name] = env;
-    return o;
-  }, {});
-
-  for (let i = ancestors.length - 1; i >= 0; i--) {
-    const ancestor = ancestors[i];
-    const aEnvironments = get(ancestor.meta, 'environments', []);
-    const aEnv = aEnvironments.find((x) => envMap[x.name]);
-
-    if (!isEnvShareable(aEnv)) {
-      break;
-    }
-
-    const env = envMap[aEnv.name];
-    if (isEnvShareable(env) && aEnv.default) {
-      env.default = '';
-      break;
-    }
-  }
-
-  return environments;
-};
-
 const fromProperty2Config = (properties = {}, result) => {
   Object.keys(properties).forEach((key) => {
     const prop = properties[key];
@@ -1335,7 +1306,7 @@ const fromProperty2Config = (properties = {}, result) => {
         name: `${BLOCKLET_PREFERENCE_PREFIX}${key}`,
         required: prop.required || false,
         secure,
-        shared: !secure,
+        shared: secure ? false : prop.shared,
       });
     }
   });
@@ -1876,6 +1847,61 @@ const updateDidDocument = async ({ blocklet, nodeInfo }) => {
   });
 };
 
+const getAppConfigsFromComponent = (meta, configsInApp = [], configsInComponent = []) => {
+  const configs = [];
+  for (const configInMeta of meta?.environments || []) {
+    if (isEnvShareable(configInMeta)) {
+      const configInApp = (configsInApp || []).find((x) => x.key === configInMeta.name);
+      if (!configInApp) {
+        const configInComponent = configsInComponent.find((y) => y.key === configInMeta.name);
+        if (configInComponent && isEnvShareable(configInComponent)) {
+          configs.push(configInComponent);
+        }
+      }
+    }
+  }
+  return configs;
+};
+
+const getConfigsFromInput = (configs = [], oldConfigs = []) => {
+  const sharedConfigs = [];
+  const selfConfigs = [];
+
+  configs.forEach((config) => {
+    const oldConfig = oldConfigs.find((y) => y.key === config.key);
+    if (isEnvShareable(config) || isEnvShareable(oldConfig)) {
+      sharedConfigs.push(config);
+    } else {
+      selfConfigs.push(config);
+    }
+  });
+
+  return { sharedConfigs, selfConfigs };
+};
+
+// remove app configs if no component use it
+const removeAppConfigsFromComponent = async (componentConfigs, app, blockletExtraState) => {
+  const appConfigs = app.configs || [];
+  const remainedConfigs = [].concat(...(app.children || []).map((x) => x.configs || []));
+  const removedAppConfigs = [];
+
+  componentConfigs.forEach((config) => {
+    const appConfig = appConfigs.find((x) => x.key === config.key);
+    if (
+      appConfig &&
+      !appConfig.custom &&
+      !(app.meta.environments || []).find((x) => x.name === config.key) &&
+      !remainedConfigs.find((x) => x.key === config.key && isEnvShareable(x))
+    ) {
+      removedAppConfigs.push({ key: appConfig.key, value: undefined });
+    }
+  });
+
+  if (removedAppConfigs.length) {
+    await blockletExtraState.setConfigs(app.meta.did, removedAppConfigs);
+  }
+};
+
 module.exports = {
   updateBlockletFallbackLogo,
   forEachBlocklet,
@@ -1914,7 +1940,6 @@ module.exports = {
   needBlockletDownload,
   ensureMeta,
   getBlocklet,
-  ensureEnvDefault,
   getConfigFromPreferences,
   createDataArchive,
   validateAppConfig,
@@ -1941,4 +1966,7 @@ module.exports = {
   updateDidDocument,
   getSlpDid,
   shouldEnableSlpDomain,
+  getAppConfigsFromComponent,
+  removeAppConfigsFromComponent,
+  getConfigsFromInput,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.16-beta-e038cde7",
+  "version": "1.16.16-beta-740ea329",
   "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.16-beta-e038cde7",
-    "@abtnode/auth": "1.16.16-beta-e038cde7",
-    "@abtnode/certificate-manager": "1.16.16-beta-e038cde7",
-    "@abtnode/constant": "1.16.16-beta-e038cde7",
-    "@abtnode/cron": "1.16.16-beta-e038cde7",
-    "@abtnode/logger": "1.16.16-beta-e038cde7",
-    "@abtnode/models": "1.16.16-beta-e038cde7",
-    "@abtnode/queue": "1.16.16-beta-e038cde7",
-    "@abtnode/rbac": "1.16.16-beta-e038cde7",
-    "@abtnode/router-provider": "1.16.16-beta-e038cde7",
-    "@abtnode/static-server": "1.16.16-beta-e038cde7",
-    "@abtnode/timemachine": "1.16.16-beta-e038cde7",
-    "@abtnode/util": "1.16.16-beta-e038cde7",
+    "@abtnode/analytics": "1.16.16-beta-740ea329",
+    "@abtnode/auth": "1.16.16-beta-740ea329",
+    "@abtnode/certificate-manager": "1.16.16-beta-740ea329",
+    "@abtnode/constant": "1.16.16-beta-740ea329",
+    "@abtnode/cron": "1.16.16-beta-740ea329",
+    "@abtnode/logger": "1.16.16-beta-740ea329",
+    "@abtnode/models": "1.16.16-beta-740ea329",
+    "@abtnode/queue": "1.16.16-beta-740ea329",
+    "@abtnode/rbac": "1.16.16-beta-740ea329",
+    "@abtnode/router-provider": "1.16.16-beta-740ea329",
+    "@abtnode/static-server": "1.16.16-beta-740ea329",
+    "@abtnode/timemachine": "1.16.16-beta-740ea329",
+    "@abtnode/util": "1.16.16-beta-740ea329",
     "@arcblock/did": "1.18.89",
     "@arcblock/did-auth": "1.18.89",
     "@arcblock/did-ext": "^1.18.89",
@@ -42,11 +42,11 @@
     "@arcblock/pm2-events": "^0.0.5",
     "@arcblock/validator": "^1.18.89",
     "@arcblock/vc": "1.18.89",
-    "@blocklet/constant": "1.16.16-beta-e038cde7",
-    "@blocklet/env": "1.16.16-beta-e038cde7",
-    "@blocklet/meta": "1.16.16-beta-e038cde7",
-    "@blocklet/resolver": "1.16.16-beta-e038cde7",
-    "@blocklet/sdk": "1.16.16-beta-e038cde7",
+    "@blocklet/constant": "1.16.16-beta-740ea329",
+    "@blocklet/env": "1.16.16-beta-740ea329",
+    "@blocklet/meta": "1.16.16-beta-740ea329",
+    "@blocklet/resolver": "1.16.16-beta-740ea329",
+    "@blocklet/sdk": "1.16.16-beta-740ea329",
     "@did-space/client": "^0.2.170",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.89",
@@ -100,5 +100,5 @@
     "jest": "^27.5.1",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "688b1c7ae0f6652094100c101f5d218266dd86ac"
+  "gitHead": "6abb5a7319ad1093f1e2d04d76215d4a127b538d"
 }