@crvouga/atlas 1.17.0 → 1.19.0

package/packages/schema/schemas/test-history.schema.json

@@ -297,6 +297,19 @@
                           "type": "boolean",
                           "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                         },
+                        "reason": {
+                          "description": "Why it is unavailable, when the report can tell: `not-in-bundle` is a file the layer names but does not hold (stored, then gone). An open vocabulary: treat an unknown reason as plain unavailable",
+                          "type": "string"
+                        },
+                        "durationMs": {
+                          "description": "How long the recording is, in milliseconds, as its producer declared it: a hint to show before the file is opened, never a latency. Absent when none was declared, and in documents of older servers",
+                          "type": "number",
+                          "minimum": 0
+                        },
+                        "poster": {
+                          "description": "The bundle key, in the same layer, of the image the producer named as this recording's poster: a hint to show before the file is opened. Absent when there is none or the layer's bundle does not hold it, and in documents of older servers",
+                          "type": "string"
+                        },
                         "scope": {
                           "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
                           "type": "object",
@@ -968,6 +981,19 @@
                       "type": "boolean",
                       "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                     },
+                    "reason": {
+                      "description": "Why it is unavailable, when the report can tell: `not-in-bundle` is a file the layer names but does not hold (stored, then gone). An open vocabulary: treat an unknown reason as plain unavailable",
+                      "type": "string"
+                    },
+                    "durationMs": {
+                      "description": "How long the recording is, in milliseconds, as its producer declared it: a hint to show before the file is opened, never a latency. Absent when none was declared, and in documents of older servers",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "poster": {
+                      "description": "The bundle key, in the same layer, of the image the producer named as this recording's poster: a hint to show before the file is opened. Absent when there is none or the layer's bundle does not hold it, and in documents of older servers",
+                      "type": "string"
+                    },
                     "scope": {
                       "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
                       "type": "object",

package/packages/schema/schemas/verify-recordings-result.schema.json

@@ -0,0 +1,97 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/verify-recordings-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "description": "True when no layer has a gap and every layer could be read (otherwise the exit code is 1). Test results are unaffected either way"
+    },
+    "layers": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Layers examined"
+    },
+    "checked": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Videos read back from the store (those that name a bundle key)"
+    },
+    "verified": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Of those, the ones that passed every check"
+    },
+    "referenced": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "Videos given only by address, which Atlas holds no bytes for and does not check"
+    },
+    "gaps": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "layer": {
+            "type": "string",
+            "description": "The layer that holds the video"
+          },
+          "check": {
+            "description": "The check that holds it, or null for a video attached to the layer or a part",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "name": {
+            "type": "string",
+            "description": "The attachment's name"
+          },
+          "bundleKey": {
+            "type": "string",
+            "description": "Its key in the layer's bundle (`attachments/<sha256>`)"
+          },
+          "problem": {
+            "type": "string",
+            "description": "`not-in-bundle` (the layer names a file its bundle does not list), `blob-missing` (a blob holding it is gone: a 404 when played), `unreadable` (the store could not be read: not proof it is gone), `size-mismatch`, `checksum-mismatch` or `undecodable` (empty, or not the container its media type names). An open vocabulary: treat an unknown problem as a gap"
+          },
+          "reason": {
+            "type": "string",
+            "description": "A short explanation without tokens, paths or payload"
+          }
+        },
+        "required": [
+          "layer",
+          "check",
+          "name",
+          "bundleKey",
+          "problem",
+          "reason"
+        ],
+        "additionalProperties": {}
+      },
+      "description": "Every video that is missing, unreadable, corrupt or not the container it claims. Re-publish the layer's recordings to repair them"
+    },
+    "notices": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Layers that could not be read at all: their recordings are unknown, never verified"
+    }
+  },
+  "required": [
+    "ok",
+    "layers",
+    "checked",
+    "verified",
+    "referenced",
+    "gaps",
+    "notices"
+  ],
+  "additionalProperties": {}
+}