14387781488

Committed 10 Apr 2025 06:33PM UTC coverage: 92.964% (-0.4%) from 93.367%

Build # 14387781488

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #70 from tabkram/feature/cache

fix: add bypass argument to cache execution

Run Details

237 of 271 branches covered (87.45%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

384 of 397 relevant lines covered (96.73%)

95.65 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.49

/src/engine/executionEngine.ts

import { TraceableEngine } from './traceableEngine';
import { EngineTrace } from '../common/models/engineTrace.model';

/**
 * Represents a Contextual Execution with traceability features.
 *
 * @template CXT - Type of the context object.
 */
export class ExecutionEngine<
  CXT extends { [key: string]: unknown } = {
    [key: string]: unknown;
  }
> extends TraceableEngine {
  protected context: CXT;

  protected executionDate: Date;
  protected executionId: string;

  /**
   * Creates an instance of ContextualExecution.
   *
   * @param {Object} [options] - Options for initializing the execution.
   * @param {Date} [options.executionDate] - Date of the execution.
   * @param {string} [options.executionId] - Unique identifier for the execution.
   * @param {string} [options.initialTrace] - The initial trace for the execution.
   */
  constructor(options?: { executionDate?: Date; executionId?: string; initialTrace?: EngineTrace }) {
    super(options?.initialTrace);
    this.executionDate = options?.executionDate ?? new Date();
    this.executionId =
      options?.executionId ??
      [
        'exec',
        this.executionDate
          .toISOString()
          .replace(/[-:.Z]/g, '')
          .replace('T', '_'),
        crypto.randomUUID()
      ].join('_');

    return this;
  }

  /**
   * Get the current options of the Execution Engine.
   *
   * @returns {Object} An object containing the execution date and ID.
   * @public
   */
  getOptions(): { executionDate: Date; executionId: string } {
    return { executionDate: this.executionDate, executionId: this.executionId };
  }

  setContext(value: CXT): ExecutionEngine<CXT> {
    this.context = this.deepClone(value);
    return this;
  }

  getContext(): CXT {
    return this.context;
  }

  /**
   * Update the context of the execution with partial information.
   *
   * @param {Partial<CXT>} partialContext - Partial context information to update.
   * @returns {ExecutionEngine} - The updated ContextualExecution instance.
   */
  updateContext(partialContext: Partial<CXT>): ExecutionEngine {
    this.context = {
      ...this.context,
      ...partialContext
    };
    return this;
  }

  /**
   * Update a specific attribute of the context object.
   *
   * @param {K} key - The key of the attribute to update.
   * @param {CXT[K]} partialContextAttribute - Partial information to update for the attribute.
   * @returns {ExecutionEngine} - The updated ContextualExecution instance.
   */
  updateContextAttribute<K extends keyof CXT>(key: K, partialContextAttribute: CXT[K]): ExecutionEngine {
    if (partialContextAttribute === null || typeof partialContextAttribute !== 'object') {
      // If the provided attribute is not an object or is null,
      // directly update the attribute in the context.
      this.context[key] = partialContextAttribute;
    } else {
      // If the provided attribute is an object, merge it with the existing attribute.
      this.context[key] = {
        ...(this.context?.[key] ?? {}),
        ...partialContextAttribute
      };
    }
    return this;
  }

  /**
   * Deep clone function to copy nested objects.
   *
   * @private
   * @template T - Type of the object to clone.
   * @param {T} obj - The object to clone.
   * @returns {T} - The cloned object.
   */
  private deepClone<T>(obj: T): T {
    if (obj === null || typeof obj !== 'object') {
      return obj;
    }

    if (Array.isArray(obj)) {
      return obj.map((item) => this.deepClone(item)) as T;
    }

    return Object.entries(obj).reduce((acc, [key, value]) => {
      acc[key] = this.deepClone(value);
      return acc;
    }, {} as T);
  }
}

1	import { TraceableEngine } from './traceableEngine';	2✔
2	import { EngineTrace } from '../common/models/engineTrace.model';
3
4	/**
5	* Represents a Contextual Execution with traceability features.
6	*
7	* @template CXT - Type of the context object.
8	*/
9	export class ExecutionEngine<	2✔
10	CXT extends { [key: string]: unknown } = {
11	[key: string]: unknown;
12	}
13	> extends TraceableEngine {
14	protected context: CXT;
15
16	protected executionDate: Date;
17	protected executionId: string;
18
19	/**
20	* Creates an instance of ContextualExecution.
21	*
22	* @param {Object} [options] - Options for initializing the execution.
23	* @param {Date} [options.executionDate] - Date of the execution.
24	* @param {string} [options.executionId] - Unique identifier for the execution.
25	* @param {string} [options.initialTrace] - The initial trace for the execution.
26	*/
27	constructor(options?: { executionDate?: Date; executionId?: string; initialTrace?: EngineTrace }) {
28	super(options?.initialTrace);	10✔
29	this.executionDate = options?.executionDate ?? new Date();	10✔
30	this.executionId =	10✔
31	options?.executionId ??	11✔
32	[
33	'exec',
34	this.executionDate
35	.toISOString()
36	.replace(/[-:.Z]/g, '')
37	.replace('T', '_'),
38	crypto.randomUUID()
39	].join('_');
40
41	return this;	10✔
42	}
43
44	/**
45	* Get the current options of the Execution Engine.
46	*
47	* @returns {Object} An object containing the execution date and ID.
48	* @public
49	*/
50	getOptions(): { executionDate: Date; executionId: string } {
51	return { executionDate: this.executionDate, executionId: this.executionId };	8✔
52	}
53
54	setContext(value: CXT): ExecutionEngine<CXT> {
55	this.context = this.deepClone(value);	3✔
56	return this;	3✔
57	}
58
59	getContext(): CXT {
60	return this.context;	4✔
61	}
62
63	/**
64	* Update the context of the execution with partial information.
65	*
66	* @param {Partial<CXT>} partialContext - Partial context information to update.
67	* @returns {ExecutionEngine} - The updated ContextualExecution instance.
68	*/
69	updateContext(partialContext: Partial<CXT>): ExecutionEngine {
70	this.context = {	1✔
71	...this.context,
72	...partialContext
73	};
74	return this;	1✔
75	}
76
77	/**
78	* Update a specific attribute of the context object.
79	*
80	* @param {K} key - The key of the attribute to update.
81	* @param {CXT[K]} partialContextAttribute - Partial information to update for the attribute.
82	* @returns {ExecutionEngine} - The updated ContextualExecution instance.
83	*/
84	updateContextAttribute<K extends keyof CXT>(key: K, partialContextAttribute: CXT[K]): ExecutionEngine {
85	if (partialContextAttribute === null \|\| typeof partialContextAttribute !== 'object') {	1!
86	// If the provided attribute is not an object or is null,
87	// directly update the attribute in the context.
UNCOV 88	this.context[key] = partialContextAttribute;	×
89	} else {
90	// If the provided attribute is an object, merge it with the existing attribute.
91	this.context[key] = {	1✔
92	...(this.context?.[key] ?? {}),	1!
93	...partialContextAttribute
94	};
95	}
96	return this;	1✔
97	}
98
99	/**
100	* Deep clone function to copy nested objects.
101	*
102	* @private
103	* @template T - Type of the object to clone.
104	* @param {T} obj - The object to clone.
105	* @returns {T} - The cloned object.
106	*/
107	private deepClone<T>(obj: T): T {
108	if (obj === null \|\| typeof obj !== 'object') {	9✔
109	return obj;	3✔
110	}
111
112	if (Array.isArray(obj)) {	6!
UNCOV 113	return obj.map((item) => this.deepClone(item)) as T;	×
114	}
115
116	return Object.entries(obj).reduce((acc, [key, value]) => {	6✔
117	acc[key] = this.deepClone(value);	6✔
118	return acc;	6✔
119	}, {} as T);
120	}
121	}

tabkram / execution-engine / 14387781488

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous