310 lines
13 KiB
JavaScript
310 lines
13 KiB
JavaScript
|
import { __assign, __values, __read, __awaiter, __generator } from 'tslib';
|
||
|
|
import { Deferred } from '@firebase/util';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Component for service name T, e.g. `auth`, `auth-internal`
|
||
|
|
*/
|
||
|
|
var Component = /** @class */ (function () {
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @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
|
||
|
|
*/
|
||
|
|
function Component(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 */;
|
||
|
|
}
|
||
|
|
Component.prototype.setInstantiationMode = function (mode) {
|
||
|
|
this.instantiationMode = mode;
|
||
|
|
return this;
|
||
|
|
};
|
||
|
|
Component.prototype.setMultipleInstances = function (multipleInstances) {
|
||
|
|
this.multipleInstances = multipleInstances;
|
||
|
|
return this;
|
||
|
|
};
|
||
|
|
Component.prototype.setServiceProps = function (props) {
|
||
|
|
this.serviceProps = props;
|
||
|
|
return this;
|
||
|
|
};
|
||
|
|
return Component;
|
||
|
|
}());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*/
|
||
|
|
var 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
|
||
|
|
*/
|
||
|
|
var Provider = /** @class */ (function () {
|
||
|
|
function Provider(name, container) {
|
||
|
|
this.name = name;
|
||
|
|
this.container = container;
|
||
|
|
this.component = null;
|
||
|
|
this.instances = new Map();
|
||
|
|
this.instancesDeferred = new Map();
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @param identifier A provider can provide mulitple instances of a service
|
||
|
|
* if this.component.multipleInstances is true.
|
||
|
|
*/
|
||
|
|
Provider.prototype.get = function (identifier) {
|
||
|
|
if (identifier === void 0) { identifier = DEFAULT_ENTRY_NAME; }
|
||
|
|
// if multipleInstances is not supported, use the default name
|
||
|
|
var normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
|
||
|
|
if (!this.instancesDeferred.has(normalizedIdentifier)) {
|
||
|
|
var deferred = new Deferred();
|
||
|
|
this.instancesDeferred.set(normalizedIdentifier, deferred);
|
||
|
|
// If the service instance is available, resolve the promise with it immediately
|
||
|
|
try {
|
||
|
|
var instance = this.getOrInitializeService(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;
|
||
|
|
};
|
||
|
|
Provider.prototype.getImmediate = function (options) {
|
||
|
|
var _a = __assign({ identifier: DEFAULT_ENTRY_NAME, optional: false }, options), identifier = _a.identifier, optional = _a.optional;
|
||
|
|
// if multipleInstances is not supported, use the default name
|
||
|
|
var normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
|
||
|
|
try {
|
||
|
|
var instance = this.getOrInitializeService(normalizedIdentifier);
|
||
|
|
if (!instance) {
|
||
|
|
if (optional) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
throw Error("Service " + this.name + " is not available");
|
||
|
|
}
|
||
|
|
return instance;
|
||
|
|
}
|
||
|
|
catch (e) {
|
||
|
|
if (optional) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
throw e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
};
|
||
|
|
Provider.prototype.getComponent = function () {
|
||
|
|
return this.component;
|
||
|
|
};
|
||
|
|
Provider.prototype.setComponent = function (component) {
|
||
|
|
var e_1, _a;
|
||
|
|
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;
|
||
|
|
// if the service is eager, initialize the default instance
|
||
|
|
if (isComponentEager(component)) {
|
||
|
|
try {
|
||
|
|
this.getOrInitializeService(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?
|
||
|
|
}
|
||
|
|
}
|
||
|
|
try {
|
||
|
|
// 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 (var _b = __values(this.instancesDeferred.entries()), _c = _b.next(); !_c.done; _c = _b.next()) {
|
||
|
|
var _d = __read(_c.value, 2), instanceIdentifier = _d[0], instanceDeferred = _d[1];
|
||
|
|
var normalizedIdentifier = this.normalizeInstanceIdentifier(instanceIdentifier);
|
||
|
|
try {
|
||
|
|
// `getOrInitializeService()` should always return a valid instance since a component is guaranteed. use ! to make typescript happy.
|
||
|
|
var instance = this.getOrInitializeService(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.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
||
|
|
finally {
|
||
|
|
try {
|
||
|
|
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
||
|
|
}
|
||
|
|
finally { if (e_1) throw e_1.error; }
|
||
|
|
}
|
||
|
|
};
|
||
|
|
Provider.prototype.clearInstance = function (identifier) {
|
||
|
|
if (identifier === void 0) { identifier = DEFAULT_ENTRY_NAME; }
|
||
|
|
this.instancesDeferred.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?
|
||
|
|
Provider.prototype.delete = function () {
|
||
|
|
return __awaiter(this, void 0, void 0, function () {
|
||
|
|
var services;
|
||
|
|
return __generator(this, function (_a) {
|
||
|
|
switch (_a.label) {
|
||
|
|
case 0:
|
||
|
|
services = Array.from(this.instances.values());
|
||
|
|
return [4 /*yield*/, Promise.all(services
|
||
|
|
.filter(function (service) { return 'INTERNAL' in service; })
|
||
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||
|
|
.map(function (service) { return service.INTERNAL.delete(); }))];
|
||
|
|
case 1:
|
||
|
|
_a.sent();
|
||
|
|
return [2 /*return*/];
|
||
|
|
}
|
||
|
|
});
|
||
|
|
});
|
||
|
|
};
|
||
|
|
Provider.prototype.isComponentSet = function () {
|
||
|
|
return this.component != null;
|
||
|
|
};
|
||
|
|
Provider.prototype.getOrInitializeService = function (identifier) {
|
||
|
|
var instance = this.instances.get(identifier);
|
||
|
|
if (!instance && this.component) {
|
||
|
|
instance = this.component.instanceFactory(this.container, normalizeIdentifierForFactory(identifier));
|
||
|
|
this.instances.set(identifier, instance);
|
||
|
|
}
|
||
|
|
return instance || null;
|
||
|
|
};
|
||
|
|
Provider.prototype.normalizeInstanceIdentifier = function (identifier) {
|
||
|
|
if (this.component) {
|
||
|
|
return this.component.multipleInstances ? identifier : DEFAULT_ENTRY_NAME;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
return identifier; // assume multiple instances are supported before the component is provided.
|
||
|
|
}
|
||
|
|
};
|
||
|
|
return Provider;
|
||
|
|
}());
|
||
|
|
// 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`
|
||
|
|
*/
|
||
|
|
var ComponentContainer = /** @class */ (function () {
|
||
|
|
function ComponentContainer(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
|
||
|
|
*/
|
||
|
|
ComponentContainer.prototype.addComponent = function (component) {
|
||
|
|
var provider = this.getProvider(component.name);
|
||
|
|
if (provider.isComponentSet()) {
|
||
|
|
throw new Error("Component " + component.name + " has already been registered with " + this.name);
|
||
|
|
}
|
||
|
|
provider.setComponent(component);
|
||
|
|
};
|
||
|
|
ComponentContainer.prototype.addOrOverwriteComponent = function (component) {
|
||
|
|
var 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.
|
||
|
|
*/
|
||
|
|
ComponentContainer.prototype.getProvider = function (name) {
|
||
|
|
if (this.providers.has(name)) {
|
||
|
|
return this.providers.get(name);
|
||
|
|
}
|
||
|
|
// create a Provider for a service that hasn't registered with Firebase
|
||
|
|
var provider = new Provider(name, this);
|
||
|
|
this.providers.set(name, provider);
|
||
|
|
return provider;
|
||
|
|
};
|
||
|
|
ComponentContainer.prototype.getProviders = function () {
|
||
|
|
return Array.from(this.providers.values());
|
||
|
|
};
|
||
|
|
return ComponentContainer;
|
||
|
|
}());
|
||
|
|
|
||
|
|
export { Component, ComponentContainer, Provider };
|
||
|
|
//# sourceMappingURL=index.esm.js.map
|