@adobe/helix-config 2.4.0 → 2.5.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.5.1](https://github.com/adobe/helix-config/compare/v2.5.0...v2.5.1) (2024-04-16)
+
+
+### Bug Fixes
+
+* use head from ref and return 404 if missing ([#47](https://github.com/adobe/helix-config/issues/47)) ([61ab5b5](https://github.com/adobe/helix-config/commit/61ab5b5b6758752c6c87cb64b02d10155a674ab6))
+
+# [2.5.0](https://github.com/adobe/helix-config/compare/v2.4.0...v2.5.0) (2024-04-16)
+
+
+### Features
+
+* calculate contentBusId on update ([#46](https://github.com/adobe/helix-config/issues/46)) ([85724df](https://github.com/adobe/helix-config/commit/85724dfa38738f75934d9b64cc9c01e53bd6c417))
+
 # [2.4.0](https://github.com/adobe/helix-config/compare/v2.3.4...v2.4.0) (2024-04-15)
 
 

package/package.json

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

package/src/config-legacy.js

@@ -17,14 +17,13 @@ const HELIX_CONTENT_BUS = 'helix-content-bus';
 
 /**
  * Retrieves the helix-config.json which is an aggregate from fstab.yaml and head.html.
- * Note: it always uses the branch `main`.
  *
  * @param {ConfigContext} ctx the context
  * @param {RSO} rso
  * @returns {Promise<HelixConfig|null>} the helix-config or {@code null} if optional and not found.
  */
 async function fetchHelixConfig(ctx, rso) {
-  const key = `${rso.org}/${rso.site}/main/helix-config.json`;
+  const key = `${rso.org}/${rso.site}/${rso.ref}/helix-config.json`;
   const res = await ctx.loader.getObject(HELIX_CODE_BUS, key);
   if (!res.body) {
     return null;
@@ -105,6 +104,8 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
       source,
     },
     folders: helixConfig.fstab?.data.folders ?? {},
+    /* c8 ignore next */
+    head: helixConfig?.head?.data ?? {},
   };
   const configAllPreview = await fetchConfigAll(ctx, config.content.contentBusId, 'preview');
   const configAllLive = await fetchConfigAll(ctx, config.content.contentBusId, 'live');
@@ -130,12 +131,6 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
     if (configAllLive?.metadata) {
       config.metadata.live = configAllLive.metadata;
     }
-
-    if (helixConfig?.head?.data?.html) {
-      config.head = {
-        html: helixConfig.head.data.html,
-      };
-    }
   }
   return config;
 }

package/src/config-view.js

@@ -167,6 +167,8 @@ async function resolveConfig(ctx, rso, scope) {
       preview: await loadMetadata(ctx, config, 'preview'),
       live: await loadMetadata(ctx, config, 'live'),
     };
+  }
+  if (scope === SCOPE_PIPELINE || scope === SCOPE_DELIVERY) {
     config.head = await loadHeadHtml(ctx, config, rso.ref);
   }
 
@@ -212,6 +214,17 @@ export async function getConfigResponse(ctx, opts) {
     }
   }
 
+  if (!config.head?.html && (opts.scope === SCOPE_PIPELINE || opts.scope === SCOPE_DELIVERY)) {
+    // validate that ref exists in code-bus
+    return new PipelineResponse('', {
+      status: 404,
+      headers: {
+        'x-error': 'ref does not exist (no head.html)',
+        ...surrogateHeaders,
+      },
+    });
+  }
+
   if (opts.scope === SCOPE_DELIVERY) {
     return new PipelineResponse('', {
       headers: {
@@ -250,6 +263,7 @@ export async function getConfigResponse(ctx, opts) {
   }
 
   if (opts.scope === SCOPE_RAW) {
+    delete config.head;
     return new PipelineResponse(JSON.stringify(config, null, 2), {
       headers: {
         'content-type': 'application/json',
@@ -259,17 +273,6 @@ export async function getConfigResponse(ctx, opts) {
   }
 
   if (opts.scope === SCOPE_PIPELINE) {
-    // validate that ref exists in code-bus
-    if (!config.head?.html) {
-      return new PipelineResponse('', {
-        status: 404,
-        headers: {
-          'x-error': 'ref does not exist (no head.html)',
-          ...surrogateHeaders,
-        },
-      });
-    }
-
     // remove all properties except `host`. pipeline doesn't need the others.
     retainProperty(config.cdn, 'host');
     const pipelineConfig = {

package/src/storage/config-store.js

@@ -11,7 +11,7 @@
  */
 import { HelixStorage } from './storage.js';
 import { StatusCodeError } from './status-code-error.js';
-import { jsonGet, jsonPut } from './utils.js';
+import { jsonGet, jsonPut, updateContentBusId } from './utils.js';
 
 const FRAGMENTS = {
   sites: {
@@ -65,6 +65,7 @@ export class ConfigStore {
     if (await storage.head(this.key)) {
       throw new StatusCodeError(409, 'config already exists.');
     }
+    updateContentBusId(ctx, data);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, data);
   }
@@ -101,7 +102,7 @@ export class ConfigStore {
       // eslint-disable-next-line no-param-reassign
       data = jsonPut(JSON.parse(buf), relPath, data);
     }
-
+    updateContentBusId(ctx, data);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, old, data);
   }

package/src/storage/utils.js

@@ -9,6 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import crypto from 'crypto';
+
 export function jsonGet(obj, path) {
   return path.split('/').reduce((o, p) => o[p], obj);
 }
@@ -30,3 +32,28 @@ export function jsonPut(obj, path, value) {
   }
   return obj;
 }
+
+/**
+ * Update the contentBusId field of the content object based on the source URL.
+ * @param ctx
+ * @param data
+ * @returns {boolean}
+ */
+export function updateContentBusId(ctx, data) {
+  if (!data.content?.source?.url) {
+    return false;
+  }
+  const sha256 = crypto
+    .createHash('sha256')
+    .update(data.content.source.url)
+    .digest('hex');
+  const contentBusId = `${sha256.substring(0, 59)}`;
+  if (contentBusId === data.content.contentBusId) {
+    ctx.log.info(`contentBusId is already correct for ${data.content.source.url}: ${contentBusId}`);
+    return false;
+  }
+  ctx.log.info(`Updating contentBusId for ${data.content.source.url}: ${contentBusId}`);
+  // eslint-disable-next-line no-param-reassign
+  data.content.contentBusId = contentBusId;
+  return true;
+}