@adobe/helix-config 2.3.4 → 2.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
+
+
+### Features
+
+* add support for raw config ([#45](https://github.com/adobe/helix-config/issues/45)) ([7e3eab3](https://github.com/adobe/helix-config/commit/7e3eab3930ba33b9e04d502e2391e26580badbe6))
+
 ## [2.3.4](https://github.com/adobe/helix-config/compare/v2.3.3...v2.3.4) (2024-04-15)
 
 

package/package.json

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

package/src/ConfigContext.js

@@ -27,9 +27,14 @@ export const SCOPE_PIPELINE = 'pipeline';
  * Admin Service in JSON includes everything.
  * @type {string}
  */
-// eslint-disable-next-line no-unused-vars
 export const SCOPE_ADMIN = 'admin';
 
+/**
+ * Raw config service view, also for legacy sites.
+ * @type {string}
+ */
+export const SCOPE_RAW = 'raw';
+
 /**
  * Public / Custom Configs: Sidekick, Production Host, Custom Preview Page / Live Host, Custom JSON.
  * @type {string}

package/src/config-legacy.js

@@ -80,41 +80,57 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
   if (!helixConfig) {
     return null;
   }
-  const { contentBusId, ...source } = helixConfig.content.data['/'];
+  const { contentBusId } = helixConfig.content.data['/'];
+  let source = helixConfig.fstab?.data.mountpoints['/'];
+  if (typeof source === 'string') {
+    source = {
+      type: source.startsWith('https://drive.google.com/')
+        ? 'google'
+        : 'onedrive',
+      url: source,
+    };
+  }
   const config = {
     version: 1,
     code: {
       owner: rso.org,
       repo: rso.site,
+      source: {
+        type: 'github',
+        url: `https://github.com/${rso.org}/${rso.site}`,
+      },
     },
     content: {
       contentBusId,
       source,
     },
+    folders: helixConfig.fstab?.data.folders ?? {},
   };
   const configAllPreview = await fetchConfigAll(ctx, config.content.contentBusId, 'preview');
+  const configAllLive = await fetchConfigAll(ctx, config.content.contentBusId, 'live');
   const { access } = configAllPreview?.config?.data || {};
   if (access) {
     config.access = access;
   }
+  if (configAllPreview) {
+    config.cdn = configAllPreview.config?.data.cdn ?? {};
+    if (!config.cdn.prod?.host && configAllPreview.config?.data.host) {
+      config.cdn.prod = {
+        host: configAllPreview.config.data.host,
+      };
+    }
+  }
+
   if (scope === SCOPE_PIPELINE) {
     config.metadata = {};
     if (configAllPreview) {
       config.headers = configAllPreview.headers?.data ?? {};
       config.metadata.preview = configAllPreview.metadata ?? {};
-      config.cdn = configAllPreview.config?.data.cdn ?? {};
-      if (!config.cdn.prod?.host && configAllPreview.config?.data.host) {
-        config.cdn.prod = {
-          host: configAllPreview.config.data.host,
-        };
-      }
     }
-    const configAllLive = await fetchConfigAll(ctx, config.content.contentBusId, 'live');
     if (configAllLive?.metadata) {
       config.metadata.live = configAllLive.metadata;
     }
 
-    config.folders = helixConfig.fstab.data.folders ?? {};
     if (helixConfig?.head?.data?.html) {
       config.head = {
         html: helixConfig.head.data.html,

package/src/config-view.js

@@ -12,7 +12,12 @@
 import { ModifiersConfig } from '@adobe/helix-shared-config/modifiers';
 import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 import { PipelineResponse } from './PipelineResponse.js';
-import { SCOPE_ADMIN, SCOPE_PIPELINE, SCOPE_DELIVERY } from './ConfigContext.js';
+import {
+  SCOPE_ADMIN,
+  SCOPE_PIPELINE,
+  SCOPE_DELIVERY,
+  SCOPE_RAW,
+} from './ConfigContext.js';
 import { resolveLegacyConfig } from './config-legacy.js';
 
 /**
@@ -202,7 +207,7 @@ export async function getConfigResponse(ctx, opts) {
       live: getAccessConfig(config.access, 'live'),
       // access.require.repository ?
     };
-    if (opts.scope === SCOPE_ADMIN) {
+    if (opts.scope === SCOPE_ADMIN || opts.scope === SCOPE_RAW) {
       config.access.admin = admin;
     }
   }
@@ -235,6 +240,7 @@ export async function getConfigResponse(ctx, opts) {
         ...config.content.source,
       },
     };
+    delete adminConfig.public;
     return new PipelineResponse(JSON.stringify(adminConfig, null, 2), {
       headers: {
         'content-type': 'application/json',
@@ -243,6 +249,15 @@ export async function getConfigResponse(ctx, opts) {
     });
   }
 
+  if (opts.scope === SCOPE_RAW) {
+    return new PipelineResponse(JSON.stringify(config, null, 2), {
+      headers: {
+        'content-type': 'application/json',
+        ...surrogateHeaders,
+      },
+    });
+  }
+
   if (opts.scope === SCOPE_PIPELINE) {
     // validate that ref exists in code-bus
     if (!config.head?.html) {
@@ -282,7 +297,7 @@ export async function getConfigResponse(ctx, opts) {
   const publicConfig = {
     version: 1,
     ...rso,
-    public: {},
+    public: config.public || {},
   };
   return new PipelineResponse(JSON.stringify(publicConfig, null, 2), {
     headers: {

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: {
@@ -29,6 +29,7 @@ const FRAGMENTS = {
     'access/admin': 'object',
     'access/preview': 'object',
     'access/live': 'object',
+    public: 'object',
   },
 };
 
@@ -64,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);
   }
@@ -100,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;
+}