@forestadmin/workflow-executor 1.8.0 → 1.9.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/README.md +57 -10
- package/dist/cli-core.js +7 -5
- package/dist/tracing.d.ts +1 -0
- package/dist/tracing.js +41 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -8,33 +8,53 @@ client data ever leaves your infrastructure.
|
|
|
8
8
|
|
|
9
9
|
## Prerequisites
|
|
10
10
|
|
|
11
|
-
Make sure you are on the latest version of your Forest Admin agent (Node.js/JS or Ruby), then
|
|
11
|
+
Make sure you are on the latest version of your Forest Admin agent (Node.js/JS or Ruby), then point your agent at the executor with `workflowExecutorUrl`:
|
|
12
12
|
|
|
13
13
|
```js
|
|
14
14
|
createAgent({
|
|
15
15
|
// ...
|
|
16
|
-
workflowExecutorUrl:
|
|
16
|
+
workflowExecutorUrl: process.env.WORKFLOW_EXECUTOR_URL, // e.g. http://localhost:3400
|
|
17
17
|
})
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
+
This is **required** for the executor to work: when `workflowExecutorUrl` is set, the agent mounts the route that forwards workflow requests to the executor (and relays the JWT for auth). If it is left unset, the agent returns `404` on those routes and the executor never receives any work.
|
|
21
|
+
|
|
22
|
+
Drive it from an environment variable (`WORKFLOW_EXECUTOR_URL` above) so each deployment can target its own executor. The URL is where the agent reaches the executor — its HTTP server (default port `3400`). When the agent and executor run on separate hosts behind a private network (e.g. an internal load balancer), use the executor's internal address, and make sure the agent can reach the executor's HTTP port.
|
|
23
|
+
|
|
20
24
|
---
|
|
21
25
|
|
|
22
|
-
##
|
|
26
|
+
## Docker (recommended)
|
|
27
|
+
|
|
28
|
+
### Quick start
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
cp .env.example .env # fill in your secrets
|
|
32
|
+
docker compose up
|
|
33
|
+
```
|
|
23
34
|
|
|
24
|
-
|
|
35
|
+
The `docker-compose.yml` at the root of this package starts a single executor instance. See `.env.example` for the full list of environment variables and their descriptions.
|
|
25
36
|
|
|
26
|
-
|
|
37
|
+
### Run directly
|
|
27
38
|
|
|
28
39
|
```bash
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
40
|
+
docker run -d \
|
|
41
|
+
-e FOREST_ENV_SECRET="your-env-secret" \
|
|
42
|
+
-e FOREST_AUTH_SECRET="your-auth-secret" \
|
|
43
|
+
-e AGENT_URL="http://host.docker.internal:3351" \
|
|
44
|
+
-e DATABASE_URL="postgres://user:pass@host.docker.internal:5432/mydb" \
|
|
45
|
+
-p 3400:3400 \
|
|
46
|
+
ghcr.io/forestadmin/workflow-executor:latest
|
|
33
47
|
```
|
|
34
48
|
|
|
49
|
+
> **Note:** When the executor runs in Docker and your agent runs on the host machine, use `host.docker.internal` instead of `localhost` in `AGENT_URL` and `DATABASE_URL`.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Without Docker
|
|
54
|
+
|
|
35
55
|
### With a database
|
|
36
56
|
|
|
37
|
-
|
|
57
|
+
Requires Node.js ≥ 22.12.0 and a Postgres database:
|
|
38
58
|
|
|
39
59
|
```bash
|
|
40
60
|
FOREST_ENV_SECRET="your-env-secret" \
|
|
@@ -49,3 +69,30 @@ npx @forestadmin/workflow-executor
|
|
|
49
69
|
Both values are already in your agent's environment variables. `FOREST_ENV_SECRET` can also be found in [app.forestadmin.com](https://app.forestadmin.com) → **Settings** → **Environments** → click your environment. `FOREST_AUTH_SECRET` is defined on your side only and is not available in the Forest Admin UI.
|
|
50
70
|
|
|
51
71
|
`AGENT_URL` is the URL where your Forest Admin agent is running (e.g. `http://localhost:3351`).
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Testing only
|
|
76
|
+
|
|
77
|
+
The following modes skip the database requirement but are **not suitable for production** — state is lost on restart.
|
|
78
|
+
|
|
79
|
+
### Docker
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
docker run --rm \
|
|
83
|
+
-e FOREST_ENV_SECRET="your-env-secret" \
|
|
84
|
+
-e FOREST_AUTH_SECRET="your-auth-secret" \
|
|
85
|
+
-e AGENT_URL="http://host.docker.internal:3351" \
|
|
86
|
+
-p 3400:3400 \
|
|
87
|
+
ghcr.io/forestadmin/workflow-executor:latest \
|
|
88
|
+
node packages/workflow-executor/dist/cli.js --in-memory --json
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Without Docker
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
FOREST_ENV_SECRET="your-env-secret" \
|
|
95
|
+
FOREST_AUTH_SECRET="your-auth-secret" \
|
|
96
|
+
AGENT_URL="https://your-agent-url" \
|
|
97
|
+
npx @forestadmin/workflow-executor --in-memory
|
|
98
|
+
```
|
package/dist/cli-core.js
CHANGED
|
@@ -39,9 +39,9 @@ function parseLoggerLevelEnv(raw) {
|
|
|
39
39
|
}
|
|
40
40
|
const TRUTHY = ['true', '1', 'yes', 'on'];
|
|
41
41
|
const FALSY = ['false', '0', 'no', 'off'];
|
|
42
|
-
function parseBooleanEnv(name, raw) {
|
|
42
|
+
function parseBooleanEnv(name, raw, defaultValue = false) {
|
|
43
43
|
if (!raw)
|
|
44
|
-
return
|
|
44
|
+
return defaultValue;
|
|
45
45
|
const value = raw.trim().toLowerCase();
|
|
46
46
|
if (TRUTHY.includes(value))
|
|
47
47
|
return true;
|
|
@@ -145,7 +145,9 @@ function readEnvConfig(env, args) {
|
|
|
145
145
|
return {
|
|
146
146
|
executorOptions,
|
|
147
147
|
databaseUrl: env.DATABASE_URL,
|
|
148
|
-
|
|
148
|
+
// Defaults to true: managed Postgres (RDS, Supabase, Railway…) requires TLS.
|
|
149
|
+
// Set DATABASE_SSL=false for a local/dev database without TLS.
|
|
150
|
+
databaseSsl: parseBooleanEnv('DATABASE_SSL', env.DATABASE_SSL, true),
|
|
149
151
|
mode: args.inMemory ? 'in-memory' : 'database',
|
|
150
152
|
};
|
|
151
153
|
}
|
|
@@ -168,7 +170,7 @@ Required environment variables:
|
|
|
168
170
|
DATABASE_URL Postgres connection string (not needed with --in-memory)
|
|
169
171
|
|
|
170
172
|
Optional environment variables:
|
|
171
|
-
DATABASE_SSL
|
|
173
|
+
DATABASE_SSL Connect to the database over TLS (default: true; set "false" for a local DB without TLS)
|
|
172
174
|
HTTP_PORT Default: ${defaults_1.DEFAULT_HTTP_PORT}
|
|
173
175
|
FOREST_SERVER_URL Default: ${defaults_1.DEFAULT_FOREST_SERVER_URL}
|
|
174
176
|
POLLING_INTERVAL_S Default: ${defaults_1.DEFAULT_POLLING_INTERVAL_S}
|
|
@@ -259,4 +261,4 @@ async function runCli(argv, env, factories) {
|
|
|
259
261
|
throw error;
|
|
260
262
|
}
|
|
261
263
|
}
|
|
262
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
264
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cli-core.js","sourceRoot":"","sources":["../src/cli-core.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;;;AA+F/B,8BAkCC;AAID,gCASC;AA6BD,sCA0CC;AAED,8BAuCC;AAED,oCAEC;AAED,gCAsBC;AAED,wBAuDC;AA9UD,6BAAwB;AAExB,+EAA4D;AAC5D,6EAA0D;AAM1D,yCAUoB;AACpB,qCAAmE;AAEnE,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;AACxD,MAAM,mBAAmB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvE,SAAS,mBAAmB,CAAC,IAAY,EAAE,GAAuB;IAChE,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IAE3B,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAE3C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAAC,GAAG,IAAI,qCAAqC,GAAG,IAAI,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAuB;IAClD,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IAE3B,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5E,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEzD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAC1B,2DAA2D,GAAG,IAAI,CACnE,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AAC1C,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAE1C,SAAS,eAAe,CAAC,IAAY,EAAE,GAAuB,EAAE,YAAY,GAAG,KAAK;IAClF,IAAI,CAAC,GAAG;QAAE,OAAO,YAAY,CAAC;IAE9B,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACvC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACxC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,MAAM,IAAI,2BAAkB,CAAC,GAAG,IAAI,yCAAyC,GAAG,GAAG,CAAC,CAAC;AACvF,CAAC;AAED,yGAAyG;AACzG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAwB,CAAC;AAEtE,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAsB/C,SAAgB,SAAS,CAAC,IAAc;IACtC,MAAM,MAAM,GAAY;QACtB,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;KACZ,CAAC;IAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,IAAI;gBACP,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACnB,MAAM;YACR,KAAK,WAAW,CAAC;YACjB,KAAK,IAAI;gBACP,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;gBACtB,MAAM;YACR,KAAK,aAAa;gBAChB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,MAAM;YACR,KAAK,UAAU;gBACb,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;gBACrB,MAAM;YACR,KAAK,QAAQ;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACnB,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,mGAAmG;AACnG,8FAA8F;AAC9F,SAAgB,UAAU,CACxB,IAAa,EACb,KAAkB,EAClB,SAA6B,OAAO,CAAC,MAAM;IAE3C,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,IAAA,wBAAmB,EAAC,KAAK,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,IAAA,uBAAkB,EAAC,KAAK,CAAC,CAAC;IAElD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,uBAAkB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,wBAAmB,EAAC,KAAK,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,aAAa,CAAC,GAAsB;IAC3C,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAClD,MAAM,MAAM,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAE/C,IAAI,QAAQ,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAErC,IAAI,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;IACJ,CAAC;IAED,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,qDAAqD,WAAW,GAAG,CAAC,CAAC;IACvF,CAAC;IAED,OAAO;QACL;YACE,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,WAAW;YACrB,KAAK,EAAE,QAAkB;YACzB,MAAM,EAAE,UAAoB;SAC7B;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAAC,GAAsB,EAAE,IAAa;IACjE,MAAM,YAAY,GAAG,CAAC,mBAAmB,EAAE,oBAAoB,EAAE,WAAW,CAAU,CAAC;IACvF,MAAM,OAAO,GAAa,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAEhE,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,4CAA4C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACvF,SAAS,WAAW,8BAA8B,CACrD,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAE5C,MAAM,eAAe,GAAoB;QACvC,SAAS,EAAE,GAAG,CAAC,iBAA2B;QAC1C,UAAU,EAAE,GAAG,CAAC,kBAA4B;QAC5C,QAAQ,EAAE,GAAG,CAAC,SAAmB;QACjC,QAAQ,EAAE,mBAAmB,CAAC,WAAW,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,4BAAiB;QAC9E,eAAe,EAAE,GAAG,CAAC,iBAAiB;QACtC,gBAAgB,EAAE,mBAAmB,CAAC,oBAAoB,EAAE,GAAG,CAAC,kBAAkB,CAAC;QACnF,YAAY,EAAE,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,CAAC,cAAc,CAAC;QACvE,YAAY,EAAE,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,CAAC,cAAc,CAAC;QACvE,gBAAgB,EAAE,mBAAmB,CAAC,qBAAqB,EAAE,GAAG,CAAC,mBAAmB,CAAC;QACrF,aAAa,EAAE,mBAAmB,CAAC,iBAAiB,EAAE,GAAG,CAAC,eAAe,CAAC;QAC1E,eAAe,EAAE,mBAAmB,CAAC,oBAAoB,EAAE,GAAG,CAAC,kBAAkB,CAAC;QAClF,WAAW,EAAE,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,+BAAoB;QACvE,GAAG,CAAC,gBAAgB,IAAI,EAAE,gBAAgB,EAAE,CAAC;QAC7C,GAAG,CAAC,GAAG,CAAC,cAAc,KAAK,MAAM,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;KAC7D,CAAC;IAEF,OAAO;QACL,eAAe;QACf,WAAW,EAAE,GAAG,CAAC,YAAY;QAC7B,6EAA6E;QAC7E,+DAA+D;QAC/D,WAAW,EAAE,eAAe,CAAC,cAAc,EAAE,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC;QACpE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU;KAC/C,CAAC;AACJ,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,CAAC,GAAG,CAAC,UAAU,WAAW;;;;;;;;;;;;;;;;;;;oCAmBC,4BAAiB;oCACjB,oCAAyB;mCAC1B,qCAA0B;mCAC1B,iCAAsB;sEACa,iCAAsB;+FACG,sCAA2B;qFACrC,kCAAuB;2EACjC,qCAA0B;iEACpC,+BAAoB;;;;;;;;;;mEAUlB,CAAC,CAAC;AACrE,CAAC;AAED,SAAgB,YAAY;IAC1B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACvB,CAAC;AAED,SAAgB,UAAU,CAAC,MAAc,EAAE,MAAiB;IAC1D,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAC5D,IAAI,OAAe,CAAC;IAEpB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO,GAAG,yBAAyB,CAAC;IACtC,CAAC;SAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;QACzC,OAAO,GAAG,UAAU,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;IAC/F,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,iBAAiB,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,4BAA4B,EAAE;QAC3C,IAAI;QACJ,WAAW,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;QAC1D,eAAe,EAAE,IAAI,CAAC,eAAe,IAAI,oCAAyB;QAClE,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,IAAI,qCAA0B;QACrE,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,+BAAoB;QACrD,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,MAAM,CAC1B,IAAc,EACd,GAAsB,EACtB,SAAuB;IAEvB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAE7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,SAAS,EAAE,CAAC;QAEZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,YAAY,EAAE,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,eAAe,CAAC,WAAW,IAAI,+BAAoB,CAAC,CAAC;IAC5F,MAAM,CAAC,eAAe,CAAC,MAAM,GAAG,MAAM,CAAC;IAEvC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE3B,IAAI,CAAC;QACH,IAAI,QAA0B,CAAC;QAE/B,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,QAAQ,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,MAAM,eAAe,GAA4B;gBAC/C,GAAG,MAAM,CAAC,eAAe;gBACzB,QAAQ,EAAE;oBACR,GAAG,EAAE,MAAM,CAAC,WAAqB;oBACjC,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI;wBACxB,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,EAAE;qBACtE,CAAC;iBACH;aACF,CAAC;YACF,QAAQ,GAAG,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvB,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE;YACxC,GAAG,EAAE,oBAAoB,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE;SAC3D,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,EAAE,mCAAmC,EAAE;YACnD,KAAK,EAAE,IAAA,4BAAmB,EAAC,KAAK,CAAC;SAClC,CAAC,CAAC;QACH,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//# sourceMappingURL=tracing.d.ts.map
|
package/dist/tracing.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Loaded via --require before cli.js to ensure instrumentation patches run first.
|
|
2
|
+
// Initialises the OpenTelemetry SDK only when OTEL_EXPORTER_OTLP_ENDPOINT is set.
|
|
3
|
+
// All configuration is handled via standard OTel environment variables:
|
|
4
|
+
// OTEL_EXPORTER_OTLP_ENDPOINT OTLP receiver (e.g. http://localhost:4318)
|
|
5
|
+
// OTEL_SERVICE_NAME default: forestadmin-workflow-executor
|
|
6
|
+
// OTEL_SDK_DISABLED set to "true" to force-disable
|
|
7
|
+
// OTEL_RESOURCE_ATTRIBUTES e.g. deployment.environment=production,version=1.7.0
|
|
8
|
+
//
|
|
9
|
+
// The OTel packages are installed only into the Docker image's isolated deps
|
|
10
|
+
// (see packages/workflow-executor/docker/), never shipped to npm consumers of
|
|
11
|
+
// the CLI — hence the dynamic require guarded by a try/catch.
|
|
12
|
+
if (process.env.OTEL_EXPORTER_OTLP_ENDPOINT && process.env.OTEL_SDK_DISABLED !== 'true') {
|
|
13
|
+
try {
|
|
14
|
+
/* eslint-disable global-require, @typescript-eslint/no-var-requires, import/no-extraneous-dependencies */
|
|
15
|
+
const { NodeSDK } = require('@opentelemetry/sdk-node');
|
|
16
|
+
const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
|
|
17
|
+
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
|
|
18
|
+
/* eslint-enable global-require, @typescript-eslint/no-var-requires, import/no-extraneous-dependencies */
|
|
19
|
+
const sdk = new NodeSDK({
|
|
20
|
+
serviceName: process.env.OTEL_SERVICE_NAME || 'forestadmin-workflow-executor',
|
|
21
|
+
traceExporter: new OTLPTraceExporter(),
|
|
22
|
+
instrumentations: [getNodeAutoInstrumentations()],
|
|
23
|
+
});
|
|
24
|
+
sdk.start();
|
|
25
|
+
// Flush buffered spans on graceful shutdown. We must NOT call process.exit
|
|
26
|
+
// here: the executor's own SIGTERM/SIGINT handler drains in-flight steps
|
|
27
|
+
// (up to stopTimeoutMs) and owns the exit. We only flush in parallel — once
|
|
28
|
+
// the SDK shutdown and the drain both settle, the event loop empties and the
|
|
29
|
+
// process exits naturally (the executor keeps its own force-exit safety net).
|
|
30
|
+
const flush = () => {
|
|
31
|
+
void sdk.shutdown();
|
|
32
|
+
};
|
|
33
|
+
process.once('SIGTERM', flush);
|
|
34
|
+
process.once('SIGINT', flush);
|
|
35
|
+
}
|
|
36
|
+
catch {
|
|
37
|
+
// eslint-disable-next-line no-console
|
|
38
|
+
console.warn('[tracing] OpenTelemetry packages not available, skipping APM initialisation');
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2luZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy90cmFjaW5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGtGQUFrRjtBQUNsRixrRkFBa0Y7QUFDbEYsd0VBQXdFO0FBQ3hFLDZFQUE2RTtBQUM3RSwwRUFBMEU7QUFDMUUsa0VBQWtFO0FBQ2xFLHdGQUF3RjtBQUN4RixFQUFFO0FBQ0YsNkVBQTZFO0FBQzdFLDhFQUE4RTtBQUM5RSw4REFBOEQ7QUFDOUQsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLDJCQUEyQixJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLEtBQUssTUFBTSxFQUFFLENBQUM7SUFDeEYsSUFBSSxDQUFDO1FBQ0gsMEdBQTBHO1FBQzFHLE1BQU0sRUFBRSxPQUFPLEVBQUUsR0FBRyxPQUFPLENBQUMseUJBQXlCLENBQUMsQ0FBQztRQUN2RCxNQUFNLEVBQUUsMkJBQTJCLEVBQUUsR0FBRyxPQUFPLENBQUMsMkNBQTJDLENBQUMsQ0FBQztRQUM3RixNQUFNLEVBQUUsaUJBQWlCLEVBQUUsR0FBRyxPQUFPLENBQUMseUNBQXlDLENBQUMsQ0FBQztRQUNqRix5R0FBeUc7UUFFekcsTUFBTSxHQUFHLEdBQUcsSUFBSSxPQUFPLENBQUM7WUFDdEIsV0FBVyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLElBQUksK0JBQStCO1lBQzdFLGFBQWEsRUFBRSxJQUFJLGlCQUFpQixFQUFFO1lBQ3RDLGdCQUFnQixFQUFFLENBQUMsMkJBQTJCLEVBQUUsQ0FBQztTQUNsRCxDQUFDLENBQUM7UUFFSCxHQUFHLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFWiwyRUFBMkU7UUFDM0UseUVBQXlFO1FBQ3pFLDRFQUE0RTtRQUM1RSw2RUFBNkU7UUFDN0UsOEVBQThFO1FBQzlFLE1BQU0sS0FBSyxHQUFHLEdBQUcsRUFBRTtZQUNqQixLQUFLLEdBQUcsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUN0QixDQUFDLENBQUM7UUFFRixPQUFPLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxLQUFLLENBQUMsQ0FBQztRQUMvQixPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1Asc0NBQXNDO1FBQ3RDLE9BQU8sQ0FBQyxJQUFJLENBQUMsNkVBQTZFLENBQUMsQ0FBQztJQUM5RixDQUFDO0FBQ0gsQ0FBQyJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forestadmin/workflow-executor",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"bin": {
|
|
6
6
|
"forest-workflow-executor": "dist/cli.js"
|
|
@@ -37,6 +37,7 @@
|
|
|
37
37
|
"jsonwebtoken": "^9.0.3",
|
|
38
38
|
"koa": "^3.0.1",
|
|
39
39
|
"koa-jwt": "^4.0.4",
|
|
40
|
+
"pg": "^8.8.0",
|
|
40
41
|
"picocolors": "^1.1.1",
|
|
41
42
|
"sequelize": "^6.37.8",
|
|
42
43
|
"umzug": "^3.8.2",
|
|
@@ -47,7 +48,6 @@
|
|
|
47
48
|
"@types/koa": "^2.13.5",
|
|
48
49
|
"@types/koa__router": "^12.0.4",
|
|
49
50
|
"@types/sequelize": "^6.12.0",
|
|
50
|
-
"pg": "^8.8.0",
|
|
51
51
|
"sqlite3": "^6.0.1",
|
|
52
52
|
"supertest": "^7.1.3"
|
|
53
53
|
}
|