@stacksjs/logging 0.74.36 → 0.74.38

package/dist/index.d.ts

@@ -6,6 +6,14 @@ import type { Logger } from '@stacksjs/clarity';
 // are re-exported here because this is where consumers already import them
 // from.
 export type { LogContext, LogLevel, LogRecord, LogTransport } from '@stacksjs/types';
+/**
+ * Whether a record at `level` is below the level in force right now.
+ *
+ * Resolved per call rather than snapshotted, because `LOG_LEVEL` is routinely
+ * set from inside the process - a `buddy` subcommand applying `--quiet`, a
+ * test pinning a level - after the logger was built.
+ */
+export declare function suppressedAtCurrentLevel(level: LogLevel): boolean;
 /**
  * Attach a transport at runtime, and get back a function that detaches it.
  *

package/dist/index.js

@@ -1,11 +1,11 @@
 // @bun
-import{AsyncLocalStorage as M}from"async_hooks";import s from"process";var O=0,E=1,u=null,d=null,x=new Set;function _(e){return x.add(e),e.finally(()=>x.delete(e)).catch(()=>{}),e}var R=!1;function J(){if(R)return;R=!0,s.on("beforeExit",()=>{g.flush()})}var l=[],j=new Set,D={debug:0,info:1,success:1,warning:2,error:3};function z(e){let n=e;if(!n||typeof n!=="object"||typeof n.log!=="function")return s.stderr.write(`[logging] Ignoring a transport without a log() function.
+import{AsyncLocalStorage as Y}from"async_hooks";import s from"process";var _=0,S=1,f=null,d=null,x=new Set;function R(e){return x.add(e),e.finally(()=>x.delete(e)).catch(()=>{}),e}var j=!1;function B(){if(j)return;j=!0,s.on("beforeExit",()=>{c.flush()})}var g=[],D=new Set,h={debug:0,info:1,success:1,warning:2,error:3};function I(e){return h[e]<h[W()]}function V(e){let n=e;if(!n||typeof n!=="object"||typeof n.log!=="function")return s.stderr.write(`[logging] Ignoring a transport without a log() function.
 `),null;if(typeof n.name!=="string"||!n.name)return s.stderr.write(`[logging] Ignoring a transport without a name.
-`),null;return l.push(n),()=>{let t=l.indexOf(n);if(t!==-1)l.splice(t,1)}}function ie(e){let n=z(e);if(!n)return()=>{};return h(),n}function se(){return[...l]}function f(e,n,t){if(l.length===0)return;let r;try{r={level:e,message:n,args:t,context:F(),timestamp:new Date().toISOString()}}catch{return}for(let o of l){if(o.level&&D[e]<D[o.level])continue;try{o.log(r)}catch(i){if(!j.has(o.name)){j.add(o.name);let c=i instanceof Error?i.message:String(i);s.stderr.write(`[logging] Transport "${o.name}" threw: ${c}. Further throws from it are silent.
-`)}}}}async function Y(){let e=l.filter((n)=>typeof n.flush==="function").map((n)=>n.flush().catch(()=>{}));if(e.length>0)await Promise.allSettled(e)}var I=new Set(["debug","info","success","warning","error"]);function p(e,n="info"){if(!e)return n;let t=e.toLowerCase();if(t==="warn")return"warning";if(I.has(t))return t;return s.stderr.write(`[logging] Ignoring invalid LOG_LEVEL="${e}" (expected: ${[...I].join(", ")}); using "${n}".
-`),n}var P,N,A;function B(){let e=s.env.LOG_LEVEL;if(e){if(e!==N)N=e,A=p(e);return A}return P??"info"}function K(e){if(e==="json"||e==="text")return e;if(e)s.stderr.write(`[logging] Ignoring invalid LOG_FORMAT="${e}" (expected "json" or "text").
-`);return s.env.NODE_ENV==="production"?"json":"text"}function U(e){let n=e.envLevel?p(e.envLevel):e.cfgLevel?p(e.cfgLevel):"info",t=e.envFormat?K(e.envFormat):e.cfgFormat==="json"||e.cfgFormat==="text"?e.cfgFormat:e.isProduction?"json":"text";return{level:n,format:t,writeToFile:e.cfgWriteToFile??!0}}function w(e,n=0){if(n>8)return{name:"Error",message:"[cause chain truncated]"};if(e instanceof Error)return{name:e.name,message:e.message,stack:e.stack,cause:e.cause!=null?w(e.cause,n+1):void 0};if(typeof e==="string")return{name:"Error",message:e};if(e==null)return{name:"Error",message:String(e)};try{return{name:"Error",message:JSON.stringify(y(e))}}catch{return{name:"Error",message:String(e)}}}function S(e){let n=e.stack||`${e.name}: ${e.message}`,t=e.cause;while(t)n+=`
-  caused by: ${t.stack||`${t.name}: ${t.message}`}`,t=t.cause;return n}function y(e,n=0){if(e instanceof Error)return w(e);if(n>=4||e===null||typeof e!=="object")return e;if(Array.isArray(e))return e.map((o)=>y(o,n+1));let t=Object.getPrototypeOf(e);if(t!==Object.prototype&&t!==null)return e;let r={};for(let[o,i]of Object.entries(e))r[o]=y(i,n+1);return r}function q(e){return y(e)}var T=new M;function ae(e,n){return T.run(e,n)}function F(){let e=T.getStore(),n=X();if(!n)return e;return{trace_id:n,...e}}function X(){try{let n=globalThis[Symbol.for("stacks.router.traceStorage")]?.getStore?.();if(n)return n;return globalThis[Symbol.for("stacks.router.requestStorage")]?.getStore?.()?._requestId}catch{return}}var H=Symbol.for("@stacksjs/config:overridesReady"),k=null;async function Q(){try{let e=await import("@stacksjs/config");return e.logging??null}catch{return null}}function V(){let e=globalThis[H];if(!e||typeof e.then!=="function")return null;return e}async function W(e,n){let{level:t,format:r,writeToFile:o}=U({envLevel:s.env.LOG_LEVEL,envFormat:s.env.LOG_FORMAT,cfgLevel:e?.level,cfgFormat:e?.format,cfgWriteToFile:typeof e?.writeToFile==="boolean"?e.writeToFile:void 0,isProduction:s.env.NODE_ENV==="production"}),i;if(e?.logsPath){let c=await import("path");i=c.dirname(e.logsPath)}if(!i)i=n;if(!i)try{let c=await import("@stacksjs/path");i=c.projectPath("storage/logs")}catch{i="storage/logs"}return{level:t,format:r,writeToFile:o,logDirectory:i}}function G(e){if(!Array.isArray(e?.transports))return;for(let n of e.transports)if(!l.includes(n))z(n)}var v=null;function C(){if(v)return;let e=V();if(!e)return;v=e.then(async(n)=>{let t=n?.logging;if(!t)return;if(G(t),t.level)P=p(t.level);let r=k;if(!r||!u)return;let o=await W(t,r.logDirectory);if(r.level===o.level&&r.format===o.format&&r.writeToFile===o.writeToFile&&r.logDirectory===o.logDirectory)return;let i=u,{Logger:c}=await import("@stacksjs/clarity");u=new c("stacks",{level:o.level,logDirectory:o.logDirectory,showTags:!1,fancy:o.format!=="json",format:o.format,writeToFile:o.writeToFile}),k=o;try{await i.flush?.(),await i.destroy?.()}catch{}}).catch(()=>{})}async function h(){if(u)return;if(d)return d;return J(),d=(async()=>{let e=await Q();if(G(e),e?.level)P=p(e.level);let n=await W(e),{Logger:t}=await import("@stacksjs/clarity");u=new t("stacks",{level:n.level,logDirectory:n.logDirectory,showTags:!1,fancy:n.format!=="json",format:n.format,writeToFile:n.writeToFile}),k=n})(),d.then(C),d}async function a(){return await h(),u}async function ge(){if(await h(),C(),v)await v;return u}function m(...e){let n=e.filter((r)=>r!==void 0).map((r)=>{if(r instanceof Error)return S(w(r));if(typeof r==="object"&&r!==null)return JSON.stringify(y(r),null,2);return String(r)}).join(" "),t=T.getStore();if(t?.requestId)return`[${t.requestId}] ${n}`;return n}var Z=new Set(["shouldExit","silent","message"]);function ee(e){if(!e||typeof e!=="object"||e instanceof Error)return!1;if(!(("shouldExit"in e)||("silent"in e)))return!1;return Object.keys(e).every((n)=>Z.has(n))}var g={info:async(...e)=>{let n=m(...e),t=await a();f("info",n,e),await t.info(n)},success:async(e)=>{let n=await a();f("success",e,[e]),await n.success(e)},warn:async(e,n)=>{let t=await a();if(f("warning",e,n===void 0?[e]:[e,n]),n==null){await t.warn(e);return}let r=y(n);await t.warn(e,r)},warning:async(e)=>{let n=await a();f("warning",e,[e]),await n.warn(e)},error:async(e,n,t)=>{let r=ee(n)?n:void 0,o;if(typeof e==="string")o=e;else o=S(w(e));if(n!==void 0&&!r)o=`${o} ${S(w(n))}`;let i={...F(),...t};if(Object.keys(i).length>0)try{o=`${o} ${JSON.stringify(q(i))}`}catch{}let c=await a();if(f("error",o,r?[e]:[e,n,t].filter((b)=>b!==void 0)),await c.error(o),r?.shouldExit){let{handleError:b}=await import("@stacksjs/error-handling/handler");b(e,r)}},debug:async(...e)=>{let n=B()!=="debug";if(n&&l.length===0){if(V()){if(!u&&!d)h();else if(!v)C()}return}let t=m(...e);if(n){f("debug",t,e);return}let r=await a();f("debug",t,e),await r.debug(t)},dump:async(...e)=>{let n=m(...e);await(await a()).debug(`DUMP: ${n}`)},dd:async(...e)=>{let n=m(...e);await(await a()).error(n),s.exit(E)},echo:async(...e)=>{let n=m(...e);await(await a()).info(`ECHO: ${n}`)},time:(e)=>{let n=performance.now();return async(t)=>{let r=performance.now()-n,o=await a(),i=t?` ${JSON.stringify(q(t))}`:"";await o.info(`${e}: ${r.toFixed(2)}ms${i}`)}},syncWarn:(e)=>{s.stderr.write(`${e}
+`),null;return g.push(n),()=>{let t=g.indexOf(n);if(t!==-1)g.splice(t,1)}}function se(e){let n=V(e);if(!n)return()=>{};return b(),n}function ae(){return[...g]}function l(e,n,t){if(g.length===0)return;let r;try{r={level:e,message:n,args:t,context:F(),timestamp:new Date().toISOString()}}catch{return}for(let o of g){if(o.level&&h[e]<h[o.level])continue;try{o.log(r)}catch(i){if(!D.has(o.name)){D.add(o.name);let u=i instanceof Error?i.message:String(i);s.stderr.write(`[logging] Transport "${o.name}" threw: ${u}. Further throws from it are silent.
+`)}}}}async function K(){let e=g.filter((n)=>typeof n.flush==="function").map((n)=>n.flush().catch(()=>{}));if(e.length>0)await Promise.allSettled(e)}var N=new Set(["debug","info","success","warning","error"]);function p(e,n="info"){if(!e)return n;let t=e.toLowerCase();if(t==="warn")return"warning";if(N.has(t))return t;return s.stderr.write(`[logging] Ignoring invalid LOG_LEVEL="${e}" (expected: ${[...N].join(", ")}); using "${n}".
+`),n}var T,A,q;function W(){let e=s.env.LOG_LEVEL;if(e){if(e!==A)A=e,q=p(e);return q}return T??"info"}function U(e){if(e==="json"||e==="text")return e;if(e)s.stderr.write(`[logging] Ignoring invalid LOG_FORMAT="${e}" (expected "json" or "text").
+`);return s.env.NODE_ENV==="production"?"json":"text"}function X(e){let n=e.envLevel?p(e.envLevel):e.cfgLevel?p(e.cfgLevel):"info",t=e.envFormat?U(e.envFormat):e.cfgFormat==="json"||e.cfgFormat==="text"?e.cfgFormat:e.isProduction?"json":"text";return{level:n,format:t,writeToFile:e.cfgWriteToFile??!0}}function w(e,n=0){if(n>8)return{name:"Error",message:"[cause chain truncated]"};if(e instanceof Error)return{name:e.name,message:e.message,stack:e.stack,cause:e.cause!=null?w(e.cause,n+1):void 0};if(typeof e==="string")return{name:"Error",message:e};if(e==null)return{name:"Error",message:String(e)};try{return{name:"Error",message:JSON.stringify(y(e))}}catch{return{name:"Error",message:String(e)}}}function k(e){let n=e.stack||`${e.name}: ${e.message}`,t=e.cause;while(t)n+=`
+  caused by: ${t.stack||`${t.name}: ${t.message}`}`,t=t.cause;return n}function y(e,n=0){if(e instanceof Error)return w(e);if(n>=4||e===null||typeof e!=="object")return e;if(Array.isArray(e))return e.map((o)=>y(o,n+1));let t=Object.getPrototypeOf(e);if(t!==Object.prototype&&t!==null)return e;let r={};for(let[o,i]of Object.entries(e))r[o]=y(i,n+1);return r}function z(e){return y(e)}var C=new Y;function ge(e,n){return C.run(e,n)}function F(){let e=C.getStore(),n=H();if(!n)return e;return{trace_id:n,...e}}function H(){try{let n=globalThis[Symbol.for("stacks.router.traceStorage")]?.getStore?.();if(n)return n;return globalThis[Symbol.for("stacks.router.requestStorage")]?.getStore?.()?._requestId}catch{return}}var Q=Symbol.for("@stacksjs/config:overridesReady"),P=null;async function Z(){try{let e=await import("@stacksjs/config");return e.logging??null}catch{return null}}function G(){let e=globalThis[Q];if(!e||typeof e.then!=="function")return null;return e}async function M(e,n){let{level:t,format:r,writeToFile:o}=X({envLevel:s.env.LOG_LEVEL,envFormat:s.env.LOG_FORMAT,cfgLevel:e?.level,cfgFormat:e?.format,cfgWriteToFile:typeof e?.writeToFile==="boolean"?e.writeToFile:void 0,isProduction:s.env.NODE_ENV==="production"}),i;if(e?.logsPath){let u=await import("path");i=u.dirname(e.logsPath)}if(!i)i=n;if(!i)try{let u=await import("@stacksjs/path");i=u.projectPath("storage/logs")}catch{i="storage/logs"}return{level:t,format:r,writeToFile:o,logDirectory:i}}function J(e){if(!Array.isArray(e?.transports))return;for(let n of e.transports)if(!g.includes(n))V(n)}var v=null;function O(){if(v)return;let e=G();if(!e)return;v=e.then(async(n)=>{let t=n?.logging;if(!t)return;if(J(t),t.level)T=p(t.level);let r=P;if(!r||!f)return;let o=await M(t,r.logDirectory);if(r.level===o.level&&r.format===o.format&&r.writeToFile===o.writeToFile&&r.logDirectory===o.logDirectory)return;let i=f,{Logger:u}=await import("@stacksjs/clarity");f=new u("stacks",{level:o.level,logDirectory:o.logDirectory,showTags:!1,fancy:o.format!=="json",format:o.format,writeToFile:o.writeToFile}),P=o;try{await i.flush?.(),await i.destroy?.()}catch{}}).catch(()=>{})}async function b(){if(f)return;if(d)return d;return B(),d=(async()=>{let e=await Z();if(J(e),e?.level)T=p(e.level);let n=await M(e),{Logger:t}=await import("@stacksjs/clarity");f=new t("stacks",{level:n.level,logDirectory:n.logDirectory,showTags:!1,fancy:n.format!=="json",format:n.format,writeToFile:n.writeToFile}),P=n})(),d.then(O),d}async function a(){return await b(),f}async function ce(){if(await b(),O(),v)await v;return f}function m(...e){let n=e.filter((r)=>r!==void 0).map((r)=>{if(r instanceof Error)return k(w(r));if(typeof r==="object"&&r!==null)return JSON.stringify(y(r),null,2);return String(r)}).join(" "),t=C.getStore();if(t?.requestId)return`[${t.requestId}] ${n}`;return n}var ee=new Set(["shouldExit","silent","message"]);function ne(e){if(!e||typeof e!=="object"||e instanceof Error)return!1;if(!(("shouldExit"in e)||("silent"in e)))return!1;return Object.keys(e).every((n)=>ee.has(n))}var c={info:async(...e)=>{let n=I("info");if(n&&g.length===0)return;let t=m(...e);if(n){l("info",t,e);return}let r=await a();l("info",t,e),await r.info(t)},success:async(e)=>{let n=I("success");if(n&&g.length===0)return;if(n){l("success",e,[e]);return}let t=await a();l("success",e,[e]),await t.success(e)},warn:async(e,n)=>{let t=await a();if(l("warning",e,n===void 0?[e]:[e,n]),n==null){await t.warn(e);return}let r=y(n);await t.warn(e,r)},warning:async(e)=>{let n=await a();l("warning",e,[e]),await n.warn(e)},error:async(e,n,t)=>{let r=ne(n)?n:void 0,o;if(typeof e==="string")o=e;else o=k(w(e));if(n!==void 0&&!r)o=`${o} ${k(w(n))}`;let i={...F(),...t};if(Object.keys(i).length>0)try{o=`${o} ${JSON.stringify(z(i))}`}catch{}let u=await a();if(l("error",o,r?[e]:[e,n,t].filter((E)=>E!==void 0)),await u.error(o),r?.shouldExit){let{handleError:E}=await import("@stacksjs/error-handling/handler");E(e,r)}},debug:async(...e)=>{let n=W()!=="debug";if(n&&g.length===0){if(G()){if(!f&&!d)b();else if(!v)O()}return}let t=m(...e);if(n){l("debug",t,e);return}let r=await a();l("debug",t,e),await r.debug(t)},dump:async(...e)=>{let n=m(...e);await(await a()).debug(`DUMP: ${n}`)},dd:async(...e)=>{let n=m(...e);await(await a()).error(n),s.exit(S)},echo:async(...e)=>{let n=m(...e);await(await a()).info(`ECHO: ${n}`)},time:(e)=>{let n=performance.now();return async(t)=>{let r=performance.now()-n,o=await a(),i=t?` ${JSON.stringify(z(t))}`:"";await o.info(`${e}: ${r.toFixed(2)}ms${i}`)}},syncWarn:(e)=>{s.stderr.write(`${e}
 `)},syncError:(e)=>{s.stderr.write(`${e}
-`)},fatal:(e,n=E)=>{s.stderr.write(`${e}
-`),s.exit(n)},exit:async(e,n=O)=>{if(e)await(n===O?g.success(e):g.error(e));await g.flush(),s.exit(n)},flush:async()=>{if(x.size>0)await Promise.allSettled([...x]);if(await Y(),!u&&!d)return;try{let e=await a(),n=e.flush;if(typeof n==="function")await n.call(e)}catch{}}};async function ce(...e){for(let n of e)await g.debug(n)}async function ue(...e){let n=m(...e);console.log(n),s.exit(E)}async function le(...e){await g.debug(...e)}function ne(e){if(e&&typeof e==="object"){let n=e;if(typeof n.status==="number")return n.status;if(typeof n.statusCode==="number")return n.statusCode}return}function fe(e,n={}){let t=n.status??ne(e),r=typeof t==="number"&&t>=400&&t<500,o=n.label??"Unhandled error",i={...n.context,...t!=null?{status:t}:{}};if(r){g.debug(`${o} (client error ${t}): ${w(e).message}`);return}g.error(o,e,i)}function L(e,n,t){let r=F(),o={event:n,traceId:r?.requestId,...t};if(e==="warn")_(g.warn(`[${n}]`,o));else _(g[e](o))}var te={request(e,n,t,r,o={}){let i=t>=500?"error":t>=400?"warn":"info";L(i,"http.request",{method:e,path:n,status:t,durationMs:r,...o})},query(e,n,t={}){L("debug","db.query",{sql:e,durationMs:n,...t})},slowQuery(e,n,t={}){L("warn","db.slow_query",{sql:e,durationMs:n,...t})},job(e,n,t={}){L(n==="failed"?"error":"info",`job.${n}`,{jobName:e,...t})},cache(e,n,t={}){L("debug",`cache.${e}`,{key:n,...t})}};g.struct=te;export{B as currentLevel,ue as dd,ce as dump,le as echo,m as formatMessage,F as getLogContext,g as log,ge as logger,q as normalizeContext,w as normalizeError,K as parseLogFormat,p as parseLogLevel,ie as registerTransport,S as renderNormalizedError,fe as report,U as resolveLogSettings,te as struct,se as transports,ae as withLogContext};
+`)},fatal:(e,n=S)=>{s.stderr.write(`${e}
+`),s.exit(n)},exit:async(e,n=_)=>{if(e)await(n===_?c.success(e):c.error(e));await c.flush(),s.exit(n)},flush:async()=>{if(x.size>0)await Promise.allSettled([...x]);if(await K(),!f&&!d)return;try{let e=await a(),n=e.flush;if(typeof n==="function")await n.call(e)}catch{}}};async function ue(...e){for(let n of e)await c.debug(n)}async function le(...e){let n=m(...e);console.log(n),s.exit(S)}async function fe(...e){await c.debug(...e)}function te(e){if(e&&typeof e==="object"){let n=e;if(typeof n.status==="number")return n.status;if(typeof n.statusCode==="number")return n.statusCode}return}function de(e,n={}){let t=n.status??te(e),r=typeof t==="number"&&t>=400&&t<500,o=n.label??"Unhandled error",i={...n.context,...t!=null?{status:t}:{}};if(r){c.debug(`${o} (client error ${t}): ${w(e).message}`);return}c.error(o,e,i)}function L(e,n,t){let r=F(),o={event:n,traceId:r?.requestId,...t};if(e==="warn")R(c.warn(`[${n}]`,o));else R(c[e](o))}var re={request(e,n,t,r,o={}){let i=t>=500?"error":t>=400?"warn":"info";L(i,"http.request",{method:e,path:n,status:t,durationMs:r,...o})},query(e,n,t={}){L("debug","db.query",{sql:e,durationMs:n,...t})},slowQuery(e,n,t={}){L("warn","db.slow_query",{sql:e,durationMs:n,...t})},job(e,n,t={}){L(n==="failed"?"error":"info",`job.${n}`,{jobName:e,...t})},cache(e,n,t={}){L("debug",`cache.${e}`,{key:n,...t})}};c.struct=re;export{W as currentLevel,le as dd,ue as dump,fe as echo,m as formatMessage,F as getLogContext,c as log,ce as logger,z as normalizeContext,w as normalizeError,U as parseLogFormat,p as parseLogLevel,se as registerTransport,k as renderNormalizedError,de as report,X as resolveLogSettings,re as struct,I as suppressedAtCurrentLevel,ae as transports,ge as withLogContext};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/logging",
   "type": "module",
   "sideEffects": false,
-  "version": "0.74.36",
+  "version": "0.74.38",
   "description": "The Stacks logging system.",
   "author": "Chris Breuer",
   "contributors": [
@@ -60,15 +60,15 @@
   "dependencies": {
     "@loghq/stacks": "^0.2.3",
     "@stacksjs/clarity": "^0.3.33",
-    "@stacksjs/config": "0.74.36",
-    "@stacksjs/error-handling": "0.74.36",
-    "@stacksjs/path": "0.74.36",
-    "@stacksjs/types": "0.74.36"
+    "@stacksjs/config": "0.74.38",
+    "@stacksjs/error-handling": "0.74.38",
+    "@stacksjs/path": "0.74.38",
+    "@stacksjs/types": "0.74.38"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.74.36",
-    "@stacksjs/storage": "0.74.36",
-    "@stacksjs/validation": "0.74.36",
+    "@stacksjs/cli": "0.74.38",
+    "@stacksjs/storage": "0.74.38",
+    "@stacksjs/validation": "0.74.38",
     "better-dx": "^0.2.24"
   }
 }