1
0
mirror of https://github.com/musix-org/musix-oss synced 2024-12-24 11:13:18 +00:00
musix-oss/node_modules/@firebase/performance/dist/index.cjs.js

1346 lines
51 KiB
JavaScript
Raw Normal View History

2020-03-03 20:30:50 +00:00
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
var firebase = _interopDefault(require('@firebase/app'));
require('@firebase/installations');
var tslib = require('tslib');
var util = require('@firebase/util');
var logger$1 = require('@firebase/logger');
var component = require('@firebase/component');
var name = "@firebase/performance";
var version = "0.2.31";
/**
* @license
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var SDK_VERSION = version;
/** The prefix for start User Timing marks used for creating Traces. */
var TRACE_START_MARK_PREFIX = 'FB-PERF-TRACE-START';
/** The prefix for stop User Timing marks used for creating Traces. */
var TRACE_STOP_MARK_PREFIX = 'FB-PERF-TRACE-STOP';
/** The prefix for User Timing measure used for creating Traces. */
var TRACE_MEASURE_PREFIX = 'FB-PERF-TRACE-MEASURE';
/** The prefix for out of the box page load Trace name. */
var OOB_TRACE_PAGE_LOAD_PREFIX = '_wt_';
var FIRST_PAINT_COUNTER_NAME = '_fp';
var FIRST_CONTENTFUL_PAINT_COUNTER_NAME = '_fcp';
var FIRST_INPUT_DELAY_COUNTER_NAME = '_fid';
var CONFIG_LOCAL_STORAGE_KEY = '@firebase/performance/config';
var CONFIG_EXPIRY_LOCAL_STORAGE_KEY = '@firebase/performance/configexpire';
var SERVICE = 'performance';
var SERVICE_NAME = 'Performance';
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var _a;
var ERROR_DESCRIPTION_MAP = (_a = {},
_a["trace started" /* TRACE_STARTED_BEFORE */] = 'Trace {$traceName} was started before.',
_a["trace stopped" /* TRACE_STOPPED_BEFORE */] = 'Trace {$traceName} is not running.',
_a["no window" /* NO_WINDOW */] = 'Window is not available.',
_a["no app id" /* NO_APP_ID */] = 'App id is not available.',
_a["no project id" /* NO_PROJECT_ID */] = 'Project id is not available.',
_a["no api key" /* NO_API_KEY */] = 'Api key is not available.',
_a["invalid cc log" /* INVALID_CC_LOG */] = 'Attempted to queue invalid cc event',
_a["FB not default" /* FB_NOT_DEFAULT */] = 'Performance can only start when Firebase app instance is the default one.',
_a["RC response not ok" /* RC_NOT_OK */] = 'RC response is not ok',
_a["invalid attribute name" /* INVALID_ATTRIBUTE_NAME */] = 'Attribute name {$attributeName} is invalid.',
_a["invalid attribute value" /* INVALID_ATTRIBUTE_VALUE */] = 'Attribute value {$attributeValue} is invalid.',
_a["invalide custom metric name" /* INVALID_CUSTOM_METRIC_NAME */] = 'Custom metric name {$customMetricName} is invalid',
_a);
var ERROR_FACTORY = new util.ErrorFactory(SERVICE, SERVICE_NAME, ERROR_DESCRIPTION_MAP);
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var apiInstance;
var windowInstance;
/**
* This class holds a reference to various browser related objects injected by
* set methods.
*/
var Api = /** @class */ (function () {
function Api(window) {
this.window = window;
if (!window) {
throw ERROR_FACTORY.create("no window" /* NO_WINDOW */);
}
this.performance = window.performance;
this.PerformanceObserver = window.PerformanceObserver;
this.windowLocation = window.location;
this.navigator = window.navigator;
this.document = window.document;
if (this.navigator && this.navigator.cookieEnabled) {
// If user blocks cookies on the browser, accessing localStorage will
// throw an exception.
this.localStorage = window.localStorage;
}
if (window.perfMetrics && window.perfMetrics.onFirstInputDelay) {
this.onFirstInputDelay = window.perfMetrics.onFirstInputDelay;
}
}
Api.prototype.getUrl = function () {
// Do not capture the string query part of url.
return this.windowLocation.href.split('?')[0];
};
Api.prototype.mark = function (name) {
if (!this.performance || !this.performance.mark) {
return;
}
this.performance.mark(name);
};
Api.prototype.measure = function (measureName, mark1, mark2) {
if (!this.performance || !this.performance.measure) {
return;
}
this.performance.measure(measureName, mark1, mark2);
};
Api.prototype.getEntriesByType = function (type) {
if (!this.performance || !this.performance.getEntriesByType) {
return [];
}
return this.performance.getEntriesByType(type);
};
Api.prototype.getEntriesByName = function (name) {
if (!this.performance || !this.performance.getEntriesByName) {
return [];
}
return this.performance.getEntriesByName(name);
};
Api.prototype.getTimeOrigin = function () {
// Polyfill the time origin with performance.timing.navigationStart.
return (this.performance &&
(this.performance.timeOrigin || this.performance.timing.navigationStart));
};
Api.prototype.requiredApisAvailable = function () {
if (fetch && Promise && this.navigator && this.navigator.cookieEnabled) {
return true;
}
return false;
};
Api.prototype.setupObserver = function (entryType, callback) {
if (!this.PerformanceObserver) {
return;
}
var observer = new this.PerformanceObserver(function (list) {
for (var _i = 0, _a = list.getEntries(); _i < _a.length; _i++) {
var entry = _a[_i];
// `entry` is a PerformanceEntry instance.
callback(entry);
}
});
// Start observing the entry types you care about.
observer.observe({ entryTypes: [entryType] });
};
Api.getInstance = function () {
if (apiInstance === undefined) {
apiInstance = new Api(windowInstance);
}
return apiInstance;
};
return Api;
}());
function setupApi(window) {
windowInstance = window;
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var settingsServiceInstance;
var SettingsService = /** @class */ (function () {
function SettingsService() {
// The variable which controls logging of automatic traces and HTTP/S network monitoring.
this.instrumentationEnabled = true;
// The variable which controls logging of custom traces.
this.dataCollectionEnabled = true;
// Configuration flags set through remote config.
this.loggingEnabled = false;
// Sampling rate between 0 and 1.
this.tracesSamplingRate = 1;
this.networkRequestsSamplingRate = 1;
// Address of logging service.
this.logEndPointUrl = 'https://firebaselogging.googleapis.com/v0cc/log?format=json_proto';
this.logSource = 462;
// Flags which control per session logging of traces and network requests.
this.logTraceAfterSampling = false;
this.logNetworkAfterSampling = false;
// TTL of config retrieved from remote config in hours.
this.configTimeToLive = 12;
}
SettingsService.prototype.getAppId = function () {
var appId = this.firebaseAppInstance &&
this.firebaseAppInstance.options &&
this.firebaseAppInstance.options.appId;
if (!appId) {
throw ERROR_FACTORY.create("no app id" /* NO_APP_ID */);
}
return appId;
};
SettingsService.prototype.getProjectId = function () {
var projectId = this.firebaseAppInstance &&
this.firebaseAppInstance.options &&
this.firebaseAppInstance.options.projectId;
if (!projectId) {
throw ERROR_FACTORY.create("no project id" /* NO_PROJECT_ID */);
}
return projectId;
};
SettingsService.prototype.getApiKey = function () {
var apiKey = this.firebaseAppInstance &&
this.firebaseAppInstance.options &&
this.firebaseAppInstance.options.apiKey;
if (!apiKey) {
throw ERROR_FACTORY.create("no api key" /* NO_API_KEY */);
}
return apiKey;
};
SettingsService.getInstance = function () {
if (settingsServiceInstance === undefined) {
settingsServiceInstance = new SettingsService();
}
return settingsServiceInstance;
};
return SettingsService;
}());
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var iid;
function getIidPromise() {
var iidPromise = SettingsService.getInstance().installationsService.getId();
// eslint-disable-next-line @typescript-eslint/no-floating-promises
iidPromise.then(function (iidVal) {
iid = iidVal;
});
return iidPromise;
}
// This method should be used after the iid is retrieved by getIidPromise method.
function getIid() {
return iid;
}
function getAuthTokenPromise() {
var authTokenPromise = SettingsService.getInstance().installationsService.getToken();
// eslint-disable-next-line @typescript-eslint/no-floating-promises
authTokenPromise.then(function (authTokenVal) {
});
return authTokenPromise;
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var VisibilityState;
(function (VisibilityState) {
VisibilityState[VisibilityState["UNKNOWN"] = 0] = "UNKNOWN";
VisibilityState[VisibilityState["VISIBLE"] = 1] = "VISIBLE";
VisibilityState[VisibilityState["HIDDEN"] = 2] = "HIDDEN";
})(VisibilityState || (VisibilityState = {}));
var RESERVED_ATTRIBUTE_PREFIXES = ['firebase_', 'google_', 'ga_'];
var ATTRIBUTE_FORMAT_REGEX = new RegExp('^[a-zA-Z]\\w*$');
var MAX_ATTRIBUTE_NAME_LENGTH = 40;
var MAX_ATTRIBUTE_VALUE_LENGTH = 100;
function getServiceWorkerStatus() {
var navigator = Api.getInstance().navigator;
if ('serviceWorker' in navigator) {
if (navigator.serviceWorker.controller) {
return 2 /* CONTROLLED */;
}
else {
return 3 /* UNCONTROLLED */;
}
}
else {
return 1 /* UNSUPPORTED */;
}
}
function getVisibilityState() {
var document = Api.getInstance().document;
var visibilityState = document.visibilityState;
switch (visibilityState) {
case 'visible':
return VisibilityState.VISIBLE;
case 'hidden':
return VisibilityState.HIDDEN;
default:
return VisibilityState.UNKNOWN;
}
}
function getEffectiveConnectionType() {
var navigator = Api.getInstance().navigator;
var navigatorConnection = navigator.connection;
var effectiveType = navigatorConnection && navigatorConnection.effectiveType;
switch (effectiveType) {
case 'slow-2g':
return 1 /* CONNECTION_SLOW_2G */;
case '2g':
return 2 /* CONNECTION_2G */;
case '3g':
return 3 /* CONNECTION_3G */;
case '4g':
return 4 /* CONNECTION_4G */;
default:
return 0 /* UNKNOWN */;
}
}
function isValidCustomAttributeName(name) {
if (name.length === 0 || name.length > MAX_ATTRIBUTE_NAME_LENGTH) {
return false;
}
var matchesReservedPrefix = RESERVED_ATTRIBUTE_PREFIXES.some(function (prefix) {
return name.startsWith(prefix);
});
return !matchesReservedPrefix && !!name.match(ATTRIBUTE_FORMAT_REGEX);
}
function isValidCustomAttributeValue(value) {
return value.length !== 0 && value.length <= MAX_ATTRIBUTE_VALUE_LENGTH;
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var consoleLogger = new logger$1.Logger(SERVICE_NAME);
consoleLogger.logLevel = logger$1.LogLevel.INFO;
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var REMOTE_CONFIG_SDK_VERSION = '0.0.1';
// These values will be used if the remote config object is successfully
// retrieved, but the template does not have these fields.
var SECONDARY_CONFIGS = {
loggingEnabled: true
};
var FIS_AUTH_PREFIX = 'FIREBASE_INSTALLATIONS_AUTH';
function getConfig(iid) {
var config = getStoredConfig();
if (config) {
processConfig(config);
return Promise.resolve();
}
return getRemoteConfig(iid)
.then(function (config) { return processConfig(config); })
.then(function (config) { return storeConfig(config); },
/** Do nothing for error, use defaults set in settings service. */
function () { });
}
function getStoredConfig() {
var localStorage = Api.getInstance().localStorage;
if (!localStorage) {
return;
}
var expiryString = localStorage.getItem(CONFIG_EXPIRY_LOCAL_STORAGE_KEY);
if (!expiryString || !configValid(expiryString)) {
return;
}
var configStringified = localStorage.getItem(CONFIG_LOCAL_STORAGE_KEY);
if (!configStringified) {
return;
}
try {
var configResponse = JSON.parse(configStringified);
return configResponse;
}
catch (_a) {
return;
}
}
function storeConfig(config) {
var localStorage = Api.getInstance().localStorage;
if (!config || !localStorage) {
return;
}
localStorage.setItem(CONFIG_LOCAL_STORAGE_KEY, JSON.stringify(config));
localStorage.setItem(CONFIG_EXPIRY_LOCAL_STORAGE_KEY, String(Date.now() +
SettingsService.getInstance().configTimeToLive * 60 * 60 * 1000));
}
var COULD_NOT_GET_CONFIG_MSG = 'Could not fetch config, will use default configs';
function getRemoteConfig(iid) {
// Perf needs auth token only to retrieve remote config.
return getAuthTokenPromise()
.then(function (authToken) {
var projectId = SettingsService.getInstance().getProjectId();
var configEndPoint = "https://firebaseremoteconfig.googleapis.com/v1/projects/" + projectId + "/namespaces/fireperf:fetch?key=" + SettingsService.getInstance().getApiKey();
var request = new Request(configEndPoint, {
method: 'POST',
headers: { Authorization: FIS_AUTH_PREFIX + " " + authToken },
/* eslint-disable camelcase */
body: JSON.stringify({
app_instance_id: iid,
app_instance_id_token: authToken,
app_id: SettingsService.getInstance().getAppId(),
app_version: SDK_VERSION,
sdk_version: REMOTE_CONFIG_SDK_VERSION
})
/* eslint-enable camelcase */
});
return fetch(request).then(function (response) {
if (response.ok) {
return response.json();
}
// In case response is not ok. This will be caught by catch.
throw ERROR_FACTORY.create("RC response not ok" /* RC_NOT_OK */);
});
})
.catch(function () {
consoleLogger.info(COULD_NOT_GET_CONFIG_MSG);
return undefined;
});
}
/**
* Processes config coming either from calling RC or from local storage.
* This method only runs if call is successful or config in storage
* is valie.
*/
function processConfig(config) {
if (!config) {
return config;
}
var settingsServiceInstance = SettingsService.getInstance();
var entries = config.entries || {};
if (entries.fpr_enabled !== undefined) {
// TODO: Change the assignment of loggingEnabled once the received type is
// known.
settingsServiceInstance.loggingEnabled =
String(entries.fpr_enabled) === 'true';
}
else {
// Config retrieved successfully, but there is no fpr_enabled in template.
// Use secondary configs value.
settingsServiceInstance.loggingEnabled = SECONDARY_CONFIGS.loggingEnabled;
}
if (entries.fpr_log_source) {
settingsServiceInstance.logSource = Number(entries.fpr_log_source);
}
if (entries.fpr_log_endpoint_url) {
settingsServiceInstance.logEndPointUrl = entries.fpr_log_endpoint_url;
}
if (entries.fpr_vc_network_request_sampling_rate !== undefined) {
settingsServiceInstance.networkRequestsSamplingRate = Number(entries.fpr_vc_network_request_sampling_rate);
}
if (entries.fpr_vc_trace_sampling_rate !== undefined) {
settingsServiceInstance.tracesSamplingRate = Number(entries.fpr_vc_trace_sampling_rate);
}
// Set the per session trace and network logging flags.
settingsServiceInstance.logTraceAfterSampling = shouldLogAfterSampling(settingsServiceInstance.tracesSamplingRate);
settingsServiceInstance.logNetworkAfterSampling = shouldLogAfterSampling(settingsServiceInstance.networkRequestsSamplingRate);
return config;
}
function configValid(expiry) {
return Number(expiry) > Date.now();
}
function shouldLogAfterSampling(samplingRate) {
return Math.random() <= samplingRate;
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var initializationStatus = 1 /* notInitialized */;
var initializationPromise;
function getInitializationPromise() {
initializationStatus = 2 /* initializationPending */;
initializationPromise = initializationPromise || initializePerf();
return initializationPromise;
}
function isPerfInitialized() {
return initializationStatus === 3 /* initialized */;
}
function initializePerf() {
return getDocumentReadyComplete()
.then(function () { return getIidPromise(); })
.then(function (iid) { return getConfig(iid); })
.then(function () { return changeInitializationStatus(); }, function () { return changeInitializationStatus(); });
}
/**
* Returns a promise which resolves whenever the document readystate is complete or
* immediately if it is called after page load complete.
*/
function getDocumentReadyComplete() {
var document = Api.getInstance().document;
return new Promise(function (resolve) {
if (document && document.readyState !== 'complete') {
var handler_1 = function () {
if (document.readyState === 'complete') {
document.removeEventListener('readystatechange', handler_1);
resolve();
}
};
document.addEventListener('readystatechange', handler_1);
}
else {
resolve();
}
});
}
function changeInitializationStatus() {
initializationStatus = 3 /* initialized */;
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var DEFAULT_SEND_INTERVAL_MS = 10 * 1000;
var INITIAL_SEND_TIME_DELAY_MS = 5.5 * 1000;
// If end point does not work, the call will be tried for these many times.
var DEFAULT_REMAINING_TRIES = 3;
var remainingTries = DEFAULT_REMAINING_TRIES;
/* eslint-enable camelcase */
var queue = [];
var isTransportSetup = false;
function setupTransportService() {
if (!isTransportSetup) {
processQueue(INITIAL_SEND_TIME_DELAY_MS);
isTransportSetup = true;
}
}
function processQueue(timeOffset) {
setTimeout(function () {
// If there is no remainingTries left, stop retrying.
if (remainingTries === 0) {
return;
}
// If there are no events to process, wait for DEFAULT_SEND_INTERVAL_MS and try again.
if (!queue.length) {
return processQueue(DEFAULT_SEND_INTERVAL_MS);
}
// Capture a snapshot of the queue and empty the "official queue".
var staged = tslib.__spreadArrays(queue);
queue = [];
/* eslint-disable camelcase */
// We will pass the JSON serialized event to the backend.
var log_event = staged.map(function (evt) { return ({
source_extension_json_proto3: evt.message,
event_time_ms: String(evt.eventTime)
}); });
var data = {
request_time_ms: String(Date.now()),
client_info: {
client_type: 1,
js_client_info: {}
},
log_source: SettingsService.getInstance().logSource,
log_event: log_event
};
/* eslint-enable camelcase */
fetch(SettingsService.getInstance().logEndPointUrl, {
method: 'POST',
body: JSON.stringify(data)
})
.then(function (res) {
if (!res.ok) {
consoleLogger.info('Call to Firebase backend failed.');
}
return res.json();
})
.then(function (res) {
var wait = Number(res.next_request_wait_millis);
// Find the next call wait time from the response.
var requestOffset = isNaN(wait)
? DEFAULT_SEND_INTERVAL_MS
: Math.max(DEFAULT_SEND_INTERVAL_MS, wait);
remainingTries = DEFAULT_REMAINING_TRIES;
// Schedule the next process.
processQueue(requestOffset);
})
.catch(function () {
/**
* If the request fails for some reason, add the events that were attempted
* back to the primary queue to retry later.
*/
queue = tslib.__spreadArrays(staged, queue);
remainingTries--;
consoleLogger.info("Tries left: " + remainingTries + ".");
processQueue(DEFAULT_SEND_INTERVAL_MS);
});
}, timeOffset);
}
function addToQueue(evt) {
if (!evt.eventTime || !evt.message) {
throw ERROR_FACTORY.create("invalid cc log" /* INVALID_CC_LOG */);
}
// Add the new event to the queue.
queue = tslib.__spreadArrays(queue, [evt]);
}
/** Log handler for cc service to send the performance logs to the server. */
function transportHandler(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
serializer) {
return function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
var message = serializer.apply(void 0, args);
addToQueue({
message: message,
eventTime: Date.now()
});
};
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-enble camelcase */
var logger;
// This method is not called before initialization.
function sendLog(resource, resourceType) {
if (!logger) {
logger = transportHandler(serializer);
}
logger(resource, resourceType);
}
function logTrace(trace) {
var settingsService = SettingsService.getInstance();
// Do not log if trace is auto generated and instrumentation is disabled.
if (!settingsService.instrumentationEnabled && trace.isAuto) {
return;
}
// Do not log if trace is custom and data collection is disabled.
if (!settingsService.dataCollectionEnabled && !trace.isAuto) {
return;
}
// Do not log if required apis are not available.
if (!Api.getInstance().requiredApisAvailable()) {
return;
}
// Only log the page load auto traces if page is visible.
if (trace.isAuto && getVisibilityState() !== VisibilityState.VISIBLE) {
return;
}
if (!settingsService.loggingEnabled ||
!settingsService.logTraceAfterSampling) {
return;
}
if (isPerfInitialized()) {
sendTraceLog(trace);
}
else {
// Custom traces can be used before the initialization but logging
// should wait until after.
getInitializationPromise().then(function () { return sendTraceLog(trace); }, function () { return sendTraceLog(trace); });
}
}
function sendTraceLog(trace) {
if (getIid()) {
setTimeout(function () { return sendLog(trace, 1 /* Trace */); }, 0);
}
}
function logNetworkRequest(networkRequest) {
var settingsService = SettingsService.getInstance();
// Do not log network requests if instrumentation is disabled.
if (!settingsService.instrumentationEnabled) {
return;
}
// Do not log the js sdk's call to cc service to avoid unnecessary cycle.
if (networkRequest.url === settingsService.logEndPointUrl.split('?')[0]) {
return;
}
if (!settingsService.loggingEnabled ||
!settingsService.logNetworkAfterSampling) {
return;
}
setTimeout(function () { return sendLog(networkRequest, 0 /* NetworkRequest */); }, 0);
}
function serializer(resource, resourceType) {
if (resourceType === 0 /* NetworkRequest */) {
return serializeNetworkRequest(resource);
}
return serializeTrace(resource);
}
function serializeNetworkRequest(networkRequest) {
var networkRequestMetric = {
url: networkRequest.url,
http_method: networkRequest.httpMethod || 0,
http_response_code: 200,
response_payload_bytes: networkRequest.responsePayloadBytes,
client_start_time_us: networkRequest.startTimeUs,
time_to_response_initiated_us: networkRequest.timeToResponseInitiatedUs,
time_to_response_completed_us: networkRequest.timeToResponseCompletedUs
};
var perfMetric = {
application_info: getApplicationInfo(),
network_request_metric: networkRequestMetric
};
return JSON.stringify(perfMetric);
}
function serializeTrace(trace) {
var traceMetric = {
name: trace.name,
is_auto: trace.isAuto,
client_start_time_us: trace.startTimeUs,
duration_us: trace.durationUs
};
if (Object.keys(trace.counters).length !== 0) {
traceMetric.counters = trace.counters;
}
var customAttributes = trace.getAttributes();
if (Object.keys(customAttributes).length !== 0) {
traceMetric.custom_attributes = customAttributes;
}
var perfMetric = {
application_info: getApplicationInfo(),
trace_metric: traceMetric
};
return JSON.stringify(perfMetric);
}
function getApplicationInfo() {
return {
google_app_id: SettingsService.getInstance().getAppId(),
app_instance_id: getIid(),
web_app_info: {
sdk_version: SDK_VERSION,
page_url: Api.getInstance().getUrl(),
service_worker_status: getServiceWorkerStatus(),
visibility_state: getVisibilityState(),
effective_connection_type: getEffectiveConnectionType()
},
application_process_state: 0
};
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var MAX_METRIC_NAME_LENGTH = 100;
var RESERVED_AUTO_PREFIX = '_';
var oobMetrics = [
FIRST_PAINT_COUNTER_NAME,
FIRST_CONTENTFUL_PAINT_COUNTER_NAME,
FIRST_INPUT_DELAY_COUNTER_NAME
];
/**
* Returns true if the metric is custom and does not start with reserved prefix, or if
* the metric is one of out of the box page load trace metrics.
*/
function isValidMetricName(name, traceName) {
if (name.length === 0 || name.length > MAX_METRIC_NAME_LENGTH) {
return false;
}
return ((traceName &&
traceName.startsWith(OOB_TRACE_PAGE_LOAD_PREFIX) &&
oobMetrics.indexOf(name) > -1) ||
!name.startsWith(RESERVED_AUTO_PREFIX));
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var Trace = /** @class */ (function () {
/**
* @param name The name of the trace.
* @param isAuto If the trace is auto-instrumented.
* @param traceMeasureName The name of the measure marker in user timing specification. This field
* is only set when the trace is built for logging when the user directly uses the user timing
* api (performance.mark and performance.measure).
*/
function Trace(name, isAuto, traceMeasureName) {
if (isAuto === void 0) { isAuto = false; }
this.name = name;
this.isAuto = isAuto;
this.state = 1 /* UNINITIALIZED */;
this.customAttributes = {};
this.counters = {};
this.api = Api.getInstance();
this.randomId = Math.floor(Math.random() * 1000000);
if (!this.isAuto) {
this.traceStartMark = TRACE_START_MARK_PREFIX + "-" + this.randomId + "-" + this.name;
this.traceStopMark = TRACE_STOP_MARK_PREFIX + "-" + this.randomId + "-" + this.name;
this.traceMeasure =
traceMeasureName ||
TRACE_MEASURE_PREFIX + "-" + this.randomId + "-" + this.name;
if (traceMeasureName) {
// For the case of direct user timing traces, no start stop will happen. The measure object
// is already available.
this.calculateTraceMetrics();
}
}
}
/**
* Starts a trace. The measurement of the duration starts at this point.
*/
Trace.prototype.start = function () {
if (this.state !== 1 /* UNINITIALIZED */) {
throw ERROR_FACTORY.create("trace started" /* TRACE_STARTED_BEFORE */, {
traceName: this.name
});
}
this.api.mark(this.traceStartMark);
this.state = 2 /* RUNNING */;
};
/**
* Stops the trace. The measurement of the duration of the trace stops at this point and trace
* is logged.
*/
Trace.prototype.stop = function () {
if (this.state !== 2 /* RUNNING */) {
throw ERROR_FACTORY.create("trace stopped" /* TRACE_STOPPED_BEFORE */, {
traceName: this.name
});
}
this.state = 3 /* TERMINATED */;
this.api.mark(this.traceStopMark);
this.api.measure(this.traceMeasure, this.traceStartMark, this.traceStopMark);
this.calculateTraceMetrics();
logTrace(this);
};
/**
* Records a trace with predetermined values. If this method is used a trace is created and logged
* directly. No need to use start and stop methods.
* @param startTime Trace start time since epoch in millisec
* @param duration The duraction of the trace in millisec
* @param options An object which can optionally hold maps of custom metrics and custom attributes
*/
Trace.prototype.record = function (startTime, duration, options) {
this.durationUs = Math.floor(duration * 1000);
this.startTimeUs = Math.floor(startTime * 1000);
if (options && options.attributes) {
this.customAttributes = tslib.__assign({}, options.attributes);
}
if (options && options.metrics) {
for (var _i = 0, _a = Object.keys(options.metrics); _i < _a.length; _i++) {
var metric = _a[_i];
if (!isNaN(Number(options.metrics[metric]))) {
this.counters[metric] = Number(Math.floor(options.metrics[metric]));
}
}
}
logTrace(this);
};
/**
* Increments a custom metric by a certain number or 1 if number not specified. Will create a new
* custom metric if one with the given name does not exist.
* @param counter Name of the custom metric
* @param num Increment by value
*/
Trace.prototype.incrementMetric = function (counter, num) {
if (num === void 0) { num = 1; }
if (this.counters[counter] === undefined) {
this.putMetric(counter, 0);
}
this.counters[counter] += num;
};
/**
* Sets a custom metric to a specified value. Will create a new custom metric if one with the
* given name does not exist.
* @param counter Name of the custom metric
* @param num Set custom metric to this value
*/
Trace.prototype.putMetric = function (counter, num) {
if (isValidMetricName(counter, this.name)) {
this.counters[counter] = num;
}
else {
throw ERROR_FACTORY.create("invalide custom metric name" /* INVALID_CUSTOM_METRIC_NAME */, {
customMetricName: counter
});
}
};
/**
* Returns the value of the custom metric by that name. If a custom metric with that name does
* not exist will return zero.
* @param counter
*/
Trace.prototype.getMetric = function (counter) {
return this.counters[counter] || 0;
};
/**
* Sets a custom attribute of a trace to a certain value.
* @param attr
* @param value
*/
Trace.prototype.putAttribute = function (attr, value) {
var isValidName = isValidCustomAttributeName(attr);
var isValidValue = isValidCustomAttributeValue(value);
if (isValidName && isValidValue) {
this.customAttributes[attr] = value;
return;
}
// Throw appropriate error when the attribute name or value is invalid.
if (!isValidName) {
throw ERROR_FACTORY.create("invalid attribute name" /* INVALID_ATTRIBUTE_NAME */, {
attributeName: attr
});
}
if (!isValidValue) {
throw ERROR_FACTORY.create("invalid attribute value" /* INVALID_ATTRIBUTE_VALUE */, {
attributeValue: value
});
}
};
/**
* Retrieves the value a custom attribute of a trace is set to.
* @param attr
*/
Trace.prototype.getAttribute = function (attr) {
return this.customAttributes[attr];
};
Trace.prototype.removeAttribute = function (attr) {
if (this.customAttributes[attr] === undefined) {
return;
}
delete this.customAttributes[attr];
};
Trace.prototype.getAttributes = function () {
return tslib.__assign({}, this.customAttributes);
};
Trace.prototype.setStartTime = function (startTime) {
this.startTimeUs = startTime;
};
Trace.prototype.setDuration = function (duration) {
this.durationUs = duration;
};
/**
* Calculates and assigns the duration and start time of the trace using the measure performance
* entry.
*/
Trace.prototype.calculateTraceMetrics = function () {
var perfMeasureEntries = this.api.getEntriesByName(this.traceMeasure);
var perfMeasureEntry = perfMeasureEntries && perfMeasureEntries[0];
if (perfMeasureEntry) {
this.durationUs = Math.floor(perfMeasureEntry.duration * 1000);
this.startTimeUs = Math.floor((perfMeasureEntry.startTime + this.api.getTimeOrigin()) * 1000);
}
};
/**
* @param navigationTimings A single element array which contains the navigationTIming object of
* the page load
* @param paintTimings A array which contains paintTiming object of the page load
* @param firstInputDelay First input delay in millisec
*/
Trace.createOobTrace = function (navigationTimings, paintTimings, firstInputDelay) {
var route = Api.getInstance().getUrl();
if (!route) {
return;
}
var trace = new Trace(OOB_TRACE_PAGE_LOAD_PREFIX + route, true);
var timeOriginUs = Math.floor(Api.getInstance().getTimeOrigin() * 1000);
trace.setStartTime(timeOriginUs);
// navigationTimings includes only one element.
if (navigationTimings && navigationTimings[0]) {
trace.setDuration(Math.floor(navigationTimings[0].duration * 1000));
trace.putMetric('domInteractive', Math.floor(navigationTimings[0].domInteractive * 1000));
trace.putMetric('domContentLoadedEventEnd', Math.floor(navigationTimings[0].domContentLoadedEventEnd * 1000));
trace.putMetric('loadEventEnd', Math.floor(navigationTimings[0].loadEventEnd * 1000));
}
var FIRST_PAINT = 'first-paint';
var FIRST_CONTENTFUL_PAINT = 'first-contentful-paint';
if (paintTimings) {
var firstPaint = paintTimings.find(function (paintObject) { return paintObject.name === FIRST_PAINT; });
if (firstPaint && firstPaint.startTime) {
trace.putMetric(FIRST_PAINT_COUNTER_NAME, Math.floor(firstPaint.startTime * 1000));
}
var firstContentfulPaint = paintTimings.find(function (paintObject) { return paintObject.name === FIRST_CONTENTFUL_PAINT; });
if (firstContentfulPaint && firstContentfulPaint.startTime) {
trace.putMetric(FIRST_CONTENTFUL_PAINT_COUNTER_NAME, Math.floor(firstContentfulPaint.startTime * 1000));
}
if (firstInputDelay) {
trace.putMetric(FIRST_INPUT_DELAY_COUNTER_NAME, Math.floor(firstInputDelay * 1000));
}
}
logTrace(trace);
};
Trace.createUserTimingTrace = function (measureName) {
var trace = new Trace(measureName, false, measureName);
logTrace(trace);
};
return Trace;
}());
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
function createNetworkRequestEntry(entry) {
var performanceEntry = entry;
if (!performanceEntry || performanceEntry.responseStart === undefined) {
return;
}
var timeOrigin = Api.getInstance().getTimeOrigin();
var startTimeUs = Math.floor((performanceEntry.startTime + timeOrigin) * 1000);
var timeToResponseInitiatedUs = performanceEntry.responseStart
? Math.floor((performanceEntry.responseStart - performanceEntry.startTime) * 1000)
: undefined;
var timeToResponseCompletedUs = Math.floor((performanceEntry.responseEnd - performanceEntry.startTime) * 1000);
// Remove the query params from logged network request url.
var url = performanceEntry.name && performanceEntry.name.split('?')[0];
var networkRequest = {
url: url,
responsePayloadBytes: performanceEntry.transferSize,
startTimeUs: startTimeUs,
timeToResponseInitiatedUs: timeToResponseInitiatedUs,
timeToResponseCompletedUs: timeToResponseCompletedUs
};
logNetworkRequest(networkRequest);
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var FID_WAIT_TIME_MS = 5000;
function setupOobResources() {
// Do not initialize unless iid is available.
if (!getIid()) {
return;
}
// The load event might not have fired yet, and that means performance navigation timing
// object has a duration of 0. The setup should run after all current tasks in js queue.
setTimeout(function () { return setupOobTraces(); }, 0);
setTimeout(function () { return setupNetworkRequests(); }, 0);
setTimeout(function () { return setupUserTimingTraces(); }, 0);
}
function setupNetworkRequests() {
var api = Api.getInstance();
var resources = api.getEntriesByType('resource');
for (var _i = 0, resources_1 = resources; _i < resources_1.length; _i++) {
var resource = resources_1[_i];
createNetworkRequestEntry(resource);
}
api.setupObserver('resource', createNetworkRequestEntry);
}
function setupOobTraces() {
var api = Api.getInstance();
var navigationTimings = api.getEntriesByType('navigation');
var paintTimings = api.getEntriesByType('paint');
// If First Input Desly polyfill is added to the page, report the fid value.
// https://github.com/GoogleChromeLabs/first-input-delay
if (api.onFirstInputDelay) {
// If the fid call back is not called for certain time, continue without it.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var timeoutId_1 = setTimeout(function () {
Trace.createOobTrace(navigationTimings, paintTimings);
timeoutId_1 = undefined;
}, FID_WAIT_TIME_MS);
api.onFirstInputDelay(function (fid) {
if (timeoutId_1) {
clearTimeout(timeoutId_1);
Trace.createOobTrace(navigationTimings, paintTimings, fid);
}
});
}
else {
Trace.createOobTrace(navigationTimings, paintTimings);
}
}
function setupUserTimingTraces() {
var api = Api.getInstance();
// Run through the measure performance entries collected up to this point.
var measures = api.getEntriesByType('measure');
for (var _i = 0, measures_1 = measures; _i < measures_1.length; _i++) {
var measure = measures_1[_i];
createUserTimingTrace(measure);
}
// Setup an observer to capture the measures from this point on.
api.setupObserver('measure', createUserTimingTrace);
}
function createUserTimingTrace(measure) {
var measureName = measure.name;
// Do not create a trace, if the user timing marks and measures are created by the sdk itself.
if (measureName.substring(0, TRACE_MEASURE_PREFIX.length) ===
TRACE_MEASURE_PREFIX) {
return;
}
Trace.createUserTimingTrace(measureName);
}
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var PerformanceController = /** @class */ (function () {
function PerformanceController(app) {
this.app = app;
if (Api.getInstance().requiredApisAvailable()) {
setupTransportService();
getInitializationPromise().then(setupOobResources, setupOobResources);
}
else {
consoleLogger.info('Firebase Performance cannot start if browser does not support fetch and Promise or cookie is disabled.');
}
}
PerformanceController.prototype.trace = function (name) {
return new Trace(name);
};
Object.defineProperty(PerformanceController.prototype, "instrumentationEnabled", {
get: function () {
return SettingsService.getInstance().instrumentationEnabled;
},
set: function (val) {
SettingsService.getInstance().instrumentationEnabled = val;
},
enumerable: true,
configurable: true
});
Object.defineProperty(PerformanceController.prototype, "dataCollectionEnabled", {
get: function () {
return SettingsService.getInstance().dataCollectionEnabled;
},
set: function (val) {
SettingsService.getInstance().dataCollectionEnabled = val;
},
enumerable: true,
configurable: true
});
return PerformanceController;
}());
/**
* @license
* Copyright 2019 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var DEFAULT_ENTRY_NAME = '[DEFAULT]';
function registerPerformance(instance) {
var factoryMethod = function (app, installations) {
if (app.name !== DEFAULT_ENTRY_NAME) {
throw ERROR_FACTORY.create("FB not default" /* FB_NOT_DEFAULT */);
}
if (typeof window === 'undefined') {
throw ERROR_FACTORY.create("no window" /* NO_WINDOW */);
}
setupApi(window);
SettingsService.getInstance().firebaseAppInstance = app;
SettingsService.getInstance().installationsService = installations;
return new PerformanceController(app);
};
// Register performance with firebase-app.
instance.INTERNAL.registerComponent(new component.Component('performance', function (container) {
/* Dependencies */
// getImmediate for FirebaseApp will always succeed
var app = container.getProvider('app').getImmediate();
// The following call will always succeed because perf has `import '@firebase/installations'`
var installations = container
.getProvider('installations')
.getImmediate();
return factoryMethod(app, installations);
}, "PUBLIC" /* PUBLIC */));
instance.registerVersion(name, version);
}
registerPerformance(firebase);
exports.registerPerformance = registerPerformance;
//# sourceMappingURL=index.cjs.js.map