@orpc/pino 2.0.0-beta.30 → 2.0.0-beta.32
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/README.md +29 -28
- package/dist/index.d.mts +11 -1
- package/dist/index.d.ts +11 -1
- package/dist/index.mjs +14 -9
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
5
5
|
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
6
6
|
</a>
|
|
7
|
-
<a href="https://
|
|
7
|
+
<a href="https://www.npmjs.com/package/@orpc/pino">
|
|
8
8
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fpino?logo=npm" />
|
|
9
9
|
</a>
|
|
10
10
|
<a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
|
|
@@ -29,44 +29,44 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
29
29
|
|
|
30
30
|
**Core**
|
|
31
31
|
|
|
32
|
-
- [@orpc/contract](https://
|
|
33
|
-
- [@orpc/server](https://
|
|
34
|
-
- [@orpc/client](https://
|
|
35
|
-
- [@orpc/openapi](https://
|
|
32
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
|
|
33
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
34
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
35
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
36
36
|
|
|
37
37
|
**Schema validation**
|
|
38
38
|
|
|
39
|
-
- [@orpc/zod](https://
|
|
40
|
-
- [@orpc/valibot](https://
|
|
41
|
-
- [@orpc/arktype](https://
|
|
39
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
40
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
41
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
42
42
|
|
|
43
43
|
**Built-in features**
|
|
44
44
|
|
|
45
|
-
- [@orpc/publisher](https://
|
|
46
|
-
- [@orpc/ratelimit](https://
|
|
47
|
-
- [@orpc/hibernation](https://
|
|
48
|
-
- [@orpc/json-schema](https://
|
|
45
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
46
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
47
|
+
- [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation): Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api).
|
|
48
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
49
49
|
|
|
50
50
|
**Framework & ecosystem integrations**
|
|
51
51
|
|
|
52
|
-
- [@orpc/next](https://
|
|
53
|
-
- [@orpc/ai-sdk](https://
|
|
54
|
-
- [@orpc/tanstack-query](https://
|
|
55
|
-
- [@orpc/pinia-colada](https://
|
|
56
|
-
- [@orpc/swr](https://
|
|
57
|
-
- [@orpc/experimental-msw](https://
|
|
58
|
-
- [@orpc/experimental-effect](https://
|
|
59
|
-
- [@orpc/nest](https://
|
|
60
|
-
- [@orpc/node](https://
|
|
61
|
-
- [@orpc/bun](https://
|
|
62
|
-
- [@orpc/cloudflare](https://
|
|
63
|
-
- [@orpc/trpc](https://
|
|
52
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
53
|
+
- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
54
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
55
|
+
- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
56
|
+
- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
|
|
57
|
+
- [@orpc/experimental-msw](https://www.npmjs.com/package/@orpc/experimental-msw): Mock procedures with [Mock Service Worker](https://mswjs.io/).
|
|
58
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
59
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
60
|
+
- [@orpc/node](https://www.npmjs.com/package/@orpc/node): [Node.js](https://nodejs.org/) plugins for static file serving and large uploads.
|
|
61
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
62
|
+
- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
|
|
63
|
+
- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
64
64
|
|
|
65
65
|
**Observability**
|
|
66
66
|
|
|
67
|
-
- [@orpc/opentelemetry](https://
|
|
68
|
-
- [@orpc/pino](https://
|
|
69
|
-
- [@orpc/evlog](https://
|
|
67
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
68
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
69
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
70
70
|
|
|
71
71
|
## Sponsors
|
|
72
72
|
|
|
@@ -113,6 +113,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
113
113
|
<td align="center"><a href="https://github.com/itigoore01?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="139" alt="shota"/><br />shota</a></td>
|
|
114
114
|
<td align="center"><a href="https://github.com/ellis-driscoll?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
|
|
115
115
|
<td align="center"><a href="https://github.com/hoangbn?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Hoang Nguyen"><img src="https://avatars.githubusercontent.com/u/38968280?u=c90084c6de65c56facabab7ba13a72a49ddbc3e4&v=4" width="139" alt="Hoang Nguyen"/><br />Hoang Nguyen</a></td>
|
|
116
|
+
<td align="center"><a href="https://opencollective.com/guest-ac41de3b?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Orestis Ioannou"><img src="https://images.opencollective.com/guest-ac41de3b/avatar/460.png" width="139" alt="Orestis Ioannou"/><br />Orestis Ioannou</a></td>
|
|
116
117
|
</tr>
|
|
117
118
|
</table>
|
|
118
119
|
|
|
@@ -135,7 +136,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
135
136
|
<td align="center"><a href="https://rigtch.fm/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
136
137
|
<td align="center"><a href="https://blog.cwang.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
137
138
|
<td align="center"><a href="https://dubinets.io/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
138
|
-
<td align="center"><a href="https://
|
|
139
|
+
<td align="center"><a href="https://kellychan.im/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
139
140
|
</tr>
|
|
140
141
|
<tr>
|
|
141
142
|
<td align="center"><a href="https://guyariely.com/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
|
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Logger } from 'pino';
|
|
1
|
+
import pino, { Logger } from 'pino';
|
|
2
2
|
import { Context } from '@orpc/server';
|
|
3
3
|
import { StandardHandlerPlugin, StandardHandlerRoutingInterceptorOptions, StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
4
|
|
|
@@ -50,6 +50,15 @@ interface PinoHandlerPluginOptions<T extends Context> {
|
|
|
50
50
|
* @default false
|
|
51
51
|
*/
|
|
52
52
|
logAbort?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Customizes the log level for errors thrown from procedures;
|
|
55
|
+
* internal handler failures are always logged at error level.
|
|
56
|
+
* Receives the level applied by default; return it to keep the default behavior:
|
|
57
|
+
* 'info' for abort errors, 'warn' for ORPCError except INTERNAL_SERVER_ERROR, 'error' otherwise.
|
|
58
|
+
*
|
|
59
|
+
* @default (error, level) => level
|
|
60
|
+
*/
|
|
61
|
+
procedureErrorLevel?: (error: unknown, level: pino.Level) => pino.Level;
|
|
53
62
|
}
|
|
54
63
|
/**
|
|
55
64
|
* Instruments an oRPC handler with Pino structured logging, request tracking,
|
|
@@ -70,6 +79,7 @@ declare class PinoHandlerPlugin<T extends Context> implements StandardHandlerPlu
|
|
|
70
79
|
private readonly generateRequestId;
|
|
71
80
|
private readonly logLifecycle;
|
|
72
81
|
private readonly logAbort;
|
|
82
|
+
private readonly procedureErrorLevel;
|
|
73
83
|
constructor(options?: PinoHandlerPluginOptions<T>);
|
|
74
84
|
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
75
85
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Logger } from 'pino';
|
|
1
|
+
import pino, { Logger } from 'pino';
|
|
2
2
|
import { Context } from '@orpc/server';
|
|
3
3
|
import { StandardHandlerPlugin, StandardHandlerRoutingInterceptorOptions, StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
4
|
|
|
@@ -50,6 +50,15 @@ interface PinoHandlerPluginOptions<T extends Context> {
|
|
|
50
50
|
* @default false
|
|
51
51
|
*/
|
|
52
52
|
logAbort?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Customizes the log level for errors thrown from procedures;
|
|
55
|
+
* internal handler failures are always logged at error level.
|
|
56
|
+
* Receives the level applied by default; return it to keep the default behavior:
|
|
57
|
+
* 'info' for abort errors, 'warn' for ORPCError except INTERNAL_SERVER_ERROR, 'error' otherwise.
|
|
58
|
+
*
|
|
59
|
+
* @default (error, level) => level
|
|
60
|
+
*/
|
|
61
|
+
procedureErrorLevel?: (error: unknown, level: pino.Level) => pino.Level;
|
|
53
62
|
}
|
|
54
63
|
/**
|
|
55
64
|
* Instruments an oRPC handler with Pino structured logging, request tracking,
|
|
@@ -70,6 +79,7 @@ declare class PinoHandlerPlugin<T extends Context> implements StandardHandlerPlu
|
|
|
70
79
|
private readonly generateRequestId;
|
|
71
80
|
private readonly logLifecycle;
|
|
72
81
|
private readonly logAbort;
|
|
82
|
+
private readonly procedureErrorLevel;
|
|
73
83
|
constructor(options?: PinoHandlerPluginOptions<T>);
|
|
74
84
|
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
75
85
|
}
|
package/dist/index.mjs
CHANGED
|
@@ -21,11 +21,13 @@ class PinoHandlerPlugin {
|
|
|
21
21
|
generateRequestId;
|
|
22
22
|
logLifecycle;
|
|
23
23
|
logAbort;
|
|
24
|
+
procedureErrorLevel;
|
|
24
25
|
constructor(options = {}) {
|
|
25
26
|
this.logger = options.logger ?? pino();
|
|
26
27
|
this.generateRequestId = options.generateRequestId ?? (({ request }) => flattenStandardHeader(request.headers["x-request-id"]) ?? crypto.randomUUID());
|
|
27
28
|
this.logLifecycle = options.logLifecycle ?? false;
|
|
28
29
|
this.logAbort = options.logAbort ?? false;
|
|
30
|
+
this.procedureErrorLevel = options.procedureErrorLevel ?? ((_, level) => level);
|
|
29
31
|
}
|
|
30
32
|
init(options) {
|
|
31
33
|
const routingInterceptor = async ({ next, ...interceptorOptions }) => {
|
|
@@ -92,7 +94,7 @@ class PinoHandlerPlugin {
|
|
|
92
94
|
try {
|
|
93
95
|
return await next();
|
|
94
96
|
} catch (error) {
|
|
95
|
-
|
|
97
|
+
logProcedureError(logger, error, this.procedureErrorLevel);
|
|
96
98
|
throw error;
|
|
97
99
|
}
|
|
98
100
|
};
|
|
@@ -101,14 +103,14 @@ class PinoHandlerPlugin {
|
|
|
101
103
|
if (isAsyncIteratorObject(output)) {
|
|
102
104
|
return override(output, wrapAsyncIteratorPreservingEventMeta(output, {
|
|
103
105
|
onError: (error) => {
|
|
104
|
-
|
|
106
|
+
logProcedureError(getLogger(context), error, this.procedureErrorLevel);
|
|
105
107
|
}
|
|
106
108
|
}));
|
|
107
109
|
}
|
|
108
110
|
if (output instanceof ReadableStream) {
|
|
109
111
|
return override(output, wrapReadableStream(output, {
|
|
110
112
|
onError: (error) => {
|
|
111
|
-
|
|
113
|
+
logProcedureError(getLogger(context), error, this.procedureErrorLevel);
|
|
112
114
|
}
|
|
113
115
|
}));
|
|
114
116
|
}
|
|
@@ -131,14 +133,17 @@ class PinoHandlerPlugin {
|
|
|
131
133
|
};
|
|
132
134
|
}
|
|
133
135
|
}
|
|
134
|
-
function
|
|
136
|
+
function logProcedureError(logger, error, procedureErrorLevel) {
|
|
137
|
+
logger?.[procedureErrorLevel(error, defaultProcedureErrorLevel(error))](error);
|
|
138
|
+
}
|
|
139
|
+
function defaultProcedureErrorLevel(error) {
|
|
135
140
|
if (isAbortError(error)) {
|
|
136
|
-
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
logger?.error(error);
|
|
141
|
+
return "info";
|
|
142
|
+
}
|
|
143
|
+
if (error instanceof ORPCError && error.code !== "INTERNAL_SERVER_ERROR") {
|
|
144
|
+
return "warn";
|
|
141
145
|
}
|
|
146
|
+
return "error";
|
|
142
147
|
}
|
|
143
148
|
|
|
144
149
|
export { LOGGER_CONTEXT_SYMBOL, PinoHandlerPlugin, getLogger };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/pino",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.32",
|
|
5
5
|
"description": "Pino integration for oRPC: structured logging for typesafe APIs",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"funding": [
|
|
@@ -38,10 +38,10 @@
|
|
|
38
38
|
"pino": ">=10.1.0"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@
|
|
42
|
-
"@orpc/server": "2.0.0-beta.
|
|
43
|
-
"@orpc/
|
|
44
|
-
"@
|
|
41
|
+
"@orpc/client": "2.0.0-beta.32",
|
|
42
|
+
"@orpc/server": "2.0.0-beta.32",
|
|
43
|
+
"@orpc/shared": "2.0.0-beta.32",
|
|
44
|
+
"@standardserver/core": "^0.8.2"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"pino": "^10.3.1"
|