Skip to content

Add router-returning function to express-wrapper #79

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
merged 1 commit into from
May 16, 2022
Merged

Add router-returning function to express-wrapper #79

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
89 changes: 51 additions & 38 deletions packages/express-wrapper/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,46 +21,59 @@ export type { ResponseEncoder } from './response';
const isHttpVerb = (verb: string): verb is 'get' | 'put' | 'post' | 'delete' =>
verb === 'get' || verb === 'put' || verb === 'post' || verb === 'delete';

export const createServerWithResponseEncoder =
(encoder: ResponseEncoder) =>
<Spec extends ApiSpec>(
spec: ApiSpec,
configureExpressApplication: (app: express.Application) => {
[ApiName in keyof Spec]: {
[Method in keyof Spec[ApiName]]: RouteHandler<Spec[ApiName][Method]>;
};
},
) => {
const app: express.Application = express();
const routes = configureExpressApplication(app);

const router = express.Router();
for (const apiName of Object.keys(spec)) {
const resource = spec[apiName] as Spec[string];
for (const method of Object.keys(resource)) {
if (!isHttpVerb(method)) {
continue;
}
const httpRoute: HttpRoute = resource[method]!;
const routeHandler = routes[apiName]![method]!;
const expressRouteHandler = decodeRequestAndEncodeResponse(
apiName,
httpRoute,
// FIXME: TS is complaining that `routeHandler` is not necessarily guaranteed to be a
// `ServiceFunction`, because subtypes of Spec[string][string] can have arbitrary extra keys.
getServiceFunction(routeHandler as any),
encoder,
);
const handlers = [...getMiddleware(routeHandler), expressRouteHandler];
type CreateRouterProps<Spec extends ApiSpec> = {
spec: Spec;
routeHandlers: {
[ApiName in keyof Spec]: {
[Method in keyof Spec[ApiName]]: RouteHandler<Spec[ApiName][Method]>;
};
};
encoder?: ResponseEncoder;
};

const expressPath = apiTsPathToExpress(httpRoute.path);
router[method](expressPath, handlers);
export function routerForApiSpec<Spec extends ApiSpec>({
spec,
routeHandlers,
encoder = defaultResponseEncoder,
}: CreateRouterProps<Spec>) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting choice of parameter type! (an object)

const router = express.Router();
for (const apiName of Object.keys(spec)) {
const resource = spec[apiName] as Spec[string];
for (const method of Object.keys(resource)) {
if (!isHttpVerb(method)) {
continue;
}
}
const httpRoute: HttpRoute = resource[method]!;
const routeHandler = routeHandlers[apiName]![method]!;
const expressRouteHandler = decodeRequestAndEncodeResponse(
apiName,
httpRoute,
// FIXME: TS is complaining that `routeHandler` is not necessarily guaranteed to be a
// `ServiceFunction`, because subtypes of Spec[string][string] can have arbitrary extra keys.
getServiceFunction(routeHandler as any),
encoder,
);
const handlers = [...getMiddleware(routeHandler), expressRouteHandler];

app.use(router);
const expressPath = apiTsPathToExpress(httpRoute.path);
router[method](expressPath, handlers);
}
}

return app;
};
return router;
}

export const createServer = createServerWithResponseEncoder(defaultResponseEncoder);
export const createServer = <Spec extends ApiSpec>(
spec: Spec,
configureExpressApplication: (app: express.Application) => {
[ApiName in keyof Spec]: {
[Method in keyof Spec[ApiName]]: RouteHandler<Spec[ApiName][Method]>;
};
},
) => {
const app = express();
const routeHandlers = configureExpressApplication(app);
const router = routerForApiSpec({ spec, routeHandlers });
app.use(router);
return app;
};