{{ message }}
Repository navigation
Expand file tree
/
Copy pathexport-user-data.ts
More file actions
403 lines (353 loc) · 15.8 KB
/
Copy pathexport-user-data.ts
File metadata and controls
403 lines (353 loc) · 15.8 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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
// SPDX-License-Identifier: AGPL-3.0-or-later
/**
* ModelScript GDPR / CCPA Data Archive Batch Exporter
* Generates self-contained ZIP archives with interactive offline HTML viewers
* or raw JSON export bundles with async worker queueing and concurrency limits.
*
* Usage:
* npx tsx scripts/export-user-data.ts [usernames_or_ids...] [options]
* npx tsx scripts/export-user-data.ts --all --concurrency 3 --output-dir ./data/archives
*/
import fs from "node:fs";
import path from "node:path";
import { LibraryDatabase } from "../apps/api/src/database.js";
import { gatherUserDataBundle, generateUserArchiveZip } from "../apps/api/src/services/user-archive.js";
interface CliOptions {
userQueries: string[];
exportAll: boolean;
concurrency: number;
outputDir: string;
explicitOutputFile?: string | undefined;
format: "zip" | "json";
dbDir?: string | undefined;
quiet: boolean;
}
interface BatchJob {
index: number;
user: {
id: number;
username: string;
email: string;
account_type?: string | undefined;
};
format: "zip" | "json";
outputPath: string;
status: "queued" | "processing" | "completed" | "failed";
workerId?: number | undefined;
startedAt?: number | undefined;
completedAt?: number | undefined;
durationMs?: number | undefined;
fileSizeBytes?: number | undefined;
error?: string | undefined;
}
const isTTY = Boolean(process.stdout.isTTY && !process.env["NO_COLOR"]);
const c = {
bold: (s: string) => (isTTY ? `\x1b[1m${s}\x1b[0m` : s),
dim: (s: string) => (isTTY ? `\x1b[2m${s}\x1b[0m` : s),
green: (s: string) => (isTTY ? `\x1b[32m${s}\x1b[0m` : s),
red: (s: string) => (isTTY ? `\x1b[31m${s}\x1b[0m` : s),
yellow: (s: string) => (isTTY ? `\x1b[33m${s}\x1b[0m` : s),
blue: (s: string) => (isTTY ? `\x1b[34m${s}\x1b[0m` : s),
magenta: (s: string) => (isTTY ? `\x1b[35m${s}\x1b[0m` : s),
cyan: (s: string) => (isTTY ? `\x1b[36m${s}\x1b[0m` : s),
};
function printHelp(): void {
console.log(`
${c.bold("ModelScript GDPR/CCPA Data Archive Batch Exporter")}
Generates self-contained ZIP archives (with offline HTML viewer) or raw JSON bundles.
${c.bold("USAGE:")}
npx tsx scripts/export-user-data.ts [usernames_or_ids...] [options]
${c.bold("TARGETS:")}
<usernames_or_ids...> One or more usernames or numeric user IDs to export
--all Export all active users found in the database
--users, -u <list> Comma-separated list of usernames or numeric IDs
${c.bold("CONCURRENCY & QUEUE:")}
--concurrency, -c <N> Maximum concurrent worker tasks (default: 2 or ARCHIVE_CONCURRENCY env)
${c.bold("OUTPUT & FORMAT:")}
--output-dir, -o <path> Directory to save generated archives (default: ./data/archives)
--output <path> Exact path for single-user archive (e.g. ./alice-archive.zip)
--format, -f <zip|json> Archive format: zip (default) or json
--json Shorthand for --format json
${c.bold("STORAGE & LOGGING:")}
--sqlite, -s <path> Path or directory of SQLite database (default: ./data)
--dir, -d <path> Alias for --sqlite
--quiet, -q Minimal output, suppresses progress bars
--help, -h Show this help message
${c.bold("EXAMPLES:")}
# Export a single user
npx tsx scripts/export-user-data.ts alice --output ./alice.zip
# Batch export multiple users with 4 workers
npx tsx scripts/export-user-data.ts alice bob charlie --concurrency 4
# Batch export ALL users with concurrency limit of 3 to a custom directory
npx tsx scripts/export-user-data.ts --all -c 3 --output-dir ./backup/gdpr-exports
`);
}
function parseArgs(args: string[]): CliOptions {
const options: CliOptions = {
userQueries: [],
exportAll: false,
concurrency: Number(process.env["ARCHIVE_CONCURRENCY"] || process.env["ARCHIVE_MAX_CONCURRENCY"]) || 2,
outputDir: path.resolve(process.cwd(), "data/archives"),
format: "zip",
quiet: false,
};
for (let i = 0; i < args.length; i++) {
const arg = args[i]!;
if (arg === "--help" || arg === "-h") {
printHelp();
process.exit(0);
} else if (arg === "--all") {
options.exportAll = true;
} else if ((arg === "--concurrency" || arg === "-c") && args[i + 1]) {
const parsed = parseInt(args[++i]!, 10);
if (Number.isFinite(parsed) && parsed > 0) {
options.concurrency = parsed;
}
} else if ((arg === "--output-dir" || arg === "-o" || arg === "--out") && args[i + 1]) {
const val = args[++i]!;
if (val.endsWith(".zip") || val.endsWith(".json")) {
options.explicitOutputFile = path.resolve(process.cwd(), val);
options.outputDir = path.dirname(options.explicitOutputFile);
} else {
options.outputDir = path.resolve(process.cwd(), val);
}
} else if (arg === "--output" && args[i + 1]) {
const val = args[++i]!;
options.explicitOutputFile = path.resolve(process.cwd(), val);
options.outputDir = path.dirname(options.explicitOutputFile);
} else if ((arg === "--users" || arg === "-u") && args[i + 1]) {
const rawList = args[++i]!;
options.userQueries.push(
...rawList
.split(",")
.map((s) => s.trim())
.filter(Boolean),
);
} else if ((arg === "--format" || arg === "-f") && args[i + 1]) {
const fmt = args[++i]!.toLowerCase();
options.format = fmt === "json" ? "json" : "zip";
} else if (arg === "--json") {
options.format = "json";
} else if ((arg === "--sqlite" || arg === "-s" || arg === "--dir" || arg === "-d") && args[i + 1]) {
options.dbDir = path.resolve(process.cwd(), args[++i]!);
} else if (arg === "--quiet" || arg === "-q") {
options.quiet = true;
} else if (!arg.startsWith("-")) {
options.userQueries.push(arg);
}
}
return options;
}
function renderProgressBar(current: number, total: number, width = 24): string {
const ratio = total > 0 ? Math.min(1, current / total) : 0;
const filled = Math.round(ratio * width);
const empty = width - filled;
const bar = "█".repeat(filled) + "░".repeat(empty);
const pct = (ratio * 100).toFixed(1).padStart(5);
return `[${c.cyan(bar)}] ${pct}%`;
}
function formatBytes(bytes: number): string {
if (bytes < 1024) return `${bytes} B`;
if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
return `${(bytes / (1024 * 1024)).toFixed(2)} MB`;
}
async function main() {
const args = process.argv.slice(2);
if (args.length === 0) {
printHelp();
process.exit(1);
}
const options = parseArgs(args);
if (!options.exportAll && options.userQueries.length === 0) {
console.error(c.red("\nError: No target users specified. Provide usernames/IDs or use --all."));
printHelp();
process.exit(1);
}
const database = new LibraryDatabase(options.dbDir);
const targetUsers: { id: number; username: string; email: string; account_type?: string | undefined }[] = [];
if (options.exportAll) {
const all = database.getAllUsers();
targetUsers.push(...all);
if (targetUsers.length === 0) {
console.log(c.yellow("No active users found in database to export."));
process.exit(0);
}
} else {
const notFound: string[] = [];
for (const query of options.userQueries) {
let user: any = null;
const numericId = Number(query);
if (!Number.isNaN(numericId) && numericId > 0) {
user = database.getUserById(numericId);
}
if (!user) {
user = database.getUserByUsername(query);
}
if (user) {
if (!targetUsers.some((u) => u.id === user.id)) {
targetUsers.push(user);
}
} else {
notFound.push(query);
}
}
if (notFound.length > 0) {
console.warn(c.yellow(`\nWarning: Could not find user(s): ${notFound.join(", ")}`));
}
if (targetUsers.length === 0) {
console.error(c.red("Error: None of the specified users could be resolved in the database."));
process.exit(1);
}
}
// Ensure output directory exists
fs.mkdirSync(options.outputDir, { recursive: true });
// Prepare batch jobs
const jobs: BatchJob[] = targetUsers.map((user, idx) => {
let targetPath: string;
if (options.explicitOutputFile && targetUsers.length === 1) {
targetPath = options.explicitOutputFile;
} else {
const ext = options.format === "json" ? "json" : "zip";
targetPath = path.join(options.outputDir, `modelscript-archive-${user.username}.${ext}`);
}
return {
index: idx + 1,
user,
format: options.format,
outputPath: targetPath,
status: "queued",
};
});
// Print Header Banner
console.log("");
console.log(c.bold("┌────────────────────────────────────────────────────────────────────────┐"));
console.log(c.bold("│ ModelScript GDPR / CCPA Data Archive Batch Processor │"));
console.log(c.bold("└────────────────────────────────────────────────────────────────────────┘"));
console.log(` ${c.dim("Regulation:")} GDPR Art. 20 / CCPA § 1798.100 Data Portability`);
console.log(` ${c.dim("Target Users:")} ${c.bold(String(jobs.length))} user(s) queued for export`);
console.log(
` ${c.dim("Concurrency:")} ${c.green(String(options.concurrency))} parallel worker slots (${c.dim(`limit: ${options.concurrency}`)})`,
);
console.log(
` ${c.dim("Format:")} ${c.cyan(options.format.toUpperCase())} ${options.format === "zip" ? "(with offline HTML viewer)" : "(raw JSON)"}`,
);
console.log(` ${c.dim("Output Directory:")} ${options.outputDir}`);
console.log(c.dim("──────────────────────────────────────────────────────────────────────────"));
console.log("");
const startTime = Date.now();
let completedCount = 0;
let failedCount = 0;
let totalBytes = 0;
let nextJobIdx = 0;
// Active worker status for dynamic CLI display
const activeWorkerMap = new Map<number, { user: string; startedAt: number }>();
function updateStatusLine(): void {
if (options.quiet || !process.stdout.isTTY) return;
const progress = renderProgressBar(completedCount + failedCount, jobs.length);
const active = activeWorkerMap.size;
const remaining = jobs.length - (completedCount + failedCount);
process.stdout.write(
`\r ${progress} ${c.bold(`${completedCount + failedCount}/${jobs.length}`)} | ${c.blue(`Active: ${active}`)} | ${c.yellow(`Queued: ${remaining}`)} | ${c.green(`Done: ${completedCount}`)}${failedCount > 0 ? ` | ${c.red(`Fail: ${failedCount}`)}` : ""}`,
);
}
async function worker(workerId: number): Promise<void> {
while (nextJobIdx < jobs.length) {
const job = jobs[nextJobIdx++];
if (!job) break;
job.status = "processing";
job.workerId = workerId;
job.startedAt = Date.now();
activeWorkerMap.set(workerId, { user: job.user.username, startedAt: job.startedAt });
updateStatusLine();
try {
if (job.format === "zip") {
const zipBuffer = generateUserArchiveZip(database, job.user.id);
if (!zipBuffer) {
throw new Error("Failed to generate archive: user record or data missing.");
}
fs.writeFileSync(job.outputPath, zipBuffer);
job.fileSizeBytes = zipBuffer.length;
} else {
const bundle = gatherUserDataBundle(database, job.user.id);
if (!bundle) {
throw new Error("Failed to gather user data: user record missing.");
}
const jsonStr = JSON.stringify(bundle, null, 2);
fs.writeFileSync(job.outputPath, jsonStr, "utf-8");
job.fileSizeBytes = Buffer.byteLength(jsonStr, "utf-8");
}
job.completedAt = Date.now();
job.durationMs = job.completedAt - job.startedAt;
job.status = "completed";
completedCount++;
totalBytes += job.fileSizeBytes || 0;
activeWorkerMap.delete(workerId);
// Print completion log line
if (process.stdout.isTTY) {
process.stdout.write("\r\x1b[K"); // clear current line
}
const sizeStr = formatBytes(job.fileSizeBytes || 0);
console.log(
` ${c.green("✔")} [${job.index}/${jobs.length}] @${c.bold(job.user.username.padEnd(14))} -> ${path.basename(job.outputPath)} ${c.dim(`(${sizeStr}, ${job.durationMs}ms)`)}`,
);
updateStatusLine();
} catch (err: any) {
job.completedAt = Date.now();
job.durationMs = job.completedAt - (job.startedAt || Date.now());
job.status = "failed";
job.error = err.message || "Unknown export error";
failedCount++;
activeWorkerMap.delete(workerId);
if (process.stdout.isTTY) {
process.stdout.write("\r\x1b[K");
}
console.log(
` ${c.red("✖")} [${job.index}/${jobs.length}] @${c.bold(job.user.username.padEnd(14))} -> ${c.red(`FAILED: ${job.error}`)} ${c.dim(`(${job.durationMs}ms)`)}`,
);
updateStatusLine();
}
}
}
// Spawn concurrency-limited workers
const workerCount = Math.min(options.concurrency, jobs.length);
const workers: Promise<void>[] = [];
for (let i = 0; i < workerCount; i++) {
workers.push(worker(i + 1));
}
await Promise.all(workers);
if (process.stdout.isTTY) {
process.stdout.write("\r\x1b[K");
}
const totalDuration = ((Date.now() - startTime) / 1000).toFixed(2);
const throughput = jobs.length > 0 ? (jobs.length / Math.max(0.1, Number(totalDuration))).toFixed(1) : "0";
// Print Summary Table
console.log("");
console.log(c.bold("┌────────────────────────────────────────────────────────────────────────┐"));
console.log(c.bold("│ Batch Export Summary │"));
console.log(c.bold("└────────────────────────────────────────────────────────────────────────┘"));
console.log(` ${c.dim("Total Jobs:")} ${jobs.length}`);
console.log(` ${c.dim("Successful:")} ${c.green(String(completedCount))}`);
if (failedCount > 0) {
console.log(` ${c.dim("Failed:")} ${c.red(String(failedCount))}`);
}
console.log(` ${c.dim("Total Data Size:")} ${formatBytes(totalBytes)}`);
console.log(` ${c.dim("Total Elapsed:")} ${totalDuration}s (${c.cyan(`${throughput} archives/sec`)})`);
console.log(` ${c.dim("Concurrency Limit:")} ${options.concurrency} workers`);
console.log(` ${c.dim("Staging Location:")} ${options.outputDir}`);
console.log(c.dim("──────────────────────────────────────────────────────────────────────────"));
if (jobs.length === 1 && completedCount === 1) {
const singleJob = jobs[0]!;
console.log(`\n${c.bold("To inspect this single archive:")}`);
console.log(` 1. Extract ${path.basename(singleJob.outputPath)}`);
console.log(` 2. Double-click "index.html" to open the interactive viewer offline.\n`);
} else {
console.log(`\n${c.green("Batch process completed successfully.")}\n`);
}
if (failedCount > 0) {
process.exit(1);
}
}
main().catch((err) => {
console.error(c.red("\nFatal error during batch export:"), err);
process.exit(1);
});
You can’t perform that action at this time.