feat: introduce standalone `execute()` and `executionTrace()` functions and `@trace()` decorator by tabkram · Pull Request #54 · tabkram/execution-engine

tabkram · 2025-02-22T12:35:41Z

create a generic execute() function that handles async , async and hidden promises function
create standalone executionTrace() function usage without requiring engine instantiation.
introduce the @trace() decorator to manage ExecutionTrace, append function metadata, and enrich the bound context with custom info.
refactor trace and engine models.
rename TraceableExecution to TraceableEngine to separate engine scope from standalone scope
refactor TraceableEngine to use the common executionTrace() function and the execute() behind
doc and generate examples to ensure deprecated engin still work and supported

⚠️ Deprecation Notice:

✅ Compatibility Notice:

- create a generic `execute()` function that handles async , async and hidden promises function - create standalone `trace()` function usage without requiring engine instantiation. - refactor models ⚠️ Deprecation Notice: - `NodeExecutionTrace` is deprecated, Use `ExecutionTrace` instead. - `NodeExecutionTraceExtractor` is deprecated. Use `ExecutionTraceExtractor` instead. - `isNodeExecutionTrace` is deprecated. Use `isExecutionTrace` instead.

github-actions · 2025-02-22T12:36:17Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	96.01% (+3.37% 🔼)	313/326
🟢	Branches	88.7% (+1.75% 🔼)	212/239
🟢	Functions	94.38% (+2.38% 🔼)	84/89
🟢	Lines	96.77% (+3.41% 🔼)	300/310

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	trace/trace.ts	100%	100%	100%	100%
🟢	`...` / functionMetadata.ts	100%	75%	100%	100%
🟢	`...` / isAsync.ts	100%	100%	100%	100%
🟢	`...` / safeError.ts	100%	100%	100%	100%
🟢	`...` / execute.ts	100%	86.96%	100%	100%
🟢	`...` / traceableEngine.ts	95.5%	86.67%	96.55%	96%
🟢	`...` / engineNodeData.model.ts	100%	100%	100%	100%
🟢	`...` / engineTraceOptions.model.ts	100%	100%	100%	100%
🟢	`...` / executionTrace.model.ts	100%	100%	100%	100%
🟢	`...` / jsonQuery.ts	83.33%	80%	76.92%	85.19%
🟢	`...` / traceDecorator.ts	100%	100%	100%	100%

Test suite run success

73 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from 2e4d89d

github-actions · 2025-02-22T12:36:33Z

🚫 Unpublished versions: ∅
✅ Created Version: 2.2.3-canary.54.ef121e4
📦 Published on NPM: View on NPM

github-actions · 2025-02-22T12:51:36Z

🚫 Unpublished versions: ~~2.2.3-canary.54.ef121e4~~
✅ Created Version: 2.2.3-canary.54.d4e19ad
📦 Published on NPM: View on NPM

github-actions · 2025-02-22T12:53:55Z

🚫 Unpublished versions: ~~2.2.3-canary.54.d4e19ad~~
✅ Created Version: 2.2.3-canary.54.6005c17
📦 Published on NPM: View on NPM

… functions features: - rename `TraceableExecution` to `TraceableEngine` to separate engine scope from standalone scope - refactor `TraceableEngine` to use the common `trace()` function and the `execute()` behind - doc and generate examples to ensure deprecated engin still work and supported ⚠️ Deprecation Notice: - `TraceableExecution` is deprecated and will be removed in a future release. Use `TraceableEngine` instead.

…or execution tracing

…dels and internal utils

github-actions · 2025-02-22T16:27:51Z

🚫 Unpublished versions: ~~2.2.3-canary.54.6005c17~~
✅ Created Version: 2.2.3-canary.54.0b86dcc
📦 Published on NPM: View on NPM

github-actions · 2025-02-22T16:28:43Z

🚫 Unpublished versions: ~~2.2.3-canary.54.0b86dcc~~
✅ Created Version: 2.2.3-canary.54.a12b259
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T08:51:48Z

🚫 Unpublished versions: ~~2.2.3-canary.54.a12b259~~
✅ Created Version: 2.2.3-canary.54.31d3db9
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T08:52:38Z

🚫 Unpublished versions: ~~2.2.3-canary.54.31d3db9~~
✅ Created Version: 2.2.3-canary.54.da35727
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T13:40:40Z

🚫 Unpublished versions: ~~2.2.3-canary.54.ee32e18~~
✅ Created Version: 2.2.3-canary.54.2a362e5
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T13:44:55Z

🚫 Unpublished versions: ~~2.2.3-canary.54.2a362e5~~
✅ Created Version: 2.2.3-canary.54.b776d29
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T16:21:55Z

🚫 Unpublished versions: ~~2.2.3-canary.54.b776d29~~
✅ Created Version: 2.2.3-canary.54.a3b581c
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T16:22:29Z

🚫 Unpublished versions: ~~2.2.3-canary.54.a3b581c~~
✅ Created Version: 2.2.3-canary.54.9d8d2a9
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T16:35:21Z

🚫 Unpublished versions: ~~2.2.3-canary.54.9d8d2a9~~
✅ Created Version: 2.2.3-canary.54.252a612
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T16:37:11Z

🚫 Unpublished versions: ~~2.2.3-canary.54.252a612~~
✅ Created Version: 2.2.3-canary.54.21d10ef
📦 Published on NPM: View on NPM

- add a unique execution uuid to the executionTrace - add the possibility to update executionTrace with a custom data - add the possibility to update the context of the instantiated class with the trace (if the contextKey is specified) - update tabkram.github.io/execution-engine documentation ✅ Compatibility Notice: - `metadata` are not handled in the engine ExecutionTrace for now, to avoid modifying the engine.

