handle document not found error in avatax during cancel (#1573)

* handle document not found error in avatax during cancel

* use error parser

* Add tests

* return response to client

.changeset/shiny-wombats-melt.md

@@ -0,0 +1,5 @@
+---
+"app-avatax": patch
+---
+
+Add handling for error occurred due to missing document in AvaTax during cancel (voiding)

apps/avatax/src/modules/avatax/order-cancelled/avatax-order-cancelled-adapter.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from "vitest";
+
+import { AvataxConfigMockGenerator } from "@/modules/avatax/avatax-config-mock-generator";
+import { AvataxOrderCancelledAdapter } from "@/modules/avatax/order-cancelled/avatax-order-cancelled-adapter";
+import { AvataxOrderCancelledPayloadTransformer } from "@/modules/avatax/order-cancelled/avatax-order-cancelled-payload-transformer";
+
+describe("AvataxOrderCancelledAdapter", () => {
+  it("Throws DocumentNotFoundError if Avatax returns DocumentNotFoundError from the response of transaction void", async () => {
+    const adapter = new AvataxOrderCancelledAdapter(
+      {
+        async voidTransaction() {
+          throw {
+            code: "EntityNotFoundError",
+            details: [{}],
+          };
+        },
+      },
+      new AvataxOrderCancelledPayloadTransformer(),
+    );
+
+    try {
+      await adapter.send({ avataxId: "1" }, new AvataxConfigMockGenerator().generateAvataxConfig());
+    } catch (e) {
+      return expect(e).toBeInstanceOf(AvataxOrderCancelledAdapter.DocumentNotFoundError);
+    }
+  });
+});

apps/avatax/src/modules/avatax/order-cancelled/avatax-order-cancelled-adapter.ts

@@ -1,3 +1,9 @@
+import { captureException } from "@sentry/nextjs";
+
+import { BaseError } from "@/error";
+import { AvataxErrorsParser } from "@/modules/avatax/avatax-errors-parser";
+import { AvataxEntityNotFoundError } from "@/modules/taxes/tax-error";
+
 import { createLogger } from "../../../logger";
 import { CancelOrderPayload } from "../../taxes/tax-provider-webhook";
 import { WebhookAdapter } from "../../taxes/tax-webhook-adapter";
@@ -10,9 +16,20 @@ export type AvataxOrderCancelledTarget = VoidTransactionArgs;
 
 export class AvataxOrderCancelledAdapter implements WebhookAdapter<{ avataxId: string }, void> {
   private logger = createLogger("AvataxOrderCancelledAdapter");
+  private errorParser = new AvataxErrorsParser((error) => {
+    captureException(
+      new Error("AvataxOrderCancelledAdapter: Unhandled error caught from Avatax", {
+        cause: error,
+      }),
+    );
+  });
+
+  static AvaTaxOrderCancelledAdapterError = BaseError.subclass("AvaTaxOrderCancelledAdapterError");
+  static DocumentNotFoundError =
+    this.AvaTaxOrderCancelledAdapterError.subclass("DocumentNotFoundError");
 
   constructor(
-    private avataxClient: AvataxClient,
+    private avataxClient: Pick<AvataxClient, "voidTransaction">,
     private avataxOrderCancelledPayloadTransformer: AvataxOrderCancelledPayloadTransformer,
   ) {}
 
@@ -42,6 +59,26 @@ export class AvataxOrderCancelledAdapter implements WebhookAdapter<{ avataxId: s
         avataxId: payload.avataxId,
       });
     } catch (e) {
+      const parsedError = this.errorParser.parse(e);
+
+      /**
+       * This can happen when AvaTax doesn't have document on their side.
+       * We can't do anything about - hence custom handling of this error
+       */
+      if (parsedError instanceof AvataxEntityNotFoundError) {
+        /**
+         * TODO Replace with neverthrow one day
+         */
+        throw new AvataxOrderCancelledAdapter.DocumentNotFoundError(
+          "AvaTax didnt find the document to void",
+          {
+            props: {
+              error: e,
+            },
+          },
+        );
+      }
+
       const error = normalizeAvaTaxError(e);
 
       this.logger.error("Error voiding the transaction", {

apps/avatax/src/pages/api/webhooks/order-cancelled.ts

@@ -4,6 +4,8 @@ import { ObservabilityAttributes } from "@saleor/apps-otel/src/lib/observability
 import * as Sentry from "@sentry/nextjs";
 import { captureException } from "@sentry/nextjs";
 
+import { AvataxOrderCancelledAdapter } from "@/modules/avatax/order-cancelled/avatax-order-cancelled-adapter";
+
 import { AppConfigExtractor } from "../../../lib/app-config-extractor";
 import { AppConfigurationLogger } from "../../../lib/app-configuration-logger";
 import { metadataCache, wrapWithMetadataCache } from "../../../lib/app-metadata-cache";
@@ -139,12 +141,25 @@ export default wrapWithLoggerContext(
               .json({ message: `App is not configured properly for order: ${payload.order?.id}` });
           }
 
-          await taxProvider.cancelOrder(
-            {
-              avataxId: cancelledOrderInstance.getAvataxId(),
-            },
-            providerConfig.value.avataxConfig.config,
-          );
+          try {
+            await taxProvider.cancelOrder(
+              {
+                avataxId: cancelledOrderInstance.getAvataxId(),
+              },
+              providerConfig.value.avataxConfig.config,
+            );
+          } catch (e) {
+            // TODO Test once it becomes testable
+            if (e instanceof AvataxOrderCancelledAdapter.DocumentNotFoundError) {
+              logger.warn("Document was not found in AvaTax. Responding 400", {
+                error: e,
+              });
+
+              return res.status(400).send({
+                message: "AvaTax responded with DocumentNotFound. Please consult AvaTax docs",
+              });
+            }
+          }
 
           logger.info("Order cancelled");