opticedge-cloud-utils 1.1.21 → 1.1.23

package/dist/{src/index.d.ts → index.d.ts}

@@ -6,6 +6,7 @@ export * from './tw/wallet';
 export * from './auth';
 export * from './chunk';
 export * from './env';
+export * from './logger';
 export * from './number';
 export * from './parser';
 export * from './pub';

package/dist/{src/index.js → index.js}

@@ -22,6 +22,7 @@ __exportStar(require("./tw/wallet"), exports);
 __exportStar(require("./auth"), exports);
 __exportStar(require("./chunk"), exports);
 __exportStar(require("./env"), exports);
+__exportStar(require("./logger"), exports);
 __exportStar(require("./number"), exports);
 __exportStar(require("./parser"), exports);
 __exportStar(require("./pub"), exports);

package/dist/logger.d.ts

@@ -0,0 +1,8 @@
+export declare enum LogLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARNING = "WARNING",
+    ERROR = "ERROR",
+    CRITICAL = "CRITICAL"
+}
+export declare function log(level: LogLevel, message: string, metadata?: Record<string, any>): void;

package/dist/logger.js

@@ -0,0 +1,53 @@
+"use strict";
+// src/logger.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+exports.log = log;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "DEBUG";
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARNING"] = "WARNING";
+    LogLevel["ERROR"] = "ERROR";
+    LogLevel["CRITICAL"] = "CRITICAL";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+function log(level, message, metadata = {}) {
+    const payload = {
+        severity: level,
+        message,
+        ...sanitize(metadata)
+    };
+    // IMPORTANT: must be single-line JSON for Cloud Logging
+    console.log(JSON.stringify(payload));
+}
+/**
+ * Makes metadata JSON-safe:
+ * - ObjectId works automatically (mongodb@7)
+ * - Error objects become structured
+ * - BigInt becomes string
+ */
+function sanitize(obj) {
+    const safe = {};
+    for (const [key, value] of Object.entries(obj)) {
+        if (value instanceof Error) {
+            safe[key] = {
+                name: value.name,
+                message: value.message,
+                stack: value.stack
+            };
+            continue;
+        }
+        if (typeof value === 'bigint') {
+            safe[key] = value.toString();
+            continue;
+        }
+        try {
+            JSON.stringify(value);
+            safe[key] = value;
+        }
+        catch {
+            safe[key] = String(value);
+        }
+    }
+    return safe;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opticedge-cloud-utils",
-  "version": "1.1.21",
+  "version": "1.1.23",
   "description": "Common utilities for cloud functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -6,6 +6,7 @@ export * from './tw/wallet'
 export * from './auth'
 export * from './chunk'
 export * from './env'
+export * from './logger'
 export * from './number'
 export * from './parser'
 export * from './pub'

package/src/logger.ts

@@ -0,0 +1,55 @@
+// src/logger.ts
+
+export enum LogLevel {
+  DEBUG = 'DEBUG',
+  INFO = 'INFO',
+  WARNING = 'WARNING',
+  ERROR = 'ERROR',
+  CRITICAL = 'CRITICAL'
+}
+
+export function log(level: LogLevel, message: string, metadata: Record<string, any> = {}): void {
+  const payload = {
+    severity: level,
+    message,
+    ...sanitize(metadata)
+  }
+
+  // IMPORTANT: must be single-line JSON for Cloud Logging
+  console.log(JSON.stringify(payload))
+}
+
+/**
+ * Makes metadata JSON-safe:
+ * - ObjectId works automatically (mongodb@7)
+ * - Error objects become structured
+ * - BigInt becomes string
+ */
+function sanitize(obj: Record<string, any>): Record<string, any> {
+  const safe: Record<string, any> = {}
+
+  for (const [key, value] of Object.entries(obj)) {
+    if (value instanceof Error) {
+      safe[key] = {
+        name: value.name,
+        message: value.message,
+        stack: value.stack
+      }
+      continue
+    }
+
+    if (typeof value === 'bigint') {
+      safe[key] = value.toString()
+      continue
+    }
+
+    try {
+      JSON.stringify(value)
+      safe[key] = value
+    } catch {
+      safe[key] = String(value)
+    }
+  }
+
+  return safe
+}

package/tests/logger.test.ts

@@ -0,0 +1,116 @@
+import { log, LogLevel } from '../src/logger'
+import { ObjectId } from 'mongodb'
+
+describe('logger.ts (100% coverage)', () => {
+  let consoleSpy: jest.SpyInstance
+
+  beforeEach(() => {
+    consoleSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+  })
+
+  afterEach(() => {
+    consoleSpy.mockRestore()
+  })
+
+  // ------------------------------------------------------------
+  // Basic log levels
+  // ------------------------------------------------------------
+
+  it('logs INFO correctly', () => {
+    log(LogLevel.INFO, 'Test message', { foo: 'bar' })
+
+    expect(consoleSpy).toHaveBeenCalledTimes(1)
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+    expect(output).toEqual({
+      severity: 'INFO',
+      message: 'Test message',
+      foo: 'bar'
+    })
+  })
+
+  it('logs all LogLevel values', () => {
+    for (const level of Object.values(LogLevel)) {
+      log(level, 'Level test')
+      const output = JSON.parse(consoleSpy.mock.calls.pop()?.[0])
+      expect(output.severity).toBe(level)
+    }
+  })
+
+  // ------------------------------------------------------------
+  // ObjectId handling
+  // ------------------------------------------------------------
+
+  it('serializes ObjectId correctly', () => {
+    const id = new ObjectId()
+
+    log(LogLevel.INFO, 'ObjectId test', { id })
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+
+    expect(output.id).toBe(id.toHexString())
+  })
+
+  // ------------------------------------------------------------
+  // Error handling
+  // ------------------------------------------------------------
+
+  it('serializes Error objects correctly', () => {
+    const error = new Error('Boom')
+
+    log(LogLevel.ERROR, 'Error test', { error })
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+
+    expect(output.error).toMatchObject({
+      name: 'Error',
+      message: 'Boom'
+    })
+
+    expect(output.error.stack).toBeDefined()
+  })
+
+  // ------------------------------------------------------------
+  // BigInt handling
+  // ------------------------------------------------------------
+
+  it('converts BigInt to string', () => {
+    const big = BigInt(123456789)
+
+    log(LogLevel.INFO, 'BigInt test', { big })
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+
+    expect(output.big).toBe('123456789')
+  })
+
+  // ------------------------------------------------------------
+  // Fallback serialization branch
+  // ------------------------------------------------------------
+
+  it('falls back to string for unserializable values', () => {
+    const circular: any = {}
+    circular.self = circular
+
+    log(LogLevel.INFO, 'Circular test', { circular })
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+
+    expect(output.circular).toBe('[object Object]')
+  })
+
+  // ------------------------------------------------------------
+  // No metadata case
+  // ------------------------------------------------------------
+
+  it('works without metadata', () => {
+    log(LogLevel.WARNING, 'No metadata')
+
+    const output = JSON.parse(consoleSpy.mock.calls[0][0])
+
+    expect(output).toEqual({
+      severity: 'WARNING',
+      message: 'No metadata'
+    })
+  })
+})

package/tsconfig.json

@@ -12,6 +12,6 @@
     "forceConsistentCasingInFileNames": true,
     "types": ["node", "jest"]
   },
