Merge pull request #49 from SharePoint/dev

PR for 1.2.3

Author: estruyf

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Releases
 
+## 1.2.3
+
+**Enhancements**
+
+- Optimized telemetry so that it only pushes control data
+- `WebPartTitle` hide control completely when empty
+
 ## 1.2.2
 
 **Fixes**

docs/documentation/docs/about/release-notes.md

@@ -1,5 +1,12 @@
 # Releases
 
+## 1.2.3
+
+**Enhancements**
+
+- Optimized telemetry so that it only pushes control data
+- `WebPartTitle` hide control completely when empty
+
 ## 1.2.2
 
 **Fixes**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pnp/spfx-controls-react",
   "description": "Reusable React controls for SharePoint Framework solutions",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "engines": {
     "node": ">=0.10.0"
   },

src/common/appInsights/index.ts

@@ -2,16 +2,35 @@ import { AppInsights } from "applicationinsights-js";
 import { version } from './version';
 import {Environment,EnvironmentType} from "@microsoft/sp-core-library";
 
+const controlType = "react";
+
 AppInsights.downloadAndSetup({ instrumentationKey: "9f59b81e-d2ed-411e-a961-8bcf3f7f04d0" });
 
-// Remove operation name from the telemetry
-if (AppInsights.context && AppInsights.context.operation && AppInsights.context.operation.name) {
-  AppInsights.context.operation.name = null;
-}
+appInsights.queue.push(() => {
+  // Remove operation name from the telemetry
+  if (AppInsights.context && AppInsights.context.operation && AppInsights.context.operation.name) {
+    AppInsights.context.operation.name = null;
+  }
+
+  // Filter out telemetry data
+  appInsights.context.addTelemetryInitializer((envelope: Microsoft.ApplicationInsights.IEnvelope) => {
+    const telemetryItem = envelope.data.baseData;
+    // Only send telemetry data if it contains data of this library
+    if (!telemetryItem.properties || !telemetryItem.properties.controlType) {
+      return false;
+    }
+
+    // Only send telemetry if it is coming from the right control type
+    if (telemetryItem.properties && telemetryItem.properties.controlType && telemetryItem.properties.controlType !== controlType) {
+      return false;
+    }
+  });
+});
 
 export function track(componentName: string, properties: any = {}): void {
   AppInsights.trackEvent(componentName, {
     version,
+    controlType,
     debug: DEBUG ? "true" : "false",
     environment: EnvironmentType[Environment.type],
     ...properties

src/controls/webPartTitle/WebPartTitle.tsx

@@ -41,16 +41,20 @@ export class WebPartTitle extends React.Component<IWebPartTitleProps, {}> {
    * Default React component render method
    */
   public render(): React.ReactElement<IWebPartTitleProps> {
-    return (
-      <div className={`${styles.webPartTitle} ${this.props.className ? this.props.className : ''}` }>
-        {
-          this.props.displayMode === DisplayMode.Edit && <textarea placeholder={strings.WebPartTitlePlaceholder} aria-label={strings.WebPartTitleLabel} onChange={this._onChange} defaultValue={this.props.title}></textarea>
-        }
-
-        {
-          this.props.displayMode !== DisplayMode.Edit && this.props.title && <span>{this.props.title}</span>
-        }
-      </div>
-    );
+    if (this.props.title || this.props.displayMode === DisplayMode.Edit) {
+      return (
+        <div className={`${styles.webPartTitle} ${this.props.className ? this.props.className : ''}` }>
+          {
+            this.props.displayMode === DisplayMode.Edit && <textarea placeholder={strings.WebPartTitlePlaceholder} aria-label={strings.WebPartTitleLabel} onChange={this._onChange} defaultValue={this.props.title}></textarea>
+          }
+
+          {
+            this.props.displayMode !== DisplayMode.Edit && this.props.title && <span>{this.props.title}</span>
+          }
+        </div>
+      );
+    }
+
+    return null;
   }
 }