Use S3 bucket for swagger UI and json

Author: devksingh4

Makefile

@@ -8,6 +8,7 @@ current_aws_account := $(shell aws sts get-caller-identity --query Account --out
 
 src_directory_root = src/
 dist_ui_directory_root = dist_ui/
+dist_docs_directory_root = dist/swagger/
 integration_test_directory_root = tests/live_integration/
 
 # CHANGE ME (as needed)
@@ -28,6 +29,8 @@ common_params = --no-confirm-changeset \
 
 s3_bucket_prefix = "$(current_aws_account)-$(region)-$(application_key)"
 ui_s3_bucket = "$(s3_bucket_prefix)-ui"
+docs_s3_bucket = "$(s3_bucket_prefix)-docs"
+
 
 GIT_HASH := $(shell git rev-parse --short HEAD)
 
@@ -66,19 +69,23 @@ build: src/ cloudformation/
 local:
 	VITE_BUILD_HASH=$(GIT_HASH) yarn run dev
 
+
+postdeploy:
+	@echo "Syncing S3 UI bucket..."
+	aws s3 sync $(dist_ui_directory_root) s3://$(ui_s3_bucket)/ --delete
+	@echo "Syncing S3 Docs bucket..."
+	aws s3 sync $(dist_docs_directory_root) s3://$(docs_s3_bucket)/ --delete
+	make invalidate_cloudfront
+
 deploy_prod: check_account_prod
 	@echo "Deploying CloudFormation stack..."
 	sam deploy $(common_params) --parameter-overrides $(run_env)=prod $(set_application_prefix)=$(application_key) $(set_application_name)="$(application_name)" S3BucketPrefix="$(s3_bucket_prefix)"
-	@echo "Syncing S3 bucket..."
-	aws s3 sync $(dist_ui_directory_root) s3://$(ui_s3_bucket)/ --delete
-	make invalidate_cloudfront
+	make postdeploy
 
 deploy_dev: check_account_dev
 	@echo "Deploying CloudFormation stack..."
 	sam deploy $(common_params) --parameter-overrides $(run_env)=dev $(set_application_prefix)=$(application_key) $(set_application_name)="$(application_name)" S3BucketPrefix="$(s3_bucket_prefix)"
-	@echo "Syncing S3 bucket..."
-	aws s3 sync $(dist_ui_directory_root) s3://$(ui_s3_bucket)/ --delete
-	make invalidate_cloudfront
+	make postdeploy
 
 invalidate_cloudfront:
 	@echo "Creating CloudFront invalidation..."

cloudformation/main.yml

@@ -611,11 +611,18 @@ Resources:
       WebsiteConfiguration:
         IndexDocument: index.html
 
+  AppDocsS3Bucket:
+    Type: AWS::S3::Bucket
+    Properties:
+      BucketName: !Sub ${S3BucketPrefix}-docs
+      WebsiteConfiguration:
+        IndexDocument: index.html
+
   CloudFrontOriginAccessIdentity:
     Type: AWS::CloudFront::CloudFrontOriginAccessIdentity
     Properties:
       CloudFrontOriginAccessIdentityConfig:
-        Comment: !Sub "Access identity for ${AppFrontendS3Bucket}"
+        Comment: !Sub "Access identity for ${AppFrontendS3Bucket} and ${AppDocsS3Bucket}"
 
   AppFrontendCloudfrontDistribution:
     Type: AWS::CloudFront::Distribution
@@ -627,6 +634,10 @@ Resources:
             DomainName: !GetAtt AppFrontendS3Bucket.RegionalDomainName
             S3OriginConfig:
               OriginAccessIdentity: !Sub "origin-access-identity/cloudfront/${CloudFrontOriginAccessIdentity}"
+          - Id: S3DocsOrigin
+            DomainName: !GetAtt AppDocsS3Bucket.RegionalDomainName
+            S3OriginConfig:
+              OriginAccessIdentity: !Sub "origin-access-identity/cloudfront/${CloudFrontOriginAccessIdentity}"
           - Id: LambdaOrigin
             DomainName: !Select [0, !Split ['/', !Select [1, !Split ['https://', !GetAtt AppLambdaUrl.FunctionUrl]]]]
             CustomOriginConfig:
@@ -698,22 +709,23 @@ Resources:
             OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966ac
             Compress: true
           - PathPattern: "/api/documentation*"
-            TargetOriginId: LambdaOrigin
+            Compress: true
+            TargetOriginId: S3DocsOrigin
             ViewerProtocolPolicy: redirect-to-https
             AllowedMethods:
               - GET
               - HEAD
-              - OPTIONS
-              - PUT
-              - POST
-              - DELETE
-              - PATCH
             CachedMethods:
               - GET
               - HEAD
-            CachePolicyId: "658327ea-f89d-4fab-a63d-7e88639e58f6"
-            OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966ac
-            Compress: true
+            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
@@ -754,6 +766,19 @@ Resources:
             Action: s3:GetObject
             Resource: !Sub "${AppFrontendS3Bucket.Arn}/*"
 
+  AppDocsS3BucketPolicy:
+    Type: AWS::S3::BucketPolicy
+    Properties:
+      Bucket: !Ref AppDocsS3Bucket
+      PolicyDocument:
+        Version: "2012-10-17"
+        Statement:
+          - Effect: Allow
+            Principal:
+              CanonicalUser: !GetAtt CloudFrontOriginAccessIdentity.S3CanonicalUserId
+            Action: s3:GetObject
+            Resource: !Sub "${AppDocsS3Bucket.Arn}/*"
+
   CloudfrontNoCachePolicy:
     Type: AWS::CloudFront::CachePolicy
     Properties:

src/api/createLambdaPackage.js

@@ -13,8 +13,6 @@ export const packagesToTransfer = [
   "moment-timezone",
   "passkit-generator",
   "fastify",
-  "@fastify/swagger",
-  "@fastify/swagger-ui",
   "zod",
   "argon2",
   "ioredis",

src/api/createSwagger.ts

@@ -0,0 +1,56 @@
+import { fileURLToPath } from "url";
+import path from "node:path";
+import { writeFile, mkdir } from "fs/promises";
+import init from "./index.js"; // Assuming this is your Fastify app initializer
+
+const html = `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="description" content="ACM @ UIUC Core API Docs" />
+  <title>ACM @ UIUC Core API</title>
+  <link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
+</head>
+<body>
+<div id="swagger-ui"></div>
+<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
+<script>
+  window.onload = () => {
+    window.ui = SwaggerUIBundle({
+      url: '/api/documentation/openapi.json',
+      dom_id: '#swagger-ui',
+    });
+  };
+</script>
+</body>
+</html>
+`;
+/**
+ * Generates and saves Swagger/OpenAPI specification files.
+ */
+async function createSwaggerFiles() {
+  try {
+    const app = await init(false, false);
+    await app.ready();
+    console.log("App is ready. Generating specs...");
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = path.dirname(__filename);
+    const outputDir = path.resolve(__dirname, "..", "..", "dist", "swagger");
+    await mkdir(outputDir, { recursive: true });
+    const jsonSpec = JSON.stringify(app.swagger(), null, 2);
+    const yamlSpec = app.swagger({ yaml: true });
+    await writeFile(path.join(outputDir, "openapi.json"), jsonSpec);
+    await writeFile(path.join(outputDir, "openapi.yaml"), yamlSpec);
+    await writeFile(path.join(outputDir, "index.html"), html);
+
+    console.log(`✅ Swagger files successfully generated in ${outputDir}`);
+    await app.close();
+  } catch (err) {
+    console.error("❌ Failed to generate Swagger files:", err);
+    process.exit(1);
+  }
+}
+
+createSwaggerFiles();