@3sixty/api-server-fastify 0.0.0-stage → 0.20.0-next.1
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/LICENSE +201 -0
- package/README.md +24 -2
- package/dist/es/fastifySocketIo.js +16 -0
- package/dist/es/fastifySocketIo.js.map +1 -0
- package/dist/es/fastifyWebServer.js +364 -0
- package/dist/es/fastifyWebServer.js.map +1 -0
- package/dist/es/index.js +6 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/IFastifyWebServerConfig.js +2 -0
- package/dist/es/models/IFastifyWebServerConfig.js.map +1 -0
- package/dist/es/models/IFastifyWebServerConstructorOptions.js +2 -0
- package/dist/es/models/IFastifyWebServerConstructorOptions.js.map +1 -0
- package/dist/types/fastifySocketIo.d.ts +8 -0
- package/dist/types/fastifyWebServer.d.ts +74 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/models/IFastifyWebServerConfig.d.ts +22 -0
- package/dist/types/models/IFastifyWebServerConstructorOptions.d.ts +19 -0
- package/docs/changelog.md +21 -0
- package/docs/examples.md +37 -0
- package/docs/reference/classes/FastifyWebServer.md +834 -0
- package/docs/reference/index.md +10 -0
- package/docs/reference/interfaces/IFastifyWebServerConfig.md +33 -0
- package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md +27 -0
- package/locales/.validate-ignore +3 -0
- package/locales/en.json +14 -0
- package/package.json +56 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2024 IOTA Stiftung.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 3Sixty API Server Fastify
|
|
2
2
|
|
|
3
|
-
This
|
|
3
|
+
This package provides Fastify web server integration for exposing API routes with consistent runtime behaviour. It builds on the Fastify framework to offer a predictable hosting layer for API services.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```shell
|
|
8
|
+
npm install @3sixty/api-server-fastify
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Examples
|
|
12
|
+
|
|
13
|
+
Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
|
|
14
|
+
|
|
15
|
+
## Reference
|
|
16
|
+
|
|
17
|
+
Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
|
|
18
|
+
|
|
19
|
+
## Changelog
|
|
20
|
+
|
|
21
|
+
The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
|
|
22
|
+
|
|
23
|
+
## Origin
|
|
24
|
+
|
|
25
|
+
This package is derived from the original [iotaledger/twin-api](https://github.com/iotaledger/twin-api/tree/next/packages/api-server-fastify) repository.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import fp from "fastify-plugin";
|
|
2
|
+
import { Server } from "socket.io";
|
|
3
|
+
/**
|
|
4
|
+
* Fastify plugin that attaches a Socket.IO server to the Fastify HTTP server.
|
|
5
|
+
* Cloned from fastify-socket.io to support recent Fastify versions.
|
|
6
|
+
*/
|
|
7
|
+
const fastifySocketIO = fp(async (fastify, opts) => {
|
|
8
|
+
const ioServer = new Server(fastify.server, opts);
|
|
9
|
+
fastify.decorate("io", ioServer);
|
|
10
|
+
fastify.addHook("preClose", async () => {
|
|
11
|
+
ioServer.disconnectSockets();
|
|
12
|
+
await ioServer.close();
|
|
13
|
+
});
|
|
14
|
+
}, { fastify: ">=5.x.x", name: "socket.io" });
|
|
15
|
+
export default fastifySocketIO;
|
|
16
|
+
//# sourceMappingURL=fastifySocketIo.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fastifySocketIo.js","sources":["../../src/fastifySocketIo.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,MAAM,EAAsB,MAAM,WAAW,CAAC;AAEvD;;;GAGG;AACH,MAAM,eAAe,GAA+C,EAAE,CACrE,KAAK,EAAE,OAAwB,EAAE,IAA4B,EAAE,EAAE;IAChE,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAElD,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACjC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;QACtC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAE7B,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;AACJ,CAAC,EACD,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,CACzC,CAAC;AAEF,eAAe,eAAe,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { FastifyInstance, FastifyPluginAsync } from \"fastify\";\nimport fp from \"fastify-plugin\";\nimport { Server, type ServerOptions } from \"socket.io\";\n\n/**\n * Fastify plugin that attaches a Socket.IO server to the Fastify HTTP server.\n * Cloned from fastify-socket.io to support recent Fastify versions.\n */\nconst fastifySocketIO: FastifyPluginAsync<Partial<ServerOptions>> = fp(\n\tasync (fastify: FastifyInstance, opts: Partial<ServerOptions>) => {\n\t\tconst ioServer = new Server(fastify.server, opts);\n\n\t\tfastify.decorate(\"io\", ioServer);\n\t\tfastify.addHook(\"preClose\", async () => {\n\t\t\tioServer.disconnectSockets();\n\n\t\t\tawait ioServer.close();\n\t\t});\n\t},\n\t{ fastify: \">=5.x.x\", name: \"socket.io\" }\n);\n\nexport default fastifySocketIO;\n"]}
|
|
@@ -0,0 +1,364 @@
|
|
|
1
|
+
// Copyright 2024 IOTA Stiftung.
|
|
2
|
+
// Copyright 2026 3Sixty Trade Ltd.
|
|
3
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
4
|
+
import { BaseServer } from "@3sixty/api-core-server";
|
|
5
|
+
import { HttpBodyLimit, HttpErrorHelper } from "@3sixty/api-models";
|
|
6
|
+
import { BaseError, GeneralError, Is, StringHelper } from "@3sixty/core";
|
|
7
|
+
import { HttpMethod, HttpStatusCode } from "@3sixty/web";
|
|
8
|
+
import FastifyCompress from "@fastify/compress";
|
|
9
|
+
import FastifyCors from "@fastify/cors";
|
|
10
|
+
import Fastify from "fastify";
|
|
11
|
+
import FastifySocketIO from "./fastifySocketIo.js";
|
|
12
|
+
/**
|
|
13
|
+
* Implementation of the web server using Fastify.
|
|
14
|
+
*/
|
|
15
|
+
export class FastifyWebServer extends BaseServer {
|
|
16
|
+
/**
|
|
17
|
+
* Runtime name for the class.
|
|
18
|
+
*/
|
|
19
|
+
static CLASS_NAME = "FastifyWebServer";
|
|
20
|
+
/**
|
|
21
|
+
* The Fastify instance.
|
|
22
|
+
* @internal
|
|
23
|
+
*/
|
|
24
|
+
_fastify;
|
|
25
|
+
/**
|
|
26
|
+
* The options for the socket server.
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
_socketConfig;
|
|
30
|
+
/**
|
|
31
|
+
* Create a new instance of FastifyWebServer.
|
|
32
|
+
* @param options The options for the server.
|
|
33
|
+
*/
|
|
34
|
+
constructor(options) {
|
|
35
|
+
super({
|
|
36
|
+
loggingComponentType: options?.loggingComponentType,
|
|
37
|
+
mimeTypeProcessors: options?.mimeTypeProcessors,
|
|
38
|
+
includeErrorStack: options?.config?.includeErrorStack
|
|
39
|
+
});
|
|
40
|
+
this._fastify = Fastify({
|
|
41
|
+
routerOptions: {
|
|
42
|
+
maxParamLength: 2000
|
|
43
|
+
},
|
|
44
|
+
...options?.config?.web
|
|
45
|
+
// Need this cast for now as maxParamLength has moved in to routerOptions
|
|
46
|
+
// but the TS defs has not been updated yet
|
|
47
|
+
});
|
|
48
|
+
this._socketConfig = {
|
|
49
|
+
path: "/socket",
|
|
50
|
+
...options?.config?.socket
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Returns the class name of the component.
|
|
55
|
+
* @returns The class name of the component.
|
|
56
|
+
*/
|
|
57
|
+
className() {
|
|
58
|
+
return FastifyWebServer.CLASS_NAME;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Get the web server instance.
|
|
62
|
+
* @returns The web server instance.
|
|
63
|
+
*/
|
|
64
|
+
getInstance() {
|
|
65
|
+
return this._fastify;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Build the server.
|
|
69
|
+
* @param restRouteProcessors The processors for incoming requests over REST.
|
|
70
|
+
* @param restRoutes The REST routes.
|
|
71
|
+
* @param socketRouteProcessors The processors for incoming requests over Sockets.
|
|
72
|
+
* @param socketRoutes The socket routes.
|
|
73
|
+
* @param options Options for building the server.
|
|
74
|
+
* @returns A promise that resolves when the server is fully built and ready to start.
|
|
75
|
+
*/
|
|
76
|
+
async build(restRouteProcessors, restRoutes, socketRouteProcessors, socketRoutes, options) {
|
|
77
|
+
await this.prepareBuild(restRouteProcessors, restRoutes, socketRouteProcessors, socketRoutes, options);
|
|
78
|
+
await this._fastify.register(FastifyCompress);
|
|
79
|
+
if (Is.arrayValue(socketRoutes)) {
|
|
80
|
+
await this._fastify.register(FastifySocketIO, this._socketConfig);
|
|
81
|
+
}
|
|
82
|
+
if (Is.arrayValue(this._mimeTypeProcessors)) {
|
|
83
|
+
for (const contentTypeHandler of this._mimeTypeProcessors) {
|
|
84
|
+
this._fastify.addContentTypeParser(contentTypeHandler.getTypes(), { parseAs: "buffer" }, (request, body, done) => {
|
|
85
|
+
// Fastify does not handle this method correctly if it is async
|
|
86
|
+
// so we have to use the callback method
|
|
87
|
+
contentTypeHandler
|
|
88
|
+
.handle(body)
|
|
89
|
+
// eslint-disable-next-line promise/prefer-await-to-then, promise/no-callback-in-promise
|
|
90
|
+
.then(processed => done(null, processed))
|
|
91
|
+
// eslint-disable-next-line promise/prefer-await-to-then, promise/no-callback-in-promise
|
|
92
|
+
.catch(err => done(BaseError.fromError(err)));
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
await this.initCors(options);
|
|
97
|
+
this._fastify.setNotFoundHandler({}, async (request, reply) => this.handleRequestRest(request, reply));
|
|
98
|
+
this._fastify.setErrorHandler(async (error, request, reply) => {
|
|
99
|
+
// If code property is set this is a fastify error
|
|
100
|
+
// otherwise it's from our framework
|
|
101
|
+
let httpStatusCode;
|
|
102
|
+
let err;
|
|
103
|
+
if (Is.number(error.code) || Is.string(error.code)) {
|
|
104
|
+
err = {
|
|
105
|
+
source: FastifyWebServer.CLASS_NAME,
|
|
106
|
+
name: error.name,
|
|
107
|
+
message: `${error.code}: ${error.message}`
|
|
108
|
+
};
|
|
109
|
+
httpStatusCode = error.statusCode ?? HttpStatusCode.badRequest;
|
|
110
|
+
}
|
|
111
|
+
else {
|
|
112
|
+
const errorAndCode = HttpErrorHelper.processError(error);
|
|
113
|
+
err = errorAndCode.error;
|
|
114
|
+
httpStatusCode = errorAndCode.httpStatusCode;
|
|
115
|
+
}
|
|
116
|
+
await this._logging?.log({
|
|
117
|
+
level: "error",
|
|
118
|
+
ts: Date.now(),
|
|
119
|
+
source: FastifyWebServer.CLASS_NAME,
|
|
120
|
+
message: "badRequest",
|
|
121
|
+
error: err
|
|
122
|
+
});
|
|
123
|
+
return reply.status(httpStatusCode).send({
|
|
124
|
+
error: err
|
|
125
|
+
});
|
|
126
|
+
});
|
|
127
|
+
await this.addRoutesRest(restRouteProcessors, restRoutes);
|
|
128
|
+
await this.addRoutesSocket(socketRouteProcessors, socketRoutes);
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Start listening for connections on the transport.
|
|
132
|
+
* @param host The host to bind to.
|
|
133
|
+
* @param port The port to bind to.
|
|
134
|
+
* @returns A promise that resolves when the transport is listening.
|
|
135
|
+
*/
|
|
136
|
+
async serverListen(host, port) {
|
|
137
|
+
await this._fastify.listen({ port, host });
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Close the transport and all of its connections.
|
|
141
|
+
* @returns A promise that resolves when the transport has closed.
|
|
142
|
+
*/
|
|
143
|
+
async serverClose() {
|
|
144
|
+
await this._fastify.close();
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Get the addresses the transport is bound to.
|
|
148
|
+
* @returns The bound addresses.
|
|
149
|
+
*/
|
|
150
|
+
serverAddresses() {
|
|
151
|
+
return this._fastify.addresses();
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Whether the transport is serving over TLS.
|
|
155
|
+
* @returns True if the transport is secure.
|
|
156
|
+
*/
|
|
157
|
+
serverIsSecure() {
|
|
158
|
+
// Fastify reports the https option as true rather than the options object
|
|
159
|
+
const https = this._fastify.initialConfig.https;
|
|
160
|
+
return https === true || Is.object(https);
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Whether the transport is currently listening for connections.
|
|
164
|
+
* @returns True if the transport is listening.
|
|
165
|
+
*/
|
|
166
|
+
serverIsListening() {
|
|
167
|
+
return this._fastify?.server?.listening ?? false;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Whether a GET route is registered for the root path.
|
|
171
|
+
* @returns True if the root route is registered.
|
|
172
|
+
*/
|
|
173
|
+
serverHasRootRoute() {
|
|
174
|
+
return this._fastify.hasRoute({ method: "GET", url: "/" });
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Add the REST routes to the server.
|
|
178
|
+
* @param restRouteProcessors The processors for the incoming requests.
|
|
179
|
+
* @param restRoutes The REST routes to add.
|
|
180
|
+
* @internal
|
|
181
|
+
*/
|
|
182
|
+
async addRoutesRest(restRouteProcessors, restRoutes) {
|
|
183
|
+
if (Is.arrayValue(restRouteProcessors) && Is.arrayValue(restRoutes)) {
|
|
184
|
+
const bodyLimits = this.resolveBodyLimits();
|
|
185
|
+
for (const restRoute of restRoutes) {
|
|
186
|
+
let path = StringHelper.trimTrailingSlashes(restRoute.path);
|
|
187
|
+
if (!path.startsWith("/")) {
|
|
188
|
+
path = `/${path}`;
|
|
189
|
+
}
|
|
190
|
+
await this._logging?.log({
|
|
191
|
+
level: "info",
|
|
192
|
+
ts: Date.now(),
|
|
193
|
+
source: FastifyWebServer.CLASS_NAME,
|
|
194
|
+
message: "restRouteAdded",
|
|
195
|
+
data: { route: path, method: restRoute.method }
|
|
196
|
+
});
|
|
197
|
+
const method = restRoute.method.toLowerCase();
|
|
198
|
+
const bodyLimitKey = Is.stringValue(restRoute.bodyLimit)
|
|
199
|
+
? restRoute.bodyLimit
|
|
200
|
+
: HttpBodyLimit.Default;
|
|
201
|
+
const bodyLimit = bodyLimits[bodyLimitKey];
|
|
202
|
+
if (Is.empty(bodyLimit)) {
|
|
203
|
+
throw new GeneralError(FastifyWebServer.CLASS_NAME, "unknownBodyLimit", {
|
|
204
|
+
route: path,
|
|
205
|
+
bodyLimit: bodyLimitKey
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
this._fastify[method](path, { bodyLimit }, async (request, reply) => this.handleRequestRest(request, reply, restRoute));
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Add the socket routes to the server.
|
|
214
|
+
* @param socketRouteProcessors The processors for the incoming requests.
|
|
215
|
+
* @param socketRoutes The socket routes to add.
|
|
216
|
+
* @internal
|
|
217
|
+
*/
|
|
218
|
+
async addRoutesSocket(socketRouteProcessors, socketRoutes) {
|
|
219
|
+
if (Is.arrayValue(socketRouteProcessors) && Is.arrayValue(socketRoutes)) {
|
|
220
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
221
|
+
const io = this._fastify.io;
|
|
222
|
+
for (const socketRoute of socketRoutes) {
|
|
223
|
+
const path = StringHelper.trimLeadingSlashes(StringHelper.trimTrailingSlashes(socketRoute.path));
|
|
224
|
+
const pathParts = path.split("/");
|
|
225
|
+
const namespace = `/${pathParts[0]}`;
|
|
226
|
+
const topic = pathParts.slice(1).join("/");
|
|
227
|
+
await this._logging?.log({
|
|
228
|
+
level: "info",
|
|
229
|
+
ts: Date.now(),
|
|
230
|
+
source: FastifyWebServer.CLASS_NAME,
|
|
231
|
+
message: "socketRouteAdded",
|
|
232
|
+
data: {
|
|
233
|
+
handshakePath: this._socketConfig.path,
|
|
234
|
+
namespace,
|
|
235
|
+
eventName: topic
|
|
236
|
+
}
|
|
237
|
+
});
|
|
238
|
+
const socketNamespace = io.of(namespace);
|
|
239
|
+
socketNamespace.on("connection", async (socket) => {
|
|
240
|
+
const socketServerRequest = {
|
|
241
|
+
method: HttpMethod.GET,
|
|
242
|
+
url: socket.handshake.url,
|
|
243
|
+
query: socket.handshake.query,
|
|
244
|
+
headers: socket.handshake.headers,
|
|
245
|
+
socketId: socket.id
|
|
246
|
+
};
|
|
247
|
+
// Pass the connected information on to any processors
|
|
248
|
+
try {
|
|
249
|
+
for (const connected of this._socketChains.connected) {
|
|
250
|
+
await connected(socketServerRequest, socketRoute, this._loggingComponentType);
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
catch (err) {
|
|
254
|
+
const { error, httpStatusCode } = HttpErrorHelper.processError(err, this._includeErrorStack);
|
|
255
|
+
const response = {};
|
|
256
|
+
HttpErrorHelper.buildResponse(response, error, httpStatusCode, this._includeErrorStack);
|
|
257
|
+
socket.emit(topic, response);
|
|
258
|
+
}
|
|
259
|
+
socket.on("disconnect", async () => {
|
|
260
|
+
try {
|
|
261
|
+
// The socket disconnected so notify any processors
|
|
262
|
+
for (const disconnected of this._socketChains.disconnected) {
|
|
263
|
+
await disconnected(socketServerRequest, socketRoute, this._loggingComponentType);
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
catch {
|
|
267
|
+
// If something fails on a disconnect there is not much we can do with it
|
|
268
|
+
}
|
|
269
|
+
});
|
|
270
|
+
// Handle any incoming messages
|
|
271
|
+
socket.on(topic, async (data) => {
|
|
272
|
+
// The listener is async, so anything escaping it would surface as an unhandled
|
|
273
|
+
// rejection and terminate the process, emit it on the topic instead
|
|
274
|
+
try {
|
|
275
|
+
await this.handleRequestSocket(socketRoute, socket, `/${pathParts.join("/")}`, topic, data);
|
|
276
|
+
}
|
|
277
|
+
catch (err) {
|
|
278
|
+
const { error, httpStatusCode } = HttpErrorHelper.processError(err, this._includeErrorStack);
|
|
279
|
+
const response = {};
|
|
280
|
+
HttpErrorHelper.buildResponse(response, error, httpStatusCode, this._includeErrorStack);
|
|
281
|
+
socket.emit(topic, response);
|
|
282
|
+
}
|
|
283
|
+
});
|
|
284
|
+
});
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* Handle the incoming REST request.
|
|
290
|
+
* @param request The incoming request.
|
|
291
|
+
* @param reply The outgoing response.
|
|
292
|
+
* @param restRoute The REST route to handle.
|
|
293
|
+
* @returns The Fastify reply with the response.
|
|
294
|
+
* @internal
|
|
295
|
+
*/
|
|
296
|
+
async handleRequestRest(request, reply, restRoute) {
|
|
297
|
+
const port = (request.port === 80 && request.protocol === "http") ||
|
|
298
|
+
(request.port === 443 && request.protocol === "https") ||
|
|
299
|
+
!Is.integer(request.port)
|
|
300
|
+
? ""
|
|
301
|
+
: `:${request.port}`;
|
|
302
|
+
const requestOrigin = `${request.protocol}://${request.hostname}${port}`;
|
|
303
|
+
const httpServerRequest = this.buildServerRequest(request.method.toUpperCase(), `${requestOrigin}${request.url}`, request.body, request.query,
|
|
304
|
+
// The not found handler matches a wildcard, which is not a param of any route
|
|
305
|
+
Is.empty(restRoute) ? {} : request.params, request.headers);
|
|
306
|
+
const httpResponse = {};
|
|
307
|
+
const contextIds = this.buildContextIds(requestOrigin, httpServerRequest.headers);
|
|
308
|
+
const processorState = {};
|
|
309
|
+
await this.runProcessorsRest(restRoute, httpServerRequest, httpResponse, contextIds, processorState);
|
|
310
|
+
this.validateResponse(httpResponse);
|
|
311
|
+
if (!Is.empty(httpResponse.headers)) {
|
|
312
|
+
for (const header of Object.keys(httpResponse.headers)) {
|
|
313
|
+
reply.header(header, httpResponse.headers[header]);
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
return reply.status(httpResponse.statusCode ?? HttpStatusCode.ok).send(httpResponse.body);
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* Handle the incoming socket request.
|
|
320
|
+
* @param socketRoute The socket route to handle.
|
|
321
|
+
* @param socket The socket to handle.
|
|
322
|
+
* @param fullPath The full path of the socket route.
|
|
323
|
+
* @param emitTopic The topic to emit the response on.
|
|
324
|
+
* @param request The incoming request.
|
|
325
|
+
* @internal
|
|
326
|
+
*/
|
|
327
|
+
async handleRequestSocket(socketRoute, socket, fullPath, emitTopic, request) {
|
|
328
|
+
const socketServerRequest = {
|
|
329
|
+
method: HttpMethod.GET,
|
|
330
|
+
url: fullPath,
|
|
331
|
+
query: socket.handshake.query,
|
|
332
|
+
headers: socket.handshake.headers,
|
|
333
|
+
// The payload arrives straight off the wire, so it can be missing or any shape
|
|
334
|
+
body: Is.object(request) ? request.body : undefined,
|
|
335
|
+
socketId: socket.id
|
|
336
|
+
};
|
|
337
|
+
const httpResponse = {};
|
|
338
|
+
const contextIds = {};
|
|
339
|
+
const processorState = {};
|
|
340
|
+
delete socketServerRequest.query?.EIO;
|
|
341
|
+
delete socketServerRequest.query?.transport;
|
|
342
|
+
await this.runProcessorsSocket(socketRoute, socketServerRequest, httpResponse, contextIds, processorState, emitTopic, async (topic, response) => {
|
|
343
|
+
socket.emit(topic, response);
|
|
344
|
+
});
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* Initialize the cors options.
|
|
348
|
+
* @param options The web server options.
|
|
349
|
+
* @internal
|
|
350
|
+
*/
|
|
351
|
+
async initCors(options) {
|
|
352
|
+
const corsOptions = this.resolveCorsOptions(options);
|
|
353
|
+
await this._fastify.register(FastifyCors, {
|
|
354
|
+
origin: (origin, callback) => {
|
|
355
|
+
callback(null, corsOptions.hasWildcardOrigin ? true : corsOptions.origins.includes(origin));
|
|
356
|
+
},
|
|
357
|
+
methods: corsOptions.methods,
|
|
358
|
+
allowedHeaders: corsOptions.allowedHeaders,
|
|
359
|
+
exposedHeaders: corsOptions.exposedHeaders,
|
|
360
|
+
credentials: true
|
|
361
|
+
});
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
//# sourceMappingURL=fastifyWebServer.js.map
|