@tellescope/sdk 1.67.0 → 1.67.2

package/src/tests/tests.ts

@@ -10,6 +10,9 @@ import {
   UserDisplayInfo,
 } from "@tellescope/types-client"
 import { 
+  CreateTicketActionInfo,
+  CreateTicketAssignmentStrategies,
+  CreateTicketAssignmentStrategy,
   FormResponseValue,
   ModelName,
 } from "@tellescope/types-models"
@@ -5026,8 +5029,414 @@ const nextReminderInMS_tests = async () => {
   ])
 }
 
+const pollForResults = async <T>(f: () => Promise<T>, evaluate: (r: T) => boolean, intervalInMS=500, iterations=20) => {
+  for (let i = 0; i < iterations; i++) {
+    await wait(undefined, intervalInMS)
+    const result = await f()
+    if (evaluate(result)) return result
+  }
+
+  throw new Error("failed pollForResults")
+}
+
 const test_ticket_automation_assignment_and_optimization = async () => {
-  console.log((await sdk.api.users.getSome({ })).length)
+  log_header("Ticket Automation / Assignment Tests")
+
+  const users = await sdk.api.users.getSome()
+  if (users.length < 3) throw new Error("Must have at least 3 users to detect invalid assignment")
+
+  await sdk.api.users.updateOne(sdk.userInfo.id, { tags: ['tag1', 'tag2'] })
+  await sdk.api.users.updateOne(sdkNonAdmin.userInfo.id, { tags: ['tag1', 'tag3'] })
+
+  const journey = await sdk.api.journeys.createOne({ title: "Testing" })
+
+  let foregroundTestCounter = 0
+  const testForegroundTicket = async ({
+    assignedTo,
+    info,
+    validOwners,
+    enduser,
+    closedForReason,
+    testDelayedChild,
+  } : {
+    assignedTo: string[]
+    info: Pick<CreateTicketActionInfo, 'assignmentStrategy' | 'defaultAssignee'>,
+    validOwners: string[],
+    closedForReason?: string,
+    enduser?: Enduser,
+    testDelayedChild?: boolean,
+  }) => {
+    const e = enduser || await sdk.api.endusers.createOne({ assignedTo, journeys: { [journey.id]: '' } })
+
+    const step = await sdk.api.automation_steps.createOne({
+      action: { type: 'createTicket', info: { ...info, title: 'background ticket' } },
+      events: [{ 
+        type: 'ticketCompleted', 
+        info: closedForReason ? { automationStepId: PLACEHOLDER_ID, closedForReason }  : { automationStepId: PLACEHOLDER_ID } 
+      }],
+      journeyId: journey.id,
+    })
+    const statusStep = await sdk.api.automation_steps.createOne({
+      action: { type: 'setEnduserStatus', info: { status: 'Test Status' } },
+      events: [{ 
+        type: 'ticketCompleted', 
+        info: closedForReason ? { automationStepId: PLACEHOLDER_ID, closedForReason }  : { automationStepId: PLACEHOLDER_ID } 
+      }],
+      journeyId: journey.id,
+    })
+    const child = await sdk.api.automation_steps.createOne({
+      action: { type: 'setEnduserStatus', info: { status: 'Test Status' } },
+      events: [{ 
+        type: 'afterAction', 
+        info: {
+          automationStepId: step.id,
+          delay: 0, delayInMS: 0, unit: 'Days', 
+        }
+      }],
+      journeyId: journey.id,
+    })
+
+    const ticket = await sdk.api.tickets.createOne({
+      title: 'foreground ticket',
+      enduserId: e.id,
+      automationStepId: PLACEHOLDER_ID,
+      journeyId: journey.id,
+      owner: validOwners[0],
+      closedForReason,
+    })
+
+    await async_test(
+      `Foreground ticket assignment ${++foregroundTestCounter}`, 
+      () => sdk.api.tickets.close_ticket({ ticketId: ticket.id, closedForReason }),
+      { onResult: ({ generated }) => !!generated?.owner && validOwners.includes(generated.owner) }
+    ) 
+    await async_test(
+      `Foreground ticket nop, no duplicates`,
+      () => sdk.api.automated_actions.getSome({ filter: { automationStepId: step.id } }),
+      { onResult: steps => steps.length === 1 && !!steps[0].isNOP }
+    ) 
+    await async_test(
+      `Background action queued, no duplicates`,
+      () => sdk.api.automated_actions.getSome({ filter: { automationStepId: statusStep.id } }),
+      { 
+        onResult: steps => steps.length === 1 && !steps[0].isNOP 
+      }
+    ) 
+
+    // verify that ticket generated by close_ticket goes on to generate its own delayed actions
+    if (testDelayedChild) {
+      await async_test(
+        `Delayed child ticket`, 
+        () => pollForResults(() => sdk.api.automated_actions.getSome({ filter: { automationStepId: child.id } }), t => !!t.length),
+        { onResult: steps => steps.length === 1 && !steps[0].isNOP }
+      ) 
+    }
+
+    await Promise.all([
+      sdk.api.endusers.deleteOne(e.id),
+      sdk.api.automation_steps.deleteOne(step.id),
+      sdk.api.automation_steps.deleteOne(statusStep.id),
+      sdk.api.automation_steps.deleteOne(child.id),
+    ])
+  }
+
+  await testForegroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'default', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdk.userInfo.id],
+    testDelayedChild: true,
+  })
+  await testForegroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'default', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdk.userInfo.id],
+    closedForReason: "closedForReason test",
+    testDelayedChild: true,
+  })
+  await testForegroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'default', info: {} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'previous-owner', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],  
+    info: { 
+      assignmentStrategy: { type: 'care-team-primary', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'care-team-random', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag1']} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id, 
+    },
+    validOwners: [sdk.userInfo.id, sdkNonAdmin.userInfo.id, ],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag2']} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id 
+    },
+    validOwners: [sdk.userInfo.id],
+  })
+  await testForegroundTicket({ 
+    assignedTo: [],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag3']} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+
+
+  let backgroundTestCounter = 0
+  const testBackgroundTicket = async ({
+    assignedTo,
+    info,
+    validOwners,
+    enduser,
+  } : {
+    assignedTo: string[]
+    info: Pick<CreateTicketActionInfo, 'assignmentStrategy' | 'defaultAssignee'>,
+    validOwners: string[],
+    enduser?: Enduser,
+  }) => {
+    const e = enduser || await sdk.api.endusers.createOne({ assignedTo })
+    await sdk.api.automated_actions.createOne({
+      action: { type: 'createTicket', info: { ...info, title: 'background ticket' } },
+      automationStepId: PLACEHOLDER_ID,
+      enduserId: e.id,
+      event: { type: 'afterAction', info: { automationStepId: PLACEHOLDER_ID, delay: 0, delayInMS: 0, unit: 'Days' } },
+      journeyId: journey.id,
+      status: 'active',
+      processAfter: Date.now(),
+    })
+
+    await async_test(
+      `Background ticket assignment ${++backgroundTestCounter}`, 
+      () => pollForResults(() => sdk.api.tickets.getSome({ filter: { enduserId: e.id, title: 'background ticket' } }), t => !!t.length),
+      { onResult: ts => ts.length === 1 && !!ts[0].owner && validOwners.includes(ts[0].owner) }
+    ) 
+
+    await sdk.api.endusers.deleteOne(e.id)
+  }
+
+  await testBackgroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'default', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdk.userInfo.id],
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [],  
+    info: { 
+      assignmentStrategy: { type: 'default', info: {} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+
+  // ticket needs existing enduser, previous owner for test to work
+  const enduser = await sdk.api.endusers.createOne({ fname: 'previous-owner-test'})  
+  await sdk.api.tickets.createOne({ 
+    // title should be different than 'background test' so it doesn't create false positive test
+    title: 'previous-owner-test', enduserId: enduser.id, journeyId: journey.id, owner: sdkNonAdmin.userInfo.id 
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [],  
+    enduser,
+    info: { 
+      assignmentStrategy: { type: 'previous-owner', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+  
+  await testBackgroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],  
+    info: { 
+      assignmentStrategy: { type: 'care-team-primary', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'care-team-random', info: {} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag1']} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id, 
+    },
+    validOwners: [sdk.userInfo.id, sdkNonAdmin.userInfo.id, ],
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [sdkNonAdmin.userInfo.id, sdk.userInfo.id],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag2']} } , 
+      defaultAssignee: sdkNonAdmin.userInfo.id 
+    },
+    validOwners: [sdk.userInfo.id],
+  })
+  await testBackgroundTicket({ 
+    assignedTo: [],
+    info: { 
+      assignmentStrategy: { type: 'by-tags', info: { qualifier: 'One Of', values: ['tag3']} } , 
+      defaultAssignee: sdk.userInfo.id 
+    },
+    validOwners: [sdkNonAdmin.userInfo.id],
+  })
+
+  return Promise.all([
+    await sdk.api.journeys.deleteOne(journey.id)
+  ])
+}
+
+const field_equals_trigger_tests = async () => {
+  log_header("Field Equals / Trigger Tests")
+
+  const journey = await sdk.api.journeys.createOne({ title: 'test' })
+  const step = await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{
+      type: 'onJourneyStart',
+      info: {}
+    }],
+    action: {
+      type: 'addEnduserTags',
+      info: { tags: ['Journey Tag']}
+    },
+  })
+
+  const existsTriggerTags = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'fname', value: "$exists" } },
+    action: { type: 'Add Tags', info: { tags: ["Tag"] } },
+    status: "Active",
+    title: 'existsTriggerTags',
+  })
+  const existsTriggerAddToJourney = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'fname', value: "$exists" } },
+    action: { type: 'Add To Journey', info: { journeyId: journey.id } },
+    status: "Active",
+    title: 'existsTriggerAddToJourney',
+  })
+  const equalsTriggerTags = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'lname', value: "Explicit" } },
+    action: { type: 'Add Tags', info: { tags: ["Tag"] } },
+    status: "Active",
+    title: 'equalsTriggerTags',
+  })
+  const equalsTriggerAddToJourney = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'lname', value: "Explicit" } },
+    action: { type: 'Add To Journey', info: { journeyId: journey.id } },
+    enduserCondition: { $and: [ { condition: { lname: 'Explicit' } } ] },
+    status: "Active",
+    title: 'equalsTriggerAddToJourney',
+  })
+  const conditionalTriggerTags = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'mname', value: "$exists" } },
+    action: { type: 'Add Tags', info: { tags: ["Tag"] } },
+    status: "Active",
+    enduserCondition: { $and: [ { condition: { lname: 'Conditional' } } ] },
+    title: 'conditionalTriggerTags',
+  })
+  const conditionalTriggerAddToJourney = await sdk.api.automation_triggers.createOne({ 
+    event: { type: 'Field Equals', info: { field: 'mname', value: "$exists" } },
+    action: { type: 'Add To Journey', info: { journeyId: journey.id } },
+    enduserCondition: { $and: [ { condition: { lname: 'Conditional' } } ] },
+    status: "Active",
+    title: 'conditionalTriggerAddToJourney',
+  })
+
+  // names are capitalized automatically, so make sure that is reflected in conditions
+  const endusers = (await sdk.api.endusers.createSome([
+    { fname: 'Test' },
+    { fname: 'Test' },
+    { lname: 'Test' }, // should not be added to any journey
+    { lname: 'Explicit' }, 
+    { mname: 'Test' }, // should not be added to any journey for failing conditional logic
+    { mname: 'Test' }, // should not be added to any journey for failing conditional logic
+    { mname: 'Test', lname: 'Nonconditional' }, // should not be added to any journey for failing conditional logic
+    { mname: 'Test', lname: 'Conditional' },
+  ])).created
+
+  await async_test(
+    `Journey and tags set`, 
+    () => pollForResults(
+      sdk.api.endusers.getSome, 
+      es => (
+        es.filter(e => e.tags?.includes('Tag') && e.journeys?.[journey.id] !== undefined).length === 4
+      ),
+      200,
+      25,
+    ),
+    passOnAnyResult,
+  ) 
+  await async_test(
+    `Background action queued for journey`, 
+    () => pollForResults(
+      sdk.api.automated_actions.getSome, 
+      as => (
+        as.filter(a => a.automationStepId === step.id && endusers.find(e => e.id === a.enduserId)).length === 4
+      ),
+      200,
+      25,
+    ),
+    passOnAnyResult,
+  )
+  await async_test(
+    `Endusers have trigger ids`, 
+    sdk.api.endusers.getSome,
+    { onResult: es => es.filter(e => e.triggerIds?.length === 2).length === 4 },
+  )
+
+
+  return await Promise.all([
+    sdk.api.journeys.deleteOne(journey.id),
+    sdk.api.automation_triggers.deleteOne(existsTriggerTags.id),
+    sdk.api.automation_triggers.deleteOne(existsTriggerAddToJourney.id),
+    sdk.api.automation_triggers.deleteOne(equalsTriggerAddToJourney.id),
+    sdk.api.automation_triggers.deleteOne(equalsTriggerTags.id),
+    sdk.api.automation_triggers.deleteOne(conditionalTriggerTags.id),
+    sdk.api.automation_triggers.deleteOne(conditionalTriggerAddToJourney.id),
+    ...endusers.map(e => sdk.api.endusers.deleteOne(e.id)),
+  ])
 }
 
 const NO_TEST = () => {}
@@ -5169,6 +5578,7 @@ const validate_schema = () => {
     await mfa_tests()
     await setup_tests()
     await multi_tenant_tests() // should come right after setup tests
+    await field_equals_trigger_tests()
     await test_ticket_automation_assignment_and_optimization()
     await role_based_access_tests()
     await automation_trigger_tests()

package/src/tests/webhooks_tests.ts

@@ -223,7 +223,7 @@ const endusers_tests = async (isSubscribed: boolean) => {
 
   const update = { assignedTo: [sdk.userInfo.id] }
   await sdk.api.endusers.updateOne(enduser.id, update)
-
+  await sdk.api.endusers.updateOne(enduser.id, { fields: { 'dontIncludeInWebhook': true } }, { dontSendWebhook: true })
   await check_next_webhook(
     a => {
       delete a.updates?.[0]?.recordBeforeUpdate.humanReadableId