@microsoft/applicationinsights-core-js 3.0.0-beta.2303-03 → 3.0.0-beta.2303-05

package/src/JavaScriptSDK/RandomHelper.ts

@@ -1,145 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-import { utcNow } from "@nevware21/ts-utils";
-import { getCrypto, getMsCrypto, isIE } from "./EnvUtils";
-import { STR_EMPTY } from "./InternalConstants";
-
-const UInt32Mask = 0x100000000;
-const MaxUInt32 = 0xffffffff;
-
-// MWC based Random generator (for IE)
-let _mwcSeeded = false;
-let _mwcW = 123456789;
-var _mwcZ = 987654321;
-
-// Takes any integer
-function _mwcSeed(seedValue: number) {
-    if (seedValue < 0) {
-        // Make sure we end up with a positive number and not -ve one.
-        seedValue >>>= 0;
-    }
-
-    _mwcW = (123456789 + seedValue) & MaxUInt32;
-    _mwcZ = (987654321 - seedValue) & MaxUInt32;
-    _mwcSeeded = true;
-}
-
-function _autoSeedMwc() {
-    // Simple initialization using default Math.random() - So we inherit any entropy from the browser
-    // and bitwise XOR with the current milliseconds
-    try {
-        const now = utcNow() & 0x7fffffff;
-        _mwcSeed(((Math.random() * UInt32Mask) ^ now) + now);
-    } catch (e) {
-        // Don't crash if something goes wrong
-    }
-}
-
-/**
- * Generate a random value between 0 and maxValue, max value should be limited to a 32-bit maximum.
- * So maxValue(16) will produce a number from 0..16 (range of 17)
- * @param maxValue
- */
-export function randomValue(maxValue: number) {
-    if (maxValue > 0) {
-        return Math.floor((random32() / MaxUInt32) * (maxValue + 1)) >>> 0;
-    }
-
-    return 0;
-}
-
-/**
- * generate a random 32-bit number (0x000000..0xFFFFFFFF) or (-0x80000000..0x7FFFFFFF), defaults un-unsigned.
- * @param signed - True to return a signed 32-bit number (-0x80000000..0x7FFFFFFF) otherwise an unsigned one (0x000000..0xFFFFFFFF)
- */
-export function random32(signed?: boolean) {
-    let value = 0;
-    let c = getCrypto() || getMsCrypto();
-    if (c && c.getRandomValues) {
-        // Make sure the number is converted into the specified range (-0x80000000..0x7FFFFFFF)
-        value = c.getRandomValues(new Uint32Array(1))[0] & MaxUInt32;
-    }
-    
-    if (value === 0 && isIE()) {
-        // For IE 6, 7, 8 (especially on XP) Math.random is not very random
-        if (!_mwcSeeded) {
-            // Set the seed for the Mwc algorithm
-            _autoSeedMwc();
-        }
-
-        // Don't use Math.random for IE
-        // Make sure the number is converted into the specified range (-0x80000000..0x7FFFFFFF)
-        value = mwcRandom32() & MaxUInt32;
-    }
-
-    if (value === 0) {
-        // Make sure the number is converted into the specified range (-0x80000000..0x7FFFFFFF)
-        value = Math.floor((UInt32Mask * Math.random()) | 0);
-    }
-
-    if (!signed) {
-        // Make sure we end up with a positive number and not -ve one.
-        value >>>= 0;
-    }
-
-    return value;
-}
-
-/**
- * Seed the MWC random number generator with the specified seed or a random value
- * @param value - optional the number to used as the seed, if undefined, null or zero a random value will be chosen
- */
-export function mwcRandomSeed(value?: number) {
-    if (!value) {
-        _autoSeedMwc();
-    } else {
-        _mwcSeed(value);
-    }
-}
-
-/**
- * Generate a random 32-bit number between (0x000000..0xFFFFFFFF) or (-0x80000000..0x7FFFFFFF), using MWC (Multiply with carry)
- * instead of Math.random() defaults to un-signed.
- * Used as a replacement random generator for IE to avoid issues with older IE instances.
- * @param signed - True to return a signed 32-bit number (-0x80000000..0x7FFFFFFF) otherwise an unsigned one (0x000000..0xFFFFFFFF)
- */
-export function mwcRandom32(signed?: boolean) {
-    _mwcZ = (36969 * (_mwcZ & 0xFFFF) + (_mwcZ >> 16)) & MaxUInt32;
-    _mwcW = (18000 * (_mwcW & 0xFFFF) + (_mwcW >> 16)) & MaxUInt32;
-
-    let value = (((_mwcZ << 16) + (_mwcW & 0xFFFF)) >>> 0) & MaxUInt32 | 0;
-
-    if (!signed) {
-        // Make sure we end up with a positive number and not -ve one.
-        value >>>= 0;
-    }
-
-    return value;
-}
-
-/**
- * Generate random base64 id string.
- * The default length is 22 which is 132-bits so almost the same as a GUID but as base64 (the previous default was 5)
- * @param maxLength - Optional value to specify the length of the id to be generated, defaults to 22
- */
-export function newId(maxLength = 22): string {
-    const base64chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
-
-    // Start with an initial random number, consuming the value in reverse byte order
-    let number = random32() >>> 0;  // Make sure it's a +ve number
-    let chars = 0;
-    let result = STR_EMPTY;
-    while (result.length < maxLength) {
-        chars ++;
-        result += base64chars.charAt(number & 0x3F);
-        number >>>= 6;              // Zero fill with right shift
-        if (chars === 5) {
-            // 5 base64 characters === 30 bits so we don't have enough bits for another base64 char
-            // So add on another 30 bits and make sure it's +ve
-            number = (((random32() << 2) & 0xFFFFFFFF) | (number & 0x03)) >>> 0;
-            chars = 0;      // We need to reset the number every 5 chars (30 bits)
-        }
-    }
-
-    return result;
-}