github-actions · 2025-02-24T17:38:04Z

🚫 Unpublished versions: ~~2.2.3-canary.54.21d10ef~~
✅ Created Version: 2.2.3-canary.54.392127b
📦 Published on NPM: View on NPM

⚠️ Deprecation Notice: - `EdgeData` is deprecated, use `EngineEdgeData` instead. - `NodeTrace` is deprecated, use `EngineNodeTrace` instead. - `NodeData` is deprecated, use `EngineNodeData` instead. - `Node` is deprecated, use `EngineNode` instead. - `Edge` is deprecated, use `EngineEdge` instead. - `Trace` is deprecated, use `EngineTrace` instead. - `isNodeTrace` is deprecated, use `isEngineNodeTrace` instead.

github-actions · 2025-02-24T18:36:27Z

🚫 Unpublished versions: ~~2.2.3-canary.54.392127b~~
✅ Created Version: 2.2.3-canary.54.4a1344b
📦 Published on NPM: View on NPM

…ial` transformer to maintain compatibility after adding mandatory `id: string` in `ExecutionTrace` model. This prevents the TS2769: No overload matches this call error when executing `.run()` with a `narratives` transformer in `options?: TraceOptions<Array<any>, O>`

github-actions · 2025-02-24T19:31:01Z

🚫 Unpublished versions: ~~2.2.3-canary.54.4a1344b~~
✅ Created Version: 2.2.3-canary.54.f4c1c63
📦 Published on NPM: View on NPM

github-actions · 2025-02-24T19:36:00Z

🚫 Unpublished versions: ~~2.2.3-canary.54.f4c1c63~~

tabkram added the deploy deploy a canary version to NPM label Feb 22, 2025

tabkram deployed to canary February 22, 2025 12:36 — with GitHub Actions View deployment

tabkram deployed to canary February 22, 2025 12:51 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from a5c9877 to 138acfd Compare February 22, 2025 12:52

tabkram changed the title ~~feat: create standalone execute() and trace() functions~~ feat: create standalone execute() and trace() functions and adapt TraceableExecution to use them Feb 22, 2025

tabkram deployed to canary February 22, 2025 12:53 — with GitHub Actions View deployment

tabkram changed the title ~~feat: create standalone execute() and trace() functions and adapt TraceableExecution to use them~~ feat: introduce standalone execute() and trace() functions, refactor TraceableExecution to utilize them Feb 22, 2025

tabkram added 2 commits February 22, 2025 16:42

feat: add @trace()decorator in order to be able to pass a handler f…

fd38e11

…or execution tracing

tabkram force-pushed the feature/trace branch from 138acfd to c25da94 Compare February 22, 2025 16:26

tabkram deployed to canary February 22, 2025 16:27 — with GitHub Actions View deployment

refactor: rename trace() to executionTrace() and create common mo…

5f70be9

…dels and internal utils

tabkram force-pushed the feature/trace branch from c25da94 to 5f70be9 Compare February 22, 2025 16:27

tabkram deployed to canary February 22, 2025 16:28 — with GitHub Actions View deployment

tabkram changed the title ~~feat: introduce standalone execute() and trace() functions, refactor TraceableExecution to utilize them~~ feat: introduce standalone execute() and executionTrace() functions and @trace() decorator Feb 22, 2025

tabkram changed the title ~~feat: introduce standalone execute() and executionTrace() functions and @trace() decorator~~ feat: introduce standalone execute() and executionTrace() functions and @trace() decorator Feb 22, 2025

tabkram deployed to canary February 24, 2025 08:51 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from c42a84f to 7c165d2 Compare February 24, 2025 08:51

tabkram deployed to canary February 24, 2025 08:52 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 7c165d2 to 3567367 Compare February 24, 2025 11:52

tabkram deployed to canary February 24, 2025 11:52 — with GitHub Actions View deployment

tabkram deployed to canary February 24, 2025 13:40 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 69e062d to 32265d0 Compare February 24, 2025 13:43

tabkram deployed to canary February 24, 2025 13:44 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 32265d0 to 7c407ea Compare February 24, 2025 16:20

tabkram deployed to canary February 24, 2025 16:21 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 7c407ea to 4e6d39f Compare February 24, 2025 16:21

tabkram deployed to canary February 24, 2025 16:21 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 4e6d39f to 3b20947 Compare February 24, 2025 16:34

tabkram deployed to canary February 24, 2025 16:34 — with GitHub Actions View deployment

tabkram force-pushed the feature/trace branch from 3b20947 to 1585a93 Compare February 24, 2025 16:36

tabkram deployed to canary February 24, 2025 16:36 — with GitHub Actions View deployment

tabkram self-assigned this Feb 24, 2025

tabkram force-pushed the feature/trace branch from 1585a93 to 5461699 Compare February 24, 2025 17:36

tabkram deployed to canary February 24, 2025 17:37 — with GitHub Actions View deployment

tabkram deployed to canary February 24, 2025 18:36 — with GitHub Actions View deployment

tabkram deployed to canary February 24, 2025 19:30 — with GitHub Actions View deployment

tabkram merged commit 4425f7a into main Feb 24, 2025

Uh oh!

Conversation

tabkram commented Feb 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Feb 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

github-actions Bot commented Feb 22, 2025

Uh oh!

github-actions Bot commented Feb 22, 2025

Uh oh!

github-actions Bot commented Feb 22, 2025

Uh oh!

github-actions Bot commented Feb 22, 2025

Uh oh!

github-actions Bot commented Feb 22, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

github-actions Bot commented Feb 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tabkram commented Feb 22, 2025 •

edited

Loading

github-actions Bot commented Feb 22, 2025 •

edited

Loading