@onlineapps/service-common 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onlineapps/service-common",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "Common utilities for both infrastructure services and business services",
5
5
  "main": "src/index.js",
6
6
  "scripts": {
package/src/index.js CHANGED
@@ -17,11 +17,17 @@ const {
17
17
  createRedisClient,
18
18
  connectRedis
19
19
  } = require('./redisClient');
20
+ const {
21
+ buildPostgresUrl,
22
+ createPostgresPool,
23
+ connectPostgres
24
+ } = require('./postgresClient');
20
25
  const {
21
26
  requireEnv,
22
27
  optionalEnv,
23
28
  optionalNumberEnv,
24
29
  getCriticalConfig,
30
+ getCriticalConfigWithFallbacks,
25
31
  getOptionalInfraConfig,
26
32
  getServiceConfig,
27
33
  getInfrastructureHealthConfig
@@ -37,11 +43,17 @@ module.exports = {
37
43
  createRedisClient,
38
44
  connectRedis,
39
45
 
46
+ // PostgreSQL utilities (shared between services and tests)
47
+ buildPostgresUrl,
48
+ createPostgresPool,
49
+ connectPostgres,
50
+
40
51
  // Configuration helpers (NO FALLBACKS for critical infrastructure)
41
52
  requireEnv,
42
53
  optionalEnv,
43
54
  optionalNumberEnv,
44
55
  getCriticalConfig,
56
+ getCriticalConfigWithFallbacks, // EXCEPTION: Fallbacks allowed ONLY for infrastructure clients
45
57
  getOptionalInfraConfig,
46
58
  getServiceConfig,
47
59
  getInfrastructureHealthConfig,
@@ -0,0 +1,104 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * PostgreSQL Client Utilities
5
+ *
6
+ * Provides helper functions for building PostgreSQL connection URLs
7
+ * with fallback support for infrastructure client configuration.
8
+ *
9
+ * EXCEPTION: Fallbacks are allowed ONLY for infrastructure client configuration.
10
+ * This is the ONLY place where fallbacks are acceptable.
11
+ */
12
+
13
+ /**
14
+ * Build a PostgreSQL connection URL from environment.
15
+ *
16
+ * EXCEPTION: Fallbacks are allowed ONLY for infrastructure client configuration.
17
+ * This is the ONLY place where fallbacks are acceptable.
18
+ *
19
+ * Environment variable precedence (checked in order):
20
+ * 1. POSTGRES_URL (full URL, e.g. postgres://monitoring:monitoring_pass@api_monitoring_postgres:5432/monitoring) - ENV variable name
21
+ * 2. POSTGRES_HOST + POSTGRES_PORT + POSTGRES_USER + POSTGRES_PASSWORD + POSTGRES_DB (if POSTGRES_URL not set)
22
+ * 3. Fallback: postgres://monitoring:monitoring_pass@api_monitoring_postgres:5432/monitoring (docker-compose default)
23
+ *
24
+ * @param {Object} options - Options
25
+ * @param {Object} [options.env=process.env] - Environment variables
26
+ * @param {Object} [options.defaults] - Default host/port/user/password/db overrides
27
+ * @returns {string} PostgreSQL connection URL
28
+ */
29
+ function buildPostgresUrl(options = {}) {
30
+ const env = options.env || process.env || {};
31
+ const defaults = options.defaults || {};
32
+
33
+ // Priority 1: POSTGRES_URL from environment (ENV variable name: POSTGRES_URL)
34
+ if (env.POSTGRES_URL && typeof env.POSTGRES_URL === 'string' && env.POSTGRES_URL.length > 0) {
35
+ return env.POSTGRES_URL;
36
+ }
37
+
38
+ // Priority 2: POSTGRES_HOST + POSTGRES_PORT + POSTGRES_USER + POSTGRES_PASSWORD + POSTGRES_DB (if POSTGRES_URL not set)
39
+ // Fallback for docker-compose environment (defined in library, not in docker-compose.yml)
40
+ const host = env.POSTGRES_HOST || defaults.host || 'api_monitoring_postgres';
41
+ const port = env.POSTGRES_PORT || defaults.port || '5432';
42
+ const user = env.POSTGRES_USER || defaults.user || 'monitoring';
43
+ const password = env.POSTGRES_PASSWORD || defaults.password || 'monitoring_pass';
44
+ const database = env.POSTGRES_DB || defaults.database || 'monitoring';
45
+
46
+ return `postgres://${user}:${password}@${host}:${port}/${database}`;
47
+ }
48
+
49
+ /**
50
+ * Create a PostgreSQL connection pool
51
+ *
52
+ * @param {Object} options - Options
53
+ * @param {Object} [options.env=process.env] - Environment variables
54
+ * @param {Object} [options.defaults] - Default connection parameters
55
+ * @param {Object} [options.poolConfig] - Additional pool configuration (max, idleTimeoutMillis, etc.)
56
+ * @returns {Object} PostgreSQL Pool instance
57
+ */
58
+ function createPostgresPool(options = {}) {
59
+ const { Pool } = require('pg');
60
+
61
+ const connectionString = buildPostgresUrl({
62
+ env: options.env,
63
+ defaults: options.defaults
64
+ });
65
+
66
+ const poolConfig = {
67
+ connectionString,
68
+ max: options.poolConfig?.max || 10,
69
+ idleTimeoutMillis: options.poolConfig?.idleTimeoutMillis || 30000,
70
+ connectionTimeoutMillis: options.poolConfig?.connectionTimeoutMillis || 2000,
71
+ ...options.poolConfig
72
+ };
73
+
74
+ return new Pool(poolConfig);
75
+ }
76
+
77
+ /**
78
+ * Connect to PostgreSQL and test connection
79
+ *
80
+ * @param {Object} pool - PostgreSQL Pool instance
81
+ * @param {Object} logger - Logger object with info/error methods
82
+ * @returns {Promise<void>}
83
+ */
84
+ async function connectPostgres(pool, logger = console) {
85
+ try {
86
+ await pool.query('SELECT NOW()');
87
+ if (logger && logger.info) {
88
+ logger.info('[PostgreSQL] Connected');
89
+ }
90
+ return true;
91
+ } catch (error) {
92
+ if (logger && logger.error) {
93
+ logger.error('[PostgreSQL] Connection failed:', error);
94
+ }
95
+ throw error;
96
+ }
97
+ }
98
+
99
+ module.exports = {
100
+ buildPostgresUrl,
101
+ createPostgresPool,
102
+ connectPostgres
103
+ };
104
+
@@ -17,20 +17,31 @@ const { createClient } = require('redis');
17
17
  /**
18
18
  * Build a Redis connection URL from environment.
19
19
  *
20
- * Precedence:
21
- * 1. REDIS_URL (full URL, e.g. redis://host:port/db)
22
- * 2. REDIS_HOST + REDIS_PORT
23
- * 3. Defaults (host/port) or localhost:6379
20
+ * EXCEPTION: Fallbacks are allowed ONLY for infrastructure client configuration.
21
+ * This is the ONLY place where fallbacks are acceptable.
22
+ *
23
+ * Environment variable precedence (checked in order):
24
+ * 1. REDIS_URL (full URL, e.g. redis://api_node_cache:6379) - ENV variable name
25
+ * 2. REDIS_HOST + REDIS_PORT (if REDIS_URL not set)
26
+ * 3. Fallback: redis://api_node_cache:6379 (docker-compose default)
27
+ *
28
+ * @param {Object} options - Options
29
+ * @param {Object} [options.env=process.env] - Environment variables
30
+ * @param {Object} [options.defaults] - Default host/port overrides
31
+ * @returns {string} Redis connection URL
24
32
  */
25
33
  function buildRedisUrl(options = {}) {
26
34
  const env = options.env || process.env || {};
27
35
  const defaults = options.defaults || {};
28
36
 
37
+ // Priority 1: REDIS_URL from environment (ENV variable name: REDIS_URL)
29
38
  if (env.REDIS_URL && typeof env.REDIS_URL === 'string' && env.REDIS_URL.length > 0) {
30
39
  return env.REDIS_URL;
31
40
  }
32
41
 
33
- const host = env.REDIS_HOST || defaults.host || 'localhost';
42
+ // Priority 2: REDIS_HOST + REDIS_PORT (if REDIS_URL not set)
43
+ // Fallback for docker-compose environment (defined in library, not in docker-compose.yml)
44
+ const host = env.REDIS_HOST || defaults.host || 'api_node_cache';
34
45
  const port = env.REDIS_PORT || defaults.port || '6379';
35
46
 
36
47
  return `redis://${host}:${port}`;
@@ -63,8 +63,12 @@ function optionalNumberEnv(name, defaultValue) {
63
63
 
64
64
  /**
65
65
  * Get critical infrastructure configuration
66
- * These MUST be set - no fallbacks allowed
66
+ *
67
+ * NOTE: This function is DEPRECATED - use getCriticalConfigWithFallbacks() instead.
68
+ * This function requires ENV variables and fails fast (NO FALLBACKS).
69
+ *
67
70
  * @returns {Object} Critical infrastructure config
71
+ * @throws {Error} If REDIS_URL or RABBITMQ_URL are not set
68
72
  */
69
73
  function getCriticalConfig() {
70
74
  return {
@@ -73,6 +77,34 @@ function getCriticalConfig() {
73
77
  };
74
78
  }
75
79
 
80
+ /**
81
+ * Get critical infrastructure configuration with fallbacks
82
+ *
83
+ * EXCEPTION: Fallbacks are allowed ONLY for infrastructure client configuration.
84
+ * This is the ONLY place where fallbacks are acceptable.
85
+ *
86
+ * Environment variables (checked in order):
87
+ * - REDIS_URL: Full Redis URL (e.g., redis://api_node_cache:6379)
88
+ * - RABBITMQ_URL: Full RabbitMQ URL (e.g., amqp://guest:guest@api_services_queuer:5672)
89
+ *
90
+ * Fallbacks (used only if ENV is not set):
91
+ * - Redis: redis://api_node_cache:6379 (docker-compose default)
92
+ * - RabbitMQ: amqp://guest:guest@api_services_queuer:5672 (docker-compose default)
93
+ *
94
+ * @returns {Object} Critical infrastructure config with fallbacks
95
+ */
96
+ function getCriticalConfigWithFallbacks() {
97
+ // Fallback URLs for docker-compose environment (defined in library, not in docker-compose.yml)
98
+ // These are used ONLY if ENV variables are not set
99
+ const redisFallback = 'redis://api_node_cache:6379';
100
+ const rabbitmqFallback = 'amqp://guest:guest@api_services_queuer:5672';
101
+
102
+ return {
103
+ REDIS_URL: optionalEnv('REDIS_URL', redisFallback),
104
+ RABBITMQ_URL: optionalEnv('RABBITMQ_URL', rabbitmqFallback)
105
+ };
106
+ }
107
+
76
108
  /**
77
109
  * Get optional infrastructure configuration
78
110
  * These have sensible defaults for development
@@ -127,6 +159,7 @@ module.exports = {
127
159
  optionalEnv,
128
160
  optionalNumberEnv,
129
161
  getCriticalConfig,
162
+ getCriticalConfigWithFallbacks,
130
163
  getOptionalInfraConfig,
131
164
  getServiceConfig,
132
165
  getInfrastructureHealthConfig