tapimo 0.10.2 → 0.12.0

package/src/apps/management/routes/webhooks.test.ts

@@ -10,7 +10,10 @@ import * as Orgs from './orgs.js'
 import * as Webhooks from './webhooks.js'
 
 const origin = 'http://localhost'
-const webhook = { supportedChainIds: [4217, 42431] } satisfies App.Webhook
+const webhook = {
+  applicationEventTypes: ['funding:deposit.updated'],
+  supportedChainIds: [4217, 42431],
+} satisfies App.Webhook
 
 function json(method: 'PATCH' | 'POST', cookie: string, body: unknown) {
   return {
@@ -47,6 +50,315 @@ async function organization(app: ReturnType<typeof createApp>, cookie: string) {
 }
 
 describe('webhooks', () => {
+  test('publishes generator-ready OpenAPI contracts', async () => {
+    const spec = await (await createApp().request('/openapi.json')).json()
+    const collection = spec.paths['/v1/orgs/{orgId}/webhooks']
+    const deliveries = spec.paths['/v1/orgs/{orgId}/webhooks/{id}/deliveries'].get
+    const delivery = spec.paths['/v1/orgs/{orgId}/webhooks/{id}/deliveries/{deliveryId}'].get
+    const detail = spec.paths['/v1/orgs/{orgId}/webhooks/{id}']
+    const retry = spec.paths['/v1/orgs/{orgId}/webhooks/{id}/deliveries/{deliveryId}/retry'].post
+
+    expect({
+      components: [
+        'CreateOrganizationWebhookBetterstackResponse',
+        'CreateOrganizationWebhookRequest',
+        'CreateOrganizationWebhookResponse',
+        'CreateOrganizationWebhookSlackResponse',
+        'CreateOrganizationWebhookUrlResponse',
+        'DeleteOrganizationWebhookResponse',
+        'OrganizationWebhook',
+        'OrganizationWebhookDelivery',
+        'OrganizationWebhookDeliveryList',
+        'OrganizationWebhookDeliverySummary',
+        'OrganizationWebhookList',
+        'RetryOrganizationWebhookDeliveryResponse',
+        'UpdateOrganizationWebhookRequest',
+      ].filter((name) => spec.components.schemas[name]),
+      create: {
+        errors: {
+          400: collection.post.responses[400].content['application/json'].schema,
+          403: collection.post.responses[403].content['application/json'].schema,
+          404: collection.post.responses[404].content['application/json'].schema,
+        },
+        operationId: collection.post.operationId,
+        request: collection.post.requestBody.content['application/json'].schema,
+        response: collection.post.responses[200].content['application/json'].schema,
+      },
+      delete: {
+        errors: {
+          400: detail.delete.responses[400].content['application/json'].schema,
+          403: detail.delete.responses[403].content['application/json'].schema,
+          404: detail.delete.responses[404].content['application/json'].schema,
+        },
+        operationId: detail.delete.operationId,
+        response: detail.delete.responses[200].content['application/json'].schema,
+      },
+      getDelivery: {
+        errors: {
+          400: delivery.responses[400].content['application/json'].schema,
+          404: delivery.responses[404].content['application/json'].schema,
+        },
+        operationId: delivery.operationId,
+        response: delivery.responses[200].content['application/json'].schema,
+      },
+      list: {
+        errors: {
+          400: collection.get.responses[400].content['application/json'].schema,
+          404: collection.get.responses[404].content['application/json'].schema,
+        },
+        operationId: collection.get.operationId,
+        response: collection.get.responses[200].content['application/json'].schema,
+      },
+      listDeliveries: {
+        errors: {
+          400: deliveries.responses[400].content['application/json'].schema,
+          404: deliveries.responses[404].content['application/json'].schema,
+        },
+        operationId: deliveries.operationId,
+        response: deliveries.responses[200].content['application/json'].schema,
+      },
+      retry: {
+        errors: {
+          400: retry.responses[400].content['application/json'].schema,
+          403: retry.responses[403].content['application/json'].schema,
+          404: retry.responses[404].content['application/json'].schema,
+        },
+        operationId: retry.operationId,
+        response: retry.responses[200].content['application/json'].schema,
+      },
+      timestamps: {
+        createdAt: spec.components.schemas.OrganizationWebhook.properties.createdAt.format,
+        deliveryCreatedAt:
+          spec.components.schemas.OrganizationWebhookDeliverySummary.properties.createdAt.format,
+        updatedAt: spec.components.schemas.OrganizationWebhook.properties.updatedAt.format,
+      },
+      update: {
+        errors: {
+          400: detail.patch.responses[400].content['application/json'].schema,
+          403: detail.patch.responses[403].content['application/json'].schema,
+          404: detail.patch.responses[404].content['application/json'].schema,
+        },
+        operationId: detail.patch.operationId,
+        request: detail.patch.requestBody.content['application/json'].schema,
+        response: detail.patch.responses[200].content['application/json'].schema,
+      },
+    }).toMatchInlineSnapshot(`
+      {
+        "components": [
+          "CreateOrganizationWebhookBetterstackResponse",
+          "CreateOrganizationWebhookRequest",
+          "CreateOrganizationWebhookResponse",
+          "CreateOrganizationWebhookSlackResponse",
+          "CreateOrganizationWebhookUrlResponse",
+          "DeleteOrganizationWebhookResponse",
+          "OrganizationWebhook",
+          "OrganizationWebhookDelivery",
+          "OrganizationWebhookDeliveryList",
+          "OrganizationWebhookDeliverySummary",
+          "OrganizationWebhookList",
+          "RetryOrganizationWebhookDeliveryResponse",
+          "UpdateOrganizationWebhookRequest",
+        ],
+        "create": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidOrChainIdUnsupportedOrEventTypeUnsupportedOrFiltersInvalidOrParamInvalidOrUrlInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ApiKeyForbiddenOrApiKeyIpForbiddenOrForbiddenOrLimitExceededError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/OrganizationNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "createOrgWebhook",
+          "request": {
+            "$ref": "#/components/schemas/CreateOrganizationWebhookRequest",
+          },
+          "response": {
+            "$ref": "#/components/schemas/CreateOrganizationWebhookResponse",
+          },
+        },
+        "delete": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/OrganizationNotFoundOrWebhookNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "deleteOrgWebhook",
+          "response": {
+            "$ref": "#/components/schemas/DeleteOrganizationWebhookResponse",
+          },
+        },
+        "getDelivery": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/DeliveryNotFoundOrOrganizationNotFoundOrWebhookNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "getOrgWebhookDelivery",
+          "response": {
+            "$ref": "#/components/schemas/OrganizationWebhookDelivery",
+          },
+        },
+        "list": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/OrganizationNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "listOrgWebhooks",
+          "response": {
+            "$ref": "#/components/schemas/OrganizationWebhookList",
+          },
+        },
+        "listDeliveries": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidOrQueryInvalidError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/OrganizationNotFoundOrWebhookNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "listOrgWebhookDeliveries",
+          "response": {
+            "$ref": "#/components/schemas/OrganizationWebhookDeliveryList",
+          },
+        },
+        "retry": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrParamInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/DeliveryNotFoundOrOrganizationNotFoundOrWebhookNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "retryOrgWebhookDelivery",
+          "response": {
+            "$ref": "#/components/schemas/RetryOrganizationWebhookDeliveryResponse",
+          },
+        },
+        "timestamps": {
+          "createdAt": "date-time",
+          "deliveryCreatedAt": "date-time",
+          "updatedAt": "date-time",
+        },
+        "update": {
+          "errors": {
+            "400": {
+              "$ref": "#/components/schemas/ApiKeyMalformedOrBodyInvalidOrParamInvalidError",
+            },
+            "403": {
+              "$ref": "#/components/schemas/ForbiddenError",
+            },
+            "404": {
+              "$ref": "#/components/schemas/OrganizationNotFoundOrWebhookNotFoundOrWebhooksNotEnabledError",
+            },
+          },
+          "operationId": "updateOrgWebhook",
+          "request": {
+            "$ref": "#/components/schemas/UpdateOrganizationWebhookRequest",
+          },
+          "response": {
+            "$ref": "#/components/schemas/OrganizationWebhook",
+          },
+        },
+      }
+    `)
+  })
+
+  test('creates funding deposit subscriptions without reading the RPC head', async () => {
+    const db = TestApp.database()
+    const app = createApp({ db })
+    const cookie = await session(app)
+    const org = await organization(app, cookie)
+    const response = await app.request(
+      `/v1/orgs/${org.id}/webhooks`,
+      json('POST', cookie, {
+        chainId: 4217,
+        destination: { type: 'url', url: 'https://example.com/funding' },
+        environment: 'production',
+        eventType: 'funding:deposit.updated',
+        filters: { status: 'completed' },
+      }),
+    )
+    const created = await TestApp.json(response, Webhooks.schema.createWebhook.Response)
+    const stored = await core_Webhooks.getSubscription(
+      db,
+      { orgId: org.id, type: 'api_key' },
+      created.id,
+    )
+    const listedResponse = await app.request(`/v1/orgs/${org.id}/webhooks`, {
+      headers: { cookie },
+    })
+    const listed = await TestApp.json(listedResponse, Webhooks.schema.ListResponse)
+
+    expect(response.status).toBe(200)
+    expect(created.environment).toBe('production')
+    expect(listed.data[0]?.environment).toBe('production')
+    expect(stored?.environment).toBe('production')
+    expect(await core_Webhooks.getCursor(db, created.id)).toBeNull()
+  })
+
+  test('preserves a production funding environment on testnet', async () => {
+    const db = TestApp.database()
+    const app = createApp({ db })
+    const cookie = await session(app)
+    const org = await organization(app, cookie)
+    const response = await app.request(
+      `/v1/orgs/${org.id}/webhooks`,
+      json('POST', cookie, {
+        chainId: 42431,
+        destination: { type: 'url', url: 'https://example.com/funding-testnet' },
+        environment: 'production',
+        eventType: 'funding:deposit.updated',
+      }),
+    )
+    const created = await TestApp.json(response, Webhooks.schema.createWebhook.Response)
+    const stored = await core_Webhooks.getSubscription(
+      db,
+      { orgId: org.id, type: 'api_key' },
+      created.id,
+    )
+
+    expect(response.status).toBe(200)
+    expect(created.environment).toBe('production')
+    expect(stored?.environment).toBe('production')
+  })
+
+  test('requires an explicit environment for funding deposit subscriptions', async () => {
+    const app = createApp()
+    const cookie = await session(app)
+    const org = await organization(app, cookie)
+    const response = await app.request(
+      `/v1/orgs/${org.id}/webhooks`,
+      json('POST', cookie, {
+        chainId: 4217,
+        destination: { type: 'url', url: 'https://example.com/funding' },
+        eventType: 'funding:deposit.updated',
+      }),
+    )
+
+    expect(response.status).toBe(400)
+  })
+
   test('creates, lists, pauses, and deletes an organization webhook', async () => {
     const db = TestApp.database()
     const app = createApp({ db })