Skip to content

FIREBASE_STORAGE_EMULATOR_HOST Environment Variable does not work with Admin SDK #874

Description

@tylerfrydenlund

My environment:

  • Operating System version: Mac OS Sonoma 14.0 (23A344)
  • Firebase Admin SDK version: 9.2.0
  • Firebase Product: Storage Emulator

The problem:

When setting the environment variable "FIREBASE_STORAGE_EMULATOR_HOST" to 127.0.0.1:9199 (the default Storage Emulator Port and IP) to use the Firebase Storage Emulator the Admin SDK does not detect this environment variable.

Other Environment variables such as "FIREBASE_DATABASE_EMULATOR_HOST" and "FIRESTORE_EMULATOR_HOST" do work perfectly fine and as expected. They make a connection to emulators on the device.

I have gone as far to test and see if this issue is persistent on other Admin SDK's such as the Node.Js SDK. It is NOT an issue that persists on the SDK for Node.js.

As see here, this was previously an issue filed for the Firebase Admin SDKin the GO Repository for the Admin SDK (see here) and was fixed here (see here) and has been since claimed to be fixed and the logic used in the Node Admin SDK project will be implemented.

The same issue previously on the Go Repo, appears to be present on the Admin Java SDK. Even using the "STORAGE_EMULATOR_HOST" environment variable as it was changed to in the GO repo, does not work.

Documentation on the Firebase Admin SDK docs is also incorrect if this is the case.

Screenshot 2023-11-03 at 5 32 06 PM

Steps to reproduce:

Set either environment variable "STORAGE_EMULATOR_HOST" or "FIREBASE_STORAGE_EMULATOR_HOST" to your Emulator host address and port (the default is 127.0.0.1:9199)

Use the Java Admin SDK to try and make a call like normal.

See it fail and use the production Cloud Storage instance.

Relevant Code:

Environment Variable Set via Intellij Run Configuration

Screenshot 2023-11-03 at 5 30 56 PM
    InputStream input = this.getClass().getResourceAsStream("/service-account.json");
    assert input != null;
    GoogleCredentials googleCredentials = GoogleCredentials.fromStream(input);


    FirebaseOptions options = FirebaseOptions.builder()
            .setCredentials(googleCredentials)
            .setProjectId("project-id")
            .setDatabaseUrl("https://project-id-default-rtdb.firebaseio.com")
            .setStorageBucket("project-id.appspot.com")
            .build();


    FirebaseApp.initializeApp(options);

    InputStream fileInput = this.getClass().getResourceAsStream("/someFile.anyExtension");
    Bucket bucket = StorageClient.getInstance().bucket();
    bucket.create("someFile.anyExtension", fileInput, "application/anyExtension");

Activity

  1. marknesh commented on Jun 5, 2024

    @marknesh

    To use the firebase storage emulator with the admin sdk use STORAGE_EMULATOR_HOST = http://localhost:9199 in your .env file.

  2. JaredEzz commented on Jan 29, 2025

    @JaredEzz

    To use the firebase storage emulator with the admin sdk use STORAGE_EMULATOR_HOST = http://localhost:9199 in your .env file.

    @marknesh this does not work for me. I've set STORAGE_EMULATOR_HOST to http://localhost:9199 and StorageClient.getInstance() still has a hostname of storage.googleapis.com

  3. JaredEzz commented on Jan 29, 2025

    @JaredEzz

    Looks like this PR allows setting the host explicitly #826

  4. JaredEzz commented on Jan 31, 2025

    @JaredEzz
  5. jonathanedey commented on Feb 14, 2025

    @jonathanedey
    Contributor

    Looking at firebase/firebase-tools#3508 and googleapis/java-storage#875, there is currently no storage emulator support for googleapis/java-storage.

    Setting the host through StorageOptions works for directing request to the emulator but the requests are not compatible with the emulator as outlined in firebase/firebase-tools#3508 (comment).

    I suggest raising your request in firebase/firebase-tools#3508.

  6. self-assigned this
    on Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions