@tellescope/sdk 1.4.61 → 1.4.63

package/src/tests/tests.ts

@@ -2021,8 +2021,8 @@ const sequenceTests = async () => {
   ])
 }
 
-export const cancelConditionsTests = async () => {
-  log_header("Cancel Condition Tests")
+export const formUnsubmittedCancelConditionTest = async () => {
+  log_header("formUnsubmitted Cancel Condition Tests")
 
   const enduser = await sdk.api.endusers.createOne({ email: 'deletemeee@tellescope.com' })
   const journey = await sdk.api.journeys.createOne({ title: 'test journey '})
@@ -2052,7 +2052,8 @@ export const cancelConditionsTests = async () => {
         automationStepId: triggerStep.id,
         delayInMS: 0, // should trigger 
         delay: 0, unit: 'Seconds', // don't matter
-        cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
+        // this cancelCondition is now added automatically, does not need to be part of step
+        // cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
       } 
     }],
     action: {
@@ -2061,6 +2062,7 @@ export const cancelConditionsTests = async () => {
     },
   })
 
+  // should occur right after unsub
   const fastFollowup = await sdk.api.automation_steps.createOne({
     journeyId: journey.id,
     events: [{ 
@@ -2069,7 +2071,8 @@ export const cancelConditionsTests = async () => {
         automationStepId: unsub.id,
         delayInMS: 0,  // ensure it triggers right after unsub
         delay: 0, unit: 'Seconds', // don't matter
-        cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
+        // this cancelCondition is now added automatically, does not need to be part of step
+        // cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
       } 
     }],
     action: {
@@ -2078,6 +2081,7 @@ export const cancelConditionsTests = async () => {
     },
   })
   
+  // should be cancelled after unsub
   await sdk.api.automation_steps.createOne({
     journeyId: journey.id,
     events: [{ 
@@ -2086,7 +2090,8 @@ export const cancelConditionsTests = async () => {
         automationStepId: unsub.id,
         delayInMS: 1000000,  // ensure it doesn't trigger
         delay: 0, unit: 'Seconds', // don't matter
-        cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
+        // this cancelCondition is now added automatically, passed down from unsub
+        // cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
       } 
     }],
     action: {
@@ -2095,6 +2100,7 @@ export const cancelConditionsTests = async () => {
     },
   })
 
+  // should be cancelled after unsub
   // a second followup to the unsub event (to create example of two actions with same cancel condition)
   await sdk.api.automation_steps.createOne({
     journeyId: journey.id,
@@ -2104,7 +2110,8 @@ export const cancelConditionsTests = async () => {
         automationStepId: unsub.id,
         delayInMS: 1000000,  // ensure it doesn't trigger
         delay: 0, unit: 'Seconds', // don't matter
-        cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
+        // this cancelCondition is now added automatically, does not need to be part of step
+        // cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id }}]
       } 
     }],
     action: {
@@ -2119,15 +2126,6 @@ export const cancelConditionsTests = async () => {
     enduserId: enduser.id 
   })
 
-  // allow formUnsubmitted to trigger
-  // await wait(undefined, 1500) // allow background creation with generous pause
-
-  // await async_test(
-  //   `formUnsubmitted event with short delay is triggered`,
-  //   () => sdk.api.endusers.getOne(enduser.id),
-  //   { onResult: e => e?.journeys?.[journey.id] === 'triggered' }
-  // )  
-
   // allow fast followup to trigger
   await wait(undefined, 4000) // allow background creation with generous pause
   await async_test(
@@ -2165,6 +2163,174 @@ export const cancelConditionsTests = async () => {
   ])
 }
 
+export const formsUnsubmittedCancelConditionTest = async () => {
+  log_header("formsUnsubmitted Cancel Condition Tests")
+
+  const enduser = await sdk.api.endusers.createOne({ email: 'deletemeee@tellescope.com' })
+  const journey = await sdk.api.journeys.createOne({ title: 'test journey '})
+  const form = await sdk.api.forms.createOne({ title: 'test form' })
+  const field = await sdk.api.form_fields.createOne({
+    formId: form.id, title: 'question', type: 'string', 
+    previousFields: [{ type: 'root', info: {} }]
+  })
+
+  // this action won't be fired, because patient isn't added to journey as part of tests
+  const triggerStep = await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{ type: 'onJourneyStart', info: { } }],
+    // in practice, this would send a form, so that the next step(s) could handle the response
+    // but we don't want to send emails in testing, and can still attach this Id to a form response to test a trigger
+    action: {
+      type: 'setEnduserStatus', 
+      info: { status: 'start' },
+    },
+  })
+
+  const unsub = await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{ 
+      type: 'formsUnsubmitted', 
+      info: { 
+        automationStepId: triggerStep.id,
+        delayInMS: 10000, // should't trigger 
+        delay: 0, unit: 'Seconds', // don't matter
+        cancelConditions: [
+          // { type: 'formResponse', info: { automationStepId: triggerStep.id }}
+        ]
+      } 
+    }],
+    action: {
+      type: 'setEnduserStatus',
+      info: { status: 'triggered' },
+    },
+  })
+
+  // test for all forms submitted triggering update
+  await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{ 
+      type: 'formResponses', 
+      info: { automationStepId: triggerStep.id } 
+    }],
+    action: {
+      type: 'setEnduserStatus',
+      info: { status: 'formsSubmitted' },
+    },
+  })
+  
+  // triggers formsUnsubmitted automated actions to be created when forms generated in templated message
+  await sdk.api.templates.get_templated_message({
+    channel: 'Email',
+    enduserId: enduser.id,
+    message: `{{forms.${form.id}.link:title}} {{forms.${form.id}.link:title}}`,
+    userId: sdk.userInfo.id,
+    automationStepId: triggerStep.id,
+  })
+
+  const form_responses = await sdk.api.form_responses.getSome()
+
+  // allow fast followup to trigger
+  await wait(undefined, 2500) // allow background creation with generous pause
+
+
+  await async_test(
+    `FormsUnsubmitted action created with cancel conditions`,
+    () => sdk.api.automated_actions.getSome(),
+    { onResult: as =>  {
+      const match = as.find(a => a.automationStepId === unsub.id)
+      return !!(
+         as.length === 1
+      && match?.status === 'active'
+      && match?.event.type === 'formsUnsubmitted'
+      && match.event.info.cancelConditions?.find(c => 
+             c.type === 'formResponses' 
+          && c.info.automationStepId === triggerStep.id
+          && c.info.unsubmittedFormCount === 2
+        )
+      )
+    }}
+  )  
+  await async_test(
+    `formResponses not triggered with all forms unsubmitted`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e?.journeys?.[journey.id] !== 'formsSubmitted' }
+  )  
+
+  // trigger cancel conditions
+  await sdk.api.form_responses.submit_form_response({ accessCode: form_responses[0].accessCode!, automationStepId: triggerStep.id, responses: [{
+    answer: {
+      type: 'string',
+      value: 'answer'
+    },
+    fieldId: field.id,
+    fieldTitle: field.title,
+  }] })
+  await wait(undefined, 2500) // allow background creation with generous pause
+
+  await async_test(
+    `FormsUnsubmitted cancel conditions working`,
+    () => sdk.api.automated_actions.getSome(),
+    { onResult: as =>  {
+      const match = as.find(a => a.automationStepId === unsub.id)
+      return !!(
+         as.length === 1
+      && match?.status === 'active'
+      && match?.event.type === 'formsUnsubmitted'
+      && match.event.info.cancelConditions?.find(c => 
+             c.type === 'formResponses' 
+          && c.info.automationStepId === triggerStep.id
+          && c.info.unsubmittedFormCount === 1
+        )
+      )
+    }}
+  )  
+  await async_test(
+    `formResponses not triggered yet after 1 form remaining`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e?.journeys?.[journey.id] !== 'formsSubmitted' }
+  )  
+
+  await sdk.api.form_responses.submit_form_response({ accessCode: form_responses[1].accessCode!, automationStepId: triggerStep.id, responses: [{
+    answer: {
+      type: 'string',
+      value: 'answer'
+    },
+    fieldId: field.id,
+    fieldTitle: field.title,
+  }] })
+
+  await wait(undefined, 2500) // allow background creation with generous pause
+
+  await async_test(
+    `FormsUnsubmitted cancel conditions work`,
+    () => sdk.api.automated_actions.getSome(),
+    { onResult: as =>  {
+      const match = as.find(a => a.automationStepId === unsub.id)
+      return !!(
+         as.length === 2 // this now includes formResponses event as well, which we test has worked in the next test
+      && match?.status === 'cancelled'
+      && match?.event.type === 'formsUnsubmitted'
+      && match.event.info.cancelConditions?.find(c => 
+             c.type === 'formResponses' 
+          && c.info.automationStepId === triggerStep.id
+          && c.info.unsubmittedFormCount === 0
+        )
+      )
+    }}
+  )  
+  await async_test(
+    `formResponses triggered after both forms submitted`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e?.journeys?.[journey.id] === 'formsSubmitted' }
+  )  
+
+  await Promise.all([
+    sdk.api.forms.deleteOne(form.id),
+    sdk.api.journeys.deleteOne(journey.id),
+    sdk.api.endusers.deleteOne(enduser.id)
+  ])
+}
+
 const addToJourneyTests = async () => {
   log_header("Add / Re-add to Journey")
 
@@ -2215,8 +2381,9 @@ const addToJourneyTests = async () => {
 
 const automation_events_tests = async () => {
   log_header("Automation Events")
+  await formsUnsubmittedCancelConditionTest() 
+  await formUnsubmittedCancelConditionTest()
   await addToJourneyTests()
-  await cancelConditionsTests()
   await sequenceTests()
   await formEventTests()
   await ticketEventTests()
@@ -3306,6 +3473,7 @@ export const role_based_access_permissions_tests = async () => {
 
 const NO_TEST = () => {}
 const tests: { [K in keyof ClientModelForName]: () => void } = {
+  automation_steps: automation_events_tests,
   products: NO_TEST,
   purchase_credits: NO_TEST,
   purchases: NO_TEST,
@@ -3313,7 +3481,6 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   appointment_booking_pages: NO_TEST,
   role_based_access_permissions: role_based_access_permissions_tests,
   chat_rooms: chat_room_tests,
-  automation_steps: automation_events_tests,
   files: files_tests,
   enduser_tasks: NO_TEST,
   care_plans: NO_TEST,
@@ -3369,6 +3536,10 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
     ]) 
     await setup_tests()
     await multi_tenant_tests() // should come right after setup tests
+
+    console.log('delete me')
+    await automation_events_tests()
+
     await sub_organization_enduser_tests()
     await sub_organization_tests()
     await self_serve_appointment_booking_tests()