410 lines
16 KiB
JavaScript
410 lines
16 KiB
JavaScript
|
import { Deferred } from '@firebase/util';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Component for service name T, e.g. `auth`, `auth-internal`
|
||
|
|
*/
|
||
|
|
class Component {
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @param name The public service name, e.g. app, auth, firestore, database
|
||
|
|
* @param instanceFactory Service factory responsible for creating the public interface
|
||
|
|
* @param type whether the service provided by the component is public or private
|
||
|
|
*/
|
||
|
|
constructor(name, instanceFactory, type) {
|
||
|
|
this.name = name;
|
||
|
|
this.instanceFactory = instanceFactory;
|
||
|
|
this.type = type;
|
||
|
|
this.multipleInstances = false;
|
||
|
|
/**
|
||
|
|
* Properties to be added to the service namespace
|
||
|
|
*/
|
||
|
|
this.serviceProps = {};
|
||
|
|
this.instantiationMode = "LAZY" /* LAZY */;
|
||
|
|
this.onInstanceCreated = null;
|
||
|
|
}
|
||
|
|
setInstantiationMode(mode) {
|
||
|
|
this.instantiationMode = mode;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
setMultipleInstances(multipleInstances) {
|
||
|
|
this.multipleInstances = multipleInstances;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
setServiceProps(props) {
|
||
|
|
this.serviceProps = props;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
setInstanceCreatedCallback(callback) {
|
||
|
|
this.onInstanceCreated = callback;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @license
|
||
|
|
* Copyright 2019 Google LLC
|
||
|
|
*
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
const DEFAULT_ENTRY_NAME = '[DEFAULT]';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @license
|
||
|
|
* Copyright 2019 Google LLC
|
||
|
|
*
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Provider for instance for service name T, e.g. 'auth', 'auth-internal'
|
||
|
|
* NameServiceMapping[T] is an alias for the type of the instance
|
||
|
|
*/
|
||
|
|
class Provider {
|
||
|
|
constructor(name, container) {
|
||
|
|
this.name = name;
|
||
|
|
this.container = container;
|
||
|
|
this.component = null;
|
||
|
|
this.instances = new Map();
|
||
|
|
this.instancesDeferred = new Map();
|
||
|
|
this.instancesOptions = new Map();
|
||
|
|
this.onInitCallbacks = new Map();
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @param identifier A provider can provide mulitple instances of a service
|
||
|
|
* if this.component.multipleInstances is true.
|
||
|
|
*/
|
||
|
|
get(identifier) {
|
||
|
|
// if multipleInstances is not supported, use the default name
|
||
|
|
const normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
|
||
|
|
if (!this.instancesDeferred.has(normalizedIdentifier)) {
|
||
|
|
const deferred = new Deferred();
|
||
|
|
this.instancesDeferred.set(normalizedIdentifier, deferred);
|
||
|
|
if (this.isInitialized(normalizedIdentifier) ||
|
||
|
|
this.shouldAutoInitialize()) {
|
||
|
|
// initialize the service if it can be auto-initialized
|
||
|
|
try {
|
||
|
|
const instance = this.getOrInitializeService({
|
||
|
|
instanceIdentifier: normalizedIdentifier
|
||
|
|
});
|
||
|
|
if (instance) {
|
||
|
|
deferred.resolve(instance);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch (e) {
|
||
|
|
// when the instance factory throws an exception during get(), it should not cause
|
||
|
|
// a fatal error. We just return the unresolved promise in this case.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return this.instancesDeferred.get(normalizedIdentifier).promise;
|
||
|
|
}
|
||
|
|
getImmediate(options) {
|
||
|
|
var _a;
|
||
|
|
// if multipleInstances is not supported, use the default name
|
||
|
|
const normalizedIdentifier = this.normalizeInstanceIdentifier(options === null || options === void 0 ? void 0 : options.identifier);
|
||
|
|
const optional = (_a = options === null || options === void 0 ? void 0 : options.optional) !== null && _a !== void 0 ? _a : false;
|
||
|
|
if (this.isInitialized(normalizedIdentifier) ||
|
||
|
|
this.shouldAutoInitialize()) {
|
||
|
|
try {
|
||
|
|
return this.getOrInitializeService({
|
||
|
|
instanceIdentifier: normalizedIdentifier
|
||
|
|
});
|
||
|
|
}
|
||
|
|
catch (e) {
|
||
|
|
if (optional) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
throw e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
// In case a component is not initialized and should/can not be auto-initialized at the moment, return null if the optional flag is set, or throw
|
||
|
|
if (optional) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
throw Error(`Service ${this.name} is not available`);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
getComponent() {
|
||
|
|
return this.component;
|
||
|
|
}
|
||
|
|
setComponent(component) {
|
||
|
|
if (component.name !== this.name) {
|
||
|
|
throw Error(`Mismatching Component ${component.name} for Provider ${this.name}.`);
|
||
|
|
}
|
||
|
|
if (this.component) {
|
||
|
|
throw Error(`Component for ${this.name} has already been provided`);
|
||
|
|
}
|
||
|
|
this.component = component;
|
||
|
|
// return early without attempting to initialize the component if the component requires explicit initialization (calling `Provider.initialize()`)
|
||
|
|
if (!this.shouldAutoInitialize()) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
// if the service is eager, initialize the default instance
|
||
|
|
if (isComponentEager(component)) {
|
||
|
|
try {
|
||
|
|
this.getOrInitializeService({ instanceIdentifier: DEFAULT_ENTRY_NAME });
|
||
|
|
}
|
||
|
|
catch (e) {
|
||
|
|
// when the instance factory for an eager Component throws an exception during the eager
|
||
|
|
// initialization, it should not cause a fatal error.
|
||
|
|
// TODO: Investigate if we need to make it configurable, because some component may want to cause
|
||
|
|
// a fatal error in this case?
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// Create service instances for the pending promises and resolve them
|
||
|
|
// NOTE: if this.multipleInstances is false, only the default instance will be created
|
||
|
|
// and all promises with resolve with it regardless of the identifier.
|
||
|
|
for (const [instanceIdentifier, instanceDeferred] of this.instancesDeferred.entries()) {
|
||
|
|
const normalizedIdentifier = this.normalizeInstanceIdentifier(instanceIdentifier);
|
||
|
|
try {
|
||
|
|
// `getOrInitializeService()` should always return a valid instance since a component is guaranteed. use ! to make typescript happy.
|
||
|
|
const instance = this.getOrInitializeService({
|
||
|
|
instanceIdentifier: normalizedIdentifier
|
||
|
|
});
|
||
|
|
instanceDeferred.resolve(instance);
|
||
|
|
}
|
||
|
|
catch (e) {
|
||
|
|
// when the instance factory throws an exception, it should not cause
|
||
|
|
// a fatal error. We just leave the promise unresolved.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
clearInstance(identifier = DEFAULT_ENTRY_NAME) {
|
||
|
|
this.instancesDeferred.delete(identifier);
|
||
|
|
this.instancesOptions.delete(identifier);
|
||
|
|
this.instances.delete(identifier);
|
||
|
|
}
|
||
|
|
// app.delete() will call this method on every provider to delete the services
|
||
|
|
// TODO: should we mark the provider as deleted?
|
||
|
|
async delete() {
|
||
|
|
const services = Array.from(this.instances.values());
|
||
|
|
await Promise.all([
|
||
|
|
...services
|
||
|
|
.filter(service => 'INTERNAL' in service) // legacy services
|
||
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||
|
|
.map(service => service.INTERNAL.delete()),
|
||
|
|
...services
|
||
|
|
.filter(service => '_delete' in service) // modularized services
|
||
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||
|
|
.map(service => service._delete())
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
isComponentSet() {
|
||
|
|
return this.component != null;
|
||
|
|
}
|
||
|
|
isInitialized(identifier = DEFAULT_ENTRY_NAME) {
|
||
|
|
return this.instances.has(identifier);
|
||
|
|
}
|
||
|
|
getOptions(identifier = DEFAULT_ENTRY_NAME) {
|
||
|
|
return this.instancesOptions.get(identifier) || {};
|
||
|
|
}
|
||
|
|
initialize(opts = {}) {
|
||
|
|
const { options = {} } = opts;
|
||
|
|
const normalizedIdentifier = this.normalizeInstanceIdentifier(opts.instanceIdentifier);
|
||
|
|
if (this.isInitialized(normalizedIdentifier)) {
|
||
|
|
throw Error(`${this.name}(${normalizedIdentifier}) has already been initialized`);
|
||
|
|
}
|
||
|
|
if (!this.isComponentSet()) {
|
||
|
|
throw Error(`Component ${this.name} has not been registered yet`);
|
||
|
|
}
|
||
|
|
const instance = this.getOrInitializeService({
|
||
|
|
instanceIdentifier: normalizedIdentifier,
|
||
|
|
options
|
||
|
|
});
|
||
|
|
// resolve any pending promise waiting for the service instance
|
||
|
|
for (const [instanceIdentifier, instanceDeferred] of this.instancesDeferred.entries()) {
|
||
|
|
const normalizedDeferredIdentifier = this.normalizeInstanceIdentifier(instanceIdentifier);
|
||
|
|
if (normalizedIdentifier === normalizedDeferredIdentifier) {
|
||
|
|
instanceDeferred.resolve(instance);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return instance;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @param callback - a function that will be invoked after the provider has been initialized by calling provider.initialize().
|
||
|
|
* The function is invoked SYNCHRONOUSLY, so it should not execute any longrunning tasks in order to not block the program.
|
||
|
|
*
|
||
|
|
* @param identifier An optional instance identifier
|
||
|
|
* @returns a function to unregister the callback
|
||
|
|
*/
|
||
|
|
onInit(callback, identifier) {
|
||
|
|
var _a;
|
||
|
|
const normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
|
||
|
|
const existingCallbacks = (_a = this.onInitCallbacks.get(normalizedIdentifier)) !== null && _a !== void 0 ? _a : new Set();
|
||
|
|
existingCallbacks.add(callback);
|
||
|
|
this.onInitCallbacks.set(normalizedIdentifier, existingCallbacks);
|
||
|
|
const existingInstance = this.instances.get(normalizedIdentifier);
|
||
|
|
if (existingInstance) {
|
||
|
|
callback(existingInstance, normalizedIdentifier);
|
||
|
|
}
|
||
|
|
return () => {
|
||
|
|
existingCallbacks.delete(callback);
|
||
|
|
};
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Invoke onInit callbacks synchronously
|
||
|
|
* @param instance the service instance`
|
||
|
|
*/
|
||
|
|
invokeOnInitCallbacks(instance, identifier) {
|
||
|
|
const callbacks = this.onInitCallbacks.get(identifier);
|
||
|
|
if (!callbacks) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
for (const callback of callbacks) {
|
||
|
|
try {
|
||
|
|
callback(instance, identifier);
|
||
|
|
}
|
||
|
|
catch (_a) {
|
||
|
|
// ignore errors in the onInit callback
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
getOrInitializeService({ instanceIdentifier, options = {} }) {
|
||
|
|
let instance = this.instances.get(instanceIdentifier);
|
||
|
|
if (!instance && this.component) {
|
||
|
|
instance = this.component.instanceFactory(this.container, {
|
||
|
|
instanceIdentifier: normalizeIdentifierForFactory(instanceIdentifier),
|
||
|
|
options
|
||
|
|
});
|
||
|
|
this.instances.set(instanceIdentifier, instance);
|
||
|
|
this.instancesOptions.set(instanceIdentifier, options);
|
||
|
|
/**
|
||
|
|
* Invoke onInit listeners.
|
||
|
|
* Note this.component.onInstanceCreated is different, which is used by the component creator,
|
||
|
|
* while onInit listeners are registered by consumers of the provider.
|
||
|
|
*/
|
||
|
|
this.invokeOnInitCallbacks(instance, instanceIdentifier);
|
||
|
|
/**
|
||
|
|
* Order is important
|
||
|
|
* onInstanceCreated() should be called after this.instances.set(instanceIdentifier, instance); which
|
||
|
|
* makes `isInitialized()` return true.
|
||
|
|
*/
|
||
|
|
if (this.component.onInstanceCreated) {
|
||
|
|
try {
|
||
|
|
this.component.onInstanceCreated(this.container, instanceIdentifier, instance);
|
||
|
|
}
|
||
|
|
catch (_a) {
|
||
|
|
// ignore errors in the onInstanceCreatedCallback
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return instance || null;
|
||
|
|
}
|
||
|
|
normalizeInstanceIdentifier(identifier = DEFAULT_ENTRY_NAME) {
|
||
|
|
if (this.component) {
|
||
|
|
return this.component.multipleInstances ? identifier : DEFAULT_ENTRY_NAME;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
return identifier; // assume multiple instances are supported before the component is provided.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
shouldAutoInitialize() {
|
||
|
|
return (!!this.component &&
|
||
|
|
this.component.instantiationMode !== "EXPLICIT" /* EXPLICIT */);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// undefined should be passed to the service factory for the default instance
|
||
|
|
function normalizeIdentifierForFactory(identifier) {
|
||
|
|
return identifier === DEFAULT_ENTRY_NAME ? undefined : identifier;
|
||
|
|
}
|
||
|
|
function isComponentEager(component) {
|
||
|
|
return component.instantiationMode === "EAGER" /* EAGER */;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @license
|
||
|
|
* Copyright 2019 Google LLC
|
||
|
|
*
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* ComponentContainer that provides Providers for service name T, e.g. `auth`, `auth-internal`
|
||
|
|
*/
|
||
|
|
class ComponentContainer {
|
||
|
|
constructor(name) {
|
||
|
|
this.name = name;
|
||
|
|
this.providers = new Map();
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @param component Component being added
|
||
|
|
* @param overwrite When a component with the same name has already been registered,
|
||
|
|
* if overwrite is true: overwrite the existing component with the new component and create a new
|
||
|
|
* provider with the new component. It can be useful in tests where you want to use different mocks
|
||
|
|
* for different tests.
|
||
|
|
* if overwrite is false: throw an exception
|
||
|
|
*/
|
||
|
|
addComponent(component) {
|
||
|
|
const provider = this.getProvider(component.name);
|
||
|
|
if (provider.isComponentSet()) {
|
||
|
|
throw new Error(`Component ${component.name} has already been registered with ${this.name}`);
|
||
|
|
}
|
||
|
|
provider.setComponent(component);
|
||
|
|
}
|
||
|
|
addOrOverwriteComponent(component) {
|
||
|
|
const provider = this.getProvider(component.name);
|
||
|
|
if (provider.isComponentSet()) {
|
||
|
|
// delete the existing provider from the container, so we can register the new component
|
||
|
|
this.providers.delete(component.name);
|
||
|
|
}
|
||
|
|
this.addComponent(component);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* getProvider provides a type safe interface where it can only be called with a field name
|
||
|
|
* present in NameServiceMapping interface.
|
||
|
|
*
|
||
|
|
* Firebase SDKs providing services should extend NameServiceMapping interface to register
|
||
|
|
* themselves.
|
||
|
|
*/
|
||
|
|
getProvider(name) {
|
||
|
|
if (this.providers.has(name)) {
|
||
|
|
return this.providers.get(name);
|
||
|
|
}
|
||
|
|
// create a Provider for a service that hasn't registered with Firebase
|
||
|
|
const provider = new Provider(name, this);
|
||
|
|
this.providers.set(name, provider);
|
||
|
|
return provider;
|
||
|
|
}
|
||
|
|
getProviders() {
|
||
|
|
return Array.from(this.providers.values());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export { Component, ComponentContainer, Provider };
|
||
|
|
//# sourceMappingURL=index.esm2017.js.map
|