399855700

Build Type

push

github

Committed by Markus Felten

Commit Message

feat: template interceptor

Run Details

48 of 55 branches covered (87.27%)

Branch coverage included in aggregate %.

66 of 68 new or added lines in 3 files covered. (97.06%)

2 existing lines in 1 file now uncovered.

365 of 434 relevant lines covered (84.1%)

4.16 hits per line

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

95.61

/src/interceptor.mjs

import { setAttributes, getAttributes } from "model-attributes";

/**
 * Base interceptor. The base class for all the interceptors
 * Calls configure() and reset().
 * @param {Object} config The interceptor configuration object.
 */
export class Interceptor {
  /**
   * Meta description of the configuration
   * @return {Object}
   */
  static get configurationAttributes() {
    return {};
  }

  constructor(config) {
    this.configure(config);
    this.reset();
  }

  /**
   * The instance method returning the type.
   * Defaults to the constructors name (class name)
   * @return {string}
   */
  get type() {
    return this.constructor.name;
  }

  /**
   * Meta description of the configuration
   * @return {Object}
   */
  get configurationAttributes() {
    return this.constructor.configurationAttributes;
  }

  /**
   * Takes attribute values from config parameters
   * and copies them over to the object.
   * Copying is done according to configurationAttributes.
   * Which means we loop over all configuration attributes
   * and then for each attribute decide if we use the default, call
   * a setter function or simply assign the attribute value.
   * @param {Object} config
   */
  configure(config) {
    setAttributes(this, this.configurationAttributes, config);
  }

  toString() {
    return `${this.type}`;
  }

  toJSON() {
    return this.toJSONWithOptions({
      includeConfig: true
    });
  }

  /**
   * Deliver the json representation.
   * @return {Object} json representation
   */
  toJSONWithOptions(options) {
    if (!options.includeConfig) {
      return { type: this.type };
    }

    let atts = getAttributes(this, this.configurationAttributes);

    if (!options.includePrivate) {
      atts = Object.fromEntries(
        Object.entries(atts).filter(([k, v]) => !v.private)
      );
    }

    return {
      type: this.type,
      ...atts
    };
  }

  /**
   * Forget all accumulated information
   */
  reset() {}

  /**
   * The receive method. This method receives the request from the leading interceptor
   * and calls the trailing interceptor.
   * @param {Endpoint} endpoint
   * @param {Function} next
   * @param {any[]} args the request from the leading interceptor
   * @return {Promise}
   */
  async receive(endpoint, next, ...args) {
    // This is a dummy implementation. Must be overwritten by the derived object.
    return next(...args);
  }
}

1	import { setAttributes, getAttributes } from "model-attributes";	5✔
2		5✔
3	/**	5✔
4	* Base interceptor. The base class for all the interceptors	5✔
5	* Calls configure() and reset().	5✔
6	* @param {Object} config The interceptor configuration object.	5✔
7	*/	5✔
8	export class Interceptor {	5✔
9	/**	5✔
10	* Meta description of the configuration	5✔
11	* @return {Object}	5✔
12	*/	5✔
13	static get configurationAttributes() {	5✔
14	return {};	13✔
15	}	13✔
16		5✔
17	constructor(config) {	5✔
18	this.configure(config);	7✔
19	this.reset();	7✔
20	}	7✔
21		5✔
22	/**	5✔
23	* The instance method returning the type.	5✔
24	* Defaults to the constructors name (class name)	5✔
25	* @return {string}	5✔
26	*/	5✔
27	get type() {	5✔
28	return this.constructor.name;	9✔
29	}	9✔
30		5✔
31	/**	5✔
32	* Meta description of the configuration	5✔
33	* @return {Object}	5✔
34	*/	5✔
35	get configurationAttributes() {	5✔
36	return this.constructor.configurationAttributes;	13✔
37	}	13✔
38		5✔
39	/**	5✔
40	* Takes attribute values from config parameters	5✔
41	* and copies them over to the object.	5✔
42	* Copying is done according to configurationAttributes.	5✔
43	* Which means we loop over all configuration attributes	5✔
44	* and then for each attribute decide if we use the default, call	5✔
45	* a setter function or simply assign the attribute value.	5✔
46	* @param {Object} config	5✔
47	*/	5✔
48	configure(config) {	5✔
49	setAttributes(this, this.configurationAttributes, config);	7✔
50	}	7✔
51		5✔
52	toString() {	5✔
53	return `${this.type}`;	×
54	}	×
55		5✔
56	toJSON() {	5✔
57	return this.toJSONWithOptions({	6✔
58	includeConfig: true	6✔
59	});	6✔
60	}	6✔
61		5✔
62	/**	5✔
63	* Deliver the json representation.	5✔
64	* @return {Object} json representation	5✔
65	*/	5✔
66	toJSONWithOptions(options) {	5✔
67	if (!options.includeConfig) {	6!
UNCOV 68	return { type: this.type };	×
UNCOV 69	}	×
70		6✔
71	let atts = getAttributes(this, this.configurationAttributes);	6✔
72		6✔
73	if (!options.includePrivate) {	6✔
74	atts = Object.fromEntries(	6✔
75	Object.entries(atts).filter(([k, v]) => !v.private)	6✔
76	);	6✔
77	}	6✔
78		6✔
79	return {	6✔
80	type: this.type,	6✔
81	...atts	6✔
82	};	6✔
83	}	6✔
84		5✔
85	/**	5✔
86	* Forget all accumulated information	5✔
87	*/	5✔
88	reset() {}	5✔
89		5✔
90	/**	5✔
91	* The receive method. This method receives the request from the leading interceptor	5✔
92	* and calls the trailing interceptor.	5✔
93	* @param {Endpoint} endpoint	5✔
94	* @param {Function} next	5✔
95	* @param {any[]} args the request from the leading interceptor	5✔
96	* @return {Promise}	5✔
97	*/	5✔
98	async receive(endpoint, next, ...args) {	5✔
99	// This is a dummy implementation. Must be overwritten by the derived object.	1✔
100	return next(...args);	1✔
101	}	1✔
102	}	5✔

Kronos-Integration / interceptor / 399855700

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