@payfit/audit-log 3.11.0 → 3.13.0

package/dist/compression.d.ts

@@ -0,0 +1,2 @@
+export declare function compress(input: string): string;
+export declare function decompress(input: string): string;

package/dist/compression.test.d.ts

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

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export type AuditTargets = 'reporting' | 'employee' | 'employee.settings' | 'emp
 /**
  * The allowed Events for the AuditLog
  */
-export type AuditEvents = 'create' | 'update' | 'share' | 'delete' | 'view' | 'sign' | 'signin' | 'signinFail' | 'signinAs' | 'logout' | 'updateCurrentAccount' | 'merge' | 'disable' | 'sendResetPasswordLink' | 'enable' | 'verify' | 'read' | 'write' | 'subscribe' | 'consume' | 'setup' | 'deleteAllAdmins' | 'import';
+export type AuditEvents = 'create' | 'update' | 'share' | 'delete' | 'view' | 'sign' | 'signin' | 'signinFail' | 'signinAs' | 'logout' | 'updateCurrentAccount' | 'merge' | 'disable' | 'sendResetPasswordLink' | 'enable' | 'verify' | 'read' | 'write' | 'subscribe' | 'consume' | 'setup' | 'deleteAllAdmins' | 'import' | 'useAccount';
 /**
  * Data to audit log.
  */

package/dist/index.js

