@microsoft/applicationinsights-common 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/src/StorageHelperFuncs.ts

@@ -1,223 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import {
-    IDiagnosticLogger, _eInternalMessageId, _throwInternal, dumpObj, eLoggingSeverity, getExceptionName, getGlobal, getGlobalInst,
-    isNullOrUndefined, objForEachKey
-} from "@microsoft/applicationinsights-core-js";
-import { StorageType } from "./Enums";
-
-let _canUseLocalStorage: boolean = undefined;
-let _canUseSessionStorage: boolean = undefined;
-
-/**
- * Gets the localStorage object if available
- * @return {Storage} - Returns the storage object if available else returns null
- */
-function _getLocalStorageObject(): Storage {
-    if (utlCanUseLocalStorage()) {
-        return _getVerifiedStorageObject(StorageType.LocalStorage);
-    }
-
-    return null;
-}
-
-/**
- * Tests storage object (localStorage or sessionStorage) to verify that it is usable
- * More details here: https://mathiasbynens.be/notes/localstorage-pattern
- * @param storageType - Type of storage
- * @return {Storage} Returns storage object verified that it is usable
- */
-function _getVerifiedStorageObject(storageType: StorageType): Storage {
-    try {
-        if (isNullOrUndefined(getGlobal())) {
-            return null;
-        }
-        let uid = (new Date).toString();
-        let storage: Storage = getGlobalInst(storageType === StorageType.LocalStorage ? "localStorage" : "sessionStorage");
-        storage.setItem(uid, uid);
-        let fail = storage.getItem(uid) !== uid;
-        storage.removeItem(uid);
-        if (!fail) {
-            return storage;
-        }
-    } catch (exception) {
-        // eslint-disable-next-line no-empty
-    }
-
-    return null;
-}
-
-/**
- * Gets the sessionStorage object if available
- * @return {Storage} - Returns the storage object if available else returns null
- */
-function _getSessionStorageObject(): Storage {
-    if (utlCanUseSessionStorage()) {
-        return _getVerifiedStorageObject(StorageType.SessionStorage);
-    }
-
-    return null;
-}
-
-/**
- * Disables the global SDK usage of local or session storage if available
- */
-export function utlDisableStorage() {
-    _canUseLocalStorage = false;
-    _canUseSessionStorage = false;
-}
-
-/**
- * Re-enables the global SDK usage of local or session storage if available
- */
-export function utlEnableStorage() {
-    _canUseLocalStorage = utlCanUseLocalStorage(true);
-    _canUseSessionStorage = utlCanUseSessionStorage(true);
-}
-
-/**
- * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override
- * any previous disable calls.
- * @param reset - Should the usage be reset and determined only based on whether LocalStorage is available
- */
-export function utlCanUseLocalStorage(reset?: boolean): boolean {
-    if (reset || _canUseLocalStorage === undefined) {
-        _canUseLocalStorage = !!_getVerifiedStorageObject(StorageType.LocalStorage);
-    }
-
-    return _canUseLocalStorage;
-}
-
-export function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): string {
-    const storage = _getLocalStorageObject();
-    if (storage !== null) {
-        try {
-            return storage.getItem(name);
-        } catch (e) {
-            _canUseLocalStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserCannotReadLocalStorage,
-                "Browser failed read of local storage. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-    return null;
-}
-
-export function utlSetLocalStorage(logger: IDiagnosticLogger, name: string, data: string): boolean {
-    const storage = _getLocalStorageObject();
-    if (storage !== null) {
-        try {
-            storage.setItem(name, data);
-            return true;
-        } catch (e) {
-            _canUseLocalStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserCannotWriteLocalStorage,
-                "Browser failed write to local storage. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-    return false;
-}
-
-export function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boolean {
-    const storage = _getLocalStorageObject();
-    if (storage !== null) {
-        try {
-            storage.removeItem(name);
-            return true;
-        } catch (e) {
-            _canUseLocalStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserFailedRemovalFromLocalStorage,
-                "Browser failed removal of local storage item. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-    return false;
-}
-
-export function utlCanUseSessionStorage(reset?: boolean): boolean {
-    if (reset || _canUseSessionStorage === undefined) {
-        _canUseSessionStorage = !!_getVerifiedStorageObject(StorageType.SessionStorage);
-    }
-
-    return _canUseSessionStorage;
-}
-
-export function utlGetSessionStorageKeys(): string[] {
-    const keys: string[] = [];
-
-    if (utlCanUseSessionStorage()) {
-        objForEachKey(getGlobalInst<any>("sessionStorage"), (key) => {
-            keys.push(key);
-        });
-    }
-
-    return keys;
-}
-
-export function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): string {
-    const storage = _getSessionStorageObject();
-    if (storage !== null) {
-        try {
-            return storage.getItem(name);
-        } catch (e) {
-            _canUseSessionStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserCannotReadSessionStorage,
-                "Browser failed read of session storage. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-    return null;
-}
-
-export function utlSetSessionStorage(logger: IDiagnosticLogger, name: string, data: string): boolean {
-    const storage = _getSessionStorageObject();
-    if (storage !== null) {
-        try {
-            storage.setItem(name, data);
-            return true;
-        } catch (e) {
-            _canUseSessionStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserCannotWriteSessionStorage,
-                "Browser failed write to session storage. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-    return false;
-}
-
-export function utlRemoveSessionStorage(logger: IDiagnosticLogger, name: string): boolean {
-    const storage = _getSessionStorageObject();
-    if (storage !== null) {
-        try {
-            storage.removeItem(name);
-            return true;
-        } catch (e) {
-            _canUseSessionStorage = false;
-
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.BrowserFailedRemovalFromSessionStorage,
-                "Browser failed removal of session storage item. " + getExceptionName(e),
-                { exception: dumpObj(e) });
-        }
-    }
-
-    return false;
-}

package/src/Telemetry/Common/Data.ts

@@ -1,35 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IData } from "../../Interfaces/Contracts/IData";
-import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
-import { FieldType } from "../../Enums";
-
-export class Data<TDomain> implements IData<TDomain>, ISerializable {
-
-    /**
-     * The data contract for serializing this object.
-     */
-    public aiDataContract = {
-        baseType: FieldType.Required,
-        baseData: FieldType.Required
-    }
-
-    /**
-     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
-     */
-    public baseType: string;
-
-    /**
-     * Container for data item (B section).
-     */
-    public baseData: TDomain;
-
-    /**
-     * Constructs a new instance of telemetry data.
-     */
-    constructor(baseType: string, data: TDomain) {
-        this.baseType = baseType;
-        this.baseData = data;
-    }
-}

package/src/Telemetry/Common/DataPoint.ts

@@ -1,58 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { FieldType } from "../../Enums";
-import { DataPointType } from "../../Interfaces/Contracts/DataPointType";
-import { IDataPoint } from "../../Interfaces/Contracts/IDataPoint";
-import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
-
-export class DataPoint implements IDataPoint, ISerializable {
-
-    /**
-     * The data contract for serializing this object.
-     */
-    public aiDataContract = {
-        name: FieldType.Required,
-        kind: FieldType.Default,
-        value: FieldType.Required,
-        count: FieldType.Default,
-        min: FieldType.Default,
-        max: FieldType.Default,
-        stdDev: FieldType.Default
-    }
-
-    /**
-     * Name of the metric.
-     */
-    public name: string;
-
-    /**
-     * Metric type. Single measurement or the aggregated value.
-     */
-    public kind: DataPointType = DataPointType.Measurement;
- 
-    /**
-     * Single value for measurement. Sum of individual measurements for the aggregation.
-     */
-    public value: number;
- 
-    /**
-     * Metric weight of the aggregated metric. Should not be set for a measurement.
-     */
-    public count: number;
- 
-    /**
-     * Minimum value of the aggregated metric. Should not be set for a measurement.
-     */
-    public min: number;
- 
-    /**
-     * Maximum value of the aggregated metric. Should not be set for a measurement.
-     */
-    public max: number;
- 
-    /**
-     * Standard deviation of the aggregated metric. Should not be set for a measurement.
-     */
-    public stdDev: number;
-}

package/src/Telemetry/Common/DataSanitizer.ts

@@ -1,197 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import {
-    IDiagnosticLogger, _eInternalMessageId, _throwInternal, eLoggingSeverity, getJSON, hasJSON, isObject, objForEachKey, strTrim
-} from "@microsoft/applicationinsights-core-js";
-
-export const enum DataSanitizerValues {
-    /**
-     * Max length allowed for custom names.
-     */
-    MAX_NAME_LENGTH = 150,
-
-     /**
-      * Max length allowed for Id field in page views.
-      */
-    MAX_ID_LENGTH = 128,
- 
-     /**
-      * Max length allowed for custom values.
-      */
-    MAX_PROPERTY_LENGTH = 8192,
- 
-     /**
-      * Max length allowed for names
-      */
-    MAX_STRING_LENGTH = 1024,
- 
-     /**
-      * Max length allowed for url.
-      */
-    MAX_URL_LENGTH = 2048,
- 
-     /**
-      * Max length allowed for messages.
-      */
-    MAX_MESSAGE_LENGTH = 32768,
- 
-     /**
-      * Max length allowed for exceptions.
-      */
-    MAX_EXCEPTION_LENGTH = 32768
-}
-
-export function dataSanitizeKeyAndAddUniqueness(logger: IDiagnosticLogger, key: any, map: any) {
-    const origLength = key.length;
-    let field = dataSanitizeKey(logger, key);
-
-    // validation truncated the length.  We need to add uniqueness
-    if (field.length !== origLength) {
-        let i = 0;
-        let uniqueField = field;
-        while (map[uniqueField] !== undefined) {
-            i++;
-            uniqueField = field.substring(0, DataSanitizerValues.MAX_NAME_LENGTH - 3) + dsPadNumber(i);
-        }
-        field = uniqueField;
-    }
-    return field;
-}
-
-export function dataSanitizeKey(logger: IDiagnosticLogger, name: any) {
-    let nameTrunc: String;
-    if (name) {
-        // Remove any leading or trailing whitespace
-        name = strTrim(name.toString());
-
-        // truncate the string to 150 chars
-        if (name.length > DataSanitizerValues.MAX_NAME_LENGTH) {
-            nameTrunc = name.substring(0, DataSanitizerValues.MAX_NAME_LENGTH);
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.NameTooLong,
-                "name is too long.  It has been truncated to " + DataSanitizerValues.MAX_NAME_LENGTH + " characters.",
-                { name }, true);
-        }
-    }
-
-    return nameTrunc || name;
-}
-
-export function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLength: number = DataSanitizerValues.MAX_STRING_LENGTH) {
-    let valueTrunc : String;
-    if (value) {
-        maxLength = maxLength ? maxLength : DataSanitizerValues.MAX_STRING_LENGTH; // in case default parameters dont work
-        value = strTrim(value.toString());
-        if (value.length > maxLength) {
-            valueTrunc = value.substring(0, maxLength);
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _eInternalMessageId.StringValueTooLong,
-                "string value is too long. It has been truncated to " + maxLength + " characters.",
-                { value }, true);
-        }
-    }
-
-    return valueTrunc || value;
-}
-
-export function dataSanitizeUrl(logger: IDiagnosticLogger, url: any) {
-    return dataSanitizeInput(logger, url, DataSanitizerValues.MAX_URL_LENGTH, _eInternalMessageId.UrlTooLong);
-}
-
-export function dataSanitizeMessage(logger: IDiagnosticLogger, message: any) {
-    let messageTrunc : String;
-    if (message) {
-        if (message.length > DataSanitizerValues.MAX_MESSAGE_LENGTH) {
-            messageTrunc = message.substring(0, DataSanitizerValues.MAX_MESSAGE_LENGTH);
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING, _eInternalMessageId.MessageTruncated,
-                "message is too long, it has been truncated to " + DataSanitizerValues.MAX_MESSAGE_LENGTH + " characters.",
-                { message },
-                true);
-        }
-    }
-
-    return messageTrunc || message;
-}
-
-export function dataSanitizeException(logger: IDiagnosticLogger, exception: any) {
-    let exceptionTrunc : String;
-    if (exception) {
-        // Make surte its a string
-        let value:string = "" + exception;
-        if (value.length > DataSanitizerValues.MAX_EXCEPTION_LENGTH) {
-            exceptionTrunc = value.substring(0, DataSanitizerValues.MAX_EXCEPTION_LENGTH);
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING, _eInternalMessageId.ExceptionTruncated, "exception is too long, it has been truncated to " + DataSanitizerValues.MAX_EXCEPTION_LENGTH + " characters.",
-                { exception }, true);
-        }
-    }
-
-    return exceptionTrunc || exception;
-}
-
-export function dataSanitizeProperties(logger: IDiagnosticLogger, properties: any) {
-    if (properties) {
-        const tempProps = {};
-        objForEachKey(properties, (prop, value) => {
-            if (isObject(value) && hasJSON()) {
-                // Stringify any part C properties
-                try {
-                    value = getJSON().stringify(value);
-                } catch (e) {
-                    _throwInternal(logger,eLoggingSeverity.WARNING, _eInternalMessageId.CannotSerializeObjectNonSerializable, "custom property is not valid", { exception: e}, true);
-                }
-            }
-            value = dataSanitizeString(logger, value, DataSanitizerValues.MAX_PROPERTY_LENGTH);
-            prop = dataSanitizeKeyAndAddUniqueness(logger, prop, tempProps);
-            tempProps[prop] = value;
-        });
-        properties = tempProps;
-    }
-
-    return properties;
-}
-
-export function dataSanitizeMeasurements(logger: IDiagnosticLogger, measurements: any) {
-    if (measurements) {
-        const tempMeasurements = {};
-        objForEachKey(measurements, (measure, value) => {
-            measure = dataSanitizeKeyAndAddUniqueness(logger, measure, tempMeasurements);
-            tempMeasurements[measure] = value;
-        });
-
-        measurements = tempMeasurements;
-    }
-
-    return measurements;
-}
-
-export function dataSanitizeId(logger: IDiagnosticLogger, id: string): string {
-    return id ? dataSanitizeInput(logger, id, DataSanitizerValues.MAX_ID_LENGTH, _eInternalMessageId.IdTooLong).toString() : id;
-}
-
-export function dataSanitizeInput(logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId) {
-    let inputTrunc : String;
-    if (input) {
-        input = strTrim(input.toString());
-        if (input.length > maxLength) {
-            inputTrunc = input.substring(0, maxLength);
-            _throwInternal(logger,
-                eLoggingSeverity.WARNING,
-                _msgId,
-                "input is too long, it has been truncated to " + maxLength + " characters.",
-                { data: input },
-                true);
-        }
-    }
-
-    return inputTrunc || input;
-}
-
-export function dsPadNumber(num: number) {
-    const s = "00" + num;
-    return s.substr(s.length - 3);
-}

package/src/Telemetry/Common/Envelope.ts

@@ -1,81 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger, toISOString } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../../Constants";
-import { FieldType } from "../../Enums";
-import { IBase } from "../../Interfaces/Contracts/IBase";
-import { IEnvelope } from "../../Interfaces/Telemetry/IEnvelope";
-import { dataSanitizeString } from "./DataSanitizer";
-
-export class Envelope implements IEnvelope {
-
-    /**
-     * The data contract for serializing this object.
-     */
-    public aiDataContract: any;
-
-    /**
-     * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.
-     */
-    public ver: number; /* 1 */
-
-    /**
-     * Type name of telemetry data item.
-     */
-    public name: string;
- 
-    /**
-     * Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.
-     */
-    public time: string;
- 
-    /**
-     * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
-     */
-    public sampleRate: number; /* 100.0 */
- 
-    /**
-     * Sequence field used to track absolute order of uploaded events.
-     */
-    public seq: string;
- 
-    /**
-     * The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.
-     */
-    public iKey: string;
- 
-    /**
-     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
-     */
-    public tags: any; /* {} */
- 
-    /**
-     * Telemetry data item.
-     */
-    public data: IBase;
- 
-    /**
-     * Constructs a new instance of telemetry data.
-     */
-    constructor(logger: IDiagnosticLogger, data: IBase, name: string) {
-        let _self = this;
-        _self.ver = 1;
-        _self.sampleRate = 100.0;
-        _self.tags = {};
-        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
-        _self.data = data;
-        _self.time = toISOString(new Date());
-
-        _self.aiDataContract = {
-            time: FieldType.Required,
-            iKey: FieldType.Required,
-            name: FieldType.Required,
-            sampleRate: () => {
-                return (this.sampleRate === 100) ? FieldType.Hidden : FieldType.Required;
-            },
-            tags: FieldType.Required,
-            data: FieldType.Required
-        };
-    }
-}

package/src/Telemetry/Event.ts

@@ -1,52 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../Constants";
-import { FieldType } from "../Enums";
-import { IEventData } from "../Interfaces/Contracts/IEventData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString } from "./Common/DataSanitizer";
-
-export class Event implements IEventData, ISerializable {
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.Event";
-    public static dataType = "EventData";
-
-    public aiDataContract = {
-        ver: FieldType.Required,
-        name: FieldType.Required,
-        properties: FieldType.Default,
-        measurements: FieldType.Default
-    };
-
-    /**
-     * Schema version
-     */
-    public ver: number; /* 2 */
-
-    /**
-     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
-     */
-    public name: string;
-
-    /**
-     * Collection of custom properties.
-     */
-    public properties: any; /* {} */
-
-    /**
-     * Collection of custom measurements.
-     */
-    public measurements: any; /* {} */
-
-    /**
-     * Constructs a new instance of the EventTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name: string, properties?: any, measurements?: any) {
-        let _self = this;
-        _self.ver = 2;
-        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-    }
-}