@microsoft/applicationinsights-properties-js 3.0.0-beta.2303-11 → 3.0.0-beta.2304-07

package/dist/applicationinsights-properties-js.rollup.d.ts

@@ -1,162 +0,0 @@
-/*
- * Microsoft Application Insights properties plugin, 3.0.0-beta.2303-11
- * Copyright (c) Microsoft and contributors. All rights reserved.
- *
- * Microsoft Application Insights Team
- * https://github.com/microsoft/ApplicationInsights-JS#readme
- *
- * ---------------------------------------------------------------------------
- * This is a single combined (rollup) declaration file for the package,
- * use this version if your build environment doesn't support the using the
- * individual *.d.ts files or default namespace wrapped version.
- * - Namespaced version: applicationinsights-properties-js.d.ts
- * ---------------------------------------------------------------------------
- */
-
-import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
-import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
-import { IApplication } from '@microsoft/applicationinsights-common';
-import { IConfig } from '@microsoft/applicationinsights-common';
-import { IConfiguration } from '@microsoft/applicationinsights-core-js';
-import { IDevice } from '@microsoft/applicationinsights-common';
-import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
-import { IDistributedTraceContext } from '@microsoft/applicationinsights-core-js';
-import { IInternal } from '@microsoft/applicationinsights-common';
-import { ILocation } from '@microsoft/applicationinsights-common';
-import { IOperatingSystem } from '@microsoft/applicationinsights-common';
-import { IPlugin } from '@microsoft/applicationinsights-core-js';
-import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
-import { IPropertiesPlugin } from '@microsoft/applicationinsights-common';
-import { ISession } from '@microsoft/applicationinsights-common';
-import { ITelemetryContext } from '@microsoft/applicationinsights-common';
-import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
-import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
-import { ITelemetryTrace } from '@microsoft/applicationinsights-common';
-import { ITraceState } from '@microsoft/applicationinsights-common';
-import { IUnloadHookContainer } from '@microsoft/applicationinsights-core-js';
-import { IUserContext } from '@microsoft/applicationinsights-common';
-import { IWeb } from '@microsoft/applicationinsights-common';
-
-declare interface IPropertiesConfig {
-    readonly accountId: string;
-    readonly sessionRenewalMs: number;
-    readonly samplingPercentage: number;
-    readonly sessionExpirationMs: number;
-    readonly cookieDomain: string;
-    readonly sdkExtension: string;
-    readonly isBrowserLinkTrackingEnabled: boolean;
-    readonly appId: string;
-    readonly getSessionId: string;
-    readonly namePrefix: string;
-    readonly sessionCookiePostfix: string;
-    readonly userCookiePostfix: string;
-    readonly idLength: number;
-    readonly getNewId: (idLength?: number) => string;
-}
-
-export declare interface IPropTelemetryContext extends ITelemetryContext {
-    readonly sessionManager: SessionManager;
-    applySessionContext(evt: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyOperatingSystemContxt(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyApplicationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyDeviceContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyInternalContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyLocationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyOperationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyWebContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyUserContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    cleanUp(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-}
-
-export declare interface ISessionConfig {
-    readonly sessionRenewalMs?: number;
-    readonly sessionExpirationMs?: number;
-    readonly namePrefix?: string;
-    readonly sessionCookiePostfix?: string;
-    readonly idLength?: number;
-    readonly getNewId?: (idLength?: number) => string;
-    /**
-     * @deprecated Avoid using this value to override the cookie manager cookie domain.
-     */
-    cookieDomain?: string;
-}
-
-export declare class PropertiesPlugin extends BaseTelemetryPlugin implements IPropertiesPlugin {
-    context: IPropTelemetryContext;
-    priority: number;
-    identifier: string;
-    constructor();
-    initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
-    /**
-     * Add Part A fields to the event
-     * @param event - The event that needs to be processed
-     */
-    processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-}
-
-export declare class Session implements ISession {
-    /**
-     * The session ID.
-     */
-    id?: string;
-    /**
-     * The date at which this guid was generated.
-     * Per the spec the ID will be regenerated if more than acquisitionSpan milliseconds elapsed from this time.
-     */
-    acquisitionDate?: number;
-    /**
-     * The date at which this session ID was last reported.
-     * This value should be updated whenever telemetry is sent using this ID.
-     * Per the spec the ID will be regenerated if more than renewalSpan milliseconds elapse from this time with no activity.
-     */
-    renewalDate?: number;
-}
-
-export declare class SessionManager {
-    automaticSession: Session;
-    constructor(config: ISessionConfig, core?: IAppInsightsCore, unloadHookContainer?: IUnloadHookContainer);
-    update(): void;
-    /**
-     *  Record the current state of the automatic session and store it in our cookie string format
-     *  into the browser's local storage. This is used to restore the session data when the cookie
-     *  expires.
-     */
-    backup(): void;
-}
-
-export declare class TelemetryContext implements IPropTelemetryContext {
-    application: IApplication;
-    device: IDevice;
-    location: ILocation;
-    telemetryTrace: ITelemetryTrace;
-    user: IUserContext;
-    internal: IInternal;
-    session: ISession;
-    sessionManager: SessionManager;
-    os: IOperatingSystem;
-    web: IWeb;
-    appId: () => string;
-    getSessionId: () => string;
-    constructor(core: IAppInsightsCore, defaultConfig: IPropertiesConfig, previousTraceCtx?: IDistributedTraceContext, unloadHookContainer?: IUnloadHookContainer);
-    applySessionContext(evt: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyOperatingSystemContxt(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyApplicationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyDeviceContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyInternalContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyLocationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyOperationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyWebContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    applyUserContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    cleanUp(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-}
-
-export declare class TelemetryTrace implements ITelemetryTrace {
-    traceID: string;
-    parentID: string;
-    traceState: ITraceState;
-    traceFlags: number;
-    name: string;
-    constructor(id?: string, parentId?: string, name?: string, logger?: IDiagnosticLogger);
-}
-
-export { }

package/src/Context/Application.ts

@@ -1,16 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IApplication } from "@microsoft/applicationinsights-common";
-
-export class Application implements IApplication {
-    /**
-     * The application version.
-     */
-    public ver: string;
-
-    /**
-     * The application build version.
-     */
-    public build: string;
-}

package/src/Context/Device.ts

@@ -1,49 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDevice } from "@microsoft/applicationinsights-common";
-
-export class Device implements IDevice {
-
-    /**
-     * The type for the current device.
-     */
-    public deviceClass: string;
-
-    /**
-     * A device unique ID.
-     */
-    public id: string;
-
-    /**
-     * The application screen resolution.
-     */
-    resolution: string;
-
-    /**
-     * The device model for the current device.
-     */
-    public model: string;
-
-    /**
-     * Device identifier known at instrumentation time
-     */
-    public localId: string;
-
-    /**
-     * Device identifier known at instrumentation time
-     */
-    public ip: string;
-
-    /**
-     * Constructs a new instance of the Device class
-     */
-    constructor() {
-        // don't attempt to fingerprint browsers
-        this.id = "browser";
-
-        // Device type is a dimension in our data platform
-        // Setting it to 'Browser' allows to separate client and server dependencies/exceptions
-        this.deviceClass = "Browser";
-    }
-}

package/src/Context/Internal.ts

@@ -1,49 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IInternal } from "@microsoft/applicationinsights-common";
-import { IUnloadHookContainer, onConfigChange } from "@microsoft/applicationinsights-core-js";
-import { IPropertiesConfig } from "../Interfaces/IPropertiesConfig";
-
-const Version = "2.8.5";
-
-export class Internal implements IInternal {
-
-    /**
-     * The SDK version used to create this telemetry item.
-     */
-    public sdkVersion: string;
-
-    /**
-     * The SDK agent version.
-     */
-    public agentVersion: string;
-
-    /**
-     * The Snippet version used to initialize the sdk instance, this will contain either
-     * undefined/null - Snippet not used
-     * '-' - Version and legacy mode not determined
-     * # - Version # of the snippet
-     * #.l - Version # in legacy mode
-     * .l - No defined version, but used legacy mode initialization
-     */
-    public snippetVer: string;
-
-    /**
-     * Identifies the source of the sdk script
-     */
-    public sdkSrc: string;
-
-    /**
-     * Constructs a new instance of the internal telemetry data class.
-     */
-    constructor(config: IPropertiesConfig, unloadHookContainer?: IUnloadHookContainer) {
-        
-        let unloadHook = onConfigChange((config), () => {
-            let prefix =  config.sdkExtension;
-            this.sdkVersion = (prefix ? prefix + "_" : "") + "javascript:" + Version;
-        });
-
-        unloadHookContainer && unloadHookContainer.add(unloadHook);
-    }
-}

package/src/Context/Location.ts

@@ -1,12 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ILocation } from "@microsoft/applicationinsights-common";
-
-export class Location implements ILocation {
-
-    /**
-     * Client IP address for reverse lookup
-     */
-    public ip: string;
-}

package/src/Context/Session.ts

@@ -1,257 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import { ISession, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage } from "@microsoft/applicationinsights-common";
-import {
-    IAppInsightsCore, ICookieMgr, IDiagnosticLogger, IUnloadHookContainer, _eInternalMessageId, _throwInternal, dateNow, dumpObj,
-    eLoggingSeverity, getExceptionName, isFunction, newId, onConfigChange, safeGetCookieMgr, safeGetLogger
-} from "@microsoft/applicationinsights-core-js";
-
-const SESSION_COOKIE_NAME = "ai_session";
-const ACQUISITION_SPAN = 86400000; // 24 hours in ms
-const RENEWAL_SPAN = 1800000; // 30 minutes in ms
-const COOKIE_UPDATE_INTERVAL = 60000 // 1 minute in ms
-
-export interface ISessionConfig {
-    readonly sessionRenewalMs?: number;
-    readonly sessionExpirationMs?: number;
-    readonly namePrefix?: string;
-    readonly sessionCookiePostfix?: string;
-    readonly idLength?: number;
-    readonly getNewId?: (idLength?: number) => string;
-
-    /**
-     * @deprecated Avoid using this value to override the cookie manager cookie domain.
-     */
-    cookieDomain?: string;
-}
-
-export class Session implements ISession {
-    /**
-     * The session ID.
-     */
-    public id?: string;
-
-    /**
-     * The date at which this guid was generated.
-     * Per the spec the ID will be regenerated if more than acquisitionSpan milliseconds elapsed from this time.
-     */
-    public acquisitionDate?: number;
-
-    /**
-     * The date at which this session ID was last reported.
-     * This value should be updated whenever telemetry is sent using this ID.
-     * Per the spec the ID will be regenerated if more than renewalSpan milliseconds elapse from this time with no activity.
-     */
-    public renewalDate?: number;
-}
-
-export class _SessionManager {
-
-    public automaticSession: Session;
-
-    constructor(config: ISessionConfig, core?: IAppInsightsCore, unloadHookContainer?: IUnloadHookContainer) {
-        let self = this;
-        let _storageNamePrefix: string;
-        let _cookieUpdatedTimestamp: number;
-        let _logger: IDiagnosticLogger = safeGetLogger(core);
-        let _cookieManager: ICookieMgr = safeGetCookieMgr(core);
-        let _sessionExpirationMs: number;
-        let _sessionRenewalMs: number;
-
-        dynamicProto(_SessionManager, self, (_self) => {
-   
-            if (!config) {
-                config = ({} as any);
-            }
-    
-            let unloadHook = onConfigChange(config, (details) => {
-                _sessionExpirationMs = config.sessionExpirationMs || ACQUISITION_SPAN;
-                _sessionRenewalMs = config.sessionRenewalMs || RENEWAL_SPAN;
-        
-                // sessionCookiePostfix takes the preference if it is configured, otherwise takes namePrefix if configured.
-                const sessionCookiePostfix = config.sessionCookiePostfix || config.namePrefix || "";
-    
-                _storageNamePrefix = SESSION_COOKIE_NAME + sessionCookiePostfix;
-            });
-
-            unloadHookContainer && unloadHookContainer.add(unloadHook);
-
-            _self.automaticSession = new Session();
-
-            _self.update = () => {
-                // Always using Date getTime() as there is a bug in older IE instances that causes the performance timings to have the hi-bit set eg 0x800000000 causing
-                // the number to be incorrect.
-                const nowMs = dateNow();
-
-                let isExpired = false;
-                const session = _self.automaticSession;
-                if (!session.id) {
-                    isExpired = !_initializeAutomaticSession(session, nowMs);
-                }
-
-                if (!isExpired && _sessionExpirationMs > 0) {
-                    const timeSinceAcqMs = nowMs - session.acquisitionDate;
-                    const timeSinceRenewalMs = nowMs - session.renewalDate;
-                    isExpired = timeSinceAcqMs < 0 || timeSinceRenewalMs < 0;           // expired if the acquisition or last renewal are in the future
-                    isExpired = isExpired || timeSinceAcqMs > _sessionExpirationMs;     // expired if the time since acquisition is more than session Expiration
-                    isExpired = isExpired || timeSinceRenewalMs > _sessionRenewalMs;    // expired if the time since last renewal is more than renewal period
-                }
-        
-                // renew if acquisitionSpan or renewalSpan has elapsed
-                if (isExpired) {
-                    // update automaticSession so session state has correct id
-                    _renew(nowMs);
-                } else {
-                    // do not update the cookie more often than cookieUpdateInterval
-                    if (!_cookieUpdatedTimestamp || nowMs - _cookieUpdatedTimestamp > COOKIE_UPDATE_INTERVAL) {
-                        _setCookie(session, nowMs);
-                    }
-                }
-            };
-        
-            /**
-             *  Record the current state of the automatic session and store it in our cookie string format
-             *  into the browser's local storage. This is used to restore the session data when the cookie
-             *  expires.
-             */
-            _self.backup = () => {
-                const session = _self.automaticSession;
-                _setStorage(session.id, session.acquisitionDate, session.renewalDate);
-            };
-
-            /**
-             * Use config.namePrefix + ai_session cookie data or local storage data (when the cookie is unavailable) to
-             * initialize the automatic session.
-             * @returns true if values set otherwise false
-             */
-            function _initializeAutomaticSession(session: ISession, now: number): boolean {
-                let isValid = false;
-                const cookieValue = _cookieManager.get(_storageNamePrefix);
-                if (cookieValue && isFunction(cookieValue.split)) {
-                    isValid = _initializeAutomaticSessionWithData(session, cookieValue);
-                } else {
-                    // There's no cookie, but we might have session data in local storage
-                    // This can happen if the session expired or the user actively deleted the cookie
-                    // We only want to recover data if the cookie is missing from expiry. We should respect the user's wishes if the cookie was deleted actively.
-                    // The User class handles this for us and deletes our local storage object if the persistent user cookie was removed.
-                    const storageValue = utlGetLocalStorage(_logger, _storageNamePrefix);
-                    if (storageValue) {
-                        isValid = _initializeAutomaticSessionWithData(session, storageValue);
-                    }
-                }
-        
-                return isValid || !!session.id;
-            }
-        
-            /**
-             * Extract id, acquisitionDate, and renewalDate from an ai_session payload string and
-             * use this data to initialize automaticSession.
-             *
-             * @param sessionData - The string stored in an ai_session cookie or local storage backup
-             * @returns true if values set otherwise false
-             */
-            function _initializeAutomaticSessionWithData(session: ISession, sessionData: string) {
-                let isValid = false;
-                const sessionReset = ", session will be reset";
-                const tokens = sessionData.split("|");
-        
-                if (tokens.length >= 2) {
-                    try {
-                        const acqMs = +tokens[1] || 0;
-                        const renewalMs = +tokens[2] || 0;
-                        if (isNaN(acqMs) || acqMs <= 0) {
-                            _throwInternal(_logger,
-                                eLoggingSeverity.WARNING,
-                                _eInternalMessageId.SessionRenewalDateIsZero,
-                                "AI session acquisition date is 0" + sessionReset);
-                        } else if (isNaN(renewalMs) || renewalMs <= 0) {
-                            _throwInternal(_logger,
-                                eLoggingSeverity.WARNING,
-                                _eInternalMessageId.SessionRenewalDateIsZero,
-                                "AI session renewal date is 0" + sessionReset);
-                        } else if (tokens[0]) {
-                            // Everything looks valid so set the values
-                            session.id = tokens[0];
-                            session.acquisitionDate = acqMs;
-                            session.renewalDate = renewalMs;
-                            isValid = true;
-                        }
-                    } catch (e) {
-                        _throwInternal(_logger,
-                            eLoggingSeverity.CRITICAL,
-                            _eInternalMessageId.ErrorParsingAISessionCookie,
-                            "Error parsing ai_session value [" + (sessionData || "") + "]" + sessionReset + " - " + getExceptionName(e),
-                            { exception: dumpObj(e) });
-                    }
-                }
-
-                return isValid;
-            }
-        
-            function _renew(nowMs: number) {
-                let getNewId = config.getNewId || newId;
-                _self.automaticSession.id = getNewId(config.idLength || 22);
-                _self.automaticSession.acquisitionDate = nowMs;
-        
-                _setCookie(_self.automaticSession, nowMs);
-        
-                // If this browser does not support local storage, fire an internal log to keep track of it at this point
-                if (!utlCanUseLocalStorage()) {
-                    _throwInternal(_logger,
-                        eLoggingSeverity.WARNING,
-                        _eInternalMessageId.BrowserDoesNotSupportLocalStorage,
-                        "Browser does not support local storage. Session durations will be inaccurate.");
-                }
-            }
-        
-            function _setCookie(session: ISession, nowMs: number) {
-                let acq = session.acquisitionDate;
-                session.renewalDate = nowMs;
-
-                let renewalPeriodMs = _sessionRenewalMs;
-
-                // Set cookie to expire after the session expiry time passes or the session renewal deadline, whichever is sooner
-                // Expiring the cookie will cause the session to expire even if the user isn't on the page
-                const acqTimeLeftMs = (acq +_sessionExpirationMs) - nowMs;
-                const cookie = [session.id, acq, nowMs];
-                let maxAgeSec = 0;
-        
-                if (acqTimeLeftMs < renewalPeriodMs) {
-                    maxAgeSec = acqTimeLeftMs / 1000;
-                } else {
-                    maxAgeSec = renewalPeriodMs / 1000;
-                }
-        
-                const cookieDomain = config.cookieDomain || null;
-
-                // if sessionExpirationMs is set to 0, it means the expiry is set to 0 for this session cookie
-                // A cookie with 0 expiry in the session cookie will never expire for that browser session.  If the browser is closed the cookie expires.
-                // Depending on the browser, another instance does not inherit this cookie, however, another tab will
-                _cookieManager.set(_storageNamePrefix, cookie.join("|"), _sessionExpirationMs > 0 ? maxAgeSec : null, cookieDomain);
-                _cookieUpdatedTimestamp = nowMs;
-            }
-        
-            function _setStorage(guid: string, acq: number, renewal: number) {
-                // Keep data in local storage to retain the last session id, allowing us to cleanly end the session when it expires
-                // Browsers that don't support local storage won't be able to end sessions cleanly from the client
-                // The server will notice this and end the sessions itself, with loss of accurate session duration
-                utlSetLocalStorage(_logger, _storageNamePrefix, [guid, acq, renewal].join("|"));
-            }
-        });
-    }
-
-    public update() {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-
-    /**
-     *  Record the current state of the automatic session and store it in our cookie string format
-     *  into the browser's local storage. This is used to restore the session data when the cookie
-     *  expires.
-     */
-    public backup() {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-}

package/src/Context/TelemetryTrace.ts

@@ -1,26 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ITelemetryTrace, ITraceState, dataSanitizeString } from "@microsoft/applicationinsights-common";
-import { IDiagnosticLogger, generateW3CId, getLocation } from "@microsoft/applicationinsights-core-js";
-
-export class TelemetryTrace implements ITelemetryTrace {
-
-    public traceID: string;
-    public parentID: string;
-    public traceState: ITraceState;
-    public traceFlags: number;
-    public name: string;
-
-    constructor(id?: string, parentId?: string, name?: string, logger?: IDiagnosticLogger) {
-        const _self = this;
-        _self.traceID = id || generateW3CId();
-        _self.parentID = parentId;
-        let location = getLocation();
-        if (!name && location && location.pathname) {
-            name = location.pathname;
-        }
-
-        _self.name = dataSanitizeString(logger, name);
-    }
-}