@hypequery/protocol-conformance 0.16.2 → 0.17.0

package/fixtures/client-contract-v1/relations.json

@@ -35,6 +35,26 @@
       "sameContentHash": false
     }
   },
+  {
+    "id": "annotations-do-not-change-schema",
+    "left": "build",
+    "right": "annotated",
+    "sameEndpointSchemas": [
+      "countries",
+      "orders",
+      "ordersRevenue"
+    ],
+    "sameContentHash": false,
+    "mode": "relation",
+    "expected": {
+      "sameEndpointSchemas": [
+        "countries",
+        "orders",
+        "ordersRevenue"
+      ],
+      "sameContentHash": false
+    }
+  },
   {
     "id": "empty-view-has-no-tools",
     "contract": "empty",

package/fixtures/client-contract-v1/success.json

@@ -692,5 +692,399 @@
       ],
       "contentHash": "c350b9b6e0351acbbac7509bf5d889afa343b9fb5048d826265d8e9f5ef895d8"
     }
+  },
+  {
+    "id": "annotated",
+    "value": {
+      "kind": "hypequery-client-contract",
+      "version": 1,
+      "view": "build",
+      "endpoints": [
+        {
+          "id": "countries",
+          "kind": "dataset",
+          "dataset": "countries",
+          "path": "/api/v1/datasets/countries/query",
+          "dimensions": {
+            "country": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": false,
+              "groupable": true,
+              "orderable": true
+            }
+          },
+          "measures": {},
+          "filters": {},
+          "time": null,
+          "defaultMeasures": [],
+          "metadata": false,
+          "limits": {
+            "defaultLimit": 100,
+            "maxLimit": 1000,
+            "maxOffset": 10000,
+            "maxDimensions": 50,
+            "maxMeasures": 0,
+            "maxPredicates": 0,
+            "maxOrderBy": 50,
+            "maxFilterValues": 1000
+          },
+          "annotations": {
+            "label": "Countries",
+            "description": "Reference list of supported countries."
+          },
+          "schemaHash": "9a5f50cd7564f283d2f0ee8f3f1cdc27731683c939e176bd25919a83d28d94ca"
+        },
+        {
+          "id": "orders",
+          "kind": "dataset",
+          "dataset": "orders",
+          "path": "/api/v1/datasets/orders/query",
+          "dimensions": {
+            "country": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": false,
+              "groupable": true,
+              "orderable": true
+            },
+            "amount": {
+              "type": "number",
+              "wireType": "number-or-string",
+              "nullable": "unknown",
+              "groupable": true,
+              "orderable": true
+            },
+            "customer.tier": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": true,
+              "groupable": true,
+              "orderable": true
+            },
+            "customer.active": {
+              "type": "boolean",
+              "wireType": "boolean",
+              "nullable": true,
+              "groupable": false,
+              "orderable": false
+            }
+          },
+          "measures": {
+            "revenue": {
+              "wireType": "string",
+              "nullable": true,
+              "having": true
+            },
+            "orderCount": {
+              "wireType": "string",
+              "nullable": true,
+              "having": true
+            },
+            "averageRevenue": {
+              "wireType": "string",
+              "nullable": true,
+              "having": true
+            },
+            "customer.unique": {
+              "wireType": "string",
+              "nullable": true,
+              "having": true
+            },
+            "latestLabel": {
+              "wireType": "string",
+              "nullable": true,
+              "having": false
+            }
+          },
+          "filters": {
+            "country": {
+              "type": "string",
+              "operators": [
+                "eq",
+                "in",
+                "like",
+                "neq",
+                "notIn"
+              ]
+            },
+            "amount": {
+              "type": "number",
+              "operators": [
+                "between",
+                "eq",
+                "gt",
+                "gte",
+                "in",
+                "lt",
+                "lte",
+                "neq",
+                "notIn"
+              ]
+            },
+            "customer.tier": {
+              "type": "string",
+              "operators": [
+                "eq",
+                "in"
+              ]
+            },
+            "customer.active": {
+              "type": "boolean",
+              "operators": [
+                "eq",
+                "neq"
+              ]
+            },
+            "paidStatus": {
+              "type": "string",
+              "operators": [
+                "eq"
+              ]
+            }
+          },
+          "time": {
+            "grains": [
+              "day",
+              "hour",
+              "month",
+              "week"
+            ],
+            "defaultTimezone": "UTC",
+            "timezone": true,
+            "periodFormat": "calendar-date-or-local-datetime-v1"
+          },
+          "defaultMeasures": [
+            "revenue",
+            "orderCount",
+            "latestLabel"
+          ],
+          "metadata": true,
+          "limits": {
+            "defaultLimit": 100,
+            "maxLimit": 1000,
+            "maxOffset": 10000,
+            "maxDimensions": 50,
+            "maxMeasures": 50,
+            "maxPredicates": 100,
+            "maxOrderBy": 50,
+            "maxFilterValues": 1000
+          },
+          "annotations": {
+            "label": "Orders",
+            "description": "One row per customer order.",
+            "fields": {
+              "country": {
+                "label": "Country"
+              },
+              "customer.tier": {
+                "description": "Tier of the ordering customer."
+              },
+              "revenue": {
+                "label": "Revenue",
+                "description": "Gross order value in €, before refunds."
+              }
+            }
+          },
+          "schemaHash": "88802c0d4798fd0758b7e7697f582b034afada967bfe0fdcb1cafd957144b1f3"
+        },
+        {
+          "id": "ordersRevenue",
+          "kind": "metric",
+          "dataset": "orders",
+          "path": "/api/v1/metrics/revenue",
+          "dimensions": {
+            "country": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": false,
+              "groupable": true,
+              "orderable": true
+            },
+            "customer.tier": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": true,
+              "groupable": true,
+              "orderable": true
+            },
+            "customer.active": {
+              "type": "boolean",
+              "wireType": "boolean",
+              "nullable": true,
+              "groupable": false,
+              "orderable": false
+            }
+          },
+          "measures": {
+            "revenue": {
+              "wireType": "string",
+              "nullable": true,
+              "having": false
+            }
+          },
+          "filters": {
+            "country": {
+              "type": "string",
+              "operators": [
+                "eq",
+                "in",
+                "like",
+                "neq",
+                "notIn"
+              ]
+            },
+            "amount": {
+              "type": "number",
+              "operators": [
+                "between",
+                "eq",
+                "gt",
+                "gte",
+                "in",
+                "lt",
+                "lte",
+                "neq",
+                "notIn"
+              ]
+            },
+            "customer.tier": {
+              "type": "string",
+              "operators": [
+                "eq",
+                "in"
+              ]
+            },
+            "customer.active": {
+              "type": "boolean",
+              "operators": [
+                "eq",
+                "neq"
+              ]
+            },
+            "paidStatus": {
+              "type": "string",
+              "operators": [
+                "eq"
+              ]
+            }
+          },
+          "time": {
+            "grains": [
+              "day",
+              "hour",
+              "month",
+              "week"
+            ],
+            "defaultTimezone": "UTC",
+            "timezone": true,
+            "periodFormat": "calendar-date-or-local-datetime-v1"
+          },
+          "metadata": true,
+          "limits": {
+            "defaultLimit": 20,
+            "maxLimit": 20,
+            "maxOffset": 10000,
+            "maxDimensions": 50,
+            "maxMeasures": 1,
+            "maxPredicates": 100,
+            "maxOrderBy": 50,
+            "maxFilterValues": 1000
+          },
+          "annotations": {
+            "label": "Orders",
+            "description": "One row per customer order.",
+            "fields": {
+              "revenue": {
+                "label": "Revenue",
+                "description": "Gross order value in €, before refunds."
+              }
+            }
+          },
+          "schemaHash": "e282fb74777e65328d87cfe5caa0349104630cd88137b1842289e0c83676a98d"
+        }
+      ],
+      "contentHash": "1cc64833994d5da761e9dae3b62992f66b6a270f01228ab97d91ebb74e54ae85"
+    }
+  },
+  {
+    "id": "null-checks",
+    "value": {
+      "kind": "hypequery-client-contract",
+      "version": 1,
+      "view": "build",
+      "endpoints": [
+        {
+          "id": "customers",
+          "kind": "dataset",
+          "dataset": "customers",
+          "path": "/api/v1/datasets/customers/query",
+          "dimensions": {
+            "plan": {
+              "type": "string",
+              "wireType": "string",
+              "nullable": true,
+              "groupable": true,
+              "orderable": true
+            }
+          },
+          "measures": {
+            "customerCount": {
+              "wireType": "string",
+              "nullable": true,
+              "having": true
+            }
+          },
+          "filters": {
+            "churnedAt": {
+              "type": "timestamp",
+              "operators": [
+                "gte",
+                "isNotNull",
+                "isNull"
+              ]
+            },
+            "plan": {
+              "type": "string",
+              "operators": [
+                "eq",
+                "isNull"
+              ]
+            },
+            "seats": {
+              "type": "number",
+              "operators": [
+                "isNotNull"
+              ]
+            },
+            "trial": {
+              "type": "boolean",
+              "operators": [
+                "eq",
+                "isNotNull",
+                "isNull"
+              ]
+            }
+          },
+          "time": null,
+          "metadata": false,
+          "limits": {
+            "defaultLimit": 100,
+            "maxLimit": 1000,
+            "maxOffset": 10000,
+            "maxDimensions": 50,
+            "maxMeasures": 50,
+            "maxPredicates": 100,
+            "maxOrderBy": 50,
+            "maxFilterValues": 1000
+          },
+          "defaultMeasures": [
+            "customerCount"
+          ],
+          "schemaHash": "67821b626e7688afa43c6598893a736854b658924e4564361b1db8bcd1f3192d"
+        }
+      ],
+      "contentHash": "08e3b75129b0f8c528d7dc25ba19ecf7472b5ef2a152655d3181c21e41f2e5c1"
+    }
   }
 ]

