diff --git a/.changeset/component-request-hook.md b/.changeset/component-request-hook.md new file mode 100644 index 000000000..10dc97736 --- /dev/null +++ b/.changeset/component-request-hook.md @@ -0,0 +1,5 @@ +--- +"oc": minor +--- + +Add an `onComponentRequest` registry option. It runs for every component request once the version has been resolved, receives the request context and the component's package.json (including `allVersions` and `latestVersion`), and can reject the request by returning `{ status, code, error }`. diff --git a/packages/oc/src/index.ts b/packages/oc/src/index.ts index 6caa62e8e..4aec083ad 100644 --- a/packages/oc/src/index.ts +++ b/packages/oc/src/index.ts @@ -18,6 +18,9 @@ export type { UploadedFile } from './registry/domain/http-server/types'; export type { + ComponentRequestContext, + ComponentRequestHook, + ComponentRequestRejection, CorsConfig, CorsOptions, Plugin, diff --git a/packages/oc/src/registry/domain/repository.ts b/packages/oc/src/registry/domain/repository.ts index b4cf4b649..feb229695 100644 --- a/packages/oc/src/registry/domain/repository.ts +++ b/packages/oc/src/registry/domain/repository.ts @@ -74,6 +74,7 @@ export default function repository(conf: Config) { const componentInfoLoads = new Map(); const localVersions = new Map(); const localVersionLoads = new Map>(); + const componentSourceVersions = new WeakMap(); let exportLegacyFilesLoop: NodeJS.Timeout | undefined; let closed = false; @@ -359,7 +360,17 @@ export default function repository(conf: Config) { } } - return { ...component, allVersions: [...allVersions] }; + const result = { ...component, allVersions: [...allVersions] }; + componentSourceVersions.set(result, allVersions); + + return result; + }, + getLatestVersion(component: Component): string { + return ( + versionHandler.getLatestVersion( + componentSourceVersions.get(component) ?? component.allVersions + ) ?? component.version + ); }, getComponentInfo( componentName: string, diff --git a/packages/oc/src/registry/domain/validators/registry-configuration.ts b/packages/oc/src/registry/domain/validators/registry-configuration.ts index 0e185e8c7..58c7c7915 100644 --- a/packages/oc/src/registry/domain/validators/registry-configuration.ts +++ b/packages/oc/src/registry/domain/validators/registry-configuration.ts @@ -189,5 +189,15 @@ export default function registryConfiguration( } } + if ( + conf.onComponentRequest !== undefined && + typeof conf.onComponentRequest !== 'function' + ) { + return returnError( + strings.errors.registry + .CONFIGURATION_ON_COMPONENT_REQUEST_MUST_BE_FUNCTION + ); + } + return { isValid: true }; } diff --git a/packages/oc/src/registry/domain/version-handler.ts b/packages/oc/src/registry/domain/version-handler.ts index dfd466f9f..a0b3679c4 100644 --- a/packages/oc/src/registry/domain/version-handler.ts +++ b/packages/oc/src/registry/domain/version-handler.ts @@ -1,15 +1,29 @@ import semver from 'semver'; +const latestVersions = new WeakMap(); + +export function getLatestVersion( + availableVersions: readonly string[] +): string | undefined { + if (latestVersions.has(availableVersions)) { + return latestVersions.get(availableVersions); + } + + const latest = + semver.maxSatisfying(availableVersions, '') || + [...availableVersions].sort(semver.rcompare)[0] || + undefined; + latestVersions.set(availableVersions, latest); + + return latest; +} + export function getAvailableVersion( requestedVersion: string | undefined, availableVersions: string[] ): string | undefined { if (!requestedVersion) { - return ( - semver.maxSatisfying(availableVersions, '') || - [...availableVersions].sort(semver.rcompare)[0] || - undefined - ); + return getLatestVersion(availableVersions); } if (availableVersions.includes(requestedVersion)) { diff --git a/packages/oc/src/registry/routes/helpers/get-component.ts b/packages/oc/src/registry/routes/helpers/get-component.ts index 87d7a011a..6546f8374 100644 --- a/packages/oc/src/registry/routes/helpers/get-component.ts +++ b/packages/oc/src/registry/routes/helpers/get-component.ts @@ -8,6 +8,7 @@ import strings from '../../../resources'; import settings from '../../../resources/settings'; import type { Component, + ComponentRequestRejection, Config, OcParameter, PluginContext, @@ -15,6 +16,7 @@ import type { } from '../../../types'; import { parseAcceptLanguage } from '../../../utils/accept-language'; import BoundedCache from '../../../utils/bounded-cache'; +import errorToString from '../../../utils/error-to-string'; import isTemplateLegacy from '../../../utils/is-template-legacy'; import { fromPromise } from '../../../utils/universalify'; import eventsHandler from '../../domain/events-handler'; @@ -77,6 +79,10 @@ export type RenderComponent = ( cb: (result: GetComponentResult) => void ) => void; +class ComponentRequestRejected { + constructor(readonly result: GetComponentResult) {} +} + export const stream = Symbol('stream'); const MAX_ARTIFACT_CACHE_ENTRIES = 1000; const noop = () => {}; @@ -271,6 +277,78 @@ export default function getComponent( } }; + const resolveComponent = ( + name: string, + version: string, + options: RendererOptions, + cb: (err: unknown, component: Component) => void + ): void => { + getComponentCb(name, version, (err, component) => { + const hook = options.conf.onComponentRequest; + if (err || !hook) { + return cb(err, component); + } + + const decide = (rejection: ComponentRequestRejection | undefined) => + rejection + ? cb( + new ComponentRequestRejected({ + status: rejection.status ?? 403, + response: { + code: rejection.code ?? 'COMPONENT_REQUEST_REJECTED', + error: + rejection.error ?? + strings.errors.registry.COMPONENT_REQUEST_REJECTED + } + }), + component + ) + : cb(null, component); + const fail = (hookErr: unknown) => { + const message = errorToString(hookErr); + eventsHandler.fire('error', { + code: 'COMPONENT_REQUEST_HOOK_FAILED', + message + }); + cb( + new ComponentRequestRejected({ + status: 500, + response: { + code: 'COMPONENT_REQUEST_HOOK_FAILED', + error: + strings.errors.registry.COMPONENT_REQUEST_HOOK_FAILED(message) + } + }), + component + ); + }; + + let decision: ReturnType; + try { + decision = hook({ + name, + requestedVersion: version, + version: component.version, + get latestVersion() { + return repository.getLatestVersion(component); + }, + component, + headers: options.headers, + parameters: options.parameters, + action: options.action + }); + } catch (hookErr) { + return fail(hookErr); + } + + if (decision instanceof Promise) { + decision.then(decide, fail); + } else { + decide(decision); + } + }); + }; + const renderer = ( options: RendererOptions, cb: (result: GetComponentResult) => void @@ -344,10 +422,15 @@ export default function getComponent( parameters: options.parameters }; - getComponentCb( + resolveComponent( requestedComponent.name, requestedComponent.version, + options, (err, component) => { + if (err instanceof ComponentRequestRejected) { + return callback(err.result); + } + // check route exist for component and version if (err) { if (conf.fallbackRegistryUrl) { @@ -557,7 +640,7 @@ export default function getComponent( response: { code: 'GENERIC_ERROR', error: strings.errors.registry.COMPONENT_EXECUTION_ERROR( - err.message || '' + err.message || (typeof err === 'string' ? err : '') ), details: { message: err.message, diff --git a/packages/oc/src/resources/index.ts b/packages/oc/src/resources/index.ts index dd97a1272..9db566076 100644 --- a/packages/oc/src/resources/index.ts +++ b/packages/oc/src/resources/index.ts @@ -100,6 +100,9 @@ export default { 'context.setHeader parameters must be strings', COMPONENT_SET_COOKIE_PARAMETERS_NOT_VALID: 'context.setCookie parameters are not valid', + COMPONENT_REQUEST_HOOK_FAILED: (message: string): string => + `onComponentRequest hook failed: ${message}`, + COMPONENT_REQUEST_REJECTED: 'Component request rejected by the registry', CONFIGURATION_DEPENDENCIES_MUST_BE_ARRAY: 'Registry configuration is not valid: dependencies must be an array', CONFIGURATION_CORS_MUST_BE_OBJECT: @@ -145,6 +148,8 @@ export default { `Registry configuration is not valid: ${storage} configuration is not valid`, CONFIGURATION_HEADERS_TO_SKIP_MUST_BE_STRING_ARRAY: 'Registry configuration is not valid: customHeadersToSkipOnWeakVersion must be an array of strings', + CONFIGURATION_ON_COMPONENT_REQUEST_MUST_BE_FUNCTION: + 'Registry configuration is not valid: onComponentRequest must be a function', DATA_OBJECT_IS_UNDEFINED: 'data object is undefined', DEPENDENCY_NOT_FOUND: (dependencies: string): string => `Component is trying to use unavailable dependencies: ${dependencies}`, diff --git a/packages/oc/src/types.ts b/packages/oc/src/types.ts index 06fe141f7..a550ecefa 100644 --- a/packages/oc/src/types.ts +++ b/packages/oc/src/types.ts @@ -1,3 +1,4 @@ +import type { IncomingHttpHeaders } from 'node:http'; import type { NextFunction, Request, Response } from 'express'; import type { MetadataStore as MetadataStoreType } from 'oc-metadata-adapters-utils'; import type { StorageAdapter } from 'oc-storage-adapters-utils'; @@ -173,6 +174,38 @@ export interface Component extends PackageJson { version: string; } +export interface ComponentRequestContext { + /** Name of the requested component. */ + name: string; + /** Version requested by the consumer (exact, semver range or empty for latest). */ + requestedVersion: string; + /** Version the registry resolved the request to and is about to serve. */ + version: string; + /** Latest published version of the component, as resolved for an unversioned request. */ + latestVersion: string; + /** package.json of the resolved component, including `allVersions`. */ + component: Readonly; + headers: IncomingHttpHeaders; + parameters: Record; + /** Name of the action being invoked, if any. */ + action?: string; +} + +export interface ComponentRequestRejection { + /** @default 403 */ + status?: number; + /** @default "COMPONENT_REQUEST_REJECTED" */ + code?: string; + error?: string; +} + +export type ComponentRequestHook = ( + context: ComponentRequestContext +) => + | ComponentRequestRejection + | undefined + | Promise; + export interface ParsedComponent extends Omit { author: Author; } @@ -451,6 +484,21 @@ export interface Config< error?: string; } | boolean; + /** + * Hook executed for every component request once the requested version has + * been resolved, before the component is rendered or its info returned. + * Return (or resolve to) a {@link ComponentRequestRejection} to reject the + * request, or nothing to let it through. Throwing or rejecting responds with + * a 500 error. + * + * @example + * onComponentRequest: ({ version, latestVersion }) => { + * if (semver.major(version) < semver.major(latestVersion)) { + * return { status: 410, code: 'VERSION_TOO_OLD', error: `Use ${latestVersion}` }; + * } + * } + */ + onComponentRequest?: ComponentRequestHook; /** * Seconds between each refresh of the internal component list cache. */ diff --git a/packages/oc/test/acceptance/registry.js b/packages/oc/test/acceptance/registry.js index b127228e4..2020c8cd8 100644 --- a/packages/oc/test/acceptance/registry.js +++ b/packages/oc/test/acceptance/registry.js @@ -153,6 +153,82 @@ describe('registry', () => { }); }); + describe('with an onComponentRequest hook rejecting some components', () => { + const requestedNames = []; + const rejectComponents = ({ name }) => { + requestedNames.push(name); + return ['hello-world', 'no-containers'].includes(name) + ? { status: 410, code: 'VERSION_TOO_OLD', error: 'Upgrade' } + : undefined; + }; + + before((done) => { + registry.close(() => { + initializeRegistry( + { + ...getDefaultTestConfiguration(), + onComponentRequest: rejectComponents + }, + done + ); + }); + }); + + after((done) => { + registry.close(() => { + initializeRegistry(getDefaultTestConfiguration(), done); + }); + }); + + describe('GET /hello-world', () => { + before((done) => { + next(request('http://localhost:3030/hello-world'), done); + }); + + it('should respond with the rejection', () => { + expect(status).to.equal(410); + expect(result.code).to.equal('VERSION_TOO_OLD'); + expect(result.error).to.equal('Upgrade'); + }); + }); + + describe('POST / with an allowed and a rejected component', () => { + before((done) => { + next( + request('http://localhost:3030', { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + components: [ + { name: 'hello-world' }, + { name: 'hello-world-custom-headers' } + ] + }) + }), + done + ); + }); + + it('should reject only the matching component', () => { + expect(result[0].status).to.equal(410); + expect(result[0].response.code).to.equal('VERSION_TOO_OLD'); + expect(result[1].status).to.equal(200); + }); + }); + + describe('GET /container-with-nested', () => { + before((done) => { + next(request('http://localhost:3030/container-with-nested'), done); + }); + + it('should apply the hook to nested components', () => { + expect(requestedNames).to.include('no-containers'); + expect(status).to.equal(500); + expect(result.error).to.equal('Component execution error: Upgrade'); + }); + }); + }); + describe('GET /hello-world-custom-cookies', () => { describe('with the default configuration and strong version 1.0.0', () => { before((done) => { diff --git a/packages/oc/test/unit/registry-domain-repository-component-info-cache.js b/packages/oc/test/unit/registry-domain-repository-component-info-cache.js index 38e53b204..e0db54d15 100644 --- a/packages/oc/test/unit/registry-domain-repository-component-info-cache.js +++ b/packages/oc/test/unit/registry-domain-repository-component-info-cache.js @@ -222,6 +222,20 @@ describe('registry : domain : repository : component info cache', () => { expect(storage.getJson.calledOnce).to.be.true; }); + it('resolves the latest version from the cached version list, not the per-request copy', async () => { + const versions = { 'hello-world': ['1.0.0', '2.0.0', '3.0.0-beta.1'] }; + const { repository } = createRepository({ versions }); + + const component = await repository.getComponent('hello-world', '1.0.0'); + component.allVersions.push('9.0.0'); + + expect(repository.getLatestVersion(component)).to.equal('2.0.0'); + + versions['hello-world'] = ['1.0.0', '2.0.0', '2.1.0']; + const refreshed = await repository.getComponent('hello-world', '1.0.0'); + expect(repository.getLatestVersion(refreshed)).to.equal('2.1.0'); + }); + it('bounds component info at 1000 entries and evicts the true LRU key', async () => { const versions = {}; for (let index = 0; index <= 1000; index++) { diff --git a/packages/oc/test/unit/registry-domain-validator.js b/packages/oc/test/unit/registry-domain-validator.js index 2cd50fdae..3801b3f46 100644 --- a/packages/oc/test/unit/registry-domain-validator.js +++ b/packages/oc/test/unit/registry-domain-validator.js @@ -598,6 +598,31 @@ describe('registry : domain : validator', () => { }); }); + describe('onComponentRequest', () => { + it('should not be valid when it is not a function', () => { + const result = validate({ + onComponentRequest: 'nope', + publishAuth: false, + s3: baseS3Conf + }); + + expect(result.isValid).to.be.false; + expect(result.message).to.equal( + 'Registry configuration is not valid: onComponentRequest must be a function' + ); + }); + + it('should be valid when it is a function', () => { + expect( + validate({ + onComponentRequest: () => undefined, + publishAuth: false, + s3: baseS3Conf + }).isValid + ).to.be.true; + }); + }); + describe('customHeadersToSkipOnWeakVersion', () => { describe('when customHeadersToSkipOnWeakVersion is not an array', () => { const conf = { diff --git a/packages/oc/test/unit/registry-domain-version-handler.js b/packages/oc/test/unit/registry-domain-version-handler.js index af05e0c97..abb8b3b4e 100644 --- a/packages/oc/test/unit/registry-domain-version-handler.js +++ b/packages/oc/test/unit/registry-domain-version-handler.js @@ -114,6 +114,33 @@ describe('registry : domain : version-handler', () => { }); }); + describe('when getting the latest version', () => { + it('should ignore pre-releases when a release is available', () => { + expect( + versionHandler.getLatestVersion(['1.0.0', '2.0.0', '3.0.0-beta.1']) + ).to.equal('2.0.0'); + }); + + it('should fall back to the highest pre-release', () => { + expect( + versionHandler.getLatestVersion(['1.0.0-beta.1', '1.0.0-beta.2']) + ).to.equal('1.0.0-beta.2'); + }); + + it('should return the same result for repeated calls on the same list', () => { + const versions = ['1.0.0', '1.1.0']; + expect(versionHandler.getLatestVersion(versions)).to.equal('1.1.0'); + expect(versionHandler.getLatestVersion(versions)).to.equal('1.1.0'); + expect(versionHandler.getLatestVersion(['1.0.0', '1.2.0'])).to.equal( + '1.2.0' + ); + }); + + it('should return undefined when there are no versions', () => { + expect(versionHandler.getLatestVersion([])).to.be.undefined; + }); + }); + describe('when publishing component', () => { const existingVersions = ['1.0.0', '1.0.1', '1.0.3', '1.1.0', '2.0.0']; const validate = (a, b) => versionHandler.validateNewVersion(a, b); diff --git a/packages/oc/test/unit/registry-routes-component.js b/packages/oc/test/unit/registry-routes-component.js index ab5f3df75..f6b09152a 100644 --- a/packages/oc/test/unit/registry-routes-component.js +++ b/packages/oc/test/unit/registry-routes-component.js @@ -5,6 +5,9 @@ describe('registry : routes : component', () => { const ComponentRoute = require('../../dist/registry/routes/component').default; const mockedComponents = require('../fixtures/mocked-components'); + const { + getLatestVersion + } = require('../../dist/registry/domain/version-handler'); let mockedRepository; let resJsonStub; let resSetStub; @@ -24,6 +27,9 @@ describe('registry : routes : component', () => { mockedRepository = { getCompiledView: sinon.stub().resolves(params.view), getComponent: sinon.stub().resolves(params.package), + getLatestVersion: sinon + .stub() + .callsFake((component) => getLatestVersion(component.allVersions)), getDataProvider: sinon .stub() .resolves({ content: params.data, filePath: '/path/to/server.js' }), @@ -836,4 +842,122 @@ describe('registry : routes : component', () => { expect(resJsonStub.args[0][0].html).to.be.undefined; }); }); + + describe('when the registry has an onComponentRequest hook', () => { + const simple = mockedComponents['simple-component']; + const requestComponent = (onComponentRequest, componentVersion) => + new Promise((resolve) => { + initialise({ + ...simple, + package: { + ...simple.package, + allVersions: ['1.0.0', '2.0.0', '2.1.0', '3.0.0-beta.1'] + } + }); + componentRoute = ComponentRoute({}, mockedRepository); + componentRoute( + { + headers: { 'user-agent': 'test' }, + params: { componentName: 'simple-component', componentVersion }, + query: { hello: 'world' } + }, + { + conf: { baseUrl: 'http://component.com/', onComponentRequest }, + status: (code) => ({ json: (json) => resolve({ code, json }) }), + set: sinon.stub() + } + ); + }); + + it('should pass the resolved request context to the hook', async () => { + const hook = sinon.stub().returns(undefined); + await requestComponent(hook, '1.X.X'); + + const ctx = hook.args[0][0]; + expect(ctx.name).to.equal('simple-component'); + expect(ctx.requestedVersion).to.equal('1.X.X'); + expect(ctx.version).to.equal('1.0.0'); + expect(ctx.latestVersion).to.equal('2.1.0'); + expect(ctx.component.oc.files.template.type).to.equal('jade'); + expect(ctx.headers['user-agent']).to.equal('test'); + expect(ctx.parameters).to.eql({ hello: 'world' }); + }); + + it('should render the component when the hook returns nothing', async () => { + const response = await requestComponent(() => undefined, '1.0.0'); + + expect(response.code).to.equal(200); + expect(response.json.html).to.contain('hello'); + }); + + it('should respond with the rejection returned by the hook without rendering', async () => { + const response = await requestComponent( + ({ version, latestVersion }) => + version !== latestVersion + ? { status: 410, code: 'VERSION_TOO_OLD', error: 'Upgrade' } + : undefined, + '1.0.0' + ); + + expect(response.code).to.equal(410); + expect(response.json.code).to.equal('VERSION_TOO_OLD'); + expect(response.json.error).to.equal('Upgrade'); + expect(response.json.name).to.equal('simple-component'); + expect(response.json.requestVersion).to.equal('1.0.0'); + expect(mockedRepository.getCompiledView.called).to.be.false; + }); + + it('should apply default rejection values for an async hook', async () => { + const response = await requestComponent(async () => ({}), '1.0.0'); + + expect(response.code).to.equal(403); + expect(response.json.code).to.equal('COMPONENT_REQUEST_REJECTED'); + expect(response.json.error).to.equal( + 'Component request rejected by the registry' + ); + }); + + it('should respond with 500 when the hook throws', async () => { + const response = await requestComponent(() => { + throw new Error('boom'); + }, '1.0.0'); + + expect(response.code).to.equal(500); + expect(response.json.code).to.equal('COMPONENT_REQUEST_HOOK_FAILED'); + expect(response.json.error).to.equal( + 'onComponentRequest hook failed: Error: boom' + ); + }); + + it('should respond with 500 when the async hook rejects', async () => { + const response = await requestComponent( + () => Promise.reject(new Error('async boom')), + '1.0.0' + ); + + expect(response.code).to.equal(500); + expect(response.json.code).to.equal('COMPONENT_REQUEST_HOOK_FAILED'); + }); + + it('should apply the hook to component info requests', async () => { + initialise(simple); + const response = await new Promise((resolve) => { + ComponentRoute({}, mockedRepository)( + { + headers: { accept: 'application/vnd.oc.info+json' }, + params: { componentName: 'simple-component' } + }, + { + conf: { + baseUrl: 'http://component.com/', + onComponentRequest: () => ({ status: 410 }) + }, + status: (code) => ({ json: (json) => resolve({ code, json }) }) + } + ); + }); + + expect(response.code).to.equal(410); + }); + }); });