Merge pull request #122 from Flagsmith/features/dynatrace_session_properties

3.1.1 - Dynatrace realtime user management session properties

Author: kyle-ssg

examples/dynatrace-realtime-user-monitoring/README.md

@@ -0,0 +1,9 @@
+<img width="100%" src="https://raw.githubusercontent.com/Flagsmith/flagsmith/main/static-files/hero.png"/>
+
+# Flagsmith with jQuery
+
+This repository contains basic integration with just jQuery.
+
+## Installation
+
+None! Just open index.html in your preferred browser.

examples/dynatrace-realtime-user-monitoring/index.html

@@ -0,0 +1,63 @@
+var environmentID = 'QjgYur4LQTwe5HpvbvhpzK'
+var flagsmithIdentity = "flagsmith_sample_user"
+
+//Identify the user
+dtrum.identifyUser(flagsmithIdentity)
+
+function identify() {
+    flagsmith.identify(flagsmithIdentity)
+}
+
+function toggleTrait () {
+    flagsmith.setTrait('example_trait', "Some value " + Math.floor(Math.random() * 10)+"");
+}
+
+function login () {
+    flagsmith.identify(flagsmithIdentity);
+};
+
+function logout () {
+    flagsmith.logout();
+};
+function evaluateConfig () {
+    alert(flagsmith.getValue("font_size"));
+};
+function evaluateFlag () {
+    alert(flagsmith.hasFeature("flag")? "true":"false");
+};
+
+$("#js-login").on("click", login);
+$("#js-evaluate-config").on("click", evaluateConfig);
+$("#js-evaluate-flag").on("click", evaluateFlag);
+$("#js-logout").on("click", logout);
+$("#js-toggle-trait").on("click", toggleTrait);
+
+//Intialise Flagsmith
+flagsmith.init({
+    environmentID: environmentID,
+    cacheFlags: true,
+    enableLogs: true,
+    enableAnalytics:true,
+    //specifying dtrum tells flagsmith to set session properties (see console)
+    dtrum: typeof dtrum === 'undefined'? null: dtrum,
+    defaultFlags: {
+        font_size: 10
+    },
+    onChange: function() {
+        $("#loaded").removeClass("hidden")
+        $("#loading").addClass("hidden")
+
+        if (flagsmith.identity) {
+            $("#logged-in").removeClass("hidden")
+            $("#logged-out").addClass("hidden")
+            $("#js-example-trait").text(flagsmith.getTrait("example_trait") + "");
+            if (flagsmith.getSegments()) {
+                $("#js-segments").text(Object.keys(flagsmith.getSegments() ).join(", "));
+            }
+        } else {
+            $("#logged-out").removeClass("hidden")
+            $("#logged-in").addClass("hidden")
+        }
+        $("#js-data").text(JSON.stringify(flagsmith.getAllFlags(), null, 2));
+    }
+});

examples/dynatrace-realtime-user-monitoring/main.js