-  "include": ["src", "tests"],
+  "include": ["src"],
   "exclude": ["node_modules", "dist"]
 }

package/dist/tests/auth.test.d.ts

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

package/dist/tests/auth.test.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const auth_1 = require("../src/auth");
-// Mock the google-auth-library
-jest.mock('google-auth-library', () => {
-    return {
-        OAuth2Client: jest.fn().mockImplementation(() => ({
-            verifyIdToken: jest.fn(({ idToken, audience }) => {
-                if (idToken === 'valid-token' && audience === 'audience') {
-                    return {
-                        getPayload: () => ({
-                            email: 'allowed@example.com'
-                        })
-                    };
-                }
-                else if (idToken === 'wrong-email-token' && audience === 'audience') {
-                    return {
-                        getPayload: () => ({
-                            email: 'unauthorized@example.com'
-                        })
-                    };
-                }
-                throw new Error('Invalid token');
-            })
-        }))
-    };
-});
-describe('verifyRequest', () => {
-    it('returns true for valid token and matching email', async () => {
-        const mockReq = {
-            headers: {
-                authorization: 'Bearer valid-token'
-            }
-        };
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const result = await (0, auth_1.verifyRequest)(mockReq, {
-            allowedAudience: 'audience',
-            allowedServiceAccount: 'allowed@example.com'
-        });
-        expect(result).toBe(true);
-    });
-    it('returns false for invalid token', async () => {
-        const mockReq = {
-            headers: {
-                authorization: 'Bearer invalid-token'
-            }
-        };
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const result = await (0, auth_1.verifyRequest)(mockReq, {
-            allowedAudience: 'audience',
-            allowedServiceAccount: 'allowed@example.com'
-        });
-        expect(result).toBe(false);
-    });
-    it('returns false for missing authorization header', async () => {
-        const mockReq = {
-            headers: {}
-        };
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const result = await (0, auth_1.verifyRequest)(mockReq, {
-            allowedAudience: 'audience',
-            allowedServiceAccount: 'allowed@example.com'
-        });
-        expect(result).toBe(false);
-    });
-    it('returns false for incorrect email', async () => {
-        const mockReq = {
-            headers: {
-                authorization: 'Bearer wrong-email-token'
-            }
-        };
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const result = await (0, auth_1.verifyRequest)(mockReq, {
-            allowedAudience: 'audience',
-            allowedServiceAccount: 'allowed@example.com'
-        });
-        expect(result).toBe(false);
-    });
-});

