fix: Expose the API Gateway Static Hosting pattern worker for reuse

src/patterns/apigateway-static-hosting/handler/index.ts

@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import SE from '@codegenie/serverless-express';
-import { InlineHost } from './hosts/inline';
-import { S3Host } from './hosts/s3';
-import { Configuration } from './types/configuration';
+import { InlineHost } from '../worker/hosts/inline';
+import { S3Host } from '../worker/hosts/s3';
+import { Configuration } from '../worker/types/configuration';
 
 /**
  * Lambda entry point

src/patterns/apigateway-static-hosting/index.ts

@@ -31,7 +31,7 @@ import { BucketDeployment, Source } from 'aws-cdk-lib/aws-s3-deployment';
 import { Construct } from 'constructs';
 import { SecureFunction } from '../../constructs/secure-function';
 import { LambdaConfiguration } from '../../types';
-import { S3HostingConfiguration } from './handler/hosts/s3';
+import { S3HostingConfiguration } from './worker/hosts/s3';
 import { DefaultConfig } from '../../common/default-config';
 
 /**

src/patterns/apigateway-static-hosting/handler/hosts/common/index.ts → src/patterns/apigateway-static-hosting/worker/hosts/common/index.ts

@@ -1,8 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Express, Handler, Request, Response, NextFunction } from 'express';
+import {
+    Express,
+    Handler,
+    Request,
+    Response,
+    Router,
+    NextFunction
+} from 'express';
 import express = require('express');
+import helmet from 'helmet';
 import morgan = require('morgan');
 import { CommonHostingConfiguration } from '../../types/configuration';
 
@@ -80,6 +88,17 @@ export abstract class CommonHost<
      */
     protected abstract get spaHandler(): Handler;
 
