Merge branch 'master' into SER-2456-active-directory-tenant-id-is-not-set-correctly

Author: coskunaydinoglu

CHANGELOG.md

@@ -1,6 +1,8 @@
 ## Version 25.03.XX
 Fixes:
 - [active_directory] Fix for reading azure application tenant id from config
+- [core] Set up default headers for common return methods
+
 ## Version 25.03.8
 Fixes:
 - [core] Fix adding llm observability to cly-event-select component

Dockerfile-api

@@ -6,7 +6,12 @@ ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,vi
 
 ARG GEOIP=empty
 EXPOSE 3001
-HEALTHCHECK --start-period=400s CMD curl --fail http://localhost:3001/o/ping || exit 1
+HEALTHCHECK --start-period=400s CMD bash -c '\
+  if [ "$COUNTLY_CONFIG_API_API_SSL_ENABLED" = "true" ] || [ "$COUNTLY_CONFIG_API_API_SSL_ENABLED" = "\"true\"" ]; then \
+    curl -k --fail https://localhost:3001/o/ping || exit 1; \
+  else \
+    curl --fail http://localhost:3001/o/ping || exit 1; \
+  fi'
 
 USER root
 

Dockerfile-centos-api

@@ -6,7 +6,12 @@ ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,vi
 
 ARG GEOIP=empty
 EXPOSE 3001
-HEALTHCHECK --start-period=400s CMD curl --fail http://localhost:3001/o/ping || exit 1
+HEALTHCHECK --start-period=400s CMD bash -c '\
+  if [ "$COUNTLY_CONFIG_API_API_SSL_ENABLED" = "true" ] || [ "$COUNTLY_CONFIG_API_API_SSL_ENABLED" = "\"true\"" ]; then \
+    curl -k --fail https://localhost:3001/o/ping || exit 1; \
+  else \
+    curl --fail http://localhost:3001/o/ping || exit 1; \
+  fi'
 
 USER root
 

Dockerfile-centos-frontend

@@ -5,7 +5,12 @@ ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,vi
 #ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,views,license,drill,funnels,retention_segments,flows,cohorts,surveys,remote-config,ab-testing,formulas,activity-map,concurrent_users,revenue,logger,systemlogs,populator,reports,crashes,push,geo,block,users,star-rating,slipping-away-users,compare,server-stats,dbviewer,crash_symbolication,crashes-jira,groups,white-labeling,alerts,times-of-day,compliance-hub,onboarding,active_users,performance-monitoring,config-transfer,consolidate,data-manager,hooks,dashboards,heatmaps,sdk,guides,journey_engine,content
 
 EXPOSE 6001
-HEALTHCHECK --start-period=400s CMD curl --fail http://localhost:6001/ping || exit 1
+HEALTHCHECK --start-period=400s CMD bash -c '\
+  if [ "$COUNTLY_CONFIG_FRONTEND_WEB_SSL_ENABLED" = "true" ] || [ "$COUNTLY_CONFIG_FRONTEND_WEB_SSL_ENABLED" = "\"true\"" ]; then \
+    curl -k --fail https://localhost:6001/ping || exit 1; \
+  else \
+    curl --fail http://localhost:6001/ping || exit 1; \
+  fi'
 
 USER root
 

Dockerfile-frontend

@@ -5,7 +5,12 @@ ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,vi
 #ARG COUNTLY_PLUGINS=mobile,web,desktop,plugins,density,locale,browser,sources,views,license,drill,funnels,retention_segments,flows,cohorts,surveys,remote-config,ab-testing,formulas,activity-map,concurrent_users,revenue,logger,systemlogs,populator,reports,crashes,push,geo,block,users,star-rating,slipping-away-users,compare,server-stats,dbviewer,crash_symbolication,crashes-jira,groups,white-labeling,alerts,times-of-day,compliance-hub,onboarding,active_users,performance-monitoring,config-transfer,consolidate,data-manager,hooks,dashboards,heatmaps,sdk,guides,journey_engine,content
 
 EXPOSE 6001
