debug logs and removed envs (#451)

Author: lkostrowski

.changeset/every-actors-occur.md

@@ -0,0 +1,5 @@
+---
+"@saleor/app-sdk": minor
+---
+
+Fixed interface for creating DynamoAPL - env variables are no longer passed to constructor. Added debug logs

src/APL/dynamodb/dynamodb-apl.test.ts

@@ -14,12 +14,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await repository.setEntry({
@@ -35,12 +29,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     const result = await apl.get(mockedAuthData.saleorApiUrl);
@@ -52,12 +40,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     vi.spyOn(repository, "getEntry").mockReturnValue(
@@ -73,12 +55,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     const result = await apl.set(mockedAuthData);
@@ -99,12 +75,6 @@ describe("DynamoAPL", () => {
 
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await expect(apl.set(mockedAuthData)).rejects.toThrowErrorMatchingInlineSnapshot(
@@ -116,12 +86,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await repository.setEntry({
@@ -147,12 +111,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await repository.setEntry({
@@ -170,12 +128,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await expect(
@@ -194,12 +146,6 @@ describe("DynamoAPL", () => {
     };
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     await repository.setEntry({
@@ -219,12 +165,6 @@ describe("DynamoAPL", () => {
     const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({
       repository,
-      env: {
-        AWS_ACCESS_KEY_ID: "",
-        AWS_REGION: "",
-        AWS_SECRET_ACCESS_KEY: "",
-        APL_TABLE_NAME: "",
-      },
     });
 
     vi.spyOn(repository, "getAllEntries").mockRejectedValueOnce(new Error("Error getting data"));

src/APL/dynamodb/dynamodb-apl.ts

@@ -1,41 +1,34 @@
 import { SpanStatusCode } from "@opentelemetry/api";
 
+import { createDebug } from "@/debug";
 import { getOtelTracer } from "@/open-telemetry";
 
 import { APL, AuthData } from "../apl";
 import { createAplEntity, UsedTable } from "./apl-db-model";
 import { APLRepository } from "./apl-repository";
 import { DynamoAPLRepository } from "./dynamo-apl-repository";
 
-type Envs = {
-  APL_TABLE_NAME: string;
-  AWS_REGION: string;
-  AWS_ACCESS_KEY_ID: string;
-  AWS_SECRET_ACCESS_KEY: string;
-};
-
 export class DynamoAPL implements APL {
   private repository: APLRepository;
 
   private tracer = getOtelTracer();
 
-  private env: Envs;
+  private debug = createDebug("DynamoAPL");
 
-  static create(deps: { env: Envs; table: UsedTable }) {
+  static create(deps: { table: UsedTable }) {
     return new DynamoAPL({
       repository: new DynamoAPLRepository({
         entity: createAplEntity(deps.table),
       }),
-      env: deps.env,
     });
   }
 
-  constructor(deps: { env: Envs; repository: APLRepository }) {
-    this.env = deps.env;
+  constructor(deps: { repository: APLRepository }) {
     this.repository = deps.repository;
   }
 
   async get(saleorApiUrl: string): Promise<AuthData | undefined> {
+    this.debug("get called with saleorApiUrl: %s", saleorApiUrl);
     return this.tracer.startActiveSpan("DynamoAPL.get", async (span) => {
       try {
         const getEntryResult = await this.repository.getEntry({
@@ -48,16 +41,19 @@ export class DynamoAPL implements APL {
           })
           .end();
 
+        this.debug("get successful for saleorApiUrl: %s", saleorApiUrl);
         return getEntryResult ?? undefined;
       } catch (e) {
         span.setStatus({ code: SpanStatusCode.ERROR }).end();
+        this.debug("get error for saleorApiUrl: %s, error: %O", saleorApiUrl, e);
 
         throw new Error("GetAuthDataError: Failed to get APL entry");
       }
     });
   }
 
   async set(authData: AuthData): Promise<void> {
+    this.debug("set called with authData for saleorApiUrl: %s", authData.saleorApiUrl);
     return this.tracer.startActiveSpan("DynamoAPL.set", async (span) => {
       try {
         await this.repository.setEntry({
@@ -69,15 +65,19 @@ export class DynamoAPL implements APL {
             code: SpanStatusCode.OK,
           })
           .end();
+
+        this.debug("set successful for saleorApiUrl: %s", authData.saleorApiUrl);
       } catch (e) {
         span.setStatus({ code: SpanStatusCode.ERROR }).end();
+        this.debug("set error for saleorApiUrl: %s, error: %O", authData.saleorApiUrl, e);
 
         throw new Error("SetAuthDataError: Failed to set APL entry");
       }
     });
   }
 
   async delete(saleorApiUrl: string): Promise<void> {
+    this.debug("delete called with saleorApiUrl: %s", saleorApiUrl);
     return this.tracer.startActiveSpan("DynamoAPL.delete", async (span) => {
       try {
         await this.repository.deleteEntry({
@@ -89,15 +89,19 @@ export class DynamoAPL implements APL {
             code: SpanStatusCode.OK,
           })
           .end();
+
+        this.debug("delete successful for saleorApiUrl: %s", saleorApiUrl);
       } catch (e) {
         span.setStatus({ code: SpanStatusCode.ERROR }).end();
+        this.debug("delete error for saleorApiUrl: %s, error: %O", saleorApiUrl, e);
 
         throw new Error("DeleteAuthDataError: Failed to set APL entry");
       }
     });
   }
 
   async getAll(): Promise<AuthData[]> {
+    this.debug("getAll called");
     return this.tracer.startActiveSpan("DynamoAPL.getAll", async (span) => {
       try {
         const getAllEntriesResult = await this.repository.getAllEntries();
@@ -108,9 +112,11 @@ export class DynamoAPL implements APL {
           })
           .end();
 
+        this.debug("getAll successful, found %d entries", getAllEntriesResult?.length ?? 0);
         return getAllEntriesResult ?? [];
       } catch (e) {
         span.setStatus({ code: SpanStatusCode.ERROR }).end();
+        this.debug("getAll error: %O", e);
 
         throw new Error("GetAllAuthDataError: Failed to set APL entry");
       }