forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdesktop_beta_breakglass.py
More file actions
195 lines (171 loc) · 8.1 KB
/
Copy pathdesktop_beta_breakglass.py
File metadata and controls
195 lines (171 loc) · 8.1 KB
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
"""Atomic incident-only mutations for the hard-coded macOS Beta pointer."""
from __future__ import annotations
from datetime import datetime, timezone
import hashlib
import json
import re
from typing import Any, cast
from google.cloud.firestore import transactional
from database._client import get_firestore_client
from database.desktop_update_channels import (
BETA_ADMISSION_COLLECTION,
BETA_ADMISSION_DOCUMENT,
CHANNELS_COLLECTION,
MANIFESTS_COLLECTION,
build_channel_pointer,
normalize_release_manifest,
parse_pointer_generation,
validate_beta_admission_control,
)
BETA_BREAKGLASS_AUDITS_COLLECTION = "desktop_beta_breakglass_audits"
_INCIDENT_URL = re.compile(r"^https://github\.com/BasedHardware/omi/(?:issues|discussions)/[1-9][0-9]*(?:[/?#].*)?$")
_REQUEST_ID = re.compile(r"^https://github\.com/BasedHardware/omi/actions/runs/[1-9][0-9]*/attempts/[1-9][0-9]*$")
def _required(value: object, field: str) -> str:
if not isinstance(value, str) or not value.strip() or value != value.strip():
raise ValueError(f"{field} is required")
return value
def _request(request: dict[str, Any], operation: str) -> dict[str, Any]:
current = _required(request.get("current_release_id"), "current_release_id")
target = _required(request.get("target_release_id"), "target_release_id")
actor = _required(request.get("actor"), "actor")
reason = _required(request.get("reason"), "reason")
incident_url = _required(request.get("incident_url"), "incident_url")
request_id = _required(request.get("request_id"), "request_id")
generation = request.get("expected_generation")
if not _INCIDENT_URL.fullmatch(incident_url):
raise ValueError("incident_url must identify an Omi GitHub incident")
if not _REQUEST_ID.fullmatch(request_id):
raise ValueError("request_id must identify this GitHub Actions attempt")
if type(generation) is not int or generation < 0:
raise ValueError("expected_generation is invalid")
normal_path = request.get("normal_path_unavailable")
if operation == "rollout":
normal_path = _required(normal_path, "normal_path_unavailable")
return {
"current_release_id": current,
"target_release_id": target,
"expected_generation": generation,
"actor": actor,
"reason": reason,
"incident_url": incident_url,
"request_id": request_id,
"normal_path_unavailable": normal_path,
}
def _manifest(snapshot: Any, message: str) -> dict[str, Any]:
if not getattr(snapshot, "exists", False):
raise ValueError(message)
raw = snapshot.to_dict()
return normalize_release_manifest(cast(dict[str, Any], raw) if isinstance(raw, dict) else {})
def _digest(manifest: dict[str, Any]) -> str:
canonical = json.dumps(manifest, sort_keys=True, separators=(",", ":"), ensure_ascii=False).encode()
return "sha256:" + hashlib.sha256(canonical).hexdigest()
@transactional
def _commit(
transaction: Any,
control_ref: Any,
pointer_ref: Any,
audit_ref: Any,
target_ref: Any,
request: dict[str, Any],
operation: str,
emergency_manifest: dict[str, Any] | None,
now: datetime,
) -> dict[str, Any]:
control_snapshot = control_ref.get(transaction=transaction)
pointer_snapshot = pointer_ref.get(transaction=transaction)
audit_snapshot = audit_ref.get(transaction=transaction)
target_snapshot = target_ref.get(transaction=transaction)
if getattr(audit_snapshot, "exists", False):
raise ValueError("request was already used")
control = validate_beta_admission_control(
control_snapshot.to_dict() if getattr(control_snapshot, "exists", False) else {}
)
raw_pointer = pointer_snapshot.to_dict() if getattr(pointer_snapshot, "exists", False) else {}
current = cast(dict[str, Any], raw_pointer) if isinstance(raw_pointer, dict) else {}
if current.get("release_id") != request["current_release_id"]:
raise ValueError("current release mismatch")
if parse_pointer_generation(current.get("generation", 0)) != request["expected_generation"]:
raise ValueError("generation mismatch")
target_exists = getattr(target_snapshot, "exists", False)
if operation == "rollback":
target = _manifest(target_snapshot, "rollback target manifest does not exist")
# Beta manifests carry the ``signed-smoke`` tier (whose frozen-schema
# truth is ``qualification_passed: False``), so a literal ``T2``/``True``
# requirement here rejects every current rollback target. The schema
# admits only ("T2", True), ("signed-smoke", False), ("emergency", False),
# so excluding emergency is exactly "normal-path evidence".
if target["qualification_tier"] == "emergency":
raise ValueError("rollback target must not be an emergency manifest")
else:
if emergency_manifest is None:
raise ValueError("emergency manifest is required")
target = emergency_manifest
if target_exists and _manifest(target_snapshot, "invalid target manifest") != target:
raise ValueError("emergency target immutable manifest collision")
if target["qualification_tier"] != "emergency" or target["qualification_passed"] is not False:
raise ValueError("emergency target must preserve failed qualification truth")
if target["build_number"] <= parse_pointer_generation(current.get("build_number")):
raise ValueError("emergency target must have a higher build")
pointer = build_channel_pointer(
current,
target,
transition="breakglass",
platform="macos",
channel="beta",
release_id=request["target_release_id"],
expected_current_release_id=request["current_release_id"],
expected_generation=request["expected_generation"],
)
audit = {
"schema_version": 1,
"operation": operation,
"platform": "macos",
"channel": "beta",
**request,
"target_manifest_sha256": _digest(target),
"resulting_generation": pointer["generation"],
"created_at": now.isoformat().replace("+00:00", "Z"),
}
paused = {
**control,
"promotion_enabled": False,
"control_generation": control["control_generation"] + 1,
"admission_updated_at": now,
}
transaction.create(audit_ref, audit)
if operation == "rollout" and not target_exists:
transaction.create(target_ref, target)
transaction.set(control_ref, paused)
transaction.set(pointer_ref, pointer)
return {"pointer": pointer, "audit": audit, "admission": paused}
def _execute(
operation: str,
request: dict[str, Any],
*,
emergency_manifest: dict[str, Any] | None = None,
firestore_client: Any = None,
now: datetime | None = None,
) -> dict[str, Any]:
validated = _request(request, operation)
manifest = normalize_release_manifest(emergency_manifest) if emergency_manifest is not None else None
if manifest is not None and manifest["release_id"] != validated["target_release_id"]:
raise ValueError("emergency target identity mismatch")
client = firestore_client or get_firestore_client()
audit_id = hashlib.sha256(validated["request_id"].encode()).hexdigest()
return _commit(
client.transaction(),
client.collection(BETA_ADMISSION_COLLECTION).document(BETA_ADMISSION_DOCUMENT),
client.collection(CHANNELS_COLLECTION).document("macos-beta"),
client.collection(BETA_BREAKGLASS_AUDITS_COLLECTION).document(audit_id),
client.collection(MANIFESTS_COLLECTION).document(validated["target_release_id"]),
validated,
operation,
manifest,
now or datetime.now(timezone.utc),
)
def rollback_beta(request: dict[str, Any], *, firestore_client: Any = None, now: datetime | None = None):
return _execute("rollback", request, firestore_client=firestore_client, now=now)
def emergency_rollout_beta(
request: dict[str, Any], manifest: dict[str, Any], *, firestore_client: Any = None, now: datetime | None = None
):
return _execute("rollout", request, emergency_manifest=manifest, firestore_client=firestore_client, now=now)