@microsoft/applicationinsights-analytics-js 2.8.5-nightly.2206-03 → 2.8.5-nightly.2207-01

package/src/JavaScriptSDK/Telemetry/PageViewPerformanceManager.ts

@@ -1,146 +1,204 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import { IPageViewPerformanceTelemetryInternal, dateTimeUtilsDuration, msToTimeSpan } from "@microsoft/applicationinsights-common";
+import {
+    IAppInsightsCore, IDiagnosticLogger, _eInternalMessageId, _throwInternal, eLoggingSeverity, getNavigator, getPerformance, safeGetLogger
+} from "@microsoft/applicationinsights-core-js";
+
+const MAX_DURATION_ALLOWED = 3600000; // 1h
+const botAgentNames = ["googlebot", "adsbot-google", "apis-google", "mediapartners-google"];
+
+function _isPerformanceTimingSupported() {
+    let perf = getPerformance();
+    return perf && !!perf.timing;
+}
 
-import {
-    IPageViewPerformanceTelemetryInternal, dateTimeUtilsDuration, msToTimeSpan
-} from "@microsoft/applicationinsights-common";
-import {
-    IAppInsightsCore, IDiagnosticLogger, eLoggingSeverity,
-    _eInternalMessageId, getNavigator, getPerformance, _throwInternal
-} from "@microsoft/applicationinsights-core-js";
+function _isPerformanceNavigationTimingSupported() {
+    let perf = getPerformance();
+    return perf && perf.getEntriesByType && perf.getEntriesByType("navigation").length > 0;
+}
 