package/fixtures/deployments-v2/README.md

@@ -16,3 +16,7 @@ before being recorded; none of them changed either implementation's behaviour.
 
 RFC 0016 added composite relationship keys: the `composite-relationship-keys`
 success and identity cases, and the `relationship-keys-*` rejections.
+
+RFC 0023 added null checks: the `null-checks` success and identity cases (measure
+filters and filter operator lists), and rejections for a null check with a
+`right` operand, a value comparison without one, and an unknown operator.

package/fixtures/deployments-v2/identity.json

@@ -33,5 +33,10 @@
     "id": "merge-measures",
     "canonical": "{\"datasets\":[{\"dimensions\":[{\"filterable\":true,\"groupable\":true,\"name\":\"day\",\"source\":{\"column\":\"day\",\"kind\":\"column\"},\"type\":\"timestamp\"}],\"filters\":[],\"measures\":[{\"aggregation\":\"merge\",\"field\":\"users\",\"filters\":[],\"name\":\"active_users\",\"stateFunction\":\"uniq\"},{\"aggregation\":\"merge\",\"field\":\"events\",\"filters\":[],\"name\":\"events\",\"stateFunction\":\"sum\"}],\"name\":\"daily_active_users\",\"relationships\":[],\"source\":\"daily_active_users\",\"tenant\":{\"kind\":\"not-required\"}}],\"kind\":\"hypequery-deployment\",\"version\":2}",
     "sha256": "525e0df757d4056b1f370ae3666b56fc7ac9e18346506ade77a63b8968ba16da"
