@camunda8/sdk 8.9.0-alpha.16 → 8.9.0-alpha.17
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/.eslintrc.json +79 -0
- package/AGENT.md +9 -0
- package/CHANGELOG.md +7 -0
- package/MAINTAINER.md +2 -1
- package/README.md +10 -1
- package/dist/zeebe/index.d.ts +1 -0
- package/dist/zeebe/index.js.map +1 -1
- package/dist/zeebe/lib/GrpcClient.d.ts +6 -0
- package/dist/zeebe/lib/GrpcClient.js +93 -85
- package/dist/zeebe/lib/GrpcClient.js.map +1 -1
- package/dist/zeebe/lib/StreamLifecycle.d.ts +189 -0
- package/dist/zeebe/lib/StreamLifecycle.js +142 -0
- package/dist/zeebe/lib/StreamLifecycle.js.map +1 -0
- package/dist/zeebe/lib/ZBStreamWorker.d.ts +3 -3
- package/dist/zeebe/lib/ZBStreamWorker.js +283 -140
- package/dist/zeebe/lib/ZBStreamWorker.js.map +1 -1
- package/dist/zeebe/zb/ZeebeGrpcClient.d.ts +6 -3
- package/dist/zeebe/zb/ZeebeGrpcClient.js +4 -0
- package/dist/zeebe/zb/ZeebeGrpcClient.js.map +1 -1
- package/package.json +6 -1
- package/scripts/assert-no-skipped-tests.d.ts +17 -0
- package/scripts/assert-no-skipped-tests.js +118 -0
- package/scripts/required-integration-specs.json +4 -0
- package/stryker.config.json +20 -0
- package/vitest.mutation.config.js +18 -0
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.describeStreamState = exports.STREAM_HANDLE_BRAND = exports.backoffDelayMs = exports.getOpenError = exports.toError = exports.cancelStream = exports.asStream = void 0;
|
|
4
|
+
exports.attachStream = attachStream;
|
|
5
|
+
exports.createStreamStateMachine = createStreamStateMachine;
|
|
6
|
+
exports.createStreamHandle = createStreamHandle;
|
|
7
|
+
/**
|
|
8
|
+
* Narrow the value that a stream-opening call resolved to (after
|
|
9
|
+
* `getOpenError` found no error) to a stream. Lives here so that stream workers
|
|
10
|
+
* never need to name, and therefore never hold a typed reference to, the raw
|
|
11
|
+
* gRPC stream type.
|
|
12
|
+
*/
|
|
13
|
+
const asStream = (opened) => opened;
|
|
14
|
+
exports.asStream = asStream;
|
|
15
|
+
/**
|
|
16
|
+
* Cancel and destroy a raw stream. Also used for a stream that was never
|
|
17
|
+
* attached (for example one that finished opening after its handle was
|
|
18
|
+
* closed): cancelling reports CANCELLED as an `error` event, which with no
|
|
19
|
+
* listener would be an uncaught exception, so a listener for that expected
|
|
20
|
+
* error is added first.
|
|
21
|
+
*/
|
|
22
|
+
const cancelStream = (stream) => {
|
|
23
|
+
stream.on('error', () => undefined);
|
|
24
|
+
stream.cancel();
|
|
25
|
+
stream.destroy();
|
|
26
|
+
};
|
|
27
|
+
exports.cancelStream = cancelStream;
|
|
28
|
+
const toError = (e) => e instanceof Error ? e : new Error(String(e));
|
|
29
|
+
exports.toError = toError;
|
|
30
|
+
/**
|
|
31
|
+
* Attach the lifecycle handlers to a raw gRPC stream. The only place in the
|
|
32
|
+
* stream modules that calls `.on(...)` on a stream.
|
|
33
|
+
*
|
|
34
|
+
* `error`, `end` and `close` events can all fire for one dead stream; the first
|
|
35
|
+
* one decides which handler runs, and the `close` handler runs exactly once.
|
|
36
|
+
*/
|
|
37
|
+
function attachStream(stream, handlers) {
|
|
38
|
+
let settled = false;
|
|
39
|
+
const settle = (deliverCause) => {
|
|
40
|
+
if (settled) {
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
settled = true;
|
|
44
|
+
try {
|
|
45
|
+
deliverCause();
|
|
46
|
+
}
|
|
47
|
+
finally {
|
|
48
|
+
handlers.close();
|
|
49
|
+
}
|
|
50
|
+
};
|
|
51
|
+
stream.on('data', (item) => {
|
|
52
|
+
if (settled) {
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
try {
|
|
56
|
+
handlers.data(item);
|
|
57
|
+
}
|
|
58
|
+
catch (e) {
|
|
59
|
+
// A throwing data handler is a bug, but it must not be silent and it
|
|
60
|
+
// must not leave a stream running that nobody is processing.
|
|
61
|
+
(0, exports.cancelStream)(stream);
|
|
62
|
+
settle(() => handlers.error((0, exports.toError)(e)));
|
|
63
|
+
}
|
|
64
|
+
});
|
|
65
|
+
stream.on('error', (e) => settle(() => handlers.error((0, exports.toError)(e))));
|
|
66
|
+
stream.on('end', () => settle(() => handlers.end()));
|
|
67
|
+
stream.on('close', () => settle(() => handlers.end()));
|
|
68
|
+
return {
|
|
69
|
+
dispose: () => {
|
|
70
|
+
settled = true;
|
|
71
|
+
(0, exports.cancelStream)(stream);
|
|
72
|
+
},
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* `streamActivatedJobsStream` resolves to `{ error }` (or `undefined` when the
|
|
77
|
+
* client is closing) instead of a stream when the stream cannot be opened.
|
|
78
|
+
* Returns the open error, or `undefined` when `result` is a usable stream.
|
|
79
|
+
*/
|
|
80
|
+
const getOpenError = (result) => {
|
|
81
|
+
if (!result)
|
|
82
|
+
return new Error('Stream could not be opened');
|
|
83
|
+
if (typeof result === 'object' && 'error' in result) {
|
|
84
|
+
return (0, exports.toError)(result.error);
|
|
85
|
+
}
|
|
86
|
+
return undefined;
|
|
87
|
+
};
|
|
88
|
+
exports.getOpenError = getOpenError;
|
|
89
|
+
/** Delay before reconnect `attempt` (1-based): exponential, capped. */
|
|
90
|
+
const backoffDelayMs = (attempt, initialDelayMs, maxDelayMs) => Math.min(initialDelayMs * 2 ** (attempt - 1), maxDelayMs);
|
|
91
|
+
exports.backoffDelayMs = backoffDelayMs;
|
|
92
|
+
exports.STREAM_HANDLE_BRAND = Symbol('StreamHandle');
|
|
93
|
+
function createStreamStateMachine(initial = { status: 'open' }) {
|
|
94
|
+
let state = initial;
|
|
95
|
+
let resolveDone = () => { };
|
|
96
|
+
const done = new Promise((resolve) => {
|
|
97
|
+
resolveDone = resolve;
|
|
98
|
+
});
|
|
99
|
+
return {
|
|
100
|
+
get state() {
|
|
101
|
+
return state;
|
|
102
|
+
},
|
|
103
|
+
done,
|
|
104
|
+
transition: (next) => {
|
|
105
|
+
if (state.status === 'closed') {
|
|
106
|
+
return false;
|
|
107
|
+
}
|
|
108
|
+
state = next;
|
|
109
|
+
if (next.status === 'closed') {
|
|
110
|
+
resolveDone(next.reason);
|
|
111
|
+
}
|
|
112
|
+
return true;
|
|
113
|
+
},
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
function createStreamHandle(machine, close) {
|
|
117
|
+
return {
|
|
118
|
+
[exports.STREAM_HANDLE_BRAND]: true,
|
|
119
|
+
close,
|
|
120
|
+
get state() {
|
|
121
|
+
return machine.state;
|
|
122
|
+
},
|
|
123
|
+
done: machine.done,
|
|
124
|
+
};
|
|
125
|
+
}
|
|
126
|
+
const describeFailure = (failure) => failure.kind === 'end'
|
|
127
|
+
? 'stream ended'
|
|
128
|
+
: `${failure.kind}: ${failure.error.message}`;
|
|
129
|
+
const describeReason = (reason) => reason.kind === 'stream-failed'
|
|
130
|
+
? `stream failed (${describeFailure(reason.failure)})`
|
|
131
|
+
: reason.kind;
|
|
132
|
+
// An exhaustive lookup rather than a `switch` (see STYLE.md): adding a state
|
|
133
|
+
// to `StreamState` without describing it here fails `tsc`.
|
|
134
|
+
const describers = {
|
|
135
|
+
open: () => 'open',
|
|
136
|
+
reconnecting: (s) => `reconnecting (attempt ${s.attempt}, ${describeFailure(s.cause)})`,
|
|
137
|
+
closed: (s) => `closed (${describeReason(s.reason)})`,
|
|
138
|
+
};
|
|
139
|
+
/** Human-readable description of a state, for logs. */
|
|
140
|
+
const describeStreamState = (state) => describers[state.status](state);
|
|
141
|
+
exports.describeStreamState = describeStreamState;
|
|
142
|
+
//# sourceMappingURL=StreamLifecycle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"StreamLifecycle.js","sourceRoot":"","sources":["../../../src/zeebe/lib/StreamLifecycle.ts"],"names":[],"mappings":";;;AAiIA,oCAyCC;AAuDD,4DAwBC;AAED,gDAYC;AAtKD;;;;;GAKG;AACI,MAAM,QAAQ,GAAG,CAAI,MAAe,EAA2B,EAAE,CACvE,MAAiC,CAAA;AADrB,QAAA,QAAQ,YACa;AAElC;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAC,MAAqC,EAAQ,EAAE;IAC3E,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,CAAC,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,OAAO,EAAE,CAAA;AACjB,CAAC,CAAA;AAJY,QAAA,YAAY,gBAIxB;AAEM,MAAM,OAAO,GAAG,CAAC,CAAU,EAAS,EAAE,CAC5C,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;AADjC,QAAA,OAAO,WAC0B;AAE9C;;;;;;GAMG;AACH,SAAgB,YAAY,CAC3B,MAA+B,EAC/B,QAA2B;IAE3B,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,MAAM,MAAM,GAAG,CAAC,YAAwB,EAAE,EAAE;QAC3C,IAAI,OAAO,EAAE,CAAC;YACb,OAAM;QACP,CAAC;QACD,OAAO,GAAG,IAAI,CAAA;QACd,IAAI,CAAC;YACJ,YAAY,EAAE,CAAA;QACf,CAAC;gBAAS,CAAC;YACV,QAAQ,CAAC,KAAK,EAAE,CAAA;QACjB,CAAC;IACF,CAAC,CAAA;IAED,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAO,EAAE,EAAE;QAC7B,IAAI,OAAO,EAAE,CAAC;YACb,OAAM;QACP,CAAC;QACD,IAAI,CAAC;YACJ,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,qEAAqE;YACrE,6DAA6D;YAC7D,IAAA,oBAAY,EAAC,MAAM,CAAC,CAAA;YACpB,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAA,eAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACzC,CAAC;IACF,CAAC,CAAC,CAAA;IACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAU,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAA,eAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC5E,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IACpD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IAEtD,OAAO;QACN,OAAO,EAAE,GAAG,EAAE;YACb,OAAO,GAAG,IAAI,CAAA;YACd,IAAA,oBAAY,EAAC,MAAM,CAAC,CAAA;QACrB,CAAC;KACD,CAAA;AACF,CAAC;AAED;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,MAAe,EAAqB,EAAE;IAClE,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;IAC3D,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACrD,OAAO,IAAA,eAAO,EAAE,MAA6B,CAAC,KAAK,CAAC,CAAA;IACrD,CAAC;IACD,OAAO,SAAS,CAAA;AACjB,CAAC,CAAA;AANY,QAAA,YAAY,gBAMxB;AAED,uEAAuE;AAChE,MAAM,cAAc,GAAG,CAC7B,OAAe,EACf,cAAsB,EACtB,UAAkB,EACT,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AAJzD,QAAA,cAAc,kBAI2C;AAEzD,QAAA,mBAAmB,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAA;AAiCxE,SAAgB,wBAAwB,CACvC,UAAuB,EAAE,MAAM,EAAE,MAAM,EAAE;IAEzC,IAAI,KAAK,GAAG,OAAO,CAAA;IACnB,IAAI,WAAW,GAAyC,GAAG,EAAE,GAAE,CAAC,CAAA;IAChE,MAAM,IAAI,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;QACxD,WAAW,GAAG,OAAO,CAAA;IACtB,CAAC,CAAC,CAAA;IACF,OAAO;QACN,IAAI,KAAK;YACR,OAAO,KAAK,CAAA;QACb,CAAC;QACD,IAAI;QACJ,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;YACpB,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAA;YACb,CAAC;YACD,KAAK,GAAG,IAAI,CAAA;YACZ,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC9B,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACzB,CAAC;YACD,OAAO,IAAI,CAAA;QACZ,CAAC;KACD,CAAA;AACF,CAAC;AAED,SAAgB,kBAAkB,CACjC,OAAmD,EACnD,KAAiB;IAEjB,OAAO;QACN,CAAC,2BAAmB,CAAC,EAAE,IAAI;QAC3B,KAAK;QACL,IAAI,KAAK;YACR,OAAO,OAAO,CAAC,KAAK,CAAA;QACrB,CAAC;QACD,IAAI,EAAE,OAAO,CAAC,IAAI;KAClB,CAAA;AACF,CAAC;AAQD,MAAM,eAAe,GAAG,CAAC,OAAsB,EAAU,EAAE,CAC1D,OAAO,CAAC,IAAI,KAAK,KAAK;IACrB,CAAC,CAAC,cAAc;IAChB,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAA;AAE/C,MAAM,cAAc,GAAG,CAAC,MAA0B,EAAU,EAAE,CAC7D,MAAM,CAAC,IAAI,KAAK,eAAe;IAC9B,CAAC,CAAC,kBAAkB,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG;IACtD,CAAC,CAAC,MAAM,CAAC,IAAI,CAAA;AAEf,6EAA6E;AAC7E,2DAA2D;AAC3D,MAAM,UAAU,GAAoB;IACnC,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM;IAClB,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,yBAAyB,CAAC,CAAC,OAAO,KAAK,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG;IACnE,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG;CACrD,CAAA;AAED,uDAAuD;AAChD,MAAM,mBAAmB,GAAG,CAAC,KAAkB,EAAU,EAAE,CAChE,UAAU,CAAC,KAAK,CAAC,MAAM,CAAgC,CAAC,KAAK,CAAC,CAAA;AADnD,QAAA,mBAAmB,uBACgC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ZeebeGrpcClient } from '../zb/ZeebeGrpcClient';
|
|
2
2
|
import { StatefulLogInterceptor } from './StatefulLogInterceptor';
|
|
3
|
+
import { StreamHandle } from './StreamLifecycle';
|
|
3
4
|
import { IZBJobWorker, Job, JobCompletionInterface, ZBGrpc, ZBWorkerTaskHandler } from './interfaces-1.0';
|
|
4
5
|
import { StreamActivatedJobsRequest } from './interfaces-grpc-1.0';
|
|
5
6
|
/**
|
|
@@ -44,6 +45,7 @@ export declare class ZBStreamWorker implements IZBJobWorker {
|
|
|
44
45
|
private logger;
|
|
45
46
|
private zbClient;
|
|
46
47
|
private streams;
|
|
48
|
+
private machines;
|
|
47
49
|
private closed;
|
|
48
50
|
private pollTimers;
|
|
49
51
|
private reconnectTimers;
|
|
@@ -81,9 +83,7 @@ export declare class ZBStreamWorker implements IZBJobWorker {
|
|
|
81
83
|
* polling (the initial backfill poll still runs).
|
|
82
84
|
*/
|
|
83
85
|
pollInterval?: number;
|
|
84
|
-
} & StreamJobsRecoveryOptions): Promise<
|
|
85
|
-
close: () => void;
|
|
86
|
-
}>;
|
|
86
|
+
} & StreamJobsRecoveryOptions): Promise<StreamHandle>;
|
|
87
87
|
close(): Promise<void>;
|
|
88
88
|
log(msg: JSON): void;
|
|
89
89
|
debug(msg: JSON): void;
|