do the redirect at api server level, use directly from s3

Author: devksingh4

cloudformation/main.yml

@@ -629,12 +629,6 @@ Resources:
             S3OriginConfig:
               OriginAccessIdentity: ''
             OriginAccessControlId: !GetAtt AppCloudfrontS3OAC.Id
-          - Id: S3DocsOrigin
-            DomainName: !GetAtt AppFrontendS3Bucket.RegionalDomainName
-            S3OriginConfig:
-              OriginAccessIdentity: ''
-            OriginAccessControlId: !GetAtt AppCloudfrontS3OAC.Id
-            OriginPath: "/swagger"
           - Id: LambdaOrigin
             DomainName: !Select [0, !Split ['/', !Select [1, !Split ['https://', !GetAtt AppLambdaUrl.FunctionUrl]]]]
             CustomOriginConfig:
@@ -705,24 +699,6 @@ Resources:
             CachePolicyId: "658327ea-f89d-4fab-a63d-7e88639e58f6"
             OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966ac
             Compress: true
-          - PathPattern: "/api/documentation*"
-            Compress: true
-            TargetOriginId: S3DocsOrigin
-            ViewerProtocolPolicy: redirect-to-https
-            AllowedMethods:
-              - GET
-              - HEAD
-            CachedMethods:
-              - GET
-              - HEAD
-            ForwardedValues:
-              QueryString: true
-              Cookies:
-                Forward: none
-            CachePolicyId: 658327ea-f89d-4fab-a63d-7e88639e58f6 # caching-optimized
-            # LambdaFunctionAssociations:
-            #   - EventType: origin-request
-            #     LambdaFunctionARN: !Ref AppFrontendEdgeLambdaVersion
           - PathPattern: "/api/*"
             TargetOriginId: LambdaOrigin
             ViewerProtocolPolicy: redirect-to-https

src/api/createSwagger.ts

@@ -19,7 +19,7 @@ const html = `
 <script>
   window.onload = () => {
     window.ui = SwaggerUIBundle({
-      url: '/api/documentation/openapi.json',
+      url: '/swagger/openapi.json',
       dom_id: '#swagger-ui',
     });
   };

src/api/index.ts

@@ -59,6 +59,7 @@ const now = () => Date.now();
 async function init(prettyPrint: boolean = false, initClients: boolean = true) {
   const isRunningInLambda =
     process.env.LAMBDA_TASK_ROOT || process.env.AWS_LAMBDA_FUNCTION_NAME;
+  let isSwaggerServer = true;
   const transport = prettyPrint
     ? {
         target: "pino-pretty",
@@ -205,6 +206,7 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
     });
   } catch (e) {
     app.log.warn("Fastify Swagger not created!");
+    isSwaggerServer = false;
   }
   await app.register(fastifyStatic, {
     root: path.join(__dirname, "public"),
@@ -213,7 +215,18 @@ async function init(prettyPrint: boolean = false, initClients: boolean = true) {
   if (!process.env.RunEnvironment) {
     process.env.RunEnvironment = "dev";
   }
-
+  if (isRunningInLambda && !isSwaggerServer) {
+    // Serve docs from S3
+    app.get("/api/documentation", (_request, response) => {
+      response.redirect("/swagger/index.html", 308);
+    });
+    app.get("/api/documentation/json", (_request, response) => {
+      response.redirect("/swagger/openapi.json", 308);
+    });
+    app.get("/api/documentation/yaml", (_request, response) => {
+      response.redirect("/swagger/openapi.yaml", 308);
+    });
+  }
   if (!runEnvironments.includes(process.env.RunEnvironment as RunEnvironment)) {
     throw new InternalServerError({
       message: `Invalid run environment ${app.runEnvironment}.`,