Adds AJV timezone validation to client API (#616)

parcelvoy · Jan 20, 2025 · c24e37c · c24e37c
1 parent e14155b
commit c24e37c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 6 deletions.
diff --git a/apps/platform/src/campaigns/Campaign.ts b/apps/platform/src/campaigns/Campaign.ts
@@ -4,7 +4,7 @@ import Model, { ModelParams } from '../core/Model'
 import List from '../lists/List'
 import Template from '../render/Template'
 import Subscription from '../subscriptions/Subscription'
-import { crossTimezoneCopy, isValidIANATimezone } from '../utilities'
+import { crossTimezoneCopy } from '../utilities'
 import Project from '../projects/Project'
 import { User } from '../users/User'
 
@@ -77,9 +77,6 @@ export class CampaignSend extends Model {
         project: Pick<Project, 'timezone'>,
         user: Pick<User, 'id' | 'timezone'>,
     ): CampaignSendParams {
-        const timezone = isValidIANATimezone(user.timezone)
-            ? user.timezone
-            : project.timezone
         return {
             user_id: user.id,
             campaign_id: campaign.id,
@@ -88,7 +85,7 @@ export class CampaignSend extends Model {
                 ? crossTimezoneCopy(
                     campaign.send_at,
                     project.timezone,
-                    timezone ?? project.timezone,
+                    user.timezone ?? project.timezone,
                 )
                 : campaign.send_at,
         }

diff --git a/apps/platform/src/client/ClientController.ts b/apps/platform/src/client/ClientController.ts
@@ -68,7 +68,11 @@ const identifyParams: JSONSchemaType<ClientIdentifyParams> = {
         },
         timezone: {
             type: 'string',
+            format: 'timezone',
             nullable: true,
+            errorMessage: {
+                format: 'The timezone value must be in the IANA format.',
+            },
         },
         locale: {
             type: 'string',

diff --git a/apps/platform/src/core/validate.ts b/apps/platform/src/core/validate.ts
@@ -1,14 +1,20 @@
 import Ajv, { ErrorObject, JSONSchemaType } from 'ajv'
 import addFormats from 'ajv-formats'
 import addErrors from 'ajv-errors'
-import { capitalizeFirstLetter } from '../utilities'
+import { capitalizeFirstLetter, isValidIANATimezone } from '../utilities'
 import { RequestError } from './errors'
 
 type IsValidSchema = [boolean, Error | undefined]
 
 const validator = new Ajv({ allErrors: true })
 addFormats(validator)
 addErrors(validator)
+validator.addFormat('timezone', {
+    type: 'string',
+    validate: (timezone: string) => {
+        return isValidIANATimezone(timezone)
+    },
+})
 
 export { JSONSchemaType, IsValidSchema, validator }