oc 0.50.58 → 0.50.60

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

@@ -123,21 +123,53 @@ function getComponent(conf, repository) {
         refreshInterval: conf.refreshInterval
     });
     const convertPlugins = pluginConverter(conf.plugins);
+    const customHeadersByConfig = new WeakMap();
+    const pluginNamesByConfig = new WeakMap();
+    const getCustomHeadersToSkip = (config) => {
+        if (!customHeadersByConfig.has(config)) {
+            customHeadersByConfig.set(config, config.customHeadersToSkipOnWeakVersion?.length
+                ? new Set(config.customHeadersToSkipOnWeakVersion)
+                : undefined);
+        }
+        return customHeadersByConfig.get(config);
+    };
+    const getRegistryPluginNames = (config) => {
+        let names = pluginNamesByConfig.get(config);
+        if (!names) {
+            names = new Set(Object.keys(config.plugins || {}));
+            pluginNamesByConfig.set(config, names);
+        }
+        return names;
+    };
+    const inFlight = new Map();
+    const singleFlight = (key, operation) => {
+        const pending = inFlight.get(key);
+        if (pending) {
+            return pending;
+        }
+        const promise = operation().finally(() => {
+            inFlight.delete(key);
+        });
+        inFlight.set(key, promise);
+        return promise;
+    };
     const getEnv = async (component) => {
         const cacheKey = `${component.name}/${component.version}/.env`;
         const cached = cache.get('file-contents', cacheKey);
         if (cached)
             return cached;
-        const env = component.oc.files.env
-            ? await repository.getEnv(component.name, component.version)
-            : {};
-        cache.set('file-contents', cacheKey, env);
-        return env;
+        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;
+        });
     };
     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);
-        let responseHeaders = {};
+        let responseHeaders;
         const responseCookies = [];
         const getLanguage = () => {
             const paramOverride = !!options.parameters && options.parameters['__ocAcceptLanguage'];
@@ -159,11 +191,8 @@ function getComponent(conf, repository) {
             return cb(result);
         };
         let componentCallbackDone = false;
+        let callbackTimeout;
         const conf = options.conf;
-        const customHeadersToSkipSet = conf.customHeadersToSkipOnWeakVersion?.length
-            ? new Set(conf.customHeadersToSkipOnWeakVersion)
-            : undefined;
-        const acceptLanguage = getLanguage();
         const requestedComponent = {
             name: options.name,
             version: options.version || '',
@@ -196,7 +225,7 @@ function getComponent(conf, repository) {
                 });
             }
             // check component requirements are satisfied by registry
