@adobe/helix-config-storage 1.2.3 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.3.0](https://github.com/adobe/helix-config-storage/compare/v1.2.3...v1.3.0) (2024-08-26)
+
+
+### Features
+
+* include profile aggregate in purge call ([02a3580](https://github.com/adobe/helix-config-storage/commit/02a3580bbae7f4d2f646f8de4e92a9efc0bedd60))
+
 ## [1.2.3](https://github.com/adobe/helix-config-storage/compare/v1.2.2...v1.2.3) (2024-08-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config-storage",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "Helix Config Storage",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/config-store.js

@@ -158,6 +158,31 @@ function redact(config, frag) {
  * General purpose config store.
  */
 export class ConfigStore {
+  /**
+   * @member {string} org the org id
+   */
+  org;
+
+  /**
+   * @member {string} type store type (org, sites, profiles, secrets, users)
+   */
+  type;
+
+  /**
+   * @member {string} name config name
+   */
+  name;
+
+  /**
+   * @member {string} key storage key
+   */
+  key;
+
+  /**
+   * @member {object} profiles the cached profiles config
+   */
+  #profiles = {};
+
   /**
    * @param {string} org the org id
    * @param {string} type store type (org, sites, profiles, secrets, users)
@@ -174,8 +199,54 @@ export class ConfigStore {
     this.type = type;
     this.name = name;
     this.key = type === 'org'
-      ? `/orgs/${this.org}/${this.name || 'config'}.json`
-      : `/orgs/${this.org}/${this.type}/${this.name}.json`;
+      ? `/orgs/${org}/${name || 'config'}.json`
+      : `/orgs/${org}/${type}/${name}.json`;
+  }
+
+  async #list(ctx) {
+    const storage = HelixStorage.fromContext(ctx).configBus();
+    const key = `orgs/${this.org}/${this.type}/`;
+    const list = await storage.list(key);
+    return {
+      [this.type]: list.map((entry) => {
+        const siteKey = entry.key;
+        if (siteKey.endsWith('.json')) {
+          const name = siteKey.split('/').pop();
+          return {
+            path: `/config/${this.org}/${this.type}/${name}`,
+            name: name.substring(0, name.length - 5),
+          };
+        }
+        return null;
+      }).filter((entry) => !!entry),
+    };
+  }
+
+  async #getProfile(ctx, data) {
+    const profileName = data.extends?.profile || 'default';
+    let profile = this.#profiles[profileName];
+    if (profile !== undefined) {
+      return profile;
+    }
+    const storage = HelixStorage.fromContext(ctx).configBus();
+    const profileJson = await storage.get(`/orgs/${this.org}/profiles/${profileName}.json`);
+    profile = profileJson ? JSON.parse(profileJson) : null;
+    this.#profiles[profileName] = profile;
+    return profile;
+  }
+
+  /**
+   * Returns the aggregated config. For site configs, this includes the profile config.
+   * @param {AdminContext} ctx
+   * @param {HelixSiteConfig|HelixProfileConfig} data the data of the config to be updated
+   * @returns {Promise<HelixSiteConfig|HelixProfileConfig>}
+   */
+  async getAggregatedConfig(ctx, data) {
+    if (this.type !== 'sites' || !data) {
+      return data;
+    }
+    const profile = await this.#getProfile(ctx, data);
+    return getMergedConfig(data, profile);
   }
 
   /**
@@ -185,16 +256,7 @@ export class ConfigStore {
    * @returns {Promise<boolean|undefined>}
    */
   async validate(ctx, data) {
-    let config = data;
-    if (this.type === 'sites') {
-      // validate the config after merging with the profile
-      const storage = HelixStorage.fromContext(ctx).configBus();
-      const profileName = data.extends?.profile || 'default';
-      const profileJson = await storage.get(`/orgs/${this.org}/profiles/${profileName}.json`);
-      const profile = profileJson ? JSON.parse(profileJson) : null;
-      config = getMergedConfig(config, profile);
-    }
-    return validateSchema(config, this.type);
+    return validateSchema(data, this.type);
   }
 
   async create(ctx, data, relPath = '') {
@@ -215,28 +277,10 @@ export class ConfigStore {
       updateContentSource(ctx, data.content);
       updateCodeSource(ctx, data.code);
     }
-    await this.validate(ctx, data);
+    const config = await this.getAggregatedConfig(ctx, data);
+    await this.validate(ctx, config);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
-    await this.purge(ctx, null, data);
-  }
-
-  async #list(ctx) {
-    const storage = HelixStorage.fromContext(ctx).configBus();
-    const key = `orgs/${this.org}/${this.type}/`;
-    const list = await storage.list(key);
-    return {
-      [this.type]: list.map((entry) => {
-        const siteKey = entry.key;
-        if (siteKey.endsWith('.json')) {
-          const name = siteKey.split('/').pop();
-          return {
-            path: `/config/${this.org}/${this.type}/${name}`,
-            name: name.substring(0, name.length - 5),
-          };
-        }
-        return null;
-      }).filter((entry) => entry),
-    };
+    await this.purge(ctx, null, config);
   }
 
   async read(ctx, relPath = '') {
@@ -337,9 +381,17 @@ export class ConfigStore {
       updateContentSource(ctx, config.content);
       updateCodeSource(ctx, config.code);
     }
-    await this.validate(ctx, config);
+    let oldConfig = buf ? JSON.parse(buf) : null;
+    let newConfig = config;
+    if (this.type === 'sites') {
+      // apply profile
+      oldConfig = await this.getAggregatedConfig(ctx, oldConfig);
+      newConfig = await this.getAggregatedConfig(ctx, newConfig);
+    }
+
+    await this.validate(ctx, newConfig);
     await storage.put(this.key, JSON.stringify(config), 'application/json');
-    await this.purge(ctx, buf ? JSON.parse(buf) : null, config);
+    await this.purge(ctx, oldConfig, newConfig);
     return ret ?? redact(data, frag);
   }
 
@@ -350,16 +402,23 @@ export class ConfigStore {
       throw new StatusCodeError(404, 'config not found.');
     }
     const frag = getFragmentInfo(this.type, relPath);
+    let oldConfig = JSON.parse(buf);
+    if (this.type === 'sites') {
+      // apply profile
+      oldConfig = await this.getAggregatedConfig(ctx, oldConfig);
+    }
+
     if (frag) {
       const data = deepPut(JSON.parse(buf), relPath, null);
-      await this.validate(ctx, data);
+      const newConfig = await this.getAggregatedConfig(ctx, data);
+      await this.validate(ctx, newConfig);
       await storage.put(this.key, JSON.stringify(data), 'application/json');
-      await this.purge(ctx, JSON.parse(buf), data);
+      await this.purge(ctx, oldConfig, newConfig);
       return;
     }
 
     await storage.remove(this.key);
-    await this.purge(ctx, JSON.parse(buf), null);
+    await this.purge(ctx, oldConfig, null);
   }
 
   // eslint-disable-next-line class-methods-use-this,no-unused-vars