Intent

This PR aims to implement a feature found in Firestore implementations for other languages, such as Go and Typescript.

These "run transaction" functions allow the user to pass in a closure that performs reads and/or writes and attempts to commit a transaction with a limited number of retries. Many of the details are not exposed to the user.

I've introduced an example that uses run_transaction to increment a counter concurrently using FuturesOrdered.

Potential Problems

• ~I've introduced the backoff crate into the Cargo.toml. If this is not desirable, we can rework the retry mechanism such that it does not bring in a dependency.~
• Users' closures must be wrapped in Box::pin presently. Is it possible to push this into the run_transaction function itself?
• ~I've placed the implementation directly into FirestoreDb. This seems okay, but is it the correct place for it?~
• run_transaction will always use ReadWrite for the consistency selector. Shouldn't we handle ReadOnly transactions as well?
• We should expose some options about the transaction behavior to the user, as the SDKs in other languages do. This includes retry configuration, a manual specification of the transaction read time, and whether or not the transaction should be read-only (which perhaps solves the previous potential issue)
• ~All reads must take place before any writes in the transaction, but I haven't tested to verify that we gracefully handle that error.~

Intent

This feature aims to add functionality for optional FirestoreTimestamp fields.

Using #[serde(with = "firestore::serialize_as_timestamp")] on an Option<DateTime<Utc>> field resulted in build errors within the Serialize/Deserialize derive macro. Due to this, resorting to using Option<DateTime<Utc>> without the relevant serializer resulted in firestore saving the Timestamp-like value as a string.

To avoid further complicating data consistency issues, it seemed as though creating an additional serializer for optional timestamps was appropriate.

Implementation

• Added functionality and relevant serializer for Option<FirestoreTimestamp>.
• Separated serialize_as_timestamp from newly created serialize_as_optional_timestamp to preserve original functionality.
• Updated serialize_none to utilize ValueType::NullValue.

Questions

• Is there potentially a way to combine both serializers into one to be able to handle Option<T> and T?

If one of the results deserialized by batch_stream_get_objects_by_ids produces a deserialization error it is only logged but the Result of the function as a whole indicates success anyways.

It's probably debatable if this an issue or not but it caught me by surprise since other functions return the deserialization error in their result.

For developing against a local firestore emulator I want to overwrite the Google API URL for the firestore client.

I tried this in my fork here: https://github.com/abdolence/firestore-rs/compare/master...xifel:firestore-rs:google_url_env and works for me. However I'm very new to Rust and not sure if this is the best way to go about it since it's adding lazy_static as a new dependency.

The name of the environment variable is also used by the official Firestore Admin SDK https://firebase.google.com/docs/emulator-suite/connect_firestore#web-version-9 and can be used the same way.

If you would like to merge that change as is or with modifications I would gladly create the pull request. Otherwise I just would like to propose the feature.

https://firebase.google.com/docs/firestore/pricing I want to use the start_at to get list data because of the pricing problem.

https://github.com/abdolence/firestore-rs/blob/652e6cce7cdd8e0dd310112c4ffedae423b2904a/src/db/query_models.rs#L55 And I found this code! I guess I can use start_at if it's implemented. So now, I have two questions.

1. Is it possible to use start_at by just passing the Cursor in that field(start_at)?
2. Will you implement this feature?

For example,

let items = firestore_db
        .query_obj::<Item>(params)
        .await

query_obj returns Result<Vec<Item>,FirestoreError> in "all or nothing" way. That is, if any of Items raises decode error, it returns Err(FirestoreError).

I think it would be better for library users to have more control over error handling(e.g. ignore or recover from error).

Therefore, I want Vec<Result<T,FirestoreError>> from querying methods instead of Result<Vec<T>,FirestoreError>.

In addition, I am happy if I can get raw FirestoreValue from querying methods and manually decode items one by one. Is there any method or api like that?

let raw_values: Vec<FirestoreValue> = firestore_db.query_obj::<???>(params).await;
let it : Vec<Result<T,Error>> =  raw_values.iter().map(|value| /* try decode raw value to `T` here */ )

I was just exploring Firestore with Rust and I found your awesome library!

I'm trying to "listen" to changes to a Firestore Collection, is that possible with this library?

I see that you have listen_doc_changes (which I assume is for listening to a single document?). Could you share an example of how to use it?

Trying to use firebase in a project and get following error:

error[E0308]: mismatched types
    --> /home/shinmen/.cargo/registry/src/github.com-1ecc6299db9ec823/firestore-0.11.0/src/db/transaction.rs:113:62
     |
113  |         transaction_span.record("/firestore/transaction_id", hex_trans_id);
     |                          ------                              ^^^^^^^^^^^^
     |                          |                                   |
     |                          |                                   expected reference, found struct `std::string::String`
     |                          |                                   help: consider borrowing here: `&hex_trans_id`
     |                          arguments to this function are incorrect
     |
     = note: expected reference `&_`
                   found struct `std::string::String`
note: associated function defined here
    --> /home/shinmen/.cargo/registry/src/github.com-1ecc6299db9ec823/tracing-0.1.35/src/span.rs:1194:12
     |
1194 |     pub fn record<Q: ?Sized, V>(&self, field: &Q, value: &V) -> &Self
     |            ^^^^^^

error[E0277]: the size for values of type `str` cannot be known at compilation time
    --> /home/shinmen/.cargo/registry/src/github.com-1ecc6299db9ec823/firestore-0.11.0/src/db/transaction.rs:153:35
     |
153  |             self.transaction_span.record(
     |                                   ^^^^^^ doesn't have a size known at compile-time
     |
     = help: the trait `Sized` is not implemented for `str`
note: required by a bound in `tracing::Span::record`
    --> /home/shinmen/.cargo/registry/src/github.com-1ecc6299db9ec823/tracing-0.1.35/src/span.rs:1194:30
     |
1194 |     pub fn record<Q: ?Sized, V>(&self, field: &Q, value: &V) -> &Self
     |                              ^ required by this bound in `tracing::Span::record`

Some errors have detailed explanations: E0277, E0308.
For more information about an error, try `rustc --explain E0277`.
error: could not compile `firestore` due to 2 previous errors

Hi, how can I find Firebase token using gcloud auth login? Error connecting to Firestore: SystemError(FirestoreSystemError { public: FirestoreErrorPublicGenericDetails { code: "TokenSource" }, message: "GCloud system error: token source error: not found token source" })

Got the following error after upgrading to 0.10.1. Last good version is 0.9.2. I cannot compile from source as well.

error[E0759]: `self` has an anonymous lifetime `'_` but it needs to satisfy a `'static` lifetime requirement
  --> /Users/__/.cargo/registry/src/github.com-1ecc6299db9ec823/firestore-0.10.1/src/db/list_doc.rs:49:9
   |
49 |         &self,
   |         ^^^^^ this data with an anonymous lifetime `'_`...
...
84 |         Ok(stream)
   |         ---------- ...is used and required to live as long as `'static` here
   |
note: `'static` lifetime requirement introduced by the return type
  --> /Users/__/.cargo/registry/src/github.com-1ecc6299db9ec823/firestore-0.10.1/src/db/list_doc.rs:51:10
   |
51 |     ) -> FirestoreResult<BoxStream<Document>> {
   |          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ requirement introduced by this return type
...
84 |         Ok(stream)
   |         ---------- because of this returned expression

error[E0759]: `self` has an anonymous lifetime `'_` but it needs to satisfy a `'static` lifetime requirement
   --> /Users/__/.cargo/registry/src/github.com-1ecc6299db9ec823/firestore-0.10.1/src/db/transaction.rs:176:9
    |
176 |         &self,
    |         ^^^^^ this data with an anonymous lifetime `'_`...
...
179 |         FirestoreTransaction::new(self, options).await
    |         ---------------------------------------------- ...is used and required to live as long as `'static` here
    ```

How can i find token? I try create a document but it return error "error": "13 INTERNAL: Firestore system/internal error: GCloud system error: token source error: not found token source"

Is it possible lo in with GOOGLE_APPLICATION_CREDENTIALS admins dk .json??

I want to insert a document a with the path "parent_1/customers/new_document_id/", but using db.parent_path method, I only seem to be able to insert it with this path "parent_1/parent_1/customers/new_document_id/".

Here's how I'm inserting it

let parent_path = db.parent_path("parent_1", "parent_1").unwrap();
let result = db
  .fluent()
  .insert()
  .into("customers")
  .document_id(&customer.email)
  .parent(&parent_path)
  .object(&customer)
  .execute()
  .await
  .unwrap();

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• [ ] Check this box to trigger a request for Renovate to run again on this repository