package/dist/tests/chunk.test.d.ts

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

package/dist/tests/chunk.test.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chunk_1 = require("../src/chunk");
-describe('chunkByBytes', () => {
-    test('splits array into chunks based on byte size', () => {
-        const arr = [
-            { id: 'a', val: 'x'.repeat(100) },
-            { id: 'b', val: 'y'.repeat(100) },
-            { id: 'c', val: 'z'.repeat(100) }
-        ];
-        const chunks = (0, chunk_1.chunkByBytes)(arr, 200); // 200 bytes max per chunk
-        expect(chunks.length).toBeGreaterThan(1); // should split
-        expect(chunks.flat()).toEqual(arr); // all items present
-    });
-    test('puts single large item in its own chunk', () => {
-        const arr = [{ id: 'big', val: 'x'.repeat(1000) }];
-        const chunks = (0, chunk_1.chunkByBytes)(arr, 100);
-        expect(chunks).toEqual([arr]); // large item pushed alone
-    });
-    test('does not split if all items fit within maxBytes', () => {
-        const arr = [
-            { id: 'a', val: 'x' },
-            { id: 'b', val: 'y' }
-        ];
-        const chunks = (0, chunk_1.chunkByBytes)(arr, 1000);
-        expect(chunks).toEqual([arr]);
-    });
-    test('uses default maxBytes if not provided', () => {
-        const arr = [{ id: 'a', val: 'x'.repeat(10) }];
-        // call without maxBytes
-        const chunks = (0, chunk_1.chunkByBytes)(arr);
-        expect(chunks.flat()).toEqual(arr); // all items present
-    });
-    test('flushes current chunk when a single item exceeds maxBytes', () => {
-        const arr = [
-            { id: '1', val: 'x'.repeat(50) }, // first small item
-            { id: '2', val: 'y'.repeat(200) } // oversized item
-        ];
-        // set maxBytes small enough to trigger oversized item
-        const chunks = (0, chunk_1.chunkByBytes)(arr, 100);
-        expect(chunks.length).toBe(2); // first small chunk + oversized item alone
-        expect(chunks[0]).toEqual([arr[0]]); // first item in first chunk
-        expect(chunks[1]).toEqual([arr[1]]); // second item alone
-    });
-});

package/dist/tests/db/mongo.test.d.ts

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

package/dist/tests/db/mongo.test.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const mongo_1 = require("../../src/db/mongo");
-const mongodb_1 = require("mongodb");
-jest.mock('mongodb');
-const mockDb = {
-    collection: jest.fn()
-};
-const mockConnect = jest.fn();
-const mockClient = {
-    connect: mockConnect,
-    db: jest.fn().mockReturnValue(mockDb)
-};
-beforeEach(() => {
-    jest.clearAllMocks();
-    mongodb_1.MongoClient.mockImplementation(() => mockClient);
-});
-describe('Mongo Utils', () => {
-    it('should connect to MongoDB and store client/db', async () => {
-        await (0, mongo_1.connectToMongo)('mongo-uri', 'test-db');
-        expect(mockConnect).toHaveBeenCalled();
-        expect(mockClient.db).toHaveBeenCalledWith('test-db');
-    });
-    it('should return a collection when db is initialized', async () => {
-        await (0, mongo_1.connectToMongo)('mongo-uri', 'test-db');
-        (0, mongo_1.getCollection)('users');
-        expect(mockDb.collection).toHaveBeenCalledWith('users');
-    });
-    it('getDb should return the initialized Db instance', async () => {
-        await (0, mongo_1.connectToMongo)('mongo-uri', 'test-db');
-        const got = (0, mongo_1.getDb)();
-        expect(got).toBe(mockDb);
-    });
-    it('should throw error if db is not initialized (getCollection/getDb)', () => {
-        jest.isolateModules(() => {
-            // require a fresh copy of the module so module-level state is uninitialized
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            const mod = require('../../src/db/mongo');
-            expect(() => mod.getCollection('users')).toThrow(/Mongo not initialized/);
-            expect(() => mod.getDb()).toThrow(/Mongo not initialized/);
-        });
-    });
-});

