app deleted shared handler

.changeset/open-eels-yell.md

@@ -0,0 +1,5 @@
+---
+"saleor-app-klaviyo": minor
+---
+
+App now will listen on APP_DELETED webhook and clean up it's Auth Data once removed

.changeset/petite-days-watch.md

@@ -0,0 +1,5 @@
+---
+"@saleor/webhook-utils": minor
+---
+
+Added APP_DELETED shared webhook that automatically cleans up APL

apps/avatax/src/app/api/webhooks/app-deleted/route.ts

@@ -0,0 +1,44 @@
+import { createAppDeletedHandler } from "@saleor/webhook-utils/app-deleted-handler";
+
+import { env } from "@/env";
+import { ClientLogDynamoEntityFactory, LogsTable } from "@/modules/client-logs/dynamo-logs-table";
+import { LogsRepositoryDynamodb } from "@/modules/client-logs/logs-repository";
+import { createDocumentClient, createDynamoClient } from "@/modules/dynamodb/dynamo-client";
+
+import { saleorApp } from "../../../../../saleor-app";
+import { createLogger } from "../../../../logger";
+
+const { handler, getWebhookManifest } = createAppDeletedHandler({
+  apl: saleorApp.apl,
+  logger: createLogger("APP_DELETED handler"),
+  webhookPath: "api/webhooks/app-deleted",
+  hooks: {
+    async onEvent({ authData }) {
+      // todo share factory
+      const logsTable = LogsTable.create({
+        documentClient: createDocumentClient(
+          createDynamoClient({
+            connectionTimeout: env.DYNAMODB_CONNECTION_TIMEOUT_MS,
+            requestTimeout: env.DYNAMODB_REQUEST_TIMEOUT_MS,
+          }),
+        ),
+        tableName: env.DYNAMODB_LOGS_TABLE_NAME,
+      });
+      const logByDateEntity = ClientLogDynamoEntityFactory.createLogByDate(logsTable);
+      const logByCheckoutOrOrderId =
+        ClientLogDynamoEntityFactory.createLogByCheckoutOrOrderId(logsTable);
+
+      const repo = new LogsRepositoryDynamodb({
+        logsTable,
+        logByDateEntity,
+        logByCheckoutOrOrderId,
+      });
+
+      await repo.pruneAllLogs({ saleorApiUrl: authData.saleorApiUrl });
+    },
+  },
+});
+
+export { getWebhookManifest };
+
+export const POST = handler;

apps/avatax/src/modules/client-logs/dynamo-logs-table.ts

@@ -60,6 +60,10 @@ export class LogsTable extends Table<
     return `${saleorApiUrl}#${appId}`;
   }
 
+  static decomposePrimaryKey(pk: string) {
+    return pk.split("#") as [saleorApiUrl: string, appId: string];
+  }
+
   static getDefaultTTL() {
     const daysUntilExpire = env.DYNAMODB_LOGS_ITEM_TTL_IN_DAYS;
     const now = new Date();

apps/avatax/src/modules/client-logs/logs-repository.ts

@@ -1,9 +1,11 @@
 import { type BatchWriteCommandOutput } from "@aws-sdk/lib-dynamodb";
 import {
+  BatchDeleteRequest,
   BatchPutRequest,
   BatchWriteCommand,
   executeBatchWrite,
   QueryCommand,
+  ScanCommand,
 } from "dynamodb-toolbox";
 import { err, ok, Result, ResultAsync } from "neverthrow";
 import { ulid } from "ulid";
@@ -38,6 +40,7 @@ export interface ILogsRepository {
     saleorApiUrl: string;
     appId: string;
   }): Promise<Result<undefined, unknown>>;
