Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/component-request-hook.md
Original file line number Diff line number Diff line change
@@ -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 }`.
3 changes: 3 additions & 0 deletions packages/oc/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ export type {
UploadedFile
} from './registry/domain/http-server/types';
export type {
ComponentRequestContext,
ComponentRequestHook,
ComponentRequestRejection,
CorsConfig,
CorsOptions,
Plugin,
Expand Down
13 changes: 12 additions & 1 deletion packages/oc/src/registry/domain/repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export default function repository(conf: Config) {
const componentInfoLoads = new Map<string, ComponentInfoLoad>();
const localVersions = new Map<string, string>();
const localVersionLoads = new Map<string, Promise<string[]>>();
const componentSourceVersions = new WeakMap<Component, readonly string[]>();
let exportLegacyFilesLoop: NodeJS.Timeout | undefined;
let closed = false;

Expand Down Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 };
}
24 changes: 19 additions & 5 deletions packages/oc/src/registry/domain/version-handler.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
import semver from 'semver';

const latestVersions = new WeakMap<readonly string[], string | undefined>();

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)) {
Expand Down
87 changes: 85 additions & 2 deletions packages/oc/src/registry/routes/helpers/get-component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ import strings from '../../../resources';
import settings from '../../../resources/settings';
import type {
Component,
ComponentRequestRejection,
Config,
OcParameter,
PluginContext,
Plugins
} 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';
Expand Down Expand Up @@ -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 = () => {};
Expand Down Expand Up @@ -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<typeof hook>;
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
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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,
Expand Down
5 changes: 5 additions & 0 deletions packages/oc/src/resources/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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}`,
Expand Down
48 changes: 48 additions & 0 deletions packages/oc/src/types.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -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<Component>;
headers: IncomingHttpHeaders;
parameters: Record<string, string>;
/** 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<ComponentRequestRejection | undefined>;

export interface ParsedComponent extends Omit<Component, 'author'> {
author: Author;
}
Expand Down Expand Up @@ -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.
*/
Expand Down
76 changes: 76 additions & 0 deletions packages/oc/test/acceptance/registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) => {
Expand Down
Loading
Loading