This crate allows easy access to your Google Firestore DB via service account or OAuth impersonated Google Firebase Auth credentials.
Features: * Subset of the Firestore v1 API * Optionally handles authentication and token refreshing for you * Support for the downloadable Google service account json file from Google Clound console. (See https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-cpp)
Usecases: * Strictly typed document read/write/query access * Cloud functions (Google Compute, AWS Lambda) access to Firestore
Limitations: * Listening to document / collection changes is not yet possible
rustls-tls: Use rustls instead of native-tls (openssl on Linux). If you want to compile this crate with MUSL, this is what you want. Don't forget to disable the default features with --no-default-features.
rocket_support: Rocket is a web framework.
This features enables rocket integration and adds a Request Guard.
Only Firestore Auth authorized requests can pass this guard.
This feature requires rust nightly, because Rocket itself requires nightly.
This crate operates on DTOs (Data transfer objects) for type-safe operations on your Firestore DB.
```rust use firestoredband_auth::{Credentials, ServiceSession, documents, errors::Result}; use serde::{Serialize,Deserialize};
#[derive(Serialize, Deserialize)]
struct DemoDTO {
astring: String,
anint: u32,
anotherint: u32,
}
#[derive(Serialize, Deserialize)]
struct DemoPartialDTO {
#[serde(skipserializingif = "Option::isnone")]
astring: Option
/// Write the given object with the document id "servicetest" to the "tests" collection. /// You do not need to provide a document id (use "None" instead) and let Firestore generate one for you. /// /// In either way a document is created or updated (overwritten). /// /// The write method will return document metadata (including a possible generated document id) fn write(session: &ServiceSession) -> Result<()> { let obj = DemoDTO { astring: "abcd".toowned(), anint: 14, anotherint: 10 }; let result = documents::write(session, "tests", Some("servicetest"), &obj, documents::WriteOptions::default())?; println!("id: {}, created: {}, updated: {}", result.documentid, result.createtime.unwrap(), result.update_time.unwrap()); Ok(()) }
/// Only write some fields and do not overwrite the entire document. /// Either via Option<> or by not having the fields in the structure, see DemoPartialDTO. fn writepartial(session: &ServiceSession) -> Result<()> { let obj = DemoPartialDTO { astring: None, anint: 16 }; let result = documents::write(session, "tests", Some("servicetest"), &obj, documents::WriteOptions{merge:true})?; println!("id: {}, created: {}, updated: {}", result.documentid, result.createtime.unwrap(), result.update_time.unwrap()); Ok(()) } ```
Read the document with the id "service_test" from the Firestore "tests" collection:
rust
let obj : DemoDTO = documents::read(&session, "tests", "service_test")?;
For listing all documents of the "tests" collection you want to use the List struct which implements the Iterator trait.
It will hide the complexity of the paging API and fetches new documents when necessary:
```rust use firestoredband_auth::{documents};
let values: documents::List
Note: The resulting list or list cursor is a snapshot view with a limited lifetime. You cannot keep the iterator for long or expect new documents to appear in an ongoing iteration.
For quering the database you would use the query method.
In the following example the collection "tests" is queried for document(s) with the "id" field equal to "Sam Weiss".
```rust use firestoredband_auth::{documents, dto};
let values = documents::query(&session, "tests", "Sam Weiss".into(), dto::FieldOperator::EQUAL, "id")?; for metadata in values { println!("id: {}, created: {}, updated: {}", metadata.name.asref().unwrap(), metadata.createtime.asref().unwrap(), metadata.updatetime.asref().unwrap()); // Fetch the actual document // The data is wrapped in a Result<> because fetching new data could have failed let doc : DemoDTO = documents::readbyname(&session, metadata.name.asref().unwrap())?; println!("{:?}", doc); } ```
Did you notice the into on "Sam Weiss".into()?
Firestore stores document fields strongly typed.
The query value can be a string, an integer, a floating point number and potentially even an array or object (not tested).
Note: The query method returns a vector, because a query potentially returns multiple matching documents.
The returned Result will have a FirebaseError set in any error case.
This custom error type wraps all possible errors (IO, Reqwest, JWT errors etc)
and Google REST API errors. If you want to specifically check for an API error,
you could do so:
```rust use firestoredband_auth::{documents, errors::FirebaseError};
let r = documents::delete(&session, "tests/nonexisting", true); if let Err(e) = r.err() { if let FirebaseError::APIError(code, message, context) = e { asserteq!(code, 404); assert!(message.contains("No document to update")); asserteq!(context, "tests/nonexisting"); } } ```
The code is numeric, the message is what the Google server returned as message. The context string depends on the called method. It may be the collection or document id or any other context information.
"private_key_id": ...."api_key" : "YOUR_API_KEY" and replace YOURAPIKEY with your Web API key, to be found in the Google Firebase console in "Project Overview -> Settings - > General".```rust use firestoredband_auth::{Credentials, ServiceSession};
/// Create credentials object. You may as well do that programmatically. let cred = Credentials::from_file("firebase-service-account.json") .expect("Read credentials file");
/// To use any of the Firestore methods, you need a session first. You either want /// an impersonated session bound to a Firebase Auth user or a service account session. let session = ServiceSession::new(&cred) .expect("Create a service account session"); ```
You can create a user session in various ways. If you just have the firebase Auth user_id, you would follow these steps:
```rust use firestoredband_auth::{Credentials, sessions};
/// Create credentials object. You may as well do that programmatically. let cred = Credentials::from_file("firebase-service-account.json") .expect("Read credentials file");
/// To use any of the Firestore methods, you need a session first. /// Create an impersonated session bound to a Firebase Auth user via your service account credentials. let session = UserSession::byuserid(&cred, "theuserid") .expect("Create a user session"); ```
If you already have a valid refresh token and want to generate an access token (and a session object), you do this instead:
rust
let refresh_token = "fkjandsfbajsbfd;asbfdaosa.asduabsifdabsda,fd,a,sdbasfadfasfas.dasdasbfadusbflansf";
let session = UserSession::by_refresh_token(&cred, &refresh_token)?;
Another way of retrieving a session object is by providing a valid access token like so:
rust
let access_token = "fkjandsfbajsbfd;asbfdaosa.asduabsifdabsda,fd,a,sdbasfadfasfas.dasdasbfadusbflansf";
let session = UserSession::by_access_token(&cred, &access_token)?;
The by_access_token method will fail if the token is not valid anymore.
Please note that a session created this way is not able to automatically refresh its access token.
(There is no refresh_token associated with it.)
The usual start up procedure includes three IO operations:
Avoid those by embedding the credentials and public key files into your application.
First download the 2 public key files:
securetoken.jwksservice-account.jwksCreate a Credentials object like so:
rust
use firestore_db_and_auth::Credentials;
let c = Credentials::new(include_str!("firebase-service-account.json"),
&[include_str!("securetoken.jwks"), include_str!("service-account.jwks")])?;
cargo +nightly doc --features external_doc,rocket_supportTo perform a full integration test (cargo test), you need a valid "firebase-service-account.json" file.
The tests expect a Firebase user with the ID given in tests/test_user_id.txt to exist.
More Information
Maintenance status: In Development
This library does not have the ambition to mirror the http/gRPC API 1:1. There are auto-generated libraries for this purpose.
This crate uses reqwest as http client. reqwest itself will soon have picked up full support for Rusts async+await features.
All that is left to do here then is to depend on Rust 1.39 and add an "async fn" variant that calls and awaits reqwest for each existing method.