+  pruneAllLogs(args: { saleorApiUrl: string }): Promise<Result<undefined, unknown>>;
 }
 
 /**
@@ -323,6 +326,108 @@ export class LogsRepositoryDynamodb implements ILogsRepository {
 
     return ok(undefined);
   }
+
+  async pruneAllLogs({
+    saleorApiUrl,
+  }: {
+    saleorApiUrl: string;
+  }): Promise<
+    Result<
+      undefined,
+      | InstanceType<typeof LogsRepositoryDynamodb.LogsFetchError>
+      | InstanceType<typeof LogsRepositoryDynamodb.WriteLogError>
+      | InstanceType<typeof LogsRepositoryDynamodb.UnprocessedItemsError>
+    >
+  > {
+    this.logger.debug("Starting pruning logs for saleorApiUrl", { saleorApiUrl });
+
+    const pkPrefix = `${saleorApiUrl}#`;
+
+    let lastEvaluatedKey: LastEvaluatedKey;
+    let deletedCount = 0;
+
+    do {
+      const scanResult = await ResultAsync.fromPromise(
+        this.logsTable
+          .build(ScanCommand)
+          .entities(this.logByDateEntity, this.logsByCheckoutOrOrderId)
+          .options({
+            exclusiveStartKey: lastEvaluatedKey,
+            showEntityAttr: true,
+            filters: {
+              LOG_BY_DATE: { attr: "PK", beginsWith: pkPrefix },
+              LOG_BY_CHECKOUT_OR_ORDER_ID: { attr: "PK", beginsWith: pkPrefix },
+            },
+          })
+          .send(),
+        (error) =>
+          new LogsRepositoryDynamodb.LogsFetchError("Error while scanning logs for pruning", {
+            cause: error,
+          }),
+      );
+
+      if (scanResult.isErr()) {
+        this.logger.error("Error while scanning logs for pruning", { error: scanResult.error });
+
+        return err(scanResult.error);
+      }
+
+      lastEvaluatedKey = scanResult.value.LastEvaluatedKey;
+
+      const items = scanResult.value.Items ?? [];
+
+      for (let i = 0; i < items.length; i += 25) {
+        const chunk = items.slice(i, i + 25);
+
+        const requests = chunk.map((item) =>
+          item.entity === "LOG_BY_DATE"
+            ? this.logByDateEntity
+                .build(BatchDeleteRequest)
+                .key({ PK: item.PK, ulid: item.ulid, date: item.date })
+            : this.logsByCheckoutOrOrderId.build(BatchDeleteRequest).key({
+                PK: item.PK,
+                ulid: item.ulid,
+                date: item.date,
+                checkoutOrOrderId: item.checkoutOrOrderId,
+              }),
+        );
+
+        const cmd = this.logsTable.build(BatchWriteCommand).requests(...requests);
+
+        const deleteResult = await ResultAsync.fromPromise(
+          executeBatchWrite({ capacity: "TOTAL", maxAttempts: 3 }, cmd),
+          (error) =>
+            new LogsRepositoryDynamodb.WriteLogError("Error while deleting logs from DynamoDB", {
+              cause: error,
+            }),
+        );
+
+        if (deleteResult.isErr()) {
+          this.logger.error("Error while batch-deleting logs from DynamoDB", {
+            error: deleteResult.error,
+          });
+
+          return err(deleteResult.error);
+        }
+
+        if (this.hasUnprocessedItems(deleteResult.value.UnprocessedItems)) {
+          this.logger.warn("Some logs were not deleted from DynamoDB", {
+            unprocessedItems: deleteResult.value.UnprocessedItems,
+          });
+
+          return err(
+            new LogsRepositoryDynamodb.UnprocessedItemsError("Some logs were not deleted"),
+          );
+        }
+
+        deletedCount += chunk.length;
+      }
+    } while (lastEvaluatedKey);
+
+    this.logger.info("Pruned all logs for saleorApiUrl", { saleorApiUrl, deletedCount });
+
+    return ok(undefined);
+  }
 }
 
 /**
@@ -376,4 +481,18 @@ export class LogsRepositoryMemory implements ILogsRepository {
   }): Promise<Result<{ clientLogs: ClientLog[]; lastEvaluatedKey: LastEvaluatedKey }, never>> {
     return ok({ clientLogs: this.logs, lastEvaluatedKey: undefined });
   }
+
+  async pruneAllLogs(args: {
+    saleorApiUrl: string;
+    appId: string;
+  }): Promise<Result<undefined, unknown>> {
+    this.logs = this.logs.filter((l) => {
+      const log = l.getValue();
+      const [saleorApiUrl] = LogsTable.decomposePrimaryKey(log.id);
+
+      return args.saleorApiUrl !== saleorApiUrl;
+    });
+
+    return ok(undefined);
+  }
 }

apps/klaviyo/next-env.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
+/// <reference types="next/navigation-types/compat/navigation" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

apps/klaviyo/package.json

@@ -28,6 +28,7 @@
     "@opentelemetry/semantic-conventions": "catalog:",
     "@saleor/app-sdk": "link:../../node_modules/@saleor/app-sdk",
     "@saleor/apps-logger": "workspace:*",
+    "@saleor/webhook-utils": "workspace:*",
     "@saleor/apps-otel": "workspace:*",
     "@saleor/apps-shared": "workspace:*",
     "@saleor/apps-ui": "workspace:*",

apps/klaviyo/src/app/api/webhooks/app-deleted/route.ts

@@ -0,0 +1,14 @@
+import { createAppDeletedHandler } from "@saleor/webhook-utils/app-deleted-handler";
+
+import { saleorApp } from "../../../../../saleor-app";
+import { createLogger } from "../../../../logger";
+
+const { handler, getWebhookManifest } = createAppDeletedHandler({
+  apl: saleorApp.apl,
+  logger: createLogger("APP_DELETED handler"),
+  webhookPath: "api/webhooks/app-deleted",
+});
+
+export { getWebhookManifest };
+
+export const POST = handler;

apps/klaviyo/src/pages/api/manifest.ts

@@ -1,9 +1,10 @@
 import { createManifestHandler } from "@saleor/app-sdk/handlers/next";
-import { AppManifest } from "@saleor/app-sdk/types";
+import { type AppManifest } from "@saleor/app-sdk/types";
 import { wrapWithLoggerContext } from "@saleor/apps-logger/node";
 import { withSpanAttributes } from "@saleor/apps-otel/src/with-span-attributes";
 
 import pkg from "../../../package.json";
+import { getWebhookManifest as getAppDeletedWebhookManifest } from "../../app/api/webhooks/app-deleted/route";
 import { env } from "../../env";
 import { loggerContext } from "../../logger-context";
 import { customerCreatedWebhook } from "./webhooks/customer-created";
@@ -41,6 +42,7 @@ const handler = wrapWithLoggerContext(
             fulfillmentCreatedWebhook.getWebhookManifest(appBaseUrl),
             orderCreatedWebhook.getWebhookManifest(appBaseUrl),
             orderFullyPaidWebhook.getWebhookManifest(appBaseUrl),
+            getAppDeletedWebhookManifest(appBaseUrl),
           ],
         };
       },

apps/klaviyo/tsconfig.json

@@ -1,8 +1,22 @@
 {
   "extends": "@saleor/typescript-config-apps/base.json",
   "compilerOptions": {
-    "baseUrl": "."
+    "baseUrl": ".",
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "next.config.ts", "graphql.config.ts"],
-  "exclude": ["node_modules"]
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+    "graphql.config.ts",
+    "next-env.d.ts",
+    "next.config.ts",
+    ".next/types/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
 }