@adobe/helix-config 1.3.3 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [2.0.0](https://github.com/adobe/helix-config/compare/v1.3.3...v2.0.0) (2024-03-14)
+
+
+### Features
+
+* refactor s3 loader abstraction ([#31](https://github.com/adobe/helix-config/issues/31)) ([086cce5](https://github.com/adobe/helix-config/commit/086cce51e76da932ed68acef095e262db0e50be5))
+
+
+### BREAKING CHANGES
+
+* replace HelixStorage with S3Loader
+
 ## [1.3.3](https://github.com/adobe/helix-config/compare/v1.3.2...v1.3.3) (2024-03-14)
 
 

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@adobe/helix-config",
-  "version": "1.3.3",
+  "version": "2.0.0",
   "description": "Helix Config",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": "./src/index.js"
+  },
   "type": "module",
   "scripts": {
     "test": "c8 mocha",

package/src/ConfigContext.d.ts

@@ -9,7 +9,7 @@
  * OF ANY KIND; either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import {HelixStorage} from "./HelixStorage";
+import {S3Loader} from "./S3Loader";
 
 type Fetch = (url: string|Request, options?: RequestOptions) => Promise<Response>;
 
@@ -23,7 +23,7 @@ export declare enum ConfigScope {
 export declare class ConfigContext {
   withLog(log: Console): ConfigContext;
   withEnv(env: object): ConfigContext;
-  withHelixStorage(storage: HelixStorage): ConfigContext;
+  withS3Loader(loader: S3Loader): ConfigContext;
   withFetch(fetch: Fetch): ConfigContext;
 }
 

package/src/ConfigContext.js

@@ -45,7 +45,7 @@ export class ConfigContext {
 
   env = {};
 
-  storage = null;
+  loader = null;
 
   fetch = null;
 
@@ -59,8 +59,8 @@ export class ConfigContext {
     return this;
   }
 
-  withHelixStorage(storage) {
-    this.storage = storage;
+  withS3Loader(loader) {
+    this.loader = loader;
     return this;
   }
 

package/src/S3Loader.d.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License; Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing; software distributed under
+ * the License is distributed on an "AS IS" BASIS; WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND; either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import {PipelineResponse} from "./PipelineResponse";
+
+
+/**
+ * S3 Loader abstration used to load S3 objects.
+ */
+export declare interface S3Loader {
+  /**
+   * Loads a S3 object from the given bucket and key.
+   * @param {string} bucketId
+   * @param {string} key
+   */
+  getObject(bucketId, key): Promise<PipelineResponse>;
+
+  /**
+   * Retrieves the head metadata of a S3 object from the given bucket and key.
+   * @param {string} bucketId
+   * @param {string} key
+   */
+  headObject(bucketId, key): Promise<PipelineResponse>;
+}

package/src/config-legacy.js

@@ -11,6 +11,10 @@
  */
 import { SCOPE_PIPELINE } from './ConfigContext.js';
 
+const HELIX_CODE_BUS = 'helix-code-bus';
+
+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`.
@@ -20,16 +24,14 @@ import { SCOPE_PIPELINE } from './ConfigContext.js';
  * @returns {Promise<HelixConfig|null>} the helix-config or {@code null} if optional and not found.
  */
 async function fetchHelixConfig(ctx, rso) {
-  const codeBus = ctx.storage.codeBus();
   const key = `${rso.org}/${rso.site}/main/helix-config.json`;
-  const meta = {};
-  const data = await codeBus.get(key, meta);
-  if (!data) {
+  const res = await ctx.loader.getObject(HELIX_CODE_BUS, key);
+  if (!res.body) {
     return null;
   }
-  const config = JSON.parse(data);
+  const config = res.json();
   // set contentbus id, if present in header
-  const cbid = meta['x-contentbus-id'];
+  const cbid = res.headers.get('x-amz-meta-x-contentbus-id');
   if (cbid && !config.content) {
     // create the content section if not already present
     config.content = {
@@ -57,13 +59,12 @@ async function fetchHelixConfig(ctx, rso) {
  * @returns {Promise<ConfigAll|null>} the project configuration
  */
 async function fetchConfigAll(ctx, contentBusId, partition) {
-  const contentBus = ctx.storage.contentBus();
   const key = `${contentBusId}/${partition}/.helix/config-all.json`;
-  const data = await contentBus.get(key);
-  if (!data) {
+  const res = await ctx.loader.getObject(HELIX_CONTENT_BUS, key);
+  if (!res.body) {
     return null;
   }
-  return JSON.parse(data);
+  return res.json();
 }
 
 /**

package/src/config-view.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { ModifiersConfig } from '@adobe/helix-shared-config';
+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';
@@ -34,6 +34,12 @@ import { resolveLegacyConfig } from './config-legacy.js';
 
 const METADATA_JSON = '/metadata.json';
 
+const HELIX_CODE_BUS = 'helix-code-bus';
+
+const HELIX_CONFIG_BUS = 'helix-config-bus';
+
+const HELIX_CONTENT_BUS = 'helix-content-bus';
+
 export function toArray(v) {
   if (!v) {
     return [];
@@ -77,7 +83,6 @@ export function getAccessConfig(access, partition) {
  * @returns {Promise<{data: ModifierMap}|{}>} the metadata
  */
 async function loadMetadata(ctx, config, partition) {
-  const contentBus = ctx.storage.contentBus();
   const paths = config.metadata?.source ?? [];
   if (!paths.length) {
     paths.push(METADATA_JSON);
@@ -86,11 +91,11 @@ async function loadMetadata(ctx, config, partition) {
   // generate the metadata-all.json first
   const metadata = [];
   for (const path of paths) {
-    const key = `/${config.content.contentBusId}/${partition}${path}`;
+    const key = `${config.content.contentBusId}/${partition}${path}`;
     // eslint-disable-next-line no-await-in-loop
-    const buf = await contentBus.get(key);
-    if (buf) {
-      const json = JSON.parse(buf.toString('utf-8'));
+    const res = await ctx.loader.getObject(HELIX_CONTENT_BUS, key);
+    if (res.body) {
+      const json = res.json();
       const data = json.data || json.default?.data;
       if (data) {
         metadata.push(...data);
@@ -109,12 +114,11 @@ async function loadMetadata(ctx, config, partition) {
 }
 
 async function loadHeadHtml(ctx, config, ref) {
-  const codeBus = ctx.storage.codeBus();
   const key = `${config.code.owner}/${config.code.repo}/${ref}/head.html`;
-  const buf = await codeBus.get(key);
-  if (buf) {
+  const res = await ctx.loader.getObject(HELIX_CODE_BUS, key);
+  if (res.body) {
     return {
-      html: buf.toString('utf-8'),
+      html: res.body,
     };
   }
   return {};
@@ -143,17 +147,16 @@ function retainProperty(obj, prop) {
  */
 async function resolveConfig(ctx, rso, scope) {
   // try to load site config from config-bus
-  const configBus = ctx.storage.configBus();
-  const key = `/orgs/${rso.org}/sites/${rso.site}.json`;
-  const buf = await configBus.get(key);
-  if (!buf) {
+  const key = `orgs/${rso.org}/sites/${rso.site}.json`;
+  const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
+  if (!res.body) {
     if (scope !== SCOPE_ADMIN) {
       return resolveLegacyConfig(ctx, rso, scope);
     } else {
       return null;
     }
   }
-  const config = JSON.parse(buf.toString('utf-8'));
+  const config = res.json();
   if (scope === SCOPE_PIPELINE) {
     config.metadata = {
       preview: await loadMetadata(ctx, config, 'preview'),

package/src/domain-view.js

@@ -12,10 +12,16 @@
 import { PipelineResponse } from './PipelineResponse.js';
 
 export async function getDomainResponse(ctx, domain) {
-  const configBus = ctx.storage.configBus();
-  const key = `/domains/${domain}`;
-  const data = await configBus.head(key);
-  if (!data?.Metadata?.location) {
+  const res = await ctx.loader.headObject('helix-config-bus', `domains/${domain}`);
+  const location = res.headers.get('x-amz-meta-location');
+  if (res.status === 200 && location) {
+    return new PipelineResponse('', {
+      status: 200,
+      headers: {
+        location,
+      },
+    });
+  } else {
     return new PipelineResponse('', {
       status: 404,
       headers: {
@@ -23,10 +29,4 @@ export async function getDomainResponse(ctx, domain) {
       },
     });
   }
-  return new PipelineResponse('', {
-    status: 200,
-    headers: {
-      Location: data.Metadata.location,
-    },
-  });
 }

package/src/index.d.ts

@@ -12,6 +12,9 @@
 import { PipelineResponse } from './PipelineResponse';
 import { ConfigContext, ConfigScope } from "./ConfigContext";
 
+export * from './PipelineResponse';
+export * from './S3Loader';
+
 export declare class ConfigRequestOptions {
   scope: ConfigScope;
   org: string;

package/src/HelixStorage.ts

@@ -1,47 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License; Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing; software distributed under
- * the License is distributed on an "AS IS" BASIS; WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND; either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-export declare interface Bucket {
-  /**
-   * Return an object contents.
-   *
-   * @param {string} key object key
-   * @param {object} [meta] output object to receive metadata if specified
-   * @returns {Promise<Buffer>}object contents as a Buffer or null if no found.
-   * @throws an error if the object could not be loaded due to an unexpected error.
-   */
-  get(key:string, meta?:object): Promise<Buffer|null>
-
-  /**
-   * Performs a head request
-   * @param key
-   * @returns the head metadata or null
-   */
-  head(key:string): Promise<object|null>;
-}
-
-export declare interface HelixStorage {
-  /**
-   * Returns a bucket with the given identifier.
-   * @param {string} bucketId
-   * @returns {Bucket} the s3 object or null if not found
-   * @throws {Error} if the s3 object cannot be retrieved
-   */
-  bucket(bucketId:string): Bucket;
-
-  contentBus(): Bucket;
-
-  codeBus(): Bucket;
-
-  configBus(): Bucket;
-
-  mediaBus(): Bucket;
-}