+    /**
+     * Add the middleware to an existing Express router
+     * Either use this with an existing router or use the `create` method but not both
+     * @param router Express router on an existing app
+     */
+    addMiddleware(router: Router): void {
+        // First, try to load the URI as a static asset
+        // Second (only for SPA) load the base page which allows client to perform routing
+        router.use(this.fileHandler, this.spaHandler);
+    }
+
     /**
      * Create an Express app to host static assets
      * @returns Express app for static asset hosting
@@ -92,17 +111,19 @@ export abstract class CommonHost<
             app.use(morgan('combined'));
         }
 
-        // First, try to load the URI as a static asset
-        app.use(this.fileHandler);
+        // Security
+        app.disable('x-powered-by');
+        app.use(helmet());
 
-        if (this.props.spaIndexPage) {
-            // Second (only for SPA) load the base page which allows client to perform routing
-            app.get('*spa', this.spaHandler);
-        }
+        const router = Router();
+        this.addMiddleware(router);
+
+        app.use(router);
 
         // Last, override error handler to only show 404 and nondescript 500 for everything else
-        // TODO: Allow verbose logging in dev
-        app.use(CommonHost.nonspecificErrorHandler);
+        if (!this.props.enableVerboseErrors) {
+            app.use(CommonHost.nonspecificErrorHandler);
+        }
 
         return app;
     }

src/patterns/apigateway-static-hosting/handler/hosts/inline/index.ts → src/patterns/apigateway-static-hosting/worker/hosts/inline/index.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { join } from 'node:path';
-import { Handler, Request, Response } from 'express';
+import { Handler, NextFunction, Request, Response } from 'express';
 import express = require('express');
 import { CommonHostingConfiguration } from '../../types/configuration';
 import { CommonHost } from '../common';
@@ -28,7 +28,7 @@ export class InlineHost extends CommonHost<InlineHostingConfiguration> {
      * Express handler for the fallthrough SPA route
      */
     protected get spaHandler(): Handler {
-        return (_req: Request, res: Response) => {
+        return (_req: Request, res: Response, next: NextFunction) => {
             if (this.props.spaIndexPage) {
                 res.sendFile(
                     join(
@@ -38,7 +38,7 @@ export class InlineHost extends CommonHost<InlineHostingConfiguration> {
                     )
                 );
             } else {
-                res.sendStatus(500);
+                next();
             }
         };
     }

src/patterns/apigateway-static-hosting/handler/hosts/s3/index.ts → src/patterns/apigateway-static-hosting/worker/hosts/s3/index.ts

@@ -8,7 +8,7 @@ import { type SdkStream } from '@smithy/types';
 import { sdkStreamMixin } from '@smithy/util-stream-node';
 import { Handler, Request, Response, NextFunction } from 'express';
 import expressAsyncHandler = require('express-async-handler');
-import { getType } from 'mime';
+import mime from 'mime';
 import { CommonHostingConfiguration } from '../../types/configuration';
 import { CommonHost } from '../common';
 
@@ -95,7 +95,8 @@ export class S3Host extends CommonHost<S3HostingConfiguration> {
                 try {
                     if (this.props.spaIndexPage) {
                         const defaultContentType =
-                            getType(this.props.spaIndexPage) ?? 'text/plain';
+                            mime.getType(this.props.spaIndexPage) ??
+                            'text/plain';
 
                         const file = await this.loadObject(
                             this.props.spaIndexPage
@@ -112,7 +113,7 @@ export class S3Host extends CommonHost<S3HostingConfiguration> {
                             res.sendStatus(500);
                         }
                     } else {
-                        res.sendStatus(404);
+                        next();
                     }
                 } catch (e) {
                     // Failed to load the default object
@@ -133,7 +134,7 @@ export class S3Host extends CommonHost<S3HostingConfiguration> {
         return expressAsyncHandler(
             async (req: Request, res: Response, next: NextFunction) => {
                 try {
-                    const contentType = getType(req.path) ?? 'text/plain';
+                    const contentType = mime.getType(req.path) ?? 'text/plain';
 
                     const file = await this.loadObject(req.path);
 

src/patterns/apigateway-static-hosting/worker/index.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { InlineHost, InlineHostingConfiguration } from './hosts/inline';
+export { S3Host, S3HostingConfiguration } from './hosts/s3';
+export { Configuration } from './types/configuration';

src/patterns/apigateway-static-hosting/handler/types/configuration.ts → src/patterns/apigateway-static-hosting/worker/types/configuration.ts

@@ -30,6 +30,14 @@ export interface CommonHostingConfiguration {
      * @default false
      */
     readonly disableHttpLogging?: boolean;
+
+    /**
+     * If specified, the host will allow full error stacks to be returned to the client
+     * It is recommended to not enable this in production
+     *
+     * @default false
+     */
+    readonly enableVerboseErrors?: boolean;
 }
 
 /**

test/patterns/apigateway-static-hosting/handler/hosts/inline/index.test.ts → test/patterns/apigateway-static-hosting/worker/hosts/inline/index.test.ts

@@ -7,7 +7,7 @@ import { describe, it, expect } from 'vitest';
 import {
     InlineHost,
     InlineHostingConfiguration
-} from '../../../../../../src/patterns/apigateway-static-hosting/handler/hosts/inline';
+} from '../../../../../../src/patterns/apigateway-static-hosting/worker';
 
 const commonConfig: Partial<InlineHostingConfiguration> = {
     disableHttpLogging: true
@@ -24,7 +24,7 @@ const relativeFixturesDir = join(
     'test',
     'patterns',
     'apigateway-static-hosting',
-    'handler',
+    'worker',
     'fixtures'
 );
 

test/patterns/apigateway-static-hosting/handler/hosts/s3/index.test.ts → test/patterns/apigateway-static-hosting/worker/hosts/s3/index.test.ts

@@ -14,7 +14,7 @@ import { describe, beforeEach, it, expect } from 'vitest';
 import {
     S3Host,
     S3HostingConfiguration
-} from '../../../../../../src/patterns/apigateway-static-hosting/handler/hosts/s3';
+} from '../../../../../../src/patterns/apigateway-static-hosting/worker';
 import { streamFile } from '../../utilities/stream-fixture';
 
 const commonConfig: Partial<S3HostingConfiguration> = {

utilities/projen/lib/deps.ts

@@ -27,12 +27,12 @@ export const configureDependencies = (project: CdklabsTypeScriptProject) => {
         '@smithy/[email protected]',
         '@types/[email protected]',
         '@types/[email protected]',
-        '@types/[email protected]',
         '@types/[email protected]',
         '[email protected]',
         '[email protected]',
         '[email protected]',
-        '[email protected]',
+        '[email protected]',
+        '[email protected]',
         '[email protected]',
         '[email protected]'
     ];

utilities/projen/lib/lint.ts

@@ -27,6 +27,7 @@ export const configureLinting = (project: CdklabsTypeScriptProject) => {
     });
 
     project.eslint?.allowDevDeps('**/handler/**/*.ts');
+    project.eslint?.allowDevDeps('**/worker/**/*.ts');
     project.eslint?.allowDevDeps('**/utilities/**/*.ts');
 
     project.eslint?.addRules({

utilities/projen/lib/package.ts

@@ -16,6 +16,8 @@ export const configurePackaging = (project: CdklabsTypeScriptProject) => {
             './aspects': './aspects/index.js',
             './constructs': './constructs/index.js',
             './patterns': './patterns/index.js',
+            './patterns/apigateway-static-hosting/worker':
+                './patterns/apigateway-static-hosting/worker/index.js',
             './types': './types/index.js'
         },
         // Represents the structure in the package staging directory