notes

6.2 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). notes.worldapi.org keeps ident ids in ONE place:
3. // users.db `identity` (users.hl usersTable, unique index). notes.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. // NOTES_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 NOTES_STORAGE=/home/notes/storage/mpackdb \
20. // -e IDENT_EXCHANGE_URL=http://127.0.0.1:45002 -v $PWD:/home/notes -w /home/notes \
21. // worldapi-hybriel-runtime:debian12 ./bin/hybriel tools/migrate-short-ids.hl
22. // NOTES_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, countOfList, firstOf } from '../lib/users.hl'
28. storage = env('NOTES_STORAGE')
29. if (storage == null || !storage.startsWith('/')) {
30. hlError('set NOTES_STORAGE to the ABSOLUTE table directory, e.g. NOTES_STORAGE=$PWD/storage/mpackdb')
31. }
32. if (identKey == '' || identSecret == '') {
33. hlError('IDENT_API_KEY / IDENT_API_SECRET are not set (on Byrodin: docker run --env-file .env …)')
34. }
36. // the characters of an id, as ident#23 makes them: 5+ of 2-9 and a-z without i, l, o (lower case)
37. static isShortId = (s) => {
38. if (s == null || hlTypeName(s) != 'String' || s.length < 5 || s.length > 16) { return false }
39. let i = 0
40. while (i < s.length) {
41. let c = s.charCodeAt(i)
42. let digit = c >= 50 && c <= 57
43. let letter = c >= 97 && c <= 122 && c != 105 && c != 108 && c != 111
44. if (!digit && !letter) { return false }
45. i = i + 1
46. }
47. return true
48. }
49. // the old per-app id: exactly 32 lowercase hex
50. static isOldId = (s) => {
51. if (s == null || hlTypeName(s) != 'String' || s.length != 32) { return false }
52. let i = 0
53. while (i < s.length) {
54. let c = s.charCodeAt(i)
55. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 102))) { return false }
56. i = i + 1
57. }
58. return true
59. }
60. // every field of the record, `identity` replaced (hl:mpackdb wants the whole @id record, its `id` included)
61. static withIdentity = (rec, identity) => {
62. let out = {}
63. for (k of rec.keys()) { out[k] = rec[k] }
64. out.identity = identity
65. return out
66. }
68. console.log('migrate-short-ids: asking ' + identExchangeUrl + '/api/migrate-ids (storage ' + storage + ')')
69. r = fetch(identExchangeUrl + '/api/migrate-ids', { method = 'POST' json = { key = identKey secret = identSecret } headers = { 'user-agent' = 'notes.worldapi.org (migrate-short-ids)' } timeoutMs = 30000 })
70. if (r == null || r.status == null || r.status == 0) { hlError('ident did not answer at ' + identExchangeUrl) }
71. if (r.status != 200) {
72. let e = r.json()
73. hlError('ident refused migrate-ids (' + r.status + (e != null && e.error != null ? ': ' + e.error : '') + ') — is ident#23 live? right key/secret?')
74. }
75. j = r.json()
76. if (j == null || j.ids == null || hlTypeName(j.ids) != 'Hybrid') { hlError('ident answered no id map: ' + JSON.stringify(j)) }
77. ids = j.ids
78. console.log('ident: ' + j.count + ' old ids in the map, finished = ' + j.finished)
80. seen = 0
81. mapped = 0
82. already = 0
83. unmapped = 0
84. conflicts = 0
85. failed = 0
86. all = usersTable.find(null, null)
87. if (countOfList(all) > 0) {
88. for (u of all) {
89. seen = seen + 1
90. let old = u.identity
91. let sid = isOldId(old) ? ids[old] : null
92. if (sid != null && isShortId(sid)) {
93. let other = firstOf(usersTable.find('identity', sid))
94. if (other != null && other.id != u.id) {
95. conflicts = conflicts + 1
96. console.log('CONFLICT user ' + u.id + ': its short id ' + sid + ' is already user ' + other.id + ' — left alone')
97. } else {
98. usersTable.update(u.id, withIdentity(u, sid))
99. let after = usersTable.fetch(u.id)
100. if (after != null && after.identity == sid && firstOf(usersTable.find('identity', sid)) != null && countOfList(usersTable.find('identity', old)) == 0) {
101. mapped = mapped + 1
102. console.log('MAPPED user ' + u.id + ' → ' + sid)
103. } else {
104. failed = failed + 1
105. console.log('FAILED user ' + u.id + ': ' + usersTable.lastError())
106. }
107. }
108. } else if (isShortId(old) && !isOldId(old)) {
109. already = already + 1
110. } else {
111. unmapped = unmapped + 1
112. console.log('UNMAPPED user ' + u.id + ' (ident does not know its old id any more — deleted identity?)')
113. }
114. }
115. }
117. console.log('migrate-short-ids: users seen ' + seen + ', mapped ' + mapped + ', already short ' + already + ', unmapped ' + unmapped + ', conflicts ' + conflicts + ', failed ' + failed)
118. if (failed > 0) { hlError('some users could not be written — restore the backup and look') }
119. 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"') }