velocious 1.0.549 → 1.0.552
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 +13 -0
- package/build/background-jobs/json-socket.js +25 -0
- package/build/background-jobs/socket-request.js +48 -6
- package/build/background-jobs/status-reporter.js +14 -2
- package/build/configuration-types.js +1 -0
- package/build/database/advisory-lock-runner.js +17 -8
- package/build/database/drivers/base.js +12 -0
- package/build/database/drivers/mssql/index.js +52 -3
- package/build/database/drivers/mysql/index.js +34 -0
- package/build/database/structure-sql-loader.js +12 -6
- package/build/src/background-jobs/json-socket.d.ts +20 -0
- package/build/src/background-jobs/json-socket.d.ts.map +1 -1
- package/build/src/background-jobs/json-socket.js +25 -1
- package/build/src/background-jobs/socket-request.d.ts +13 -1
- package/build/src/background-jobs/socket-request.d.ts.map +1 -1
- package/build/src/background-jobs/socket-request.js +44 -7
- package/build/src/background-jobs/status-reporter.d.ts +12 -1
- package/build/src/background-jobs/status-reporter.d.ts.map +1 -1
- package/build/src/background-jobs/status-reporter.js +14 -3
- package/build/src/configuration-types.d.ts +5 -0
- package/build/src/configuration-types.d.ts.map +1 -1
- package/build/src/configuration-types.js +2 -1
- package/build/src/database/advisory-lock-runner.d.ts +25 -8
- package/build/src/database/advisory-lock-runner.d.ts.map +1 -1
- package/build/src/database/advisory-lock-runner.js +18 -9
- package/build/src/database/drivers/base.d.ts +9 -0
- package/build/src/database/drivers/base.d.ts.map +1 -1
- package/build/src/database/drivers/base.js +12 -1
- package/build/src/database/drivers/mssql/index.d.ts +9 -0
- package/build/src/database/drivers/mssql/index.d.ts.map +1 -1
- package/build/src/database/drivers/mssql/index.js +45 -2
- package/build/src/database/drivers/mysql/index.d.ts.map +1 -1
- package/build/src/database/drivers/mysql/index.js +35 -1
- package/build/src/database/structure-sql-loader.d.ts.map +1 -1
- package/build/src/database/structure-sql-loader.js +14 -8
- package/build/src/testing/test.d.ts +2 -1
- package/build/src/testing/test.d.ts.map +1 -1
- package/build/src/testing/test.js +3 -2
- package/build/src/testing/wait-for-event.d.ts +46 -0
- package/build/src/testing/wait-for-event.d.ts.map +1 -0
- package/build/src/testing/wait-for-event.js +64 -0
- package/build/testing/test.js +2 -1
- package/build/testing/wait-for-event.js +72 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/background-jobs/json-socket.js +25 -0
- package/src/background-jobs/socket-request.js +48 -6
- package/src/background-jobs/status-reporter.js +14 -2
- package/src/configuration-types.js +1 -0
- package/src/database/advisory-lock-runner.js +17 -8
- package/src/database/drivers/base.js +12 -0
- package/src/database/drivers/mssql/index.js +52 -3
- package/src/database/drivers/mysql/index.js +34 -0
- package/src/database/structure-sql-loader.js +12 -6
- package/src/testing/test.js +2 -1
- package/src/testing/wait-for-event.js +72 -0
package/README.md
CHANGED
|
@@ -141,6 +141,19 @@ Slowest 10 tests:
|
|
|
141
141
|
|
|
142
142
|
The report is skipped for single-test runs. See [docs/testing-guidelines.md](docs/testing-guidelines.md).
|
|
143
143
|
|
|
144
|
+
Prefer waiting for a real signal or condition over sleeping a fixed duration. `waitForEvent(emitter, eventName, {timeoutMs, filter})` resolves the instant a matching event fires (a background job finishing, a model update, a websocket message) and rejects on timeout; for polling an arbitrary condition, use awaitery's `waitFor`.
|
|
145
|
+
|
|
146
|
+
```js
|
|
147
|
+
import {waitForEvent} from "velocious/build/src/testing/test.js"
|
|
148
|
+
import waitFor from "awaitery/build/wait-for.js"
|
|
149
|
+
|
|
150
|
+
// Event-driven: resolves as soon as the matching event fires (no polling latency).
|
|
151
|
+
const {result} = await waitForEvent(jobRunner, "jobFinished", {filter: (event) => event.jobId === jobId})
|
|
152
|
+
|
|
153
|
+
// Condition polling: retries the callback until it stops throwing.
|
|
154
|
+
await waitFor(() => expect(await Message.count()).toEqual(1))
|
|
155
|
+
```
|
|
156
|
+
|
|
144
157
|
Velocious captures console output emitted while each test executes, but does not print passing-test output by default. When a test fails, Velocious prints a truncated `Console output:` block for that failed test and saves the full captured log under `tmp/screenshots` next to failure screenshots/browser logs/HTML. Each failed test summary prints the saved console log path.
|
|
145
158
|
|
|
146
159
|
Configure console output behavior in your testing config file.
|
|
@@ -44,6 +44,19 @@ export default class JsonSocket extends EventEmitter {
|
|
|
44
44
|
* the main's liveness sweep to drop a wedged/silent worker.
|
|
45
45
|
* @type {number | undefined} */
|
|
46
46
|
this.lastSeenAt = undefined
|
|
47
|
+
/**
|
|
48
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
49
|
+
* `destroy()` has run, incremented immediately before the raw socket
|
|
50
|
+
* `destroy()` call so specs can assert the actual teardown method that ran
|
|
51
|
+
* rather than a self-reported flag. Do not read or depend on this outside tests.
|
|
52
|
+
* @type {number} */
|
|
53
|
+
this._destroyCallCount = 0
|
|
54
|
+
/**
|
|
55
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
56
|
+
* `close()` has run, incremented immediately before the raw socket `end()`
|
|
57
|
+
* call. Do not read or depend on this outside tests.
|
|
58
|
+
* @type {number} */
|
|
59
|
+
this._closeCallCount = 0
|
|
47
60
|
this.buffer = ""
|
|
48
61
|
this.socket.setEncoding("utf8")
|
|
49
62
|
this.socket.on("data", (chunk) => this._onData(String(chunk)))
|
|
@@ -91,6 +104,18 @@ export default class JsonSocket extends EventEmitter {
|
|
|
91
104
|
* @returns {void}
|
|
92
105
|
*/
|
|
93
106
|
close() {
|
|
107
|
+
this._closeCallCount++
|
|
94
108
|
this.socket.end()
|
|
95
109
|
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Forcibly destroys the underlying socket. Unlike {@link close}, which
|
|
113
|
+
* half-closes gracefully via `end()`, this tears the connection down
|
|
114
|
+
* immediately so a stalled/aborted request does not leave the socket alive.
|
|
115
|
+
* @returns {void}
|
|
116
|
+
*/
|
|
117
|
+
destroy() {
|
|
118
|
+
this._destroyCallCount++
|
|
119
|
+
this.socket.destroy()
|
|
120
|
+
}
|
|
96
121
|
}
|
|
@@ -15,6 +15,16 @@ export default class BackgroundJobsSocketRequest {
|
|
|
15
15
|
this.host = host
|
|
16
16
|
this.port = port
|
|
17
17
|
this.role = role
|
|
18
|
+
/**
|
|
19
|
+
* Internal test-only observability reference — NOT public API. Holds the
|
|
20
|
+
* JsonSocket wrapper this request created so the timeout spec can inspect the
|
|
21
|
+
* wrapper's own `destroy()`/`close()` call counters — direct evidence of which
|
|
22
|
+
* teardown method actually ran, not a self-reported flag. Retains the single
|
|
23
|
+
* (already torn-down) wrapper for the request's lifetime. Do not expose or
|
|
24
|
+
* depend on this outside tests.
|
|
25
|
+
* @type {JsonSocket | undefined}
|
|
26
|
+
*/
|
|
27
|
+
this._jsonSocket = undefined
|
|
18
28
|
}
|
|
19
29
|
|
|
20
30
|
/**
|
|
@@ -23,28 +33,60 @@ export default class BackgroundJobsSocketRequest {
|
|
|
23
33
|
* @param {object} args - Options.
|
|
24
34
|
* @param {(jsonSocket: JsonSocket) => void} args.onConnect - Called after the socket connects.
|
|
25
35
|
* @param {(args: {message: import("./types.js").BackgroundJobSocketMessage, resolve: (value: T) => void, reject: (error: Error) => void}) => void} args.onMessage - Message handler.
|
|
36
|
+
* @param {AbortSignal} [args.signal] - Aborts the request; on abort the pending socket is destroyed and the promise rejects with the signal reason when it is an Error, otherwise with a generic abort Error.
|
|
26
37
|
* @returns {Promise<T>} - Resolved request value.
|
|
27
38
|
*/
|
|
28
|
-
async run({onConnect, onMessage}) {
|
|
39
|
+
async run({onConnect, onMessage, signal}) {
|
|
29
40
|
const socket = net.createConnection({host: this.host, port: this.port})
|
|
30
41
|
const jsonSocket = new JsonSocket(socket)
|
|
31
42
|
|
|
43
|
+
this._jsonSocket = jsonSocket
|
|
44
|
+
|
|
32
45
|
return await new Promise((resolve, reject) => {
|
|
33
46
|
let finished = false
|
|
34
47
|
/**
|
|
35
48
|
* Finish.
|
|
49
|
+
* @param {object} options - Options.
|
|
50
|
+
* @param {boolean} [options.destroy] - Destroy the socket instead of gracefully closing it.
|
|
36
51
|
* @param {() => void} callback - Finish callback.
|
|
37
52
|
*/
|
|
38
|
-
const finish = (callback) => {
|
|
53
|
+
const finish = ({destroy = false} = {}, callback) => {
|
|
39
54
|
if (finished) return
|
|
40
55
|
finished = true
|
|
56
|
+
if (signal) signal.removeEventListener("abort", onAbort)
|
|
41
57
|
jsonSocket.removeAllListeners()
|
|
42
|
-
|
|
58
|
+
|
|
59
|
+
if (destroy) {
|
|
60
|
+
jsonSocket.destroy()
|
|
61
|
+
} else {
|
|
62
|
+
jsonSocket.close()
|
|
63
|
+
}
|
|
64
|
+
|
|
43
65
|
callback()
|
|
44
66
|
}
|
|
45
67
|
|
|
68
|
+
/**
|
|
69
|
+
* Handles a cooperative abort: tears down the pending socket and rejects
|
|
70
|
+
* with the signal reason when it is an Error.
|
|
71
|
+
* @returns {void}
|
|
72
|
+
*/
|
|
73
|
+
const onAbort = () => {
|
|
74
|
+
const reason = signal?.reason
|
|
75
|
+
|
|
76
|
+
finish({destroy: true}, () => reject(reason instanceof Error ? reason : new Error("Background job socket request aborted")))
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
if (signal) {
|
|
80
|
+
if (signal.aborted) {
|
|
81
|
+
onAbort()
|
|
82
|
+
return
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
signal.addEventListener("abort", onAbort)
|
|
86
|
+
}
|
|
87
|
+
|
|
46
88
|
jsonSocket.on("error", (error) => {
|
|
47
|
-
finish(() => reject(error))
|
|
89
|
+
finish({}, () => reject(error))
|
|
48
90
|
})
|
|
49
91
|
|
|
50
92
|
/**
|
|
@@ -54,8 +96,8 @@ export default class BackgroundJobsSocketRequest {
|
|
|
54
96
|
jsonSocket.on("message", (message) => {
|
|
55
97
|
onMessage({
|
|
56
98
|
message,
|
|
57
|
-
resolve: (value) => finish(() => resolve(value)),
|
|
58
|
-
reject: (error) => finish(() => reject(error))
|
|
99
|
+
resolve: (value) => finish({}, () => resolve(value)),
|
|
100
|
+
reject: (error) => finish({}, () => reject(error))
|
|
59
101
|
})
|
|
60
102
|
})
|
|
61
103
|
|
|
@@ -15,11 +15,20 @@ export default class BackgroundJobsStatusReporter {
|
|
|
15
15
|
* @param {import("../configuration.js").default} args.configuration - Configuration.
|
|
16
16
|
* @param {string} [args.host] - Host.
|
|
17
17
|
* @param {number} [args.port] - Port.
|
|
18
|
+
* @param {number} [args.attemptTimeoutMs] - Per-attempt socket-request timeout in milliseconds (default: 5000).
|
|
18
19
|
*/
|
|
19
|
-
constructor({configuration, host, port}) {
|
|
20
|
+
constructor({configuration, host, port, attemptTimeoutMs = 5000}) {
|
|
20
21
|
this.configuration = configuration
|
|
21
22
|
this.host = host
|
|
22
23
|
this.port = port
|
|
24
|
+
this.attemptTimeoutMs = attemptTimeoutMs
|
|
25
|
+
/**
|
|
26
|
+
* Internal test-only observability state — NOT public API. References the most
|
|
27
|
+
* recent socket request so the timeout spec can inspect how its socket was torn
|
|
28
|
+
* down. Do not expose or depend on this outside tests.
|
|
29
|
+
* @type {BackgroundJobsSocketRequest | undefined}
|
|
30
|
+
*/
|
|
31
|
+
this._lastRequest = undefined
|
|
23
32
|
this.logger = new Logger(this)
|
|
24
33
|
}
|
|
25
34
|
|
|
@@ -39,10 +48,13 @@ export default class BackgroundJobsStatusReporter {
|
|
|
39
48
|
const host = this.host || config.host
|
|
40
49
|
const port = typeof this.port === "number" ? this.port : config.port
|
|
41
50
|
|
|
42
|
-
await timeout({timeout:
|
|
51
|
+
await timeout({timeout: this.attemptTimeoutMs}, async ({control}) => {
|
|
43
52
|
const request = new BackgroundJobsSocketRequest({host, port, role: "reporter"})
|
|
44
53
|
|
|
54
|
+
this._lastRequest = request
|
|
55
|
+
|
|
45
56
|
await request.run({
|
|
57
|
+
signal: control.signal,
|
|
46
58
|
onConnect: (jsonSocket) => {
|
|
47
59
|
jsonSocket.send({
|
|
48
60
|
type: status === "completed" ? "job-complete" : "job-failed",
|
|
@@ -72,6 +72,7 @@
|
|
|
72
72
|
* @property {function() : ?} [getConnection] - Custom connection factory override.
|
|
73
73
|
* @property {string} [host] - Database host.
|
|
74
74
|
* @property {boolean} [migrations] - Whether migrations are enabled for this database.
|
|
75
|
+
* @property {boolean} [multipleStatements] - (MySQL) Opt in to multi-statement queries so a whole structure SQL dump loads in one round-trip via `StructureSqlLoader`. Off by default; ordinary queries otherwise reject stacked statements.
|
|
75
76
|
* @property {string} [password] - Password for the database user.
|
|
76
77
|
* @property {number} [port] - Database port.
|
|
77
78
|
* @property {string} [primaryKeyType] - Default type for implicit migration primary keys and references. Defaults to `uuid`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// @ts-check
|
|
2
2
|
|
|
3
|
-
import timeout from "awaitery/build/timeout.js"
|
|
3
|
+
import timeout, {TimeoutError} from "awaitery/build/timeout.js"
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Thrown when an advisory lock could not be acquired before `timeoutMs` elapsed.
|
|
@@ -67,9 +67,12 @@ export default class AdvisoryLockRunner {
|
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
69
|
* Runs a callback after acquiring the advisory lock, waiting up to `timeoutMs`.
|
|
70
|
+
* When a `holdTimeoutMs` is set the callback receives a `TimeoutControl` from
|
|
71
|
+
* awaitery for cooperative cancellation (`control.check()`, `control.signal`,
|
|
72
|
+
* `control.timedOut`, `control.remaining()`).
|
|
70
73
|
* @template T
|
|
71
74
|
* @param {string} name - Lock name.
|
|
72
|
-
* @param {() => Promise<T>} callback - Callback to invoke while the lock is held.
|
|
75
|
+
* @param {(args?: {control: import("awaitery/build/timeout.js").TimeoutControl}) => Promise<T>} callback - Callback to invoke while the lock is held.
|
|
73
76
|
* @param {{timeoutMs?: number | null, holdTimeoutMs?: number | null}} [args] - Lock and hold timeout options.
|
|
74
77
|
* @returns {Promise<T>} - Resolves with the callback result.
|
|
75
78
|
*/
|
|
@@ -87,9 +90,11 @@ export default class AdvisoryLockRunner {
|
|
|
87
90
|
|
|
88
91
|
/**
|
|
89
92
|
* Runs a callback only if the advisory lock can be acquired immediately.
|
|
93
|
+
* When a `holdTimeoutMs` is set the callback receives a `TimeoutControl` from
|
|
94
|
+
* awaitery for cooperative cancellation.
|
|
90
95
|
* @template T
|
|
91
96
|
* @param {string} name - Lock name.
|
|
92
|
-
* @param {() => Promise<T>} callback - Callback to invoke while the lock is held.
|
|
97
|
+
* @param {(args?: {control: import("awaitery/build/timeout.js").TimeoutControl}) => Promise<T>} callback - Callback to invoke while the lock is held.
|
|
93
98
|
* @param {{holdTimeoutMs?: number | null}} [args] - Hold timeout options.
|
|
94
99
|
* @returns {Promise<T>} - Resolves with the callback result.
|
|
95
100
|
*/
|
|
@@ -108,7 +113,7 @@ export default class AdvisoryLockRunner {
|
|
|
108
113
|
/**
|
|
109
114
|
* Runs the lock holder callback and releases the lock from its owning connection.
|
|
110
115
|
* @template T
|
|
111
|
-
* @param {{callback: () => Promise<T>, connection: import("./drivers/base.js").default, holdTimeoutMs?: number | null, name: string}} args - Locked callback args.
|
|
116
|
+
* @param {{callback: (args?: {control: import("awaitery/build/timeout.js").TimeoutControl}) => Promise<T>, connection: import("./drivers/base.js").default, holdTimeoutMs?: number | null, name: string}} args - Locked callback args.
|
|
112
117
|
* @returns {Promise<T>} - Resolves with the callback result.
|
|
113
118
|
*/
|
|
114
119
|
async runLockedCallback({callback, connection, holdTimeoutMs, name}) {
|
|
@@ -160,9 +165,13 @@ export default class AdvisoryLockRunner {
|
|
|
160
165
|
* Runs `callback`, rejecting with `AdvisoryLockHoldTimeoutError` if it has
|
|
161
166
|
* not settled within `holdTimeoutMs`. The callback is not cancelled; callers
|
|
162
167
|
* use a dedicated advisory-lock connection so the lock can still be released.
|
|
168
|
+
*
|
|
169
|
+
* The callback receives a `TimeoutControl` from awaitery, enabling cooperative
|
|
170
|
+
* cancellation via `control.check()`, `control.signal`, `control.timedOut`,
|
|
171
|
+
* and `control.remaining()`.
|
|
163
172
|
* @template T
|
|
164
173
|
* @param {string} name - Lock name (for the error message).
|
|
165
|
-
* @param {() => Promise<T>} callback - Callback holding the lock.
|
|
174
|
+
* @param {(args?: {control: import("awaitery/build/timeout.js").TimeoutControl}) => Promise<T>} callback - Callback holding the lock.
|
|
166
175
|
* @param {number | null} [holdTimeoutMs] - Max hold time; falsy disables the timeout.
|
|
167
176
|
* @returns {Promise<T>} - Resolves with the callback result.
|
|
168
177
|
*/
|
|
@@ -174,15 +183,15 @@ export default class AdvisoryLockRunner {
|
|
|
174
183
|
let callbackSettled = false
|
|
175
184
|
|
|
176
185
|
try {
|
|
177
|
-
return await timeout({timeout: holdTimeoutMs}, async () => {
|
|
186
|
+
return await timeout({timeout: holdTimeoutMs}, async ({control}) => {
|
|
178
187
|
try {
|
|
179
|
-
return await callback()
|
|
188
|
+
return await callback({control})
|
|
180
189
|
} finally {
|
|
181
190
|
callbackSettled = true
|
|
182
191
|
}
|
|
183
192
|
})
|
|
184
193
|
} catch (error) {
|
|
185
|
-
if (!callbackSettled) {
|
|
194
|
+
if (!callbackSettled || error instanceof TimeoutError) {
|
|
186
195
|
throw new AdvisoryLockHoldTimeoutError(`Advisory lock ${JSON.stringify(name)} held longer than ${holdTimeoutMs}ms`, {name})
|
|
187
196
|
}
|
|
188
197
|
|
|
@@ -583,6 +583,18 @@ export default class VelociousDatabaseDriversBase {
|
|
|
583
583
|
return null
|
|
584
584
|
}
|
|
585
585
|
|
|
586
|
+
/**
|
|
587
|
+
* Executes a whole multi-statement structure SQL script in a single round-trip when
|
|
588
|
+
* the driver supports it, running on this connection (so the caller's foreign-key
|
|
589
|
+
* handling applies). Returns true if it ran the whole script; false when the caller
|
|
590
|
+
* should run the statements individually. The base driver has no batch path.
|
|
591
|
+
* @param {string} _structureSql - Full multi-statement structure SQL.
|
|
592
|
+
* @returns {Promise<boolean>} - Whether the script was executed as one batch.
|
|
593
|
+
*/
|
|
594
|
+
async execStructureScript(_structureSql) {
|
|
595
|
+
return false
|
|
596
|
+
}
|
|
597
|
+
|
|
586
598
|
/**
|
|
587
599
|
* Runs get table by name.
|
|
588
600
|
* @param {string} name - Name.
|
|
@@ -23,6 +23,17 @@ import Upsert from "./sql/upsert.js"
|
|
|
23
23
|
import Update from "./sql/update.js"
|
|
24
24
|
import UUID from "pure-uuid"
|
|
25
25
|
|
|
26
|
+
/**
|
|
27
|
+
* SQL Server error number raised by `sp_releaseapplock` when the current
|
|
28
|
+
* session does not hold the requested application lock. Releasing a lock the
|
|
29
|
+
* session no longer holds is a normal race (a shared connection's final
|
|
30
|
+
* check-in may already have auto-released it), which the cross-driver
|
|
31
|
+
* `releaseAdvisoryLock` contract models by resolving to `false`. We translate
|
|
32
|
+
* this specific error into that result rather than letting it escape.
|
|
33
|
+
* @type {number}
|
|
34
|
+
*/
|
|
35
|
+
const APPLOCK_NOT_HELD_ERROR_NUMBER = 1223
|
|
36
|
+
|
|
26
37
|
export default class VelociousDatabaseDriversMssql extends Base{
|
|
27
38
|
async connect() {
|
|
28
39
|
const args = this.getArgs()
|
|
@@ -640,18 +651,56 @@ export default class VelociousDatabaseDriversMssql extends Base{
|
|
|
640
651
|
|
|
641
652
|
/**
|
|
642
653
|
* Runs release advisory lock.
|
|
654
|
+
*
|
|
655
|
+
* `sp_releaseapplock` returns 0 when the lock was released, but SQL Server
|
|
656
|
+
* raises error {@link APPLOCK_NOT_HELD_ERROR_NUMBER} instead of returning a
|
|
657
|
+
* failure code when the session does not currently hold the lock. That
|
|
658
|
+
* error aborts the batch before the trailing `SELECT` can run, so we catch
|
|
659
|
+
* it and resolve to `false` to honor the cross-driver contract for an
|
|
660
|
+
* already-unheld lock.
|
|
643
661
|
* @param {string} name - Lock name.
|
|
644
662
|
* @returns {Promise<boolean>} - True if the lock was held by this session and has now been released.
|
|
645
663
|
*/
|
|
646
664
|
async _releaseAdvisoryLock(name) {
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
665
|
+
let rows
|
|
666
|
+
|
|
667
|
+
try {
|
|
668
|
+
rows = await this.query(
|
|
669
|
+
`DECLARE @velocious_advisory_lock_result INT; EXEC @velocious_advisory_lock_result = sp_releaseapplock @Resource = ${this.quote(name)}, @LockOwner = 'Session'; SELECT @velocious_advisory_lock_result AS velocious_advisory_lock_result`
|
|
670
|
+
)
|
|
671
|
+
} catch (error) {
|
|
672
|
+
if (this._isApplockNotHeldError(error)) return false
|
|
673
|
+
|
|
674
|
+
throw error
|
|
675
|
+
}
|
|
676
|
+
|
|
650
677
|
const result = Number(rows?.[0]?.velocious_advisory_lock_result)
|
|
651
678
|
|
|
652
679
|
return result === 0
|
|
653
680
|
}
|
|
654
681
|
|
|
682
|
+
/**
|
|
683
|
+
* Detects the SQL Server "application lock is not currently held" error
|
|
684
|
+
* raised by `sp_releaseapplock`. It walks the wrapped-error cause chain
|
|
685
|
+
* because `query` re-wraps the driver's `RequestError` in a plain `Error`,
|
|
686
|
+
* and matches on the stable numeric error number rather than the message.
|
|
687
|
+
* @param {unknown} error - Error thrown while releasing the lock.
|
|
688
|
+
* @returns {boolean} - True if the error means the lock was not held by this session.
|
|
689
|
+
*/
|
|
690
|
+
_isApplockNotHeldError(error) {
|
|
691
|
+
let current = error
|
|
692
|
+
|
|
693
|
+
while (current instanceof Error) {
|
|
694
|
+
const errorNumber = /** @type {{number?: unknown}} */ (current).number
|
|
695
|
+
|
|
696
|
+
if (typeof errorNumber === "number" && errorNumber === APPLOCK_NOT_HELD_ERROR_NUMBER) return true
|
|
697
|
+
|
|
698
|
+
current = current.cause
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
return false
|
|
702
|
+
}
|
|
703
|
+
|
|
655
704
|
/**
|
|
656
705
|
* Returns true if any session currently holds the application lock.
|
|
657
706
|
*
|
|
@@ -190,6 +190,10 @@ export default class VelociousDatabaseDriversMysql extends Base{
|
|
|
190
190
|
|
|
191
191
|
if ("username" in args) connectArgs["user"] = args["username"]
|
|
192
192
|
if ("charset" in args) connectArgs["charset"] = args["charset"]
|
|
193
|
+
// Opt-in only. Lets a whole structure SQL dump run in one round-trip via
|
|
194
|
+
// {@link execStructureScript}; off by default so ordinary queries keep rejecting
|
|
195
|
+
// stacked statements.
|
|
196
|
+
if ("multipleStatements" in args) connectArgs["multipleStatements"] = Boolean(digg(args, "multipleStatements"))
|
|
193
197
|
|
|
194
198
|
return connectArgs
|
|
195
199
|
}
|
|
@@ -417,6 +421,36 @@ export default class VelociousDatabaseDriversMysql extends Base{
|
|
|
417
421
|
})
|
|
418
422
|
}
|
|
419
423
|
|
|
424
|
+
/**
|
|
425
|
+
* Executes a full multi-statement structure SQL script in one round-trip when the
|
|
426
|
+
* connection was configured with `multipleStatements: true`. Runs on the pooled
|
|
427
|
+
* connection so the caller's `SET FOREIGN_KEY_CHECKS = 0` applies. Returns false so
|
|
428
|
+
* the caller runs statements individually when multi-statement queries are off.
|
|
429
|
+
* @param {string} structureSql - Full multi-statement structure SQL.
|
|
430
|
+
* @returns {Promise<boolean>} - Whether the script was executed as one batch.
|
|
431
|
+
*/
|
|
432
|
+
async execStructureScript(structureSql) {
|
|
433
|
+
if (!this.getArgs().multipleStatements) return false
|
|
434
|
+
|
|
435
|
+
// The batched pool call below bypasses Base#query, so re-run the same read-only
|
|
436
|
+
// write guard the per-statement path applies before executing the dump.
|
|
437
|
+
this._assertWritableQuery(structureSql)
|
|
438
|
+
|
|
439
|
+
if (!this.pool) await this.connect()
|
|
440
|
+
if (!this.pool) throw new Error("MySQL pool failed to initialize")
|
|
441
|
+
|
|
442
|
+
const pool = this.pool
|
|
443
|
+
|
|
444
|
+
await new Promise((resolve, reject) => {
|
|
445
|
+
pool.query(structureSql, (error) => {
|
|
446
|
+
if (error) reject(error)
|
|
447
|
+
else resolve(undefined)
|
|
448
|
+
})
|
|
449
|
+
})
|
|
450
|
+
|
|
451
|
+
return true
|
|
452
|
+
}
|
|
453
|
+
|
|
420
454
|
/**
|
|
421
455
|
* Runs query to sql.
|
|
422
456
|
* @param {import("../../query/index.js").default} query - Query instance.
|
|
@@ -31,17 +31,23 @@ export default class StructureSqlLoader {
|
|
|
31
31
|
await db.disableForeignKeys()
|
|
32
32
|
|
|
33
33
|
try {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
34
|
+
// Prefer a single round-trip for the whole dump: a driver-native multi-statement
|
|
35
|
+
// batch (e.g. MySQL with `multipleStatements`) first, then a native `exec`
|
|
36
|
+
// connection (e.g. SQLite), and finally per-statement execution. Running the
|
|
37
|
+
// whole dump at once is far faster than issuing every CREATE separately.
|
|
38
|
+
if (!await db.execStructureScript(structureSql)) {
|
|
39
|
+
if (executableConnection) {
|
|
40
|
+
await executableConnection.exec(structureSql)
|
|
41
|
+
} else {
|
|
42
|
+
for (const statement of statements) {
|
|
43
|
+
await db.query(statement)
|
|
44
|
+
}
|
|
39
45
|
}
|
|
40
46
|
}
|
|
41
47
|
} finally {
|
|
42
48
|
await db.enableForeignKeys()
|
|
43
49
|
|
|
44
|
-
// The native `exec`
|
|
50
|
+
// The batch / native `exec` paths mutate the schema outside `Base#query`, so the
|
|
45
51
|
// usual post-DDL schema-cache invalidation never runs. Clear it here so a
|
|
46
52
|
// caller that read schema metadata before provisioning (e.g. an empty table
|
|
47
53
|
// list) does not keep seeing the pre-load schema afterwards. Harmless for the
|
|
@@ -40,6 +40,19 @@ export default class JsonSocket extends JsonSocket_base {
|
|
|
40
40
|
* the main's liveness sweep to drop a wedged/silent worker.
|
|
41
41
|
* @type {number | undefined} */
|
|
42
42
|
lastSeenAt: number | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
45
|
+
* `destroy()` has run, incremented immediately before the raw socket
|
|
46
|
+
* `destroy()` call so specs can assert the actual teardown method that ran
|
|
47
|
+
* rather than a self-reported flag. Do not read or depend on this outside tests.
|
|
48
|
+
* @type {number} */
|
|
49
|
+
_destroyCallCount: number;
|
|
50
|
+
/**
|
|
51
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
52
|
+
* `close()` has run, incremented immediately before the raw socket `end()`
|
|
53
|
+
* call. Do not read or depend on this outside tests.
|
|
54
|
+
* @type {number} */
|
|
55
|
+
_closeCallCount: number;
|
|
43
56
|
buffer: string;
|
|
44
57
|
/**
|
|
45
58
|
* Runs on data.
|
|
@@ -58,6 +71,13 @@ export default class JsonSocket extends JsonSocket_base {
|
|
|
58
71
|
* @returns {void}
|
|
59
72
|
*/
|
|
60
73
|
close(): void;
|
|
74
|
+
/**
|
|
75
|
+
* Forcibly destroys the underlying socket. Unlike {@link close}, which
|
|
76
|
+
* half-closes gracefully via `end()`, this tears the connection down
|
|
77
|
+
* immediately so a stalled/aborted request does not leave the socket alive.
|
|
78
|
+
* @returns {void}
|
|
79
|
+
*/
|
|
80
|
+
destroy(): void;
|
|
61
81
|
}
|
|
62
82
|
export {};
|
|
63
83
|
//# sourceMappingURL=json-socket.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"json-socket.d.ts","sourceRoot":"","sources":["../../../src/background-jobs/json-socket.js"],"names":[],"mappings":";AAIA;IACE;;;OAGG;IACH,oBAFW,OAAO,KAAK,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"json-socket.d.ts","sourceRoot":"","sources":["../../../src/background-jobs/json-socket.js"],"names":[],"mappings":";AAIA;IACE;;;OAGG;IACH,oBAFW,OAAO,KAAK,EAAE,MAAM,EAyD9B;IArDC,kCAAoB;IACpB;;oCAEgC;IAChC,UADU,MAAM,GAAG,SAAS,CACH;IACzB;;yBAEqB;IACrB,4BADU,OAAO,CACsB;IACvC;;yBAEqB;IACrB,oBADU,OAAO,CACa;IAC9B;;yBAEqB;IACrB,mBADU,OAAO,CACY;IAC7B,sBAAsB;IACtB,mBADW,OAAO,CACY;IAC9B;;yBAEqB;IACrB,mBADU,OAAO,CACY;IAC7B;;;;;yBAKqB;IACrB,mBADU,OAAO,CACa;IAC9B;;;oCAGgC;IAChC,YADU,MAAM,GAAG,SAAS,CACD;IAC3B;;;;;wBAKoB;IACpB,mBADU,MAAM,CACU;IAC1B;;;;wBAIoB;IACpB,iBADU,MAAM,CACQ;IACxB,eAAgB;IAOlB;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;OAIG;IACH,cAHW,OAAC,GACC,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAKhB;IAED;;;;;OAKG;IACH,WAFa,IAAI,CAKhB;CACF"}
|
|
@@ -42,6 +42,19 @@ export default class JsonSocket extends EventEmitter {
|
|
|
42
42
|
* the main's liveness sweep to drop a wedged/silent worker.
|
|
43
43
|
* @type {number | undefined} */
|
|
44
44
|
this.lastSeenAt = undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
47
|
+
* `destroy()` has run, incremented immediately before the raw socket
|
|
48
|
+
* `destroy()` call so specs can assert the actual teardown method that ran
|
|
49
|
+
* rather than a self-reported flag. Do not read or depend on this outside tests.
|
|
50
|
+
* @type {number} */
|
|
51
|
+
this._destroyCallCount = 0;
|
|
52
|
+
/**
|
|
53
|
+
* Internal test-only observability counter — NOT public API. Number of times
|
|
54
|
+
* `close()` has run, incremented immediately before the raw socket `end()`
|
|
55
|
+
* call. Do not read or depend on this outside tests.
|
|
56
|
+
* @type {number} */
|
|
57
|
+
this._closeCallCount = 0;
|
|
45
58
|
this.buffer = "";
|
|
46
59
|
this.socket.setEncoding("utf8");
|
|
47
60
|
this.socket.on("data", (chunk) => this._onData(String(chunk)));
|
|
@@ -85,7 +98,18 @@ export default class JsonSocket extends EventEmitter {
|
|
|
85
98
|
* @returns {void}
|
|
86
99
|
*/
|
|
87
100
|
close() {
|
|
101
|
+
this._closeCallCount++;
|
|
88
102
|
this.socket.end();
|
|
89
103
|
}
|
|
104
|
+
/**
|
|
105
|
+
* Forcibly destroys the underlying socket. Unlike {@link close}, which
|
|
106
|
+
* half-closes gracefully via `end()`, this tears the connection down
|
|
107
|
+
* immediately so a stalled/aborted request does not leave the socket alive.
|
|
108
|
+
* @returns {void}
|
|
109
|
+
*/
|
|
110
|
+
destroy() {
|
|
111
|
+
this._destroyCallCount++;
|
|
112
|
+
this.socket.destroy();
|
|
113
|
+
}
|
|
90
114
|
}
|
|
91
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
115
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"json-socket.js","sourceRoot":"","sources":["../../../src/background-jobs/json-socket.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ,OAAO,YAAY,MAAM,2BAA2B,CAAA;AAEpD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,YAAY;IAClD;;;OAGG;IACH,YAAY,MAAM;QAChB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB;;wCAEgC;QAChC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;QACzB;;6BAEqB;QACrB,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAA;QACvC;;6BAEqB;QACrB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B;;6BAEqB;QACrB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAA;QAC7B,sBAAsB;QACtB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAA;QAC9B;;6BAEqB;QACrB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAA;QAC7B;;;;;6BAKqB;QACrB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAA;QAC9B;;;wCAGgC;QAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B;;;;;4BAKoB;QACpB,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAA;QAC1B;;;;4BAIoB;QACpB,IAAI,CAAC,eAAe,GAAG,CAAC,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAChB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC/B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC9D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QACjD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAK;QACX,IAAI,CAAC,MAAM,IAAI,KAAK,CAAA;QAEpB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YAC9C,IAAI,YAAY,KAAK,CAAC,CAAC;gBAAE,MAAK;YAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE,CAAA;YACtD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA;YAEjD,IAAI,CAAC,IAAI;gBAAE,SAAQ;YAEnB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAChC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YAC/B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAAO;QACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,eAAe,EAAE,CAAA;QACtB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAA;IACnB,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACL,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;IACvB,CAAC;CACF","sourcesContent":["// @ts-check\n\nimport EventEmitter from \"../utils/event-emitter.js\"\n\nexport default class JsonSocket extends EventEmitter {\n  /**\n   * Runs constructor.\n   * @param {import(\"net\").Socket} socket - Socket instance.\n   */\n  constructor(socket) {\n    super()\n    this.socket = socket\n    /**\n     * Narrows the runtime value to the documented type.\n     * @type {string | undefined} */\n    this.workerId = undefined\n    /**\n     * Narrows the runtime value to the documented type.\n     * @type {boolean} */\n    this.supportsHandoffIdReporting = false\n    /**\n     * Narrows the runtime value to the documented type.\n     * @type {boolean} */\n    this.acceptsSpawnedJobs = true\n    /**\n     * Narrows the runtime value to the documented type.\n     * @type {boolean} */\n    this.acceptsForkedJobs = true\n    /** @type {boolean} */\n    this.acceptsPooledJobs = false\n    /**\n     * Narrows the runtime value to the documented type.\n     * @type {boolean} */\n    this.acceptsInlineJobs = true\n    /**\n     * Whether this worker advertised heartbeat support in its hello. Only\n     * heartbeat-capable workers are subject to the main's stale-liveness\n     * eviction; a legacy worker (e.g. mid rolling deploy) is exempt so its\n     * active leases are not released while it is still running them.\n     * @type {boolean} */\n    this.supportsHeartbeat = false\n    /**\n     * Last time (ms) the main saw any message from this worker socket; used by\n     * the main's liveness sweep to drop a wedged/silent worker.\n     * @type {number | undefined} */\n    this.lastSeenAt = undefined\n    /**\n     * Internal test-only observability counter — NOT public API. Number of times\n     * `destroy()` has run, incremented immediately before the raw socket\n     * `destroy()` call so specs can assert the actual teardown method that ran\n     * rather than a self-reported flag. Do not read or depend on this outside tests.\n     * @type {number} */\n    this._destroyCallCount = 0\n    /**\n     * Internal test-only observability counter — NOT public API. Number of times\n     * `close()` has run, incremented immediately before the raw socket `end()`\n     * call. Do not read or depend on this outside tests.\n     * @type {number} */\n    this._closeCallCount = 0\n    this.buffer = \"\"\n    this.socket.setEncoding(\"utf8\")\n    this.socket.on(\"data\", (chunk) => this._onData(String(chunk)))\n    this.socket.on(\"close\", () => this.emit(\"close\"))\n    this.socket.on(\"error\", (error) => this.emit(\"error\", error))\n  }\n\n  /**\n   * Runs on data.\n   * @param {string} chunk - Data chunk.\n   * @returns {void}\n   */\n  _onData(chunk) {\n    this.buffer += chunk\n\n    while (true) {\n      const newlineIndex = this.buffer.indexOf(\"\\n\")\n      if (newlineIndex === -1) break\n\n      const line = this.buffer.slice(0, newlineIndex).trim()\n      this.buffer = this.buffer.slice(newlineIndex + 1)\n\n      if (!line) continue\n\n      try {\n        const message = JSON.parse(line)\n        this.emit(\"message\", message)\n      } catch (error) {\n        this.emit(\"error\", error)\n      }\n    }\n  }\n\n  /**\n   * Runs send.\n   * @param {?} message - Message to send.\n   * @returns {void}\n   */\n  send(message) {\n    this.socket.write(`${JSON.stringify(message)}\\n`)\n  }\n\n  /**\n   * Runs close.\n   * @returns {void}\n   */\n  close() {\n    this._closeCallCount++\n    this.socket.end()\n  }\n\n  /**\n   * Forcibly destroys the underlying socket. Unlike {@link close}, which\n   * half-closes gracefully via `end()`, this tears the connection down\n   * immediately so a stalled/aborted request does not leave the socket alive.\n   * @returns {void}\n   */\n  destroy() {\n    this._destroyCallCount++\n    this.socket.destroy()\n  }\n}\n"]}
|
|
@@ -14,21 +14,33 @@ export default class BackgroundJobsSocketRequest {
|
|
|
14
14
|
host: string;
|
|
15
15
|
port: number;
|
|
16
16
|
role: "client" | "reporter";
|
|
17
|
+
/**
|
|
18
|
+
* Internal test-only observability reference — NOT public API. Holds the
|
|
19
|
+
* JsonSocket wrapper this request created so the timeout spec can inspect the
|
|
20
|
+
* wrapper's own `destroy()`/`close()` call counters — direct evidence of which
|
|
21
|
+
* teardown method actually ran, not a self-reported flag. Retains the single
|
|
22
|
+
* (already torn-down) wrapper for the request's lifetime. Do not expose or
|
|
23
|
+
* depend on this outside tests.
|
|
24
|
+
* @type {JsonSocket | undefined}
|
|
25
|
+
*/
|
|
26
|
+
_jsonSocket: JsonSocket | undefined;
|
|
17
27
|
/**
|
|
18
28
|
* Runs run.
|
|
19
29
|
* @template T
|
|
20
30
|
* @param {object} args - Options.
|
|
21
31
|
* @param {(jsonSocket: JsonSocket) => void} args.onConnect - Called after the socket connects.
|
|
22
32
|
* @param {(args: {message: import("./types.js").BackgroundJobSocketMessage, resolve: (value: T) => void, reject: (error: Error) => void}) => void} args.onMessage - Message handler.
|
|
33
|
+
* @param {AbortSignal} [args.signal] - Aborts the request; on abort the pending socket is destroyed and the promise rejects with the signal reason when it is an Error, otherwise with a generic abort Error.
|
|
23
34
|
* @returns {Promise<T>} - Resolved request value.
|
|
24
35
|
*/
|
|
25
|
-
run<T>({ onConnect, onMessage }: {
|
|
36
|
+
run<T>({ onConnect, onMessage, signal }: {
|
|
26
37
|
onConnect: (jsonSocket: JsonSocket) => void;
|
|
27
38
|
onMessage: (args: {
|
|
28
39
|
message: import("./types.js").BackgroundJobSocketMessage;
|
|
29
40
|
resolve: (value: T) => void;
|
|
30
41
|
reject: (error: Error) => void;
|
|
31
42
|
}) => void;
|
|
43
|
+
signal?: AbortSignal | undefined;
|
|
32
44
|
}): Promise<T>;
|
|
33
45
|
}
|
|
34
46
|
import JsonSocket from "./json-socket.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket-request.d.ts","sourceRoot":"","sources":["../../../src/background-jobs/socket-request.js"],"names":[],"mappings":"AAKA;IACE;;;;;;OAMG;IACH,kCAJG;QAAqB,IAAI,EAAjB,MAAM;QACO,IAAI,EAAjB,MAAM;QACsB,IAAI,EAAhC,QAAQ,GAAG,UAAU;KAC/B,
|
|
1
|
+
{"version":3,"file":"socket-request.d.ts","sourceRoot":"","sources":["../../../src/background-jobs/socket-request.js"],"names":[],"mappings":"AAKA;IACE;;;;;;OAMG;IACH,kCAJG;QAAqB,IAAI,EAAjB,MAAM;QACO,IAAI,EAAjB,MAAM;QACsB,IAAI,EAAhC,QAAQ,GAAG,UAAU;KAC/B,EAeA;IAbC,aAAgB;IAChB,aAAgB;IAChB,4BAAgB;IAChB;;;;;;;;OAQG;IACH,aAFU,UAAU,GAAG,SAAS,CAEJ;IAG9B;;;;;;;;OAQG;IACH,IAPa,CAAC,oCAEX;QAA+C,SAAS,EAAhD,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI;QAC8G,SAAS,EAAvJ,CAAC,IAAI,EAAE;YAAC,OAAO,EAAE,OAAO,YAAY,EAAE,0BAA0B,CAAC;YAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;YAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;SAAC,KAAK,IAAI;QACpH,MAAM;KACjC,GAAU,OAAO,CAAC,CAAC,CAAC,CAwEtB;CACF;uBA1GsB,kBAAkB"}
|