oc 0.50.63 → 0.50.64

package/dist/registry/routes/helpers/get-component.js

@@ -52,14 +52,12 @@ const is_template_legacy_1 = __importDefault(require("../../../utils/is-template
 const events_handler_1 = __importDefault(require("../../domain/events-handler"));
 const nested_renderer_1 = __importDefault(require("../../domain/nested-renderer"));
 const require_wrapper_1 = __importDefault(require("../../domain/require-wrapper"));
-const sanitiser = __importStar(require("../../domain/sanitiser"));
 const urlBuilder = __importStar(require("../../domain/url-builder"));
 const validator = __importStar(require("../../domain/validators"));
 const validators_1 = require("../../domain/validators");
-const apply_default_values_1 = __importDefault(require("./apply-default-values"));
+const component_parameter_processor_1 = require("./component-parameter-processor");
 const format_error_stack_1 = require("./format-error-stack");
 const getComponentFallback = __importStar(require("./get-component-fallback"));
-const get_component_retrieving_info_1 = __importDefault(require("./get-component-retrieving-info"));
 exports.stream = Symbol('stream');
 const MAX_ARTIFACT_CACHE_ENTRIES = 1000;
 const noop = () => { };
@@ -140,6 +138,24 @@ function getComponent(conf, repository) {
         return names;
     };
     const inFlight = new Map();
+    const parameterSchemaCache = new WeakMap();
+    const emptyParameterSchema = (0, component_parameter_processor_1.compileParameterSchema)(undefined);
+    const getCompiledParameterSchema = (expectedParameters) => {
+        if (!expectedParameters || typeof expectedParameters !== 'object') {
+            return emptyParameterSchema;
+        }
+        let compiled = parameterSchemaCache.get(expectedParameters);
+        if (compiled) {
+            return compiled;
+        }
+        if (Object.keys(expectedParameters).length === 0) {
+            parameterSchemaCache.set(expectedParameters, emptyParameterSchema);
+            return emptyParameterSchema;
+        }
+        compiled = (0, component_parameter_processor_1.compileParameterSchema)(expectedParameters);
+        parameterSchemaCache.set(expectedParameters, compiled);
+        return compiled;
+    };
     const singleFlight = (key, operation) => {
         const pending = inFlight.get(key);
         if (pending) {
@@ -151,41 +167,89 @@ function getComponent(conf, repository) {
         inFlight.set(key, promise);
         return promise;
     };
-    const getEnv = async (component) => {
+    const lookupEnv = (component, cb) => {
         const cacheKey = `${component.name}/${component.version}/.env`;
         const cached = cache.get('file-contents', cacheKey);
-        if (cached !== undefined)
-            return cached;
-        return singleFlight(cacheKey, async () => {
+        if (cached !== undefined) {
+            cb(null, cached);
+            return;
+        }
+        singleFlight(cacheKey, async () => {
             const env = component.oc.files.env
                 ? await repository.getEnv(component.name, component.version)
                 : {};
             cache.set('file-contents', cacheKey, env);
             return env;
-        });
+        }).then((env) => cb(null, env), cb);
     };
-    const renderer = async (options, cb) => {
-        const nestedRenderer = (0, nested_renderer_1.default)(renderer, options.conf);
-        const retrievingInfo = (0, get_component_retrieving_info_1.default)(options);
+    const enrichLocalErrorStack = async (component, err, response) => {
+        try {
+            const { content } = await repository
+                .getDataProvider(component.name, component.version)
+                .catch(() => ({ content: null }));
+            if (!content || !err.stack || !response.response.details) {
+                return;
+            }
+            const processedStack = await (0, format_error_stack_1.processStackTrace)({
+                stackTrace: err.stack,
+                code: content
+            }).catch(() => null);
+            if (!processedStack) {
+                return;
+            }
+            response.response.details.stack = processedStack.stack;
+            response.response.details.frame = processedStack.frame;
+            console.log(`Error rendering component ${component.name} ${component.version}`);
+            console.log(processedStack.stack);
+            console.log(processedStack.frame);
+        }
+        catch {
+            // keep the original error stack when local diagnostics fail
+        }
+    };
+    const renderer = (options, cb) => {
+        const retrievalStart = process.hrtime.bigint();
+        let retrievedHref;
+        let retrievedVersion;
+        let retrievedRenderMode;
         let responseHeaders;
         const responseCookies = [];
         const getLanguage = () => {
             const paramOverride = !!options.parameters && options.parameters['__ocAcceptLanguage'];
             return paramOverride || options.headers['accept-language'];
         };
+        const fireComponentRetrievedEvent = (result) => {
+            if (!events_handler_1.default.hasListeners('component-retrieved')) {
+                return;
+            }
+            const eventData = {
+                headers: options.headers,
+                name: options.name,
+                parameters: options.parameters,
+                requestVersion: options.version || ''
+            };
+            if (retrievedHref !== undefined) {
+                eventData['href'] = retrievedHref;
+                eventData['version'] = retrievedVersion;
+                eventData['renderMode'] = retrievedRenderMode;
+            }
+            if (result.response.error) {
+                Object.assign(eventData, result.response);
+            }
+            eventData['status'] = result.status;
+            eventData['duration'] =
+                Number(process.hrtime.bigint() - retrievalStart) / 1e3;
+            events_handler_1.default.fire('component-retrieved', eventData);
+        };
         const callback = (result) => {
             if (responseCookies.length > 0 && !result.cookies) {
                 result.cookies = responseCookies;
             }
-            if (result.response.error) {
-                retrievingInfo.extend(result.response);
-            }
-            retrievingInfo.extend({ status: result.status });
             Object.assign(result.response, {
                 name: options.name,
                 requestVersion: options.version || ''
             });
-            events_handler_1.default.fire('component-retrieved', retrievingInfo.getData());
+            fireComponentRetrievedEvent(result);
             return cb(result);
         };
         let componentCallbackDone = false;
@@ -196,7 +260,7 @@ function getComponent(conf, repository) {
             version: options.version || '',
             parameters: options.parameters
         };
-        (0, universalify_1.fromPromise)(repository.getComponent)(requestedComponent.name, requestedComponent.version, (err, component) => {
+        getComponentCb(requestedComponent.name, requestedComponent.version, (err, component) => {
             // check route exist for component and version
             if (err) {
                 if (conf.fallbackRegistryUrl) {
@@ -234,10 +298,9 @@ function getComponent(conf, repository) {
                     }
                 });
             }
-            // sanitise and check params
-            const appliedParams = (0, apply_default_values_1.default)(requestedComponent.parameters, component.oc.parameters);
-            const params = sanitiser.sanitiseComponentParameters(appliedParams, component.oc.parameters);
-            const validationResult = validator.validateComponentParameters(params, component.oc.parameters);
+            // sanitise and check params (compiled schema + single scan)
+            const compiledParameterSchema = getCompiledParameterSchema(component.oc.parameters);
+            const { params, validation: validationResult } = (0, component_parameter_processor_1.processParameters)(requestedComponent.parameters, compiledParameterSchema);
             if (!options.action && !validationResult.isValid) {
                 return callback({
                     status: 400,
@@ -291,7 +354,7 @@ function getComponent(conf, repository) {
                 }
                 return filteredHeaders;
             };
-            const returnComponent = async (err, data) => {
+            const returnComponent = (err, data) => {
                 if (componentCallbackDone) {
                     return;
                 }
@@ -324,11 +387,9 @@ function getComponent(conf, repository) {
                         renderMode = 'rendered';
                     }
                 }
-                retrievingInfo.extend({
-                    href: componentHref,
-                    version: component.version,
-                    renderMode
-                });
+                retrievedHref = componentHref;
+                retrievedVersion = component.version;
+                retrievedRenderMode = renderMode;
                 if (err || !data) {
                     err =
                         err ||
@@ -356,22 +417,10 @@ function getComponent(conf, repository) {
                         }
                     };
                     if (conf.local && err.stack) {
-                        const { content } = await repository
-                            .getDataProvider(component.name, component.version)
-                            .catch(() => ({ content: null }));
-                        if (content) {
-                            const processedStack = await (0, format_error_stack_1.processStackTrace)({
-                                stackTrace: err.stack,
-                                code: content
-                            }).catch(() => null);
-                            if (processedStack) {
-                                response.response.details.stack = processedStack.stack;
-                                response.response.details.frame = processedStack.frame;
-                                console.log(`Error rendering component ${component.name} ${component.version}`);
-                                console.log(processedStack.stack);
-                                console.log(processedStack.frame);
-                            }
-                        }
+                        enrichLocalErrorStack(component, err, response)
+                            .catch(() => { })
+                            .then(() => callback(response));
+                        return;
                     }
                     return callback(response);
                 }
@@ -471,7 +520,7 @@ function getComponent(conf, repository) {
                 returnComponent(null, { component: { props } });
             }
             else {
-                (0, universalify_1.fromPromise)(getEnv)(component, (err, env) => {
+                lookupEnv(component, (err, env) => {
                     if (err) {
                         componentCallbackDone = true;
                         return callback({
@@ -494,14 +543,14 @@ function getComponent(conf, repository) {
                             return parsedAcceptLanguage;
                         },
                         baseUrl: conf.baseUrl,
-                        env: { ...conf.env, ...env },
+                        env: { ...conf.env, ...(env || {}) },
                         params,
                         plugins: convertPlugins({
                             name: component.name,
                             version: component.version
                         }),
-                        renderComponent: (0, universalify_1.fromPromise)(nestedRenderer.renderComponent),
-                        renderComponents: (0, universalify_1.fromPromise)(nestedRenderer.renderComponents),
+                        renderComponent: nestedRenderComponent,
+                        renderComponents: nestedRenderComponents,
                         requestHeaders: options.headers,
                         requestIp: options.ip,
                         setEmptyResponse,
@@ -636,5 +685,9 @@ function getComponent(conf, repository) {
             }
         });
     };
+    const nestedRenderer = (0, nested_renderer_1.default)(renderer, conf);
+    const nestedRenderComponent = (0, universalify_1.fromPromise)(nestedRenderer.renderComponent);
+    const nestedRenderComponents = (0, universalify_1.fromPromise)(nestedRenderer.renderComponents);
+    const getComponentCb = (0, universalify_1.fromPromise)(repository.getComponent);
     return renderer;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "oc",
-	"version": "0.50.63",
+	"version": "0.50.64",
 	"description": "A framework for developing and distributing html components",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -97,8 +97,8 @@
 		"oc-empty-response-handler": "^1.0.2",
 		"oc-get-unix-utc-timestamp": "^1.0.6",
 		"oc-metadata-adapters-utils": "^0.1.1",
-		"oc-s3-storage-adapter": "^2.2.4",
-		"oc-storage-adapters-utils": "^2.1.2",
+		"oc-s3-storage-adapter": "^2.2.5",
+		"oc-storage-adapters-utils": "^2.1.3",
 		"oc-template-es6": "^2.0.0",
 		"oc-template-es6-compiler": "^7.1.4",
 		"oc-template-handlebars": "^6.0.26",
@@ -117,7 +117,7 @@
 		"source-map": "^0.7.6",
 		"targz": "^1.0.1",
 		"try-require": "^1.2.1",
-		"undici": "^8.5.0",
+		"undici": "^8.9.0",
 		"universalify": "^2.0.1",
 		"yargs": "^17.7.2"
 	}

package/dist/registry/routes/helpers/get-component-retrieving-info.d.ts

@@ -1,19 +0,0 @@
-import type { IncomingHttpHeaders } from 'node:http';
-interface Options {
-    headers: IncomingHttpHeaders;
-    name: string;
-    parameters: IncomingHttpHeaders;
-    version: string;
-}
-interface EventData {
-    headers: IncomingHttpHeaders;
-    name: string;
-    parameters: IncomingHttpHeaders;
-    requestVersion: string;
-    duration: number;
-}
-export default function getComponentRetrievingInfo(options: Options): {
-    extend(obj: unknown): void;
-    getData(): EventData;
-};
-export {};

package/dist/registry/routes/helpers/get-component-retrieving-info.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getComponentRetrievingInfo;
-function getComponentRetrievingInfo(options) {
-    const eventData = {
-        headers: options.headers,
-        name: options.name,
-        parameters: options.parameters,
-        requestVersion: options.version || '',
-        duration: 0
-    };
-    const start = process.hrtime();
-    return {
-        extend(obj) {
-            Object.assign(eventData, obj);
-        },
-        getData() {
-            const delta = process.hrtime(start);
-            const nanosec = delta[0] * 1e9 + delta[1];
-            eventData.duration = nanosec / 1e3;
-            return eventData;
-        }
-    };
-}