@payfit/audit-log 3.5.0-rc.22 → 3.5.0-rc.24

package/dist/index.js

@@ -1 +1 @@
-"use strict";var w=Object.defineProperty;var p=(s,e,t)=>e in s?w(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var i=(s,e,t)=>(p(s,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const v=require("uuid"),a=require("winston"),S=require("hot-shots"),d=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.",h=s=>Object.entries(s).filter(([,e])=>e!==void 0&&e!=="").map(([e,t])=>`${e}:${String(t)}`);class A{constructor(){i(this,"client");this.client=new S.StatsD({prefix:M,errorHandler:()=>{},cacheDns:!0})}increment(e,t){this.client.increment(e,1,h(t))}histogram(e,t,n){this.client.histogram(e,t,h(n))}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){i(this,"environment");i(this,"logger");i(this,"client");i(this,"queueUrl");this.environment=e,this.logger=t;const n=D[e]??e,o=z[n];if(!o)throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);this.queueUrl=o,this.client=new d.SQSClient({region:O})}async create(e){var n;const t=JSON.stringify(e);try{await this.send(t)}catch(o){if(!U(o))throw o;(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(C(t))}}async send(e){await this.client.send(new d.SendMessageCommand({QueueUrl:this.queueUrl,MessageBody:e}))}}class Q{constructor(e,t={}){i(this,"params");i(this,"transport");i(this,"logger");i(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,...n}){const o=v.v4(),{environment:g,service:l}=this.params,r={...n,...t,service:l,id:o,environment:g,...e&&{scope:e}},c={service:l,environment:g,namespace:r.namespace,event:r.event,target:r.target},m=Date.now();try{await this.transport.create(r),this.metrics.increment("sent",c),this.metrics.histogram("send_duration_ms",Date.now()-m,c),this.logger.debug("audit-log sent",{id:r.id,event:r.event,target:r.target})}catch(f){this.metrics.increment("send_failed",c),this.metrics.histogram("send_duration_ms",Date.now()-m,c);const u=f.message;try{this.logger.error("audit-log write failed",{audit_log:r,error:u})}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:u})}catch{}}}}}exports.AuditLogger=Q;
+"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

@@ -21,7 +21,7 @@ const M = "audit-logs", A = "@payfit/audit-log", C = () => {
   },
   format: c.combine(c.timestamp(), c.errors({ stack: !0 }), c.json()),
   transports: [new S.Console()]
-}), q = "payfit.audit-logs.", u = (s) => Object.entries(s).filter(([, e]) => e !== void 0 && e !== "").map(([e, t]) => `${e}:${String(t)}`);
+}), 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");
@@ -34,10 +34,10 @@ class b {
     });
   }
   increment(e, t) {
-    this.client.increment(e, 1, u(t));
+    this.client.increment(e, 1, h(t));
   }
   histogram(e, t, n) {
-    this.client.histogram(e, t, u(n));
+    this.client.histogram(e, t, h(n));
   }
   async close() {
     await new Promise((e) => {
@@ -76,11 +76,11 @@ class k {
     var n;
     const t = JSON.stringify(e);
     try {
-      await this.send(t);
+      return await this.send(t), { compressed: !1 };
     } catch (o) {
       if (!O(o))
         throw o;
-      (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));
+      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 send(e) {
@@ -99,33 +99,37 @@ class V {
     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: e, account: t, ...n }) {
-    const o = w(), { environment: g, service: l } = this.params, r = {
+    const o = w(), { environment: m, service: l } = this.params, r = {
       ...n,
       ...t,
       service: l,
       id: o,
-      environment: g,
+      environment: m,
       ...e && { scope: e }
     }, a = {
       service: l,
-      environment: g,
+      environment: m,
       namespace: r.namespace,
       event: r.event,
       target: r.target
-    }, m = Date.now();
+    }, d = Date.now();
     try {
-      await this.transport.create(r), this.metrics.increment("sent", a), this.metrics.histogram("send_duration_ms", Date.now() - m, a), 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", a), this.metrics.histogram("send_duration_ms", Date.now() - m, a);
-      const d = 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: d
+          error: u
         });
       } catch {
         this.metrics.increment("serialization_failed", a);
@@ -139,7 +143,7 @@ class V {
               event: r.event,
               target: r.target
             },
-            error: d
+            error: u
           });
         } catch {
         }

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,11 +1,11 @@
 import type { Logger } from 'winston';
-import { IAuditLogCreationData, IAuditLogTransport } from './interface';
+import { IAuditLogCreationData, IAuditLogCreationResult, IAuditLogTransport } from './interface';
 export declare class Transport implements IAuditLogTransport {
     protected environment: string;
     private logger?;
     private client;
     private queueUrl;
     constructor(environment: string, logger?: Logger | undefined);
-    create(auditLogData: IAuditLogCreationData): Promise<void>;
+    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.5.0-rc.22",
+  "version": "3.5.0-rc.24",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",