+  },
+  {
+    "id": "null-checks",
+    "canonical": "{\"datasets\":[{\"dimensions\":[{\"filterable\":true,\"groupable\":true,\"name\":\"plan\",\"source\":{\"column\":\"plan\",\"kind\":\"column\"},\"type\":\"string\"},{\"filterable\":true,\"groupable\":true,\"name\":\"churnedAt\",\"source\":{\"column\":\"churned_at\",\"kind\":\"column\"},\"type\":\"timestamp\"},{\"filterable\":true,\"groupable\":true,\"name\":\"trial\",\"source\":{\"column\":\"trial\",\"kind\":\"column\"},\"type\":\"boolean\"}],\"filters\":[{\"field\":\"churnedAt\",\"name\":\"churnedAt\",\"operators\":[\"gte\",\"isNotNull\",\"isNull\"]},{\"field\":\"trial\",\"name\":\"trial\",\"operators\":[\"eq\",\"isNull\"]}],\"measures\":[{\"aggregation\":\"count\",\"field\":\"id\",\"filters\":[{\"kind\":\"comparison\",\"left\":{\"kind\":\"reference\",\"name\":\"churned_at\"},\"operator\":\"isNotNull\"}],\"name\":\"churnedCustomers\"},{\"aggregation\":\"count\",\"field\":\"id\",\"filters\":[{\"kind\":\"comparison\",\"left\":{\"kind\":\"reference\",\"name\":\"churned_at\"},\"operator\":\"isNull\"},{\"kind\":\"comparison\",\"left\":{\"kind\":\"reference\",\"name\":\"trial\"},\"operator\":\"eq\",\"right\":{\"kind\":\"literal\",\"value\":false}}],\"name\":\"activeCustomers\"}],\"name\":\"customers\",\"relationships\":[],\"source\":\"customers\",\"tenant\":{\"kind\":\"not-required\"}}],\"kind\":\"hypequery-deployment\",\"version\":2}",
+    "sha256": "92690d7dfdb8a948ea705b24464b420e097c2a8b711ac9d26d0e3e99c24913a7"
   }
 ]