Merge remote-tracking branch 'powerbi/master'

Author: ali-hamud

demo/v2-demo/index.html

@@ -59,10 +59,14 @@
 
     <script src="scripts/codesamples.js"></script>
 
+    <script src="scripts/aisdk.js"></script>
     <script src="scripts/index.js"></script>
     <script src="scripts/utils.js"></script>
+    <script src="scripts/assert.js"></script>
     <script src="scripts/logger.js"></script>
+    <script src="scripts/guid.js"></script>
     <script src="scripts/session_utils.js"></script>
+    <script src="scripts/telemetry.js"></script>
     <script src="scripts/function_mapping.js"></script>
 
     <script src="scripts/report.js"></script>

demo/v2-demo/scripts/aisdk.js

@@ -0,0 +1,5 @@
+function assert(exp){
+  if(console["assert"]){
+      console.assert(exp);
+  }
+}

demo/v2-demo/scripts/assert.js

@@ -0,0 +1,18 @@
+/**
+ * Generates a 20 character uuid.
+ */
+function generateNewGuid() {
+  let d = new Date().getTime();
+  if (typeof performance !== 'undefined' && typeof performance.now === 'function') {
+    d += performance.now();
+  }
+  return 'xxxxxxxxxxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+    // Generate a random number, scaled from 0 to 16.
+    // Bitwise-and by 15 since we only care about the last 4 bits.
+    const r = (d + Math.random() * 16) & 15 | 0;
+
+    // Shift 4 times to divide by 16
+    d >>= 4;
+    return r.toString(16);
+  });
+}

demo/v2-demo/scripts/guid.js

@@ -27,7 +27,6 @@ function OpenEmbedWorkspace(activeTabSelector, samplesStepHtml)
 
     $(".content").hide();
     $("#sampleContent").show();
-    OpenSamplesStep();
 
     LayoutShowcaseState.layoutReport = null;
     BookmarkShowcaseState.bookmarksReport = null;