package/dist/tests/db/mongo2.test.d.ts

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

package/dist/tests/db/mongo2.test.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const mongo2_1 = require("../../src/db/mongo2");
-const mongodb_1 = require("mongodb");
-jest.mock('mongodb');
-const mockDb = {
-    collection: jest.fn()
-};
-const mockConnect = jest.fn();
-const mockClient = {
-    connect: mockConnect,
-    db: jest.fn().mockReturnValue(mockDb)
-};
-beforeEach(() => {
-    jest.clearAllMocks();
-    mongodb_1.MongoClient.mockImplementation(() => mockClient);
-});
-describe('Mongo Utils', () => {
-    it('should connect to MongoDB and store client', async () => {
-        await (0, mongo2_1.connectToMongo2)('mongo-uri');
-        expect(mockConnect).toHaveBeenCalled();
-    });
-    it('should return a Db instance when client is initialized', async () => {
-        await (0, mongo2_1.connectToMongo2)('mongo-uri');
-        const db = (0, mongo2_1.getDb2)('test-db');
-        expect(mockClient.db).toHaveBeenCalledWith('test-db');
-        expect(db).toBe(mockDb);
-    });
-    it('should return a collection when client is initialized', async () => {
-        await (0, mongo2_1.connectToMongo2)('mongo-uri');
-        (0, mongo2_1.getCollection2)('test-db', 'users');
-        expect(mockClient.db).toHaveBeenCalledWith('test-db');
-        expect(mockDb.collection).toHaveBeenCalledWith('users');
-    });
-    it('should throw error if client is not initialized (getDb)', () => {
-        jest.isolateModules(() => {
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            const { getDb2 } = require('../../src/db/mongo2');
-            expect(() => getDb2('test-db')).toThrow('Mongo not initialized');
-        });
-    });
-    it('should throw error if client is not initialized (getCollection)', () => {
-        jest.isolateModules(() => {
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            const { getCollection2 } = require('../../src/db/mongo2');
-            expect(() => getCollection2('test-db', 'users')).toThrow('Mongo not initialized');
-        });
-    });
-});

package/dist/tests/db/mongo3.test.d.ts

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

package/dist/tests/db/mongo3.test.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const mongo3_1 = require("../../src/db/mongo3");
-const mongodb_1 = require("mongodb");
-jest.mock('mongodb');
-const mockDb = {
-    collection: jest.fn()
-};
-const mockConnect = jest.fn();
-const mockClient = {
-    connect: mockConnect,
-    db: jest.fn().mockReturnValue(mockDb)
-};
-beforeEach(() => {
-    jest.clearAllMocks();
-    mongo3_1.__mongoClients.clear();
-    mongo3_1.__connectPromises.clear();
-    mongodb_1.MongoClient.mockImplementation(() => mockClient);
-});
-describe('MongoClientManager (multi-cluster)', () => {
-    const clusterAUri = 'clusterA-uri';
-    const clusterBUri = 'clusterB-uri';
-    it('should connect and cache client for a single cluster', async () => {
-        await (0, mongo3_1.connectToMongo3)(clusterAUri);
-        expect(mockConnect).toHaveBeenCalled();
-        const db = (0, mongo3_1.getDb3)(clusterAUri, 'test-db');
-        expect(mockClient.db).toHaveBeenCalledWith('test-db');
-        expect(db).toBe(mockDb);
-    });
-    it('should reuse client if already connected', async () => {
-        await (0, mongo3_1.connectToMongo3)(clusterAUri);
-        await (0, mongo3_1.connectToMongo3)(clusterAUri);
-        expect(mockConnect).toHaveBeenCalledTimes(1);
-    });
-    it('should connect and cache separate clients for multiple clusters', async () => {
-        await (0, mongo3_1.connectToMongo3)(clusterAUri);
-        await (0, mongo3_1.connectToMongo3)(clusterBUri);
-        expect(mockConnect).toHaveBeenCalledTimes(2);
-    });
-    it('should return a collection when client is initialized', async () => {
-        await (0, mongo3_1.connectToMongo3)(clusterAUri);
-        (0, mongo3_1.getCollection3)(clusterAUri, 'test-db', 'users');
-        expect(mockClient.db).toHaveBeenCalledWith('test-db');
-        expect(mockDb.collection).toHaveBeenCalledWith('users');
-    });
-    it('should throw error if client not initialized (getDb)', () => {
-        jest.isolateModules(() => {
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            const { getDb3 } = require('../../src/db/mongo3');
-            expect(() => getDb3('unknown-uri', 'some-db')).toThrow('Mongo client not initialized');
-        });
-    });
-    it('should throw error if client not initialized (getCollection)', () => {
-        jest.isolateModules(() => {
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            const { getCollection3 } = require('../../src/db/mongo3');
-            expect(() => getCollection3('unknown-uri', 'some-db', 'users')).toThrow('Mongo client not initialized');
-        });
-    });
-});

