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

package/src/Context/User.ts

@@ -1,233 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import { IUserContext, utlRemoveStorage } from "@microsoft/applicationinsights-common";
-import {
-    IAppInsightsCore, ICookieMgr, IUnloadHookContainer, _eInternalMessageId, _throwInternal, eLoggingSeverity, newId, onConfigChange,
-    safeGetCookieMgr, safeGetLogger, toISOString
-} from "@microsoft/applicationinsights-core-js";
-import { objDefine } from "@nevware21/ts-utils";
-import { IPropertiesConfig } from "../Interfaces/IPropertiesConfig";
-
-function _validateUserInput(id: string): boolean {
-    // Validate:
-    // 1. Id is a non-empty string.
-    // 2. It does not contain special characters for cookies.
-    if (typeof id !== "string" ||
-        !id ||
-        id.match(/,|;|=| |\|/)) {
-        return false;
-    }
-
-    return true;
-}
-
-export class User implements IUserContext {
-
-    static cookieSeparator: string = "|";
-    static userCookieName: string = "ai_user";
-    static authUserCookieName: string = "ai_authUser";
-
-    /**
-     * The telemetry configuration.
-     */
-    public readonly config: IPropertiesConfig;
-
-    /**
-     * The user ID.
-     */
-    public id: string;
-
-    /**
-     * Authenticated user id
-     */
-    public authenticatedId: string;
-
-    /**
-     * The localId
-     */
-    public localId: string;
-
-    /**
-     * The account ID.
-     */
-    public accountId: string;
-
-    /**
-     * The account acquisition date.
-     */
-    public accountAcquisitionDate: string;
-
-    /**
-     * A flag indicating whether this represents a new user
-     */
-    public isNewUser = false;
-
-    /**
-     * A flag indicating whether the user cookie has been set
-     */
-    public isUserCookieSet = false;
-
-    constructor(config: IPropertiesConfig, core: IAppInsightsCore, unloadHookContainer?: IUnloadHookContainer) {
-        let _logger = safeGetLogger(core);
-        let _cookieManager: ICookieMgr = safeGetCookieMgr(core);
-        let _storageNamePrefix: string;
-
-        dynamicProto(User, this, (_self) => {
-            // Define _self.config
-            objDefine(_self, "config", {
-                g: () => config
-            });
-
-            let unloadHook = onConfigChange(config, () => {
-
-                const userCookiePostfix = config.userCookiePostfix || "";
-                _storageNamePrefix = User.userCookieName + userCookiePostfix;
-    
-                // get userId or create new one if none exists
-                const cookie = _cookieManager.get(_storageNamePrefix);
-                if (cookie) {
-                    _self.isNewUser = false;
-                    const params = cookie.split(User.cookieSeparator);
-                    if (params.length > 0) {
-                        _self.id = params[0];
-                        // we already have a cookie
-                        _self.isUserCookieSet = !!_self.id;
-                    }
-                }
-
-                if (!_self.id) {
-                    _self.id = _generateNewId();
-                    const newCookie = _generateNewCookie(_self.id);
-    
-                    _setUserCookie(newCookie.join(User.cookieSeparator));
-    
-                    // If we have an config.namePrefix() + ai_session in local storage this means the user actively removed our cookies.
-                    // We should respect their wishes and clear ourselves from local storage
-                    const name = (config.namePrefix || "") + "ai_session";
-                    utlRemoveStorage(_logger, name);
-                }
-    
-                // We still take the account id from the ctor param for backward compatibility.
-                // But if the the customer set the accountId through the newer setAuthenticatedUserContext API, we will override it.
-                _self.accountId = config.accountId || undefined;
-    
-                // Get the auth user id and account id from the cookie if exists
-                // Cookie is in the pattern: <authenticatedId>|<accountId>
-                let authCookie = _cookieManager.get(User.authUserCookieName);
-                if (authCookie) {
-                    authCookie = decodeURI(authCookie);
-                    const authCookieString = authCookie.split(User.cookieSeparator);
-                    if (authCookieString[0]) {
-                        _self.authenticatedId = authCookieString[0];
-                    }
-    
-                    if (authCookieString.length > 1 && authCookieString[1]) {
-                        _self.accountId = authCookieString[1];
-                    }
-                }
-            });
-
-            unloadHookContainer && unloadHookContainer.add(unloadHook);
-
-            function _generateNewId() {
-                let theConfig = (config || {}) as IPropertiesConfig;
-                let getNewId = theConfig.getNewId || newId;
-                let id = getNewId(theConfig.idLength ? config.idLength : 22);
-                return id;
-            }
-
-            function _generateNewCookie(userId: string) {
-                const acqStr = toISOString(new Date());
-                _self.accountAcquisitionDate = acqStr;
-                _self.isNewUser = true;
-                const newCookie = [userId, acqStr];
-                return newCookie;
-            }
-
-            function _setUserCookie(cookie: string) {
-                // without expiration, cookies expire at the end of the session
-                // set it to 365 days from now
-                // 365 * 24 * 60 * 60 = 31536000
-                const oneYear = 31536000;
-                _self.isUserCookieSet = _cookieManager.set(_storageNamePrefix, cookie, oneYear);
-            }
-
-            _self.setAuthenticatedUserContext = (authenticatedUserId: string, accountId?: string, storeInCookie = false) => {
-
-                // Validate inputs to ensure no cookie control characters.
-                const isInvalidInput = !_validateUserInput(authenticatedUserId) || (accountId && !_validateUserInput(accountId));
-                if (isInvalidInput) {
-                    _throwInternal(_logger,
-                        eLoggingSeverity.WARNING,
-                        _eInternalMessageId.SetAuthContextFailedAccountName,
-                        "Setting auth user context failed. " +
-                        "User auth/account id should be of type string, and not contain commas, semi-colons, equal signs, spaces, or vertical-bars.",
-                        true);
-                    return;
-                }
-
-                // Create cookie string.
-                _self.authenticatedId = authenticatedUserId;
-                let authCookie = _self.authenticatedId;
-                if (accountId) {
-                    _self.accountId = accountId;
-                    authCookie = [_self.authenticatedId, _self.accountId].join(User.cookieSeparator);
-                }
-
-                if (storeInCookie) {
-                    // Set the cookie. No expiration date because this is a session cookie (expires when browser closed).
-                    // Encoding the cookie to handle unexpected unicode characters.
-                    _cookieManager.set(User.authUserCookieName, encodeURI(authCookie));
-                }
-            };
-
-            /**
-             * Clears the authenticated user id and the account id from the user context.
-             * @returns {}
-             */
-            _self.clearAuthenticatedUserContext = () => {
-                _self.authenticatedId = null;
-                _self.accountId = null;
-                _cookieManager.del(User.authUserCookieName);
-            };
-
-            _self.update = (userId?: string) => {
-                // Optimizations to avoid setting and processing the cookie when not needed
-                if (_self.id !== userId || !_self.isUserCookieSet) {
-                    let user_id = userId ? userId : _generateNewId();
-                    let user_cookie = _generateNewCookie(user_id);
-                    _setUserCookie(user_cookie.join(User.cookieSeparator));
-                }
-            };
-        });
-    }
-
-    /**
-    * Sets the authenticated user id and the account id in this session.
-    *
-    * @param authenticatedUserId - {string} - The authenticated user id. A unique and persistent string that represents each authenticated user in the service.
-    * @param accountId - {string} - An optional string to represent the account associated with the authenticated user.
-    */
-    public setAuthenticatedUserContext(authenticatedUserId: string, accountId?: string, storeInCookie = false) {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-
-    /**
-     * Clears the authenticated user id and the account id from the user context.
-     * @returns {}
-     */
-    public clearAuthenticatedUserContext() {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-
-    /**
-     * Update or create the user cookie if cookies where previously disabled or the new userId does not match the existing value.
-     * If you pass nothing a new random user id will be created.
-     * @param userId - Specific either the current (via appInsights.context.user.id) or new id that you want to set
-     */
-    public update(userId?: string) {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-}

package/src/Interfaces/IPropTelemetryContext.ts

@@ -1,21 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ITelemetryContext } from "@microsoft/applicationinsights-common";
-import { IProcessTelemetryContext, ITelemetryItem } from "@microsoft/applicationinsights-core-js";
-import { _SessionManager } from "../Context/Session";
-
-export interface IPropTelemetryContext extends ITelemetryContext {
-    readonly sessionManager: _SessionManager; // The session manager that manages session on the base of cookies.
-
-    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;
-}

package/src/Interfaces/IPropertiesConfig.ts

@@ -1,19 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export 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;
-}

package/src/PropertiesPlugin.ts

@@ -1,183 +0,0 @@
-/**
-* PropertiesPlugin.ts
-* @copyright Microsoft 2018
-*/
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import {
-    BreezeChannelIdentifier, IConfig, IPropertiesPlugin, PageView, PropertiesPluginIdentifier, createDistributedTraceContextFromTrace
-} from "@microsoft/applicationinsights-common";
-import {
-    BaseTelemetryPlugin, IAppInsightsCore, IConfigDefaults, IConfiguration, IDistributedTraceContext, IPlugin, IProcessTelemetryContext,
-    IProcessTelemetryUnloadContext, ITelemetryItem, ITelemetryPluginChain, ITelemetryUnloadState, _InternalLogMessage, _eInternalMessageId,
-    _logInternalMessage, createProcessTelemetryContext, eLoggingSeverity, getNavigator, getSetValue, isNullOrUndefined, onConfigChange
-} from "@microsoft/applicationinsights-core-js";
-import { objDeepFreeze, objDefine } from "@nevware21/ts-utils";
-import { IPropTelemetryContext } from "./Interfaces/IPropTelemetryContext";
-import { IPropertiesConfig } from "./Interfaces/IPropertiesConfig";
-import { TelemetryContext } from "./TelemetryContext";
-
-let undefString: string;
-const nullValue: any = null;
-
-const _defaultConfig: IConfigDefaults<IPropertiesConfig> = objDeepFreeze({
-    accountId: nullValue,
-    sessionRenewalMs: 30 * 60 * 1000,
-    samplingPercentage: 100,
-    sessionExpirationMs: 24 * 60 * 60 * 1000,
-    cookieDomain: nullValue,
-    sdkExtension: nullValue,
-    isBrowserLinkTrackingEnabled: false,
-    appId: nullValue,
-    getSessionId: nullValue,
-    namePrefix: undefString,
-    sessionCookiePostfix: undefString,
-    userCookiePostfix: undefString,
-    idLength: 22,
-    getNewId: nullValue
-});
-
-export default class PropertiesPlugin extends BaseTelemetryPlugin implements IPropertiesPlugin {
-
-    public context: IPropTelemetryContext;
-
-    public priority = 110;
-    public identifier = PropertiesPluginIdentifier;
-
-    constructor() {
-        super();
-
-        let _extensionConfig: IPropertiesConfig;
-        let _distributedTraceCtx: IDistributedTraceContext;
-        let _previousTraceCtx: IDistributedTraceContext;
-        let _context: IPropTelemetryContext;
-
-        dynamicProto(PropertiesPlugin, this, (_self, _base) => {
-
-            _initDefaults();
-
-            objDefine(_self, "context", {
-                g: function() {
-                    return _context;
-                }
-            });
-
-            _self.initialize = (config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?:ITelemetryPluginChain) => {
-                _base.initialize(config, core, extensions, pluginChain);
-                _populateDefaults(config);
-            };
-    
-            /**
-             * Add Part A fields to the event
-             * @param event - The event that needs to be processed
-             */
-            _self.processTelemetry = (event: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => {
-                if (!isNullOrUndefined(event)) {
-                    itemCtx = _self._getTelCtx(itemCtx);
-                    // If the envelope is PageView, reset the internal message count so that we can send internal telemetry for the new page.
-                    if (event.name === PageView.envelopeType) {
-                        itemCtx.diagLog().resetInternalMessageCount();
-                    }
-
-                    let theContext: TelemetryContext = (_context || {}) as TelemetryContext;
-    
-                    if (theContext.session) {
-                        // If customer did not provide custom session id update the session manager
-                        if (typeof _context.session.id !== "string" && theContext.sessionManager) {
-                            theContext.sessionManager.update();
-                        }
-                    }
-
-                    let userCtx = theContext.user;
-                    if (userCtx && !userCtx.isUserCookieSet) {
-                        userCtx.update(theContext.user.id);
-                    }
-    
-                    _processTelemetryInternal(event, itemCtx);
-    
-                    if (userCtx && userCtx.isNewUser) {
-                        userCtx.isNewUser = false;
-                        const message = new _InternalLogMessage(_eInternalMessageId.SendBrowserInfoOnUserInit, ((getNavigator()||{} as any).userAgent||""));
-                        _logInternalMessage(itemCtx.diagLog(), eLoggingSeverity.CRITICAL, message);
-                    }
-    
-                    _self.processNext(event, itemCtx);
-                }
-            };
-
-            _self._doTeardown = (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => {
-                let core = (unloadCtx || {} as any).core();
-                if (core && core.getTraceCtx) {
-                    let traceCtx = core.getTraceCtx(false);
-                    if (traceCtx === _distributedTraceCtx) {
-                        core.setTraceCtx(_previousTraceCtx);
-                    }
-                }
-
-                _initDefaults();
-            };
-    
-            function _initDefaults() {
-                _extensionConfig = null;
-                _distributedTraceCtx = null;
-                _previousTraceCtx = null;
-                _context = null;
-            }
-
-            function _populateDefaults(config: IConfiguration) {
-                let identifier = _self.identifier;
-                let core = _self.core;
-
-                // This function will be re-called whenever any referenced configuration is changed
-                _self._addHook(onConfigChange(config, () => {
-                    let ctx = createProcessTelemetryContext(null, config, core);
-                    _extensionConfig = ctx.getExtCfg(identifier, _defaultConfig);
-
-                    // Test hook to allow accessing the internal values -- explicitly not defined as an available property on the class
-                    _self["_extConfig"] = _extensionConfig;
-                }));
-
-                // This is outside of the onConfigChange as we don't want to update (replace) these values whenever a referenced config item changes
-                _previousTraceCtx = core.getTraceCtx(false);
-                _context = new TelemetryContext(core, _extensionConfig, _previousTraceCtx, _self._unloadHooks);
-                _distributedTraceCtx = createDistributedTraceContextFromTrace(_self.context.telemetryTrace, _previousTraceCtx);
-                core.setTraceCtx(_distributedTraceCtx);
-                _self.context.appId = () => {
-                    let breezeChannel = core.getPlugin<IPlugin>(BreezeChannelIdentifier);
-                    return breezeChannel ? breezeChannel.plugin["_appId"] : null;
-                };
-            }
-
-            function _processTelemetryInternal(evt: ITelemetryItem, itemCtx: IProcessTelemetryContext) {
-                // Set Part A fields
-                getSetValue(evt, "tags", []);
-                getSetValue(evt, "ext", {});
-
-                let ctx = _self.context;
-                ctx.applySessionContext(evt, itemCtx);
-                ctx.applyApplicationContext(evt, itemCtx);
-                ctx.applyDeviceContext(evt, itemCtx);
-                ctx.applyOperationContext(evt, itemCtx);
-                ctx.applyUserContext(evt, itemCtx);
-                ctx.applyOperatingSystemContxt(evt, itemCtx);
-                ctx.applyWebContext(evt, itemCtx);
-
-                ctx.applyLocationContext(evt, itemCtx); // legacy tags
-                ctx.applyInternalContext(evt, itemCtx); // legacy tags
-                ctx.cleanUp(evt, itemCtx);
-            }
-        });
-    }
-
-    public initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?:ITelemetryPluginChain) {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-
-    /**
-     * Add Part A fields to the event
-     * @param event - The event that needs to be processed
-     */
-    public processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext) {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
-}