-HEALTHCHECK --start-period=400s CMD curl --fail http://localhost:6001/ping || exit 1
+HEALTHCHECK --start-period=400s CMD bash -c '\
+  if [ "$COUNTLY_CONFIG_FRONTEND_WEB_SSL_ENABLED" = "true" ] || [ "$COUNTLY_CONFIG_FRONTEND_WEB_SSL_ENABLED" = "\"true\"" ]; then \
+    curl -k --fail https://localhost:6001/ping || exit 1; \
+  else \
+    curl --fail http://localhost:6001/ping || exit 1; \
+  fi'
 
 USER root
 
@@ -19,6 +24,7 @@ ENV COUNTLY_CONTAINER="frontend" \
 
 WORKDIR /opt/countly
 COPY . .
+
 # install required dependencies which slim image doesn't have
 RUN apt-get update && \
 	apt-get install -y iputils-ping net-tools telnet apt-transport-https procps curl wget git make gcc g++ unzip xz-utils

api/config.sample.js

@@ -73,7 +73,7 @@ var countlyConfig = {
             enabled: false,
             key: "/path/to/ssl/private.key",
             cert: "/path/to/ssl/certificate.crt",
-            ca: "/path/to/ssl/ca_bundle.crt" // Optional: for client certificate verification
+            // ca: "/path/to/ssl/ca_bundle.crt" // Optional: for client certificate verification, uncomment to activate
         }
     },
     /**

api/parts/data/usage.js

@@ -1117,6 +1117,16 @@ plugins.register("/sdk/user_properties", async function(ob) {
                 userProps.av_major = versionComponents.major;
                 userProps.av_minor = versionComponents.minor;
                 userProps.av_patch = versionComponents.patch;
+                userProps.av_prerel = versionComponents.prerelease;
+                userProps.av_build = versionComponents.build;
+            }
+            else {
+                log.w("Invalid app version format: %s", params.qstring.metrics._app_version);
+                userProps.av_major = null;
+                userProps.av_minor = null;
+                userProps.av_patch = null;
+                userProps.av_rel = null;
+                userProps.av_build = null;
             }
         }
     }

api/utils/common.js

@@ -6,14 +6,14 @@
  * @typedef {import('../../types/requestProcessor').Params} Params
  * @typedef {import('../../types/common').TimeObject} TimeObject
  * @typedef {import('mongodb').ObjectId} ObjectId
- * typedef {import('moment-timezone').Moment} MomentTimezone
+ * @typedef {import('moment-timezone').Moment} MomentTimezone
  */
 
 /** @lends module:api/utils/common **/
-/** @type(import('../../types/common').Common) */
+/** @type {import('../../types/common').Common} */
 const common = {};
 
-/** @type(import('moment-timezone')) */
+/** @type {import('moment-timezone')} */
 const moment = require('moment-timezone');
 const crypto = require('crypto');
 const logger = require('./log.js');
