wip change schema version to tuple

Author: lkostrowski

src/handlers/platforms/aws-lambda/saleor-webhooks/saleor-sync-webhook.test.ts

@@ -74,7 +74,7 @@ describe("AWS Lambda SaleorSyncWebhook", () => {
           baseUrl: "example.com",
           event: "CHECKOUT_CALCULATE_TAXES",
           payload: { data: "test_payload" },
-          schemaVersion: 3.19,
+          schemaVersion: [3, 19],
           authData: {
             token: webhookConfig.apl.mockToken,
             jwks: webhookConfig.apl.mockJwks,

src/handlers/platforms/fetch-api/saleor-webhooks/saleor-async-webhook.test.ts

@@ -33,7 +33,7 @@ describe("Web API SaleorAsyncWebhook", () => {
           baseUrl: "example.com",
           event: "product_updated",
           payload: { data: "test_payload" },
-          schemaVersion: 3.2,
+          schemaVersion: [3, 20],
           authData: {
             saleorApiUrl: mockAPL.workingSaleorApiUrl,
             token: mockAPL.mockToken,
@@ -62,7 +62,7 @@ describe("Web API SaleorAsyncWebhook", () => {
           authData: expect.objectContaining({
             saleorApiUrl: mockAPL.workingSaleorApiUrl,
           }),
-        })
+        }),
       );
     });
 

src/handlers/platforms/fetch-api/saleor-webhooks/saleor-sync-webhook.test.ts

@@ -31,7 +31,7 @@ describe("Web API SaleorSyncWebhook", () => {
         baseUrl: "example.com",
         event: "checkout_calculate_taxes",
         payload: { data: "test_payload" },
-        schemaVersion: 3.19,
+        schemaVersion: [3, 19],
         authData: {
           token: webhookConfiguration.apl.mockToken,
           jwks: webhookConfiguration.apl.mockJwks,

src/handlers/platforms/fetch-api/saleor-webhooks/saleor-webhook.ts

@@ -14,16 +14,16 @@ export type WebhookConfig<Event = AsyncWebhookEventType | SyncWebhookEventType>
   GenericWebhookConfig<WebApiHandlerInput, Event>;
 
 /** Function type provided by consumer in `SaleorWebApiWebhook.createHandler` */
-export type WebApiWebhookHandler<TPayload = unknown, TExtras = {}> = (
+export type WebApiWebhookHandler<TPayload = unknown> = (
   req: Request,
-  ctx: WebhookContext<TPayload> & TExtras
+  ctx: WebhookContext<TPayload>,
 ) => Response | Promise<Response>;
 
-export abstract class SaleorWebApiWebhook<
-  TPayload = unknown,
-  TExtras extends Record<string, unknown> = {}
-> extends GenericSaleorWebhook<WebApiHandlerInput, TPayload, TExtras> {
-  createHandler(handlerFn: WebApiWebhookHandler<TPayload, TExtras>): WebApiHandler {
+export abstract class SaleorWebApiWebhook<TPayload = unknown> extends GenericSaleorWebhook<
+  WebApiHandlerInput,
+  TPayload
+> {
+  createHandler(handlerFn: WebApiWebhookHandler<TPayload>): WebApiHandler {
     return async (req) => {
       const adapter = new WebApiAdapter(req);
       const prepareRequestResult = await super.prepareRequest<WebApiAdapter>(adapter);
@@ -34,7 +34,6 @@ export abstract class SaleorWebApiWebhook<
 
       debug("Incoming request validated. Call handlerFn");
       return handlerFn(req, {
-        ...(this.extraContext ?? ({} as TExtras)),
         ...prepareRequestResult.context,
       });
     };

src/handlers/platforms/next/saleor-webhooks/saleor-async-webhook.test.ts

@@ -33,7 +33,7 @@ describe("Next.js SaleorAsyncWebhook", () => {
       expect(saleorAsyncWebhook.getWebhookManifest(baseUrl)).toEqual(
         expect.objectContaining({
           targetUrl: `${baseUrl}/${webhookPath}`,
-        })
+        }),
       );
     });
 
@@ -56,7 +56,7 @@ describe("Next.js SaleorAsyncWebhook", () => {
           baseUrl: "example.com",
           event: "product_updated",
           payload: { data: "test_payload" },
-          schemaVersion: 3.2,
+          schemaVersion: [3, 20],
           authData: {
             saleorApiUrl: mockAPL.workingSaleorApiUrl,
             token: mockAPL.mockToken,

src/handlers/platforms/next/saleor-webhooks/saleor-sync-webhook.test.ts

@@ -55,7 +55,7 @@ describe("Next.js SaleorSyncWebhook", () => {
           baseUrl: "example.com",
           event: "checkout_calculate_taxes",
           payload: { data: "test_payload" },
-          schemaVersion: 3.19,
+          schemaVersion: [3, 19],
           authData: {
             token: validSyncWebhookConfiguration.apl.mockToken,
             jwks: validSyncWebhookConfiguration.apl.mockJwks,

src/handlers/shared/saleor-webhook-validator.test.ts

@@ -237,8 +237,7 @@ describe("SaleorWebhookValidator", () => {
     });
   });
 
-  // TODO: This should be required
-  it("Fallbacks to null if version is missing in payload", async () => {
+  it("Throws if version header is missing", async () => {
     vi.spyOn(adapter, "getRawBody").mockResolvedValue(JSON.stringify({}));
     vi.spyOn(requestProcessor, "getSaleorHeaders").mockReturnValue(validHeaders);
 

src/handlers/shared/saleor-webhook-validator.ts

@@ -4,6 +4,7 @@ import { APL } from "@/APL";
 import { createDebug } from "@/debug";
 import { fetchRemoteJwks } from "@/fetch-remote-jwks";
 import { getOtelTracer } from "@/open-telemetry";
+import { SaleorSchemaVersion } from "@/types";
 import { parseSchemaVersion } from "@/util";
 import { verifySignatureWithJwks } from "@/verify-signature";
 
@@ -69,7 +70,8 @@ export class SaleorWebhookValidator {
             throw new WebhookError("Wrong request method, only POST allowed", "WRONG_METHOD");
           }
 
-          const { event, signature, saleorApiUrl } = requestProcessor.getSaleorHeaders();
+          const { event, signature, saleorApiUrl, schemaVersion } =
+            requestProcessor.getSaleorHeaders();
           const baseUrl = adapter.getBaseUrl();
 
           if (!baseUrl) {
@@ -94,7 +96,7 @@ export class SaleorWebhookValidator {
 
             throw new WebhookError(
               `Wrong incoming request event: ${event}. Expected: ${expected}`,
-              "WRONG_EVENT"
+              "WRONG_EVENT",
             );
           }
 
@@ -111,7 +113,7 @@ export class SaleorWebhookValidator {
             throw new WebhookError("Missing request body", "MISSING_REQUEST_BODY");
           }
 
-          let parsedBody: unknown & { version?: string | null };
+          let parsedBody: unknown;
 
           try {
             parsedBody = JSON.parse(rawBody);
@@ -121,13 +123,7 @@ export class SaleorWebhookValidator {
             throw new WebhookError("Request body can't be parsed", "CANT_BE_PARSED");
           }
 
-          let parsedSchemaVersion: number | null = null;
-
-          try {
-            parsedSchemaVersion = parseSchemaVersion(parsedBody.version);
-          } catch {
-            this.debug("Schema version cannot be parsed");
-          }
+          const parsedSchemaVersion = parseSchemaVersion(schemaVersion);
 
           /**
            * Verify if the app is properly installed for given Saleor API URL
@@ -139,7 +135,7 @@ export class SaleorWebhookValidator {
 
             throw new WebhookError(
               `Can't find auth data for ${saleorApiUrl}. Please register the application`,
-              "NOT_REGISTERED"
+              "NOT_REGISTERED",
             );
           }
 
@@ -162,15 +158,15 @@ export class SaleorWebhookValidator {
 
               throw new WebhookError(
                 "Fetching remote JWKS failed",
-                "SIGNATURE_VERIFICATION_FAILED"
+                "SIGNATURE_VERIFICATION_FAILED",
               );
             });
 
             this.debug("Fetched refreshed JWKS");
 
             try {
               this.debug(
-                "Second attempt to validate the signature JWKS, using fresh tokens from the API"
+                "Second attempt to validate the signature JWKS, using fresh tokens from the API",
               );
 
               await verifySignatureWithJwks(newJwks, signature, rawBody);
@@ -183,7 +179,7 @@ export class SaleorWebhookValidator {
 
               throw new WebhookError(
                 "Request signature check failed",
-                "SIGNATURE_VERIFICATION_FAILED"
+                "SIGNATURE_VERIFICATION_FAILED",
               );
             }
           }
@@ -211,7 +207,7 @@ export class SaleorWebhookValidator {
         } finally {
           span.end();
         }
-      }
+      },
     );
   }
 }

src/handlers/shared/saleor-webhook.ts

@@ -1,3 +1,5 @@
+import { SaleorSchemaVersion } from "@/types";
+
 import { AuthData } from "../../APL";
 
 export const WebhookErrorCodeMap: Record<SaleorWebhookError, number> = {
@@ -50,9 +52,7 @@ export type WebhookContext<TPayload> = {
   event: string;
   payload: TPayload;
   authData: AuthData;
-  // TODO: Make this required
-  /** Added in Saleor 3.15 */
-  schemaVersion: number | null;
+  schemaVersion: SaleorSchemaVersion;
 };
 
 export type FormatWebhookErrorResult = {

src/types.ts

@@ -320,3 +320,8 @@ export interface AppManifest {
     };
   };
 }
+
+/**
+ * Tuple representing public schema version. Patch is omitted - it doesn't change the schema.
+ */
+export type SaleorSchemaVersion = [major: number, minor: number];