-            const pluginsCompatibility = validator.validatePluginsRequirements(component.oc.plugins, conf.plugins);
+            const pluginsCompatibility = validator.validatePluginsRequirements(component.oc.plugins, getRegistryPluginNames(conf));
             if (!pluginsCompatibility.isValid) {
                 return callback({
                     status: 501,
@@ -249,7 +278,10 @@ function getComponent(conf, repository) {
                 });
             }
             const filterCustomHeaders = (headers, requestedVersion, actualVersion) => {
-                if (!customHeadersToSkipSet || requestedVersion === actualVersion) {
+                const customHeadersToSkipSet = getCustomHeadersToSkip(conf);
+                if (!headers ||
+                    !customHeadersToSkipSet ||
+                    requestedVersion === actualVersion) {
                     return headers;
                 }
                 let filteredHeaders;
@@ -259,28 +291,32 @@ function getComponent(conf, repository) {
                         filteredHeaders[key] = headers[key];
                     }
                 }
-                return filteredHeaders || {};
+                return filteredHeaders;
             };
             const returnComponent = async (err, data) => {
                 if (componentCallbackDone) {
                     return;
                 }
                 componentCallbackDone = true;
+                if (callbackTimeout) {
+                    clearTimeout(callbackTimeout);
+                    callbackTimeout = undefined;
+                }
                 const componentHref = urlBuilder.component({
                     name: component.name,
                     version: requestedComponent.version,
                     parameters: params
                 }, conf.baseUrl);
                 const isUnrendered = options.headers.accept === settings_1.default.registry.acceptUnrenderedHeader;
-                const isValidClientRequest = options.headers['user-agent'] &&
-                    !!options.headers['user-agent'].match('oc-client-');
-                const supportedTemplates = options.headers['templates']
-                    ? parseTemplatesHeader(options.headers['templates'])
-                    : [];
-                const isTemplateSupportedByClient = Boolean(isValidClientRequest &&
-                    options.headers['templates'] &&
-                    (supportedTemplates.includes(component.oc.files.template.type) ||
-                        supportedTemplates.includes(templateType)));
+                const isValidClientRequest = String(options.headers['user-agent'] || '').includes('oc-client-');
+                const templatesHeader = options.headers['templates'];
+                let isTemplateSupportedByClient = false;
+                if (isUnrendered && isValidClientRequest && templatesHeader) {
+                    const supportedTemplates = parseTemplatesHeader(templatesHeader);
+                    isTemplateSupportedByClient =
+                        supportedTemplates.includes(component.oc.files.template.type) ||
+                            supportedTemplates.includes(templateType);
+                }
                 let renderMode = options.action ? 'unrendered' : 'rendered';
                 if (isUnrendered) {
                     renderMode = 'unrendered';
@@ -356,7 +392,7 @@ function getComponent(conf, repository) {
                 if (renderMode === 'unrendered') {
                     callback({
                         status: 200,
-                        headers: responseHeaders,
+                        ...(responseHeaders ? { headers: responseHeaders } : {}),
                         response: Object.assign(response, {
                             data: data,
                             template: {
@@ -396,7 +432,7 @@ function getComponent(conf, repository) {
                             }
                             callback({
                                 status: 200,
-                                headers: responseHeaders,
+                                ...(responseHeaders ? { headers: responseHeaders } : {}),
                                 response: Object.assign(response, { html })
                             });
                         });
@@ -405,18 +441,30 @@ function getComponent(conf, repository) {
                         returnResult(cached);
                     }
                     else {
-                        (0, universalify_1.fromPromise)(repository.getCompiledView)(component.name, component.version, (_err, templateText) => {
+                        const loadTemplate = async () => {
+                            const templateText = await repository.getCompiledView(component.name, component.version);
                             const template = ocTemplate.getCompiledTemplate(templateText, key);
                             cache.set('file-contents', cacheKey, template);
-                            returnResult(template);
-                        });
+                            return template;
+                        };
+                        const templatePromise = conf.hotReloading
+                            ? loadTemplate()
+                            : singleFlight(cacheKey, loadTemplate);
+                        templatePromise.then(returnResult).catch((error) => callback({
+                            status: 500,
+                            response: {
+                                code: 'INTERNAL_SERVER_ERROR',
+                                error
+                            }
+                        }));
                     }
                 }
             };
             const staticPath = repository
                 .getStaticFilePath(component.name, component.version, '')
                 .replace(/^https:/, '');
-            if (!component.oc.files.dataProvider) {
+            const dataProviderDisabled = conf.dataProvider?.enabled === false;
+            if (dataProviderDisabled || !component.oc.files.dataProvider) {
                 const { __oc_Retry, ...props } = params;
                 props['_staticPath'] = staticPath;
                 props['_baseUrl'] = conf.baseUrl;
@@ -440,9 +488,13 @@ function getComponent(conf, repository) {
                     const cached = cache.get('file-contents', cacheKey);
                     const domain = node_domain_1.default.create();
                     const setEmptyResponse = oc_empty_response_handler_1.default.contextDecorator(returnComponent);
+                    let parsedAcceptLanguage;
                     const contextObj = {
                         action: options.action,
-                        acceptLanguage: accept_language_parser_1.default.parse(acceptLanguage),
+                        get acceptLanguage() {
+                            parsedAcceptLanguage ??= accept_language_parser_1.default.parse(getLanguage());
+                            return parsedAcceptLanguage;
+                        },
                         baseUrl: conf.baseUrl,
                         env: { ...conf.env, ...env },
                         params,
@@ -479,7 +531,7 @@ function getComponent(conf, repository) {
                     const setCallbackTimeout = () => {
                         const executionTimeout = conf.executionTimeout;
                         if (executionTimeout) {
-                            setTimeout(() => {
+                            callbackTimeout = setTimeout(() => {
                                 const message = `timeout (${executionTimeout * 1000}ms)`;
                                 returnComponent({ message }, undefined);
                                 domain.exit();
@@ -490,8 +542,8 @@ function getComponent(conf, repository) {
                         domain.on('error', returnComponent);
                         try {
                             domain.run(() => {
-                                cached(contextObj, returnComponent);
                                 setCallbackTimeout();
+                                cached(contextObj, returnComponent);
                             });
                         }
                         catch (e) {
@@ -499,17 +551,36 @@ function getComponent(conf, repository) {
                         }
                     }
                     else {
-                        (0, universalify_1.fromPromise)(repository.getDataProvider)(component.name, component.version, (err, dataProvider) => {
-                            if (err) {
+                        const handleError = (err) => {
+                            if (err.code === 'DATA_RESOLVING_ERROR') {
                                 componentCallbackDone = true;
                                 return callback({
                                     status: 502,
                                     response: {
-                                        code: 'DATA_RESOLVING_ERROR',
+                                        code: err.code,
                                         error: resources_1.default.errors.registry.RESOLVING_ERROR
                                     }
                                 });
                             }
+                            if (err.code === 'DEPENDENCY_MISSING_FROM_REGISTRY') {
+                                componentCallbackDone = true;
+                                return callback({
+                                    status: 501,
+                                    response: {
+                                        code: err.code,
+                                        error: resources_1.default.errors.registry.DEPENDENCY_NOT_FOUND(err.missing.join(', ')),
+                                        missingDependencies: err.missing
+                                    }
+                                });
+                            }
+                            returnComponent(err, undefined);
+                        };
+                        const loadDataProvider = async () => {
+                            const dataProvider = await repository
+                                .getDataProvider(component.name, component.version)
+                                .catch(() => {
+                                throw { code: 'DATA_RESOLVING_ERROR', missing: [] };
+                            });
                             const context = {
                                 require: (0, require_wrapper_1.default)(conf.dependencies),
                                 module: {
@@ -538,40 +609,29 @@ function getComponent(conf, repository) {
                                     }
                                 }
                             };
-                            const handleError = (err) => {
-                                if (err.code === 'DEPENDENCY_MISSING_FROM_REGISTRY') {
-                                    componentCallbackDone = true;
-                                    return callback({
-                                        status: 501,
-                                        response: {
-                                            code: err.code,
-                                            error: resources_1.default.errors.registry.DEPENDENCY_NOT_FOUND(err.missing.join(', ')),
-                                            missingDependencies: err.missing
-                                        }
-                                    });
-                                }
-                                returnComponent(err, undefined);
-                            };
-                            const options = conf.local
+                            const vmOptions = conf.local
                                 ? {
                                     displayErrors: true,
                                     filename: dataProvider.filePath
                                 }
                                 : {};
-                            try {
-                                node_vm_1.default.runInNewContext(dataProvider.content, context, options);
-                                const processData = context.module.exports['data'] || context.exports['data'];
-                                cache.set('file-contents', cacheKey, processData);
-                                domain.on('error', handleError);
-                                domain.run(() => {
-                                    processData(contextObj, returnComponent);
-                                    setCallbackTimeout();
-                                });
-                            }
-                            catch (err) {
-                                handleError(err);
-                            }
-                        });
+                            node_vm_1.default.runInNewContext(dataProvider.content, context, vmOptions);
+                            const processData = context.module.exports['data'] || context.exports['data'];
+                            cache.set('file-contents', cacheKey, processData);
+                            return processData;
+                        };
+                        const dataProviderPromise = conf.hotReloading
+                            ? loadDataProvider()
+                            : singleFlight(cacheKey, loadDataProvider);
+                        dataProviderPromise
+                            .then((processData) => {
+                            domain.on('error', handleError);
+                            domain.run(() => {
+                                setCallbackTimeout();
+                                processData(contextObj, returnComponent);
+                            });
+                        })
+                            .catch(handleError);
                     }
                 });
             }

package/dist/resources/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const safe_1 = require("colors/safe");
+const colors_1 = require("../utils/colors");
 // Kind of long multi-string messages and functions
 const validFunctionMock = `// simplified mock signature
 module.exports = (a, b) => a+b;`;
@@ -23,24 +23,24 @@ const mockPluginIsNotValid = `Looks like you are trying to register a dynamic mo
 The entry point should be a synchronous function or an object containing an asynchronous register() function and a synchronous execute() function.
 Example:
 
-${(0, safe_1.yellow)(validFunctionMock)}
+${(0, colors_1.yellow)(validFunctionMock)}
 
-${(0, safe_1.yellow)(validMockObject)}`;
+${(0, colors_1.yellow)(validMockObject)}`;
 const initSuccess = (componentName, componentPath) => {
     const success = `Success! Created ${componentName} at ${componentPath}`;
-    return `${(0, safe_1.green)(success)}
+    return `${(0, colors_1.green)(success)}
 
 From here you can run several commands
 
-${(0, safe_1.green)('oc --help')}
+${(0, colors_1.green)('oc --help')}
 To see a detailed list of all the commands available
 
 We suggest that you begin by typing:
 
-${(0, safe_1.green)('oc dev . 3030')}
+${(0, colors_1.green)('oc dev . 3030')}
 
 If you have questions, issues or feedback about OpenComponents, please, join us on Gitter:
-${(0, safe_1.green)('https://gitter.im/opentable/oc')}
+${(0, colors_1.green)('https://gitter.im/opentable/oc')}
 
 Happy coding
 
@@ -156,7 +156,7 @@ exports.default = {
             cleanSuccess: 'Folders removed',
             initSuccess,
             installCompiler: (compiler) => `Installing ${compiler} from npm...`,
-            installCompilerSuccess: (template, compiler, version) => `${(0, safe_1.green)('✔')} Installed ${compiler} [${template} v${version}]`,
+            installCompilerSuccess: (template, compiler, version) => `${(0, colors_1.green)('✔')} Installed ${compiler} [${template} v${version}]`,
             legacyTemplateDeprecationWarning: (legacyType, newType) => `Template-type "${legacyType}" has been deprecated and is now replaced by "${newType}"`,
             CHANGES_DETECTED: (file) => `Changes detected on file: ${file}`,
             CHECKING_DEPENDENCIES: 'Ensuring dependencies are loaded...',

package/dist/types.d.ts

@@ -239,6 +239,23 @@ export interface Config<T = any, TServerAdapter extends HttpServerAdapterFactory
      * @example ["lodash", "moment"]
      */
     dependencies: string[];
+    /**
+     * Configuration for the data provider step, i.e. the component's `server.js`
+     * that produces the model consumed by the view.
+     */
+    dataProvider: {
+        /**
+         * Executes the component's own data provider (`server.js`) when it has one.
+         *
+         * When `false` the registry never fetches nor runs a component's data
+         * provider, even if one exists in the storage: every component is served
+         * through the same path used by components that ship no `server.js`, i.e.
+         * the request parameters are passed straight through as the view model.
+         *
+         * @default true
+         */
+        enabled: boolean;
+    };
     /**
      * Configuration object to enable/disable the HTML discovery page and the API
      */

package/dist/utils/colors.d.ts

@@ -0,0 +1,14 @@
+declare const colors: {
+    black: import("picocolors/types").Formatter;
+    red: import("picocolors/types").Formatter;
+    green: import("picocolors/types").Formatter;
+    yellow: import("picocolors/types").Formatter;
+    blue: import("picocolors/types").Formatter;
+    magenta: import("picocolors/types").Formatter;
+    cyan: import("picocolors/types").Formatter;
+    white: import("picocolors/types").Formatter;
+    gray: import("picocolors/types").Formatter;
+    grey: import("picocolors/types").Formatter;
+};
+export declare const black: import("picocolors/types").Formatter, red: import("picocolors/types").Formatter, green: import("picocolors/types").Formatter, yellow: import("picocolors/types").Formatter, blue: import("picocolors/types").Formatter, magenta: import("picocolors/types").Formatter, cyan: import("picocolors/types").Formatter, white: import("picocolors/types").Formatter, gray: import("picocolors/types").Formatter, grey: import("picocolors/types").Formatter;
+export default colors;

package/dist/utils/colors.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grey = exports.gray = exports.white = exports.cyan = exports.magenta = exports.blue = exports.yellow = exports.green = exports.red = exports.black = void 0;
+const picocolors_1 = __importDefault(require("picocolors"));
+const colors = {
+    black: picocolors_1.default.black,
+    red: picocolors_1.default.red,
+    green: picocolors_1.default.green,
+    yellow: picocolors_1.default.yellow,
+    blue: picocolors_1.default.blue,
+    magenta: picocolors_1.default.magenta,
+    cyan: picocolors_1.default.cyan,
+    white: picocolors_1.default.white,
+    gray: picocolors_1.default.gray,
+    grey: picocolors_1.default.gray
+};
+exports.black = colors.black, exports.red = colors.red, exports.green = colors.green, exports.yellow = colors.yellow, exports.blue = colors.blue, exports.magenta = colors.magenta, exports.cyan = colors.cyan, exports.white = colors.white, exports.gray = colors.gray, exports.grey = colors.grey;
+exports.default = colors;

package/dist/utils/deprecate.d.ts

@@ -0,0 +1,20 @@
+interface DeprecationNotice {
+    /** Stable identifier used to only warn once per process for this deprecation. */
+    id: string;
+    /** The option/API being removed. */
+    subject: string;
+    /** What to use instead. */
+    replacement: string;
+}
+/**
+ * Emits a single, consistent deprecation notice (once per process, per `id`)
+ * for a config option or API that will be removed in OpenComponents v1.
+ *
+ * Routes through `process.emitWarning` with type `DeprecationWarning`, so it
+ * honors the standard Node.js opt-out mechanisms (`--no-deprecation`, etc.)
+ * without needing a bespoke env var.
+ *
+ * This never changes runtime behavior - it is purely informational.
+ */
+export default function deprecate({ id, subject, replacement }: DeprecationNotice): void;
+export {};

package/dist/utils/deprecate.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = deprecate;
+const warned = new Set();
+/**
+ * Emits a single, consistent deprecation notice (once per process, per `id`)
+ * for a config option or API that will be removed in OpenComponents v1.
+ *
+ * Routes through `process.emitWarning` with type `DeprecationWarning`, so it
+ * honors the standard Node.js opt-out mechanisms (`--no-deprecation`, etc.)
+ * without needing a bespoke env var.
+ *
+ * This never changes runtime behavior - it is purely informational.
+ */
+function deprecate({ id, subject, replacement }) {
+    if (warned.has(id)) {
+        return;
+    }
+    warned.add(id);
+    process.emitWarning(`${subject} is deprecated and will be removed in OpenComponents v1 - use ${replacement} instead.`, 'DeprecationWarning');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "oc",
-	"version": "0.50.58",
+	"version": "0.50.60",
 	"description": "A framework for developing and distributing html components",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -39,7 +39,6 @@
 	"devDependencies": {
 		"@biomejs/biome": "^2.5.0",
 		"@types/accept-language-parser": "^1.5.8",
-		"@types/async": "^3.2.25",
 		"@types/bun": "^1.3.14",
 		"@types/cookie-parser": "^1.4.10",
 		"@types/cross-spawn": "^6.0.6",
@@ -74,11 +73,9 @@
 		"@rdevis/turbo-stream": "^2.4.1",
 		"@types/lodash.isequal": "^4.5.8",
 		"accept-language-parser": "^1.5.0",
-		"async": "^3.2.6",
 		"basic-auth-connect": "^1.1.0",
 		"builtin-modules": "^3.3.0",
 		"chokidar": "^4.0.3",
-		"colors": "^1.4.0",
 		"cookie-parser": "^1.4.7",
 		"cross-spawn": "^7.0.6",
 		"dependency-graph": "^1.0.0",
@@ -92,14 +89,14 @@
 		"livereload": "^0.10.3",
 		"lodash.isequal": "^4.5.0",
 		"morgan": "^1.11.0",
-		"multer": "^2.0.2",
+		"multer": "^2.2.0",
 		"nice-cache": "^0.0.5",
 		"oc-client": "^4.0.3",
-		"oc-client-browser": "^2.1.11",
+		"oc-client-browser": "^2.1.12",
 		"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.3",
+		"oc-s3-storage-adapter": "^2.2.4",
 		"oc-storage-adapters-utils": "^2.1.2",
 		"oc-template-es6": "^2.0.0",
 		"oc-template-es6-compiler": "^7.1.4",
@@ -109,6 +106,7 @@
 		"oc-template-jade-compiler": "^7.5.0",
 		"open": "^10.2.0",
 		"parse-author": "^2.0.0",
+		"picocolors": "^1.1.1",
 		"read": "^1.0.7",
 		"require-package-name": "^2.0.1",
 		"response-time": "^2.3.4",