feat: Add support for new Firestore types #14800

ehsannas · 2025-05-01T22:14:06Z

Adds support for MinKey, MaxKey, RegexValue, Int32Value, BsonObjectId, BsonTimestamp, and BsonBinaryData.

* Add RegexValue class. * Add to/from proto logic. * Add comparison logic and unit tests. * Add serializer unit test. * Add Codable support, Improve Swift API, Add integration test. * Add more unit tests and integration tests. Also fixed a bug found by unit tests. * Add 6 other types' public API. * rename `.m` to `.mm` to stay consistent. * More unit tests. * WIP: Add the FieldValue methods for building new types. * Add the Swift API and the Obj-C Unit tests. * Add UserDataReader support for new types. * Add missing `extern`. * Add UserDataWriter support for types. Int32 is still missing. * UserDataWriter support for int32. * Update TypeOrder usages with new types. * Add comparison logic for more types. * Add Int32Value comparison logic. * Add SerializerTests for more types. * Use snake case. * Add more unit tests. * Fix bug and add integration test. * Add more integration tests. * Add more integration tests. * Add more integration and unit tests. * Expose public `isEqual` for new types and add tests for it. * Add cross-type order test. * Add Codable support along with integration tests for them. * Remove named parameter for Int32Value and BsonObjectId. * clang-format. * Use `uint8_t` for BsonBinaryData's subtype. * Add `description` for new types. * Reuse type check logic for new types. * Use uint8_t for BsonBinaryData. * Adds tests for FIRFieldValue static c'tors of new types. * Add a few missing tests. * Update tests to check listeners, src=cache, src=server. * Remove FieldValue factory methods.

* Add RegexValue class. * Add to/from proto logic. * Add comparison logic and unit tests. * Add serializer unit test. * Add Codable support, Improve Swift API, Add integration test. * Add more unit tests and integration tests. Also fixed a bug found by unit tests. * Add 6 other types' public API. * rename `.m` to `.mm` to stay consistent. * More unit tests. * WIP: Add the FieldValue methods for building new types. * Add the Swift API and the Obj-C Unit tests. * Add UserDataReader support for new types. * Add missing `extern`. * Add UserDataWriter support for types. Int32 is still missing. * UserDataWriter support for int32. * Update TypeOrder usages with new types. * Add comparison logic for more types. * Add Int32Value comparison logic. * Add SerializerTests for more types. * Use snake case. * Add more unit tests. * Fix bug and add integration test. * Add more integration tests. * Add more integration tests. * Add more integration and unit tests. * Expose public `isEqual` for new types and add tests for it. * Add cross-type order test. * Add Codable support along with integration tests for them. * Remove named parameter for Int32Value and BsonObjectId. * clang-format. * Use `uint8_t` for BsonBinaryData's subtype. * Add `description` for new types. * Reuse type check logic for new types. * Use uint8_t for BsonBinaryData. * Adds tests for FIRFieldValue static c'tors of new types. * Add a few missing tests. * Update tests to check listeners, src=cache, src=server. * Implement indexing for bson types. * Add test for offline write and read from cache. * WIP: Adding more unit tests and integration tests. * Add IndexAllTypesTogether test. * Properly handle empty segments in ref. * Add ComputesLowerBound test. * Add ComputesUpperBound test. * Add IndexValueWriterTest. * Add bson types to index_value_writer_test.cc. * Add CSI tests for bson types. * Check ordered results for queries served from the index. * Add TODO for failing tests. * Address comments. * Improve doc ordering in the new leveldb_local_store_test tests.

gemini-code-assist · 2025-05-01T22:14:10Z

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

google-oss-bot · 2025-05-01T22:15:37Z

	1 Warning
⚠️	New public headers were added, did you remember to add them to the umbrella header?

Generated by 🚫 Danger

ehsannas · 2025-05-12T20:25:54Z

TODO (ehsann): Update Bson* -> BSON*

Firestore/CHANGELOG.md

ncooke3 · 2025-05-12T23:06:00Z

FirebaseFirestoreInternal/FirebaseFirestore/FIRBsonBinaryData.h

