feat(specs): add authenticatedUserToken and Identify to insights (#…

…2151)
algolia · Oct 23, 2023 · fa326a5 · fa326a5
1 parent 0ae420a
commit fa326a5
Show file tree

Hide file tree

Showing 17 changed files with 84 additions and 1 deletion.
diff --git a/.github/.cache_version b/.github/.cache_version
@@ -1 +1 @@
-0.0.97
+0.0.98
diff --git a/specs/insights/common/schemas/AddedToCartObjectIDs.yml b/specs/insights/common/schemas/AddedToCartObjectIDs.yml
@@ -24,6 +24,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'  
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/AddedToCartObjectIDsAfterSearch.yml b/specs/insights/common/schemas/AddedToCartObjectIDsAfterSearch.yml
@@ -25,6 +25,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'  
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ClickedFilters.yml b/specs/insights/common/schemas/ClickedFilters.yml
@@ -15,6 +15,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'  
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ClickedObjectIDsAfterSearch.yml b/specs/insights/common/schemas/ClickedObjectIDsAfterSearch.yml
@@ -24,6 +24,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ConvertedFilters.yml b/specs/insights/common/schemas/ConvertedFilters.yml
@@ -14,6 +14,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ConvertedObjectIDs.yml b/specs/insights/common/schemas/ConvertedObjectIDs.yml
@@ -19,6 +19,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ConvertedObjectIDsAfterSearch.yml b/specs/insights/common/schemas/ConvertedObjectIDsAfterSearch.yml
@@ -23,6 +23,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/EventAttributes.yml b/specs/insights/common/schemas/EventAttributes.yml
@@ -28,6 +28,11 @@ userToken:
     > **Note**: Never include personally identifiable information in user tokens.
   example: test-user-1
 
+authenticatedUserToken:
+  type: string
+  description: User token for authenticated users.
+  example: c6a52c02-d0c7-4b53-8ce3-2b8fd202f3f9
+
 timestamp:
   type: integer
   format: int64

diff --git a/specs/insights/common/schemas/EventsItems.yml b/specs/insights/common/schemas/EventsItems.yml
@@ -11,3 +11,4 @@ oneOf:
   - $ref: './AddedToCartObjectIDs.yml'
   - $ref: './PurchasedObjectIDs.yml'
   - $ref: './PurchasedObjectIDsAfterSearch.yml'
+  - $ref: './Identify.yml'
diff --git a/specs/insights/common/schemas/Identify.yml b/specs/insights/common/schemas/Identify.yml
@@ -0,0 +1,16 @@
+type: object
+title: Identify user 
+description: |
+  The identify event is a signal for Insights to process all events coming from 'userToken' as if they were from 'authenticatedUserToken'.
+properties:
+  eventType:
+    $ref: './IdentifyEvent.yml'
+    default: identify
+  userToken:
+    $ref: './EventAttributes.yml#/userToken'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
+required:
+  - eventType
+  - userToken
+  - authenticatedUserToken
diff --git a/specs/insights/common/schemas/IdentifyEvent.yml b/specs/insights/common/schemas/IdentifyEvent.yml
@@ -0,0 +1,2 @@
+type: string
+enum: [identify]
diff --git a/specs/insights/common/schemas/PurchasedObjectIDs.yml b/specs/insights/common/schemas/PurchasedObjectIDs.yml
@@ -24,6 +24,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/PurchasedObjectIDsAfterSearch.yml b/specs/insights/common/schemas/PurchasedObjectIDsAfterSearch.yml
@@ -25,6 +25,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ViewedFilters.yml b/specs/insights/common/schemas/ViewedFilters.yml
@@ -18,6 +18,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/specs/insights/common/schemas/ViewedObjectIDs.yml b/specs/insights/common/schemas/ViewedObjectIDs.yml
@@ -15,6 +15,8 @@ properties:
     $ref: './EventAttributes.yml#/userToken'
   timestamp:
     $ref: './EventAttributes.yml#/timestamp'
+  authenticatedUserToken:
+    $ref: './EventAttributes.yml#/authenticatedUserToken'
 required:
   - eventName
   - eventType

diff --git a/tests/CTS/methods/requests/insights/pushEvents.json b/tests/CTS/methods/requests/insights/pushEvents.json
@@ -7,6 +7,7 @@
           "eventName": "Product Clicked",
           "index": "products",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -30,6 +31,7 @@
             "eventName": "Product Clicked",
             "index": "products",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -54,6 +56,7 @@
           "eventName": "Product Purchased",
           "index": "products",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -66,6 +69,7 @@
           "eventName": "Product Detail Page Viewed",
           "index": "products",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -84,6 +88,7 @@
             "eventName": "Product Purchased",
             "index": "products",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -96,6 +101,7 @@
             "eventName": "Product Detail Page Viewed",
             "index": "products",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -115,6 +121,7 @@
           "eventName": "Product Purchased",
           "index": "products",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -134,6 +141,7 @@
             "eventName": "Product Purchased",
             "index": "products",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -154,6 +162,7 @@
           "eventName": "Product Detail Page Viewed",
           "index": "products",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -172,6 +181,7 @@
             "eventName": "Product Detail Page Viewed",
             "index": "products",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -193,6 +203,7 @@
           "index": "products",
           "queryID": "43b15df305339e827f0ac0bdc5ebcaa7",
           "userToken": "user-123456",
+          "authenticatedUserToken": "user-123456",
           "timestamp": 1641290601962,
           "objectIDs": [
             "9780545139700",
@@ -226,6 +237,7 @@
             "index": "products",
             "queryID": "43b15df305339e827f0ac0bdc5ebcaa7",
             "userToken": "user-123456",
+            "authenticatedUserToken": "user-123456",
             "timestamp": 1641290601962,
             "objectIDs": [
               "9780545139700",
@@ -248,5 +260,30 @@
         ]
       }
     }
+  },
+  {
+    "testName": "Identify",
+    "parameters": {
+      "events": [
+        {
+          "eventType": "identify",
+          "userToken": "anonymous-1",
+          "authenticatedUserToken": "authenticated-1"
+        }
+      ]
+    },
+    "request": {
+      "path": "/1/events",
+      "method": "POST",
+      "body": {
+        "events": [
+          {
+            "eventType": "identify",
+            "userToken": "anonymous-1",
+            "authenticatedUserToken": "authenticated-1"
+          }
+        ]
+      }
+    }
   }
 ]