Merge branch 'development' into feat/SQDSDKS-6940-tiktok-partner-id

alexs-mparticle · web-flow · commit b901e4ca0cd8 · 2025-01-13T14:06:49.000-05:00
diff --git a/.github/workflows/issue-autorespond-and-close.yml b/.github/workflows/issue-autorespond-and-close.yml
@@ -0,0 +1,14 @@
+name: Auto respond and close issue
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  auto-respond-and-close-issue:
+    uses: mparticle/mparticle-workflows/.github/workflows/auto-respond-close-issue.yml@main
+    with:
+      issue_number: ${{ github.event.issue.number }}
+      repository: ${{ github.repository }}
+      user_login: ${{ github.event.issue.user.login }}
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -18,7 +18,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest 
 
             - name: Run NPM CI
               run: npm ci
@@ -55,7 +55,7 @@ jobs:
         runs-on: 'ubuntu-latest'
         strategy:
             matrix:
-                node-version: [16.x, 17.x, 18.x, 19.x, 20.x]
+                node-version: [18.x, 19.x, 20.x, 21.x, 22.x, 23.x]
         steps:
             - name: Checkout
               uses: actions/checkout@v3
@@ -107,7 +107,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest
 
             - name: Run NPM CI
               run: npm ci
@@ -224,7 +224,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest 
 
             - name: Run NPM CI
               run: npm ci
@@ -275,7 +275,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest
 
             - name: Compress Bundle
               run: npm run bundle
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -28,7 +28,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest
 
             - name: Run NPM CI
               run: npm ci
@@ -57,17 +57,14 @@ jobs:
     test-jest:
         name: 'Test Jest'
         runs-on: 'ubuntu-latest'
-        strategy:
-            matrix:
-                node-version: [16.x, 17.x, 18.x, 19.x, 20.x]
         steps:
             - name: Checkout
               uses: actions/checkout@v3
 
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: ${{ matrix.node-version }}
+                  node-version: latest
 
             - name: Run NPM CI
               run: npm ci
@@ -111,7 +108,7 @@ jobs:
             - name: NPM install
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest
 
             - name: Run NPM CI
               run: npm ci
@@ -272,7 +269,7 @@ jobs:
             - name: Setup Node.js
               uses: actions/setup-node@v3
               with:
