summaryrefslogtreecommitdiffstats
path: root/services/sync/tests/unit/sync_ping_schema.json
blob: a9866e35506a80ef0e0cc715cf5b0913b064e9ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "schema for Sync pings, documentation avaliable in toolkit/components/telemetry/docs/sync-ping.rst",
  "type": "object",
  "additionalProperties": false,
  "required": ["version", "syncs", "why", "uid"],
  "properties": {
    "version": { "type": "integer", "minimum": 0 },
    "os": { "type": "object" },
    "discarded": { "type": "integer", "minimum": 1 },
    "why": { "enum": ["shutdown", "schedule", "idchange"] },
    "uid": {
      "type": "string",
      "pattern": "^[0-9a-f]{32}$"
    },
    "deviceID": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "devices": {
      "type": "array",
      "items": { "$ref": "#/definitions/device" }
    },
    "sessionStartDate": { "type": "string" },
    "syncs": {
      "type": "array",
      "minItems": 0,
      "items": { "$ref": "#/definitions/payload" }
    },
    "syncNodeType": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "items": { "$ref": "#/definitions/event" }
    },
    "migrations": {
      "type": "array",
      "minItems": 1,
      "items": { "$ref": "#/definitions/migration" }
    },
    "histograms": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "min": { "type": "integer" },
          "max": { "type": "integer" },
          "histogram_type": { "type": "integer" },
          "sum": { "type": "integer" },
          "ranges": { "type": "array" },
          "counts": { "type": "array" }
        }
      }
    }
  },
  "definitions": {
    "payload": {
      "type": "object",
      "additionalProperties": false,
      "required": ["when", "took"],
      "properties": {
        "didLogin": { "type": "boolean" },
        "when": { "type": "integer" },
        "status": {
          "type": "object",
          "anyOf": [{ "required": ["sync"] }, { "required": ["service"] }],
          "additionalProperties": false,
          "properties": {
            "sync": { "type": "string" },
            "service": { "type": "string" }
          }
        },
        "why": { "type": "string" },
        "took": { "type": "integer", "minimum": -1 },
        "failureReason": { "$ref": "#/definitions/error" },
        "engines": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/definitions/engine" }
        }
      }
    },
    "device": {
      "required": ["id"],
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "id": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
        "os": { "type": "string" },
        "version": { "type": "string" },
        "type": { "type": "string" },
        "syncID": { "type": "string", "pattern": "^[0-9a-f]{64}$" }
      }
    },
    "engine": {
      "required": ["name"],
      "additionalProperties": false,
      "properties": {
        "failureReason": { "$ref": "#/definitions/error" },
        "name": { "type": "string" },
        "took": { "type": "integer", "minimum": 1 },
        "status": { "type": "string" },
        "incoming": {
          "type": "object",
          "additionalProperties": false,
          "anyOf": [{ "required": ["applied"] }, { "required": ["failed"] }],
          "properties": {
            "applied": { "type": "integer", "minimum": 1 },
            "failed": { "type": "integer", "minimum": 1 },
            "failedReasons": {
              "type": "array",
              "minItems": 1,
              "$ref": "#/definitions/namedCount"
            }
          }
        },
        "outgoing": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/definitions/outgoingBatch" }
        },
        "steps": {
          "type": "array",
          "minItems": 1,
          "$ref": "#/definitions/step"
        },
        "validation": {
          "type": "object",
          "additionalProperties": false,
          "anyOf": [
            { "required": ["checked"] },
            { "required": ["failureReason"] }
          ],
          "properties": {
            "checked": { "type": "integer", "minimum": 0 },
            "failureReason": { "$ref": "#/definitions/error" },
            "took": { "type": "integer" },
            "version": { "type": "integer" },
            "problems": {
              "type": "array",
              "minItems": 1,
              "$ref": "#/definitions/namedCount"
            }
          }
        }
      }
    },
    "outgoingBatch": {
      "type": "object",
      "additionalProperties": false,
      "anyOf": [{ "required": ["sent"] }, { "required": ["failed"] }],
      "properties": {
        "sent": { "type": "integer", "minimum": 1 },
        "failed": { "type": "integer", "minimum": 1 },
        "failedReasons": {
          "type": "array",
          "minItems": 1,
          "$ref": "#/definitions/namedCount"
        }
      }
    },
    "event": {
      "type": "array",
      "minItems": 4,
      "maxItems": 6
    },
    "migration": {
      "oneOf": [{ "$ref": "#/definitions/webextMigration" }]
    },
    "webextMigration": {
      "required": ["type"],
      "properties": {
        "type": { "enum": ["webext-storage"] },
        "entries": { "type": "integer" },
        "entriesSuccessful": { "type": "integer" },
        "extensions": { "type": "integer" },
        "extensionsSuccessful": { "type": "integer" },
        "openFailure": { "type": "boolean" }
      }
    },
    "error": {
      "oneOf": [
        { "$ref": "#/definitions/httpError" },
        { "$ref": "#/definitions/nsError" },
        { "$ref": "#/definitions/shutdownError" },
        { "$ref": "#/definitions/authError" },
        { "$ref": "#/definitions/otherError" },
        { "$ref": "#/definitions/unexpectedError" },
        { "$ref": "#/definitions/sqlError" }
      ]
    },
    "httpError": {
      "required": ["name", "code"],
      "properties": {
        "name": { "enum": ["httperror"] },
        "code": { "type": "integer" }
      }
    },
    "nsError": {
      "required": ["name", "code"],
      "properties": {
        "name": { "enum": ["nserror"] },
        "code": { "type": "integer" }
      }
    },
    "shutdownError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["shutdownerror"] }
      }
    },
    "authError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["autherror"] },
        "from": { "enum": ["tokenserver", "fxaccounts", "hawkclient"] }
      }
    },
    "otherError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["othererror"] },
        "error": { "type": "string" }
      }
    },
    "unexpectedError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["unexpectederror"] },
        "error": { "type": "string" }
      }
    },
    "sqlError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["sqlerror"] },
        "code": { "type": "integer" }
      }
    },
    "step": {
      "required": ["name"],
      "properties": {
        "name": { "type": "string" },
        "took": { "type": "integer", "minimum": 1 },
        "counts": {
          "type": "array",
          "minItems": 1,
          "$ref": "#/definitions/namedCount"
        }
      }
    },
    "namedCount": {
      "required": ["name", "count"],
      "properties": {
        "name": { "type": "string" },
        "count": { "type": "integer" }
      }
    }
  }
}