Skip to content

feat: more extension controller decorators #2272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Salazareo merged 1 commit into from
Jan 13, 2026
Merged

feat: more extension controller decorators #2272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion extensions/api.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare global {
string: T,
) => T extends keyof ServiceNameMap ? ServiceNameMap[T] : unknown;
};
actor: Actor;
actor?: Actor;
rawBody: Buffer;
/** @deprecated use actor instead */
user: IUser;
Expand Down
33 changes: 30 additions & 3 deletions extensions/extensionController/src/ExtensionController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ import type {
export const Controller = (
prefix: string,
adminUsernames?: string[],
allowedAppIds?: string[],
): ClassDecorator => {
return (target: Function) => {
target.prototype.__controllerPrefix = prefix;
target.prototype.__allowedAppIds = allowedAppIds;
target.prototype.__adminUsernames = adminUsernames
? [...adminUsernames, 'admin', 'system']
: undefined;
Expand All @@ -31,14 +33,16 @@ interface RouteMeta {
options?: EndpointOptions | undefined;
handler: RequestHandler;
adminUsernames?: string[];
allowedAppIds?: string[];
}

const createMethodDecorator = (method: HttpMethod) => {
return <This>(
path: string,
options?: EndpointOptions,
routeOptions?: EndpointOptions & { allowedAppIds?: string[] },
adminUsernames?: string[],
) => {
const { allowedAppIds, ...options } = routeOptions ?? {};
return <
P extends Record<string, string | undefined> = Record<
string,
Expand Down Expand Up @@ -67,6 +71,7 @@ const createMethodDecorator = (method: HttpMethod) => {
adminUsernames: adminUsernames
? [...adminUsernames, 'admin', 'system']
: undefined,
allowedAppIds,
handler: target,
});
});
Expand Down Expand Up @@ -97,6 +102,9 @@ export class ExtensionController {
const adminsForController = Object.getPrototypeOf(this).__adminUsernames as
| string[]
| undefined;
const allowedAppIdsForController = Object.getPrototypeOf(this).__allowedAppIds as
| string[]
| undefined;
const routes: RouteMeta[] = Object.getPrototypeOf(this).__routes || [];
for ( const route of routes ) {
const fullPath = `${prefix}/${route.path}`.replace(/\/+/g, '/');
Expand All @@ -107,6 +115,14 @@ export class ExtensionController {
: adminsForController
? adminsForController
: undefined;
const allowedAppIds = route.allowedAppIds
? allowedAppIdsForController
? allowedAppIdsForController.concat(route.allowedAppIds)
: route.allowedAppIds
: allowedAppIdsForController
? allowedAppIdsForController
: undefined;

if ( ! extension[route.method] ) {
throw new Error(`Unsupported HTTP method: ${route.method}`);
} else {
Expand All @@ -117,12 +133,23 @@ export class ExtensionController {
route.options || {},
async (req, res, next) => {
try {
if ( adminsForRoute || allowedAppIds ) {
if ( ! req.actor ) {
throw new HttpError(StatusCodes.UNAUTHORIZED, 'Unauthenticated');
}
}
if ( adminsForRoute ) {
if ( ! adminsForRoute.includes(req.actor.type.user.username) ) {
throw new HttpError(StatusCodes.UNAUTHORIZED,
if ( ! adminsForRoute.includes(req.actor!.type.user.username) ) {
throw new HttpError(StatusCodes.FORBIDDEN,
'Only admins may request this resource.');
}
}
if ( allowedAppIds ) {
if ( ( req.actor!.type?.app?.uid && !allowedAppIds.includes(req.actor!.type.app.uid) ) ) {
throw new HttpError(StatusCodes.FORBIDDEN,
'This app may not request this resource.');
}
}
await route.handler.bind(this)(req, res, next);
} catch ( error ) {
if ( error instanceof HttpError ) {
Expand Down
Loading