allow geo information fields

Author: lindsey-volta

src/components/ga4/EventBuilder/ValidateEvent/schemas/baseContent.spec.ts

@@ -142,4 +142,16 @@ describe("baseContentSchema", () => {
 
         expect(validator.isValid(validInput)).toEqual(false)
     })
+
+    describe("with ip_override", () => {
+      test("is valid with a valid IPv4 address", () => {
+        const validInput = {
+          events: [{ name: "something", params: {} }],
+          ip_override: "127.0.0.1",
+        }
+        const validator = new Validator(baseContentSchema)
+        expect(validator.isValid(validInput)).toEqual(true)
+      })
+    })
+  
 })

src/components/ga4/EventBuilder/ValidateEvent/schemas/baseContent.ts

@@ -2,29 +2,34 @@
 
 import { userPropertiesSchema } from './userProperties'
 import { eventsSchema } from './events'
+import { userLocationSchema } from "./userLocation"
 
 export const baseContentSchema = {
-    "type": "object",
-    "required": ["events"],
-    "additionalProperties": false,
-    "properties": {
-        "app_instance_id": {
-            "type": "string",
-            "format": "app_instance_id"
-        },
-        "client_id": {
-            "type": "string",
-        },
-        "user_id": {
-            "type": "string"
-        },
-        "timestamp_micros": {
-            // "type": "number"
-        },
-        "user_properties": userPropertiesSchema,
-        "non_personalized_ads": {
-            "type": "boolean"
-        },
-        "events": eventsSchema,
-    }
+  type: "object",
+  required: ["events"],
+  additionalProperties: false,
+  properties: {
+    app_instance_id: {
+      type: "string",
+      format: "app_instance_id",
+    },
+    client_id: {
+      type: "string",
+    },
+    user_id: {
+      type: "string",
+    },
+    timestamp_micros: {
+      // "type": "number"
+    },
+    user_properties: userPropertiesSchema,
+    non_personalized_ads: {
+      type: "boolean",
+    },
+    events: eventsSchema,
+    user_location: userLocationSchema,
+    ip_override: {
+      type: "string",
+    },
+  },
 }

src/components/ga4/EventBuilder/ValidateEvent/schemas/userLocation.spec.ts

@@ -0,0 +1,84 @@
+import "jest"
+import { Validator } from "../validator"
+import { userLocationSchema } from "./userLocation"
+
+describe("userLocationSchema", () => {
+  test("can be used to validate a valid payload", () => {
+    const validInput = {
+      city: "Mountain View",
+      region_id: "US-CA",
+      country_id: "US",
+      subcontinent_id: "021",
+      continent_id: "019",
+    }
+    const validator = new Validator(userLocationSchema)
+    expect(validator.isValid(validInput)).toEqual(true)
+  })
+
+  test.each([["US-CA"], ["US-C"], ["US-C1A"]])(
+    "is valid with a valid region_id: %s",
+    region_id => {
+      const validator = new Validator(userLocationSchema)
+      expect(validator.isValid({ region_id })).toEqual(true)
+    }
+  )
+
+  test.each([["USA-CA"], ["US-CALI"], ["us-ca"], ["US_CA"]])(
+    "is invalid with an invalid region_id: %s",
+    region_id => {
+      const validator = new Validator(userLocationSchema)
+      expect(validator.isValid({ region_id })).toEqual(false)
+    }
+  )
+
+  test("is valid with a valid country_id", () => {
+    const validInput = { country_id: "US" }
+    const validator = new Validator(userLocationSchema)
+    expect(validator.isValid(validInput)).toEqual(true)
+  })
+
+  test.each([["USA"], ["U"], ["us"]])(
+    "is invalid with an invalid country_id: %s",
+    country_id => {
+      const validator = new Validator(userLocationSchema)
+      expect(validator.isValid({ country_id })).toEqual(false)
+    }
+  )
+
+  test("is valid with a valid subcontinent_id", () => {
+    const validInput = { subcontinent_id: "021" }
+    const validator = new Validator(userLocationSchema)
+    expect(validator.isValid(validInput)).toEqual(true)
+  })
+
+  test.each([["21"], ["0211"], ["abc"]])(
+    "is invalid with an invalid subcontinent_id: %s",
+    subcontinent_id => {
+      const validator = new Validator(userLocationSchema)
+      expect(validator.isValid({ subcontinent_id })).toEqual(false)
+    }
+  )
+
+  test("is valid with a valid continent_id", () => {
+    const validInput = { continent_id: "019" }
+    const validator = new Validator(userLocationSchema)
+    expect(validator.isValid(validInput)).toEqual(true)
+  })
+
+  test.each([["19"], ["0199"], ["abc"]])(
+    "is invalid with an invalid continent_id: %s",
+    continent_id => {
+      const validator = new Validator(userLocationSchema)
+      expect(validator.isValid({ continent_id })).toEqual(false)
+    }
+  )
+
+  test("is invalid with additional properties", () => {
+    const invalidInput = {
+      city: "Mountain View",
+      extra_prop: "should fail",
+    }
+    const validator = new Validator(userLocationSchema)
+    expect(validator.isValid(invalidInput)).toEqual(false)
+  })
+})

src/components/ga4/EventBuilder/ValidateEvent/schemas/userLocation.ts

@@ -0,0 +1,31 @@
+// User Location Schema
+
+export const userLocationSchema = {
+  type: "object",
+  additionalProperties: false,
+  properties: {
+    city: {
+      type: "string",
+    },
+    region_id: {
+      type: "string",
+      // ISO 3166-2
+      pattern: "^[A-Z]{2}-[A-Z0-9]{1,3}$",
+    },
+    country_id: {
+      type: "string",
+      // ISO 3166-1 alpha-2
+      pattern: "^[A-Z]{2}$",
+    },
+    subcontinent_id: {
+      type: "string",
+      // UN M49
+      pattern: "^[0-9]{3}$",
+    },
+    continent_id: {
+      type: "string",
+      // UN M49
+      pattern: "^[0-9]{3}$",
+    },
+  },
+}