@payfit/audit-log 3.8.0 → 3.10.0

package/dist/index.d.ts

@@ -1,7 +1,10 @@
+import type { Logger } from 'winston';
+import { type IMetricsClient } from './metrics';
+import { IAuditLogTransport } from './transport/interface';
 /**
  * The allowed Namespaces for the AuditLog
  */
-export type AuditNamespaces = 'employee' | 'company' | 'permissions' | 'absence' | 'expense' | 'payments' | 'auth' | 'billing' | 'modules' | 'integrations' | 'partnerApi' | 'donation' | 'notificationSettings' | 'people' | 'subscriptions' | 'organization' | 'declarations' | 'pricing' | 'payroll' | 'jetlang' | 'files' | 'versioner';
+export type AuditNamespaces = 'employee' | 'company' | 'permissions' | 'absence' | 'expense' | 'payments' | 'auth' | 'billing' | 'modules' | 'integrations' | 'partnerApi' | 'donation' | 'notificationSettings' | 'people' | 'subscriptions' | 'organization' | 'declarations' | 'pricing' | 'payroll' | 'jetlang' | 'files' | 'versioner' | 'live-timing';
 /**
  * The allowed targets for the AuditLog
  */
@@ -97,9 +100,16 @@ export interface IAuditLoggerInitialization {
     environment: string;
     service: string;
 }
+export interface IAuditLoggerDependencies {
+    transport?: IAuditLogTransport;
+    logger?: Logger;
+    metrics?: IMetricsClient;
+}
 export declare class AuditLogger implements IAuditLogger {
     protected params: IAuditLoggerInitialization;
-    private transport;
-    constructor(params: IAuditLoggerInitialization);
+    private readonly transport;
+    private readonly logger;
+    private readonly metrics;
+    constructor(params: IAuditLoggerInitialization, deps?: IAuditLoggerDependencies);
     log({ scope, account, ...data }: IAuditLogData): Promise<void>;
 }

package/dist/index.js