@@ -44,6 +43,7 @@ function OpenDocumentationSection() {
 
     $(".content").hide();
     $("#documentationContent").show();
+    trackEvent(TelemetryEventName.SectionOpen, { section: TelemetrySectionName.Documentation, src: TelemetryEventSource.UserClick });
 }
 
 function OpenShowcasesSection() {
@@ -58,6 +58,7 @@ function OpenShowcasesSection() {
 
     $(".content").hide();
     $("#showcasesContent").show();
+    trackEvent(TelemetryEventName.SectionOpen, { section: TelemetrySectionName.Showcase, src: TelemetryEventSource.UserClick });
 }
 
 function SetActiveStyle(id)
@@ -77,6 +78,7 @@ const ShowcasesHtmls = {
 function OpenShowcase(showcaseType) {
     $("#showcasesContent").load(ShowcasesHtmls[showcaseType]);
     showcasesContentLoaded = false;
+    trackEvent(TelemetrySectionName.Showcase, { showcaseType: showcaseType, src: TelemetryEventSource.UserClick });
 }
 
 function OpenShowcaseFromURL(showcase) {
@@ -85,4 +87,5 @@ function OpenShowcaseFromURL(showcase) {
 
     $(".content").hide();
     $("#showcasesContent").show();
+    trackEvent(TelemetrySectionName.Showcase, { showcaseType: showcase, src: TelemetryEventSource.Url });
 }

demo/v2-demo/scripts/index.js

@@ -30,6 +30,8 @@ function OpenSamplesStep() {
     $("#embed-and-interact-steps-wrapper").hide();
 
     $("#welcome-text").show();
+
+    trackEvent(TelemetryEventName.InnerSectionOpen, { section: TelemetryInnerSection.Sample, src: TelemetryEventSource.UserClick });
 }
 
 function OpenCodeStepFromNavPane()
@@ -79,11 +81,20 @@ function OpenCodeStep(mode, entityType, tokenType) {
     $('#interact-tab').removeClass(active_tabs_li);
 
     LoadEmbedSettings(mode, entityType, tokenType);
+
+    trackEvent(TelemetryEventName.InnerSectionOpen, { section: TelemetryInnerSection.Code, src: TelemetryEventSource.UserClick });
 }
 
 function bootstrapIframe(entityType) {
     const activeContainer = getActiveEmbedContainer();
 
+    // To avoid multiple bootstrap when switching between Desktop view and Phone view 
+    // and also when changing the mode (view/edit/create).
+    if (activeContainer.children.length > 0) {
+      // entity is already embedded
+      return;
+    }
+
     // Bootstrap iframe - for better performance.
     let embedUrl = GetSession(SessionKeys.EmbedUrl);
     config = {
@@ -574,6 +585,7 @@ function EmbedAreaDesktopView() {
             runFunc();
         }
     }
+    trackEvent(TelemetryEventName.DesktopModeOpen, {});
 }
 
 function EmbedAreaMobileView() {
@@ -631,6 +643,7 @@ function EmbedAreaMobileView() {
         }
       }
     }
+    trackEvent(TelemetryEventName.MobileModeOpen, {});
 }
 
 function updateRunFuncSessionParameters(runFunc) {
@@ -684,5 +697,6 @@ function hideFeaturesOnMobile(){
 
 function onShowcaseTryMeClicked(showcase) {
     let showcaseUrl = location.href.substring(0, location.href.lastIndexOf("/")) + '?showcase=' + showcase;
+    trackEvent(TelemetrySectionName.Showcase, { showcaseType: showcase, src: TelemetryEventSource.Interact });
     window.open(showcaseUrl, '_blank');
 }

demo/v2-demo/scripts/report.js

@@ -22,28 +22,39 @@ const EntityType = {
     Qna: "Qna"
 };
 
-var _session = {};
-
 const SessionKeys = {
     AccessToken : "accessToken",
+    DashboardId : "dashboardId",
     EmbedUrl : "embedUrl",
     EmbedId : "embedId",
-    DashboardId : "dashboardId",
     EmbedMode: "embedMode",
     EntityType: "entityType",
     GroupId : "groupId",
     IsSampleReport: "isSampleReport",
     IsSampleDashboard: "IsSampleDashboard",
     IsSampleTile: "IsSampleTile",
     IsSampleQna: "IsSampleQna",
+    IsTelemetryEnabled: "isTelemetryEnabled",
     PageName: "PageName",
     QnaQuestion: "QnaQuestion",
     QnaMode: "QnaMode",
     SampleId: "SampleId",
+    SessionId: "SessionId",
     TokenType: "tokenType",
     VisualName: "VisualName"
 };
 
+var _session = {};
+
+function initSession() {
+    SetSession(SessionKeys.SessionId, generateNewGuid());
+    if (GetParameterByName(SessionKeys.IsTelemetryEnabled) === "false") {
+        SetSession(SessionKeys.IsTelemetryEnabled, false);
+    } else {
+        SetSession(SessionKeys.IsTelemetryEnabled, true);
+    }
+}
+
 function GetParameterByName(name, url) {
     if (!url) {
       url = window.location.href;
@@ -317,3 +328,5 @@ function setSession(accessToken, embedUrl, embedId, dashboardId)
     SetSession(SessionKeys.EmbedId, embedId);
     SetSession(SessionKeys.DashboardId, dashboardId);
 }
+
+initSession();

demo/v2-demo/scripts/session_utils.js

@@ -32,4 +32,10 @@ function OpenCodeStepWithSample(entityType) {
       SetSession(SessionKeys.IsSampleQna, true);
       OpenCodeStep(EmbedViewMode, EntityType.Qna)
     }
+    else {
+      assert(false);
+      trackEvent(TelemetryEventName.CodeStepError, {});
+      return;
+    }
+    trackEvent(TelemetrySectionName.SampleTool, { entityType: entityType, src: TelemetryEventSource.UserClick });
 }

demo/v2-demo/scripts/step_samples.js

@@ -0,0 +1,44 @@
+const TelemetryEventName = {
+    CodeStepError: "CodeStepError",
+    CopyCode: "CopyCode",
+    CopyLog: "CopyLog",
+    DesktopModeOpen: "DesktopModeOpen",
+    InnerSectionOpen: "InnerSectionOpen",
+    Interact: "Interact",
+    MobileModeOpen: "MobileModeOpen",
+    RunClick: "RunClick",
+    SectionOpen: "SectionOpen",
+    SessionStart: "SessionStart"
+};
+const TelemetryEventSource = {
+    Url: "Url",
+    UserClick: "UserClick"
+};
+
+const TelemetryInnerSection = {
+    Code: "Code",
+    Sample: "Sample"
+};
+
+const TelemetrySectionName = {
+    Documentation: "Documentation",
+    SampleTool: "SampleTool",
+    Showcase: "Showcase"
+};
+
+function trackEvent(name, properties, flush = false) {
+    if (!_session[SessionKeys.IsTelemetryEnabled]) {
+        return;
+    }
+    assert(name && properties);
+    properties.sessionId = GetSession(SessionKeys.SessionId);
+
+    // Normally, the SDK sends data at fixed intervals (typically 30 secs) or whenever buffer is full (typically 500 items).
+    // https://docs.microsoft.com/en-us/azure/azure-monitor/app/api-custom-events-metrics#flushing-data
+    appInsights.trackEvent({ name, properties });
+    if (flush) {
+        appInsights.flush();
+    }
+}
+
+trackEvent(TelemetryEventName.SessionStart, { referrer: document.referrer }, true);

demo/v2-demo/scripts/telemetry.js

@@ -54,8 +54,8 @@ function SetCode(func) {
 
     if (func != "") {
         let runFunc = mapFunc(func);
-
-        if (getFuncName(runFunc).match(/Embed/)) {
+        let funcName = getFuncName(runFunc);
+        if (funcName.match(/Embed/)) {
             let oldFunc = runFunc;
             runFunc = function() {
                 oldFunc();
@@ -74,6 +74,7 @@ function SetCode(func) {
             showEmbedContainer();
             removeIframeIfUrlIsChanged();
             elementClicked('#btnRunCode');
+            trackEvent(TelemetryEventName.RunClick, { EmbedType: GetSession(SessionKeys.EntityType), TokenType: GetSession(SessionKeys.TokenType), ApiUsed: funcName });
             runFunc();
         });
         // TODO: add indication to click Interact tab on first embedding
@@ -92,10 +93,12 @@ function CopyCode() {
 
     textarea.value = currentCode;
     CopyTextArea('#' + id, "#btnRunCopyCode");
+    trackEvent(TelemetryEventName.CopyCode, {});
 }
 
 function CopyResponseWindow() {
     CopyTextArea("#txtResponse", "#btnCopyResponse");
+    trackEvent(TelemetryEventName.CopyLog, {});
 }
 
 function CopyTextArea(textAreaSelector, buttonSelector) {
@@ -179,7 +182,9 @@ function removeIframeIfUrlIsChanged() {
       return;
     }
 
-    let existingIframeUrl = removeUidFromUrl(activeContainer.powerBiEmbed.iframe.src);
+    let existingIframeUrl = removeArgFromUrl(activeContainer.powerBiEmbed.iframe.src, "uid");
+    existingIframeUrl = removeArgFromUrl(existingIframeUrl, "isMobile");
+
     let embedUrl = GetSession(SessionKeys.EmbedUrl);
 
     if (embedUrl !== existingIframeUrl) {
@@ -216,12 +221,12 @@ function SetAuthoringPageActive(report) {
     });
 }
 
-function removeUidFromUrl(url) {
-    const uidRegEx = /uid="?([^&]+)"?/
-    const uidMatch = url.match(uidRegEx);
+function removeArgFromUrl(url, arg) {
+    const argRegEx = new RegExp(arg + '="?([^&]+)"?')
+    const argMatch = url.match(argRegEx);
 
-    if (uidMatch) {
-        return url.replace("&" + uidMatch[0], "");
+    if (argMatch) {
+        return url.replace("&" + argMatch[0], "");
     }
 
     return url;