pino-testkit 10.4.5

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.
Files changed (196) hide show
  1. package/.nojekyll +0 -0
  2. package/.prettierignore +1 -0
  3. package/CNAME +1 -0
  4. package/CONTRIBUTING.md +30 -0
  5. package/LICENSE +21 -0
  6. package/README.md +175 -0
  7. package/SECURITY.md +87 -0
  8. package/benchmarks/basic.bench.js +95 -0
  9. package/benchmarks/child-child.bench.js +52 -0
  10. package/benchmarks/child-creation.bench.js +73 -0
  11. package/benchmarks/child.bench.js +62 -0
  12. package/benchmarks/deep-object.bench.js +88 -0
  13. package/benchmarks/formatters.bench.js +50 -0
  14. package/benchmarks/internal/custom-levels.js +67 -0
  15. package/benchmarks/internal/just-pino-heavy.bench.js +76 -0
  16. package/benchmarks/internal/just-pino.bench.js +182 -0
  17. package/benchmarks/internal/parent-vs-child.bench.js +75 -0
  18. package/benchmarks/internal/redact.bench.js +86 -0
  19. package/benchmarks/long-string.bench.js +81 -0
  20. package/benchmarks/multi-arg.bench.js +193 -0
  21. package/benchmarks/multistream.js +98 -0
  22. package/benchmarks/object.bench.js +82 -0
  23. package/benchmarks/utils/generate-benchmark-doc.js +36 -0
  24. package/benchmarks/utils/runbench.js +138 -0
  25. package/benchmarks/utils/wrap-log-level.js +55 -0
  26. package/bin.js +6 -0
  27. package/browser.js +547 -0
  28. package/build/sync-version.js +25 -0
  29. package/docs/api.md +1593 -0
  30. package/docs/asynchronous.md +40 -0
  31. package/docs/benchmarks.md +55 -0
  32. package/docs/browser.md +278 -0
  33. package/docs/bundling.md +40 -0
  34. package/docs/child-loggers.md +95 -0
  35. package/docs/diagnostics.md +16 -0
  36. package/docs/ecosystem.md +86 -0
  37. package/docs/help.md +345 -0
  38. package/docs/lts.md +64 -0
  39. package/docs/pretty.md +35 -0
  40. package/docs/redaction.md +135 -0
  41. package/docs/transports.md +1376 -0
  42. package/docs/web.md +309 -0
  43. package/eslint.config.js +28 -0
  44. package/examples/basic.js +43 -0
  45. package/examples/transport.js +68 -0
  46. package/favicon.ico +0 -0
  47. package/file.js +12 -0
  48. package/inc-version.sh +42 -0
  49. package/index.html +55 -0
  50. package/lib/caller.js +30 -0
  51. package/lib/constants.js +28 -0
  52. package/lib/contract.js +8 -0
  53. package/lib/deprecations.js +8 -0
  54. package/lib/levels.js +241 -0
  55. package/lib/meta.js +3 -0
  56. package/lib/multistream.js +203 -0
  57. package/lib/proto.js +256 -0
  58. package/lib/redaction.js +114 -0
  59. package/lib/symbols.js +74 -0
  60. package/lib/time.js +39 -0
  61. package/lib/tools.js +427 -0
  62. package/lib/transport-stream.js +56 -0
  63. package/lib/transport.js +289 -0
  64. package/lib/worker.js +194 -0
  65. package/package.json +119 -0
  66. package/pino.d.ts +908 -0
  67. package/pino.js +240 -0
  68. package/test/basic.test.js +886 -0
  69. package/test/broken-pipe.test.js +59 -0
  70. package/test/browser-child.test.js +132 -0
  71. package/test/browser-disabled.test.js +87 -0
  72. package/test/browser-early-console-freeze.test.js +12 -0
  73. package/test/browser-is-level-enabled.test.js +101 -0
  74. package/test/browser-levels.test.js +241 -0
  75. package/test/browser-serializers.test.js +352 -0
  76. package/test/browser-timestamp.test.js +88 -0
  77. package/test/browser-transmit.test.js +417 -0
  78. package/test/browser.test.js +698 -0
  79. package/test/complex-objects.test.js +36 -0
  80. package/test/crlf.test.js +34 -0
  81. package/test/custom-levels.test.js +267 -0
  82. package/test/diagnostics.test.js +107 -0
  83. package/test/error-key.test.js +37 -0
  84. package/test/error.test.js +403 -0
  85. package/test/escaping.test.js +93 -0
  86. package/test/esm/esm.mjs +14 -0
  87. package/test/esm/index.test.js +21 -0
  88. package/test/esm/named-exports.mjs +29 -0
  89. package/test/exit.test.js +79 -0
  90. package/test/fixtures/broken-pipe/basic.js +9 -0
  91. package/test/fixtures/broken-pipe/destination.js +10 -0
  92. package/test/fixtures/broken-pipe/syncfalse.js +12 -0
  93. package/test/fixtures/console-transport.js +13 -0
  94. package/test/fixtures/crashing-transport.js +13 -0
  95. package/test/fixtures/default-exit.js +8 -0
  96. package/test/fixtures/destination-exit.js +8 -0
  97. package/test/fixtures/eval/index.js +13 -0
  98. package/test/fixtures/eval/node_modules/14-files.js +3 -0
  99. package/test/fixtures/eval/node_modules/2-files.js +3 -0
  100. package/test/fixtures/eval/node_modules/file1.js +5 -0
  101. package/test/fixtures/eval/node_modules/file10.js +5 -0
  102. package/test/fixtures/eval/node_modules/file11.js +5 -0
  103. package/test/fixtures/eval/node_modules/file12.js +5 -0
  104. package/test/fixtures/eval/node_modules/file13.js +5 -0
  105. package/test/fixtures/eval/node_modules/file14.js +11 -0
  106. package/test/fixtures/eval/node_modules/file2.js +5 -0
  107. package/test/fixtures/eval/node_modules/file3.js +5 -0
  108. package/test/fixtures/eval/node_modules/file4.js +5 -0
  109. package/test/fixtures/eval/node_modules/file5.js +5 -0
  110. package/test/fixtures/eval/node_modules/file6.js +5 -0
  111. package/test/fixtures/eval/node_modules/file7.js +5 -0
  112. package/test/fixtures/eval/node_modules/file8.js +5 -0
  113. package/test/fixtures/eval/node_modules/file9.js +5 -0
  114. package/test/fixtures/noop-transport.js +10 -0
  115. package/test/fixtures/pretty/null-prototype.js +8 -0
  116. package/test/fixtures/stdout-hack-protection.js +11 -0
  117. package/test/fixtures/syncfalse-child.js +6 -0
  118. package/test/fixtures/syncfalse-exit.js +9 -0
  119. package/test/fixtures/syncfalse-flush-exit.js +10 -0
  120. package/test/fixtures/syncfalse.js +6 -0
  121. package/test/fixtures/syntax-error-esm.mjs +2 -0
  122. package/test/fixtures/to-file-transport-with-transform.js +20 -0
  123. package/test/fixtures/to-file-transport.js +13 -0
  124. package/test/fixtures/to-file-transport.mjs +8 -0
  125. package/test/fixtures/transport/index.js +12 -0
  126. package/test/fixtures/transport/package.json +5 -0
  127. package/test/fixtures/transport-exit-immediately-with-async-dest.js +16 -0
  128. package/test/fixtures/transport-exit-immediately.js +11 -0
  129. package/test/fixtures/transport-exit-on-ready.js +12 -0
  130. package/test/fixtures/transport-invalid-node-options.js +26 -0
  131. package/test/fixtures/transport-main.js +9 -0
  132. package/test/fixtures/transport-many-lines.js +29 -0
  133. package/test/fixtures/transport-preload-main.mjs +13 -0
  134. package/test/fixtures/transport-preload.mjs +13 -0
  135. package/test/fixtures/transport-string-stdout.js +9 -0
  136. package/test/fixtures/transport-transform.js +21 -0
  137. package/test/fixtures/transport-uses-pino-config.js +33 -0
  138. package/test/fixtures/transport-with-on-exit.js +12 -0
  139. package/test/fixtures/transport-worker-data.js +19 -0
  140. package/test/fixtures/transport-worker-name.js +24 -0
  141. package/test/fixtures/transport-worker.js +15 -0
  142. package/test/fixtures/transport-wrong-export-type.js +3 -0
  143. package/test/fixtures/ts/to-file-transport-native.mts +15 -0
  144. package/test/fixtures/ts/to-file-transport-with-transform.ts +18 -0
  145. package/test/fixtures/ts/to-file-transport.ts +11 -0
  146. package/test/fixtures/ts/transpile.cjs +36 -0
  147. package/test/fixtures/ts/transport-exit-immediately-with-async-dest.ts +15 -0
  148. package/test/fixtures/ts/transport-exit-immediately.ts +10 -0
  149. package/test/fixtures/ts/transport-exit-on-ready.ts +11 -0
  150. package/test/fixtures/ts/transport-main.ts +8 -0
  151. package/test/fixtures/ts/transport-string-stdout.ts +8 -0
  152. package/test/fixtures/ts/transport-worker.ts +14 -0
  153. package/test/formatters.test.js +364 -0
  154. package/test/helper.d.ts +4 -0
  155. package/test/helper.js +155 -0
  156. package/test/hooks.test.js +114 -0
  157. package/test/http.test.js +214 -0
  158. package/test/internals/version.test.js +17 -0
  159. package/test/is-level-enabled.test.js +179 -0
  160. package/test/jest/basic.spec.js +10 -0
  161. package/test/levels.test.js +810 -0
  162. package/test/metadata.test.js +120 -0
  163. package/test/mixin-merge-strategy.test.js +57 -0
  164. package/test/mixin.test.js +241 -0
  165. package/test/multistream.test.js +729 -0
  166. package/test/redact.test.js +893 -0
  167. package/test/serializers.test.js +257 -0
  168. package/test/stdout-protection.test.js +41 -0
  169. package/test/syncfalse.test.js +186 -0
  170. package/test/timestamp-nano.test.js +37 -0
  171. package/test/timestamp.test.js +124 -0
  172. package/test/transport/big.test.js +42 -0
  173. package/test/transport/bundlers-support.test.js +99 -0
  174. package/test/transport/caller.test.js +24 -0
  175. package/test/transport/core.test.js +733 -0
  176. package/test/transport/core.transpiled.test.ts +114 -0
  177. package/test/transport/crash.test.js +36 -0
  178. package/test/transport/module-link.test.js +241 -0
  179. package/test/transport/native-type-stripping.test.mjs +151 -0
  180. package/test/transport/node-options.test.js +116 -0
  181. package/test/transport/pipeline.test.js +137 -0
  182. package/test/transport/preload.test.js +54 -0
  183. package/test/transport/repl.test.js +15 -0
  184. package/test/transport/sync-false.test.js +67 -0
  185. package/test/transport/sync-true.test.js +57 -0
  186. package/test/transport/targets.test.js +48 -0
  187. package/test/transport/uses-pino-config.test.js +166 -0
  188. package/test/transport-stream.test.js +40 -0
  189. package/test/types/pino-import.test-d.cts +30 -0
  190. package/test/types/pino-multistream.test-d.ts +28 -0
  191. package/test/types/pino-top-export.test-d.ts +34 -0
  192. package/test/types/pino-transport.test-d.ts +156 -0
  193. package/test/types/pino-type-only.test-d.ts +75 -0
  194. package/test/types/pino.test-d.ts +683 -0
  195. package/test/types/pino.ts +91 -0
  196. package/tsconfig.json +14 -0
