@onlineapps/service-common 1.0.5 → 1.0.6

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@onlineapps/service-common",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Common utilities for both infrastructure services and business services",
   "main": "src/index.js",
   "scripts": {
-    "prepublishOnly": "../../scripts/pre-publish-compatibility-check.sh",
-    "postpublish": "../../scripts/update-manifest-from-npm.sh && ../../scripts/update-all-services.sh",
     "test": "jest",
     "test:unit": "jest tests/unit",
     "test:integration": "jest tests/integration"
@@ -19,6 +17,7 @@
   "author": "OA Drive Team",
   "license": "MIT",
   "dependencies": {
+    "@onlineapps/runtime-config": "1.0.1",
     "nodemailer": "^6.9.8",
     "redis": "^4.6.0"
   },

package/src/config.js

@@ -0,0 +1,40 @@
+'use strict';
+
+/**
+ * Runtime configuration schema for @onlineapps/service-common.
+ *
+ * Uses @onlineapps/runtime-config for unified priority:
+ * 1. Explicit config
+ * 2. Environment variable
+ * 3. Owner defaults (from ./defaults.js)
+ *
+ * This module owns infrastructure connection defaults (Redis, RabbitMQ)
+ * that are used as fallbacks by other modules.
+ *
+ * @module @onlineapps/service-common/config
+ */
+
+const { createRuntimeConfig } = require('@onlineapps/runtime-config');
+const DEFAULTS = require('./defaults');
+
+/**
+ * Runtime config schema for service-common
+ */
+const runtimeCfg = createRuntimeConfig({
+  defaults: DEFAULTS,
+  schema: {
+    // Redis defaults
+    redisHost: { env: 'REDIS_HOST', defaultKey: 'redisHost' },
+    redisPort: { env: 'REDIS_PORT', defaultKey: 'redisPort' },
+    redisUrl: { env: 'REDIS_URL', defaultKey: 'redisUrl' },
+
+    // RabbitMQ defaults
+    rabbitmqUrl: { env: 'RABBITMQ_URL', defaultKey: 'rabbitmqUrl' },
+
+    // Infrastructure health
+    infrastructureHealthQueueName: { env: 'INFRASTRUCTURE_HEALTH_QUEUE', defaultKey: 'infrastructureHealthQueueName' },
+  }
+});
+
+module.exports = runtimeCfg;
+

package/src/defaults.js

@@ -0,0 +1,21 @@
+'use strict';
+
+/**
+ * Module-owned defaults for @onlineapps/service-common.
+ *
+ * Ownership rule:
+ * - These defaults are owned by service-common.
+ * - Callers can override via explicit config or environment variables.
+ * - Keep infra-related defaults here to avoid duplication across files.
+ */
+
+module.exports = {
+  redisHost: 'api_node_cache',
+  redisPort: '6379',
+  redisUrl: 'redis://api_node_cache:6379',
+
+  rabbitmqUrl: 'amqp://guest:guest@api_services_queuer:5672',
+  infrastructureHealthQueueName: 'infrastructure.health.checks',
+};
+
+

package/src/index.js

@@ -32,12 +32,6 @@ const {
   getServiceConfig,
   getInfrastructureHealthConfig
 } = require('./runtime-config');
-const {
-  publishToMonitoringResilient,
-  publishToMonitoringWorkflow,
-  publishToMonitoringServices,
-  isQueueUnavailableError
-} = require('./monitoring-publish');
 
 module.exports = {
   // Infrastructure readiness utilities (used by both infrastructure and business services)
@@ -65,13 +59,7 @@ module.exports = {
   getInfrastructureHealthConfig,
 
   // Reporting utilities
-  sendMonitoringFailFallbackEmail,
-
-  // Resilient monitoring publish utilities
-  publishToMonitoringResilient,
-  publishToMonitoringWorkflow,
-  publishToMonitoringServices,
-  isQueueUnavailableError
+  sendMonitoringFailFallbackEmail
 };
 
 

package/src/redisClient.js

@@ -13,6 +13,7 @@
  */
 
 const { createClient } = require('redis');
+const DEFAULTS = require('./defaults');
 
 /**
  * Build a Redis connection URL from environment.
@@ -41,8 +42,8 @@ function buildRedisUrl(options = {}) {
 
   // Priority 2: REDIS_HOST + REDIS_PORT (if REDIS_URL not set)
   // Fallback for docker-compose environment (defined in library, not in docker-compose.yml)
-  const host = env.REDIS_HOST || defaults.host || 'api_node_cache';
-  const port = env.REDIS_PORT || defaults.port || '6379';
+  const host = env.REDIS_HOST || defaults.host || DEFAULTS.redisHost;
+  const port = env.REDIS_PORT || defaults.port || DEFAULTS.redisPort;
 
   return `redis://${host}:${port}`;
 }

package/src/runtime-config.js

@@ -12,6 +12,8 @@
  * - No hidden dependencies on hardcoded values
  */
 
+const runtimeCfg = require('./config');
+
 /**
  * Get required environment variable or throw error
  * @param {string} name - Environment variable name
@@ -94,14 +96,11 @@ function getCriticalConfig() {
  * @returns {Object} Critical infrastructure config with fallbacks
  */
 function getCriticalConfigWithFallbacks() {
-  // Fallback URLs for docker-compose environment (defined in library, not in docker-compose.yml)
-  // These are used ONLY if ENV variables are not set
-  const redisFallback = 'redis://api_node_cache:6379';
-  const rabbitmqFallback = 'amqp://guest:guest@api_services_queuer:5672';
-  
+  // Uses runtime-config for unified priority: ENV → owner defaults
+  // Fallbacks are defined in ./defaults.js (module-owned)
   return {
-    REDIS_URL: optionalEnv('REDIS_URL', redisFallback),
-    RABBITMQ_URL: optionalEnv('RABBITMQ_URL', rabbitmqFallback)
+    REDIS_URL: runtimeCfg.get('redisUrl'),
+    RABBITMQ_URL: runtimeCfg.get('rabbitmqUrl')
   };
 }
 
@@ -144,7 +143,7 @@ function getServiceConfig(options = {}) {
  */
 function getInfrastructureHealthConfig() {
   return {
-    queueName: optionalEnv('INFRASTRUCTURE_HEALTH_QUEUE', 'infrastructure.health.checks'),
+    queueName: runtimeCfg.get('infrastructureHealthQueueName'),
     publishInterval: optionalNumberEnv('INFRASTRUCTURE_HEALTH_PUBLISH_INTERVAL', 5000),
     waitMaxTime: optionalNumberEnv('INFRASTRUCTURE_HEALTH_WAIT_MAX_TIME', 300000),
     waitCheckInterval: optionalNumberEnv('INFRASTRUCTURE_HEALTH_WAIT_CHECK_INTERVAL', 5000),

package/tests/unit/defaults.test.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const defaults = require('../../src/defaults');
+const { getCriticalConfigWithFallbacks, getInfrastructureHealthConfig } = require('../../src/runtime-config');
+const { buildRedisUrl } = require('../../src/redisClient');
+
+describe('@onlineapps/service-common defaults @unit', () => {
+  test('should export stable module-owned defaults', () => {
+    expect(defaults.redisUrl).toBe('redis://api_node_cache:6379');
+    expect(defaults.rabbitmqUrl).toBe('amqp://guest:guest@api_services_queuer:5672');
+    expect(defaults.infrastructureHealthQueueName).toBe('infrastructure.health.checks');
+  });
+
+  test('getCriticalConfigWithFallbacks should use module defaults when env is missing', () => {
+    const oldRedis = process.env.REDIS_URL;
+    const oldRabbit = process.env.RABBITMQ_URL;
+    delete process.env.REDIS_URL;
+    delete process.env.RABBITMQ_URL;
+
+    const cfg = getCriticalConfigWithFallbacks();
+    expect(cfg.REDIS_URL).toBe(defaults.redisUrl);
+    expect(cfg.RABBITMQ_URL).toBe(defaults.rabbitmqUrl);
+
+    if (oldRedis !== undefined) process.env.REDIS_URL = oldRedis;
+    if (oldRabbit !== undefined) process.env.RABBITMQ_URL = oldRabbit;
+  });
+
+  test('getInfrastructureHealthConfig should default queue name from module defaults', () => {
+    const old = process.env.INFRASTRUCTURE_HEALTH_QUEUE;
+    delete process.env.INFRASTRUCTURE_HEALTH_QUEUE;
+
+    const cfg = getInfrastructureHealthConfig();
+    expect(cfg.queueName).toBe(defaults.infrastructureHealthQueueName);
+
+    if (old !== undefined) process.env.INFRASTRUCTURE_HEALTH_QUEUE = old;
+  });
+
+  test('buildRedisUrl should fall back to module defaults host/port', () => {
+    const url = buildRedisUrl({ env: {}, defaults: {} });
+    expect(url).toBe(defaults.redisUrl);
+  });
+});
+
+
+

package/src/monitoring-publish.js

@@ -1,133 +0,0 @@
-/**
- * Resilient monitoring publish helper
- * 
- * Publishes to monitoring queues (monitoring.workflow, monitoring.services) with fail-safe behavior.
- * If the queue doesn't exist or RabbitMQ is unavailable, logs the error and continues without failing.
- * 
- * This ensures services can start and operate even if monitoring queues aren't ready yet.
- * Monitoring queues are created when health:all is true, so this is a temporary state during startup.
- */
-
-/**
- * Check if error indicates queue doesn't exist or RabbitMQ is unavailable
- */
-function isQueueUnavailableError(error) {
-  if (!error) return false;
-  
-  const errorMessage = error.message || String(error);
-  const errorCode = error.code || '';
-  
-  // RabbitMQ connection errors
-  if (errorCode === 'ECONNREFUSED' || errorCode === 'ENOTFOUND' || errorCode === 'ETIMEDOUT') {
-    return true;
-  }
-  
-  // Queue doesn't exist errors (from RabbitMQ)
-  if (errorMessage.includes('NOT_FOUND') || 
-      errorMessage.includes('404') ||
-      errorMessage.includes('no queue') ||
-      errorMessage.includes('queue does not exist') ||
-      errorMessage.includes('Channel closed') ||
-      errorMessage.includes('Connection closed')) {
-    return true;
-  }
-  
-  return false;
-}
-
-/**
- * Resilient publish to monitoring queue
- * 
- * @param {Object} mqClient - MQ client instance (must have publish method)
- * @param {string} queueName - Queue name (e.g., 'monitoring.workflow', 'monitoring.services')
- * @param {Object} message - Message to publish
- * @param {Object} logger - Logger instance (optional, for logging)
- * @param {Object} context - Additional context for logging (optional)
- * @returns {Promise<boolean>} - true if published successfully, false otherwise
- */
-async function publishToMonitoringResilient(mqClient, queueName, message, logger = null, context = {}) {
-  if (!mqClient || typeof mqClient.publish !== 'function') {
-    if (logger) {
-      logger.warn('Monitoring publish skipped: mqClient not available', context);
-    }
-    return false;
-  }
-
-  try {
-    await mqClient.publish(queueName, message);
-    
-    if (logger) {
-      logger.debug(`Published to ${queueName}`, {
-        ...context,
-        event_type: message.event_type,
-        workflow_id: message.workflow_id,
-        service_name: message.service_name
-      });
-    }
-    
-    return true;
-  } catch (error) {
-    // Check if this is a queue unavailable error
-    if (isQueueUnavailableError(error)) {
-      // Queue doesn't exist yet or RabbitMQ is unavailable - log but don't fail
-      if (logger) {
-        logger.warn(`Monitoring queue ${queueName} not available (queue may not exist yet or RabbitMQ unavailable)`, {
-          ...context,
-          error: error.message,
-          event_type: message.event_type,
-          workflow_id: message.workflow_id,
-          service_name: message.service_name
-        });
-      }
-      return false;
-    }
-    
-    // Other errors - log as warning but don't fail
-    if (logger) {
-      logger.warn(`Failed to publish to monitoring queue ${queueName}`, {
-        ...context,
-        error: error.message,
-        errorCode: error.code,
-        event_type: message.event_type,
-        workflow_id: message.workflow_id,
-        service_name: message.service_name
-      });
-    }
-    
-    return false;
-  }
-}
-
-/**
- * Resilient publish to monitoring.workflow queue
- * 
- * @param {Object} mqClient - MQ client instance
- * @param {Object} message - Message with event_type, workflow_id, etc.
- * @param {Object} logger - Logger instance (optional)
- * @param {Object} context - Additional context for logging (optional)
- * @returns {Promise<boolean>}
- */
-async function publishToMonitoringWorkflow(mqClient, message, logger = null, context = {}) {
-  return publishToMonitoringResilient(mqClient, 'monitoring.workflow', message, logger, context);
-}
-
-/**
- * Resilient publish to monitoring.services queue
- * 
- * @param {Object} mqClient - MQ client instance
- * @param {Object} message - Message with event_type, service_name, etc.
- * @param {Object} logger - Logger instance (optional)
- * @param {Object} context - Additional context for logging (optional)
- * @returns {Promise<boolean>}
- */
-async function publishToMonitoringServices(mqClient, message, logger = null, context = {}) {
-  return publishToMonitoringResilient(mqClient, 'monitoring.services', message, logger, context);
-}
-
-module.exports = {
-  publishToMonitoringResilient,
-  publishToMonitoringWorkflow,
-  publishToMonitoringServices,
-  isQueueUnavailableError
-};
-