@@ -53,7 +53,7 @@ const Flagsmith = class {
     getFlags = (resolve?:(v?:any)=>any, reject?:(v?:any)=>any) => {
         const { onChange, onError, identity, api } = this;
         let resolved = false;
-        const handleResponse = ({ flags: features, traits }, segments) => {
+        const handleResponse = ({ flags: features, traits }) => {
             if (identity) {
                 this.withTraits = false;
             }
@@ -75,18 +75,38 @@ const Flagsmith = class {
             this.oldFlags = {
                 ...this.flags
             };
-            if (segments) {
-                let userSegments = {};
-                segments.map((s) => {
-                    userSegments[s.name] = s;
-                });
-                this.segments = userSegments;
-            }
             const flagsEqual = deepEqual(this.flags, flags);
             const traitsEqual = deepEqual(this.traits, userTraits);
             this.flags = flags;
             this.traits = userTraits;
             this.updateStorage();
+            if (this.dtrum) {
+                let traits: {
+                    "javaLongOrObject": Record<string, number>,
+                    "date": Record<string, Date>,
+                    "shortString": Record<string, string>,
+                    "javaDouble": Record<string, number>,
+                } = {
+                    javaDouble: {},
+                    date: {},
+                    shortString: {},
+                    javaLongOrObject: {},
+                }
+                Object.keys(this.flags).map((key)=>{
+                    setDynatraceValue(traits, "flagsmith_value_"+key, this.getValue(key) )
+                    setDynatraceValue(traits, "flagsmith_enabled_"+key, this.hasFeature(key) )
+                })
+                Object.keys(this.traits).map((key)=>{
+                    setDynatraceValue(traits, "flagsmith_trait_"+key, this.getTrait(key) )
+                })
+                this.log("Sending javaLongOrObject traits to dynatrace", traits.javaLongOrObject)
+                this.log("Sending date traits to dynatrace", traits.date)
+                this.log("Sending shortString traits to dynatrace", traits.shortString)
+                this.log("Sending javaDouble to dynatrace", traits.javaDouble)
+                this.dtrum.sendSessionProperties(
+                    traits.javaLongOrObject, traits.date, traits.shortString, traits.javaDouble
+                )
+            }
             if(this.trigger) {
                 this.trigger()
             }
@@ -114,7 +134,7 @@ const Flagsmith = class {
                 .then((res) => {
                     // @ts-ignore
                     this.withTraits = false
-                    handleResponse(res[0], res[1])
+                    handleResponse(res[0])
                     if (resolve && !resolved) {
                         resolved = true;
                         resolve();
@@ -128,7 +148,7 @@ const Flagsmith = class {
             ])
                 .then((res) => {
                     // @ts-ignore
-                    handleResponse({ flags: res[0] }, null)
+                    handleResponse({ flags: res[0] })
                     if (resolve && !resolved) {
                         resolved = true;
                         resolve();
@@ -176,10 +196,10 @@ const Flagsmith = class {
     onError= null
     trigger= null
     identity= null
-    segments= null
     ticks= null
     timer= null
     traits= null
+    dtrum= null
     withTraits= null
 
     init({
@@ -192,6 +212,7 @@ const Flagsmith = class {
         defaultFlags,
         preventFetch,
         enableLogs,
+        dtrum,
         enableAnalytics,
         AsyncStorage: _AsyncStorage,
         identity,
@@ -248,6 +269,10 @@ const Flagsmith = class {
                 throw ('Please specify a environment id');
             }
 
+            if (dtrum) {
+                this.dtrum = dtrum;
+            }
+
             if(angularHttpClient) {
                 _fetch = (url: string, params: { headers: Record<string, string>, method: "GET" | "POST" | "PUT", body: string }) => {
                     const {headers, method, body} = params
@@ -424,7 +449,6 @@ const Flagsmith = class {
             environmentID: this.environmentID,
             flags: this.flags,
             identity: this.identity,
-            segments: this.segments,
             traits: this.traits,
             evaluationEvent: this.evaluationEvent,
         }
@@ -437,7 +461,6 @@ const Flagsmith = class {
             this.environmentID = state.environmentID || this.environmentID;
             this.flags = state.flags || this.flags;
             this.identity = state.identity || this.identity;
-            this.segments = state.segments || this.segments;
             this.traits = state.traits || this.traits;
             this.evaluationEvent = state.evaluationEvent || this.evaluationEvent;
         }
@@ -467,7 +490,6 @@ const Flagsmith = class {
 
     logout() {
         this.identity = null;
-        this.segments = null;
         this.traits = null;
         if (this.initialised) {
             return this.getFlags();
@@ -614,3 +636,16 @@ type Config= {fetch?:any, AsyncStorage?:any};
 export default function ({ fetch, AsyncStorage }:Config):IFlagsmith {
     return new Flagsmith({ fetch, AsyncStorage }) as IFlagsmith;
 };
+
+// transforms any trait to match sendSessionProperties
+// https://www.dynatrace.com/support/doc/javascriptapi/interfaces/dtrum_types.DtrumApi.html#addActionProperties
+const setDynatraceValue = function (obj, trait, value) {
+    let key = 'shortString'
+    let convertToString = true
+    if (typeof value === 'number') {
+        key = 'javaDouble'
+        convertToString = false
+    }
+    obj[key] = obj[key] || {}
+    obj[key][trait] = convertToString ? value+"":value
+}

flagsmith-core.ts

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-es",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Feature flagging to support continuous development. This is an esm equivalent of the standard flagsmith npm module.",
   "main": "./index.js",
   "type": "module",

flagsmith-es/index.js

@@ -32,6 +32,7 @@ export interface IInitConfig {
     api?: string;
     cacheFlags?: boolean;
     defaultFlags?: IFlags;
+    dtrum?: any;
     enableAnalytics?: boolean;
     enableLogs?: boolean;
     angularHttpClient?: any;