@tellescope/sdk 2.0.0-beta.2 → 2.0.0-beta.3

package/src/tests/api_tests/webhook_raw_json_number.test.ts

@@ -1,15 +1,18 @@
 require('source-map-support').install();
 
 import { Session } from "../../sdk"
+import { wait } from "@tellescope/testing"
 import {
-  async_test,
-  log_header,
-  wait,
-} from "@tellescope/testing"
-import { setup_tests } from "../setup"
+  assert_checks,
+  Check,
+  setup_isolated_tenant,
+  IsolatedSuite,
+} from "../setup_isolated"
 
 const host = process.env.API_URL || 'http://localhost:8080' as const
 
+const RAND = () => Math.random().toString(36).slice(2, 10)
+
 // Unreachable webhook target — the request will fail quickly but the API still writes
 // the resolved payload to webhook_logs, which is what we're verifying.
 const WEBHOOK_TARGET_URL = 'http://127.0.0.1:9'
@@ -25,122 +28,137 @@ const find_log_for_url = async (sdk: Session, url: string) => {
   return null
 }
 
-// Main test function that can be called independently
-export const webhook_raw_json_number_tests = async (
-  { sdk, sdkNonAdmin } : { sdk: Session, sdkNonAdmin: Session }
-) => {
-  log_header("Webhook Raw JSON Body Numeric Placeholder Tests")
-
-  const enduser = await sdk.api.endusers.createOne({ fname: 'RawJSON', lname: 'Number' })
-  const purchase = await sdk.api.purchases.createOne({
-    enduserId: enduser.id,
-    title: 'Raw JSON Number Test Purchase',
-    cost: { amount: 129.99, currency: 'USD' },
-    processor: 'Stripe',
-  })
-
-  // create an automation step to satisfy schema validation (automationStepId is required)
-  const journey = await sdk.api.journeys.createOne({
-    title: 'Webhook Raw JSON Number Tests',
-    defaultState: 'State 1',
-  })
-  const step = await sdk.api.automation_steps.createOne({
-    journeyId: journey.id,
-    events: [{ type: 'onJourneyStart', info: {} }],
-    action: {
-      type: 'sendWebhook',
-      info: {
-        message: 'placeholder',
-        url: WEBHOOK_TARGET_URL,
-      },
-    },
-  })
+/**
+ * Covers placeholder resolution in a sendWebhook action's rawJSONBody: an unquoted
+ * {{...}} placeholder must land in the payload as a JSON number (and a missing one as null,
+ * rather than invalidating the body and dropping the whole payload).
+ *
+ * Provisions its own throwaway tenant: webhook_logs is read business-wide (the log is found by URL
+ * among the 50 most recent), so on the shared fixture another suite's webhook traffic can push the
+ * log under test out of the window.
+ */
+export const webhook_raw_json_number_checks = async (): Promise<Check[]> => {
+  const checks: Check[] = []
+  const record = (label: string, pass: boolean, detail: string) => checks.push({ label, pass, detail })
+
+  let tenant: Awaited<ReturnType<typeof setup_isolated_tenant>> | undefined
 
   try {
-    await async_test(
-      'Send Webhook rawJSONBody sends unquoted {{purchase.cost.amount}} as a number and quoted as a string',
-      async () => {
-        const url = `${WEBHOOK_TARGET_URL}/raw-json-number/${purchase.id}`
-        await sdk.api.webhooks.send_automation_webhook({
+    tenant = await setup_isolated_tenant({
+      name: `Webhook raw JSON number ${RAND()}`,
+      users: [{ isAdmin: true }],
+      apiKeys: 0,
+    })
+    const { sdk } = tenant
+
+    const enduser = await sdk.api.endusers.createOne({ fname: 'RawJSON', lname: 'Number' })
+    const purchase = await sdk.api.purchases.createOne({
+      enduserId: enduser.id,
+      title: 'Raw JSON Number Test Purchase',
+      cost: { amount: 129.99, currency: 'USD' },
+      processor: 'Stripe',
+    })
+
+    // create an automation step to satisfy schema validation (automationStepId is required)
+    const journey = await sdk.api.journeys.createOne({
+      title: 'Webhook Raw JSON Number Tests',
+      defaultState: 'State 1',
+    })
+    const step = await sdk.api.automation_steps.createOne({
+      journeyId: journey.id,
+      events: [{ type: 'onJourneyStart', info: {} }],
+      action: {
+        type: 'sendWebhook',
+        info: {
           message: 'placeholder',
-          enduserId: enduser.id,
-          automationStepId: step.id,
-          action: {
-            type: 'sendWebhook',
-            info: {
-              message: 'placeholder',
-              url,
-              rawJSONBody: '{"amount": {{purchase.cost.amount}}, "asString": "{{purchase.cost.amount}}"}',
-            },
-          },
-          context: { purchaseId: purchase.id },
-        }).catch(() => {}) // the unreachable URL is expected to error after logging
-
-        const log = await find_log_for_url(sdk, url)
-        if (!log) return false
-        const payload = log.payload as any
-        return (
-          typeof payload?.amount === 'number' && payload.amount === 129.99
-          && typeof payload?.asString === 'string' && payload.asString === '129.99'
-        )
+          url: WEBHOOK_TARGET_URL,
+        },
       },
-      { onResult: r => r === true }
-    )
-
-    await async_test(
-      'Send Webhook rawJSONBody with a MISSING unquoted placeholder degrades to null instead of dropping the whole body',
-      async () => {
-        const url = `${WEBHOOK_TARGET_URL}/raw-json-missing/${purchase.id}`
-        await sdk.api.webhooks.send_automation_webhook({
-          message: 'placeholder',
-          enduserId: enduser.id,
-          automationStepId: step.id,
-          action: {
-            type: 'sendWebhook',
-            info: {
-              message: 'placeholder',
-              url,
-              // enduser has no 'NoSuchNumber' field: the unquoted placeholder would otherwise leave a
-              // literal {{...}} in a value slot, invalidating the JSON and dropping the entire payload.
-              rawJSONBody: '{"missing": {{enduser.NoSuchNumber}}, "patient": "{{enduser.fname}}"}',
-            },
+    })
+
+    {
+      const url = `${WEBHOOK_TARGET_URL}/raw-json-number/${purchase.id}`
+      await sdk.api.webhooks.send_automation_webhook({
+        message: 'placeholder',
+        enduserId: enduser.id,
+        automationStepId: step.id,
+        action: {
+          type: 'sendWebhook',
+          info: {
+            message: 'placeholder',
+            url,
+            rawJSONBody: '{"amount": {{purchase.cost.amount}}, "asString": "{{purchase.cost.amount}}"}',
           },
-          context: { purchaseId: purchase.id },
-        }).catch(() => {})
-
-        const log = await find_log_for_url(sdk, url)
-        if (!log) return false
-        const payload = log.payload as any
-        // body must still be sent (not null/empty), the missing value coerced to JSON null,
-        // and the resolvable placeholder still substituted
-        return (
-          payload && typeof payload === 'object'
-          && payload.missing === null
-          && payload.patient === 'RawJSON'
-        )
-      },
-      { onResult: r => r === true }
-    )
+        },
+        context: { purchaseId: purchase.id },
+      }).catch(() => {}) // the unreachable URL is expected to error after logging
+
+      const log = await find_log_for_url(sdk, url)
+      const payload = log?.payload as any
+      record(
+        'Send Webhook rawJSONBody sends unquoted {{purchase.cost.amount}} as a number and quoted as a string',
+        !!log
+        && typeof payload?.amount === 'number' && payload.amount === 129.99
+        && typeof payload?.asString === 'string' && payload.asString === '129.99',
+        log ? `payload=${JSON.stringify(payload)}` : 'no webhook_log written for the URL within 10s',
+      )
+    }
+
+    {
+      const url = `${WEBHOOK_TARGET_URL}/raw-json-missing/${purchase.id}`
+      await sdk.api.webhooks.send_automation_webhook({
+        message: 'placeholder',
+        enduserId: enduser.id,
+        automationStepId: step.id,
+        action: {
+          type: 'sendWebhook',
+          info: {
+            message: 'placeholder',
+            url,
+            // enduser has no 'NoSuchNumber' field: the unquoted placeholder would otherwise leave a
+            // literal {{...}} in a value slot, invalidating the JSON and dropping the entire payload.
+            rawJSONBody: '{"missing": {{enduser.NoSuchNumber}}, "patient": "{{enduser.fname}}"}',
+          },
+        },
+        context: { purchaseId: purchase.id },
+      }).catch(() => {})
+
+      const log = await find_log_for_url(sdk, url)
+      const payload = log?.payload as any
+      // body must still be sent (not null/empty), the missing value coerced to JSON null,
+      // and the resolvable placeholder still substituted
+      record(
+        'Send Webhook rawJSONBody with a MISSING unquoted placeholder degrades to null instead of dropping the whole body',
+        !!log
+        && payload && typeof payload === 'object'
+        && payload.missing === null
+        && payload.patient === 'RawJSON',
+        log ? `payload=${JSON.stringify(payload)}` : 'no webhook_log written for the URL within 10s',
+      )
+    }
   } finally {
-    try { await sdk.api.purchases.deleteOne(purchase.id) } catch {}
-    try { await sdk.api.automation_steps.deleteOne(step.id) } catch {}
-    try { await sdk.api.journeys.deleteOne(journey.id) } catch {}
-    try { await sdk.api.endusers.deleteOne(enduser.id) } catch {}
+    // Teardown BEFORE anything asserts — assert calls process.exit, which would strand this tenant.
+    if (tenant) { try { await tenant.teardown() } catch (e) { console.error('teardown failed', e) } }
   }
+
+  return checks
+}
+
+/** Asserting wrapper, for standalone runs. */
+export const webhook_raw_json_number_tests = async () => {
+  assert_checks('Webhook raw JSON number', await webhook_raw_json_number_checks())
+}
+
+/** Enrolls this suite in the auto-discovered parallel pool — see run_discovered_isolated_suites. */
+export const ISOLATED_SUITE: IsolatedSuite = {
+  name: 'Webhook raw JSON number',
+  run: webhook_raw_json_number_checks,
 }
 
 // Allow running this test file independently
 if (require.main === module) {
   console.log(`🌐 Using API URL: ${host}`)
-  const sdk = new Session({ host })
-  const sdkNonAdmin = new Session({ host })
-
-  const runTests = async () => {
-    await setup_tests(sdk, sdkNonAdmin)
-    await webhook_raw_json_number_tests({ sdk, sdkNonAdmin })
-  }
-
-  runTests()
+  webhook_raw_json_number_tests()
     .then(() => {
       console.log("✅ Webhook raw JSON number test suite completed successfully")
       process.exit(0)