@dyno-cloud/schema 0.0.0-stage → 0.1.2

package/json/dyno-toml.schema.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LinkFile",
+  "description": "A link file: one `[[game]]` table per build folder.",
+  "type": "object",
+  "properties": {
+    "build": {
+      "description": "How CI makes the build folders. dyno does not run it.",
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BuildCommand"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "game": {
+      "description": "One `[[game]]` table per build folder.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "#/$defs/LinkedGame"
+      }
+    },
+    "schema_version": {
+      "description": "The file format version. Must equal the schema version this dyno reads.",
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "schema_version"
+  ],
+  "$defs": {
+    "BuildCommand": {
+      "description": "How CI makes the build folders, such as the workflow that the dyno site's setup pull request\nwrites. dyno does not run it.",
+      "type": "object",
+      "properties": {
+        "command": {
+          "description": "The shell command that makes every build folder from a fresh checkout, run in this file's\nfolder.",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "command"
+      ]
+    },
+    "LinkedGame": {
+      "description": "One build folder and the game it belongs to.",
+      "type": "object",
+      "properties": {
+        "build": {
+          "description": "The build folder or .zip, relative to this file. Unique in the file.",
+          "type": "string"
+        },
+        "id": {
+          "description": "The game's id on the dyno site, a UUID.",
+          "type": "string"
+        },
+        "name": {
+          "description": "The game's name: the `--game` label when none is given.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "build"
+      ]
+    }
+  }
+}

package/json/exposure-checkpoint.schema.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ExposureCheckpoint",
+  "description": "Sampled exposure, written to storage every 30 s or so and sent on the next load. A page\nthat dies loses only the time since its last checkpoint.",
+  "type": "object",
+  "properties": {
+    "host_profile": {
+      "$ref": "#/$defs/ProfileRef"
+    },
+    "samples": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/ExposureSample"
+      }
+    },
+    "schema_version": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    }
+  },
+  "required": [
+    "schema_version",
+    "host_profile",
+    "samples"
+  ],
+  "$defs": {
+    "ExposureSample": {
+      "description": "Live time for one game frame in one state.",
+      "type": "object",
+      "properties": {
+        "build_version": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "frame_state": {
+          "$ref": "#/$defs/FrameState"
+        },
+        "game_id": {
+          "type": "string"
+        },
+        "live_ms": {
+          "description": "Time the frame was live in this state.",
+          "type": "integer",
+          "format": "uint64",
+          "minimum": 0
+        },
+        "sampled_share": {
+          "description": "The share of sessions that log exposure, from above 0 to 1.",
+          "type": "number",
+          "format": "double"
+        }
+      },
+      "required": [
+        "game_id",
+        "frame_state",
+        "live_ms",
+        "sampled_share"
+      ]
+    },
+    "FrameState": {
+      "description": "Whether a game frame is the one on screen. Reels calls an inactive frame preloaded.",
+      "oneOf": [
+        {
+          "description": "On screen, after the host's active message.",
+          "type": "string",
+          "const": "active"
+        },
+        {
+          "description": "Mounted but not on screen.",
+          "type": "string",
+          "const": "inactive"
+        }
+      ]
+    },
+    "ProfileRef": {
+      "description": "Which host profile, and which version of it, a result used.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "version": {
+          "type": "integer",
+          "format": "uint32",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "name",
+        "version"
+      ]
+    }
+  }
+}

package/json/games.schema.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "GamesFile",
+  "description": "A games file: the games a catalogue run checks.",
+  "type": "object",
+  "properties": {
+    "game": {
+      "description": "One `[[game]]` table per game.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/GameEntry"
+      }
+    },
+    "schema_version": {
+      "description": "The file format version. Must equal the schema version this dyno reads.",
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "game"
+  ],
+  "$defs": {
+    "GameEntry": {
+      "description": "One game in a games file. It needs a build, a launch URL or both.",
+      "type": "object",
+      "properties": {
+        "build": {
+          "description": "The build folder or .zip, relative to the games file.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null
+        },
+        "id": {
+          "description": "Unique in the file. Shards split the games in id order.",
+          "type": "string"
+        },
+        "launch_url": {
+          "description": "An http or https URL, checked when the file loads.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null
+        },
+        "release": {
+          "description": "The release version label for the result.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ]
+    }
+  }
+}

package/json/library-bucket.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "LibraryBucket",
+  "description": "What a library does. Only the rendering bucket says how the game draws.",
+  "oneOf": [
+    {
+      "description": "Draws the game, such as Pixi.",
+      "type": "string",
+      "const": "rendering"
+    },
+    {
+      "description": "Plays sound, such as Howler.",
+      "type": "string",
+      "const": "audio"
+    },
+    {
+      "description": "Anything else, such as an SDK or a utility.",
+      "type": "string",
+      "const": "other"
+    }
+  ]
+}

