feat: Add GDPR and CCPA Consent #13

BrandonStalnaker · 2022-04-04T16:27:52Z

Summary

Update Cordova SDK to support consent state. Thankfully ATTStatus was already added

peterjenkins

Thanks for putting this together.. I left some feedback. Note that I only commented on one occurrence of each item but changes will need to be made in two places for all except the first.

plugin/src/android/src/main/java/com/mparticle/cordova/MParticleCordovaPlugin.java

plugin/src/ios/CDVMParticle.m

peterjenkins

Updates look good, thanks.

willpassidomo · 2022-04-06T15:03:26Z

Hey @BrandonStalnaker , it's been a while since I've done anything with this project, but don't we need to update the www/mparticle.js file in order to actually add the setConsentState() etc APIs?

BrandonStalnaker · 2022-04-06T15:27:39Z

@willpassidomo You would be correct So it would be really helpful if I had included those changes in the commit initially... oops. Added them now thanks for noticing that.

willpassidomo · 2022-04-06T15:31:01Z

Hahaha, that's happened to me more time than I would want to admit, checking it out now :)

willpassidomo

Nice! Read through my comments, there are a couple things I pointed out in there that might be worth fixing now or not, depending on the urgency of getting this PR out :)

willpassidomo · 2022-04-06T15:40:28Z

plugin/src/android/src/main/java/com/mparticle/cordova/MParticleCordovaPlugin.java

@@ -326,6 +338,56 @@ public void getUserIdentities(final JSONArray args, final CallbackContext callba
        callbackContext.sendPluginResult(pluginResult);
    }

+    public void addGDPRConsentState(final JSONArray args) throws JSONException {
+        MParticleUser user = MParticle.getInstance().Identity().getCurrentUser();
+        final JSONObject map = args.getJSONObject(0);


So, I'm not going to block the PR because it looks like we already do this in a bunch of other methods, but the JSONArray.getJSONObject(int) method (or any JSONObject/JSONArray get{type}() method) will throw an exception if the value is not a JSONObject (or {type}), meaning our null-check on this value won't every help us.

The most defensive way to handle this parsing would be like:

JSONObject map = null; if (args.length > 0) { map = args.optJSONObject(0) } String purpose = null; if (args.length > 1) { purpose = args.optString(1) } if (user != null && map != null && purpose != null) { //do the stuff }

Since your implementation is consistent with how we do it elsewhere in this file, it'd be fine to get this out and fast-follow with a broader update

willpassidomo · 2022-04-06T15:42:08Z

plugin/src/android/src/main/java/com/mparticle/cordova/MParticleCordovaPlugin.java

@@ -698,5 +760,35 @@ private static String ConvertPromotionActionType(int promotionActionType) {
                return Promotion.CLICK;
        }
    }
+
+    private static GDPRConsent ConvertGDPRConsent(JSONObject map) throws JSONException {
+        String dateStr = obj.getString("timestamp");


Same here, using obj.optString("timestamp") then null-checking will allow us to gracefully handle malformed input without crashing..right now this will generate a JSONException if the user leaves out the "timestamp" value

willpassidomo · 2022-04-06T15:43:55Z

plugin/www/mparticle.js

@@ -375,6 +391,52 @@ var mparticle = {
        'modify',
        [IdentityRequest])
    }
+  },
+
+  GDPRConsent: function () {


nit: since these are identical objects, we could instead just merge them into a single Consent class and use that on both add methods

BrandonStalnaker · 2022-04-06T16:52:21Z

We're going to spin out Will's add-on suggestions to another PR.

mparticle-automation · 2022-05-06T16:42:25Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

mparticle-automation · 2022-05-06T16:55:59Z