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

package/src/JavaScriptSDK/W3cTraceParent.ts

@@ -1,197 +0,0 @@
-import { isArray, isString, strLeft, strTrim } from "@nevware21/ts-utils";
-import { ITraceParent } from "../JavaScriptSDK.Interfaces/ITraceParent";
-import { generateW3CId } from "./CoreUtils";
-import { findMetaTag, findNamedServerTiming } from "./EnvUtils";
-import { STR_EMPTY } from "./InternalConstants";
-
-// using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string
-const TRACE_PARENT_REGEX = /^([\da-f]{2})-([\da-f]{32})-([\da-f]{16})-([\da-f]{2})(-[^\s]{1,64})?$/i;
-const DEFAULT_VERSION = "00";
-const INVALID_VERSION = "ff";
-const INVALID_TRACE_ID = "00000000000000000000000000000000";
-const INVALID_SPAN_ID = "0000000000000000";
-const SAMPLED_FLAG = 0x01;
-
-function _isValid(value: string, len: number, invalidValue?: string): boolean {
-    if (value && value.length === len && value !== invalidValue) {
-        return !!value.match(/^[\da-f]*$/i);
-    }
-
-    return false;
-}
-
-function _formatValue(value: string, len: number, defValue: string): string {
-    if (_isValid(value, len)) {
-        return value;
-    }
-
-    return defValue;
-}
-
-function _formatFlags(value: number): string {
-    if (isNaN(value) || value < 0 || value > 255) {
-        value = 0x01;
-    }
-
-    let result = value.toString(16);
-    while (result.length < 2) {
-        result = "0" + result;
-    }
-
-    return result;
-}
-
-/**
- * Create a new ITraceParent instance using the provided values.
- * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
- * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
- * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
- * @param version - The version to used, defaults to version "01" if not supplied or invalid.
- * @returns
- */
-export function createTraceParent(traceId?: string, spanId?: string, flags?: number, version?: string): ITraceParent {
-
-    return {
-        version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,
-        traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),
-        spanId: isValidSpanId(spanId) ? spanId : strLeft(generateW3CId(), 16),
-        traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1
-    };
-}
-
-/**
- * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
- *
- * @param value
- * @returns
- */
-export function parseTraceParent(value: string): ITraceParent {
-    if (!value) {
-        // Don't pass a null/undefined or empty string
-        return null;
-    }
-
-    if (isArray(value)) {
-        // The value may have been encoded on the page into an array so handle this automatically
-        value = value[0] || "";
-    }
-
-    if (!value || !isString(value) || value.length > 8192) {
-        // limit potential processing based on total length
-        return null;
-    }
-
-    // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent
-    const match = TRACE_PARENT_REGEX.exec(strTrim(value));
-    if (!match ||                               // No match
-            match[1] === INVALID_VERSION ||     // version ff is forbidden
-            match[2] === INVALID_TRACE_ID ||    // All zeros is considered to be invalid
-            match[3] === INVALID_SPAN_ID) {     // All zeros is considered to be invalid
-        return null;
-    }
-
-    return {
-        version: (match[1] || STR_EMPTY).toLowerCase(),
-        traceId: (match[2] || STR_EMPTY).toLowerCase(),
-        spanId: (match[3] || STR_EMPTY).toLowerCase(),
-        traceFlags: parseInt(match[4], 16)
-    }
-}
-
-/**
- * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
- * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
- * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
- * @param value - The W3c trace Id to be validated
- * @returns true if valid otherwise false
- */
-export function isValidTraceId(value: string): boolean {
-    return _isValid(value, 32, INVALID_TRACE_ID);
-}
-
-/**
- * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
- * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
- * If all characters are zero (0000000000000000) this is considered an invalid value.
- * @param value - The W3c span id to be validated
- * @returns true if valid otherwise false
- */
-export function isValidSpanId(value: string): boolean {
-    return _isValid(value, 16, INVALID_SPAN_ID);
-}
-
-/**
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
- * @param value
- * @returns
- */
-export function isValidTraceParent(value: ITraceParent) {
-    if (!value ||
-            !_isValid(value.version, 2, INVALID_VERSION) ||
-            !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||
-            !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||
-            !_isValid(_formatFlags(value.traceFlags), 2)) {
-
-        // Each known field must contain a valid value
-        return false;
-    }
-
-    return true;
-}
-
-/**
- * Is the parsed traceParent indicating that the trace is currently sampled.
- * @param value - The parsed traceParent value
- * @returns
- */
-export function isSampledFlag(value: ITraceParent) {
-    if (isValidTraceParent(value)) {
-        return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;
-    }
-
-    return false;
-}
-
-/**
- * Format the ITraceParent value as a string using the supported and know version formats.
- * So even if the passed traceParent is a later version the string value returned from this
- * function will convert it to only the known version formats.
- * This currently only supports version "00" and invalid "ff"
- * @param value - The parsed traceParent value
- * @returns
- */
-export function formatTraceParent(value: ITraceParent) {
-    if (value) {
-        // Special Note: This only supports formatting as version 00, future versions should encode any known supported version
-        // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.
-        let flags = _formatFlags(value.traceFlags);
-        if (!_isValid(flags, 2)) {
-            flags = "01";
-        }
-
-        let version = value.version || DEFAULT_VERSION;
-        if (version !== "00" && version !== "ff") {
-            // Reduce version to "00"
-            version = DEFAULT_VERSION;
-        }
-
-        // Format as version 00
-        return `${version.toLowerCase()}-${_formatValue(value.traceId, 32, INVALID_TRACE_ID).toLowerCase()}-${_formatValue(value.spanId, 16, INVALID_SPAN_ID).toLowerCase()}-${flags.toLowerCase()}`;
-    }
-
-    return "";
-}
-
-/**
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
- * @returns
- */
-export function findW3cTraceParent(): ITraceParent {
-    const name = "traceparent";
-    let traceParent: ITraceParent = parseTraceParent(findMetaTag(name));
-    if (!traceParent) {
-        traceParent = parseTraceParent(findNamedServerTiming(name))
-    }
-
-    return traceParent;
-}