@@ -1 +1 @@
-"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;
+"use strict";var f=Object.defineProperty;var w=(s,e,t)=>e in s?f(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var n=(s,e,t)=>(w(s,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const S=require("uuid"),a=require("winston"),v=require("hot-shots"),h=require("@aws-sdk/client-sqs"),E=require("zlib"),y="audit-logs",_="@payfit/audit-log",q=()=>{const s=process.env.LOG_LEVEL;return s&&s.trim()!==""?s.trim():"info"},L=(s,e)=>a.createLogger({level:q(),silent:process.env.NODE_ENV==="test",exitOnError:!1,defaultMeta:{namespace:y,sdk:_,service:s,environment:e},format:a.format.combine(a.format.timestamp(),a.format.errors({stack:!0}),a.format.json()),transports:[new a.transports.Console]}),M="payfit.audit_logs.",p=s=>Object.entries(s).filter(([,e])=>e!==void 0&&e!=="").map(([e,t])=>`${e}:${String(t)}`);class A{constructor(){n(this,"client");this.client=new v.StatsD({prefix:M,errorHandler:()=>{},cacheDns:!0})}increment(e,t){this.client.increment(e,1,p(t))}histogram(e,t,i){this.client.histogram(e,t,p(i))}async close(){await new Promise(e=>{this.client.close(()=>e())})}}const b=()=>new A;function C(s){return E.brotliCompressSync(Buffer.from(s,"utf8")).toString("base64")}function U(s){return s instanceof Error&&s.message.includes("Message must be shorter than")}const O="eu-west-3",z={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"},D={working:"staging",production:"prod"};class N{constructor(e,t){n(this,"environment");n(this,"logger");n(this,"client");n(this,"queueUrl");this.environment=e,this.logger=t;const i=D[e]??e,o=z[i];if(!o)throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);this.queueUrl=o,this.client=new h.SQSClient({region:O})}async create(e){var i;const t=JSON.stringify(e);try{return await this.send(t),{compressed:!1}}catch(o){if(!U(o))throw o;return(i=this.logger)==null||i.info("audit-log payload exceeds the SQS size limit, retrying with Brotli compression",{id:e.id,namespace:e.namespace}),await this.send(C(t)),{compressed:!0}}}async send(e){await this.client.send(new h.SendMessageCommand({QueueUrl:this.queueUrl,MessageBody:e}))}}class Q{constructor(e,t={}){n(this,"params");n(this,"transport");n(this,"logger");n(this,"metrics");this.params=e,this.logger=t.logger??L(e.service,e.environment),this.transport=t.transport??new N(e.environment,this.logger),this.metrics=t.metrics??b()}async log({scope:e,account:t,...i}){const o=S.v4(),{environment:l,service:m}=this.params,r={...i,...t,service:m,id:o,environment:l,...e&&{scope:e}},c={service:m,environment:l,namespace:r.namespace,event:r.event,target:r.target},u=Date.now();try{const{compressed:g}=await this.transport.create(r);this.metrics.increment("sent",{...c,compressed:String(g)}),this.metrics.histogram("send_duration_ms",Date.now()-u,c),this.logger.debug("audit-log sent",{id:r.id,event:r.event,target:r.target})}catch(g){this.metrics.increment("send_failed",c),this.metrics.histogram("send_duration_ms",Date.now()-u,c);const d=g.message;try{this.logger.error("audit-log write failed",{audit_log:r,error:d})}catch{this.metrics.increment("serialization_failed",c);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:d})}catch{}}}}}exports.AuditLogger=Q;

package/dist/index.mjs

@@ -1,114 +1,138 @@
 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 = () => {
+var f = (s, e, t) => e in s ? p(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
+var i = (s, e, t) => (f(s, typeof e != "symbol" ? e + "" : e, t), t);
+import { v4 as w } from "uuid";
+import { createLogger as v, format as c, transports as S } from "winston";
+import { StatsD as E } from "hot-shots";
+import { SQSClient as _, SendMessageCommand as y } from "@aws-sdk/client-sqs";
+import { brotliCompressSync as L } from "zlib";
+const M = "audit-logs", A = "@payfit/audit-log", C = () => {
   const s = process.env.LOG_LEVEL;
   return s && s.trim() !== "" ? s.trim() : "info";
-}, M = (s, t) => f({
-  level: D(),
+}, U = (s, e) => v({
+  level: C(),
   silent: process.env.NODE_ENV === "test",
   exitOnError: !1,
   defaultMeta: {
-    namespace: y,
+    namespace: M,
     sdk: A,
     service: s,
-    environment: t
+    environment: e
   },
-  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 {
+  format: c.combine(c.timestamp(), c.errors({ stack: !0 }), c.json()),
+  transports: [new S.Console()]
+}), q = "payfit.audit_logs.", h = (s) => Object.entries(s).filter(([, e]) => e !== void 0 && e !== "").map(([e, t]) => `${e}:${String(t)}`);
+class b {
   constructor() {
     i(this, "client");
-    this.client = new _({
-      prefix: U,
+    this.client = new E({
+      prefix: q,
       // 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));
+  increment(e, t) {
+    this.client.increment(e, 1, h(t));
   }
-  histogram(t, e, n) {
-    this.client.histogram(t, e, d(n));
+  histogram(e, t, n) {
+    this.client.histogram(e, t, h(n));
   }
   async close() {
-    await new Promise((t) => {
-      this.client.close(() => t());
+    await new Promise((e) => {
+      this.client.close(() => e());
     });
   }
 }
-const C = () => new q(), N = "eu-west-3", O = {
+const D = () => new b();
+function N(s) {
+  return L(Buffer.from(s, "utf8")).toString("base64");
+}
+function O(s) {
+  return s instanceof Error && s.message.includes("Message must be shorter than");
+}
+const z = "eu-west-3", Q = {
   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"
-}, z = {
+}, R = {
   working: "staging",
   production: "prod"
 };
-class R {
-  constructor(t) {
+class k {
+  constructor(e, t) {
     i(this, "environment");
+    i(this, "logger");
     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 });
+    this.environment = e, this.logger = t;
+    const n = R[e] ?? e, o = Q[n];
+    if (!o)
+      throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);
+    this.queueUrl = o, this.client = new _({ region: z });
+  }
+  async create(e) {
+    var n;
+    const t = JSON.stringify(e);
+    try {
+      return await this.send(t), { compressed: !1 };
+    } catch (o) {
+      if (!O(o))
+        throw o;
+      return (n = this.logger) == null || n.info("audit-log payload exceeds the SQS size limit, retrying with Brotli compression", { id: e.id, namespace: e.namespace }), await this.send(N(t)), { compressed: !0 };
+    }
   }
-  async create(t) {
-    await this.client.send(new L({
+  async send(e) {
+    await this.client.send(new y({
       QueueUrl: this.queueUrl,
-      MessageBody: JSON.stringify(t)
+      MessageBody: e
     }));
   }
 }
-class x {
-  constructor(t, e = {}) {
+class V {
+  constructor(e, t = {}) {
     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();
+    this.params = e, this.logger = t.logger ?? U(e.service, e.environment), this.transport = t.transport ?? new k(e.environment, this.logger), this.metrics = t.metrics ?? D();
   }
-  async log({ scope: t, account: e, ...n }) {
-    const u = v(), { environment: c, service: g } = this.params, r = {
+  async log({ scope: e, account: t, ...n }) {
+    const o = w(), { environment: m, service: l } = this.params, r = {
       ...n,
-      ...e,
-      service: g,
-      id: u,
-      environment: c,
-      ...t && { scope: t }
-    }, o = {
-      service: g,
-      environment: c,
+      ...t,
+      service: l,
+      id: o,
+      environment: m,
+      ...e && { scope: e }
+    }, a = {
+      service: l,
+      environment: m,
       namespace: r.namespace,
       event: r.event,
       target: r.target
-    }, l = Date.now();
+    }, d = Date.now();
     try {
-      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", {
+      const { compressed: g } = await this.transport.create(r);
+      this.metrics.increment("sent", {
+        ...a,
+        compressed: String(g)
+      }), this.metrics.histogram("send_duration_ms", Date.now() - d, a), 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;
+    } catch (g) {
+      this.metrics.increment("send_failed", a), this.metrics.histogram("send_duration_ms", Date.now() - d, a);
+      const u = g.message;
       try {
         this.logger.error("audit-log write failed", {
           audit_log: r,
-          error: m
+          error: u
         });
       } catch {
-        this.metrics.increment("serialization_failed", o);
+        this.metrics.increment("serialization_failed", a);
         try {
           this.logger.error("audit-log write failed (serialization failed)", {
             audit_log_meta: {
@@ -119,7 +143,7 @@ class x {
               event: r.event,
               target: r.target
             },
-            error: m
+            error: u
           });
         } catch {
         }
@@ -128,5 +152,5 @@ class x {
   }
 }
 export {
-  x as AuditLogger
+  V as AuditLogger
 };

package/dist/metrics.d.ts

@@ -1,4 +1,4 @@
-export declare const METRIC_PREFIX = "payfit.audit-logs.";
+export declare const METRIC_PREFIX = "payfit.audit_logs.";
 export type MetricName = 'sent' | 'send_failed' | 'serialization_failed' | 'send_duration_ms';
 export interface MetricTags {
     service: string;
@@ -6,6 +6,7 @@ export interface MetricTags {
     namespace?: string;
     event?: string;
     target?: string;
+    compressed?: string;
 }
 export interface IMetricsClient {
     increment(name: MetricName, tags: MetricTags): void;

package/dist/transport/implementation.d.ts

@@ -1,8 +1,11 @@
-import { IAuditLogCreationData, IAuditLogTransport } from './interface';
+import type { Logger } from 'winston';
+import { IAuditLogCreationData, IAuditLogCreationResult, IAuditLogTransport } from './interface';
 export declare class Transport implements IAuditLogTransport {
     protected environment: string;
+    private logger?;
     private client;
     private queueUrl;
-    constructor(environment: string);
-    create(auditLogData: IAuditLogCreationData): Promise<void>;
+    constructor(environment: string, logger?: Logger | undefined);
+    create(auditLogData: IAuditLogCreationData): Promise<IAuditLogCreationResult>;
+    private send;
 }

package/dist/transport/interface.d.ts

@@ -20,6 +20,9 @@ export interface IAuditLogCreationData {
     specialRole?: string;
     email?: string;
 }
+export interface IAuditLogCreationResult {
+    compressed: boolean;
+}
 export interface IAuditLogTransport {
-    create: (data: IAuditLogCreationData) => Promise<void>;
+    create: (data: IAuditLogCreationData) => Promise<IAuditLogCreationResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "3.11.0",
+  "version": "3.13.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",