@tellescope/sdk 1.38.3 → 1.38.4

package/src/tests/tests.ts

@@ -1080,10 +1080,10 @@ const sms_tests = async (queries=sdk.api.sms_messages) => {
     () => queries.createOne(testSMS), 
     { onResult: t => !!t }
   )
-  testSMS.message = "(Multi-Send)"
+  testSMS.message = "(Multi-Send)" // sending 3 or more will exceed rate limit of 3-per-3 seconds
   await async_test(
     `send-sms (multiple)`, 
-    () => queries.createSome([ testSMS, testSMS, testSMS ]), 
+    () => queries.createSome([ testSMS, testSMS ]), 
     { onResult: t => !!t }
   )
 
@@ -4223,6 +4223,107 @@ const wait_for_trigger_tests = async () => {
   // double-check that wait for trigger step triggers were deleted
 }
 
+
+const handleRateLimitError = { shouldError: true, onError: (e: { message: string }) => e.message === 'Rate limit exceeded'}
+const rate_limit_tests = async () => {
+  log_header("Rate Limits")
+
+  const [e1, e2] = (await sdk.api.endusers.createSome([
+    { fname: '1', email: 'e1@tellescope.com', phone: '+15555555555' },
+    { fname: '2', email: 'e2@tellescope.com', phone: '+15555555555' },
+  ])).created
+
+  await async_test(
+    "Same template email rate limit 1-per-minute",
+    () => sdk.api.emails.createSome([
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', templateId: PLACEHOLDER_ID },
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', templateId: PLACEHOLDER_ID },
+    ]),
+    handleRateLimitError
+  )
+
+  // these should work, as 1 each is safe
+  const [email1, email2] = (await sdk.api.emails.createSome([
+    { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', templateId: PLACEHOLDER_ID },
+    { logOnly: true, enduserId: e2.id, subject: 'ratelimit', textContent: 'rate limit', templateId: PLACEHOLDER_ID },
+  ])).created
+  // already has 1 created 
+  await async_test(
+    "Same enduser rate limit 5 per 5 seconds",
+    () => sdk.api.emails.createSome([
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', },
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', },
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', },
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', },
+      { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit' },
+    ]),
+    handleRateLimitError
+  )
+
+  await wait(undefined, 2500) // give it some time before trying again, to ensure still blocked after 2.5 < 60 seconds
+  await async_test(
+    "Same template email rate limit 1-per-minute after creating",
+    () => sdk.api.emails.createOne({
+      logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit', templateId: PLACEHOLDER_ID
+    }),
+    handleRateLimitError
+  )
+
+
+  await async_test(
+    "Same template sms rate limit 1-per-minute",
+    () => sdk.api.sms_messages.createSome([
+      { logOnly: true, enduserId: e1.id, templateId: PLACEHOLDER_ID, message: 'hi' },
+      { logOnly: true, enduserId: e1.id, templateId: PLACEHOLDER_ID, message: 'hi' },
+    ]),
+    handleRateLimitError
+  )
+
+  // these should work, as 1 each is safe
+  const [sms1, sms2] = (await sdk.api.sms_messages.createSome([
+    { logOnly: true, enduserId: e1.id, templateId: PLACEHOLDER_ID, message: 'hi' },
+    { logOnly: true, enduserId: e2.id, templateId: PLACEHOLDER_ID, message: 'hi' },
+  ])).created
+  // already has 1 created, so 3 new should error (4 > 3)
+  await async_test(
+    "Same enduser sms rate limit 3 per 3 seconds",
+    () => sdk.api.sms_messages.createSome([
+      { logOnly: true, enduserId: e1.id, message: 'hi' },
+      { logOnly: true, enduserId: e1.id, message: 'hi' },
+      { logOnly: true, enduserId: e1.id, message: 'hi' },
+    ]),
+    handleRateLimitError
+  )
+
+  await wait(undefined, 2500) // give it some time before trying again, to ensure still blocked after 2.5 < 60 seconds
+  await async_test(
+    "Same template sms rate limit 1-per-minute after creating",
+    () => sdk.api.sms_messages.createOne({ 
+      logOnly: true, enduserId: e2.id, templateId: PLACEHOLDER_ID, message: 'hi' 
+    }),
+    handleRateLimitError
+  )
+
+  // these should work, as they do not have the same template
+  const [email3, email4, email5] = (await sdk.api.emails.createSome([
+    { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit' },
+    { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit' },
+    { logOnly: true, enduserId: e1.id, subject: 'ratelimit', textContent: 'rate limit' },
+  ])).created
+ 
+  await Promise.all([
+    sdk.api.endusers.deleteOne(e1.id),
+    sdk.api.endusers.deleteOne(e2.id),
+    sdk.api.emails.deleteOne(email1.id),
+    sdk.api.emails.deleteOne(email2.id),
+    sdk.api.emails.deleteOne(email3.id),
+    sdk.api.emails.deleteOne(email4.id),
+    sdk.api.emails.deleteOne(email5.id),
+    sdk.api.sms_messages.deleteOne(sms1.id),
+    sdk.api.sms_messages.deleteOne(sms2.id),
+  ])
+}
+
 const NO_TEST = () => {}
 const tests: { [K in keyof ClientModelForName]: () => void } = {
   phone_trees: NO_TEST,
@@ -4299,6 +4400,7 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
     ]) 
     await setup_tests()
     await multi_tenant_tests() // should come right after setup tests
+    await rate_limit_tests()
     await role_based_access_tests()
     await wait_for_trigger_tests()
     await merge_enduser_tests()