App Hosting JS SDK autoinit #8483
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@firebase/util': minor | ||
| 'firebase': minor | ||
| --- | ||
|
|
||
| Add support for the `FIREBASE_WEBAPP_CONFIG` environment variable at install time. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 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 { writeFile, readFile } = require('node:fs/promises'); | ||
| const { pathToFileURL } = require('node:url'); | ||
| const { isAbsolute, join } = require('node:path'); | ||
|
|
||
| async function getPartialConfig() { | ||
| if (!process.env.FIREBASE_WEBAPP_CONFIG) { | ||
| return undefined; | ||
| } | ||
|
|
||
| // Like FIREBASE_CONFIG (admin autoinit) FIREBASE_WEBAPP_CONFIG can be | ||
| // either a JSON representation of FirebaseOptions or the path to a filename | ||
| if (process.env.FIREBASE_WEBAPP_CONFIG.startsWith('{"')) { | ||
jamesdaniels marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| try { | ||
| return JSON.parse(process.env.FIREBASE_WEBAPP_CONFIG); | ||
| } catch (e) { | ||
| console.warn( | ||
| 'FIREBASE_WEBAPP_CONFIG could not be parsed, ignoring.\n', | ||
| e | ||
| ); | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| const fileName = process.env.FIREBASE_WEBAPP_CONFIG; | ||
| const fileURL = pathToFileURL( | ||
| isAbsolute(fileName) ? fileName : join(process.cwd(), fileName) | ||
| ); | ||
|
|
||
| try { | ||
| const fileContents = await readFile(fileURL, 'utf-8'); | ||
| return JSON.parse(fileContents); | ||
| } catch (e) { | ||
| console.warn( | ||
| `Contents of "${fileName}" could not be parsed, ignoring FIREBASE_WEBAPP_CONFIG.\n`, | ||
| e | ||
| ); | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| async function getFullConfig(partialConfig) { | ||
| if (!partialConfig) { | ||
| return undefined; | ||
| } | ||
| // In Firebase App Hosting the config provided to the environment variable is up-to-date and | ||
| // "complete" we should not reach out to the webConfig endpoint to freshen it | ||
| if (process.env.X_GOOGLE_TARGET_PLATFORM === 'fah') { | ||
| return partialConfig; | ||
| } | ||
| const projectId = partialConfig.projectId || '-'; | ||
| // If the projectId starts with demo- this is an demo project from the firebase emulators | ||
| // treat the config as whole | ||
| if (projectId.startsWith('demo-')) { | ||
| return partialConfig; | ||
| } | ||
| const appId = partialConfig.appId; | ||
| const apiKey = partialConfig.apiKey; | ||
| if (!appId || !apiKey) { | ||
| console.warn( | ||
| `Unable to fetch Firebase config, appId and apiKey are required, ignoring FIREBASE_WEBAPP_CONFIG.` | ||
| ); | ||
| return undefined; | ||
| } | ||
|
|
||
| const url = `https://firebase.googleapis.com/v1alpha/projects/${projectId}/apps/${appId}/webConfig`; | ||
|
|
||
| try { | ||
| const response = await fetch(url, { | ||
| headers: { 'x-goog-api-key': apiKey } | ||
| }); | ||
| if (!response.ok) { | ||
| console.warn( | ||
| `Unable to fetch Firebase config, ignoring FIREBASE_WEBAPP_CONFIG.` | ||
| ); | ||
| console.warn( | ||
| `${url} returned ${response.statusText} (${response.status})` | ||
| ); | ||
| try { | ||
| console.warn((await response.json()).error.message); | ||
| } catch (e) {} | ||
| return undefined; | ||
| } | ||
| const json = await response.json(); | ||
| return { ...json, apiKey }; | ||
| } catch (e) { | ||
| console.warn( | ||
| `Unable to fetch Firebase config, ignoring FIREBASE_WEBAPP_CONFIG.\n`, | ||
| e | ||
| ); | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function handleUnexpectedError(e) { | ||
| console.warn( | ||
| 'Unexpected error encountered in @firebase/util postinstall script, ignoring FIREBASE_WEBAPP_CONFIG.' | ||
| ); | ||
| console.warn(e); | ||
| process.exit(0); | ||
| } | ||
|
|
||
| getPartialConfig() | ||
| .catch(handleUnexpectedError) | ||
| .then(getFullConfig) | ||
| .catch(handleUnexpectedError) | ||
| .then(async config => { | ||
jamesdaniels marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const emulatorHosts = { | ||
|
There was a problem hiding this comment. Clarification: does this execute if partialConfig is undefined (and subsequently fullConfig)? There was a problem hiding this comment. It does, the idea is to wipe out any hardcoded config from prior runs. The Firebase CLI will trip this script during either a Hosting deploy or emulator start. |
||
| firestore: process.env.FIRESTORE_EMULATOR_HOST, | ||
| database: process.env.FIREBASE_DATABASE_EMULATOR_HOST, | ||
| storage: process.env.FIREBASE_STORAGE_EMULATOR_HOST, | ||
| auth: process.env.FIREBASE_AUTH_EMULATOR_HOST | ||
| }; | ||
|
|
||
| const defaults = config && { config, emulatorHosts }; | ||
|
|
||
| await Promise.all([ | ||
| writeFile( | ||
| join(__dirname, 'dist', 'autoinit_env.js'), | ||
| `'use strict'; | ||
| Object.defineProperty(exports, '__esModule', { value: true }); | ||
| exports.postinstallDefaults = ${JSON.stringify(defaults)};` | ||
| ), | ||
| writeFile( | ||
| join(__dirname, 'dist', 'autoinit_env.mjs'), | ||
| `const postinstallDefaults = ${JSON.stringify(defaults)}; | ||
| export { postinstallDefaults };` | ||
| ) | ||
| ]); | ||
|
|
||
| process.exit(0); | ||
| }) | ||
| .catch(handleUnexpectedError); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 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. | ||
| */ | ||
|
|
||
| import type { FirebaseDefaults } from './defaults'; | ||
|
|
||
| // This value is retrieved and hardcoded by the NPM postinstall script | ||
| export const postinstallDefaults: FirebaseDefaults | undefined = undefined; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.