feat: add cors origins

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Summary
+
+What is the background of this pull request?
+
+## Changes
+
+- What are the changes made in this pull request?
+- Change this and that, etc...
+
+## Issues
+
+What are the related issues or stories?

.github/workflows/pull-requests.yml

@@ -0,0 +1,17 @@
+name: Pull Request Tests
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3   
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 20.x
+    - run: npm ci --no-fund --no-audit
+    - run: npm test

package.json

@@ -12,10 +12,10 @@
   "dependencies": {
     "@govtechsg/dnsprove": "^2.8.0",
     "@middy/core": "^3.4.0",
+    "@middy/http-cors": "^3.4.0",
     "tldts": "^6.1.41",
     "zod": "^3.23.8"
   },
-
   "devDependencies": {
     "@serverless/typescript": "^3.0.0",
     "@types/aws-lambda": "^8.10.71",

src/functions/resolve/__tests__/handler.test.ts

@@ -9,7 +9,13 @@ describe("resolve handler test", () => {
     queryStringParameters: Record<string, string> | null,
   ): APIGatewayProxyEventV2 =>
     ({
-      queryStringParameters,
+      version: "2.0",
+      queryStringParameters: queryStringParameters,
+      requestContext: {
+        http: {
+          method: "GET",
+        },
+      },
     }) as APIGatewayProxyEventV2;
 
   const mockContext = {
@@ -38,7 +44,7 @@ describe("resolve handler test", () => {
     const result = await handler(mockEvent, mockContext);
 
     expect(queryDns).toHaveBeenCalledWith("opencerts.io", expect.any(Array));
-    expect(result).toEqual({
+    expect(result).toMatchObject({
       statusCode: 200,
       body: JSON.stringify(mockQueryDnsResult),
     });
@@ -49,7 +55,7 @@ describe("resolve handler test", () => {
 
     const result = await handler(mockEvent, mockContext);
 
-    expect(result).toEqual({
+    expect(result).toMatchObject({
       statusCode: 400,
       body: JSON.stringify({
         message: "Invalid parameters",
@@ -63,7 +69,7 @@ describe("resolve handler test", () => {
 
     const result = await handler(mockEvent, mockContext);
 
-    expect(result).toEqual({
+    expect(result).toMatchObject({
       statusCode: 400,
       body: JSON.stringify({
         message: "Invalid parameters",
@@ -81,7 +87,7 @@ describe("resolve handler test", () => {
     const result = await handler(mockEvent, mockContext);
 
     expect(queryDns).toHaveBeenCalledWith("opencerts.io", expect.any(Array));
-    expect(result).toEqual({
+    expect(result).toMatchObject({
       statusCode: 502,
       body: JSON.stringify({
         message: mockError.message,
@@ -110,4 +116,45 @@ describe("resolve handler test", () => {
       statusCode: 502,
     });
   });
+
+  describe("CORS headers", () => {
+    it("should include www.opencerts.io origin in the response", async () => {
+      const mockEvent = createMockEvent({ name: "opencerts.io" });
+      mockEvent.headers = { Origin: "https://www.opencerts.io" };
+
+      const result = await handler(mockEvent, mockContext);
+
+      expect(result).toMatchObject({
+        headers: {
+          "Access-Control-Allow-Origin": "https://www.opencerts.io",
+        },
+      });
+    });
+
+    it("should include dev.opencerts.io origin in the response", async () => {
+      const mockEvent = createMockEvent({ name: "opencerts.io" });
+      mockEvent.headers = { Origin: "https://dev.opencerts.io" };
+
+      const result = await handler(mockEvent, mockContext);
+
+      expect(result).toMatchObject({
+        headers: {
+          "Access-Control-Allow-Origin": "https://dev.opencerts.io",
+        },
+      });
+    });
+
+    it("should default origin to www.opencerts.io in the response", async () => {
+      const mockEvent = createMockEvent({ name: "opencerts.io" });
+      mockEvent.headers = { Origin: "https://www.not-opencerts.io" };
+
+      const result = await handler(mockEvent, mockContext);
+
+      expect(result).toMatchObject({
+        headers: {
+          "Access-Control-Allow-Origin": "https://www.opencerts.io",
+        },
+      });
+    });
+  });
 });

src/functions/resolve/cors.ts

@@ -0,0 +1,8 @@
+import httpCors from '@middy/http-cors';
+
+export const cors = httpCors({
+    origins: [
+      'https://www.opencerts.io',
+      'https://dev.opencerts.io'
+  ]
+});

src/functions/resolve/handler.ts

@@ -4,6 +4,7 @@ import { queryDns, googleDnsResolver, cloudflareDnsResolver } from "@govtechsg/d
 import { formatJSONResponse } from "@libs/api-gateway";
 import { errorResponse, SchemaValidationError, validateSchema } from "@functions/resolve/helpers";
 import { dnsResultSchema, queryParamSchema } from "@functions/resolve/schemas";
+import { cors } from "@functions/resolve/cors";
 
 const resolve: APIGatewayProxyHandlerV2 = async (event) => {
   try {
@@ -28,4 +29,4 @@ const resolve: APIGatewayProxyHandlerV2 = async (event) => {
   }
 };
 
-export const main = middy(resolve);
+export const main = middy(resolve).use(cors);

src/functions/resolve/index.ts

@@ -1,21 +1,16 @@
-import { handlerPath } from '@libs/handler-resolver';
+import { handlerPath } from "@libs/handler-resolver";
 import { AWS } from "@serverless/typescript";
 
-const config: AWS['functions']['Function'] = {
+const config: AWS["functions"]["Function"] = {
   handler: `${handlerPath(__dirname)}/handler.main`,
   events: [
     {
       http: {
-        method: 'get',
-        path: 'resolve',
-        cors: {
-          origin: 'https://www.opencerts.io',
-          headers: ['Accept'],
-          allowCredentials: false,
-        },
+        method: "get",
+        path: "resolve",
       },
     },
   ],
 };
 
-export default config
+export default config;