package/dist/tests/env.test.d.ts

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

package/dist/tests/env.test.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const env_1 = require("../src/env");
-describe('getEnv', () => {
-    it('returns the value of an existing env var', () => {
-        process.env.TEST_KEY = 'test-value';
-        expect((0, env_1.getEnv)('TEST_KEY')).toBe('test-value');
-    });
-    it('returns fallback if env var is not set', () => {
-        delete process.env.OPTIONAL_KEY;
-        expect((0, env_1.getEnv)('OPTIONAL_KEY', 'default')).toBe('default');
-    });
-    it('throws error if env var is not set and no fallback provided', () => {
-        delete process.env.MISSING_KEY;
-        expect(() => (0, env_1.getEnv)('MISSING_KEY')).toThrow('Missing env var MISSING_KEY');
-    });
-});

package/dist/tests/number.test.d.ts

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

package/dist/tests/number.test.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const number_1 = require("../src/number");
-describe('round1', () => {
-    it('rounds down correctly', () => {
-        expect((0, number_1.round1)(4.21)).toBe(4.2);
-        expect((0, number_1.round1)(4.24)).toBe(4.2);
-    });
-    it('rounds up correctly', () => {
-        expect((0, number_1.round1)(4.25)).toBe(4.3);
-        expect((0, number_1.round1)(4.26)).toBe(4.3);
-    });
-    it('handles floating point precision issues', () => {
-        expect((0, number_1.round1)(1.005)).toBe(1.0); // classic float issue
-        expect((0, number_1.round1)(2.675)).toBe(2.7);
-    });
-    it('handles negative numbers', () => {
-        expect((0, number_1.round1)(-4.24)).toBe(-4.2);
-        expect((0, number_1.round1)(-4.25)).toBe(-4.2); // JS rounds toward +∞ for halves
-        expect((0, number_1.round1)(-4.26)).toBe(-4.3);
-    });
-    it('handles zero', () => {
-        expect((0, number_1.round1)(0)).toBe(0);
-        expect((0, number_1.round1)(0.04)).toBe(0);
-        expect((0, number_1.round1)(0.05)).toBe(0.1);
-    });
-    it('handles large numbers', () => {
-        expect((0, number_1.round1)(123456.789)).toBe(123456.8);
-    });
-});

package/dist/tests/parser.test.d.ts

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

package/dist/tests/parser.test.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = require("../src");
-describe('toNumber', () => {
-    it('returns the same number when input is a finite number', () => {
-        expect((0, src_1.toNumber)(123)).toBe(123);
-        expect((0, src_1.toNumber)(0)).toBe(0);
-    });
-    it('returns number when input is a numeric string', () => {
-        expect((0, src_1.toNumber)('456')).toBe(456);
-    });
-    it('returns null for non-numeric strings', () => {
-        expect((0, src_1.toNumber)('abc')).toBeNull();
-        expect((0, src_1.toNumber)('123abc')).toBeNull();
-        expect((0, src_1.toNumber)('')).toBeNull();
-    });
-    it('returns null for non-numbers', () => {
-        expect((0, src_1.toNumber)(NaN)).toBeNull();
-        expect((0, src_1.toNumber)(Infinity)).toBeNull();
-        expect((0, src_1.toNumber)(undefined)).toBeNull();
-        expect((0, src_1.toNumber)(null)).toBeNull();
-        expect((0, src_1.toNumber)({})).toBeNull();
-    });
-});

package/dist/tests/pub.test.d.ts

@@ -1 +0,0 @@
-declare const path = "../src/pub";