Upgrade to AWS SDK v3 (#2080)

.github/workflows/destroy.yml

@@ -1,6 +1,6 @@
 name: Destroy
 
-on: 
+on:
   delete:
   workflow_dispatch:
     inputs:

README.md

@@ -376,8 +376,6 @@ The Kafka Queues we link to are in the BigMac account and are currently not bein
 
 `postKafkaData`: Fires when an update to the database happens and syncs kafka to reflect the current state of the database.
 
-`forceKafkaSync`: This can be manually triggered to force kafka to reflect the current state of the database.
-
 ### Utilities
 
 ---

package.json

@@ -28,7 +28,6 @@
     "@types/yargs": "^15.0.10",
     "@typescript-eslint/eslint-plugin": "5.18.0",
     "@typescript-eslint/parser": "5.18.0",
-    "aws-sdk": "^2.1310.0",
     "dotenv": "^8.2.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",

services/app-api/handlers/banners/fetch.ts

@@ -1,6 +1,7 @@
 import handler from "../../libs/handler-lib";
 import dynamoDb from "../../libs/dynamodb-lib";
 import { Errors, StatusCodes } from "../../utils/constants/constants";
+import { Banner } from "../../types";
 
 export const fetchBanner = handler(async (event, _context) => {
   if (!event?.pathParameters?.bannerId!) {
@@ -12,8 +13,8 @@ export const fetchBanner = handler(async (event, _context) => {
       key: event?.pathParameters?.bannerId!,
     },
   };
-  const response = await dynamoDb.get(params);
+  const response = await dynamoDb.get<Banner>(params);
 
   const status = StatusCodes.SUCCESS;
-  return { status: status, body: response };
+  return { status: status, body: { Item: response } };
 });

services/app-api/handlers/banners/tests/create.test.ts

@@ -1,21 +1,15 @@
 import { createBanner } from "../create";
-import { APIGatewayProxyEvent } from "aws-lambda";
+import { APIGatewayProxyEvent } from "../../../types";
 import { testBanner, proxyEvent } from "./proxyEvent";
 import dynamoDb from "../../../libs/dynamodb-lib";
 import { Errors, StatusCodes } from "../../../utils/constants/constants";
-import { mockDocumentClient } from "../../../utils/testing/setupJest";
 
 const mockHasRolePermissions = jest.fn();
 jest.mock("../../../libs/authorization", () => ({
   isAuthenticated: jest.fn().mockReturnValue(true),
   hasRolePermissions: () => mockHasRolePermissions(),
 }));
 
-jest.mock("../../../libs/debug-lib", () => ({
-  init: jest.fn(),
-  flush: jest.fn(),
-}));
-
 const testEvent: APIGatewayProxyEvent = {
   ...proxyEvent,
   httpMethod: "PUT",
@@ -28,15 +22,9 @@ const testEventNoTitle: APIGatewayProxyEvent = {
   body: JSON.stringify({ ...testBanner, title: "" }),
 };
 
-jest.spyOn(dynamoDb, "put").mockImplementation(
-  mockDocumentClient.put.promise.mockReturnValue({
-    Item: {
-      ...testBanner,
-      createdAt: new Date().getTime(),
-      lastAltered: new Date().getTime(),
-    },
-  })
-);
+jest.mock("../../../libs/dynamodb-lib", () => ({
+  put: jest.fn().mockResolvedValue("yep i put that thing!"),
+}));
 
 describe("Test createBanner API method", () => {
   beforeEach(() => {

services/app-api/handlers/banners/tests/delete.test.ts

@@ -1,33 +1,23 @@
 import { deleteBanner } from "../delete";
-import { APIGatewayProxyEvent } from "aws-lambda";
+import { APIGatewayProxyEvent } from "../../../types";
 import { testBanner, proxyEvent } from "./proxyEvent";
 import dynamoDb from "../../../libs/dynamodb-lib";
 import { Errors, StatusCodes } from "../../../utils/constants/constants";
-import { mockDocumentClient } from "../../../utils/testing/setupJest";
 
 const mockHasRolePermissions = jest.fn();
 jest.mock("../../../libs/authorization", () => ({
   isAuthenticated: jest.fn().mockReturnValue(true),
   hasRolePermissions: () => mockHasRolePermissions(),
 }));
 
-jest.mock("../../../libs/debug-lib", () => ({
-  init: jest.fn(),
-  flush: jest.fn(),
-}));
-
 const testEvent: APIGatewayProxyEvent = {
   ...proxyEvent,
   httpMethod: "DEL",
 };
 
-jest.spyOn(dynamoDb, "delete").mockImplementation(
-  mockDocumentClient.delete.promise.mockReturnValue({
-    Item: {
-      ...testBanner,
-    },
-  })
-);
+jest.mock("../../../libs/dynamodb-lib", () => ({
+  delete: jest.fn().mockResolvedValue("DELETED"),
+}));
 
 describe("Test deleteBanner API method", () => {
   beforeEach(() => {

services/app-api/handlers/banners/tests/fetch.test.ts

@@ -1,43 +1,39 @@
 import { fetchBanner } from "../fetch";
-import { APIGatewayProxyEvent } from "aws-lambda";
-import { proxyEvent, testBanner } from "./proxyEvent";
+import { APIGatewayProxyEvent, EventParameters } from "../../../types";
 import dynamoDb from "../../../libs/dynamodb-lib";
 import { Errors, StatusCodes } from "../../../utils/constants/constants";
-import { mockDocumentClient } from "../../../utils/testing/setupJest";
 
 jest.mock("../../../libs/authorization", () => ({
   isAuthenticated: jest.fn().mockReturnValue(true),
   hasPermissions: jest.fn().mockReturnValue(true),
 }));
 
-jest.mock("../../../libs/debug-lib", () => ({
-  init: jest.fn(),
-  flush: jest.fn(),
+jest.mock("../../../libs/dynamodb-lib", () => ({
+  get: jest.fn().mockResolvedValue({
+    title: "test banner",
+    description: "test description",
+    link: "https://www.example.com",
+    startDate: 1000,
+    endDate: 2000,
+    createdAt: new Date().getTime(),
+    lastAltered: new Date().getTime(),
+  }),
 }));
 
-jest.spyOn(dynamoDb, "get").mockImplementation(
-  mockDocumentClient.get.promise.mockReturnValue({
-    Item: {
-      ...testBanner,
-      createdAt: new Date().getTime(),
-      lastAltered: new Date().getTime(),
-    },
-  })
-);
-
-const testEvent: APIGatewayProxyEvent = {
-  ...proxyEvent,
-  headers: { "cognito-identity-id": "test" },
-  pathParameters: { bannerId: "testKey" },
-};
+const testEvent = {
+  headers: {
+    "cognito-identity-id": "test",
+  } as EventParameters,
+  pathParameters: {
+    bannerId: "testKey",
+  } as EventParameters,
+} as APIGatewayProxyEvent;
 
 describe("Test fetchBanner API method", () => {
   test("Test Successful empty Banner Fetch", async () => {
-    jest.spyOn(dynamoDb, "get").mockImplementation(
-      mockDocumentClient.get.promise.mockReturnValueOnce({
-        Item: undefined,
-      })
-    );
+    (dynamoDb.get as jest.Mock).mockResolvedValueOnce({
+      Item: undefined,
+    });
     const res = await fetchBanner(testEvent, null);
     expect(res.statusCode).toBe(StatusCodes.SUCCESS);
   });
@@ -46,11 +42,11 @@ describe("Test fetchBanner API method", () => {
     const res = await fetchBanner(testEvent, null);
     expect(res.statusCode).toBe(StatusCodes.SUCCESS);
     const parsedBody = JSON.parse(res.body);
-    expect(parsedBody.Item.title).toEqual(testBanner.title);
-    expect(parsedBody.Item.description).toEqual(testBanner.description);
-    expect(parsedBody.Item.startDate).toEqual(testBanner.startDate);
-    expect(parsedBody.Item.endDate).toEqual(testBanner.endDate);
-    expect(parsedBody.Item.link).toEqual(testBanner.link);
+    expect(parsedBody.Item.title).toEqual("test banner");
+    expect(parsedBody.Item.description).toEqual("test description");
+    expect(parsedBody.Item.startDate).toEqual(1000);
+    expect(parsedBody.Item.endDate).toEqual(2000);
+    expect(parsedBody.Item.link).toEqual("https://www.example.com");
   });
 
   test("Test bannerKey not provided throws 500 error", async () => {

services/app-api/handlers/banners/tests/proxyEvent.ts

@@ -1,4 +1,4 @@
-import { APIGatewayProxyEvent } from "aws-lambda";
+import { APIGatewayProxyEvent, EventParameters } from "../../../types";
 
 export const testBanner = {
   title: "test banner",
@@ -10,60 +10,17 @@ export const testBanner = {
 
 export const proxyEvent: APIGatewayProxyEvent = {
   body: "{}",
-  headers: { "x-api-key": "test" },
+  headers: { "x-api-key": "test" } as EventParameters,
   httpMethod: "GET",
   isBase64Encoded: false,
-  multiValueHeaders: {},
-  multiValueQueryStringParameters: {},
+  multiValueHeaders: {} as EventParameters,
+  multiValueQueryStringParameters: {} as EventParameters,
   path: "",
-  pathParameters: { bannerId: "admin-banner-id" },
+  pathParameters: { bannerId: "admin-banner-id" } as EventParameters,
   resource: "",
   stageVariables: null,
-  queryStringParameters: { bannerId: "testKey" },
+  queryStringParameters: { bannerId: "testKey" } as EventParameters,
   requestContext: {
-    accountId: "",
-    apiId: "",
-    authorizer: () => {},
-    httpMethod: "",
-    path: "",
-    protocol: "",
-    requestId: "",
-    requestTimeEpoch: 0,
-    resourceId: "",
-    resourcePath: "",
-    stage: "",
-    connectedAt: 0,
-    connectionId: "",
-    domainName: "",
-    domainPrefix: "",
-    eventType: "",
-    extendedRequestId: "",
-    messageDirection: "",
-    messageId: "",
-    requestTime: "",
-    routeKey: "",
-    identity: {
-      accessKey: "",
-      accountId: "",
-      apiKey: "",
-      apiKeyId: "",
-      caller: "",
-      cognitoAuthenticationProvider: "",
-      cognitoAuthenticationType: "",
-      cognitoIdentityId: "",
-      cognitoIdentityPoolId: "",
-      principalOrgId: "",
-      sourceIp: "",
-      user: "",
-      userAgent: "",
-      userArn: "",
-      clientCert: {
-        clientCertPem: "",
-        issuerDN: "",
-        serialNumber: "",
-        subjectDN: "",
-        validity: { notAfter: "", notBefore: "" },
-      },
-    },
+    /* nope */
   },
 };

services/app-api/handlers/coreSets/create.ts

@@ -76,7 +76,7 @@ export const createCoreSet = handler(async (event, context) => {
     },
   };
 
-  await dynamoDb.post(params);
+  await dynamoDb.put(params);
   return { status: StatusCodes.SUCCESS, body: params };
 });
 
@@ -114,7 +114,7 @@ const createDependentMeasures = async (
       },
     };
 
-    const result = await dynamoDb.post(params);
+    const result = await dynamoDb.put(params);
     dependentMeasures.push(result);
   }
 };

services/app-api/handlers/coreSets/delete.ts

@@ -43,7 +43,7 @@ const deleteDependentMeasures = async (
   coreSet: string
 ) => {
   const measures = await getMeasures(state, year, coreSet);
-  const Items = measures.Items || [];
+  const Items = measures;
 
   for await (const { measure } of Items) {
     const dynamoKey = `${state}${year}${coreSet}${measure}`;
@@ -67,6 +67,6 @@ const getMeasures = async (state: string, year: number, coreSet: string) => {
       "list"
     ),
   };
-  const queryValue = await dynamoDb.scan<Measure>(params);
+  const queryValue = await dynamoDb.scanAll<Measure>(params);
   return queryValue;
 };

services/app-api/handlers/coreSets/get.ts

@@ -8,12 +8,12 @@ import {
   hasRolePermissions,
   hasStatePermissions,
 } from "../../libs/authorization";
-import * as Types from "../../types";
 import { Errors, StatusCodes } from "../../utils/constants/constants";
+import { CoreSet, CoreSetAbbr, UserRoles } from "../../types";
 
 export const coreSetList = handler(async (event, context) => {
   // action limited to any admin type user and state users from corresponding state
-  const isStateUser = hasRolePermissions(event, [Types.UserRoles.STATE_USER]);
+  const isStateUser = hasRolePermissions(event, [UserRoles.STATE_USER]);
   if (isStateUser) {
     const isFromCorrespondingState = hasStatePermissions(event);
     if (!isFromCorrespondingState) {
@@ -35,15 +35,15 @@ export const coreSetList = handler(async (event, context) => {
     ),
   };
 
-  const results = await dynamoDb.scan<Types.CoreSet>(params);
+  const results = await dynamoDb.scanAll<CoreSet>(params);
   // if the query value contains no results
-  if (results.Count === 0) {
+  if (results.length === 0) {
     // add an adult coreset and requery the db
     const createCoreSetEvent = {
       ...event,
       pathParameters: {
         ...event.pathParameters,
-        coreSet: Types.CoreSetAbbr.ACS,
+        coreSet: CoreSetAbbr.ACS,
       },
     };
     try {
@@ -52,10 +52,12 @@ export const coreSetList = handler(async (event, context) => {
         context
       );
       if (createCoreSetResult.statusCode === 200) {
-        const res = await dynamoDb.scan(params);
+        const res = await dynamoDb.scanAll<CoreSet>(params);
         return {
           status: StatusCodes.SUCCESS,
-          body: res,
+          body: {
+            Items: res,
+          },
         };
       } else {
         throw new Error("Creation failed");
@@ -66,18 +68,20 @@ export const coreSetList = handler(async (event, context) => {
     }
   } else {
     // Update the progress measure numComplete
-    const updatedCoreSetProgressResults =
-      (await updateCoreSetProgress(results, event, context)) || results;
+    await updateCoreSetProgress(results, event, context);
+
     return {
       status: StatusCodes.SUCCESS,
-      body: updatedCoreSetProgressResults,
+      body: {
+        Items: results,
+      },
     };
   }
 });
 
 export const getCoreSet = handler(async (event, context) => {
   // action limited to any admin type user and state users from corresponding state
-  const isStateUser = hasRolePermissions(event, [Types.UserRoles.STATE_USER]);
+  const isStateUser = hasRolePermissions(event, [UserRoles.STATE_USER]);
   if (isStateUser) {
     const isFromCorrespondingState = hasStatePermissions(event);
     if (!isFromCorrespondingState) {
@@ -99,6 +103,8 @@ export const getCoreSet = handler(async (event, context) => {
   const queryValue = await dynamoDb.get(params);
   return {
     status: StatusCodes.SUCCESS,
-    body: queryValue,
+    body: {
+      Item: queryValue,
+    },
   };
 });