[sdk] reset server conf & location tracking

.github/workflows/main.yml

@@ -392,3 +392,72 @@ jobs:
           mkdir -p screenshots videos
           tar zcvf "$ARTIFACT_ARCHIVE_NAME" screenshots videos
           curl -o /tmp/uploader.log -u "${{ secrets.BOX_UPLOAD_AUTH }}" ${{ secrets.BOX_UPLOAD_PATH }} -T "$ARTIFACT_ARCHIVE_NAME"
+
+  ui-test-sdk:
+    runs-on: ubuntu-latest
+
+    services:
+      mongodb:
+        image: mongo:8.0
+        options: >-
+          --health-cmd mongosh
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 27017:27017
+
+    container:
+      image: countly/countly-core:pipelines-${{ inputs.custom_tag || github.base_ref || github.ref_name }}
+      env:
+        COUNTLY_CONFIG__MONGODB_HOST: mongodb
+        COUNTLY_CONFIG_API_PREVENT_JOBS: true
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Chrome
+        shell: bash
+        run: |
+          apt update
+          apt install -y libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb wget
+          wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb -O /tmp/chrome.deb
+          apt install -y /tmp/chrome.deb
+
+      - name: Copy code
+        shell: bash
+        run: cp -rf ./* /opt/countly
+
+      - name: Prepare files to use correct MongoDB host
+        shell: bash
+        run: "sed -i 's/mongosh --quiet/mongosh --host mongodb --quiet/' /opt/countly/bin/backup/import_events.sh && sed -i 's/mongoimport --db/mongoimport --host mongodb --db/' /opt/countly/bin/backup/import_events.sh"
+
+      - name: NPM install
+        shell: bash
+        working-directory: /opt/countly
+        run: npm install
+
+      - name: Prepare environment
+        shell: bash
+        working-directory: /opt/countly
+        run: |
+          sed -i 's/port: 3001,/port: 3001, workers: 1,/' /opt/countly/api/config.js
+          cp "./plugins/plugins.default.json" "/opt/countly/plugins/plugins.json"
+          npm install
+          sudo countly task dist-all
+          bash bin/scripts/countly.prepare.ce.tests.sh
+          cd ui-tests
+          echo '{"username": "${{ secrets.CYPRESS_USER_USERNAME }}","email": "${{ secrets.CYPRESS_USER_EMAIL }}","password": "${{ secrets.CYPRESS_USER_PASSWORD }}"}' > cypress/fixtures/user.json
+          sed -i 's/00000000-0000-0000-0000-000000000000/${{ secrets.CYPRESS_KEY }}/g' package.json
+          cp cypress.config.sample.js cypress.config.js
+          sed -i 's/000000/${{ secrets.CYPRESS_PROJECT_ID }}/g' cypress.config.js
+
+      - name: Run UI tests
+        shell: bash
+        working-directory: /opt/countly
+        run: |
+          /sbin/my_init &
+          cd ui-tests
+          npm install
+          xvfb-run --auto-servernum --server-args="-screen 0 1280x1024x24" \
+          npm run cy:run:sdk

frontend/express/public/javascripts/countly/vue/components/helpers.js

@@ -405,6 +405,10 @@
             placement: {
                 type: String,
                 default: 'auto'
+            },
+            tooltipClass: {
+                type: String,
+                default: ''
             }
         },
         computed: {
@@ -415,7 +419,7 @@
                 };
             }
         },
-        template: '<i v-if="tooltip" :class="\'cly-vue-tooltip-icon \' + icon" v-tooltip="tooltipConf"></i>'
+        template: '<i v-if="tooltip" :class="\'cly-vue-tooltip-icon \' + icon + \' \' + tooltipClass" v-tooltip="tooltipConf"></i>'
     }));
 
     Vue.component("cly-remover", countlyBaseComponent.extend({

plugins/sdk/api/api.js

@@ -12,6 +12,49 @@ plugins.register("/permissions/features", function(ob) {
 
 (function() {
 
+    /**
+     * @api {get} /o/sdk?method=sc Get SDK config
+     * @apiName GetSDKConfig
+     * @apiGroup SDK Config
+     * @apiPermission app
+     * @apiDescription Get SDK configuration for this SDK and this user
+     *
+     * @apiQuery {String} app_key Application key
+     *
+     * @apiSuccess {Object} v - version 
+     * @apiSuccess {Object} t - timestamp
+     * @apiSuccess {Object} c - sdk config
+     *
+     * @apiSuccessExample {json} Success-Response:
+     * {
+        "v":1,
+        "t":1682328445330,
+        "c":{
+            "tracking":true,
+            "networking":true,
+            "crt":true,
+            "vt":true,
+            "st":true,
+            "cet":true,
+            "ecz":true,
+            "cr":true,
+            "sui":true,
+            "eqs":true,
+            "rqs":true,
+            "czi":true,
+            "dort":true,
+            "scui":true,
+            "lkl":true,
+            "lvs":true,
+            "lsv":true,
+            "lbc":true,
+            "ltlpt":true,
+            "ltl":true,
+            "lt":true,
+            "rcz":true
+        }
+     * }
+     */
     plugins.register("/o/sdk", function(ob) {
         var params = ob.params;
         if (params.qstring.method !== "sc") {
@@ -36,36 +79,24 @@ plugins.register("/permissions/features", function(ob) {
     });
 
     /**
-     * @api {get} /o?method=sc Get SDK config
-     * @apiName GetSDKConfig
+     * @api {get} /o?method=config-upload Save SDK config
+     * @apiName SaveSDKConfig
      * @apiGroup SDK Config
-     * @apiPermission app
-     * @apiDescription Get SDK configuration for this SDK and this user
-     *
-     * @apiQuery {String} app_key Application key
-     *
-     * @apiSuccess {Object} v - version 
-     * @apiSuccess {Object} t - timestamp
-     * @apiSuccess {Object} c - sdk config
-     *
-     * @apiSuccessExample {json} Success-Response:
+     * @apiPermission admin
+     * @apiDescription Save SDK configuration for the given app
+     * 
+     * @apiQuery {String} app_id Application ID
+     * @apiQuery {String} config SDK config object
+     * 
+     * @apiSuccess {json} Success-Response:
      * {
-        "v":1,
-        "t":1682328445330,
-        "c":{
-            "tracking":false,
-            "networking":false,
-            "crashes":false,
-            "views":false,
-            "heartbeat":61,
-            "event_queue":11,
-            "request_queue":1001
-        }
+     *     "result": "Success"
      * }
      */
     plugins.register("/o", function(ob) {
         var params = ob.params;
 
+        // returns server config for the given app
         if (params.qstring.method === "sdk-config") {
             validateRead(params, FEATURE_NAME, function() {
                 getSDKConfig(params).then(function(res) {
@@ -78,6 +109,77 @@ plugins.register("/permissions/features", function(ob) {
 
             return true;
         }
+
+        // saves the given server configuration for the given app
+        if (params.qstring.method === "config-upload") {
+            return new Promise(function(resolve) {
+                validateUpdate(params, FEATURE_NAME, function() {
+                    var uploadConfig = params.qstring.config;
+                    if (uploadConfig && typeof uploadConfig === "string") {
+                        try {
+                            uploadConfig = JSON.parse(uploadConfig);
+                        }
+                        catch (ex) {
+                            common.returnMessage(params, 400, 'Invalid config format');
+                            return resolve();
+                        }
+                    }
+
+                    if (!uploadConfig || typeof uploadConfig !== "object") {
+                        common.returnMessage(params, 400, 'Config must be a valid object');
+                        return resolve();
+                    }
+
+                    var configToSave = uploadConfig.c || uploadConfig; // incase they provide the config object directly
+                    var validOptions = [
+                        "tracking",
+                        "networking",
+                        "crt",
+                        "vt",
+                        "st",
+                        "cet",
+                        "ecz",
+                        "cr",
+                        "sui",
+                        "eqs",
+                        "rqs",
+                        "czi",
+                        "dort",
+                        "scui",
+                        "lkl",
+                        "lvs",
+                        "lsv",
+                        "lbc",
+                        "ltlpt",
+                        "ltl",
+                        "lt",
+                        "rcz"
+                    ];
+                    for (var key in configToSave) {
+                        if (validOptions.indexOf(key) === -1) {
+                            delete configToSave[key];
+                        }
+                    }
+
+                    common.outDb.collection('sdk_configs').updateOne(
+                        {_id: params.qstring.app_id + ""},
+                        {$set: {config: configToSave}},
+                        {upsert: true},
+                        function(err) {
+                            if (err) {
+                                common.returnMessage(params, 500, 'Error saving config to database');
+                            }
+                            else {
+                                common.returnOutput(params, {result: 'Success'});
+                            }
+                            resolve();
+                        }
+                    );
+                });
+            });
+        }
+
+        return false;
     });
 
     plugins.register("/i/sdk-config", function(ob) {
@@ -359,7 +461,7 @@ plugins.register("/permissions/features", function(ob) {
     });
 
     /**
-     * Updated SDK config
+     * Updates SDK config (used internally when configuration is changed in the dashboard)
      * @param {params} params - request params
      * @returns {void}
      */