FYI, these build failures are expected. I think it's acceptable to merge with the spm-binary workflow failing, and I'll fix right after. Another option is to build a zip off of this branch but that's only worth doing when the PR is final. Either way works–– we just need to update the SPM FST binary to include the new sources.

Sounds good. It seems that the rollout is going to take longer. So, we need to keep the PR open for a bit. I'll ping you before we merge the PR.

ncooke3 · 2025-05-12T23:08:28Z

Firestore/Source/API/FIRBsonBinaryData.mm

+
+#include "Firestore/Source/Public/FirebaseFirestore/FIRBsonBinaryData.h"
+
+NS_ASSUME_NONNULL_BEGIN


nit: remove NS_ASSUME_NONNULL_BEGIN and NS_ASSUME_NONNULL_END from .m or .mm files. These macros only have an effect when used in header files.

ncooke3 · 2025-05-12T23:20:03Z

Firestore/Source/API/FIRBsonBinaryData.mm

+  self = [super init];
+  if (self) {
+    _subtype = subtype;
+    _data = data;


@property(atomic, copy, readonly) NSData *data;

When initializing a property with the copy attribute, the property setter that does the copy doesn't run when accessing the ivar with the _ prefix. So the copy needs to be manual here:

Suggested change

_data = data;

_data = [data copy];

Good article: https://furbo.org/2012/05/04/arc-and-copy/

Since this and the other types are immutable and don't re-set the properties after initialization, the copy isn't doing anything. I'm okay with removing it or leaving it as-is as documentation of the intended ownership strategy.

oh! TIL! keeping the copy. Done

ncooke3 · 2025-05-12T23:22:30Z

Firestore/Source/Public/FirebaseFirestore/FIRBsonBinaryData.h

+ * @param subtype An 8-bit unsigned integer denoting the subtype of the data.
+ * @param data The binary data.
+ */
+- (instancetype)initWithSubtype:(uint8_t)subtype data:(nonnull NSData *)data;


Hmm, I think the warning has to do with this line. The class interface is wrapped with NS_ASSUME_NONNULL_BEGIN which auto assumes every param is nonnull already

Nevermind, the nonnull could be removed as NS_ASSUME_NONNULL_BEGIN is adding it for you.

The issue is that
- (BOOL)isEqual:(id)object; should actually be - (BOOL)isEqual:(nullable id)object;. Added suggestion below.

Got it. Thanks. Done.

ncooke3 · 2025-05-12T23:24:05Z

Firestore/Source/Public/FirebaseFirestore/FIRFieldValue.h

I believe the nonnulls here are duplicates since the class assumes nonnull

ncooke3 · 2025-05-12T23:26:28Z

Firestore/Source/Public/FirebaseFirestore/FIRBsonBinaryData.h

+- (instancetype)initWithSubtype:(uint8_t)subtype data:(nonnull NSData *)data;
+
+/** Returns true if the given object is equal to this, and false otherwise. */
+- (BOOL)isEqual:(id)object;


Suggested change

- (BOOL)isEqual:(id)object;

- (BOOL)isEqual:(nullable id)object;

ncooke3 · 2025-05-19T16:34:58Z

Firestore/Source/Public/FirebaseFirestore/FIRMaxKey.h

+
+/** Returns true if the given object is equal to this, and false otherwise. */
+- (BOOL)isEqual:(nullable id)object;
+


Hide default initializer inherited from NSObject superclass.

Suggested change

- (instancetype)init NS_UNAVAILABLE;

ncooke3 · 2025-05-19T16:35:22Z

Firestore/Source/Public/FirebaseFirestore/FIRMinKey.h

+
+/** Returns true if the given object is equal to this, and false otherwise. */
+- (BOOL)isEqual:(nullable id)object;
+


Hide default initializer inherited from NSObject superclass.

Suggested change

- (instancetype)init NS_UNAVAILABLE;

ncooke3 · 2025-05-19T16:36:31Z

Firestore/Source/Public/FirebaseFirestore/FIRMaxKey.h

+__attribute__((objc_subclassing_restricted))
+@interface FIRMaxKey : NSObject
+
+/** Returns the only instance of MaxKey. */


nit – consistent doc comment for Max and Min keys

Suggested change

/** Returns the only instance of MaxKey. */

/** The shared singleton `MaxKey` instance. */

ncooke3 · 2025-05-19T16:36:55Z

Firestore/Source/Public/FirebaseFirestore/FIRMinKey.h

+__attribute__((objc_subclassing_restricted))
+@interface FIRMinKey : NSObject
+
+/** The only instance of MinKey. */


Suggested change

/** The only instance of MinKey. */

/** The shared singleton `MinKey` instance.

ncooke3 · 2025-05-19T16:39:29Z

Firestore/Source/API/FIRBSONBinaryData.mm

nit: This file looks to use only Objective-C, so the extension can just be .m

ncooke3 · 2025-05-19T16:39:57Z

Firestore/Source/API/FIRMaxKey.mm

nit: This file looks to use only Objective-C, so the extension can just be .m

ncooke3 · 2025-05-19T16:40:02Z

Firestore/Source/API/FIRMinKey.mm

nit: This file looks to use only Objective-C, so the extension can just be .m

ncooke3 · 2025-05-19T16:40:09Z

Firestore/Source/API/FIRRegexValue.mm

nit: This file looks to use only Objective-C, so the extension can just be .m

ncooke3 · 2025-05-19T16:58:49Z

Firestore/Source/Public/FirebaseFirestore/FIRBSONObjectId.h

+/** Returns true if the given object is equal to this, and false otherwise. */
+- (BOOL)isEqual:(nullable id)object;


I'm curious, why was the isEqual API added for all of these new types?

ncooke3 · 2025-05-19T17:26:49Z

FirebaseFirestoreInternal/FirebaseFirestore/FIRBSONBinaryData.h

@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC


A note on these redirect headers– they were added to preserve existing header imports when we reorganized the Firestore modules so that the top-most FirebaseFirestore module was actually a Swift module. Unless these headers need to be imported in C++ clients, we probably could remove them in favor of customers importing them with the module style import of FirebaseFirestore.

ehsannas added 3 commits May 1, 2025 14:20

Remove temporary test code.

2d4fd68

google-oss-bot added api: firestore public-api-change labels May 1, 2025

ehsannas added 3 commits May 1, 2025 15:17

Add CHANGELOG.

a33a387

Merge remote-tracking branch 'origin-public/main' into bson3

8d8078d

Fix the copyright header.

2333e8d

ehsannas self-assigned this May 1, 2025

ehsannas added 3 commits May 1, 2025 15:42

Remove remaining FieldValue factory method usages.

9271067

Fix merge conflicts.

5fd1c1c

Address API proposal feedback.

fcb6ebb

ehsannas requested a review from ncooke3 May 9, 2025 23:43

ncooke3 reviewed May 12, 2025

View reviewed changes

ehsannas added 4 commits May 15, 2025 15:07

Address API feedback (2).

d7deaf8

Rename to BSON* and _actually_ remove the FIRFieldValue APIs.

ba3dada

Address feedback (3).

32f35a6

Address feedback (4).

31a1bd8

ncooke3 reviewed May 19, 2025

View reviewed changes


		#include "Firestore/Source/Public/FirebaseFirestore/FIRBsonBinaryData.h"

		NS_ASSUME_NONNULL_BEGIN

	- (BOOL)isEqual:(id)object;
	- (BOOL)isEqual:(nullable id)object;


		/** Returns true if the given object is equal to this, and false otherwise. */
		- (BOOL)isEqual:(nullable id)object;

	/** Returns the only instance of MaxKey. */
	/** The shared singleton `MaxKey` instance. */

	/** The only instance of MinKey. */
	/** The shared singleton `MinKey` instance.

feat: Add support for new Firestore types #14800

Are you sure you want to change the base?

feat: Add support for new Firestore types #14800

Uh oh!

Conversation

ehsannas commented May 1, 2025

Uh oh!

gemini-code-assist bot commented May 1, 2025

Uh oh!

google-oss-bot commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ehsannas commented May 12, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

google-oss-bot commented May 1, 2025 •

edited

Loading