calendar

6.3 KB

1. // tools/migrate-short-ids.hl — ONE-OFF MIGRATION (mission 039, ident#23): ident answers every identity's public
2. // 5-character SHORT ID (e.g. `a68sz`) instead of the old per-app id (32 hex). calendar.worldapi.org keeps ident ids in ONE place:
3. // users.db `identity` (lib/users.hl usersTable, unique index). events.db / settings.db `owner` is the users @id.
4. // Everything else points at the users @id, which does not change — sessions (`user = { id = <users @id> }`) stay signed in.
5. //
6. // What it does: POST <ident>/api/migrate-ids {key, secret} (NEVER `finish` — that is a separate, later step, runbook
7. // antcolony-docs/docs/short-id-switch.md) → { ids: { <old id>: <short id> } }, then for every user:
8. // * old id in the map → `identity` rewritten to the short id (MAPPED)
9. // * already a short id → left alone (ALREADY) — so a second run changes nothing (idempotent)
10. // * old id NOT in the map → left alone (UNMAPPED): an identity deleted in ident since; nobody can log in as it
11. // * the short id is already another user's `identity` → left alone (CONFLICT; cannot happen while the app was
12. // stopped between the ident switch and this run — needs a human, runbook "Conflicts"; the tool then exits non-zero)
13. // Prints counts; the key/secret are read from the environment and never printed. Exit is non-zero on any refusal.
14. //
15. // RUN IT WITH THE APP STOPPED (the server holds the tables), after ident#23 is live, storage backed up:
16. // CALENDAR_STORAGE=$PWD/storage/mpackdb IDENT_API_KEY=… IDENT_API_SECRET=… IDENT_EXCHANGE_URL=<ident> bin/hybriel tools/migrate-short-ids.hl
17. // On Byrodin (the key/secret come from the app's .env through docker's --env-file; hybriel itself only loads a .env
18. // beside the ENTRY script, i.e. tools/.env, which does not exist):
19. // docker run --rm --network host --env-file .env -e CALENDAR_STORAGE=/home/calendar/storage/mpackdb \
20. // -e IDENT_EXCHANGE_URL=http://127.0.0.1:45002 -v $PWD:/home/calendar -w /home/calendar \
21. // worldapi-hybriel-runtime:debian12 ./bin/hybriel tools/migrate-short-ids.hl
22. // CALENDAR_STORAGE must be ABSOLUTE: Hybriel resolves a relative path against the entry script's folder (tools/).
23. // Test: tests/short-id-switch.mjs (old ident → data → new ident → this tool twice → the same user logs in again).
24. import { env } from 'hl:proc'
25. import { fetch } from 'hl:fetch'
26. import { usersTable, identKey, identSecret, identExchangeUrl } from '../lib/users.hl'
27. import { countOfList, firstOf } from '../lib/util.hl'
29. storage = env('CALENDAR_STORAGE')
30. if (storage == null || !storage.startsWith('/')) {
31. hlError('set CALENDAR_STORAGE to the ABSOLUTE table directory, e.g. CALENDAR_STORAGE=$PWD/storage/mpackdb')
32. }
33. if (identKey == '' || identSecret == '') {
34. hlError('IDENT_API_KEY / IDENT_API_SECRET are not set (on Byrodin: docker run --env-file .env …)')
35. }
37. // the characters of an id, as ident#23 makes them: 5+ of 2-9 and a-z without i, l, o (lower case)
38. static isShortId = (s) => {
39. if (s == null || hlTypeName(s) != 'String' || s.length < 5 || s.length > 16) { return false }
40. let i = 0
41. while (i < s.length) {
42. let c = s.charCodeAt(i)
43. let digit = c >= 50 && c <= 57
44. let letter = c >= 97 && c <= 122 && c != 105 && c != 108 && c != 111
45. if (!digit && !letter) { return false }
46. i = i + 1
47. }
48. return true
49. }
50. // the old per-app id: exactly 32 lowercase hex
51. static isOldId = (s) => {
52. if (s == null || hlTypeName(s) != 'String' || s.length != 32) { return false }
53. let i = 0
54. while (i < s.length) {
55. let c = s.charCodeAt(i)
56. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 102))) { return false }
57. i = i + 1
58. }
59. return true
60. }
61. // every field of the record, `identity` replaced (hl:mpackdb wants the whole @id record, its `id` included)
62. static withIdentity = (rec, identity) => {
63. out = {}
64. for (k of rec.keys()) { out[k] = rec[k] }
65. out.identity = identity
66. return out
67. }
69. console.log('migrate-short-ids: asking ' + identExchangeUrl + '/api/migrate-ids (storage ' + storage + ')')
70. r = fetch(identExchangeUrl + '/api/migrate-ids', { method = 'POST' json = { key = identKey secret = identSecret } headers = { 'user-agent' = 'calendar.worldapi.org (migrate-short-ids)' } timeoutMs = 30000 })
71. if (r == null || r.status == null || r.status == 0) { hlError('ident did not answer at ' + identExchangeUrl) }
72. if (r.status != 200) {
73. e = r.json()
74. hlError('ident refused migrate-ids (' + r.status + (e != null && e.error != null ? ': ' + e.error : '') + ') — is ident#23 live? right key/secret?')
75. }
76. j = r.json()
77. if (j == null || j.ids == null || hlTypeName(j.ids) != 'Hybrid') { hlError('ident answered no id map: ' + JSON.stringify(j)) }
78. ids = j.ids
79. console.log('ident: ' + j.count + ' old ids in the map, finished = ' + j.finished)
81. seen = 0
82. mapped = 0
83. already = 0
84. unmapped = 0
85. conflicts = 0
86. failed = 0
87. all = usersTable.find(null, null)
88. if (countOfList(all) > 0) {
89. for (u of all) {
90. seen = seen + 1
91. let old = u.identity
92. let sid = isOldId(old) ? ids[old] : null
93. if (sid != null && isShortId(sid)) {
94. let other = firstOf(usersTable.find('identity', sid))
95. if (other != null && other.id != u.id) {
96. conflicts = conflicts + 1
97. console.log('CONFLICT user ' + u.id + ': its short id ' + sid + ' is already user ' + other.id + ' — left alone')
98. } else {
99. usersTable.update(u.id, withIdentity(u, sid))
100. let after = usersTable.fetch(u.id)
101. if (after != null && after.identity == sid && firstOf(usersTable.find('identity', sid)) != null && countOfList(usersTable.find('identity', old)) == 0) {
102. mapped = mapped + 1
103. console.log('MAPPED user ' + u.id + ' → ' + sid)
104. } else {
105. failed = failed + 1
106. console.log('FAILED user ' + u.id + ': ' + usersTable.lastError())
107. }
108. }
109. } else if (isShortId(old) && !isOldId(old)) {
110. already = already + 1
111. } else {
112. unmapped = unmapped + 1
113. console.log('UNMAPPED user ' + u.id + ' (ident does not know its old id any more — deleted identity?)')
114. }
115. }
116. }
118. console.log('migrate-short-ids: users seen ' + seen + ', mapped ' + mapped + ', already short ' + already + ', unmapped ' + unmapped + ', conflicts ' + conflicts + ', failed ' + failed)
119. if (failed > 0) { hlError('some users could not be written — restore the backup and look') }
120. if (conflicts > 0) { hlError('CONFLICTS: the app made a new user for a short id before this ran (it was not stopped?) — the old user keeps its old id; see the runbook "Conflicts"') }