@payfit/audit-log 3.5.0-rc.2 → 3.5.0-rc.20

package/README.md

@@ -16,8 +16,7 @@ Then, you must instanciate a client :
 import { AuditLogger } from '@payfit/audit-log'
 
 const logger = new AuditLogger({
-  apiUrl: 'http://localhost:8090',
-  environment: 'an-environment-name',
+  environment: 'dev', // must be one of: dev, staging, prod
   service: 'the-name-of-the-service',
 })
 ```

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
  */
@@ -92,13 +95,21 @@ export interface IAuditLogger {
     log: (data: IAuditLogData) => Promise<void>;
 }
 export interface IAuditLoggerInitialization {
-    apiUrl: string;
+    /** @deprecated No longer used. The library routes via SQS based on `environment`. Kept for backward compatibility. */
+    apiUrl?: string;
     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 P=(s,e,t)=>e in s?d(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var n=(s,e,t)=>(P(s,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("uuid"),h=require("axios"),p="http://localhost:8090".replace(/\/+$/,"");class f{constructor(e,t=p,r=h){n(this,"basePath");n(this,"axios");n(this,"configuration");this.basePath=t,this.axios=r,e&&(this.configuration=e,this.basePath=e.basePath||this.basePath)}}class g extends Error{constructor(t,r){super(r);n(this,"field");n(this,"name","RequiredError");this.field=t}}const A="https://example.com",w=function(s,e,t){if(t==null)throw new g(e,`Required parameter ${e} was null or undefined when calling ${s}.`)},b=function(s,...e){const t=new URLSearchParams(s.search);for(const r of e)for(const o in r)if(Array.isArray(r[o])){t.delete(o);for(const a of r[o])t.append(o,a)}else t.set(o,r[o]);s.search=t.toString()},x=function(s,e,t){const r=typeof s!="string";return(r&&t&&t.isJsonMime?t.isJsonMime(e.headers["Content-Type"]):r)?JSON.stringify(s!==void 0?s:{}):s||""},y=function(s){return s.pathname+s.search+s.hash},L=function(s,e,t,r){return(o=e,a=t)=>{const i={...s.options,url:((r==null?void 0:r.basePath)||a)+s.url};return o.request(i)}},S=function(s){return{v1LogPost:async(e,t={})=>{w("v1LogPost","inlineObject",e);const r="/v1/log",o=new URL(r,A);let a;s&&(a=s.baseOptions);const i={method:"POST",...a,...t},c={},l={};c["Content-Type"]="application/json",b(o,l);let u=a&&a.headers?a.headers:{};return i.headers={...c,...u,...t.headers},i.data=x(e,i,s),{url:y(o),options:i}}}},E=function(s){const e=S(s);return{async v1LogPost(t,r){const o=await e.v1LogPost(t,r);return L(o,h,p,s)}}};class v extends f{v1LogPost(e,t){return E(this.configuration).v1LogPost(e,t).then(r=>r(this.axios,this.basePath))}}const R=s=>"isAxiosError"in s&&s.isAxiosError&&s instanceof Error;class j{constructor(e){n(this,"apiUrl");n(this,"api");this.apiUrl=e,this.api=new v({basePath:this.apiUrl,isJsonMime(t){const r=new RegExp("^(application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(;.*)?$","i");return t!==null&&(r.test(t)||t.toLowerCase()==="application/json-patch+json")}})}async create(e){var t;try{await this.api.v1LogPost(e,{timeout:5e3})}catch(r){if(!R(r))throw r;const o=((t=r.response)==null?void 0:t.data)||r.message;throw new Error(o)}}}class q{constructor(e){n(this,"params");n(this,"transport");this.params=e,this.transport=new j(e.apiUrl)}async log({scope:e,account:t,...r}){const o=m.v4(),{environment:a,service:i}=this.params,c=Math.floor(Date.now()/1e3),l={...r,...t,service:i,id:o,environment:a,timestamp:c,...e&&{scope:e}};await this.transport.create(l)}}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,149 +1,132 @@
-var u = Object.defineProperty;
-var P = (s, e, t) => e in s ? u(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
-var n = (s, e, t) => (P(s, typeof e != "symbol" ? e + "" : e, t), t);
-import { v4 as m } from "uuid";
-import l from "axios";
-const p = "http://localhost:8090".replace(/\/+$/, "");
-class f {
-  constructor(e, t = p, o = l) {
-    n(this, "basePath");
-    n(this, "axios");
-    n(this, "configuration");
-    this.basePath = t, this.axios = o, e && (this.configuration = e, this.basePath = e.basePath || this.basePath);
+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
+    });
   }
-}
-class A extends Error {
-  constructor(t, o) {
-    super(o);
-    n(this, "field");
-    n(this, "name", "RequiredError");
-    this.field = t;
+  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 w = "https://example.com", x = function(s, e, t) {
-  if (t == null)
-    throw new A(e, `Required parameter ${e} was null or undefined when calling ${s}.`);
-}, g = function(s, ...e) {
-  const t = new URLSearchParams(s.search);
-  for (const o of e)
-    for (const r in o)
-      if (Array.isArray(o[r])) {
-        t.delete(r);
-        for (const a of o[r])
-          t.append(r, a);
-      } else
-        t.set(r, o[r]);
-  s.search = t.toString();
-}, b = function(s, e, t) {
-  const o = typeof s != "string";
-  return (o && t && t.isJsonMime ? t.isJsonMime(e.headers["Content-Type"]) : o) ? JSON.stringify(s !== void 0 ? s : {}) : s || "";
-}, y = function(s) {
-  return s.pathname + s.search + s.hash;
-}, E = function(s, e, t, o) {
-  return (r = e, a = t) => {
-    const i = { ...s.options, url: ((o == null ? void 0 : o.basePath) || a) + s.url };
-    return r.request(i);
-  };
-}, L = function(s) {
-  return {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1LogPost: async (e, t = {}) => {
-      x("v1LogPost", "inlineObject", e);
-      const o = "/v1/log", r = new URL(o, w);
-      let a;
-      s && (a = s.baseOptions);
-      const i = { method: "POST", ...a, ...t }, c = {}, h = {};
-      c["Content-Type"] = "application/json", g(r, h);
-      let d = a && a.headers ? a.headers : {};
-      return i.headers = { ...c, ...d, ...t.headers }, i.data = b(e, i, s), {
-        url: y(r),
-        options: i
-      };
-    }
-  };
-}, S = function(s) {
-  const e = L(s);
-  return {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    async v1LogPost(t, o) {
-      const r = await e.v1LogPost(t, o);
-      return E(r, l, p, s);
-    }
-  };
+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"
+}, z = {
+  working: "staging",
+  production: "prod"
 };
-class v extends f {
-  /**
-   *
-   * @summary Creates Audit Log event
-   * @param {InlineObject} inlineObject
-   * @param {*} [options] Override http request option.
-   * @throws {RequiredError}
-   * @memberof DefaultApi
-   */
-  v1LogPost(e, t) {
-    return S(this.configuration).v1LogPost(e, t).then((o) => o(this.axios, this.basePath));
+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(t) {
+    await this.client.send(new L({
+      QueueUrl: this.queueUrl,
+      MessageBody: JSON.stringify(t)
+    }));
   }
 }
-const R = (s) => "isAxiosError" in s && s.isAxiosError && s instanceof Error;
-class U {
-  constructor(e) {
-    n(this, "apiUrl");
-    n(this, "api");
-    this.apiUrl = e, this.api = new v({
-      basePath: this.apiUrl,
-      isJsonMime(t) {
-        const o = new RegExp(
-          // eslint-disable-next-line no-control-regex
-          "^(application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(;.*)?$",
-          "i"
-        );
-        return t !== null && (o.test(t) || t.toLowerCase() === "application/json-patch+json");
-      }
-    });
+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 create(e) {
-    var 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,
+      environment: c,
+      namespace: r.namespace,
+      event: r.event,
+      target: r.target
+    }, l = Date.now();
     try {
-      await this.api.v1LogPost(e, { timeout: 5e3 });
-    } catch (o) {
-      if (!R(o))
-        throw o;
-      const r = ((t = o.response) == null ? void 0 : t.data) || o.message;
-      throw new Error(r);
+      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 {
+        this.logger.error("audit-log write failed", {
+          audit_log: r,
+          error: m
+        });
+      } catch {
+        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 {
+        }
+      }
     }
   }
 }
-class O {
-  constructor(e) {
-    n(this, "params");
-    n(this, "transport");
-    this.params = e, this.transport = new U(e.apiUrl);
-  }
-  async log({ scope: e, account: t, ...o }) {
-    const r = m(), { environment: a, service: i } = this.params, c = Math.floor(Date.now() / 1e3), h = {
-      ...o,
-      ...t,
-      service: i,
-      id: r,
-      environment: a,
-      timestamp: c,
-      ...e && { scope: e }
-    };
-    await this.transport.create(h);
-  }
-}
 export {
-  O as AuditLogger
+  x as AuditLogger
 };

package/dist/index.test.d.ts

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

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/dist/transport/implementation.d.ts

@@ -1,8 +1,8 @@
-import { InlineObject } from './generated/model';
-import { IAuditLogTransport } from './interface';
+import { IAuditLogCreationData, IAuditLogTransport } from './interface';
 export declare class Transport implements IAuditLogTransport {
-    protected apiUrl: string;
-    private api;
-    constructor(apiUrl: string);
-    create(auditLogData: InlineObject): Promise<void>;
+    protected environment: string;
+    private client;
+    private queueUrl;
+    constructor(environment: string);
+    create(auditLogData: IAuditLogCreationData): Promise<void>;
 }

package/dist/transport/implementation.test.d.ts

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

package/dist/transport/interface.d.ts

@@ -1,6 +1,5 @@
 export interface IAuditLogCreationData {
     id: string;
-    timestamp: number;
     environment: string;
     service: string;
     scope?: Record<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "3.5.0-rc.2",
+  "version": "3.5.0-rc.20",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",
@@ -15,6 +15,8 @@
     "build": "rimraf dist && vite build",
     "prepack": "npm run build",
     "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "start:playground": "ts-node src/playground.ts",
     "format:check": "prettier --check .",
     "format:fix": "prettier --write .",
@@ -23,9 +25,12 @@
   "author": "",
   "license": "ISC",
   "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",
@@ -46,13 +51,14 @@
     "semantic-release": "22.0.12",
     "ts-node": "10.9.2",
     "typescript": "5.3.3",
-    "vite": "4.5.1"
+    "vite": "4.5.1",
+    "vitest": "4.1.4"
   },
-  "peerDependencies": {},
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "files": [
     "dist"
-  ]
+  ],
+  "packageManager": "yarn@4.14.1+sha512.64df448055b2d37ba269d7db535a469b8da93f8ef1140c25fd7a83c00a8fbaacb214ca0e02553b92a2c54cef78bb67d0b4817fab02001df0e24fac0faccc3b42"
 }