package/src/JavaScriptSDK/TelemetryHelpers.ts

@@ -1,184 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-import { arrForEach, isFunction } from "@nevware21/ts-utils";
-import { IAppInsightsCore } from "../JavaScriptSDK.Interfaces/IAppInsightsCore";
-import { IDistributedTraceContext } from "../JavaScriptSDK.Interfaces/IDistributedTraceContext";
-import { IProcessTelemetryContext, IProcessTelemetryUnloadContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
-import { IPlugin, ITelemetryPlugin } from "../JavaScriptSDK.Interfaces/ITelemetryPlugin";
-import { ITelemetryPluginChain } from "../JavaScriptSDK.Interfaces/ITelemetryPluginChain";
-import { ITelemetryUnloadState } from "../JavaScriptSDK.Interfaces/ITelemetryUnloadState";
-import { ITraceParent } from "../JavaScriptSDK.Interfaces/ITraceParent";
-import { IUnloadableComponent } from "../JavaScriptSDK.Interfaces/IUnloadableComponent";
-import { createElmNodeData } from "./DataCacheHelper";
-import { STR_CORE, STR_PRIORITY, STR_PROCESS_TELEMETRY } from "./InternalConstants";
-import { isValidSpanId, isValidTraceId } from "./W3cTraceParent";
-
-export interface IPluginState {
-    core?: IAppInsightsCore;
-    isInitialized?: boolean;
-    teardown?: boolean;
-    disabled?: boolean;
-}
-
-const pluginStateData = createElmNodeData("plugin");
-
-export function _getPluginState(plugin: IPlugin): IPluginState {
-    return pluginStateData.get<IPluginState>(plugin, "state", {}, true)
-}
-
-/**
- * Initialize the queue of plugins
- * @param plugins - The array of plugins to initialize and setting of the next plugin
- * @param config - The current config for the instance
- * @param core - THe current core instance
- * @param extensions - The extensions
- */
-export function initializePlugins(processContext: IProcessTelemetryContext, extensions: IPlugin[]) {
-
-    // Set the next plugin and identified the uninitialized plugins
-    let initPlugins: ITelemetryPlugin[] = [];
-    let lastPlugin: ITelemetryPlugin = null;
-    let proxy: ITelemetryPluginChain = processContext.getNext();
-    let pluginState: IPluginState;
-
-    while (proxy) {
-        let thePlugin = proxy.getPlugin();
-        if (thePlugin) {
-            if (lastPlugin && lastPlugin.setNextPlugin && thePlugin.processTelemetry) {
-                // Set this plugin as the next for the previous one
-                lastPlugin.setNextPlugin(thePlugin);
-            }
-
-            pluginState = _getPluginState(thePlugin);
-
-            let isInitialized = !!pluginState.isInitialized;
-            if (thePlugin.isInitialized) {
-                isInitialized = thePlugin.isInitialized();
-            }
-
-            if (!isInitialized) {
-                initPlugins.push(thePlugin);
-            }
-
-            lastPlugin = thePlugin;
-            proxy = proxy.getNext();
-        }
-    }
-
-    // Now initialize the plugins
-    arrForEach(initPlugins, thePlugin => {
-        let core = processContext.core();
-
-        thePlugin.initialize(
-            processContext.getCfg(),
-            core,
-            extensions,
-            processContext.getNext());
-
-        pluginState = _getPluginState(thePlugin);
-
-        // Only add the core to the state if the plugin didn't set it (doesn't extend from BaseTelemetryPlugin)
-        if (!thePlugin[STR_CORE] && !pluginState[STR_CORE]) {
-            pluginState[STR_CORE] = core;
-        }
-
-        pluginState.isInitialized = true;
-        delete pluginState.teardown;
-    });
-}
-
-export function sortPlugins<T = IPlugin>(plugins:T[]) {
-    // Sort by priority
-    return plugins.sort((extA, extB) => {
-        let result = 0;
-        if (extB) {
-            let bHasProcess = extB[STR_PROCESS_TELEMETRY];
-            if (extA[STR_PROCESS_TELEMETRY]) {
-                result = bHasProcess ? extA[STR_PRIORITY] - extB[STR_PRIORITY] : 1;
-            } else if (bHasProcess) {
-                result = -1;
-            }
-        } else {
-            result = extA ? 1 : -1;
-        }
-
-        return result;
-    });
-    // sort complete
-}
-
-/**
- * Teardown / Unload helper to perform teardown/unloading operations for the provided components synchronously or asynchronously, this will call any
- * _doTeardown() or _doUnload() functions on the provided components to allow them to finish removal.
- * @param components - The components you want to unload
- * @param unloadCtx - This is the context that should be used during unloading.
- * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
- * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.
- * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
- */
-export function unloadComponents(components: any | IUnloadableComponent[], unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean {
-    let idx = 0;
-
-    function _doUnload(): void | boolean {
-        while (idx < components.length) {
-            let component = components[idx++];
-            if (component) {
-                let func = component._doUnload || component._doTeardown;
-                if (isFunction(func)) {
-                    if (func.call(component, unloadCtx, unloadState, _doUnload) === true) {
-                        return true;
-                    }
-                }
-            }
-        }
-    }
-
-    return _doUnload();
-}
-
-
-/**
- * Creates a IDistributedTraceContext which optionally also "sets" the value on a parent
- * @param parentCtx - An optional parent distributed trace instance
- * @returns A new IDistributedTraceContext instance that uses an internal temporary object
- */
-export function createDistributedTraceContext(parentCtx?: IDistributedTraceContext): IDistributedTraceContext {
-    let trace: ITraceParent = {} as ITraceParent;
-
-    return {
-        getName: (): string => {
-            return (trace as any).name;
-        },
-        setName: (newValue: string): void => {
-            parentCtx && parentCtx.setName(newValue);
-            (trace as any).name = newValue;
-        },
-        getTraceId: (): string => {
-            return trace.traceId;
-        },
-        setTraceId: (newValue: string): void => {
-            parentCtx && parentCtx.setTraceId(newValue);
-            if (isValidTraceId(newValue)) {
-                trace.traceId = newValue
-            }
-        },
-        getSpanId: (): string => {
-            return trace.spanId;
-        },
-        setSpanId: (newValue: string): void => {
-            parentCtx && parentCtx.setSpanId(newValue);
-            if (isValidSpanId(newValue)) {
-                trace.spanId = newValue
-            }
-        },
-        getTraceFlags: (): number => {
-            return trace.traceFlags;
-        },
-        setTraceFlags: (newTraceFlags?: number): void => {
-            parentCtx && parentCtx.setTraceFlags(newTraceFlags);
-            trace.traceFlags = newTraceFlags
-        }
-    };
-}

package/src/JavaScriptSDK/TelemetryInitializerPlugin.ts

@@ -1,112 +0,0 @@
-// // Copyright (c) Microsoft Corporation. All rights reserved.
-// // Licensed under the MIT License.
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import { arrForEach, dumpObj } from "@nevware21/ts-utils";
-import { _eInternalMessageId, eLoggingSeverity } from "../JavaScriptSDK.Enums/LoggingEnums";
-import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
-import {
-    ITelemetryInitializerContainer, ITelemetryInitializerHandler, TelemetryInitializerFunction
-} from "../JavaScriptSDK.Interfaces/ITelemetryInitializers";
-import { ITelemetryItem } from "../JavaScriptSDK.Interfaces/ITelemetryItem";
-import { BaseTelemetryPlugin } from "./BaseTelemetryPlugin";
-import { _throwInternal } from "./DiagnosticLogger";
-import { getExceptionName } from "./HelperFuncs";
-
-interface _IInternalTelemetryInitializerHandler {
-    id: number;
-    fn: TelemetryInitializerFunction;
-}
-
-export class TelemetryInitializerPlugin extends BaseTelemetryPlugin implements ITelemetryInitializerContainer {
-
-    public identifier: string = "TelemetryInitializerPlugin";
-    priority: number = 199;
-
-    constructor() {
-        super();
-
-        // NOTE!: DON'T set default values here, instead set them in the _initDefaults() function as it is also called during teardown()
-        let _id: number;
-        let _initializers: _IInternalTelemetryInitializerHandler[];
-
-        _initDefaults();
-
-        dynamicProto(TelemetryInitializerPlugin, this, (_self, _base) => {
-
-            _self.addTelemetryInitializer = (telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler => {
-                let theInitializer = {
-                    id: _id++,
-                    fn: telemetryInitializer
-                };
-
-                _initializers.push(theInitializer);
-
-                let handler: ITelemetryInitializerHandler = {
-                    remove: () => {
-                        arrForEach(_initializers, (initializer, idx) => {
-                            if (initializer.id === theInitializer.id) {
-                                _initializers.splice(idx, 1);
-                                return -1;
-                            }
-                        });
-                    }
-                }
-    
-                return handler;
-            }
-
-            _self.processTelemetry = (item: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void => {
-                var doNotSendItem = false;
-                var telemetryInitializersCount = _initializers.length;
-                for (var i = 0; i < telemetryInitializersCount; ++i) {
-                    var telemetryInitializer = _initializers[i];
-                    if (telemetryInitializer) {
-                        try {
-                            if (telemetryInitializer.fn.apply(null, [item]) === false) {
-                                doNotSendItem = true;
-                                break;
-                            }
-                        } catch (e) {
-                            // log error but dont stop executing rest of the telemetry initializers
-                            // doNotSendItem = true;
-                            _throwInternal(
-                                itemCtx.diagLog(),
-                                eLoggingSeverity.WARNING,
-                                _eInternalMessageId.TelemetryInitializerFailed,
-                                "Telemetry initializer failed: " + getExceptionName(e),
-                                { exception: dumpObj(e) }, true);
-                        }
-                    }
-                }
-
-                if (!doNotSendItem) {
-                    _self.processNext(item, itemCtx);
-                }
-            };
-
-            _self._doTeardown = () => {
-                _initDefaults();
-            };
-        });
-
-        function _initDefaults() {
-            _id = 0;
-            _initializers = [];
-        }
-    }
-
-    /**
-     * Add a telemetry processor to decorate or drop telemetry events.
-     * @param telemetryInitializer - The Telemetry Initializer function
-     * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
-     */
-    public addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-        return null;
-    }
-
-    public processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-}

package/src/JavaScriptSDK/UnloadHandlerContainer.ts

@@ -1,45 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { arrForEach, dumpObj } from "@nevware21/ts-utils";
-import { _eInternalMessageId, eLoggingSeverity } from "../JavaScriptSDK.Enums/LoggingEnums";
-import { IProcessTelemetryUnloadContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
-import { ITelemetryUnloadState } from "../JavaScriptSDK.Interfaces/ITelemetryUnloadState";
-import { _throwInternal } from "./DiagnosticLogger";
-
-export type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
-
-export interface IUnloadHandlerContainer {
-    add: (handler: UnloadHandler) => void;
-    run: (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void
-}
-
-export function createUnloadHandlerContainer(): IUnloadHandlerContainer {
-    let handlers: UnloadHandler[] = [];
-
-    function _addHandler(handler: UnloadHandler) {
-        if (handler) {
-            handlers.push(handler);
-        }
-    }
-
-    function _runHandlers(unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) {
-        arrForEach(handlers, (handler) => {
-            try {
-                handler(unloadCtx, unloadState);
-            } catch (e) {
-                _throwInternal(
-                    unloadCtx.diagLog(),
-                    eLoggingSeverity.WARNING,
-                    _eInternalMessageId.PluginException,
-                    "Unexpected error calling unload handler - " + dumpObj(e));
-            }
-        });
-        handlers = [];
-    }
-
-    return {
-        add: _addHandler,
-        run: _runHandlers
-    }
-}

package/src/JavaScriptSDK/UnloadHookContainer.ts

@@ -1,52 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { arrAppend, arrForEach, dumpObj } from "@nevware21/ts-utils";
-import { eLoggingSeverity, _eInternalMessageId } from "../JavaScriptSDK.Enums/LoggingEnums";
-import { IDiagnosticLogger } from "../JavaScriptSDK.Interfaces/IDiagnosticLogger";
-import { ILegacyUnloadHook, IUnloadHook } from "../JavaScriptSDK.Interfaces/IUnloadHook";
-import { _throwInternal } from "./DiagnosticLogger";
-
-/**
- * Interface which identifiesAdd this hook so that it is automatically removed during unloading
- * @param hooks - The single hook or an array of IInstrumentHook objects
- */
-export interface IUnloadHookContainer {
-    add: (hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>) => void;
-    run: (logger?: IDiagnosticLogger) => void;
-}
-
-/**
- * Create a IUnloadHookContainer which can be used to remember unload hook functions to be executed during the component unloading
- * process.
- * @returns A new IUnloadHookContainer instance
- */
-export function createUnloadHookContainer(): IUnloadHookContainer {
-    let _hooks: Array<ILegacyUnloadHook | IUnloadHook> = [];
-
-    function _doUnload(logger: IDiagnosticLogger) {
-        let oldHooks = _hooks;
-        _hooks = [];
-
-        // Remove all registered unload hooks
-        arrForEach(oldHooks, (fn) => {
-            // allow either rm or remove callback function
-            try{
-                ((fn as IUnloadHook).rm || (fn as ILegacyUnloadHook).remove).call(fn);
-            } catch (e) {
-                _throwInternal(logger, eLoggingSeverity.WARNING, _eInternalMessageId.PluginException, "Unloading:" + dumpObj(e));
-            }
-        });
-    }
-
-    function _addHook(hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>) {
-        if (hooks) {
-            arrAppend(_hooks, hooks);
-        }
-    }
-
-    return {
-        run: _doUnload,
-        add: _addHook
-    };
-}