add node.js package

Author: zhiyuanliang-ms

.github/workflows/ci.yml

@@ -59,4 +59,12 @@ jobs:
 
     - name: Run lint check for feature-management-applicationinsights-browser
       run: npm run lint
-      working-directory: sdk/feature-management-applicationinsights-browser
+      working-directory: sdk/feature-management-applicationinsights-browser
+
+    - name: Build feature-management-applicationinsights-node
+      run: npm run build
+      working-directory: sdk/feature-management-applicationinsights-node
+
+    - name: Run lint check for feature-management-applicationinsights-node
+      run: npm run lint
+      working-directory: sdk/feature-management-applicationinsights-node

scripts/build-and-pack.sh

@@ -41,4 +41,19 @@ echo "npm pack in $PACKAGE_DIR"
 npm pack
 
 echo "copy $PACKAGE package to $PROJECT_BASE_DIR"
-cp "$PACKAGE_DIR"/*.tgz "$PROJECT_BASE_DIR"
+cp "$PACKAGE_DIR"/*.tgz "$PROJECT_BASE_DIR"
+
+PACKAGE="feature-management-applicationinsights-node"
+PACKAGE_DIR="$SDK_DIR/$PACKAGE"
+
+echo "Building package $PACKAGE in $PACKAGE_DIR"
+cd "$PACKAGE_DIR"
+
+echo "npm run build in $PACKAGE_DIR"
+npm run build
+
+echo "npm pack in $PACKAGE_DIR"
+npm pack
+
+echo "copy $PACKAGE package to $PROJECT_BASE_DIR"
+cp "$PACKAGE_DIR"/*.tgz "$PROJECT_BASE_DIR"

sdk/feature-management-applicationinsights-node/README.md

@@ -11,20 +11,22 @@ Feature Management Application Insights Plugin for Browser provides a solution f
 ### Usage
 
 ``` javascript
-import applicationInsights from "applicationinsights";
+import appInsights from "applicationinsights";
 import { FeatureManager, ConfigurationObjectFeatureFlagProvider } from "@microsoft/feature-management";
 import { trackEvent, publishTelemetry } from "@microsoft/feature-management-applicationinsights-node";
 
-applicationInsights.setup(CONNECTION_STRING).start();
+appInsights.setup(CONNECTION_STRING)
+           .start();
 
+const publishTelemetry = createTelemetryPublisher(appInsights.defaultClient);
 const provider = new ConfigurationObjectFeatureFlagProvider(jsonObject);
 const featureManager = new FeatureManager(provider, {onFeatureEvaluated: publishTelemetry});
 
 // FeatureEvaluation event will be emitted when a feature flag is evaluated
 featureManager.getVariant("TestFeature", {userId : TARGETING_ID}).then((variant) => { /* do something*/ });
 
 // Emit a custom event with targeting id attached.
-trackEvent(TARGETING_ID, {name: "TestEvent"});
+trackEvent(appInsights.defaultClient, TARGETING_ID, {name: "TestEvent"});
 ```
 
 ## Contributing

sdk/feature-management-applicationinsights-node/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@microsoft/feature-management-applicationinsights-node",
   "version": "2.0.0-preview.2",
-  "description": "Feature Management Application Insights Plugin for Browser provides a solution for sending feature flag evaluation events produced by the Feature Management library.",
+  "description": "Feature Management Application Insights Plugin for Node.js provides a solution for sending feature flag evaluation events produced by the Feature Management library.",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "types/index.d.ts",

sdk/feature-management-applicationinsights-node/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { publishTelemetry, trackEvent } from "./telemetry.js";
+export { createTelemetryPublisher, trackEvent } from "./telemetry.js";
 export { VERSION } from "./version.js";

sdk/feature-management-applicationinsights-node/src/telemetry.ts

@@ -2,31 +2,50 @@
 // Licensed under the MIT license.
 
 import { EvaluationResult } from "@microsoft/feature-management";
-import { applicationInsights } from "applicationinsights";
+import { TelemetryClient, Contracts } from "applicationinsights";
 
-export function publishTelemetry(event: EvaluationResult): void {
-    if (applicationInsights.defaultClient === undefined) {
-        console.warn(`Application Insights default client is not found.`);
-        return;
-    }
+/**
+ * Creates a telemetry publisher that sends feature evaluation events to Application Insights.
+ * @param client The Application Insights telemetry client.
+ * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.
+ */
+export function createTelemetryPublisher(client: TelemetryClient): (event: EvaluationResult) => void {
+    return (event: EvaluationResult) => {
+        const eventProperties = {
+            "FeatureName": event.feature ? event.feature.id : "",
+            "Enabled": event.enabled.toString(),
+            // Ensure targetingId is string so that it will be placed in customDimensions
+            "TargetingId": event.targetingId ? event.targetingId.toString() : "",
+            "Variant": event.variant ? event.variant.name : "",
+            "VariantAssignmentReason": event.variantAssignmentReason,
+        };
 
-    const eventProperties = {
-        "FeatureName": event.feature ? event.feature.id : "",
-        "Enabled": event.enabled.toString(),
-        // Ensure targetingId is string so that it will be placed in customDimensions
-        "TargetingId": event.targetingId ? event.targetingId.toString() : "",
-        "Variant": event.variant ? event.variant.name : "",
-        "VariantAssignmentReason": event.variantAssignmentReason,
-    };
-
-    const metadata = event.feature?.telemetry?.metadata;
-    if (metadata) {
-        for (const key in metadata) {
-            if (!(key in eventProperties)) {
-                eventProperties[key] = metadata[key];
+        const metadata = event.feature?.telemetry?.metadata;
+        if (metadata) {
+            for (const key in metadata) {
+                if (!(key in eventProperties)) {
+                    eventProperties[key] = metadata[key];
+                }
             }
         }
-    }
 
-    applicationInsights.defaultClient.trackEvent({ name: "FeatureEvaluation", properties: eventProperties});
-}
+        client.trackEvent({ name: "FeatureEvaluation", properties: eventProperties });
+    };
+}
+
+/**
+ * Tracks a custom event using Application Insights, ensuring that the "TargetingId"
+ * is included in the custom properties. If the "TargetingId" already exists in
+ * the provided custom properties, it will be overwritten.
+ *
+ * @param client The Application Insights client instance used to track the event.
+ * @param targetingId The unique targeting identifier that will be included in the custom properties.
+ * @param event The event telemetry object to be tracked, containing event details.
+ */
+export function trackEvent(client: TelemetryClient, targetingId: string, event: Contracts.EventTelemetry): void {
+    event.properties = { 
+        ...event.properties,
+        TargetingId: targetingId ? targetingId.toString() : ""
+    };
+    client.trackEvent(event);
+}