@crvouga/atlas 1.17.0 → 1.18.0

package/packages/schema/schemas/report-run.schema.json

@@ -162,6 +162,12 @@
               "minimum": 0,
               "maximum": 9007199254740991,
               "description": "References that name no bytes, or bytes the layer does not hold"
+            },
+            "missing": {
+              "description": "Of `unavailable`, those that name a file the layer's bundle does not hold (stored, then gone). Absent when there are none",
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
             }
           },
           "required": [
@@ -171,6 +177,64 @@
           ],
           "additionalProperties": {}
         },
+        "recordings": {
+          "description": "Whether the recordings its layers expected were published, apart from its outcomes. Absent when no layer declared an expectation: its completeness is unknown, never complete. Matched by the `recordings` filter",
+          "type": "object",
+          "properties": {
+            "state": {
+              "type": "string",
+              "enum": [
+                "complete",
+                "incomplete",
+                "none-expected",
+                "unknown"
+              ],
+              "description": "`incomplete` when an expected recording was skipped or unresolved; else `unknown` when a layer declared no expectations; else `complete` when something was expected and `none-expected` when nothing was"
+            },
+            "expected": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "published": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Of the expected recordings, uploaded or referenced by address"
+            },
+            "skipped": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "unresolved": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "notApplicable": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "layersWithoutReceipt": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Layers of the run that declared no recording expectations: nothing is claimed for them"
+            }
+          },
+          "required": [
+            "state",
+            "expected",
+            "published",
+            "skipped",
+            "unresolved",
+            "notApplicable",
+            "layersWithoutReceipt"
+          ],
+          "additionalProperties": {}
+        },
         "attachments": {
           "description": "Files attached to the run itself, in its layers, not to a check. Absent when there are none",
           "type": "integer",
@@ -316,6 +380,10 @@
                   "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"
+                },
                 "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",
@@ -517,6 +585,12 @@
                 "minimum": 0,
                 "maximum": 9007199254740991,
                 "description": "References that name no bytes, or bytes the layer does not hold"
+              },
+              "missing": {
+                "description": "Of `unavailable`, those that name a file the layer's bundle does not hold (stored, then gone). Absent when there are none",
+                "type": "integer",
+                "exclusiveMinimum": 0,
+                "maximum": 9007199254740991
               }
             },
             "required": [

package/packages/schema/schemas/report-runs.schema.json

@@ -170,6 +170,12 @@
                 "minimum": 0,
                 "maximum": 9007199254740991,
                 "description": "References that name no bytes, or bytes the layer does not hold"
+              },
+              "missing": {
+                "description": "Of `unavailable`, those that name a file the layer's bundle does not hold (stored, then gone). Absent when there are none",
+                "type": "integer",
+                "exclusiveMinimum": 0,
+                "maximum": 9007199254740991
               }
             },
             "required": [
@@ -179,6 +185,64 @@
             ],
             "additionalProperties": {}
           },
+          "recordings": {
+            "description": "Whether the recordings its layers expected were published, apart from its outcomes. Absent when no layer declared an expectation: its completeness is unknown, never complete. Matched by the `recordings` filter",
+            "type": "object",
+            "properties": {
+              "state": {
+                "type": "string",
+                "enum": [
+                  "complete",
+                  "incomplete",
+                  "none-expected",
+                  "unknown"
+                ],
+                "description": "`incomplete` when an expected recording was skipped or unresolved; else `unknown` when a layer declared no expectations; else `complete` when something was expected and `none-expected` when nothing was"
+              },
+              "expected": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "published": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "Of the expected recordings, uploaded or referenced by address"
+              },
+              "skipped": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "unresolved": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "notApplicable": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "layersWithoutReceipt": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "Layers of the run that declared no recording expectations: nothing is claimed for them"
+              }
+            },
+            "required": [
+              "state",
+              "expected",
+              "published",
+              "skipped",
+              "unresolved",
+              "notApplicable",
+              "layersWithoutReceipt"
+            ],
+            "additionalProperties": {}
+          },
           "attachments": {
             "description": "Files attached to the run itself, in its layers, not to a check. Absent when there are none",
             "type": "integer",
@@ -419,6 +483,28 @@
             ],
             "additionalProperties": {}
           }
+        },
+        "recordings": {
+          "description": "Only for runs: `complete`, `incomplete`, `none-expected` and `unknown` with how many runs have each. Absent on servers that predate the filter",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "value": {
+                "type": "string"
+              },
+              "count": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "value",
+              "count"
+            ],
+            "additionalProperties": {}
+          }
         }
       },
       "required": [

package/packages/schema/schemas/review-collection.schema.json

@@ -196,6 +196,10 @@
                       "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"
+                    },
                     "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/review-manifest.schema.json

@@ -221,6 +221,10 @@
                       "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"
+                    },
                     "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/test-catalog.schema.json

@@ -1003,6 +1003,10 @@
                             "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"
+                          },
                           "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/test-history.schema.json

@@ -297,6 +297,10 @@
                           "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"
+                        },
                         "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 +972,10 @@
                       "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"
+                    },
                     "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": {}
+}