resplite 1.3.2 → 1.3.5
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/README.md +1 -4
- package/package.json +1 -1
- package/src/migration/apply-dirty.js +3 -55
- package/src/migration/bulk.js +2 -19
- package/src/migration/import-one.js +2 -2
package/README.md
CHANGED
|
@@ -189,10 +189,7 @@ await m.close();
|
|
|
189
189
|
`resume` defaults to `true`. It doesn't matter whether it's the first run or a resume: the same script works for both starting and continuing. The first run starts from cursor 0; if the process is interrupted (Ctrl+C, crash, etc.), running the script again continues from the last checkpoint. You don't need to pass `resume: false` on the first run or change anything to resume.
|
|
190
190
|
|
|
191
191
|
**Graceful shutdown**
|
|
192
|
-
On SIGINT (Ctrl+C) or SIGTERM, the bulk importer checkpoints progress, sets the run status to `aborted`, closes the SQLite database cleanly (so WAL is checkpointed and the file is not left open), then exits. You can safely interrupt a long-running bulk and resume later.
|
|
193
|
-
|
|
194
|
-
**Errors and stalls**
|
|
195
|
-
Use `onProgress` to see progress and detect problems. The callback receives the run row (e.g. `scanned_keys`, `migrated_keys`, `dirty_keys_applied`, `last_error`). If progress stops for a long time (e.g. Redis hang or network issue), you may see `_stallWarning: true` and `_stallMessage` in the progress object every 15 seconds. When a key fails to import, the error is logged to `migration_errors` and the run’s `last_error` is set; the real error message is included so you can diagnose. After any failure, check `m.status()` and query `migration_errors` in the DB if needed.
|
|
192
|
+
On SIGINT (Ctrl+C) or SIGTERM, the bulk importer checkpoints progress, sets the run status to `aborted`, closes the SQLite database cleanly (so WAL is checkpointed and the file is not left open), then exits. You can safely interrupt a long-running bulk and resume later.
|
|
196
193
|
|
|
197
194
|
The JS API can run the dirty-key tracker in-process via `m.startDirtyTracker()` / `m.stopDirtyTracker()`, so the full flow stays inside a single script.
|
|
198
195
|
|
package/package.json
CHANGED
|
@@ -9,20 +9,15 @@ import { createHashesStorage } from '../storage/sqlite/hashes.js';
|
|
|
9
9
|
import { createSetsStorage } from '../storage/sqlite/sets.js';
|
|
10
10
|
import { createListsStorage } from '../storage/sqlite/lists.js';
|
|
11
11
|
import { createZsetsStorage } from '../storage/sqlite/zsets.js';
|
|
12
|
-
import { getRun, getDirtyBatch, markDirtyState, logError,
|
|
12
|
+
import { getRun, getDirtyBatch, markDirtyState, logError, RUN_STATUS } from './registry.js';
|
|
13
13
|
import { importKeyFromRedis } from './import-one.js';
|
|
14
14
|
|
|
15
15
|
function sleep(ms) {
|
|
16
16
|
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
-
const HEARTBEAT_INTERVAL_MS = 15000;
|
|
20
|
-
const STALL_WARNING_MS = 60000;
|
|
21
|
-
|
|
22
19
|
/**
|
|
23
20
|
* Apply dirty keys: for each key in registry with state=dirty, reimport from Redis or delete in destination.
|
|
24
|
-
* On SIGINT/SIGTERM, sets run status to ABORTED, closes DB and rethrows so the process can exit and Ctrl+C works.
|
|
25
|
-
*
|
|
26
21
|
* @param {import('redis').RedisClientType} redisClient
|
|
27
22
|
* @param {string} dbPath
|
|
28
23
|
* @param {string} runId
|
|
@@ -30,32 +25,12 @@ const STALL_WARNING_MS = 60000;
|
|
|
30
25
|
* @param {string} [options.pragmaTemplate='default']
|
|
31
26
|
* @param {number} [options.batch_keys=200]
|
|
32
27
|
* @param {number} [options.max_rps=0]
|
|
33
|
-
* @param {(run: object) => void | Promise<void>} [options.onProgress] - Called after each batch
|
|
28
|
+
* @param {(run: object) => void | Promise<void>} [options.onProgress] - Called after each batch with the current run row.
|
|
34
29
|
*/
|
|
35
30
|
export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
36
31
|
const { pragmaTemplate = 'default', batch_keys = 200, max_rps = 0, onProgress } = options;
|
|
37
32
|
|
|
38
33
|
const db = openDb(dbPath, { pragmaTemplate });
|
|
39
|
-
let abortRequested = false;
|
|
40
|
-
const onSignal = () => {
|
|
41
|
-
abortRequested = true;
|
|
42
|
-
};
|
|
43
|
-
process.on('SIGINT', onSignal);
|
|
44
|
-
process.on('SIGTERM', onSignal);
|
|
45
|
-
|
|
46
|
-
let heartbeatTimer = null;
|
|
47
|
-
if (onProgress) {
|
|
48
|
-
heartbeatTimer = setInterval(() => {
|
|
49
|
-
const run = getRun(db, runId);
|
|
50
|
-
if (!run) return;
|
|
51
|
-
let payload = run;
|
|
52
|
-
if (run.updated_at && Date.now() - run.updated_at > STALL_WARNING_MS) {
|
|
53
|
-
payload = { ...run, _stallWarning: true, _stallMessage: 'No progress for 60s — possible hang or Redis timeout' };
|
|
54
|
-
}
|
|
55
|
-
Promise.resolve(onProgress(payload)).catch(() => {});
|
|
56
|
-
}, HEARTBEAT_INTERVAL_MS);
|
|
57
|
-
}
|
|
58
|
-
|
|
59
34
|
const run = getRun(db, runId);
|
|
60
35
|
if (!run) throw new Error(`Run ${runId} not found`);
|
|
61
36
|
|
|
@@ -70,9 +45,7 @@ export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
|
70
45
|
const minIntervalMs = max_rps > 0 ? 1000 / max_rps : 0;
|
|
71
46
|
let lastKeyTime = 0;
|
|
72
47
|
|
|
73
|
-
try {
|
|
74
48
|
for (;;) {
|
|
75
|
-
if (abortRequested) break;
|
|
76
49
|
let r = getRun(db, runId);
|
|
77
50
|
if (r && r.status === RUN_STATUS.ABORTED) break;
|
|
78
51
|
while (r && r.status === RUN_STATUS.PAUSED) {
|
|
@@ -88,7 +61,6 @@ export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
|
88
61
|
|
|
89
62
|
// ── Re-import (or remove) keys that changed while bulk was running ──
|
|
90
63
|
for (const { key: keyBuf } of dirtyBatch) {
|
|
91
|
-
if (abortRequested) break;
|
|
92
64
|
r = getRun(db, runId);
|
|
93
65
|
if (r && r.status === RUN_STATUS.ABORTED) break;
|
|
94
66
|
while (r && r.status === RUN_STATUS.PAUSED) {
|
|
@@ -115,7 +87,7 @@ export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
|
115
87
|
} else if (outcome.skipped) {
|
|
116
88
|
markDirtyState(db, runId, keyBuf, 'skipped');
|
|
117
89
|
} else {
|
|
118
|
-
logError(db, runId, 'dirty_apply', outcome.
|
|
90
|
+
logError(db, runId, 'dirty_apply', outcome.error ? 'Import failed' : 'Skipped', keyName);
|
|
119
91
|
markDirtyState(db, runId, keyBuf, 'error');
|
|
120
92
|
}
|
|
121
93
|
}
|
|
@@ -130,7 +102,6 @@ export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
|
130
102
|
// Marked as 'deleted' in the run counter; state changed away from 'deleted'
|
|
131
103
|
// so the next getDirtyBatch call won't return them again (avoiding infinite loop).
|
|
132
104
|
for (const { key: keyBuf } of deletedBatch) {
|
|
133
|
-
if (abortRequested) break;
|
|
134
105
|
r = getRun(db, runId);
|
|
135
106
|
if (r && r.status === RUN_STATUS.ABORTED) break;
|
|
136
107
|
while (r && r.status === RUN_STATUS.PAUSED) {
|
|
@@ -160,28 +131,5 @@ export async function runApplyDirty(redisClient, dbPath, runId, options = {}) {
|
|
|
160
131
|
}
|
|
161
132
|
}
|
|
162
133
|
|
|
163
|
-
if (abortRequested) {
|
|
164
|
-
setRunStatus(db, runId, RUN_STATUS.ABORTED);
|
|
165
|
-
updateBulkProgress(db, runId, { last_error: 'Interrupted by SIGINT/SIGTERM' });
|
|
166
|
-
const run = getRun(db, runId);
|
|
167
|
-
if (onProgress && run) Promise.resolve(onProgress(run)).catch(() => {});
|
|
168
|
-
const err = new Error('Apply dirty interrupted by signal (SIGINT/SIGTERM)');
|
|
169
|
-
err.code = 'APPLY_DIRTY_ABORTED';
|
|
170
|
-
throw err;
|
|
171
|
-
}
|
|
172
|
-
|
|
173
134
|
return getRun(db, runId);
|
|
174
|
-
} catch (err) {
|
|
175
|
-
if (err.code !== 'APPLY_DIRTY_ABORTED') {
|
|
176
|
-
setRunStatus(db, runId, RUN_STATUS.FAILED);
|
|
177
|
-
updateBulkProgress(db, runId, { last_error: err.message });
|
|
178
|
-
logError(db, runId, 'dirty_apply', err.message, null);
|
|
179
|
-
}
|
|
180
|
-
throw err;
|
|
181
|
-
} finally {
|
|
182
|
-
if (heartbeatTimer) clearInterval(heartbeatTimer);
|
|
183
|
-
process.off('SIGINT', onSignal);
|
|
184
|
-
process.off('SIGTERM', onSignal);
|
|
185
|
-
db.close();
|
|
186
|
-
}
|
|
187
135
|
}
|
package/src/migration/bulk.js
CHANGED
|
@@ -35,9 +35,6 @@ function sleep(ms) {
|
|
|
35
35
|
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
36
36
|
}
|
|
37
37
|
|
|
38
|
-
const HEARTBEAT_INTERVAL_MS = 15000;
|
|
39
|
-
const STALL_WARNING_MS = 60000;
|
|
40
|
-
|
|
41
38
|
/**
|
|
42
39
|
* Run bulk import: SCAN keys from Redis, import into RespLite DB with checkpointing.
|
|
43
40
|
* On SIGINT/SIGTERM, checkpoint progress, set run status to ABORTED, close DB and rethrow.
|
|
@@ -55,7 +52,7 @@ const STALL_WARNING_MS = 60000;
|
|
|
55
52
|
* @param {number} [options.batch_bytes=64*1024*1024] - 64MB
|
|
56
53
|
* @param {number} [options.checkpoint_interval_sec=30]
|
|
57
54
|
* @param {boolean} [options.resume=true] - true: start from 0 or continue from checkpoint; false: always start from 0
|
|
58
|
-
* @param {function(run): void} [options.onProgress] - called after checkpoint
|
|
55
|
+
* @param {function(run): void} [options.onProgress] - called after checkpoint with run row
|
|
59
56
|
*/
|
|
60
57
|
export async function runBulkImport(redisClient, dbPath, runId, options = {}) {
|
|
61
58
|
const {
|
|
@@ -78,19 +75,6 @@ export async function runBulkImport(redisClient, dbPath, runId, options = {}) {
|
|
|
78
75
|
process.on('SIGINT', onSignal);
|
|
79
76
|
process.on('SIGTERM', onSignal);
|
|
80
77
|
|
|
81
|
-
let heartbeatTimer = null;
|
|
82
|
-
if (onProgress) {
|
|
83
|
-
heartbeatTimer = setInterval(() => {
|
|
84
|
-
const run = getRun(db, runId);
|
|
85
|
-
if (!run) return;
|
|
86
|
-
let payload = run;
|
|
87
|
-
if (run.updated_at && Date.now() - run.updated_at > STALL_WARNING_MS) {
|
|
88
|
-
payload = { ...run, _stallWarning: true, _stallMessage: 'No progress for 60s — possible hang or Redis timeout' };
|
|
89
|
-
}
|
|
90
|
-
Promise.resolve(onProgress(payload)).catch(() => {});
|
|
91
|
-
}, HEARTBEAT_INTERVAL_MS);
|
|
92
|
-
}
|
|
93
|
-
|
|
94
78
|
try {
|
|
95
79
|
const keys = createKeysStorage(db);
|
|
96
80
|
const strings = createStringsStorage(db, keys);
|
|
@@ -162,7 +146,7 @@ export async function runBulkImport(redisClient, dbPath, runId, options = {}) {
|
|
|
162
146
|
skipped_keys++;
|
|
163
147
|
} else {
|
|
164
148
|
error_keys++;
|
|
165
|
-
logError(db, runId, 'bulk', outcome.
|
|
149
|
+
logError(db, runId, 'bulk', outcome.error ? 'Import failed' : 'Skipped', keyName);
|
|
166
150
|
}
|
|
167
151
|
|
|
168
152
|
const now2 = Date.now();
|
|
@@ -223,7 +207,6 @@ export async function runBulkImport(redisClient, dbPath, runId, options = {}) {
|
|
|
223
207
|
}
|
|
224
208
|
throw err;
|
|
225
209
|
} finally {
|
|
226
|
-
if (heartbeatTimer) clearInterval(heartbeatTimer);
|
|
227
210
|
process.off('SIGINT', onSignal);
|
|
228
211
|
process.off('SIGTERM', onSignal);
|
|
229
212
|
db.close();
|
|
@@ -20,7 +20,7 @@ function toBuffer(value) {
|
|
|
20
20
|
* @param {string} keyName
|
|
21
21
|
* @param {{ keys: import('../storage/sqlite/keys.js').ReturnType<import('../storage/sqlite/keys.js').createKeysStorage>; strings: ReturnType<import('../storage/sqlite/strings.js').createStringsStorage>; hashes: ReturnType<import('../storage/sqlite/hashes.js').createHashesStorage>; sets: ReturnType<import('../storage/sqlite/sets.js').createSetsStorage>; lists: ReturnType<import('../storage/sqlite/lists.js').createListsStorage>; zsets: ReturnType<import('../storage/sqlite/zsets.js').createZsetsStorage> }} storages
|
|
22
22
|
* @param {{ now?: number }} options
|
|
23
|
-
* @returns {Promise<{ ok: boolean; skipped?: boolean; error?: boolean;
|
|
23
|
+
* @returns {Promise<{ ok: boolean; skipped?: boolean; error?: boolean; bytes?: number }>}
|
|
24
24
|
*/
|
|
25
25
|
export async function importKeyFromRedis(redisClient, keyName, storages, options = {}) {
|
|
26
26
|
const now = options.now ?? Date.now();
|
|
@@ -99,7 +99,7 @@ export async function importKeyFromRedis(redisClient, keyName, storages, options
|
|
|
99
99
|
|
|
100
100
|
return { ok: false, skipped: true };
|
|
101
101
|
} catch (err) {
|
|
102
|
-
return { ok: false, error: true
|
|
102
|
+
return { ok: false, error: true };
|
|
103
103
|
}
|
|
104
104
|
}
|
|
105
105
|
|