package/pino.js ADDED
@@ -0,0 +1,240 @@
1
+ 'use strict'
2
+
3
+ const os = require('node:os')
4
+ const stdSerializers = require('pino-std-serializers')
5
+ const caller = require('./lib/caller')
6
+ const redaction = require('./lib/redaction')
7
+ const contract = require('./lib/contract')
8
+ const time = require('./lib/time')
9
+ const proto = require('./lib/proto')
10
+ const symbols = require('./lib/symbols')
11
+ const { configure } = require('safe-stable-stringify')
12
+ const { assertDefaultLevelFound, mappings, genLsCache, genLevelComparison, assertLevelComparison } = require('./lib/levels')
13
+ const { DEFAULT_LEVELS, SORTING_ORDER } = require('./lib/constants')
14
+ const {
15
+ createArgsNormalizer,
16
+ asChindings,
17
+ buildSafeSonicBoom,
18
+ buildFormatters,
19
+ stringify,
20
+ normalizeDestFileDescriptor,
21
+ noop
22
+ } = require('./lib/tools')
23
+ const { version } = require('./lib/meta')
24
+ const {
25
+ chindingsSym,
26
+ redactFmtSym,
27
+ serializersSym,
28
+ timeSym,
29
+ timeSliceIndexSym,
30
+ streamSym,
31
+ stringifySym,
32
+ stringifySafeSym,
33
+ stringifiersSym,
34
+ setLevelSym,
35
+ endSym,
36
+ formatOptsSym,
37
+ messageKeySym,
38
+ errorKeySym,
39
+ nestedKeySym,
40
+ mixinSym,
41
+ levelCompSym,
42
+ useOnlyCustomLevelsSym,
43
+ formattersSym,
44
+ hooksSym,
45
+ nestedKeyStrSym,
46
+ mixinMergeStrategySym,
47
+ msgPrefixSym
48
+ } = symbols
49
+ const { epochTime, nullTime } = time
50
+ const { pid } = process
51
+ const hostname = os.hostname()
52
+ const defaultErrorSerializer = stdSerializers.err
53
+ const defaultOptions = {
54
+ level: 'info',
55
+ levelComparison: SORTING_ORDER.ASC,
56
+ levels: DEFAULT_LEVELS,
57
+ messageKey: 'msg',
58
+ errorKey: 'err',
59
+ nestedKey: null,
60
+ enabled: true,
61
+ base: { pid, hostname },
62
+ serializers: Object.assign(Object.create(null), {
63
+ err: defaultErrorSerializer
64
+ }),
65
+ formatters: Object.assign(Object.create(null), {
66
+ bindings(bindings) {
67
+ return bindings
68
+ },
69
+ level(label, number) {
70
+ return { level: number }
71
+ }
72
+ }),
73
+ hooks: {
74
+ logMethod: undefined,
75
+ streamWrite: undefined
76
+ },
77
+ timestamp: epochTime,
78
+ name: undefined,
79
+ redact: null,
80
+ customLevels: null,
81
+ useOnlyCustomLevels: false,
82
+ depthLimit: 5,
83
+ edgeLimit: 100
84
+ }
85
+
86
+ const normalize = createArgsNormalizer(defaultOptions)
87
+
88
+ const serializers = Object.assign(Object.create(null), stdSerializers)
89
+
90
+ function chain(chai, utils) {
91
+ contract()
92
+ }
93
+
94
+ function pino(...args) {
95
+ const instance = {}
96
+ const { opts, stream } = normalize(instance, caller(), ...args)
97
+
98
+ if (opts.level && typeof opts.level === 'string' && DEFAULT_LEVELS[opts.level.toLowerCase()] !== undefined) opts.level = opts.level.toLowerCase()
99
+
100
+ const {
101
+ redact,
102
+ crlf,
103
+ serializers,
104
+ timestamp,
105
+ messageKey,
106
+ errorKey,
107
+ nestedKey,
108
+ base,
109
+ name,
110
+ level,
111
+ customLevels,
112
+ levelComparison,
113
+ mixin,
114
+ mixinMergeStrategy,
115
+ useOnlyCustomLevels,
116
+ formatters,
117
+ hooks,
118
+ depthLimit,
119
+ edgeLimit,
120
+ onChild,
121
+ msgPrefix
122
+ } = opts
123
+
124
+ const stringifySafe = configure({
125
+ maximumDepth: depthLimit,
126
+ maximumBreadth: edgeLimit
127
+ })
128
+
129
+ const allFormatters = buildFormatters(
130
+ formatters.level,
131
+ formatters.bindings,
132
+ formatters.log
133
+ )
134
+
135
+ const stringifyFn = stringify.bind({
136
+ [stringifySafeSym]: stringifySafe
137
+ })
138
+ const stringifiers = redact ? redaction(redact, stringifyFn) : {}
139
+ const formatOpts = redact
140
+ ? { stringify: stringifiers[redactFmtSym] }
141
+ : { stringify: stringifyFn }
142
+ const end = '}' + (crlf ? '\r\n' : '\n')
143
+ const coreChindings = asChindings.bind(null, {
144
+ [chindingsSym]: '',
145
+ [serializersSym]: serializers,
146
+ [stringifiersSym]: stringifiers,
147
+ [stringifySym]: stringify,
148
+ [stringifySafeSym]: stringifySafe,
149
+ [formattersSym]: allFormatters
150
+ })
151
+
152
+ let chindings = ''
153
+ if (base !== null) {
154
+ if (name === undefined) {
155
+ chindings = coreChindings(base)
156
+ } else {
157
+ chindings = coreChindings(Object.assign({}, base, { name }))
158
+ }
159
+ }
160
+
161
+ const time = (timestamp instanceof Function)
162
+ ? timestamp
163
+ : (timestamp ? epochTime : nullTime)
164
+ const timeSliceIndex = time().indexOf(':') + 1
165
+
166
+ if (useOnlyCustomLevels && !customLevels) throw Error('customLevels is required if useOnlyCustomLevels is set true')
167
+ if (mixin && typeof mixin !== 'function') throw Error(`Unknown mixin type "${typeof mixin}" - expected "function"`)
168
+ if (msgPrefix && typeof msgPrefix !== 'string') throw Error(`Unknown msgPrefix type "${typeof msgPrefix}" - expected "string"`)
169
+
170
+ assertDefaultLevelFound(level, customLevels, useOnlyCustomLevels)
171
+ const levels = mappings(customLevels, useOnlyCustomLevels)
172
+
173
+ if (typeof stream.emit === 'function') {
174
+ stream.emit('message', { code: 'PINO_CONFIG', config: { levels, messageKey, errorKey } })
175
+ }
176
+
177
+ assertLevelComparison(levelComparison)
178
+ const levelCompFunc = genLevelComparison(levelComparison)
179
+
180
+ Object.assign(instance, {
181
+ levels,
182
+ [levelCompSym]: levelCompFunc,
183
+ [useOnlyCustomLevelsSym]: useOnlyCustomLevels,
184
+ [streamSym]: stream,
185
+ [timeSym]: time,
186
+ [timeSliceIndexSym]: timeSliceIndex,
187
+ [stringifySym]: stringify,
188
+ [stringifySafeSym]: stringifySafe,
189
+ [stringifiersSym]: stringifiers,
190
+ [endSym]: end,
191
+ [formatOptsSym]: formatOpts,
192
+ [messageKeySym]: messageKey,
193
+ [errorKeySym]: errorKey,
194
+ [nestedKeySym]: nestedKey,
195
+ // protect against injection
196
+ [nestedKeyStrSym]: nestedKey ? `,${JSON.stringify(nestedKey)}:{` : '',
197
+ [serializersSym]: serializers,
198
+ [mixinSym]: mixin,
199
+ [mixinMergeStrategySym]: mixinMergeStrategy,
200
+ [chindingsSym]: chindings,
201
+ [formattersSym]: allFormatters,
202
+ [hooksSym]: hooks,
203
+ silent: noop,
204
+ onChild,
205
+ [msgPrefixSym]: msgPrefix
206
+ })
207
+
208
+ Object.setPrototypeOf(instance, proto())
209
+
210
+ genLsCache(instance)
211
+
212
+ instance[setLevelSym](level)
213
+
214
+ return instance
215
+ }
216
+
217
+ module.exports = pino
218
+
219
+ module.exports.destination = (dest = process.stdout.fd) => {
220
+ if (typeof dest === 'object') {
221
+ dest.dest = normalizeDestFileDescriptor(dest.dest || process.stdout.fd)
222
+ return buildSafeSonicBoom(dest)
223
+ } else {
224
+ return buildSafeSonicBoom({ dest: normalizeDestFileDescriptor(dest), minLength: 0 })
225
+ }
226
+ }
227
+
228
+ module.exports.transport = require('./lib/transport')
229
+ module.exports = chain
230
+ module.exports.multistream = require('./lib/multistream')
231
+ module.exports.contract = contract
232
+ module.exports.levels = mappings()
233
+ module.exports.stdSerializers = serializers
234
+ module.exports.stdTimeFunctions = Object.assign({}, time)
235
+ module.exports.symbols = symbols
236
+ module.exports.version = version
237
+
238
+ // Enables default and name export with TypeScript and Babel
239
+ module.exports.default = pino
240
+ module.exports.pino = pino