@payfit/audit-log 3.12.0 → 3.14.0

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 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;
+"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 i=(s,e,t)=>(w(s,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const v=require("uuid"),o=require("winston"),S=require("hot-shots"),h=require("@aws-sdk/client-sqs"),y=require("zlib"),E="audit-logs",_="@payfit/audit-log",q=()=>{const s=process.env.LOG_LEVEL;return s&&s.trim()!==""?s.trim():"info"},L=(s,e)=>o.createLogger({level:q(),silent:process.env.NODE_ENV==="test",exitOnError:!1,defaultMeta:{namespace:E,sdk:_,service:s,environment:e},format:o.format.combine(o.format.timestamp(),o.format.errors({stack:!0}),o.format.json()),transports:[new o.transports.Console]}),M="payfit.audit_logs.",p=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 S.StatsD({prefix:M,errorHandler:()=>{},cacheDns:!0})}increment(e,t){this.client.increment(e,1,p(t))}histogram(e,t,n){this.client.histogram(e,t,p(n))}async close(){await new Promise(e=>{this.client.close(()=>e())})}}const A=()=>new b;function U(s){return y.brotliCompressSync(Buffer.from(s,"utf8")).toString("base64")}function C(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",development:"dev"};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;if(this.queueUrl=z[n],!this.queueUrl){t==null||t.warn("audit-logs SDK: no SQS queue URL configured for this environment, audit logs are disabled",{environment:e});return}this.client=new h.SQSClient({region:O})}async create(e){var n;if(!this.client||!this.queueUrl)return{compressed:!1};const t=JSON.stringify(e);try{return await this.send(t),{compressed:!1}}catch(c){if(!C(c))throw c;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(U(t)),{compressed:!0}}}async send(e){await this.client.send(new h.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??A()}async log({scope:e,account:t,...n}){const c=v.v4(),{environment:g,service:u}=this.params,r={...n,...t,service:u,id:c,environment:g,...e&&{scope:e}},a={service:u,environment:g,namespace:r.namespace,event:r.event,target:r.target},m=Date.now();try{const{compressed:l}=await this.transport.create(r);this.metrics.increment("sent",{...a,compressed:String(l)}),this.metrics.histogram("send_duration_ms",Date.now()-m,a),this.logger.debug("audit-log sent",{id:r.id,event:r.event,target:r.target})}catch(l){this.metrics.increment("send_failed",a),this.metrics.histogram("send_duration_ms",Date.now()-m,a);const d=l.message;try{this.logger.error("audit-log write failed",{audit_log:r,error:d})}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:d})}catch{}}}}}exports.AuditLogger=Q;

package/dist/index.mjs

@@ -6,11 +6,11 @@ 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 M = "audit-logs", A = "@payfit/audit-log", U = () => {
   const s = process.env.LOG_LEVEL;
   return s && s.trim() !== "" ? s.trim() : "info";
-}, U = (s, e) => v({
-  level: C(),
+}, q = (s, e) => v({
+  level: U(),
   silent: process.env.NODE_ENV === "test",
   exitOnError: !1,
   defaultMeta: {
@@ -21,12 +21,12 @@ 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.", h = (s) => Object.entries(s).filter(([, e]) => e !== void 0 && e !== "").map(([e, t]) => `${e}:${String(t)}`);
+}), C = "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 E({
-      prefix: q,
+      prefix: C,
       // Loss of metrics never breaks the caller — DogStatsD UDP is best-effort by design.
       errorHandler: () => {
       },
@@ -58,7 +58,8 @@ const z = "eu-west-3", Q = {
   prod: "https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"
 }, R = {
   working: "staging",
-  production: "prod"
+  production: "prod",
+  development: "dev"
 };
 class k {
   constructor(e, t) {
@@ -67,19 +68,23 @@ class k {
     i(this, "client");
     i(this, "queueUrl");
     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 });
+    const n = R[e] ?? e;
+    if (this.queueUrl = Q[n], !this.queueUrl) {
+      t == null || t.warn("audit-logs SDK: no SQS queue URL configured for this environment, audit logs are disabled", { environment: e });
+      return;
+    }
+    this.client = new _({ region: z });
   }
   async create(e) {
     var n;
+    if (!this.client || !this.queueUrl)
+      return { compressed: !1 };
     const t = JSON.stringify(e);
     try {
       return await this.send(t), { compressed: !1 };
-    } catch (o) {
-      if (!O(o))
-        throw o;
+    } catch (a) {
+      if (!O(a))
+        throw a;
       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 };
     }
   }
@@ -96,43 +101,43 @@ class V {
     i(this, "transport");
     i(this, "logger");
     i(this, "metrics");
-    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();
+    this.params = e, this.logger = t.logger ?? q(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: m, service: l } = this.params, r = {
+    const a = w(), { environment: l, service: g } = this.params, r = {
       ...n,
       ...t,
-      service: l,
-      id: o,
-      environment: m,
+      service: g,
+      id: a,
+      environment: l,
       ...e && { scope: e }
-    }, a = {
-      service: l,
-      environment: m,
+    }, o = {
+      service: g,
+      environment: l,
       namespace: r.namespace,
       event: r.event,
       target: r.target
     }, d = Date.now();
     try {
-      const { compressed: g } = await this.transport.create(r);
+      const { compressed: m } = 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", {
+        ...o,
+        compressed: String(m)
+      }), this.metrics.histogram("send_duration_ms", Date.now() - d, o), this.logger.debug("audit-log sent", {
         id: r.id,
         event: r.event,
         target: r.target
       });
-    } catch (g) {
-      this.metrics.increment("send_failed", a), this.metrics.histogram("send_duration_ms", Date.now() - d, a);
-      const u = g.message;
+    } catch (m) {
+      this.metrics.increment("send_failed", o), this.metrics.histogram("send_duration_ms", Date.now() - d, o);
+      const u = m.message;
       try {
         this.logger.error("audit-log write failed", {
           audit_log: r,
           error: u
         });
       } catch {
-        this.metrics.increment("serialization_failed", a);
+        this.metrics.increment("serialization_failed", o);
         try {
           this.logger.error("audit-log write failed (serialization failed)", {
             audit_log_meta: {

package/dist/transport/implementation.d.ts

@@ -3,8 +3,8 @@ import { IAuditLogCreationData, IAuditLogCreationResult, IAuditLogTransport } fr
 export declare class Transport implements IAuditLogTransport {
     protected environment: string;
     private logger?;
-    private client;
-    private queueUrl;
+    private readonly client;
+    private readonly queueUrl;
     constructor(environment: string, logger?: Logger | undefined);
     create(auditLogData: IAuditLogCreationData): Promise<IAuditLogCreationResult>;
     private send;

package/package.json

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