Add Emulator Overlay #8977
Open
Add Emulator Overlay #8977
Conversation
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
…m/firebase/firebase-js-sdk into mtewani/fix-auth-redirects-studio
🦋 Changeset detectedLatest commit: 1c4c6ee The changes in this PR will be included in the next version bump. This PR includes changesets to release 30 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
maneesht
requested review from
sam-gc,
pashanka,
mansisampat and
NhienLam
as code owners
hsubox76
reviewed
May 5, 2025
hsubox76
reviewed
May 5, 2025
hsubox76
reviewed
May 5, 2025
hsubox76
approved these changes
May 5, 2025
avolkovi
requested changes
May 6, 2025
avolkovi
reviewed
May 6, 2025
| emitEmulatorWarning(); | ||
| } | ||
|
|
||
| // Workaround to get cookies in Firebase Studio | ||
| if (isCloudWorkstation(host)) { | ||
| void pingServer(`${protocol}//${host}${portStr}`); | ||
| updateEmulatorBanner('Auth', true); |
There was a problem hiding this comment.
should we honor the disableWarnings flag for this banner? I think the way you have it now there's no way for customer to override it
| @@ -393,6 +394,7 @@ export function connectDatabaseEmulator( | |||
| // Workaround to get cookies in Firebase Studio | |||
| if (isCloudWorkstation(host)) { | |||
| void pingServer(host); | |||
| updateEmulatorBanner('Database', true); | |||
There was a problem hiding this comment.
ditto here, we need a way to override this
packages/auth/src/api/index.ts
Outdated
| @@ -198,7 +199,9 @@ export async function _performFetchWithErrorHandling<V>( | |||
| customErrorMap: Partial<ServerErrorMap<ServerError>>, | |||
| fetchFn: () => Promise<Response> | |||
| ): Promise<V> { | |||
| (auth as AuthInternal)._canInitEmulator = false; | |||
| const authInternal = auth as AuthInternal; | |||
| updateEmulatorBanner('Auth', authInternal.emulatorConfig !== null); | |||
There was a problem hiding this comment.
do we need to update this on every call? or just when we do the ping?
There was a problem hiding this comment.
What about when the user connects to prod?
| if (document.readyState === 'loading') { | ||
| window.addEventListener('DOMContentLoaded', setupDom); | ||
| } else { | ||
| setupDom(); |
There was a problem hiding this comment.
will this trigger every time i make an API request? can we cache it somehow?
There was a problem hiding this comment.
Not anymore. I refactored to only call updateEmulatorBanner upon get[Product] and connect[Product].
Here are the flows I tested:
getProduct(); // update banner to prod
connectEmulator(); // update banner to emulator
getProduct(); // No Op because previously the product was connected to the emulator, and you can't un-connect to the emulator.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds an overlay to the bottom of the user's screen:
If the user is connected to the emulator, the image will always be shown. If the user is not connected to the emulator, but is on a cloud workstation, then the user will be shown that they are connected to prod.