Merge pull request #106 from Countly/staging

Staging 24.10.0

Author: turtledreams

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, staging ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ master, staging ]
   schedule:
     - cron: '30 5 * * 4'
 
@@ -39,11 +39,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v3

.github/workflows/release_notice.yml

@@ -0,0 +1,39 @@
+name: Release Notice
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # To check the github context
+      - name: Dump Github context
+        env:
+          GITHUB_CONTEXT: ${{ toJSON(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - name: Send custom JSON data to Slack workflow
+        id: slack
+        uses: slackapi/slack-github-action@v1.23.0
+        with:
+          # This data can be any valid JSON from a previous step in the GitHub Action
+          payload: |
+            {
+              "repository": "${{ github.repository }}",
+              "tag_name": "${{ github.event.release.tag_name }}",
+              "actor": "${{ github.actor }}",
+              "body": ${{ toJSON(github.event.release.body) }},
+              "html_url": "${{ github.event.release.html_url }}"
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_RELEASE }}
+      - name: Send custom JSON data to Discord
+        uses: sarisia/actions-status-discord@v1.13.0
+        with:
+          webhook: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          nodetail: true
+          title: New ${{ github.repository }} version ${{ github.event.release.tag_name }} published by ${{ github.actor }}
+          description: |
+            Release URL: ${{ github.event.release.html_url }}
+            Click [here](https://github.com/Countly/countly-server/blob/master/CHANGELOG.md) to view the change log.
+            `${{ github.event.release.body }}`

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 24.10.0
+- Default max segmentation value count changed from 30 to 100
+- Mitigated an issue where SDK could create an unintended dump file
+- Added a new init time config option (conf.storage_type) which can make user set the SDK storage option:
+  - File Storage
+  - Memory Only Storage
+- Added a new init time config option (conf.custom_storage_method) which enables user to provide custom storage methods
+
 ## 22.06.0
 - Fixed a bug where remote config requests were rejected
 - Fixed a bug where empty storage object did cause some issues

README.md

@@ -1,18 +1,18 @@
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ed5f07ef6f8b4503ac01b2dab190de01)](https://www.codacy.com/gh/Countly/countly-sdk-nodejs/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-nodejs&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ed5f07ef6f8b4503ac01b2dab190de01)](https://app.codacy.com/gh/Countly/countly-sdk-nodejs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![npm version](https://badge.fury.io/js/countly-sdk-nodejs.svg)](https://badge.fury.io/js/countly-sdk-nodejs) 
 [![Inline docs](https://inch-ci.org/github/Countly/countly-sdk-nodejs.svg?branch=master)](https://inch-ci.org/github/Countly/countly-sdk-nodejs)
 
 # Countly NodeJS SDK 
 
-This repository contains the Countly NodeJS SDK, which can be integrated into NodeJS running device or server. The Countly NodeJS SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://count.ly/product).
+This repository contains the Countly NodeJS SDK, which can be integrated into NodeJS running device or server. The Countly NodeJS SDK is intended to be used with [Countly Lite](https://countly.com/lite), [Countly Flex](https://countly.com/flex) or [Countly Enterprise](https://countly.com/enterprise).
 ## What is Countly?
-[Countly](https://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](http://count.ly/web-analytics),
+[Countly](https://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](https://count.ly/web-analytics),
 and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privacy by design](https://count.ly/privacy-by-design), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
 
 Track, measure, and take action - all without leaving Countly.
 
 * **Questions or feature requests?** [Join the Countly Community on Discord](https://discord.gg/countly)
-* **Looking for the Countly Server?** [Countly Community Edition repository](https://github.com/Countly/countly-server)
+* **Looking for the Countly Server?** [Countly Server repository](https://github.com/Countly/countly-server)
 * **Looking for other Countly SDKs?** [An overview of all Countly SDKs for mobile, web and desktop](https://support.count.ly/hc/en-us/articles/360037236571-Downloading-and-Installing-SDKs#officially-supported-sdks)
 
 ## Integrating Countly SDK in your projects

examples/apm_example.js

@@ -1,10 +1,17 @@
 //since we need to test crashing the app
 /*global app*/
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+    console.warn("Please do not use default set of app key and server url")
+}
+
 var Countly = require("../lib/countly.js");
 
 Countly.init({
-    app_key: "YOUR_APP_KEY",
-    url: "https://try.count.ly", //your server goes here
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY, //your server goes here
     debug: true
 });
 

examples/bulk_import_example.js

@@ -1,8 +1,15 @@
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+    console.warn("Please do not use default set of app key and server url")
+}
+
 var CountlyBulk = require("../lib/countly").Bulk;
 
 var server = new CountlyBulk({
-    app_key: "YOUR_APP_KEY",
-    url: "https://try.count.ly", //your server goes here
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY, //your server goes here
     debug: true
 });
 

examples/example.js

@@ -1,14 +1,20 @@
 //since we need to test crashing the app
 /*global runthis, crashDaApp*/
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+    console.warn("Please do not use default set of app key and server url")
+}
+
 var Countly = require("../lib/countly.js");
 
 Countly.init({
-    app_key: "YOUR_APP_KEY",
-    url: "https://try.count.ly", //your server goes here
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY, //your server goes here
     debug: true
 });
 
-
 Countly.begin_session();
 
 Countly.track_errors();

examples/multi-process.js

@@ -13,11 +13,18 @@ else if (cluster.isWorker) {
     console.log("I am worker " + cluster.worker.id);
 }
 
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+    console.warn("Please do not use default set of app key and server url")
+}
+
 var Countly = require("../lib/countly.js");
 
 Countly.init({
-    app_key: "YOUR_APP_KEY",
-    url: "https://try.count.ly", //your server goes here
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY, //your server goes here
     debug: true
 });
 

lib/countly-bulk-user.js

@@ -49,7 +49,7 @@ function CountlyBulkUser(conf) {
     var sessionStart = 0;
     var maxKeyLength = 128;
     var maxValueSize = 256;
-    var maxSegmentationValues = 30;
+    var maxSegmentationValues = 100;
     var maxBreadcrumbCount = 100;
     var maxStackTraceLinesPerThread = 30;
     var maxStackTraceLineLength = 200;