@@ -176,6 +176,7 @@ function escape_html_entities(key, value, more) {
 common.getJSON = getJSON;
 
 common.log = logger;
+const log = logger('api:utils:common');
 
 common.dbMap = {
     'events': 'e',
@@ -1307,16 +1308,23 @@ common.returnRaw = function(params, returnCode, body, heads) {
         }
         return;
     }
+    const defaultHeaders = {};
     //set provided in configuration headers
-    var headers = {};
+    let headers = {};
     if (heads) {
         for (var i in heads) {
             headers[i] = heads[i];
         }
     }
     if (params && params.res && params.res.writeHead && !params.blockResponses) {
         if (!params.res.finished) {
-            params.res.writeHead(returnCode, headers);
+            try {
+                params.res.writeHead(returnCode, headers);
+            }
+            catch (err) {
+                log.e(`Error writing header in 'returnRaw' ${err}`);
+                params.res.writeHead(returnCode, defaultHeaders);
+            }
             if (body) {
                 params.res.write(body);
             }
@@ -1347,9 +1355,10 @@ common.returnMessage = function(params, returnCode, message, heads, noResult = f
         return;
     }
     //set provided in configuration headers
-    var headers = {
+    const defaultHeaders = {
         'Content-Type': 'application/json; charset=utf-8'
     };
+    let headers = { ...defaultHeaders };
     var add_headers = (plugins.getConfig("security").api_additional_headers || "").replace(/\r\n|\r|\n/g, "\n").split("\n");
     var parts;
     for (let i = 0; i < add_headers.length; i++) {
@@ -1373,7 +1382,13 @@ common.returnMessage = function(params, returnCode, message, heads, noResult = f
     }
     if (params && params.res && params.res.writeHead && !params.blockResponses) {
         if (!params.res.finished) {
-            params.res.writeHead(returnCode, headers);
+            try {
+                params.res.writeHead(returnCode, headers);
+            }
+            catch (err) {
+                log.e(`Error writing header in 'returnMessage' ${err}`);
+                params.res.writeHead(returnCode, defaultHeaders);
+            }
             if (params.qstring.callback) {
                 params.res.write(params.qstring.callback + '(' + JSON.stringify({result: message}, escape_html_entities) + ')');
             }
@@ -1415,9 +1430,10 @@ common.returnOutput = function(params, output, noescape, heads) {
         return;
     }
     //set provided in configuration headers
-    var headers = {
+    const defaultHeaders = {
         'Content-Type': 'application/json; charset=utf-8'
     };
+    let headers = { ...defaultHeaders };
     var add_headers = (plugins.getConfig("security").api_additional_headers || "").replace(/\r\n|\r|\n/g, "\n").split("\n");
     var parts;
     for (let i = 0; i < add_headers.length; i++) {
@@ -1442,7 +1458,13 @@ common.returnOutput = function(params, output, noescape, heads) {
     }
     if (params && params.res && params.res.writeHead && !params.blockResponses) {
         if (!params.res.finished) {
-            params.res.writeHead(200, headers);
+            try {
+                params.res.writeHead(200, headers);
+            }
+            catch (err) {
+                log.e(`Error writing header in 'returnMessage' ${err}`);
+                params.res.writeHead(200, defaultHeaders);
+            }
             if (params.qstring.callback) {
                 params.res.write(params.qstring.callback + '(' + JSON.stringify(output, escape) + ')');
             }
@@ -2069,19 +2091,16 @@ common.parseAppVersion = function(version) {
             version = String(version);
         }
 
-        // Ensure version has at least one decimal point
-        if (version.indexOf('.') === -1) {
-            version += '.0';
-        }
-
-        const parsedVersion = semver.valid(semver.coerce(version));
-        if (parsedVersion) {
-            const versionObj = semver.parse(parsedVersion);
+        const isValid = semver.valid(semver.coerce(version, {includePrerelease: true}));
+        if (isValid) {
+            const versionObj = semver.parse(semver.coerce(version, {includePrerelease: true}));
             if (versionObj) {
                 return {
                     major: versionObj.major,
                     minor: versionObj.minor,
                     patch: versionObj.patch,
+                    prerelease: versionObj.prerelease,
+                    build: versionObj.build,
                     original: version,
                     success: true
                 };
@@ -3465,5 +3484,5 @@ common.trimWhitespaceStartEnd = function(value) {
     return value;
 };
 
-/** @type(import('../../types/common').Common) */
+/** @type {import('../../types/common').Common} */
 module.exports = common;

api/utils/localization.js

@@ -3,7 +3,7 @@
 * @module api/utils/localization
 */
 
-/** @type(import('../../types/localization').Locale) */
+/** @type {import('../../types/localization').Locale} */
 var locale = {},
     fs = require('fs'),
     path = require('path'),
@@ -91,5 +91,5 @@ locale.getProperties = function(lang, callback) {
     }
 };
 
-/** @type(import('../../types/localization').Locale) */
+/** @type {import('../../types/localization').Locale} */
 module.exports = locale;

frontend/express/config.sample.js

@@ -82,7 +82,7 @@ var countlyConfig = {
             enabled: false,
             key: "/path/to/ssl/private.key",
             cert: "/path/to/ssl/certificate.crt",
-            ca: "/path/to/ssl/ca_bundle.crt" // Optional: for client certificate verification
+            // ca: "/path/to/ssl/ca_bundle.crt" // Optional: for client certificate verification, uncomment to activate
         }
     },
     /**
@@ -121,4 +121,4 @@ var countlyConfig = {
     passwordSecret: ""
 };
 
-module.exports = require('../../api/configextender')('FRONTEND', countlyConfig, process.env);
+module.exports = require('../../api/configextender')('FRONTEND', countlyConfig, process.env);