package/src/JavaScriptSDK.Enums/EnumHelperFuncs.ts

@@ -1,24 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { EnumCls, createEnum, createTypeMap } from "@nevware21/ts-utils";
-
-export declare type EnumValue<E = any> = EnumCls<E>;
-
-/**
- * Create an enum style object which has both the key => value and value => key mappings
- * @param values - The values to populate on the new object
- * @returns
- */
-export const createEnumStyle: <E>(values: { [key in keyof E]: E[keyof E] }) => EnumValue<E> = createEnum;
-
-/**
- * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] => mapValue and X[0] => mapValue.
- * Generic values
- * - E = the const enum type (typeof eRequestHeaders);
- * - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
- * resulting "Value" of each entry identifies the valid values withing the assignments.
- * @param values - The values to populate on the new object
- * @returns
- */
-export const createValueMap: <E, V = E>(values: { [key in keyof E]: [ E[keyof E], V[keyof V] ] }) => V = createTypeMap;

package/src/JavaScriptSDK.Enums/EventsDiscardedReason.ts

@@ -1,71 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { createEnumStyle } from "../JavaScriptSDK.Enums/EnumHelperFuncs";
-
-/**
- * The eEventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
- */
-export const enum eEventsDiscardedReason {
-    /**
-     * Unknown.
-     */
-     Unknown = 0,
-     /**
-      * Status set to non-retryable.
-      */
-     NonRetryableStatus = 1,
-     /**
-      * The event is invalid.
-      */
-     InvalidEvent = 2,
-     /**
-      * The size of the event is too large.
-      */
-     SizeLimitExceeded = 3,
-     /**
-      * The server is not accepting events from this instrumentation key.
-      */
-     KillSwitch = 4,
-     /**
-      * The event queue is full.
-      */
-     QueueFull = 5
- }
-
-/**
- * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
- */
-export const EventsDiscardedReason = createEnumStyle<typeof eEventsDiscardedReason>({
-    /**
-     * Unknown.
-     */
-    Unknown: eEventsDiscardedReason.Unknown,
-
-    /**
-     * Status set to non-retryable.
-     */
-    NonRetryableStatus: eEventsDiscardedReason.NonRetryableStatus,
-
-    /**
-     * The event is invalid.
-     */
-    InvalidEvent: eEventsDiscardedReason.InvalidEvent,
-
-    /**
-     * The size of the event is too large.
-     */
-    SizeLimitExceeded: eEventsDiscardedReason.SizeLimitExceeded,
-
-    /**
-     * The server is not accepting events from this instrumentation key.
-     */
-    KillSwitch: eEventsDiscardedReason.KillSwitch,
-
-    /**
-     * The event queue is full.
-     */
-    QueueFull: eEventsDiscardedReason.QueueFull
-});
-
-export type EventsDiscardedReason = number | eEventsDiscardedReason;