package/json/library.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Library",
+  "description": "A library the static scan can detect.",
+  "oneOf": [
+    {
+      "type": "string",
+      "enum": [
+        "pixi",
+        "howler"
+      ]
+    },
+    {
+      "description": "StakeEngine's web-sdk. It bundles its own Pixi, which the scan detects as Pixi.",
+      "type": "string",
+      "const": "web_sdk"
+    }
+  ]
+}

package/json/measures.json

@@ -0,0 +1,407 @@
+[
+  {
+    "id": "static.inventory.files",
+    "source": "static",
+    "phase": 1,
+    "unit": "count",
+    "covers": "supplied_files",
+    "quantity": "files",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bytes.by_type",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "download_bytes",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bytes.compressed",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "compressed_bytes",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bytes.duplicates",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "duplicate_bytes",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.textures.decoded",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "textures",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.audio.decoded_48k",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "audio",
+    "statistic": "all_files_at48k"
+  },
+  {
+    "id": "static.audio.decoded_24k",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "audio",
+    "statistic": "all_files_at24k"
+  },
+  {
+    "id": "static.audio.stereo_files",
+    "source": "static",
+    "phase": 1,
+    "unit": "count",
+    "covers": "supplied_files",
+    "quantity": "stereo_sounds",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.audio.stereo_mono_safe",
+    "source": "static",
+    "phase": 1,
+    "unit": "count",
+    "covers": "supplied_files",
+    "quantity": "mono_safe_stereo_sounds",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.audio.sprite_silence",
+    "source": "static",
+    "phase": 1,
+    "unit": "basis_points",
+    "covers": "supplied_files",
+    "quantity": "sprite_silence",
+    "statistic": "largest"
+  },
+  {
+    "id": "static.audio.silence_by_decode",
+    "source": "static",
+    "phase": 1,
+    "unit": "basis_points",
+    "covers": "supplied_files",
+    "quantity": "audio_silence",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.render.antialias",
+    "source": "static",
+    "phase": 1,
+    "unit": "flag",
+    "covers": "supplied_files",
+    "quantity": "antialias",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.render.resolution_uncapped",
+    "source": "static",
+    "phase": 1,
+    "unit": "flag",
+    "covers": "supplied_files",
+    "quantity": "resolution_uncapped",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.render.backend",
+    "source": "static",
+    "phase": 1,
+    "unit": "text",
+    "covers": "supplied_files",
+    "quantity": "render_backend",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.render.canvas",
+    "source": "static",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "canvas",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bundle.engines",
+    "source": "static",
+    "phase": 1,
+    "unit": "count",
+    "covers": "supplied_files",
+    "quantity": "libraries",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bundle.external_urls",
+    "source": "static",
+    "phase": 1,
+    "unit": "count",
+    "covers": "supplied_files",
+    "quantity": "external_urls",
+    "statistic": "all_files"
+  },
+  {
+    "id": "static.bundle.source_map",
+    "source": "static",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "supplied_files",
+    "quantity": "script_bytes",
+    "statistic": "all_files"
+  },
+  {
+    "id": "lab.time.first_frame",
+    "source": "lab",
+    "phase": 1,
+    "unit": "ms",
+    "covers": "load_to_idle",
+    "quantity": "first_frame_time",
+    "statistic": "since_navigation"
+  },
+  {
+    "id": "lab.time.ready",
+    "source": "lab",
+    "phase": 1,
+    "unit": "ms",
+    "covers": "load_to_idle",
+    "quantity": "ready_time",
+    "statistic": "since_navigation"
+  },
+  {
+    "id": "lab.bytes.loaded_by_idle",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "download_bytes",
+    "statistic": "by_idle"
+  },
+  {
+    "id": "lab.bytes.to_playable",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "download_bytes",
+    "statistic": "to_playable"
+  },
+  {
+    "id": "lab.audio.decoded",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "audio",
+    "statistic": "by_idle"
+  },
+  {
+    "id": "lab.audio.context_rate",
+    "source": "lab",
+    "phase": 1,
+    "unit": "hertz",
+    "covers": "load_to_idle",
+    "quantity": "audio_rate",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "lab.textures.uploaded",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "textures",
+    "statistic": "by_idle"
+  },
+  {
+    "id": "lab.textures.resident",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "textures",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "lab.canvas.contexts",
+    "source": "lab",
+    "phase": 1,
+    "unit": "count",
+    "covers": "load_to_idle",
+    "quantity": "canvas_contexts",
+    "statistic": "by_idle"
+  },
+  {
+    "id": "lab.canvas.bytes",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "canvas",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "lab.js_heap",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "js_heap",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "lab.inactive.audio_running",
+    "source": "lab",
+    "phase": 1,
+    "unit": "flag",
+    "covers": "load_to_idle",
+    "quantity": "audio_running",
+    "statistic": "while_inactive"
+  },
+  {
+    "id": "lab.inactive.frame_rate",
+    "source": "lab",
+    "phase": 1,
+    "unit": "hertz",
+    "covers": "load_to_idle",
+    "quantity": "frame_rate",
+    "statistic": "while_inactive"
+  },
+  {
+    "id": "lab.inactive.allocated",
+    "source": "lab",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "load_to_idle",
+    "quantity": "allocated_bytes",
+    "statistic": "while_inactive"
+  },
+  {
+    "id": "lab.self_check.frame_dpr",
+    "source": "lab",
+    "phase": 1,
+    "unit": "milli",
+    "covers": "load_to_idle",
+    "quantity": "frame_dpr",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "lab.self_check.frame_requests",
+    "source": "lab",
+    "phase": 1,
+    "unit": "count",
+    "covers": "load_to_idle",
+    "quantity": "frame_requests",
+    "statistic": "by_idle"
+  },
+  {
+    "id": "lab.self_check.webgl_renderer",
+    "source": "lab",
+    "phase": 1,
+    "unit": "text",
+    "covers": "load_to_idle",
+    "quantity": "webgl_renderer",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "model.footprint",
+    "source": "model",
+    "phase": 1,
+    "unit": "bytes",
+    "covers": "model_inputs",
+    "quantity": "footprint",
+    "statistic": "modelled_active"
+  },
+  {
+    "id": "model.footprint_inactive",
+    "source": "model",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "model_inputs",
+    "quantity": "footprint",
+    "statistic": "modelled_inactive"
+  },
+  {
+    "id": "play.spins",
+    "source": "lab",
+    "phase": 2,
+    "unit": "count",
+    "covers": "demo_spins",
+    "quantity": "spins",
+    "statistic": "during_spins"
+  },
+  {
+    "id": "play.peak",
+    "source": "lab",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "demo_spins",
+    "quantity": "memory",
+    "statistic": "peak_during_spins"
+  },
+  {
+    "id": "play.growth_per_100_spins",
+    "source": "lab",
+    "phase": 2,
+    "unit": "bytes_change",
+    "covers": "demo_spins",
+    "quantity": "memory",
+    "statistic": "growth_per100_spins"
+  },
+  {
+    "id": "play.bonus_peak",
+    "source": "lab",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "demo_spins",
+    "quantity": "memory",
+    "statistic": "peak_during_bonus"
+  },
+  {
+    "id": "device.phys_footprint",
+    "source": "device",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "fresh_device_runs",
+    "quantity": "footprint",
+    "statistic": "at_idle"
+  },
+  {
+    "id": "device.phys_footprint_peak",
+    "source": "device",
+    "phase": 2,
+    "unit": "bytes",
+    "covers": "fresh_device_runs",
+    "quantity": "footprint",
+    "statistic": "peak"
+  },
+  {
+    "id": "device.footprint_over_baseline",
+    "source": "device",
+    "phase": 2,
+    "unit": "bytes_change",
+    "covers": "fresh_device_runs",
+    "quantity": "footprint",
+    "statistic": "median_peak_over_baseline"
+  },
+  {
+    "id": "device.kills",
+    "source": "device",
+    "phase": 2,
+    "unit": "count",
+    "covers": "fresh_device_runs",
+    "quantity": "kills",
+    "statistic": "of_runs"
+  }
+]