|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright 2025 Google LLC |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | +import { Storage } from '../storage/storage'; |
| 18 | +import { FirebaseExperimentDescription } from '../public_types'; |
| 19 | +import { Provider } from '@firebase/component'; |
| 20 | +import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types'; |
| 21 | +import { Logger } from '@firebase/logger'; |
| 22 | +import { RemoteConfig } from '../remote_config'; |
| 23 | +import { ERROR_FACTORY, ErrorCode } from '../errors'; |
| 24 | + |
| 25 | +export class Experiment { |
| 26 | + private storage: Storage; |
| 27 | + private logger: Logger; |
| 28 | + private analyticsProvider: Provider<FirebaseAnalyticsInternalName>; |
| 29 | + |
| 30 | + constructor(rc: RemoteConfig) { |
| 31 | + this.storage = rc._storage; |
| 32 | + this.logger = rc._logger; |
| 33 | + this.analyticsProvider = rc._analyticsProvider; |
| 34 | + } |
| 35 | + |
| 36 | + async updateActiveExperiments( |
| 37 | + latestExperiments: FirebaseExperimentDescription[] |
| 38 | + ): Promise<void> { |
| 39 | + const currentActiveExperiments = |
| 40 | + (await this.storage.getActiveExperiments()) || new Set<string>(); |
| 41 | + const experimentInfoMap = this.createExperimentInfoMap(latestExperiments); |
| 42 | + this.addActiveExperiments(experimentInfoMap); |
| 43 | + this.removeInactiveExperiments(currentActiveExperiments, experimentInfoMap); |
| 44 | + return this.storage.setActiveExperiments(new Set(experimentInfoMap.keys())); |
| 45 | + } |
| 46 | + |
| 47 | + private createExperimentInfoMap( |
| 48 | + latestExperiments: FirebaseExperimentDescription[] |
| 49 | + ): Map<string, FirebaseExperimentDescription> { |
| 50 | + const experimentInfoMap = new Map<string, FirebaseExperimentDescription>(); |
| 51 | + for (const experiment of latestExperiments) { |
| 52 | + experimentInfoMap.set(experiment.experimentId, experiment); |
| 53 | + } |
| 54 | + return experimentInfoMap; |
| 55 | + } |
| 56 | + |
| 57 | + private addActiveExperiments( |
| 58 | + experimentInfoMap: Map<string, FirebaseExperimentDescription> |
| 59 | + ): void { |
| 60 | + const customProperty: Record<string, string | null> = {}; |
| 61 | + for (const [experimentId, experimentInfo] of experimentInfoMap.entries()) { |
| 62 | + customProperty[`firebase${experimentId}`] = experimentInfo.variantId; |
| 63 | + } |
| 64 | + this.addExperimentToAnalytics(customProperty); |
| 65 | + } |
| 66 | + |
| 67 | + private removeInactiveExperiments( |
| 68 | + currentActiveExperiments: Set<string>, |
| 69 | + experimentInfoMap: Map<string, FirebaseExperimentDescription> |
| 70 | + ): void { |
| 71 | + const customProperty: Record<string, string | null> = {}; |
| 72 | + for (const experimentId of currentActiveExperiments) { |
| 73 | + if (!experimentInfoMap.has(experimentId)) { |
| 74 | + customProperty[`firebase${experimentId}`] = null; |
| 75 | + } |
| 76 | + } |
| 77 | + this.addExperimentToAnalytics(customProperty); |
| 78 | + } |
| 79 | + |
| 80 | + private addExperimentToAnalytics( |
| 81 | + customProperty: Record<string, string | null> |
| 82 | + ): void { |
| 83 | + if (Object.keys(customProperty).length === 0) { |
| 84 | + return; |
| 85 | + } |
| 86 | + try { |
| 87 | + const analytics = this.analyticsProvider.getImmediate({ optional: true }); |
| 88 | + if (analytics) { |
| 89 | + analytics.setUserProperties(customProperty); |
| 90 | + analytics.logEvent(`set_firebase_experiment_state`); |
| 91 | + } else { |
| 92 | + this.logger.warn( |
| 93 | + `Analytics import failed. Verify if you have imported Firebase Analytics in your app code.` |
| 94 | + ); |
| 95 | + } |
| 96 | + } catch (error) { |
| 97 | + throw ERROR_FACTORY.create(ErrorCode.ANALYTICS_UNAVAILABLE, { |
| 98 | + originalErrorMessage: (error as Error)?.message |
| 99 | + }); |
| 100 | + } |
| 101 | + } |
| 102 | +} |
0 commit comments