@@ -1 +1 @@
-"use strict";var d=Object.defineProperty;var m=(r,e,t)=>e in r?d(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t;var n=(r,e,t)=>(m(r,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("uuid"),i=require("@aws-sdk/client-sqs"),p="eu-west-3",S={dev:"https://sqs.eu-west-3.amazonaws.com/533547282673/audit-logs-ingest",staging:"https://sqs.eu-west-3.amazonaws.com/589883667243/audit-logs-ingest",prod:"https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"},h={working:"staging",production:"prod"};class v{constructor(e){n(this,"environment");n(this,"client");n(this,"queueUrl");this.environment=e;const t=h[e]??e,o=S[t];if(!o)throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);this.queueUrl=o,this.client=new i.SQSClient({region:p})}async create(e){await this.client.send(new i.SendMessageCommand({QueueUrl:this.queueUrl,MessageBody:JSON.stringify(e)}))}}class q{constructor(e){n(this,"params");n(this,"transport");this.params=e,this.transport=new v(e.environment)}async log({scope:e,account:t,...o}){const c=w.v4(),{environment:u,service:g}=this.params,s={...o,...t,service:g,id:c,environment:u,...e&&{scope:e}};try{await this.transport.create(s)}catch(l){const a=l.message;try{console.error(JSON.stringify({status:"error",namespace:"audit-logs",message:"audit-log write failed",audit_log:s,error:a}))}catch{console.error(JSON.stringify({status:"error",namespace:"audit-logs",message:"audit-log write failed (serialization failed)",audit_log_meta:{id:s.id,service:s.service,environment:s.environment,namespace:s.namespace,event:s.event,target:s.target},error:a}))}}}}exports.AuditLogger=q;
+"use strict";var v=Object.defineProperty;var p=(s,t,e)=>t in s?v(s,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[t]=e;var n=(s,t,e)=>(p(s,typeof t!="symbol"?t+"":t,e),e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const f=require("uuid"),o=require("winston"),S=require("hot-shots"),m=require("@aws-sdk/client-sqs"),E="audit-logs",_="@payfit/audit-log",L=()=>{const s=process.env.LOG_LEVEL;return s&&s.trim()!==""?s.trim():"info"},q=(s,t)=>o.createLogger({level:L(),silent:process.env.NODE_ENV==="test",exitOnError:!1,defaultMeta:{namespace:E,sdk:_,service:s,environment:t},format:o.format.combine(o.format.timestamp(),o.format.errors({stack:!0}),o.format.json()),transports:[new o.transports.Console]}),y="payfit.audit-logs.",d=s=>Object.entries(s).filter(([,t])=>t!==void 0&&t!=="").map(([t,e])=>`${t}:${String(e)}`);class A{constructor(){n(this,"client");this.client=new S.StatsD({prefix:y,errorHandler:()=>{},cacheDns:!0})}increment(t,e){this.client.increment(t,1,d(e))}histogram(t,e,i){this.client.histogram(t,e,d(i))}async close(){await new Promise(t=>{this.client.close(()=>t())})}}const M=()=>new A,D="eu-west-3",U={dev:"https://sqs.eu-west-3.amazonaws.com/533547282673/audit-logs-ingest",staging:"https://sqs.eu-west-3.amazonaws.com/589883667243/audit-logs-ingest",prod:"https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"},C={working:"staging",production:"prod"};class O{constructor(t){n(this,"environment");n(this,"client");n(this,"queueUrl");this.environment=t;const e=C[t]??t,i=U[e];if(!i)throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${t}"`);this.queueUrl=i,this.client=new m.SQSClient({region:D})}async create(t){await this.client.send(new m.SendMessageCommand({QueueUrl:this.queueUrl,MessageBody:JSON.stringify(t)}))}}class N{constructor(t,e={}){n(this,"params");n(this,"transport");n(this,"logger");n(this,"metrics");this.params=t,this.transport=e.transport??new O(t.environment),this.logger=e.logger??q(t.service,t.environment),this.metrics=e.metrics??M()}async log({scope:t,account:e,...i}){const h=f.v4(),{environment:c,service:g}=this.params,r={...i,...e,service:g,id:h,environment:c,...t&&{scope:t}},a={service:g,environment:c,namespace:r.namespace,event:r.event,target:r.target},l=Date.now();try{await this.transport.create(r),this.metrics.increment("sent",a),this.metrics.histogram("send_duration_ms",Date.now()-l,a),this.logger.debug("audit-log sent",{id:r.id,event:r.event,target:r.target})}catch(w){this.metrics.increment("send_failed",a),this.metrics.histogram("send_duration_ms",Date.now()-l,a);const u=w.message;try{this.logger.error("audit-log write failed",{audit_log:r,error:u})}catch{this.metrics.increment("serialization_failed",a);try{this.logger.error("audit-log write failed (serialization failed)",{audit_log_meta:{id:r.id,service:r.service,environment:r.environment,namespace:r.namespace,event:r.event,target:r.target},error:u})}catch{}}}}}exports.AuditLogger=N;

package/dist/index.mjs

@@ -1,80 +1,132 @@
-var l = Object.defineProperty;
-var d = (r, e, t) => e in r ? l(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t;
-var o = (r, e, t) => (d(r, typeof e != "symbol" ? e + "" : e, t), t);
-import { v4 as m } from "uuid";
-import { SQSClient as p, SendMessageCommand as w } from "@aws-sdk/client-sqs";
-const h = "eu-west-3", S = {
+var p = Object.defineProperty;
+var w = (s, t, e) => t in s ? p(s, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[t] = e;
+var i = (s, t, e) => (w(s, typeof t != "symbol" ? t + "" : t, e), e);
+import { v4 as v } from "uuid";
+import { createLogger as f, format as a, transports as E } from "winston";
+import { StatsD as _ } from "hot-shots";
+import { SQSClient as S, SendMessageCommand as L } from "@aws-sdk/client-sqs";
+const y = "audit-logs", A = "@payfit/audit-log", D = () => {
+  const s = process.env.LOG_LEVEL;
+  return s && s.trim() !== "" ? s.trim() : "info";
+}, M = (s, t) => f({
+  level: D(),
+  silent: process.env.NODE_ENV === "test",
+  exitOnError: !1,
+  defaultMeta: {
+    namespace: y,
+    sdk: A,
+    service: s,
+    environment: t
+  },
+  format: a.combine(a.timestamp(), a.errors({ stack: !0 }), a.json()),
+  transports: [new E.Console()]
+}), U = "payfit.audit-logs.", d = (s) => Object.entries(s).filter(([, t]) => t !== void 0 && t !== "").map(([t, e]) => `${t}:${String(e)}`);
+class q {
+  constructor() {
+    i(this, "client");
+    this.client = new _({
+      prefix: U,
+      // Loss of metrics never breaks the caller — DogStatsD UDP is best-effort by design.
+      errorHandler: () => {
+      },
+      cacheDns: !0
+    });
+  }
+  increment(t, e) {
+    this.client.increment(t, 1, d(e));
+  }
+  histogram(t, e, n) {
+    this.client.histogram(t, e, d(n));
+  }
+  async close() {
+    await new Promise((t) => {
+      this.client.close(() => t());
+    });
+  }
+}
+const C = () => new q(), N = "eu-west-3", O = {
   dev: "https://sqs.eu-west-3.amazonaws.com/533547282673/audit-logs-ingest",
   staging: "https://sqs.eu-west-3.amazonaws.com/589883667243/audit-logs-ingest",
   prod: "https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"
-}, v = {
+}, z = {
   working: "staging",
   production: "prod"
 };
-class f {
-  constructor(e) {
-    o(this, "environment");
-    o(this, "client");
-    o(this, "queueUrl");
-    this.environment = e;
-    const t = v[e] ?? e, a = S[t];
-    if (!a)
-      throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);
-    this.queueUrl = a, this.client = new p({ region: h });
+class R {
+  constructor(t) {
+    i(this, "environment");
+    i(this, "client");
+    i(this, "queueUrl");
+    this.environment = t;
+    const e = z[t] ?? t, n = O[e];
+    if (!n)
+      throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${t}"`);
+    this.queueUrl = n, this.client = new S({ region: N });
   }
-  async create(e) {
-    await this.client.send(new w({
+  async create(t) {
+    await this.client.send(new L({
       QueueUrl: this.queueUrl,
-      MessageBody: JSON.stringify(e)
+      MessageBody: JSON.stringify(t)
     }));
   }
 }
-class E {
-  constructor(e) {
-    o(this, "params");
-    o(this, "transport");
-    this.params = e, this.transport = new f(e.environment);
+class x {
+  constructor(t, e = {}) {
+    i(this, "params");
+    i(this, "transport");
+    i(this, "logger");
+    i(this, "metrics");
+    this.params = t, this.transport = e.transport ?? new R(t.environment), this.logger = e.logger ?? M(t.service, t.environment), this.metrics = e.metrics ?? C();
   }
-  async log({ scope: e, account: t, ...a }) {
-    const i = m(), { environment: c, service: g } = this.params, s = {
-      ...a,
-      ...t,
+  async log({ scope: t, account: e, ...n }) {
+    const u = v(), { environment: c, service: g } = this.params, r = {
+      ...n,
+      ...e,
+      service: g,
+      id: u,
+      environment: c,
+      ...t && { scope: t }
+    }, o = {
       service: g,
-      id: i,
       environment: c,
-      ...e && { scope: e }
-    };
+      namespace: r.namespace,
+      event: r.event,
+      target: r.target
+    }, l = Date.now();
     try {
-      await this.transport.create(s);
-    } catch (u) {
-      const n = u.message;
+      await this.transport.create(r), this.metrics.increment("sent", o), this.metrics.histogram("send_duration_ms", Date.now() - l, o), this.logger.debug("audit-log sent", {
+        id: r.id,
+        event: r.event,
+        target: r.target
+      });
+    } catch (h) {
+      this.metrics.increment("send_failed", o), this.metrics.histogram("send_duration_ms", Date.now() - l, o);
+      const m = h.message;
       try {
-        console.error(JSON.stringify({
-          status: "error",
-          namespace: "audit-logs",
-          message: "audit-log write failed",
-          audit_log: s,
-          error: n
-        }));
+        this.logger.error("audit-log write failed", {
+          audit_log: r,
+          error: m
+        });
       } catch {
-        console.error(JSON.stringify({
-          status: "error",
-          namespace: "audit-logs",
-          message: "audit-log write failed (serialization failed)",
-          audit_log_meta: {
-            id: s.id,
-            service: s.service,
-            environment: s.environment,
-            namespace: s.namespace,
-            event: s.event,
-            target: s.target
-          },
-          error: n
-        }));
+        this.metrics.increment("serialization_failed", o);
+        try {
+          this.logger.error("audit-log write failed (serialization failed)", {
+            audit_log_meta: {
+              id: r.id,
+              service: r.service,
+              environment: r.environment,
+              namespace: r.namespace,
+              event: r.event,
+              target: r.target
+            },
+            error: m
+          });
+        } catch {
+        }
       }
     }
   }
 }
 export {
-  E as AuditLogger
+  x as AuditLogger
 };

package/dist/logger.d.ts

@@ -0,0 +1,2 @@
+import { type Logger } from 'winston';
+export declare const createSdkLogger: (service: string, environment: string) => Logger;

package/dist/logger.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/metrics.d.ts

@@ -0,0 +1,15 @@
+export declare const METRIC_PREFIX = "payfit.audit-logs.";
+export type MetricName = 'sent' | 'send_failed' | 'serialization_failed' | 'send_duration_ms';
+export interface MetricTags {
+    service: string;
+    environment: string;
+    namespace?: string;
+    event?: string;
+    target?: string;
+}
+export interface IMetricsClient {
+    increment(name: MetricName, tags: MetricTags): void;
+    histogram(name: MetricName, value: number, tags: MetricTags): void;
+    close(): Promise<void>;
+}
+export declare const createMetricsClient: () => IMetricsClient;

package/dist/metrics.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "3.8.0",
+  "version": "3.10.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",
@@ -27,8 +27,10 @@
   "dependencies": {
     "@aws-sdk/client-sqs": "^3.600.0",
     "axios": "^1.0.0",
+    "hot-shots": "^11.0.0",
     "lodash": "^4.17.20",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "winston": "^3.13.0"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "2.7.0",