opticedge-cloud-utils 1.1.22 → 1.1.24

package/dist/env.d.ts

@@ -1 +1 @@
-export declare function getEnv(name: string, fallback?: any): any;
+export declare function requireEnv(name: string, defaultValue?: string): string;

package/dist/env.js

@@ -1,13 +1,13 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnv = getEnv;
-function getEnv(name, fallback) {
+exports.requireEnv = requireEnv;
+function requireEnv(name, defaultValue) {
     const value = process.env[name];
-    if (!value) {
-        if (fallback !== undefined)
-            return fallback;
-        throw new Error(`Missing env var ${name}`);
+    if (value === undefined || value === '') {
+        if (defaultValue !== undefined) {
+            return defaultValue;
+        }
+        throw new Error(`${name} env var must be set`);
     }
     return value;
 }

package/dist/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/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.22",
+  "version": "1.1.24",
   "description": "Common utilities for cloud functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/env.ts

@@ -1,10 +1,12 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-export function getEnv(name: string, fallback?: any): any {
+export function requireEnv(name: string, defaultValue?: string): string {
   const value = process.env[name]
-  if (!value) {
-    if (fallback !== undefined) return fallback
-    throw new Error(`Missing env var ${name}`)
+
+  if (value === undefined || value === '') {
+    if (defaultValue !== undefined) {
+      return defaultValue
+    }
+    throw new Error(`${name} env var must be set`)
   }
+
   return value
-}
+}

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/env.test.ts

@@ -1,18 +1,65 @@
-import { getEnv } from '../src/env'
+import { requireEnv } from '../src/env'
 
-describe('getEnv', () => {
-  it('returns the value of an existing env var', () => {
-    process.env.TEST_KEY = 'test-value'
-    expect(getEnv('TEST_KEY')).toBe('test-value')
+describe('requireEnv', () => {
+  const ORIGINAL_ENV = process.env
+
+  beforeEach(() => {
+    jest.resetModules()
+    process.env = { ...ORIGINAL_ENV }
+  })
+
+  afterAll(() => {
+    process.env = ORIGINAL_ENV
+  })
+
+  // ============================================================
+  // Success cases
+  // ============================================================
+
+  it('returns env value when set', () => {
+    process.env.TEST_VAR = 'hello'
+    expect(requireEnv('TEST_VAR')).toBe('hello')
+  })
+
+  it('returns "0" correctly (should not treat as missing)', () => {
+    process.env.TEST_VAR = '0'
+    expect(requireEnv('TEST_VAR')).toBe('0')
   })
 
-  it('returns fallback if env var is not set', () => {
-    delete process.env.OPTIONAL_KEY
-    expect(getEnv('OPTIONAL_KEY', 'default')).toBe('default')
+  it('returns "false" correctly (should not treat as missing)', () => {
+    process.env.TEST_VAR = 'false'
+    expect(requireEnv('TEST_VAR')).toBe('false')
+  })
+
+  // ============================================================
+  // Default handling
+  // ============================================================
+
+  it('returns default when env is undefined', () => {
+    delete process.env.TEST_VAR
+    expect(requireEnv('TEST_VAR', 'fallback')).toBe('fallback')
+  })
+
+  it('returns default when env is empty string', () => {
+    process.env.TEST_VAR = ''
+    expect(requireEnv('TEST_VAR', 'fallback')).toBe('fallback')
+  })
+
+  // ============================================================
+  // Error cases
+  // ============================================================
+
+  it('throws when env is undefined and no default provided', () => {
+    delete process.env.TEST_VAR
+    expect(() => requireEnv('TEST_VAR')).toThrow(
+      'TEST_VAR env var must be set'
+    )
   })
 
-  it('throws error if env var is not set and no fallback provided', () => {
-    delete process.env.MISSING_KEY
-    expect(() => getEnv('MISSING_KEY')).toThrow('Missing env var MISSING_KEY')
+  it('throws when env is empty string and no default provided', () => {
+    process.env.TEST_VAR = ''
+    expect(() => requireEnv('TEST_VAR')).toThrow(
+      'TEST_VAR env var must be set'
+    )
   })
-})
+})

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'
+    })
+  })
+})