configurapi 2.1.0 → 2.3.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.
@@ -10,10 +10,12 @@ export declare class Service extends EventEmitter implements IService {
10
10
  isReady: boolean;
11
11
  onStartPromise: Promise<boolean>;
12
12
  constructor(config: IConfig, loader?: IPolicyHandlerLoader);
13
+ private initDone;
14
+ init(): Promise<void>;
13
15
  configureLogs(svc: EventEmitter & {
14
16
  logLevel: LogLevel;
15
17
  }): void;
16
18
  process(event: IEvent): Promise<void>;
17
- _handleEvent(eventName: string, event?: IEvent): Promise<boolean>;
18
- _handleError(event: IEvent, error: object): Promise<void>;
19
+ handleEvent(eventName: string, event?: IEvent): Promise<boolean>;
20
+ handleError(event: IEvent, error: object): Promise<void>;
19
21
  }
@@ -33,7 +33,11 @@ class Service extends events_1.EventEmitter {
33
33
  this.configureLogs(route);
34
34
  this.emit(logLevel_1.LogLevel.Trace, `configurapi - - Registerd ${route.name} route.`);
35
35
  }
36
- this.onStartPromise = this._handleEvent('on_start');
36
+ }
37
+ async init() {
38
+ this.onStartPromise ?? (this.onStartPromise = this.handleEvent('on_start'));
39
+ await this.onStartPromise;
40
+ this.initDone = true;
37
41
  }
38
42
  configureLogs(svc) {
39
43
  for (const level of [logLevel_1.LogLevel.Trace, logLevel_1.LogLevel.Debug, logLevel_1.LogLevel.Error]) {
@@ -42,14 +46,16 @@ class Service extends events_1.EventEmitter {
42
46
  }
43
47
  }
44
48
  async process(event) {
49
+ if (!this.initDone) {
50
+ await this.init();
51
+ }
45
52
  if (!this.isReady) {
46
53
  try {
47
- await this.onStartPromise;
48
- await this._handleEvent('on_first_request', event);
54
+ await this.handleEvent('on_first_request', event);
49
55
  }
50
56
  catch (error) {
51
57
  try {
52
- await this._handleError(event, error);
58
+ await this.handleError(event, error);
53
59
  }
54
60
  finally {
55
61
  throw error;
@@ -59,11 +65,11 @@ class Service extends events_1.EventEmitter {
59
65
  }
60
66
  let startTime = perf_hooks_1.performance.now();
61
67
  try {
62
- await this._handleEvent('on_before_request', event);
63
- if (await this._handleEvent(event.name, event) || await this._handleEvent(event.method, event)) {
68
+ await this.handleEvent('on_before_request', event);
69
+ if (await this.handleEvent(event.name, event) || await this.handleEvent(event.method, event)) {
64
70
  //Great
65
71
  }
66
- else if (await this._handleEvent('catchall', event)) {
72
+ else if (await this.handleEvent('catchall', event)) {
67
73
  //Great
68
74
  }
69
75
  else {
@@ -72,17 +78,17 @@ class Service extends events_1.EventEmitter {
72
78
  if (event.response && event.response instanceof errorResponse_1.ErrorResponse) {
73
79
  throw event.response;
74
80
  }
75
- await this._handleEvent('on_success', event);
81
+ await this.handleEvent('on_success', event);
76
82
  }
77
83
  catch (error) {
78
- await this._handleError(event, error);
84
+ await this.handleError(event, error);
79
85
  }
80
86
  finally {
81
87
  try {
82
- await this._handleEvent('on_after_request', event);
88
+ await this.handleEvent('on_after_request', event);
83
89
  }
84
90
  catch (error) {
85
- await this._handleError(event, error);
91
+ await this.handleError(event, error);
86
92
  }
87
93
  let endTime = perf_hooks_1.performance.now();
88
94
  let route = this.config.events.get(event.name);
@@ -93,7 +99,7 @@ class Service extends events_1.EventEmitter {
93
99
  }
94
100
  }
95
101
  }
96
- async _handleEvent(eventName, event) {
102
+ async handleEvent(eventName, event) {
97
103
  let result = false;
98
104
  if (this.config.events.has(eventName)) {
99
105
  await this.config.events.get(eventName).process(event);
@@ -101,7 +107,7 @@ class Service extends events_1.EventEmitter {
101
107
  }
102
108
  return result;
103
109
  }
104
- async _handleError(event, error) {
110
+ async handleError(event, error) {
105
111
  if (error instanceof Error) {
106
112
  this.emit(logLevel_1.LogLevel.Error, `${event.id} - ${event.correlationId} - Failed to handle ${event.name}: ${error.message}`);
107
113
  event.response = new errorResponse_1.ErrorResponse(error, error['statusCode'] || 500);
@@ -117,7 +123,7 @@ class Service extends events_1.EventEmitter {
117
123
  if (this.config.events.has('on_error')) {
118
124
  try {
119
125
  this.emit(logLevel_1.LogLevel.Error, `${event.id} - ${event.correlationId} - Failed to handle ${event.name}: ${error}`);
120
- await this._handleEvent('on_error', event);
126
+ await this.handleEvent('on_error', event);
121
127
  }
122
128
  catch (reason) {
123
129
  this.emit(logLevel_1.LogLevel.Error, `${event.id} - ${event.correlationId} - ${reason}`);
@@ -1,6 +1,24 @@
1
1
  import { IEvent } from "./iEvent";
2
2
  import { IServiceListener } from "./iServiceListener";
3
3
  export interface IService {
4
+ /**
5
+ * Call to trigger on_start event after instantiating a new instance
6
+ */
7
+ init(): Promise<void>;
4
8
  on(type: string, listener: IServiceListener): void;
5
9
  process(event: IEvent): Promise<void>;
10
+ /**
11
+ * This method is called internally by process() to handle an event.
12
+ * This method should not be called directly.
13
+ * @param eventName The name of the event
14
+ * @param event The event object
15
+ */
16
+ handleEvent(eventName: string, event?: IEvent): Promise<boolean>;
17
+ /**
18
+ * This method is called internally by process() to handle an event.
19
+ * This method should not be called directly.
20
+ * @param event The event object
21
+ * @param error The error object
22
+ */
23
+ handleError(event: IEvent, error: object): Promise<void>;
6
24
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "configurapi",
3
- "version": "2.1.0",
3
+ "version": "2.3.0",
4
4
  "description": "A configurable API framework",
5
5
  "main": "dist/configurapi.js",
6
6
  "typings": "dist/configurapi.d.ts",