Merge pull request #57 from saleor/feat/authorize-webhooks

feat: authorize webhooks

.changeset/funny-horses-destroy.md

@@ -0,0 +1,5 @@
+---
+"saleor-app-authorize-net": minor
+---
+
+Added registering and handling Authorize.net webhooks. Enclosing the two-way synchronization between Saleor and Authorize.net transactions. Known issues: hard-coded channels, skipped webhook body verification. Both will be addressed in the next release.

.env.example

@@ -6,4 +6,5 @@ AUTHORIZE_TRANSACTION_KEY=
 AUTHORIZE_PUBLIC_CLIENT_KEY=
 AUTHORIZE_ENVIRONMENT="sandbox"
 AUTHORIZE_SALEOR_CHANNEL_SLUG="default-channel"
-AUTHORIZE_PAYMENT_FORM_URL=""
+AUTHORIZE_PAYMENT_FORM_URL=""
+APP_API_BASE_URL=""

README.md

@@ -1,3 +1,35 @@
-Important:
+# Authorize.net App
 
-- Checkout UI relies on "Authorize transactions instead of charging" in the Saleor Dashboard -> Configuration -> Channels -> [channel] settings.
+## Development
+
+### Build
+
+```bash
+pnpm run build
+```
+
+### Run
+
+#### Running the Authorize.net App
+
+```bash
+pnpm run dev
+```
+
+The app will run on port 8000.
+
+#### Running the Authorize.net UI example
+
+```bash
+cd example
+pnpm run dev
+```
+
+> [!IMPORTANT]
+> Both the example and the app need to be [tunneled](https://docs.saleor.io/docs/3.x/developer/extending/apps/developing-with-tunnels).
+
+## Important
+
+- The `example` Checkout UI relies on the "Authorize transactions instead of charging" setting in the Saleor Dashboard -> Configuration -> Channels -> [channel] settings.
+
+- The Saleor transaction id is stored in Authorize transaction `order.description`. Ideally, we would store it in `refId` but that field is max. 20 characters long and the Saleor transaction id is longer than that.

example/package.json

@@ -3,7 +3,7 @@
 	"version": "0.1.0",
 	"private": true,
 	"scripts": {
-		"dev": "next dev",
+		"dev": "next dev --port 8001",
 		"build": "next build",
 		"start": "next start",
 		"lint": "next lint --fix --dir src",

graphql/fragments/Transaction.graphql

@@ -0,0 +1,22 @@
+fragment Transaction on TransactionItem {
+  id
+  pspReference
+  sourceObject: order {
+    ... on Order {
+      total {
+        gross {
+          ...Money
+        }
+      }
+    }
+    ...OrderOrCheckoutLines
+  }
+  privateMetadata {
+    key
+    value
+  }
+  authorizedAmount {
+    amount
+    currency
+  }
+}

graphql/fragments/TransactionCancelationRequestedEvent.graphql

@@ -8,21 +8,6 @@ fragment TransactionCancelationRequestedEvent on TransactionCancelationRequested
     amount
   }
   transaction {
-    id
-    pspReference
-    sourceObject: order {
-      channel {
-        id
-        slug
-      }
-    }
-    privateMetadata {
-      key
-      value
-    }
-    authorizedAmount {
-      amount
-      currency
-    }
+    ...Transaction
   }
 }

graphql/fragments/TransactionChargeRequestedEvent.graphql

@@ -8,17 +8,6 @@ fragment TransactionChargeRequestedEvent on TransactionChargeRequested {
     actionType
   }
   transaction {
-    id
-    pspReference
-    sourceObject: order {
-      ... on Order {
-        total {
-          gross {
-            ...Money
-          }
-        }
-      }
-      ...OrderOrCheckoutLines
-    }
+    ...Transaction
   }
 }

graphql/fragments/TransactionInitializeSessionEvent.graphql

@@ -16,7 +16,7 @@ fragment TransactionInitializeSessionEvent on TransactionInitializeSession {
     }
   }
   transaction {
-    id
+    ...Transaction
   }
   sourceObject {
     __typename

graphql/fragments/TransactionProcessSessionEvent.graphql

@@ -11,7 +11,7 @@ fragment TransactionProcessSessionEvent on TransactionProcessSession {
     actionType
   }
   transaction {
-    id
+    ...Transaction
   }
   sourceObject {
     __typename

graphql/fragments/TransactionRefundRequestedEvent.graphql

@@ -8,21 +8,6 @@ fragment TransactionRefundRequestedEvent on TransactionRefundRequested {
     actionType
   }
   transaction {
-    id
-    pspReference
-    sourceObject: order {
-      ... on Order {
-        total {
-          gross {
-            ...Money
-          }
-        }
-      }
-      ...OrderOrCheckoutLines
-    }
-    privateMetadata {
-      key
-      value
-    }
+    ...Transaction
   }
 }

graphql/mutations/TransactionEventReport.graphql

@@ -2,10 +2,10 @@ mutation TransactionEventReport(
   $transactionId: ID!
   $amount: PositiveDecimal!
   $availableActions: [TransactionActionEnum!]!
-  $externalUrl: String!
+  $externalUrl: String
   $message: String
   $pspReference: String!
-  $time: DateTime!
+  $time: DateTime
   $type: TransactionEventTypeEnum!
 ) {
   transactionEventReport(

package.json

@@ -12,7 +12,7 @@
   },
   "type": "module",
   "scripts": {
-    "dev": "pnpm generate && next dev",
+    "dev": "pnpm generate && next dev --port 8000",
     "build": "pnpm generate && next build",
     "deploy": "tsx ./src/deploy.ts",
     "start": "next start",
@@ -63,6 +63,7 @@
     "jose": "4.14.4",
     "jsdom": "22.1.0",
     "lodash-es": "4.17.21",
+    "micro": "10.0.1",
     "modern-errors": "6.0.0",
     "modern-errors-http": "4.0.0",
     "modern-errors-serialize": "5.0.0",
@@ -108,7 +109,7 @@
     "@types/authorizenet": "1.0.1",
     "@types/bluebird": "3.5.38",
     "@types/lodash-es": "4.17.8",
-    "@types/node": "20.5.4",
+    "@types/node": "20.10.4",
     "@types/omit-deep-lodash": "1.1.1",
     "@types/react": "18.2.21",
     "@types/react-dom": "18.2.7",