firebase-admin 0.1.1

An open-source Firebase Admin SDK for Rust, starting with Authentication
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Contributing to firebase-admin-rs

Thanks for your interest in contributing! This project aims to be a
well-documented, well-tested, community-maintained Firebase Admin SDK for
Rust — contributions of all sizes are welcome, from typo fixes to new
features.

## Getting started

1. Fork the repository and clone your fork.
2. Install the stable Rust toolchain (see `rust-toolchain.toml`).
3. Run the test suite: `cargo test --all-features`.
4. For changes touching user management or session cookies, install the
   [Firebase CLI](https://firebase.google.com/docs/cli) and run the local
   emulator: `firebase emulators:start --only auth`, then run the
   emulator-backed integration tests with `FIREBASE_AUTH_EMULATOR_HOST` set
   (see `tests/emulator_*.rs`).

## Project structure

See [`ARCHITECTURE.md`](ARCHITECTURE.md) for the module layout and the
reasoning behind it — in particular, why `src/core/` exists separately from
`src/auth/` even though there is currently only one service.

## Before opening a pull request

- Run `cargo fmt`.
- Run `cargo clippy --all-targets --all-features -- -D warnings` and fix any
  warnings.
- Run `cargo test --all-features` and `cargo test --doc --all-features`.
- Add or update tests for any behavior change:
  - Token-verification logic should include negative-case coverage (expired,
    wrong audience, tampered signature, etc.) — see
    `src/auth/id_token/verifier.rs` for the existing pattern.
  - New Identity Toolkit REST calls (in `src/auth/users/operations.rs` or
    similar) should be tested against a mocked HTTP server using `wiremock`,
    not the live emulator — see the `#[cfg(test)]` module in
    `src/auth/users/operations.rs` for the existing pattern (success paths,
    empty-result paths, and structured-error paths with `error_code`).
  - Reserve `tests/emulator_*.rs` (the real Firebase Auth Emulator) for
    end-to-end round-trip coverage, not for testing individual error branches
    — those are cheaper and faster to cover with `wiremock`.
- Add a doc comment (`///`) to any new public item; `cargo doc --all-features`
  should build without warnings.

## Commit messages

This project uses [Conventional Commits](https://www.conventionalcommits.org/)
(`feat:`, `fix:`, `docs:`, `chore:`, etc.) so that
[release-plz](https://release-plz.dev/) can generate accurate changelogs and
version bumps automatically. Please follow this convention in your PR title
and/or commits.

## Branching model

This project uses trunk-based development: `main` is always releasable, and
changes land via short-lived `feat/*`/`fix/*` branches merged through a
reviewed, CI-gated pull request. There is no long-lived `dev` branch.

## Reporting bugs / requesting features

Please use the issue templates under `.github/ISSUE_TEMPLATE/`. For security
vulnerabilities, see [`SECURITY.md`](SECURITY.md) instead of opening a public
issue.

## Code of Conduct

This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md).