fix(specs): event.status can be null

Author: millotp

scripts/cts/testServer/algoliaMock.ts

@@ -37,6 +37,18 @@ function addRoutes(app: Express): void {
       processingTimeMS: 0,
     });
   });
+
+  app.get('/1/runs/:runID/events/:eventID', (req, res) => {
+    res.json({
+      eventID: req.params.eventID,
+      runID: req.params.runID,
+      status: null,
+      type: 'log',
+      batchSize: 100,
+      data: null,
+      publishedAt: '2023-10-03T12:00:00Z',
+    });
+  });
 }
 
 export function algoliaMockServer(): Promise<Server> {

scripts/install.sh

@@ -19,7 +19,7 @@ apic() {
 export apic
 
 _list_languages() {
-  cat $ROOT/config/clients.config.json | jq -r 'keys[]'
+  cat $ROOT/config/clients.config.json | jq -r 'keys[] | select(. != "$schema")'
 }
 
 _list_languages_all() {

specs/ingestion/common/schemas/event.yml

@@ -18,8 +18,10 @@ Event:
       minimum: 0
       multipleOf: 1
     data:
-      type: object
-      additionalProperties: true
+      oneOf:
+        - type: object
+          additionalProperties: true
+        - type: 'null'
     publishedAt:
       $ref: './common.yml#/publishedAt'
   required:
@@ -31,8 +33,10 @@ Event:
     - publishedAt
 
 EventStatus:
-  type: string
-  enum: [created, started, retried, failed, succeeded, critical]
+  oneOf:
+    - type: string
+      enum: [created, started, retried, failed, succeeded, critical]
+    - type: 'null'
 
 EventType:
   type: string

templates/python/model_generic.mustache

@@ -12,7 +12,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
 {{> model_description}}
 
 {{#vars}}
-    {{name}}: {{^required}}Optional[{{/required}}{{{dataType}}}{{^required}}]{{/required}}{{^required}} = None{{/required}}
+    {{name}}: {{^required}}Optional[{{/required}}{{{dataType}}}{{#required}}{{#isNullable}} | None{{/isNullable}}{{/required}}{{^required}}]{{/required}}{{^required}} = None{{/required}}
     {{#description}}
     """ {{{.}}} """
     {{/description}}

tests/CTS/client/ingestion/api.json

@@ -102,7 +102,9 @@
         },
         "expected": {
           "type": "response",
-          "match": {"message":"OK"}
+          "match": {
+            "message": "OK"
+          }
         }
       }
     ]

tests/CTS/client/ingestion/getEvent.json

@@ -0,0 +1,41 @@
+[
+  {
+    "testName": "can deserialize an event",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "region": "us",
+          "customHosts": [
+            {
+              "port": 6686
+            }
+          ]
+        }
+      },
+      {
+        "type": "method",
+        "method": "getEvent",
+        "parameters": {
+          "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+          "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0a"
+        },
+        "expected": {
+          "type": "response",
+          "match": {
+            "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0a",
+            "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+            "status": null,
+            "type": "log",
+            "batchSize": 100,
+            "data": null,
+            "publishedAt": "2023-10-03T12:00:00Z"
+          }
+        }
+      }
+    ]
+  }
+]