@n24q02m/workspace 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +9 -2
- package/README.md +108 -15
- package/bin/cli.mjs +78 -51
- package/build/src/auth/workspace-auth.test.js +3 -3
- package/build/src/auth/workspace-auth.test.js.map +1 -1
- package/build/src/cli/tools.d.ts +64 -0
- package/build/src/cli/tools.d.ts.map +1 -0
- package/build/src/cli/tools.integration.test.d.ts +2 -0
- package/build/src/cli/tools.integration.test.d.ts.map +1 -0
- package/build/src/cli/tools.integration.test.js +46 -0
- package/build/src/cli/tools.integration.test.js.map +1 -0
- package/build/src/cli/tools.js +411 -0
- package/build/src/cli/tools.js.map +1 -0
- package/build/src/cli/tools.test.d.ts +2 -0
- package/build/src/cli/tools.test.d.ts.map +1 -0
- package/build/src/cli/tools.test.js +365 -0
- package/build/src/cli/tools.test.js.map +1 -0
- package/build/src/constants.d.ts +2 -1
- package/build/src/constants.d.ts.map +1 -1
- package/build/src/constants.js +8 -5
- package/build/src/constants.js.map +1 -1
- package/build/src/data-dir-migration.d.ts +72 -0
- package/build/src/data-dir-migration.d.ts.map +1 -0
- package/build/src/data-dir-migration.js +181 -0
- package/build/src/data-dir-migration.js.map +1 -0
- package/build/src/data-dir-migration.test.d.ts +2 -0
- package/build/src/data-dir-migration.test.d.ts.map +1 -0
- package/build/src/data-dir-migration.test.js +148 -0
- package/build/src/data-dir-migration.test.js.map +1 -0
- package/build/src/data-dir.d.ts +59 -0
- package/build/src/data-dir.d.ts.map +1 -0
- package/build/src/data-dir.js +94 -0
- package/build/src/data-dir.js.map +1 -0
- package/build/src/data-dir.test.d.ts +2 -0
- package/build/src/data-dir.test.d.ts.map +1 -0
- package/build/src/data-dir.test.js +73 -0
- package/build/src/data-dir.test.js.map +1 -0
- package/build/src/docs/calendar.md +27 -0
- package/build/src/docs/chat.md +34 -0
- package/build/src/docs/config.md +17 -0
- package/build/src/docs/docs.md +1 -1
- package/build/src/docs/drive.md +29 -0
- package/build/src/docs/forms.md +19 -0
- package/build/src/docs/gmail.md +37 -0
- package/build/src/docs/overview.md +24 -0
- package/build/src/docs/people.md +23 -0
- package/build/src/docs/sheets.md +27 -0
- package/build/src/docs/slides.md +31 -0
- package/build/src/docs/tasks.md +18 -0
- package/build/src/main.d.ts +2 -0
- package/build/src/main.d.ts.map +1 -1
- package/build/src/main.js +25 -5
- package/build/src/main.js.map +1 -1
- package/build/src/main.test.js +42 -1
- package/build/src/main.test.js.map +1 -1
- package/build/src/tools/config.d.ts +10 -1
- package/build/src/tools/config.d.ts.map +1 -1
- package/build/src/tools/config.js +20 -1
- package/build/src/tools/config.js.map +1 -1
- package/build/src/tools/dispatch.d.ts +25 -0
- package/build/src/tools/dispatch.d.ts.map +1 -0
- package/build/src/tools/dispatch.js +119 -0
- package/build/src/tools/dispatch.js.map +1 -0
- package/build/src/tools/domains/bounds-e2e.test.d.ts +2 -0
- package/build/src/tools/domains/bounds-e2e.test.d.ts.map +1 -0
- package/build/src/tools/domains/bounds-e2e.test.js +166 -0
- package/build/src/tools/domains/bounds-e2e.test.js.map +1 -0
- package/build/src/tools/domains/bounds.d.ts +53 -0
- package/build/src/tools/domains/bounds.d.ts.map +1 -0
- package/build/src/tools/domains/bounds.js +72 -0
- package/build/src/tools/domains/bounds.js.map +1 -0
- package/build/src/tools/domains/calendar.d.ts.map +1 -1
- package/build/src/tools/domains/calendar.js +5 -1
- package/build/src/tools/domains/calendar.js.map +1 -1
- package/build/src/tools/domains/chat.d.ts.map +1 -1
- package/build/src/tools/domains/chat.js +3 -1
- package/build/src/tools/domains/chat.js.map +1 -1
- package/build/src/tools/domains/docs.d.ts.map +1 -1
- package/build/src/tools/domains/docs.js +2 -1
- package/build/src/tools/domains/docs.js.map +1 -1
- package/build/src/tools/domains/drive.d.ts.map +1 -1
- package/build/src/tools/domains/drive.js +5 -1
- package/build/src/tools/domains/drive.js.map +1 -1
- package/build/src/tools/domains/factory-bounds.test.d.ts +2 -0
- package/build/src/tools/domains/factory-bounds.test.d.ts.map +1 -0
- package/build/src/tools/domains/factory-bounds.test.js +169 -0
- package/build/src/tools/domains/factory-bounds.test.js.map +1 -0
- package/build/src/tools/domains/factory.d.ts +15 -0
- package/build/src/tools/domains/factory.d.ts.map +1 -1
- package/build/src/tools/domains/factory.js +18 -1
- package/build/src/tools/domains/factory.js.map +1 -1
- package/build/src/tools/domains/forms.d.ts.map +1 -1
- package/build/src/tools/domains/forms.js +5 -1
- package/build/src/tools/domains/forms.js.map +1 -1
- package/build/src/tools/domains/gmail.d.ts.map +1 -1
- package/build/src/tools/domains/gmail.js +5 -1
- package/build/src/tools/domains/gmail.js.map +1 -1
- package/build/src/tools/domains/index.d.ts.map +1 -1
- package/build/src/tools/domains/index.js +94 -12
- package/build/src/tools/domains/index.js.map +1 -1
- package/build/src/tools/domains/people.d.ts.map +1 -1
- package/build/src/tools/domains/people.js +2 -1
- package/build/src/tools/domains/people.js.map +1 -1
- package/build/src/tools/domains/slides.d.ts.map +1 -1
- package/build/src/tools/domains/slides.js +2 -1
- package/build/src/tools/domains/slides.js.map +1 -1
- package/build/src/tools/domains/tasks.d.ts.map +1 -1
- package/build/src/tools/domains/tasks.js +3 -1
- package/build/src/tools/domains/tasks.js.map +1 -1
- package/build/src/tools/helpers/bounds.d.ts +72 -0
- package/build/src/tools/helpers/bounds.d.ts.map +1 -0
- package/build/src/tools/helpers/bounds.js +234 -0
- package/build/src/tools/helpers/bounds.js.map +1 -0
- package/build/src/tools/helpers/bounds.test.d.ts +2 -0
- package/build/src/tools/helpers/bounds.test.d.ts.map +1 -0
- package/build/src/tools/helpers/bounds.test.js +239 -0
- package/build/src/tools/helpers/bounds.test.js.map +1 -0
- package/build/src/tools/registry.d.ts +28 -0
- package/build/src/tools/registry.d.ts.map +1 -1
- package/build/src/tools/registry.js +15 -120
- package/build/src/tools/registry.js.map +1 -1
- package/build/src/tools/registry.test.js +7 -1
- package/build/src/tools/registry.test.js.map +1 -1
- package/build/src/vendored/services/CalendarService.d.ts +2 -0
- package/build/src/vendored/services/CalendarService.d.ts.map +1 -1
- package/build/src/vendored/services/CalendarService.js +13 -2
- package/build/src/vendored/services/CalendarService.js.map +1 -1
- package/build/src/vendored/services/ChatService.d.ts +4 -1
- package/build/src/vendored/services/ChatService.d.ts.map +1 -1
- package/build/src/vendored/services/ChatService.js +11 -3
- package/build/src/vendored/services/ChatService.js.map +1 -1
- package/build/src/vendored/services/DocsService.d.ts.map +1 -1
- package/build/src/vendored/services/DocsService.js +6 -1
- package/build/src/vendored/services/DocsService.js.map +1 -1
- package/build/src/vendored/services/DocsService.test.js +2 -2
- package/build/src/vendored/services/DocsService.test.js.map +1 -1
- package/build/src/vendored/services/DriveService.d.ts +3 -1
- package/build/src/vendored/services/DriveService.d.ts.map +1 -1
- package/build/src/vendored/services/DriveService.js +10 -3
- package/build/src/vendored/services/DriveService.js.map +1 -1
- package/build/src/vendored/services/SheetsService.d.ts +6 -2
- package/build/src/vendored/services/SheetsService.d.ts.map +1 -1
- package/build/src/vendored/services/SheetsService.js +67 -6
- package/build/src/vendored/services/SheetsService.js.map +1 -1
- package/build/src/vendored/services/SheetsService.test.js +67 -0
- package/build/src/vendored/services/SheetsService.test.js.map +1 -1
- package/build/src/vendored/utils/textBounds.d.ts +40 -0
- package/build/src/vendored/utils/textBounds.d.ts.map +1 -0
- package/build/src/vendored/utils/textBounds.js +115 -0
- package/build/src/vendored/utils/textBounds.js.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One-time forward migration of the credential store across the plugin-slug
|
|
3
|
+
* rename (`better-workspace` -> `workspace`).
|
|
4
|
+
*
|
|
5
|
+
* Every release so far passed `STORE_PLUGIN = 'better-workspace'` to hull, so
|
|
6
|
+
* the encrypted blob lives in `~/.better-workspace/`. The slug is now the short
|
|
7
|
+
* product name, which means hull reads and writes `~/.workspace/`; its own
|
|
8
|
+
* read-only fallbacks still cover `~/.workspace-mcp/` and the older
|
|
9
|
+
* `~/.better-workspace-mcp/`, but the immediately-previous layout
|
|
10
|
+
* (`~/.better-workspace/`) would stop being read and an existing install would
|
|
11
|
+
* look unconfigured.
|
|
12
|
+
*
|
|
13
|
+
* This module copies that layout forward once per process, before the first
|
|
14
|
+
* credential read:
|
|
15
|
+
*
|
|
16
|
+
* - a blob is only written when the current store still has nothing for that
|
|
17
|
+
* namespace, so a store already living under the new name always wins and is
|
|
18
|
+
* never replaced;
|
|
19
|
+
* - the payload is decrypted and re-encrypted through hull for the new slug.
|
|
20
|
+
* A plain directory rename would be wrong: hull derives the multi-user
|
|
21
|
+
* scrypt salt from `<keyPlugin>:<sub>`, so blobs written under
|
|
22
|
+
* `better-workspace:<sub>` would stay undecryptable under
|
|
23
|
+
* `workspace:<sub>` (single-user blobs would survive a rename, multi-user
|
|
24
|
+
* ones would not);
|
|
25
|
+
* - every write is read back and compared before the run reports success, and
|
|
26
|
+
* the legacy directory is only ever read, never modified or removed, so a
|
|
27
|
+
* failed migration cannot lose data;
|
|
28
|
+
* - an unreadable legacy directory (bad permissions, a file where the store
|
|
29
|
+
* directory should be) raises `StoreMigrationError` instead of being treated
|
|
30
|
+
* as "not configured", which would silently drop the user's credentials.
|
|
31
|
+
*
|
|
32
|
+
* Multi-user namespaces are only migrated while `CREDENTIAL_SECRET` is set,
|
|
33
|
+
* because that is the only process that can decrypt and re-encrypt them. An
|
|
34
|
+
* HTTP deployment migrates its namespaces on its next start; a stdio run leaves
|
|
35
|
+
* them alone and never touches their key material.
|
|
36
|
+
*/
|
|
37
|
+
import { existsSync, readdirSync } from 'node:fs';
|
|
38
|
+
import { join } from 'node:path';
|
|
39
|
+
import { isDeepStrictEqual } from 'node:util';
|
|
40
|
+
import { credPath, dataDirCandidates, PerPluginStore } from '@n24q02m/hull/storage';
|
|
41
|
+
import { LEGACY_STORE_PLUGIN, STORE_PLUGIN } from './constants.js';
|
|
42
|
+
/**
|
|
43
|
+
* A legacy store that cannot be read, or a migrated blob that cannot be written
|
|
44
|
+
* or read back. The message names the paths and never the credential values.
|
|
45
|
+
*/
|
|
46
|
+
export class StoreMigrationError extends Error {
|
|
47
|
+
constructor(path, message) {
|
|
48
|
+
super(message);
|
|
49
|
+
this.path = path;
|
|
50
|
+
this.name = 'StoreMigrationError';
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
// Same alphabet hull accepts for a plugin/namespace path component, so a stray
|
|
54
|
+
// directory (`.DS_Store`, an editor swap dir) is never mistaken for a namespace.
|
|
55
|
+
const SAFE_SUB = /^[A-Za-z0-9._-]+$/;
|
|
56
|
+
function errorCode(error) {
|
|
57
|
+
return error?.code ?? 'unknown error';
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Whether `dir` exists and can be listed. A directory that exists but cannot be
|
|
61
|
+
* read is reported, not skipped: skipping it would silently look like "no saved
|
|
62
|
+
* credentials" and invite the user to overwrite state that is still there.
|
|
63
|
+
*/
|
|
64
|
+
function legacyDirExists(dir) {
|
|
65
|
+
try {
|
|
66
|
+
readdirSync(dir);
|
|
67
|
+
return true;
|
|
68
|
+
}
|
|
69
|
+
catch (error) {
|
|
70
|
+
const code = errorCode(error);
|
|
71
|
+
if (code === 'ENOENT')
|
|
72
|
+
return false;
|
|
73
|
+
throw new StoreMigrationError(dir, `Cannot read the previous credential directory ${dir} (${code}). Fix its permissions or move it aside, then start again: nothing was migrated and no credential was changed.`);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
/** Multi-user namespaces present in one legacy directory. */
|
|
77
|
+
function legacySubs(root) {
|
|
78
|
+
const subsDir = join(root, 'subs');
|
|
79
|
+
let entries;
|
|
80
|
+
try {
|
|
81
|
+
entries = readdirSync(subsDir, { withFileTypes: true });
|
|
82
|
+
}
|
|
83
|
+
catch (error) {
|
|
84
|
+
const code = errorCode(error);
|
|
85
|
+
if (code === 'ENOENT')
|
|
86
|
+
return [];
|
|
87
|
+
throw new StoreMigrationError(subsDir, `Cannot read the previous credential directory ${subsDir} (${code}). Fix its permissions or move it aside, then start again: nothing was migrated and no credential was changed.`);
|
|
88
|
+
}
|
|
89
|
+
return entries
|
|
90
|
+
.filter((entry) => entry.isDirectory() && entry.name !== '.' && entry.name !== '..' && SAFE_SUB.test(entry.name))
|
|
91
|
+
.map((entry) => entry.name);
|
|
92
|
+
}
|
|
93
|
+
/** First legacy directory holding a blob for `sub`, in the order hull reads them. */
|
|
94
|
+
function legacySource(sub) {
|
|
95
|
+
for (const { dir: root } of dataDirCandidates(LEGACY_STORE_PLUGIN)) {
|
|
96
|
+
const blob = sub === null ? join(root, 'config.json') : join(root, 'subs', sub, 'config.json');
|
|
97
|
+
if (existsSync(blob))
|
|
98
|
+
return root;
|
|
99
|
+
}
|
|
100
|
+
return null;
|
|
101
|
+
}
|
|
102
|
+
/** Copy one namespace forward, unless the current store already owns it. */
|
|
103
|
+
async function migrateBlob(sub, source, report) {
|
|
104
|
+
const target = credPath(STORE_PLUGIN, sub);
|
|
105
|
+
if (existsSync(target)) {
|
|
106
|
+
report.kept.push(target);
|
|
107
|
+
return;
|
|
108
|
+
}
|
|
109
|
+
if (sub !== null && !process.env.CREDENTIAL_SECRET) {
|
|
110
|
+
report.deferred.push(sub);
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
let payload;
|
|
114
|
+
try {
|
|
115
|
+
payload = await new PerPluginStore(LEGACY_STORE_PLUGIN, sub).load();
|
|
116
|
+
}
|
|
117
|
+
catch (error) {
|
|
118
|
+
throw new StoreMigrationError(source, `Cannot read the saved credential in ${source} (${errorCode(error)}). Nothing was migrated and the previous store was left untouched.`);
|
|
119
|
+
}
|
|
120
|
+
// Nothing saved for this namespace (or hull already reported it as corrupt).
|
|
121
|
+
if (payload === null)
|
|
122
|
+
return;
|
|
123
|
+
const store = new PerPluginStore(STORE_PLUGIN, sub);
|
|
124
|
+
try {
|
|
125
|
+
await store.save(payload);
|
|
126
|
+
}
|
|
127
|
+
catch (error) {
|
|
128
|
+
throw new StoreMigrationError(target, `Cannot write the migrated credential to ${target} (${errorCode(error)}). The previous store in ${source} was left untouched.`);
|
|
129
|
+
}
|
|
130
|
+
let readBack = null;
|
|
131
|
+
try {
|
|
132
|
+
readBack = await store.load();
|
|
133
|
+
}
|
|
134
|
+
catch {
|
|
135
|
+
readBack = null;
|
|
136
|
+
}
|
|
137
|
+
if (!isDeepStrictEqual(readBack, payload)) {
|
|
138
|
+
throw new StoreMigrationError(target, `Wrote ${target} but reading it back did not return the migrated credential. The previous store in ${source} was left untouched.`);
|
|
139
|
+
}
|
|
140
|
+
report.migrated.push({ source, sub });
|
|
141
|
+
}
|
|
142
|
+
async function runMigration() {
|
|
143
|
+
const report = { migrated: [], kept: [], deferred: [] };
|
|
144
|
+
const present = dataDirCandidates(LEGACY_STORE_PLUGIN)
|
|
145
|
+
.map((location) => location.dir)
|
|
146
|
+
.filter((root) => legacyDirExists(root));
|
|
147
|
+
if (present.length === 0)
|
|
148
|
+
return report;
|
|
149
|
+
const subs = new Set();
|
|
150
|
+
for (const root of present) {
|
|
151
|
+
for (const sub of legacySubs(root))
|
|
152
|
+
subs.add(sub);
|
|
153
|
+
}
|
|
154
|
+
const single = legacySource(null);
|
|
155
|
+
if (single !== null)
|
|
156
|
+
await migrateBlob(null, single, report);
|
|
157
|
+
for (const sub of [...subs].sort()) {
|
|
158
|
+
const source = legacySource(sub);
|
|
159
|
+
if (source !== null)
|
|
160
|
+
await migrateBlob(sub, source, report);
|
|
161
|
+
}
|
|
162
|
+
return report;
|
|
163
|
+
}
|
|
164
|
+
let inFlight = null;
|
|
165
|
+
/**
|
|
166
|
+
* Migrate the pre-rename credential store, at most once per process.
|
|
167
|
+
*
|
|
168
|
+
* Idempotent by construction (the current store wins per namespace), and the
|
|
169
|
+
* single flight also keeps two concurrent startup paths from writing the same
|
|
170
|
+
* blob twice. A failure is returned to every later caller unchanged: the same
|
|
171
|
+
* unreadable directory stays unreadable for the life of the process.
|
|
172
|
+
*/
|
|
173
|
+
export function migrateLegacyStore() {
|
|
174
|
+
inFlight ??= runMigration();
|
|
175
|
+
return inFlight;
|
|
176
|
+
}
|
|
177
|
+
/** Forget the single-flight result so a test can run the migration again. */
|
|
178
|
+
export function resetStoreMigrationForTesting() {
|
|
179
|
+
inFlight = null;
|
|
180
|
+
}
|
|
181
|
+
//# sourceMappingURL=data-dir-migration.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir-migration.js","sourceRoot":"","sources":["../../src/data-dir-migration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAAe,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAoBlE;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,YACW,IAAY,EACrB,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAA;QAHL,SAAI,GAAJ,IAAI,CAAQ;QAIrB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAA;IACnC,CAAC;CACF;AAED,+EAA+E;AAC/E,iFAAiF;AACjF,MAAM,QAAQ,GAAG,mBAAmB,CAAA;AAEpC,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAQ,KAA+B,EAAE,IAAI,IAAI,eAAe,CAAA;AAClE,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,GAAW;IAClC,IAAI,CAAC;QACH,WAAW,CAAC,GAAG,CAAC,CAAA;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;QAC7B,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAA;QACnC,MAAM,IAAI,mBAAmB,CAC3B,GAAG,EACH,iDAAiD,GAAG,KAAK,IAAI,gHAAgH,CAC9K,CAAA;IACH,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAClC,IAAI,OAAiB,CAAA;IACrB,IAAI,CAAC;QACH,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;QAC7B,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,CAAA;QAChC,MAAM,IAAI,mBAAmB,CAC3B,OAAO,EACP,iDAAiD,OAAO,KAAK,IAAI,gHAAgH,CAClL,CAAA;IACH,CAAC;IACD,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAChH,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC;AAED,qFAAqF;AACrF,SAAS,YAAY,CAAC,GAAkB;IACtC,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAA;QAC9F,IAAI,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;IACnC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,4EAA4E;AAC5E,KAAK,UAAU,WAAW,CAAC,GAAkB,EAAE,MAAc,EAAE,MAAuB;IACpF,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IAC1C,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACxB,OAAM;IACR,CAAC;IACD,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACzB,OAAM;IACR,CAAC;IAED,IAAI,OAAuC,CAAA;IAC3C,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACrE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,mBAAmB,CAC3B,MAAM,EACN,uCAAuC,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,oEAAoE,CACvI,CAAA;IACH,CAAC;IACD,6EAA6E;IAC7E,IAAI,OAAO,KAAK,IAAI;QAAE,OAAM;IAE5B,MAAM,KAAK,GAAG,IAAI,cAAc,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IACnD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,mBAAmB,CAC3B,MAAM,EACN,2CAA2C,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,4BAA4B,MAAM,sBAAsB,CAC/H,CAAA;IACH,CAAC;IAED,IAAI,QAAQ,GAAmC,IAAI,CAAA;IACnD,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,QAAQ,GAAG,IAAI,CAAA;IACjB,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,mBAAmB,CAC3B,MAAM,EACN,SAAS,MAAM,sFAAsF,MAAM,sBAAsB,CAClI,CAAA;IACH,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;AACvC,CAAC;AAED,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAoB,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IAExE,MAAM,OAAO,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;SACnD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;SAC/B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAA;IAC1C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAA;IAEvC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAC9B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,MAAM,KAAK,IAAI;QAAE,MAAM,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5D,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;QAChC,IAAI,MAAM,KAAK,IAAI;YAAE,MAAM,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7D,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,IAAI,QAAQ,GAAoC,IAAI,CAAA;AAEpD;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB;IAChC,QAAQ,KAAK,YAAY,EAAE,CAAA;IAC3B,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,6BAA6B;IAC3C,QAAQ,GAAG,IAAI,CAAA;AACjB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir-migration.test.d.ts","sourceRoot":"","sources":["../../src/data-dir-migration.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { chmodSync, existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs';
|
|
2
|
+
import { tmpdir } from 'node:os';
|
|
3
|
+
import { join } from 'node:path';
|
|
4
|
+
import { PerPluginStore, setHomeDirForTesting } from '@n24q02m/hull/storage';
|
|
5
|
+
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
6
|
+
import { LEGACY_STORE_PLUGIN, STORE_PLUGIN } from './constants.js';
|
|
7
|
+
import { migrateLegacyStore, resetStoreMigrationForTesting, StoreMigrationError } from './data-dir-migration.js';
|
|
8
|
+
// The two on-disk directories the rename moves state between. Spelled out rather
|
|
9
|
+
// than derived, so a silent slug change in either direction fails here.
|
|
10
|
+
const OLD_DIR = '.better-workspace';
|
|
11
|
+
const NEW_DIR = '.workspace';
|
|
12
|
+
const credential = (overrides = {}) => ({
|
|
13
|
+
access_token: 'old-access-token',
|
|
14
|
+
refresh_token: 'old-refresh-token',
|
|
15
|
+
expiry_date: 1_700_000_000_000,
|
|
16
|
+
...overrides
|
|
17
|
+
});
|
|
18
|
+
describe('migrateLegacyStore', () => {
|
|
19
|
+
let home;
|
|
20
|
+
let savedCredentialSecret;
|
|
21
|
+
beforeEach(() => {
|
|
22
|
+
home = mkdtempSync(join(tmpdir(), 'workspace-migration-'));
|
|
23
|
+
// hull resolves every store path from one process-wide home; point it at the
|
|
24
|
+
// temp dir so nothing here can touch the real ~/.workspace.
|
|
25
|
+
setHomeDirForTesting(home);
|
|
26
|
+
resetStoreMigrationForTesting();
|
|
27
|
+
savedCredentialSecret = process.env.CREDENTIAL_SECRET;
|
|
28
|
+
delete process.env.CREDENTIAL_SECRET;
|
|
29
|
+
});
|
|
30
|
+
afterEach(() => {
|
|
31
|
+
resetStoreMigrationForTesting();
|
|
32
|
+
setHomeDirForTesting(null);
|
|
33
|
+
if (savedCredentialSecret === undefined)
|
|
34
|
+
delete process.env.CREDENTIAL_SECRET;
|
|
35
|
+
else
|
|
36
|
+
process.env.CREDENTIAL_SECRET = savedCredentialSecret;
|
|
37
|
+
rmSync(home, { recursive: true, force: true });
|
|
38
|
+
});
|
|
39
|
+
it('pins the slug pair the migration exists for', () => {
|
|
40
|
+
expect(STORE_PLUGIN).toBe('workspace');
|
|
41
|
+
expect(LEGACY_STORE_PLUGIN).toBe('better-workspace');
|
|
42
|
+
expect(`.${STORE_PLUGIN}`).toBe(NEW_DIR);
|
|
43
|
+
expect(`.${LEGACY_STORE_PLUGIN}`).toBe(OLD_DIR);
|
|
44
|
+
});
|
|
45
|
+
// Branch 1: only the pre-rename store exists -> it still reads after the rename.
|
|
46
|
+
it('copies a pre-rename store forward and keeps the credentials readable', async () => {
|
|
47
|
+
const payload = credential();
|
|
48
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN).save(payload);
|
|
49
|
+
expect(existsSync(join(home, OLD_DIR, 'config.json'))).toBe(true);
|
|
50
|
+
expect(existsSync(join(home, NEW_DIR))).toBe(false);
|
|
51
|
+
const report = await migrateLegacyStore();
|
|
52
|
+
expect(report.migrated).toEqual([{ source: join(home, OLD_DIR), sub: null }]);
|
|
53
|
+
expect(report.kept).toEqual([]);
|
|
54
|
+
expect(existsSync(join(home, NEW_DIR, 'config.json'))).toBe(true);
|
|
55
|
+
expect(await new PerPluginStore(STORE_PLUGIN).load()).toEqual(payload);
|
|
56
|
+
// The legacy copy is read-only history: the migration never deletes it.
|
|
57
|
+
expect(await new PerPluginStore(LEGACY_STORE_PLUGIN).load()).toEqual(payload);
|
|
58
|
+
});
|
|
59
|
+
// Branch 1 (multi-user): the blob is re-keyed, not moved -- hull salts the
|
|
60
|
+
// multi-user key with the slug, so a plain directory rename would leave it
|
|
61
|
+
// undecryptable.
|
|
62
|
+
it('re-encrypts a multi-user namespace under the new slug salt', async () => {
|
|
63
|
+
process.env.CREDENTIAL_SECRET = 'namespace-master-secret';
|
|
64
|
+
const payload = credential({ access_token: 'ns-access-token' });
|
|
65
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN, 'alice').save(payload);
|
|
66
|
+
const report = await migrateLegacyStore();
|
|
67
|
+
expect(report.migrated).toEqual([{ source: join(home, OLD_DIR), sub: 'alice' }]);
|
|
68
|
+
expect(existsSync(join(home, NEW_DIR, 'subs', 'alice', 'config.json'))).toBe(true);
|
|
69
|
+
expect(await new PerPluginStore(STORE_PLUGIN, 'alice').load()).toEqual(payload);
|
|
70
|
+
expect(await new PerPluginStore(LEGACY_STORE_PLUGIN, 'alice').load()).toEqual(payload);
|
|
71
|
+
});
|
|
72
|
+
it('leaves multi-user namespaces alone when this process cannot decrypt them', async () => {
|
|
73
|
+
process.env.CREDENTIAL_SECRET = 'namespace-master-secret';
|
|
74
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN, 'alice').save(credential());
|
|
75
|
+
delete process.env.CREDENTIAL_SECRET;
|
|
76
|
+
const report = await migrateLegacyStore();
|
|
77
|
+
expect(report.migrated).toEqual([]);
|
|
78
|
+
expect(report.deferred).toEqual(['alice']);
|
|
79
|
+
expect(existsSync(join(home, NEW_DIR, 'subs', 'alice', 'config.json'))).toBe(false);
|
|
80
|
+
});
|
|
81
|
+
// Branch 2: only the post-rename store exists -> untouched.
|
|
82
|
+
it('leaves a current store untouched when there is nothing older', async () => {
|
|
83
|
+
const payload = credential({ access_token: 'current-access-token' });
|
|
84
|
+
await new PerPluginStore(STORE_PLUGIN).save(payload);
|
|
85
|
+
const report = await migrateLegacyStore();
|
|
86
|
+
expect(report.migrated).toEqual([]);
|
|
87
|
+
expect(report.kept).toEqual([]);
|
|
88
|
+
expect(existsSync(join(home, OLD_DIR))).toBe(false);
|
|
89
|
+
expect(await new PerPluginStore(STORE_PLUGIN).load()).toEqual(payload);
|
|
90
|
+
});
|
|
91
|
+
// Branch 3: both exist -> the current store wins and the old one survives intact.
|
|
92
|
+
it('keeps the current store when a pre-rename store also exists', async () => {
|
|
93
|
+
const current = credential({ access_token: 'current-access-token' });
|
|
94
|
+
const old = credential({ access_token: 'old-access-token' });
|
|
95
|
+
await new PerPluginStore(STORE_PLUGIN).save(current);
|
|
96
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN).save(old);
|
|
97
|
+
const report = await migrateLegacyStore();
|
|
98
|
+
expect(report.migrated).toEqual([]);
|
|
99
|
+
expect(report.kept).toEqual([join(home, NEW_DIR, 'config.json')]);
|
|
100
|
+
expect(await new PerPluginStore(STORE_PLUGIN).load()).toEqual(current);
|
|
101
|
+
expect(await new PerPluginStore(LEGACY_STORE_PLUGIN).load()).toEqual(old);
|
|
102
|
+
});
|
|
103
|
+
// Branch 4: an empty old directory is not a migration and must not create the
|
|
104
|
+
// new store (an empty store reported as "configured" is its own bug).
|
|
105
|
+
it('does nothing when the pre-rename directory holds no credential', async () => {
|
|
106
|
+
mkdirSync(join(home, OLD_DIR, 'subs'), { recursive: true });
|
|
107
|
+
const report = await migrateLegacyStore();
|
|
108
|
+
expect(report.migrated).toEqual([]);
|
|
109
|
+
expect(report.kept).toEqual([]);
|
|
110
|
+
expect(existsSync(join(home, NEW_DIR))).toBe(false);
|
|
111
|
+
});
|
|
112
|
+
// Branch 5a: an unreadable old store is an error, never "not configured".
|
|
113
|
+
it.skipIf(process.platform === 'win32' || process.getuid?.() === 0)('reports an unreadable pre-rename store instead of dropping it', async () => {
|
|
114
|
+
const payload = credential();
|
|
115
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN).save(payload);
|
|
116
|
+
chmodSync(join(home, OLD_DIR), 0o000);
|
|
117
|
+
try {
|
|
118
|
+
const failure = await migrateLegacyStore().catch((error) => error);
|
|
119
|
+
expect(failure).toBeInstanceOf(StoreMigrationError);
|
|
120
|
+
expect(failure.path).toBe(join(home, OLD_DIR));
|
|
121
|
+
expect(failure.message).toContain(join(home, OLD_DIR));
|
|
122
|
+
expect(failure.message).not.toContain(payload.access_token);
|
|
123
|
+
expect(existsSync(join(home, NEW_DIR))).toBe(false);
|
|
124
|
+
}
|
|
125
|
+
finally {
|
|
126
|
+
chmodSync(join(home, OLD_DIR), 0o700);
|
|
127
|
+
}
|
|
128
|
+
// The credential is still where it always was: nothing was lost.
|
|
129
|
+
expect(await new PerPluginStore(LEGACY_STORE_PLUGIN).load()).toEqual(payload);
|
|
130
|
+
});
|
|
131
|
+
// Branch 5b (every platform): a file where the store directory belongs is the
|
|
132
|
+
// same class of broken install and gets the same clear failure.
|
|
133
|
+
it('reports a pre-rename store path that is not a directory', async () => {
|
|
134
|
+
writeFileSync(join(home, OLD_DIR), 'not a directory');
|
|
135
|
+
const failure = await migrateLegacyStore().catch((error) => error);
|
|
136
|
+
expect(failure).toBeInstanceOf(StoreMigrationError);
|
|
137
|
+
expect(failure.path).toBe(join(home, OLD_DIR));
|
|
138
|
+
expect(failure.message).toContain(join(home, OLD_DIR));
|
|
139
|
+
expect(existsSync(join(home, NEW_DIR))).toBe(false);
|
|
140
|
+
});
|
|
141
|
+
it('migrates once per process even when startup paths call it twice', async () => {
|
|
142
|
+
await new PerPluginStore(LEGACY_STORE_PLUGIN).save(credential());
|
|
143
|
+
const [first, second] = await Promise.all([migrateLegacyStore(), migrateLegacyStore()]);
|
|
144
|
+
expect(second).toBe(first);
|
|
145
|
+
expect(first.migrated).toHaveLength(1);
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
//# sourceMappingURL=data-dir-migration.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir-migration.test.js","sourceRoot":"","sources":["../../src/data-dir-migration.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC9F,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAEhH,iFAAiF;AACjF,wEAAwE;AACxE,MAAM,OAAO,GAAG,mBAAmB,CAAA;AACnC,MAAM,OAAO,GAAG,YAAY,CAAA;AAE5B,MAAM,UAAU,GAAG,CAAC,YAAqC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,YAAY,EAAE,kBAAkB;IAChC,aAAa,EAAE,mBAAmB;IAClC,WAAW,EAAE,iBAAiB;IAC9B,GAAG,SAAS;CACb,CAAC,CAAA;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,IAAY,CAAA;IAChB,IAAI,qBAAyC,CAAA;IAE7C,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAA;QAC1D,6EAA6E;QAC7E,4DAA4D;QAC5D,oBAAoB,CAAC,IAAI,CAAC,CAAA;QAC1B,6BAA6B,EAAE,CAAA;QAC/B,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QACrD,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;IACtC,CAAC,CAAC,CAAA;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,6BAA6B,EAAE,CAAA;QAC/B,oBAAoB,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAI,qBAAqB,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;;YACxE,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,qBAAqB,CAAA;QAC1D,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACtC,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACpD,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACxC,MAAM,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;IAEF,iFAAiF;IACjF,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,OAAO,GAAG,UAAU,EAAE,CAAA;QAC5B,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC3D,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAEnD,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QAC7E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACtE,wEAAwE;QACxE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/E,CAAC,CAAC,CAAA;IAEF,2EAA2E;IAC3E,2EAA2E;IAC3E,iBAAiB;IACjB,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,yBAAyB,CAAA;QACzD,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC,CAAA;QAC/D,MAAM,IAAI,cAAc,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEpE,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAChF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClF,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC/E,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACxF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,yBAAyB,CAAA;QACzD,MAAM,IAAI,cAAc,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACzE,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QAEpC,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;QAC1C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrF,CAAC,CAAC,CAAA;IAEF,4DAA4D;IAC5D,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC,CAAA;QACpE,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEpD,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnD,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC,CAAC,CAAA;IAEF,kFAAkF;IAClF,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC,CAAA;QACpE,MAAM,GAAG,GAAG,UAAU,CAAC,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAC,CAAA;QAC5D,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvD,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;QACjE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACtE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC3E,CAAC,CAAC,CAAA;IAEF,8EAA8E;IAC9E,sEAAsE;IACtE,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE3D,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrD,CAAC,CAAC,CAAA;IAEF,0EAA0E;IAC1E,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,CACjE,+DAA+D,EAC/D,KAAK,IAAI,EAAE;QACT,MAAM,OAAO,GAAG,UAAU,EAAE,CAAA;QAC5B,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC3D,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QACrC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,kBAAkB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;YAE3E,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAA;YACnD,MAAM,CAAE,OAA+B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;YACvE,MAAM,CAAE,OAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;YACjE,MAAM,CAAE,OAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YACtE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrD,CAAC;gBAAS,CAAC;YACT,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QACvC,CAAC;QACD,iEAAiE;QACjE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/E,CAAC,CACF,CAAA;IAED,8EAA8E;IAC9E,gEAAgE;IAChE,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAA;QAErD,MAAM,OAAO,GAAG,MAAM,kBAAkB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;QAE3E,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAA;QACnD,MAAM,CAAE,OAA+B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QACvE,MAAM,CAAE,OAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QACjE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAEhE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,kBAAkB,EAAE,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAA;QAEvF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Data directory for this server, chosen the way the telegram server chooses
|
|
3
|
+
* its own: a single resolver, one base directory, an env override, and a guard
|
|
4
|
+
* that a hostile value cannot walk out of the base.
|
|
5
|
+
*
|
|
6
|
+
* Workspace state is hull's per-plugin credential store, so the base is hull's
|
|
7
|
+
* home directory and the store lands in `<base>/.workspace/`
|
|
8
|
+
* (`config.json` for the single-user bucket, `subs/<sub>/config.json` for the
|
|
9
|
+
* HTTP multi-user ones). The directory name is `STORE_PLUGIN` from
|
|
10
|
+
* src/constants.ts with the leading dot hull's layout adds; a test pins the two
|
|
11
|
+
* together. Stores written by earlier releases under `~/.better-workspace/` are
|
|
12
|
+
* copied forward once at startup (see src/data-dir-migration.ts).
|
|
13
|
+
*
|
|
14
|
+
* `WORKSPACE_DATA_DIR` replaces the base outright, so a container can mount a
|
|
15
|
+
* single volume: `-e WORKSPACE_DATA_DIR=/data` -> `/data/.workspace/config.json`.
|
|
16
|
+
*
|
|
17
|
+
* Guard: a RELATIVE value is resolved against `$HOME` and must stay inside it,
|
|
18
|
+
* so `..`, `../..`, `..\\..` and NUL bytes cannot leave the base. An ABSOLUTE
|
|
19
|
+
* value is an explicit operator choice (a mounted volume) and is normalized and
|
|
20
|
+
* taken as-is. Empty or whitespace-only means "use the default", because plugin
|
|
21
|
+
* manifests set unset env vars to `""`.
|
|
22
|
+
*/
|
|
23
|
+
import { type MigrationReport } from './data-dir-migration.js';
|
|
24
|
+
/** Env var that replaces the base directory. */
|
|
25
|
+
export declare const DATA_DIR_ENV = "WORKSPACE_DATA_DIR";
|
|
26
|
+
/** Directory name this server owns under the base (hull's `.<STORE_PLUGIN>`). */
|
|
27
|
+
export declare const DATA_DIR_NAME = ".workspace";
|
|
28
|
+
/** A `DATA_DIR` value that would leave the base directory. */
|
|
29
|
+
export declare class DataDirEscapeError extends Error {
|
|
30
|
+
constructor(message: string);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Absolute base directory this server's state lives under: `WORKSPACE_DATA_DIR`
|
|
34
|
+
* when set, else the home directory.
|
|
35
|
+
*/
|
|
36
|
+
export declare function resolveBaseDir(env?: NodeJS.ProcessEnv, home?: string): string;
|
|
37
|
+
/** Absolute directory holding this server's credential store. */
|
|
38
|
+
export declare function resolveDataDir(env?: NodeJS.ProcessEnv, home?: string): string;
|
|
39
|
+
/**
|
|
40
|
+
* Point hull's store at `WORKSPACE_DATA_DIR`, once per process, before any
|
|
41
|
+
* credential read or write. Returns the base directory in force, or null when
|
|
42
|
+
* no override is set (nothing is touched, so the default stays dynamic).
|
|
43
|
+
*
|
|
44
|
+
* hull derives the encrypted blob, the machine key that decrypts it, and the
|
|
45
|
+
* legacy fallback directories from ONE home directory (`dataDir()`,
|
|
46
|
+
* `getHomeDir()`). Moving only the blob's base -- the `LocalFsBackend` seam --
|
|
47
|
+
* would leave the key behind, so a blob written under the override could not be
|
|
48
|
+
* decrypted on the next run. The home override is therefore the only correct
|
|
49
|
+
* seam, and it is the same all-or-nothing behaviour as telegram's
|
|
50
|
+
* `TELEGRAM_DATA_DIR`, which also bypasses the legacy directory handling.
|
|
51
|
+
*/
|
|
52
|
+
export declare function applyDataDirOverride(env?: NodeJS.ProcessEnv): string | null;
|
|
53
|
+
/**
|
|
54
|
+
* Prepare the store before the first credential read: put `WORKSPACE_DATA_DIR`
|
|
55
|
+
* in force (so hull's home is the base this process writes under) and copy a
|
|
56
|
+
* pre-rename store forward. Both steps are process-wide and idempotent.
|
|
57
|
+
*/
|
|
58
|
+
export declare function prepareDataDir(env?: NodeJS.ProcessEnv): Promise<MigrationReport>;
|
|
59
|
+
//# sourceMappingURL=data-dir.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir.d.ts","sourceRoot":"","sources":["../../src/data-dir.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAQH,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,yBAAyB,CAAA;AAElF,gDAAgD;AAChD,eAAO,MAAM,YAAY,uBAAuB,CAAA;AAEhD,iFAAiF;AACjF,eAAO,MAAM,aAAa,eAAqB,CAAA;AAE/C,8DAA8D;AAC9D,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,EAAE,IAAI,GAAE,MAAkB,GAAG,MAAM,CAkBrG;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,EAAE,IAAI,GAAE,MAAkB,GAAG,MAAM,CAErG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,GAAG,IAAI,CAKxF;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,OAAO,CAAC,eAAe,CAAC,CAGnG"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Data directory for this server, chosen the way the telegram server chooses
|
|
3
|
+
* its own: a single resolver, one base directory, an env override, and a guard
|
|
4
|
+
* that a hostile value cannot walk out of the base.
|
|
5
|
+
*
|
|
6
|
+
* Workspace state is hull's per-plugin credential store, so the base is hull's
|
|
7
|
+
* home directory and the store lands in `<base>/.workspace/`
|
|
8
|
+
* (`config.json` for the single-user bucket, `subs/<sub>/config.json` for the
|
|
9
|
+
* HTTP multi-user ones). The directory name is `STORE_PLUGIN` from
|
|
10
|
+
* src/constants.ts with the leading dot hull's layout adds; a test pins the two
|
|
11
|
+
* together. Stores written by earlier releases under `~/.better-workspace/` are
|
|
12
|
+
* copied forward once at startup (see src/data-dir-migration.ts).
|
|
13
|
+
*
|
|
14
|
+
* `WORKSPACE_DATA_DIR` replaces the base outright, so a container can mount a
|
|
15
|
+
* single volume: `-e WORKSPACE_DATA_DIR=/data` -> `/data/.workspace/config.json`.
|
|
16
|
+
*
|
|
17
|
+
* Guard: a RELATIVE value is resolved against `$HOME` and must stay inside it,
|
|
18
|
+
* so `..`, `../..`, `..\\..` and NUL bytes cannot leave the base. An ABSOLUTE
|
|
19
|
+
* value is an explicit operator choice (a mounted volume) and is normalized and
|
|
20
|
+
* taken as-is. Empty or whitespace-only means "use the default", because plugin
|
|
21
|
+
* manifests set unset env vars to `""`.
|
|
22
|
+
*/
|
|
23
|
+
import { homedir } from 'node:os';
|
|
24
|
+
import { isAbsolute, join, resolve, sep } from 'node:path';
|
|
25
|
+
// hull derives the store directory from one process-wide home; it exposes that
|
|
26
|
+
// override only under this name (there is no production alias in 0.4.x).
|
|
27
|
+
import { setHomeDirForTesting as overrideHullHomeDir } from '@n24q02m/hull/storage';
|
|
28
|
+
import { STORE_PLUGIN } from './constants.js';
|
|
29
|
+
import { migrateLegacyStore } from './data-dir-migration.js';
|
|
30
|
+
/** Env var that replaces the base directory. */
|
|
31
|
+
export const DATA_DIR_ENV = 'WORKSPACE_DATA_DIR';
|
|
32
|
+
/** Directory name this server owns under the base (hull's `.<STORE_PLUGIN>`). */
|
|
33
|
+
export const DATA_DIR_NAME = `.${STORE_PLUGIN}`;
|
|
34
|
+
/** A `DATA_DIR` value that would leave the base directory. */
|
|
35
|
+
export class DataDirEscapeError extends Error {
|
|
36
|
+
constructor(message) {
|
|
37
|
+
super(message);
|
|
38
|
+
this.name = 'DataDirEscapeError';
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Absolute base directory this server's state lives under: `WORKSPACE_DATA_DIR`
|
|
43
|
+
* when set, else the home directory.
|
|
44
|
+
*/
|
|
45
|
+
export function resolveBaseDir(env = process.env, home = homedir()) {
|
|
46
|
+
const base = resolve(home);
|
|
47
|
+
const raw = env[DATA_DIR_ENV]?.trim();
|
|
48
|
+
if (!raw)
|
|
49
|
+
return base;
|
|
50
|
+
if (raw.includes('\0')) {
|
|
51
|
+
throw new DataDirEscapeError(`${DATA_DIR_ENV} must not contain a NUL byte`);
|
|
52
|
+
}
|
|
53
|
+
if (isAbsolute(raw))
|
|
54
|
+
return resolve(raw);
|
|
55
|
+
const target = resolve(base, raw);
|
|
56
|
+
if (target !== base && !target.startsWith(base + sep)) {
|
|
57
|
+
throw new DataDirEscapeError(`${DATA_DIR_ENV}="${raw}" escapes the base directory ${base}; use an absolute path to choose another directory`);
|
|
58
|
+
}
|
|
59
|
+
return target;
|
|
60
|
+
}
|
|
61
|
+
/** Absolute directory holding this server's credential store. */
|
|
62
|
+
export function resolveDataDir(env = process.env, home = homedir()) {
|
|
63
|
+
return join(resolveBaseDir(env, home), DATA_DIR_NAME);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Point hull's store at `WORKSPACE_DATA_DIR`, once per process, before any
|
|
67
|
+
* credential read or write. Returns the base directory in force, or null when
|
|
68
|
+
* no override is set (nothing is touched, so the default stays dynamic).
|
|
69
|
+
*
|
|
70
|
+
* hull derives the encrypted blob, the machine key that decrypts it, and the
|
|
71
|
+
* legacy fallback directories from ONE home directory (`dataDir()`,
|
|
72
|
+
* `getHomeDir()`). Moving only the blob's base -- the `LocalFsBackend` seam --
|
|
73
|
+
* would leave the key behind, so a blob written under the override could not be
|
|
74
|
+
* decrypted on the next run. The home override is therefore the only correct
|
|
75
|
+
* seam, and it is the same all-or-nothing behaviour as telegram's
|
|
76
|
+
* `TELEGRAM_DATA_DIR`, which also bypasses the legacy directory handling.
|
|
77
|
+
*/
|
|
78
|
+
export function applyDataDirOverride(env = process.env) {
|
|
79
|
+
if (!env[DATA_DIR_ENV]?.trim())
|
|
80
|
+
return null;
|
|
81
|
+
const base = resolveBaseDir(env);
|
|
82
|
+
overrideHullHomeDir(base);
|
|
83
|
+
return base;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Prepare the store before the first credential read: put `WORKSPACE_DATA_DIR`
|
|
87
|
+
* in force (so hull's home is the base this process writes under) and copy a
|
|
88
|
+
* pre-rename store forward. Both steps are process-wide and idempotent.
|
|
89
|
+
*/
|
|
90
|
+
export async function prepareDataDir(env = process.env) {
|
|
91
|
+
applyDataDirOverride(env);
|
|
92
|
+
return migrateLegacyStore();
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=data-dir.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir.js","sourceRoot":"","sources":["../../src/data-dir.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAC1D,+EAA+E;AAC/E,yEAAyE;AACzE,OAAO,EAAE,oBAAoB,IAAI,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAwB,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAElF,gDAAgD;AAChD,MAAM,CAAC,MAAM,YAAY,GAAG,oBAAoB,CAAA;AAEhD,iFAAiF;AACjF,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,YAAY,EAAE,CAAA;AAE/C,8DAA8D;AAC9D,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;IAClC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,MAAyB,OAAO,CAAC,GAAG,EAAE,OAAe,OAAO,EAAE;IAC3F,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAA;IACrC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAA;IAErB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,kBAAkB,CAAC,GAAG,YAAY,8BAA8B,CAAC,CAAA;IAC7E,CAAC;IAED,IAAI,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAA;IAExC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IACjC,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,kBAAkB,CAC1B,GAAG,YAAY,KAAK,GAAG,gCAAgC,IAAI,oDAAoD,CAChH,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,cAAc,CAAC,MAAyB,OAAO,CAAC,GAAG,EAAE,OAAe,OAAO,EAAE;IAC3F,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAyB,OAAO,CAAC,GAAG;IACvE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE;QAAE,OAAO,IAAI,CAAA;IAC3C,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;IAChC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAyB,OAAO,CAAC,GAAG;IACvE,oBAAoB,CAAC,GAAG,CAAC,CAAA;IACzB,OAAO,kBAAkB,EAAE,CAAA;AAC7B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir.test.d.ts","sourceRoot":"","sources":["../../src/data-dir.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { existsSync, mkdtempSync, rmSync } from 'node:fs';
|
|
2
|
+
import { tmpdir } from 'node:os';
|
|
3
|
+
import { join, resolve } from 'node:path';
|
|
4
|
+
import { dataDir, PerPluginStore } from '@n24q02m/hull/storage';
|
|
5
|
+
import { afterEach, describe, expect, it } from 'vitest';
|
|
6
|
+
import { STORE_PLUGIN } from './constants.js';
|
|
7
|
+
import { applyDataDirOverride, DATA_DIR_ENV, DATA_DIR_NAME, DataDirEscapeError, resolveBaseDir, resolveDataDir } from './data-dir.js';
|
|
8
|
+
// Platform-neutral absolute home: `resolve` makes it absolute on Windows too.
|
|
9
|
+
const HOME = resolve('/', 'home', 'user');
|
|
10
|
+
afterEach(() => {
|
|
11
|
+
// `applyDataDirOverride` moves hull's process-wide home; put it back.
|
|
12
|
+
applyDataDirOverride({});
|
|
13
|
+
});
|
|
14
|
+
describe('resolveDataDir', () => {
|
|
15
|
+
it('names the directory hull uses for STORE_PLUGIN', () => {
|
|
16
|
+
expect(DATA_DIR_NAME).toBe(`.${STORE_PLUGIN}`);
|
|
17
|
+
});
|
|
18
|
+
it('resolves the default data dir under the home directory', () => {
|
|
19
|
+
expect(resolveBaseDir({}, HOME)).toBe(HOME);
|
|
20
|
+
expect(resolveDataDir({}, HOME)).toBe(join(HOME, DATA_DIR_NAME));
|
|
21
|
+
});
|
|
22
|
+
it('honors an absolute DATA_DIR override', () => {
|
|
23
|
+
const override = resolve('/', 'srv', 'workspace');
|
|
24
|
+
expect(resolveDataDir({ [DATA_DIR_ENV]: override }, HOME)).toBe(join(override, DATA_DIR_NAME));
|
|
25
|
+
});
|
|
26
|
+
it('resolves a relative DATA_DIR override inside the base dir', () => {
|
|
27
|
+
expect(resolveBaseDir({ [DATA_DIR_ENV]: 'state/workspace' }, HOME)).toBe(join(HOME, 'state', 'workspace'));
|
|
28
|
+
expect(resolveDataDir({ [DATA_DIR_ENV]: './state/../state/workspace' }, HOME)).toBe(join(HOME, 'state', 'workspace', DATA_DIR_NAME));
|
|
29
|
+
});
|
|
30
|
+
it('rejects a relative DATA_DIR override that escapes the base dir', () => {
|
|
31
|
+
// Native separators, so the traversal is real on POSIX and on Windows; a
|
|
32
|
+
// backslash path is only a traversal where the platform treats it as one.
|
|
33
|
+
const hostile = ['..', '../..', '../../etc', 'state/../../..', join('..', '..', 'windows')];
|
|
34
|
+
if (process.platform === 'win32')
|
|
35
|
+
hostile.push('..\\..\\windows');
|
|
36
|
+
for (const value of hostile) {
|
|
37
|
+
expect(() => resolveDataDir({ [DATA_DIR_ENV]: value }, HOME), value).toThrow(DataDirEscapeError);
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
it('rejects a DATA_DIR override containing a NUL byte', () => {
|
|
41
|
+
expect(() => resolveDataDir({ [DATA_DIR_ENV]: `${HOME}\0evil` }, HOME)).toThrow(DataDirEscapeError);
|
|
42
|
+
});
|
|
43
|
+
it('falls back to the default when DATA_DIR is empty or whitespace', () => {
|
|
44
|
+
expect(resolveDataDir({ [DATA_DIR_ENV]: '' }, HOME)).toBe(join(HOME, DATA_DIR_NAME));
|
|
45
|
+
expect(resolveDataDir({ [DATA_DIR_ENV]: ' ' }, HOME)).toBe(join(HOME, DATA_DIR_NAME));
|
|
46
|
+
expect(resolveDataDir({ [DATA_DIR_ENV]: undefined }, HOME)).toBe(join(HOME, DATA_DIR_NAME));
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
describe('applyDataDirOverride', () => {
|
|
50
|
+
it('moves hull’s per-plugin store under the override', () => {
|
|
51
|
+
const override = resolve('/', 'srv', 'workspace');
|
|
52
|
+
expect(applyDataDirOverride({ [DATA_DIR_ENV]: override })).toBe(override);
|
|
53
|
+
expect(dataDir(STORE_PLUGIN)).toBe(join(override, DATA_DIR_NAME));
|
|
54
|
+
});
|
|
55
|
+
it('writes the credential store under the override', async () => {
|
|
56
|
+
const base = mkdtempSync(join(tmpdir(), 'data-dir-store-'));
|
|
57
|
+
try {
|
|
58
|
+
applyDataDirOverride({ [DATA_DIR_ENV]: base });
|
|
59
|
+
await new PerPluginStore(STORE_PLUGIN).save({ GOOGLE_OAUTH_CLIENT_ID: 'cid' });
|
|
60
|
+
expect(existsSync(join(base, DATA_DIR_NAME, 'config.json'))).toBe(true);
|
|
61
|
+
expect(await new PerPluginStore(STORE_PLUGIN).load()).toEqual({ GOOGLE_OAUTH_CLIENT_ID: 'cid' });
|
|
62
|
+
}
|
|
63
|
+
finally {
|
|
64
|
+
rmSync(base, { recursive: true, force: true });
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
it('leaves hull alone when DATA_DIR is unset', () => {
|
|
68
|
+
const before = dataDir(STORE_PLUGIN);
|
|
69
|
+
expect(applyDataDirOverride({})).toBeNull();
|
|
70
|
+
expect(dataDir(STORE_PLUGIN)).toBe(before);
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
//# sourceMappingURL=data-dir.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-dir.test.js","sourceRoot":"","sources":["../../src/data-dir.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EACL,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,cAAc,EACf,MAAM,eAAe,CAAA;AAEtB,8EAA8E;AAC9E,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAEzC,SAAS,CAAC,GAAG,EAAE;IACb,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,CAAC,CAAA;AAC1B,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,YAAY,EAAE,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;QACjD,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAA;IAChG,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,iBAAiB,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QAC1G,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,4BAA4B,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CACjF,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,CAChD,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,yEAAyE;QACzE,0EAA0E;QAC1E,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAA;QAC3F,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;YAAE,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAEjE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;QAClG,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACrG,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;QACpF,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;QACvF,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;IAC7F,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;QAEjD,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACzE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAA;IACnE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC;YACH,oBAAoB,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;YAE9C,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,CAAA;YAE9E,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACvE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,CAAA;QAClG,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAChD,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;QACpC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC3C,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|