Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

FR: Support direct lookup of Storage objects by `metadata.id`

Open
#2,939 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
google-cloud, node.js, typescript
Domain
api, backend, cloud

Research direction

Start with the Admin SDK's Bucket class and trace how it creates file references; compare that path with the underlying @google-cloud/storage client mentioned in the issue. Define how a metadata.id lookup would be supported, then verify that the returned object supports getMetadata(), download(), and getSignedUrl() like bucket.file(path).

Written by the indexing model from the issue text.

Description

type: feature request

Title:
FR: Support direct lookup of Storage objects by metadata.id


Is your feature request related to a problem? Please describe.
Currently in the Admin SDK there is no way to fetch a file reference directly by its internal metadata.id. Users must call bucket.getFiles() (optionally with a prefix) and then iterate through every file’s metadata until they find a match. This approach is painfully inefficient for buckets with hundreds or thousands of objects, and leads to high latency and extra egress charges just to resolve a single file by its ID.


Describe the solution you’d like
Add a first-class API—e.g.

const file = await bucket.fileById('ABCD1234-xyz');

under the Admin SDK’s Bucket class (and optionally in the underlying @google-cloud/storage client). Internally it could leverage a server-side lookup or index rather than requiring a full listing scan. The returned object should behave identically to bucket.file(path) so you can immediately call getMetadata(), download(), or getSignedUrl().


Describe alternatives you’ve considered

  • Client-side scan:

    const [files] = await bucket.getFiles();
    for (const f of files) {
      const [m] = await f.getMetadata();
      if (m.id === targetId) return f;
    }
    

Works, but requires listing every object + extra round-trips.

  • Storing custom metadata: You could save your own “id” in metadata.custom and index it in Firestore, but that duplicates what the server already knows, and still needs a separate database lookup.

Additional context

  • This feature is especially important for multi-tenant or large-scale apps where buckets routinely hit thousands of files.
  • Without it, reverse-lookup patterns become a maintenance burden and performance bottleneck.
  • Screenshot of current workaround and templates attached.
Dominant language
TypeScript
Stars
1.7k
Forks
419
Avg merge
4d 20h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from firebase/firebase-admin-node

All issues in firebase/firebase-admin-node

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.