package/src/JavaScriptSDK.Enums/LoggingEnums.ts

@@ -1,121 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-//  @skip-file-minify
-
-import { createEnumStyle } from "../JavaScriptSDK.Enums/EnumHelperFuncs";
-
-export const enum eLoggingSeverity {
-    /**
-     * No Logging will be enabled
-     */
-    DISABLED = 0,
-
-    /**
-     * Error will be sent as internal telemetry
-     */
-    CRITICAL = 1,
-
-    /**
-     * Error will NOT be sent as internal telemetry, and will only be shown in browser console
-     */
-    WARNING = 2
-}
-
-export const LoggingSeverity = createEnumStyle<typeof eLoggingSeverity>({
-    DISABLED: eLoggingSeverity.DISABLED,
-    CRITICAL: eLoggingSeverity.CRITICAL,
-    WARNING: eLoggingSeverity.WARNING
-});
-export type LoggingSeverity = number | eLoggingSeverity;
-
-export const enum _eInternalMessageId {
-    BrowserDoesNotSupportLocalStorage = 0,
-    BrowserCannotReadLocalStorage = 1,
-    BrowserCannotReadSessionStorage = 2,
-    BrowserCannotWriteLocalStorage = 3,
-    BrowserCannotWriteSessionStorage = 4,
-    BrowserFailedRemovalFromLocalStorage = 5,
-    BrowserFailedRemovalFromSessionStorage = 6,
-    CannotSendEmptyTelemetry = 7,
-    ClientPerformanceMathError = 8,
-    ErrorParsingAISessionCookie = 9,
-    ErrorPVCalc = 10,
-    ExceptionWhileLoggingError = 11,
-    FailedAddingTelemetryToBuffer = 12,
-    FailedMonitorAjaxAbort = 13,
-    FailedMonitorAjaxDur = 14,
-    FailedMonitorAjaxOpen = 15,
-    FailedMonitorAjaxRSC = 16,
-    FailedMonitorAjaxSend = 17,
-    FailedMonitorAjaxGetCorrelationHeader = 18,
-    FailedToAddHandlerForOnBeforeUnload = 19,
-    FailedToSendQueuedTelemetry = 20,
-    FailedToReportDataLoss = 21,
-    FlushFailed = 22,
-    MessageLimitPerPVExceeded = 23,
-    MissingRequiredFieldSpecification = 24,
-    NavigationTimingNotSupported = 25,
-    OnError = 26,
-    SessionRenewalDateIsZero = 27,
-    SenderNotInitialized = 28,
-    StartTrackEventFailed = 29,
-    StopTrackEventFailed = 30,
-    StartTrackFailed = 31,
-    StopTrackFailed = 32,
-    TelemetrySampledAndNotSent = 33,
-    TrackEventFailed = 34,
-    TrackExceptionFailed = 35,
-    TrackMetricFailed = 36,
-    TrackPVFailed = 37,
-    TrackPVFailedCalc = 38,
-    TrackTraceFailed = 39,
-    TransmissionFailed = 40,
-    FailedToSetStorageBuffer = 41,
-    FailedToRestoreStorageBuffer = 42,
-    InvalidBackendResponse = 43,
-    FailedToFixDepricatedValues = 44,
-    InvalidDurationValue = 45,
-    TelemetryEnvelopeInvalid = 46,
-    CreateEnvelopeError = 47,
-
-    // User actionable
-    CannotSerializeObject = 48,
-    CannotSerializeObjectNonSerializable = 49,
-    CircularReferenceDetected = 50,
-    ClearAuthContextFailed = 51,
-    ExceptionTruncated = 52,
-    IllegalCharsInName = 53,
-    ItemNotInArray = 54,
-    MaxAjaxPerPVExceeded = 55,
-    MessageTruncated = 56,
-    NameTooLong = 57,
-    SampleRateOutOfRange = 58,
-    SetAuthContextFailed = 59,
-    SetAuthContextFailedAccountName = 60,
-    StringValueTooLong = 61,
-    StartCalledMoreThanOnce = 62,
-    StopCalledWithoutStart = 63,
-    TelemetryInitializerFailed = 64,
-    TrackArgumentsNotSpecified = 65,
-    UrlTooLong = 66,
-    SessionStorageBufferFull = 67,
-    CannotAccessCookie = 68,
-    IdTooLong = 69,
-    InvalidEvent = 70,
-    FailedMonitorAjaxSetRequestHeader = 71,
-    SendBrowserInfoOnUserInit = 72,
-    PluginException = 73,
-    NotificationException = 74,
-    SnippetScriptLoadFailure = 99,
-    InvalidInstrumentationKey = 100,
-    CannotParseAiBlobValue = 101,
-    InvalidContentBlob = 102,
-    TrackPageActionEventFailed = 103,
-    FailedAddingCustomDefinedRequestContext = 104,
-    InMemoryStorageBufferFull = 105,
-    InstrumentationKeyDeprecation = 106,
-    ConfigWatcherException = 107,
-    DynamicConfigException = 108
-}
-
-export type _InternalMessageId = number | _eInternalMessageId;