-/**
- * Class encapsulates sending page view performance telemetry.
- */
-export class PageViewPerformanceManager {
-    private _logger: IDiagnosticLogger;
-    private MAX_DURATION_ALLOWED = 3600000; // 1h
+function _isPerformanceTimingDataReady() {
+    let perf = getPerformance();
+    const timing = perf ? perf.timing : 0;
+
+    return timing
+        && timing.domainLookupStart > 0
+        && timing.navigationStart > 0
+        && timing.responseStart > 0
+        && timing.requestStart > 0
+        && timing.loadEventEnd > 0
+        && timing.responseEnd > 0
+        && timing.connectEnd > 0
+        && timing.domLoading > 0;
+}
 
-    constructor(core: IAppInsightsCore) {
-        if (core) {
-            this._logger = core.logger;
-        }
+function _getPerformanceTiming(): PerformanceTiming | null {
+    if (_isPerformanceTimingSupported()) {
+        return getPerformance().timing;
+    }
 
+    return null;
+}
+
+function _getPerformanceNavigationTiming(): PerformanceNavigationTiming | null {
+    if (_isPerformanceNavigationTimingSupported()) {
+        return getPerformance().getEntriesByType("navigation")[0] as PerformanceNavigationTiming;
     }
 
-    public populatePageViewPerformanceEvent(pageViewPerformance: IPageViewPerformanceTelemetryInternal): void {
-        pageViewPerformance.isValid = false;
-
-        /*
-         * http://www.w3.org/TR/navigation-timing/#processing-model
-         *  |-navigationStart
-         *  |             |-connectEnd
-         *  |             ||-requestStart
-         *  |             ||             |-responseStart
-         *  |             ||             |              |-responseEnd
-         *  |             ||             |              |
-         *  |             ||             |              |         |-loadEventEnd
-         *  |---network---||---request---|---response---|---dom---|
-         *  |--------------------------total----------------------|
-         *
-         *  total = The difference between the load event of the current document is completed and the first recorded timestamp of the performance entry : https://developer.mozilla.org/en-US/docs/Web/Performance/Navigation_and_resource_timings#duration
-         *  network = Redirect time + App Cache + DNS lookup time + TCP connection time
-         *  request = Request time : https://developer.mozilla.org/en-US/docs/Web/Performance/Navigation_and_resource_timings#request_time
-         *  response = Response time
-         *  dom = Document load time : https://html.spec.whatwg.org/multipage/dom.html#document-load-timing-info
-         *      = Document processing time : https://developers.google.com/web/fundamentals/performance/navigation-and-resource-timing/#document_processing
-         *      + Loading time : https://developers.google.com/web/fundamentals/performance/navigation-and-resource-timing/#loading
-         */
-        const navigationTiming = this.getPerformanceNavigationTiming();
-        const timing = this.getPerformanceTiming();
-        let total = 0;
-        let network = 0;
-        let request = 0;
-        let response = 0;
-        let dom = 0;
-
-        if (navigationTiming || timing) {
-            if (navigationTiming) {
-                total = navigationTiming.duration;
-                /**
-                 * support both cases:
-                 * - startTime is always zero: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming
-                 * - for older browsers where the startTime is not zero
-                 */
-                network = navigationTiming.startTime === 0 ? navigationTiming.connectEnd : dateTimeUtilsDuration(navigationTiming.startTime, navigationTiming.connectEnd);
-                request = dateTimeUtilsDuration(navigationTiming.requestStart, navigationTiming.responseStart);
-                response = dateTimeUtilsDuration(navigationTiming.responseStart, navigationTiming.responseEnd);
-                dom = dateTimeUtilsDuration(navigationTiming.responseEnd, navigationTiming.loadEventEnd);
-            } else {
-                total = dateTimeUtilsDuration(timing.navigationStart, timing.loadEventEnd);
-                network = dateTimeUtilsDuration(timing.navigationStart, timing.connectEnd);
-                request = dateTimeUtilsDuration(timing.requestStart, timing.responseStart);
-                response = dateTimeUtilsDuration(timing.responseStart, timing.responseEnd);
-                dom = dateTimeUtilsDuration(timing.responseEnd, timing.loadEventEnd);
-            }
+    return null;
+}
 
-            let logger = this._logger;
-
-            if (total === 0) {
-                _throwInternal(logger,
-                    eLoggingSeverity.WARNING,
-                    _eInternalMessageId.ErrorPVCalc,
-                    "error calculating page view performance.",
-                    { total, network, request, response, dom });
-
-            } else if (!this.shouldCollectDuration(total, network, request, response, dom)) {
-                _throwInternal(logger,
-                    eLoggingSeverity.WARNING,
-                    _eInternalMessageId.InvalidDurationValue,
-                    "Invalid page load duration value. Browser perf data won't be sent.",
-                    { total, network, request, response, dom });
-
-            } else if (total < Math.floor(network) + Math.floor(request) + Math.floor(response) + Math.floor(dom)) {
-                // some browsers may report individual components incorrectly so that the sum of the parts will be bigger than total PLT
-                // in this case, don't report client performance from this page
-                _throwInternal(logger,
-                    eLoggingSeverity.WARNING,
-                    _eInternalMessageId.ClientPerformanceMathError,
-                    "client performance math error.",
-                    { total, network, request, response, dom });
-
-            } else {
-                pageViewPerformance.durationMs = total;
-                // // convert to timespans
-                pageViewPerformance.perfTotal = pageViewPerformance.duration = msToTimeSpan(total);
-                pageViewPerformance.networkConnect = msToTimeSpan(network);
-                pageViewPerformance.sentRequest = msToTimeSpan(request);
-                pageViewPerformance.receivedResponse = msToTimeSpan(response);
-                pageViewPerformance.domProcessing = msToTimeSpan(dom);
-                pageViewPerformance.isValid = true;
-            }
+/**
+* This method tells if given durations should be excluded from collection.
+*/
+function _shouldCollectDuration(...durations: number[]): boolean {
+    var _navigator = getNavigator() || {} as any;
+    // a full list of Google crawlers user agent strings - https://support.google.com/webmasters/answer/1061943?hl=en
+    const userAgent = _navigator.userAgent;
+    let isGoogleBot = false;
+
+    if (userAgent) {
+        for (let i = 0; i < botAgentNames.length; i++) {
+            isGoogleBot = isGoogleBot || userAgent.toLowerCase().indexOf(botAgentNames[i]) !== -1;
         }
     }
 
-    public getPerformanceTiming(): PerformanceTiming | null {
-        if (this.isPerformanceTimingSupported()) {
-            return getPerformance().timing;
+    if (isGoogleBot) {
+        // Don't report durations for GoogleBot, it is returning invalid values in performance.timing API.
+        return false;
+    } else {
+        // for other page views, don't report if it's outside of a reasonable range
+        for (let i = 0; i < durations.length; i++) {
+            if (durations[i] < 0 || durations[i] >= MAX_DURATION_ALLOWED) {
+                return false;
+            }
         }
+    }
 
-        return null;
+    return true;
+}
+
+/**
+ * Class encapsulates sending page view performance telemetry.
+ */
+export class PageViewPerformanceManager {
+
+    constructor(core: IAppInsightsCore) {
+        let _logger: IDiagnosticLogger = safeGetLogger(core);
+
+        dynamicProto(PageViewPerformanceManager, this, (_self) => {
+            _self.populatePageViewPerformanceEvent = (pageViewPerformance: IPageViewPerformanceTelemetryInternal): void => {
+                pageViewPerformance.isValid = false;
+        
+                /*
+                 * http://www.w3.org/TR/navigation-timing/#processing-model
+                 *  |-navigationStart
+                 *  |             |-connectEnd
+                 *  |             ||-requestStart
+                 *  |             ||             |-responseStart
+                 *  |             ||             |              |-responseEnd
+                 *  |             ||             |              |
+                 *  |             ||             |              |         |-loadEventEnd
+                 *  |---network---||---request---|---response---|---dom---|
+                 *  |--------------------------total----------------------|
+                 *
+                 *  total = The difference between the load event of the current document is completed and the first recorded timestamp of the performance entry : https://developer.mozilla.org/en-US/docs/Web/Performance/Navigation_and_resource_timings#duration
+                 *  network = Redirect time + App Cache + DNS lookup time + TCP connection time
+                 *  request = Request time : https://developer.mozilla.org/en-US/docs/Web/Performance/Navigation_and_resource_timings#request_time
+                 *  response = Response time
+                 *  dom = Document load time : https://html.spec.whatwg.org/multipage/dom.html#document-load-timing-info
+                 *      = Document processing time : https://developers.google.com/web/fundamentals/performance/navigation-and-resource-timing/#document_processing
+                 *      + Loading time : https://developers.google.com/web/fundamentals/performance/navigation-and-resource-timing/#loading
+                 */
+                const navigationTiming = _getPerformanceNavigationTiming();
+                const timing = _getPerformanceTiming();
+                let total = 0;
+                let network = 0;
+                let request = 0;
+                let response = 0;
+                let dom = 0;
+        
+                if (navigationTiming || timing) {
+                    if (navigationTiming) {
+                        total = navigationTiming.duration;
+                        /**
+                         * support both cases:
+                         * - startTime is always zero: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming
+                         * - for older browsers where the startTime is not zero
+                         */
+                        network = navigationTiming.startTime === 0 ? navigationTiming.connectEnd : dateTimeUtilsDuration(navigationTiming.startTime, navigationTiming.connectEnd);
+                        request = dateTimeUtilsDuration(navigationTiming.requestStart, navigationTiming.responseStart);
+                        response = dateTimeUtilsDuration(navigationTiming.responseStart, navigationTiming.responseEnd);
+                        dom = dateTimeUtilsDuration(navigationTiming.responseEnd, navigationTiming.loadEventEnd);
+                    } else {
+                        total = dateTimeUtilsDuration(timing.navigationStart, timing.loadEventEnd);
+                        network = dateTimeUtilsDuration(timing.navigationStart, timing.connectEnd);
+                        request = dateTimeUtilsDuration(timing.requestStart, timing.responseStart);
+                        response = dateTimeUtilsDuration(timing.responseStart, timing.responseEnd);
+                        dom = dateTimeUtilsDuration(timing.responseEnd, timing.loadEventEnd);
+                    }
+        
+                    if (total === 0) {
+                        _throwInternal(_logger,
+                            eLoggingSeverity.WARNING,
+                            _eInternalMessageId.ErrorPVCalc,
+                            "error calculating page view performance.",
+                            { total, network, request, response, dom });
+        
+                    } else if (!this.shouldCollectDuration(total, network, request, response, dom)) {
+                        _throwInternal(_logger,
+                            eLoggingSeverity.WARNING,
+                            _eInternalMessageId.InvalidDurationValue,
+                            "Invalid page load duration value. Browser perf data won't be sent.",
+                            { total, network, request, response, dom });
+        
+                    } else if (total < Math.floor(network) + Math.floor(request) + Math.floor(response) + Math.floor(dom)) {
+                        // some browsers may report individual components incorrectly so that the sum of the parts will be bigger than total PLT
+                        // in this case, don't report client performance from this page
+                        _throwInternal(_logger,
+                            eLoggingSeverity.WARNING,
+                            _eInternalMessageId.ClientPerformanceMathError,
+                            "client performance math error.",
+                            { total, network, request, response, dom });
+        
+                    } else {
+                        pageViewPerformance.durationMs = total;
+                        // // convert to timespans
+                        pageViewPerformance.perfTotal = pageViewPerformance.duration = msToTimeSpan(total);
+                        pageViewPerformance.networkConnect = msToTimeSpan(network);
+                        pageViewPerformance.sentRequest = msToTimeSpan(request);
+                        pageViewPerformance.receivedResponse = msToTimeSpan(response);
+                        pageViewPerformance.domProcessing = msToTimeSpan(dom);
+                        pageViewPerformance.isValid = true;
+                    }
+                }
+            }
+        
+            _self.getPerformanceTiming = _getPerformanceTiming;
+            _self.isPerformanceTimingSupported = _isPerformanceTimingSupported;
+            _self.isPerformanceTimingDataReady = _isPerformanceTimingDataReady;
+            _self.shouldCollectDuration = _shouldCollectDuration;
+        });
     }
-    public getPerformanceNavigationTiming(): PerformanceNavigationTiming | null {
-        if (this.isPerformanceNavigationTimingSupported()) {
-            return getPerformance().getEntriesByType("navigation")[0] as PerformanceNavigationTiming;
-        }
 
-        return null;
+    public populatePageViewPerformanceEvent(pageViewPerformance: IPageViewPerformanceTelemetryInternal): void {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 
-    /**
-    * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
-    */
-    public isPerformanceNavigationTimingSupported() {
-        let perf = getPerformance();
-        return perf && perf.getEntriesByType && perf.getEntriesByType("navigation").length > 0;
+    public getPerformanceTiming(): PerformanceTiming | null {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+        return null;
     }
 
     /**
     * Returns true is window performance timing API is supported, false otherwise.
     */
     public isPerformanceTimingSupported() {
-        let perf = getPerformance();
-        return perf && perf.timing;
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+        return true;
     }
 
     /**
@@ -148,50 +206,15 @@ export class PageViewPerformanceManager {
     * Returns true if ready, false otherwise.
     */
     public isPerformanceTimingDataReady() {
-        let perf = getPerformance();
-        const timing = perf ? perf.timing : 0;
-
-        return timing
-            && timing.domainLookupStart > 0
-            && timing.navigationStart > 0
-            && timing.responseStart > 0
-            && timing.requestStart > 0
-            && timing.loadEventEnd > 0
-            && timing.responseEnd > 0
-            && timing.connectEnd > 0
-            && timing.domLoading > 0;
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+        return true;
     }
 
     /**
     * This method tells if given durations should be excluded from collection.
     */
     public shouldCollectDuration(...durations: number[]): boolean {
-        var _navigator = getNavigator() || {} as any;
-        // a full list of Google crawlers user agent strings - https://support.google.com/webmasters/answer/1061943?hl=en
-        const botAgentNames = ["googlebot", "adsbot-google", "apis-google", "mediapartners-google"];
-        const userAgent = _navigator.userAgent;
-        let isGoogleBot = false;
-
-        if (userAgent) {
-            for (let i = 0; i < botAgentNames.length; i++) {
-                isGoogleBot = isGoogleBot || userAgent.toLowerCase().indexOf(botAgentNames[i]) !== -1;
-            }
-        }
-
-        if (isGoogleBot) {
-            // Don't report durations for GoogleBot, it is returning invalid values in performance.timing API.
-            return false;
-        } else {
-            // for other page views, don't report if it's outside of a reasonable range
-            for (let i = 0; i < durations.length; i++) {
-                if (durations[i] < 0 || durations[i] >= this.MAX_DURATION_ALLOWED) {
-                    return false;
-                }
-            }
-        }
-
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
         return true;
     }
-
-
-}
+}

package/src/JavaScriptSDK/Telemetry/PageVisitTimeManager.ts

@@ -1,121 +1,129 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { utlCanUseSessionStorage, utlGetSessionStorage, utlRemoveSessionStorage, utlSetSessionStorage } from "@microsoft/applicationinsights-common";
-import { IDiagnosticLogger, hasJSON, getJSON, dateNow, dumpObj, throwError, _warnToConsole } from "@microsoft/applicationinsights-core-js";
-
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import {
+    utlCanUseSessionStorage, utlGetSessionStorage, utlRemoveSessionStorage, utlSetSessionStorage
+} from "@microsoft/applicationinsights-common";
+import {
+    IDiagnosticLogger, _warnToConsole, dateNow, dumpObj, getJSON, hasJSON, objDefineAccessors, throwError
+} from "@microsoft/applicationinsights-core-js";
+
 /**
  * Used to track page visit durations
  */
 export class PageVisitTimeManager {
 
-    private prevPageVisitDataKeyName: string = "prevPageVisitData";
-    private pageVisitTimeTrackingHandler: (pageName: string, pageUrl: string, pageVisitTime: number) => void;
-    private _logger: IDiagnosticLogger;
-
     /**
      * Creates a new instance of PageVisitTimeManager
      * @param pageVisitTimeTrackingHandler Delegate that will be called to send telemetry data to AI (when trackPreviousPageVisit is called)
      * @returns {}
      */
     constructor(logger: IDiagnosticLogger, pageVisitTimeTrackingHandler: (pageName: string, pageUrl: string, pageVisitTime: number) => void) {
-        this.pageVisitTimeTrackingHandler = pageVisitTimeTrackingHandler;
-        this._logger = logger;
-    }
-
-    /**
-    * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
-    * @param currentPageName Name of page to begin timing for visit duration
-    * @param currentPageUrl Url of page to begin timing for visit duration
-    */
-    public trackPreviousPageVisit(currentPageName: string, currentPageUrl: string) {
-
-        try {
-            // Restart timer for new page view
-            const prevPageVisitTimeData = this.restartPageVisitTimer(currentPageName, currentPageUrl);
+        let prevPageVisitDataKeyName: string = "prevPageVisitData";
+
+        dynamicProto(PageVisitTimeManager, this, (_self) => {
+            _self.trackPreviousPageVisit = (currentPageName: string, currentPageUrl: string) => {
+
+                try {
+                    // Restart timer for new page view
+                    const prevPageVisitTimeData = restartPageVisitTimer(currentPageName, currentPageUrl);
+        
+                    // If there was a page already being timed, track the visit time for it now.
+                    if (prevPageVisitTimeData) {
+                        pageVisitTimeTrackingHandler(prevPageVisitTimeData.pageName, prevPageVisitTimeData.pageUrl, prevPageVisitTimeData.pageVisitTime);
+                    }
+                } catch (e) {
+                    _warnToConsole(logger, "Auto track page visit time failed, metric will not be collected: " + dumpObj(e));
+                }
+            };
+        
+            /**
+             * Stops timing of current page (if exists) and starts timing for duration of visit to pageName
+             * @param pageName Name of page to begin timing visit duration
+             * @returns {PageVisitData} Page visit data (including duration) of pageName from last call to start or restart, if exists. Null if not.
+             */
+            function restartPageVisitTimer(pageName: string, pageUrl: string) {
+                let prevPageVisitData: PageVisitData = null;
+                try {
+                    prevPageVisitData = stopPageVisitTimer();
+                    startPageVisitTimer(pageName, pageUrl);
+        
+                } catch (e) {
+                    _warnToConsole(logger, "Call to restart failed: " + dumpObj(e));
+                    prevPageVisitData = null;
+                }
 
-            // If there was a page already being timed, track the visit time for it now.
-            if (prevPageVisitTimeData) {
-                this.pageVisitTimeTrackingHandler(prevPageVisitTimeData.pageName, prevPageVisitTimeData.pageUrl, prevPageVisitTimeData.pageVisitTime);
+                return prevPageVisitData;
             }
-        } catch (e) {
-            _warnToConsole(this._logger, "Auto track page visit time failed, metric will not be collected: " + dumpObj(e));
-        }
-    }
-
-    /**
-     * Stops timing of current page (if exists) and starts timing for duration of visit to pageName
-     * @param pageName Name of page to begin timing visit duration
-     * @returns {PageVisitData} Page visit data (including duration) of pageName from last call to start or restart, if exists. Null if not.
-     */
-    public restartPageVisitTimer(pageName: string, pageUrl: string) {
-        try {
-            const prevPageVisitData = this.stopPageVisitTimer();
-            this.startPageVisitTimer(pageName, pageUrl);
-
-            return prevPageVisitData;
-        } catch (e) {
-            _warnToConsole(this._logger, "Call to restart failed: " + dumpObj(e));
-            return null;
-        }
-    }
-
-    /**
-     * Starts timing visit duration of pageName
-     * @param pageName
-     * @returns {}
-     */
-    public startPageVisitTimer(pageName: string, pageUrl: string) {
-        try {
-            if (utlCanUseSessionStorage()) {
-                if (utlGetSessionStorage(this._logger, this.prevPageVisitDataKeyName) != null) {
-                    throwError("Cannot call startPageVisit consecutively without first calling stopPageVisit");
+        
+            /**
+             * Starts timing visit duration of pageName
+             * @param pageName
+             * @returns {}
+             */
+            function startPageVisitTimer(pageName: string, pageUrl: string) {
+                try {
+                    if (utlCanUseSessionStorage()) {
+                        if (utlGetSessionStorage(logger, prevPageVisitDataKeyName) != null) {
+                            throwError("Cannot call startPageVisit consecutively without first calling stopPageVisit");
+                        }
+        
+                        const currPageVisitData = new PageVisitData(pageName, pageUrl);
+                        const currPageVisitDataStr = getJSON().stringify(currPageVisitData);
+                        utlSetSessionStorage(logger, prevPageVisitDataKeyName, currPageVisitDataStr);
+                    }
+                } catch (e) {
+                    // TODO: Remove this catch in next phase, since if start is called twice in a row the exception needs to be propagated out
+                    _warnToConsole(logger, "Call to start failed: " + dumpObj(e));
+                }
+            }
+        
+            /**
+             * Stops timing of current page, if exists.
+             * @returns {PageVisitData} Page visit data (including duration) of pageName from call to start, if exists. Null if not.
+             */
+            function stopPageVisitTimer() {
+                let prevPageVisitData: PageVisitData = null;
+                try {
+                    if (utlCanUseSessionStorage()) {
+        
+                        // Define end time of page's visit
+                        const pageVisitEndTime = dateNow();
+        
+                        // Try to retrieve  page name and start time from session storage
+                        const pageVisitDataJsonStr = utlGetSessionStorage(logger, prevPageVisitDataKeyName);
+                        if (pageVisitDataJsonStr && hasJSON()) {
+        
+                            // if previous page data exists, set end time of visit
+                            prevPageVisitData = getJSON().parse(pageVisitDataJsonStr);
+                            prevPageVisitData.pageVisitTime = pageVisitEndTime - prevPageVisitData.pageVisitStartTime;
+        
+                            // Remove data from storage since we already used it
+                            utlRemoveSessionStorage(logger, prevPageVisitDataKeyName);
+                        }
+                    }
+                } catch (e) {
+                    _warnToConsole(logger, "Stop page visit timer failed: " + dumpObj(e));
+                    prevPageVisitData = null;
                 }
 
-                const currPageVisitData = new PageVisitData(pageName, pageUrl);
-                const currPageVisitDataStr = getJSON().stringify(currPageVisitData);
-                utlSetSessionStorage(this._logger, this.prevPageVisitDataKeyName, currPageVisitDataStr);
+                return prevPageVisitData;
             }
-        } catch (e) {
-            // TODO: Remove this catch in next phase, since if start is called twice in a row the exception needs to be propagated out
-            _warnToConsole(this._logger, "Call to start failed: " + dumpObj(e));
-        }
+
+            // For backward compatibility
+            objDefineAccessors(_self, "_logger", () => logger);
+            objDefineAccessors(_self, "pageVisitTimeTrackingHandler", () => pageVisitTimeTrackingHandler);
+        });
     }
 
     /**
-     * Stops timing of current page, if exists.
-     * @returns {PageVisitData} Page visit data (including duration) of pageName from call to start, if exists. Null if not.
-     */
-    public stopPageVisitTimer() {
-        try {
-            if (utlCanUseSessionStorage()) {
-
-                // Define end time of page's visit
-                const pageVisitEndTime = dateNow();
-
-                // Try to retrieve  page name and start time from session storage
-                const pageVisitDataJsonStr = utlGetSessionStorage(this._logger, this.prevPageVisitDataKeyName);
-                if (pageVisitDataJsonStr && hasJSON()) {
-
-                    // if previous page data exists, set end time of visit
-                    const prevPageVisitData: PageVisitData = getJSON().parse(pageVisitDataJsonStr);
-                    prevPageVisitData.pageVisitTime = pageVisitEndTime - prevPageVisitData.pageVisitStartTime;
-
-                    // Remove data from storage since we already used it
-                    utlRemoveSessionStorage(this._logger, this.prevPageVisitDataKeyName);
-
-                    // Return page visit data
-                    return prevPageVisitData;
-                } else {
-                    return null;
-                }
-
-            }
-            return null;
-        } catch (e) {
-            _warnToConsole(this._logger, "Stop page visit timer failed: " + dumpObj(e));
-            return null;
-        }
+    * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
+    * @param currentPageName Name of page to begin timing for visit duration
+    * @param currentPageUrl Url of page to begin timing for visit duration
+    */
+    public trackPreviousPageVisit(currentPageName: string, currentPageUrl: string): void {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 }
 
@@ -131,4 +139,4 @@ export class PageVisitData {
         this.pageName = pageName;
         this.pageUrl = pageUrl;
     }
-}
+}