-                  node-version: 16.x
+                  node-version: latest
 
             - name: Install dependencies
               run: npm ci
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+## [2.31.1](https://github.com/mParticle/mparticle-web-sdk/compare/v2.31.0...v2.31.1) (2025-01-06)
+
+
+### Bug Fixes
+
+* Check for uploader to prevent errors when calling upload() too early ([#938](https://github.com/mParticle/mparticle-web-sdk/issues/938)) ([4342b0a](https://github.com/mParticle/mparticle-web-sdk/commit/4342b0a6f9089d8694686afa48e1f46906398997))
+* Forward user attributes to kits properly when kit blocking is enabled and unplanned UAs are allowed ([#947](https://github.com/mParticle/mparticle-web-sdk/issues/947)) ([fdbc6ba](https://github.com/mParticle/mparticle-web-sdk/commit/fdbc6baf509f4816bcc835e1b5b7105d40faa05e))
+
+# [2.31.0](https://github.com/mParticle/mparticle-web-sdk/compare/v2.30.4...v2.31.0) (2024-12-11)
+
+
+### Features
+
+* Add support for Google Click Ids ([#955](https://github.com/mParticle/mparticle-web-sdk/issues/955)) ([#957](https://github.com/mParticle/mparticle-web-sdk/issues/957)) ([3df8d84](https://github.com/mParticle/mparticle-web-sdk/commit/3df8d8435129874bbf0f1a9daf1e7772843c5442))
+
 ## [2.30.4](https://github.com/mParticle/mparticle-web-sdk/compare/v2.30.3...v2.30.4) (2024-11-05)
 
 
diff --git a/dist/mparticle.common.js b/dist/mparticle.common.js
diff --git a/dist/mparticle.esm.js b/dist/mparticle.esm.js
diff --git a/dist/mparticle.js b/dist/mparticle.js
@@ -393,7 +393,7 @@ var mParticle = (function () {
         return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
     };
 
-    var version = "2.30.4";
+    var version = "2.31.1";
 
     var Constants = {
       sdkVersion: version,
@@ -8885,15 +8885,21 @@ var mParticle = (function () {
         if (!this.blockUserAttributes) {
           return false;
         }
-        if (this.blockUserAttributes) {
-          var matchedAttributes = this.dataPlanMatchLookups['user_attributes'];
-          if (matchedAttributes === true) {
+        var matchedAttributes = this.dataPlanMatchLookups['user_attributes'];
+        // When additionalProperties is set to true, matchedAttributes 
+        // will be a boolean, otherwise it will return an object
+        if (typeof matchedAttributes === 'boolean' && matchedAttributes) {
+          return false;
+        }
+        if (_typeof$1(matchedAttributes) === "object") {
+          if (matchedAttributes[key] === true) {
             return false;
-          }
-          if (!matchedAttributes[key]) {
+          } else {
             return true;
           }
         }
+        // When "Block unplanned user attributes" is enabled and "Allow unplanned user
+        // attributes" is also enabled in the UI, allowing unplanned user attributes will be prioritized
         return false;
       };
       KitBlocker.prototype.isIdentityBlocked = function (key) {
@@ -9242,6 +9248,7 @@ var mParticle = (function () {
       return "fb.".concat(subdomainIndex, ".").concat(_timestamp, ".").concat(clickId);
     };
     var integrationMapping = {
+      // Facebook / Meta
       fbclid: {
         mappedKey: 'Facebook.ClickId',
         processor: facebookClickIdProcessor
@@ -9251,6 +9258,16 @@ var mParticle = (function () {
       },
       _fbc: {
         mappedKey: 'Facebook.ClickId'
+      },
+      // Google
+      gclid: {
+        mappedKey: 'GoogleEnhancedConversions.Gclid'
+      },
+      gbraid: {
+        mappedKey: 'GoogleEnhancedConversions.Gbraid'
+      },
+      wbraid: {
+        mappedKey: 'GoogleEnhancedConversions.Wbraid'
       }
     };
     var IntegrationCapture = /** @class */function () {
@@ -9782,7 +9799,8 @@ var mParticle = (function () {
           if (self._Store.webviewBridgeEnabled) {
             self._NativeSdkHelpers.sendToNative(Constants.NativeSdkPaths.Upload);
           } else {
-            self._APIClient.uploader.prepareAndUpload(false, false);
+            var _self$_APIClient;
+            (_self$_APIClient = self._APIClient) === null || _self$_APIClient === void 0 || (_self$_APIClient = _self$_APIClient.uploader) === null || _self$_APIClient === void 0 || _self$_APIClient.prepareAndUpload(false, false);
           }
         }
       };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.30.4",
+    "version": "2.31.1",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
diff --git a/src/integrationCapture.ts b/src/integrationCapture.ts
@@ -108,6 +108,18 @@ const integrationMapping: IntegrationIdMapping = {
         mappedKey: 'tiktok_cookie_id',
         output: IntegrationOutputs.PARTNER_IDENTITIES,
     },
+
+    // Google
+    gclid: {
+        mappedKey: 'GoogleEnhancedConversions.Gclid',
+    },
+    gbraid: {
+        mappedKey: 'GoogleEnhancedConversions.Gbraid',
+    },
+    wbraid: {
+        mappedKey: 'GoogleEnhancedConversions.Wbraid',
+    },
+
 };
 
 export default class IntegrationCapture {
diff --git a/src/kitBlocking.ts b/src/kitBlocking.ts
@@ -460,17 +460,25 @@ export default class KitBlocker {
         if (!this.blockUserAttributes) {
             return false
         }
-        if (this.blockUserAttributes) {
-            const matchedAttributes = this.dataPlanMatchLookups['user_attributes'];
-            if (matchedAttributes === true) {
-                return false
-            }
-            if (!matchedAttributes[key]) {
-                return true
+        const matchedAttributes = this.dataPlanMatchLookups['user_attributes'];
+
+        // When additionalProperties is set to true, matchedAttributes 
+        // will be a boolean, otherwise it will return an object
+        if (typeof matchedAttributes === 'boolean' && matchedAttributes) {
+            return false
+        }
+
+        if (typeof matchedAttributes === "object") {
+            if (matchedAttributes[key] === true) {
+                return false;
+            } else {
+                return true;
             }
         }
 
-        return false
+        // When "Block unplanned user attributes" is enabled and "Allow unplanned user
+        // attributes" is also enabled in the UI, allowing unplanned user attributes will be prioritized
+        return false;
     }
 
     isIdentityBlocked(key: string) {
diff --git a/test/src/tests-kit-blocking.ts b/test/src/tests-kit-blocking.ts
@@ -7,6 +7,7 @@ import KitBlocker from '../../src/kitBlocking';
 import Types from '../../src/types';
 import { DataPlanVersion } from '@mparticle/data-planning-models';
 import fetchMock from 'fetch-mock/esm/client';
+import { expect } from 'chai'
 const { findBatch, waitForCondition, fetchMockSuccess, hasIdentifyReturned } = Utils;
 
 let forwarderDefaultConfiguration = Utils.forwarderDefaultConfiguration,
@@ -616,6 +617,26 @@ describe('kit blocking', () => {
             })
         });
 
+        it('integration test - should not throw an error when unplanned user attributes are allowed and block.ua = true', function(done) {
+            window.mParticle.config.kitConfigs.push(forwarderDefaultConfiguration('MockForwarder'));
+            window.mParticle.init(apiKey, window.mParticle.config);
+            
+            // save old data points for reset later
+            const oldDataPoints = dataPlan.dtpn.vers.version_document.data_points;
+            // when "Allow unplanned user attributes" is enabled, the data points returned is an empty array
+            dataPlan.dtpn.vers.version_document.data_points = [];
+            let kitBlocker = new KitBlocker(kitBlockerDataPlan, window.mParticle.getInstance());
+
+            expect(() => { kitBlocker.isAttributeKeyBlocked('unplannedAttr') }).to.not.throw(TypeError, /Cannot read properties of undefined \(reading 'unplannedAttr'\)/)
+            // "Allow unplanned user attributes" is prioritized when blocking unplanned attributes is also enabled, hence the expected value is false
+            expect(kitBlocker.isAttributeKeyBlocked('unplannedAttr')).to.equal(false)
+            // reset data points
+            dataPlan.dtpn.vers.version_document.data_points = oldDataPoints;
+
+            done();
+            
+        });
+
         it('integration test - should allow an unplanned attribute to be set on forwarder if additionalProperties = true and blok.ua = true', function(done) {
             let userAttributeDataPoint = dataPlan.dtpn.vers.version_document.data_points.find(dataPoint => {
                 return dataPoint.match.type === 'user_attributes'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@mparticle/web-sdk",`
`3`		`- "version": "2.30.4",`
	`3`	`+ "version": "2.31.1",`
`4`	`4`	`"description": "mParticle core SDK for web applications",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"keywords": [`