package/src/JavaScriptSDK.Enums/SendRequestReason.ts

@@ -1,56 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-/**
- * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
- */
-export const enum SendRequestReason {
-    /**
-     * No specific reason was specified
-     */
-    Undefined       = 0,
-
-    /**
-     * Events are being sent based on the normal event schedule / timer.
-     */
-    NormalSchedule = 1,
-
-    /**
-     * A manual flush request was received
-     */
-    ManualFlush = 1,
-
-    /**
-     * Unload event is being processed
-     */
-    Unload = 2,
-
-    /**
-     * The event(s) being sent are sync events
-     */
-    SyncEvent = 3,
-
-    /**
-     * The Channel was resumed
-     */
-    Resumed = 4,
-
-    /**
-     * The event(s) being sent as a retry
-     */
-    Retry = 5,
-
-    /**
-     * The SDK is unloading
-     */
-    SdkUnload = 6,
-    
-    /**
-     * Maximum batch size would be exceeded
-     */
-    MaxBatchSize = 10,
-
-    /**
-     * The Maximum number of events have already been queued
-     */
-    MaxQueuedEvents = 20
-}

package/src/JavaScriptSDK.Enums/TelemetryUnloadReason.ts

@@ -1,27 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * The TelemetryUnloadReason enumeration contains the possible reasons for why a plugin is being unloaded / torndown().
- */
-export const enum TelemetryUnloadReason {
-    /**
-     * Teardown has been called without any context.
-     */
-    ManualTeardown = 0,
-
-    /**
-     * Just this plugin is being removed
-     */
-    PluginUnload = 1,
-
-    /**
-     * This instance of the plugin is being removed and replaced
-     */
-    PluginReplace = 2,
-
-    /**
-     * The entire SDK is being unloaded
-     */
-    SdkUnload = 50
-}

package/src/JavaScriptSDK.Enums/TelemetryUpdateReason.ts

@@ -1,27 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * The TelemetryUpdateReason enumeration contains a set of bit-wise values that specify the reason for update request.
- */
-export const enum TelemetryUpdateReason {
-    /**
-     * Unknown.
-     */
-    Unknown = 0,
-
-    /**
-     * The configuration has ben updated or changed
-     */
-    ConfigurationChanged = 0x01,
-
-    /**
-     * One or more plugins have been added
-     */
-    PluginAdded = 0x10,
-
-    /**
-     * One or more plugins have been removed
-     */
-    PluginRemoved = 0x20,
-}