Skip to content

Add expected count to target #4574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 27, 2023
Merged

Add expected count to target #4574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ff97c00
upload initial code
milaGGL Jan 19, 2023
f876824
format
milaGGL Jan 19, 2023
d7806f3
add expectedCount assertion to spec test
milaGGL Jan 19, 2023
ae7edd0
port spec tests
milaGGL Jan 20, 2023
89fb871
Merge branch 'mila/BloomFilter' into mila/BloomFilter-add-expectedCou…
milaGGL Jan 23, 2023
ef1a6e9
resolve comments
milaGGL Jan 26, 2023
e9bace3
Merge branch 'mila/BloomFilter' into mila/BloomFilter-add-expectedCou…
milaGGL Jan 26, 2023
a241d07
remove createtime
milaGGL Jan 27, 2023
c26b4e5
add todo comment
milaGGL Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion firebase-firestore/src/main/java/com/google/firebase/firestore/core/SyncEngine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,14 @@ public int listen(Query query) {
hardAssert(!queryViewsByQuery.containsKey(query), "We already listen to query: %s", query);

TargetData targetData = localStore.allocateTarget(query.toTarget());
remoteStore.listen(targetData);

ViewSnapshot viewSnapshot =
initializeViewAndComputeSnapshot(
query, targetData.getTargetId(), targetData.getResumeToken());
syncEngineListener.onViewSnapshots(Collections.singletonList(viewSnapshot));

remoteStore.listen(targetData);

return targetData.getTargetId();
}

Expand Down
3 changes: 2 additions & 1 deletion firebase-firestore/src/main/java/com/google/firebase/firestore/local/LocalSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,8 @@ TargetData decodeTargetData(com.google.firebase.firestore.proto.Target targetPro
QueryPurpose.LISTEN,
version,
lastLimboFreeSnapshotVersion,
resumeToken);
resumeToken,
null);
}

public com.google.firestore.bundle.BundledQuery encodeBundledQuery(BundledQuery bundledQuery) {
Expand Down
46 changes: 40 additions & 6 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/local/TargetData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@

import static com.google.firebase.firestore.util.Preconditions.checkNotNull;

import androidx.annotation.Nullable;
import com.google.firebase.firestore.core.Target;
import com.google.firebase.firestore.model.SnapshotVersion;
import com.google.firebase.firestore.remote.WatchStream;
import com.google.protobuf.ByteString;
import java.util.Objects;

/** An immutable set of metadata that the store will need to keep track of for each target. */
public final class TargetData {
Expand All @@ -30,6 +32,7 @@ public final class TargetData {
private final SnapshotVersion snapshotVersion;
private final SnapshotVersion lastLimboFreeSnapshotVersion;
private final ByteString resumeToken;
private final @Nullable Integer expectedCount;

/**
* Creates a new TargetData with the given values.
Expand All @@ -45,6 +48,9 @@ public final class TargetData {
* @param resumeToken An opaque, server-assigned token that allows watching a target to be resumed
* after disconnecting without retransmitting all the data that matches the target. The resume
* token essentially identifies a point in time from which the server should resume sending
* @param expectedCount The number of documents that last matched the query at the resume token or
* read time. Documents are counted only when making a listen request with resume token or
* read time, otherwise, keep it null.
*/
TargetData(
Target target,
Expand All @@ -53,14 +59,16 @@ public final class TargetData {
QueryPurpose purpose,
SnapshotVersion snapshotVersion,
SnapshotVersion lastLimboFreeSnapshotVersion,
ByteString resumeToken) {
ByteString resumeToken,
@Nullable Integer expectedCount) {
this.target = checkNotNull(target);
this.targetId = targetId;
this.sequenceNumber = sequenceNumber;
this.lastLimboFreeSnapshotVersion = lastLimboFreeSnapshotVersion;
this.purpose = purpose;
this.snapshotVersion = checkNotNull(snapshotVersion);
this.resumeToken = checkNotNull(resumeToken);
this.expectedCount = expectedCount;
}

/** Convenience constructor for use when creating a TargetData for the first time. */
Expand All @@ -72,7 +80,8 @@ public TargetData(Target target, int targetId, long sequenceNumber, QueryPurpose
purpose,
SnapshotVersion.NONE,
SnapshotVersion.NONE,
WatchStream.EMPTY_RESUME_TOKEN);
WatchStream.EMPTY_RESUME_TOKEN,
null);
}

/** Creates a new target data instance with an updated sequence number. */
Expand All @@ -84,7 +93,8 @@ public TargetData withSequenceNumber(long sequenceNumber) {
purpose,
snapshotVersion,
lastLimboFreeSnapshotVersion,
resumeToken);
resumeToken,
/* expectedCount= */ null);
}

/** Creates a new target data instance with an updated resume token and snapshot version. */
Expand All @@ -96,7 +106,21 @@ public TargetData withResumeToken(ByteString resumeToken, SnapshotVersion snapsh
purpose,
snapshotVersion,
lastLimboFreeSnapshotVersion,
resumeToken);
resumeToken,
expectedCount);
}

/** Creates a new target data instance with an updated expected count. */
public TargetData withExpectedCount(@Nullable Integer expectedCount) {
return new TargetData(
target,
targetId,
sequenceNumber,
purpose,
snapshotVersion,
lastLimboFreeSnapshotVersion,
resumeToken,
expectedCount);
}

/** Creates a new target data instance with an updated last limbo free snapshot version number. */
Expand All @@ -108,7 +132,8 @@ public TargetData withLastLimboFreeSnapshotVersion(SnapshotVersion lastLimboFree
purpose,
snapshotVersion,
lastLimboFreeSnapshotVersion,
resumeToken);
resumeToken,
expectedCount);
}

public Target getTarget() {
Expand All @@ -135,6 +160,11 @@ public ByteString getResumeToken() {
return resumeToken;
}

@Nullable
public Integer getExpectedCount() {
return expectedCount;
}

/**
* Returns the last snapshot version for which the associated view contained no limbo documents.
*/
Expand All @@ -158,7 +188,8 @@ public boolean equals(Object o) {
&& purpose.equals(targetData.purpose)
&& snapshotVersion.equals(targetData.snapshotVersion)
&& lastLimboFreeSnapshotVersion.equals(targetData.lastLimboFreeSnapshotVersion)
&& resumeToken.equals(targetData.resumeToken);
&& resumeToken.equals(targetData.resumeToken)
&& Objects.equals(expectedCount, targetData.expectedCount);
}

@Override
Expand All @@ -170,6 +201,7 @@ public int hashCode() {
result = 31 * result + snapshotVersion.hashCode();
result = 31 * result + lastLimboFreeSnapshotVersion.hashCode();
result = 31 * result + resumeToken.hashCode();
result = 31 * result + Objects.hashCode(expectedCount);
return result;
}

Expand All @@ -190,6 +222,8 @@ public String toString() {
+ lastLimboFreeSnapshotVersion
+ ", resumeToken="
+ resumeToken
+ ", expectedCount="
+ expectedCount
+ '}';
}
}
7 changes: 7 additions & 0 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/remote/RemoteSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,13 @@ public Target encodeTarget(TargetData targetData) {
builder.setResumeToken(targetData.getResumeToken());
}

// TODO(Mila) Incorporate this into the if statement above.
if (targetData.getExpectedCount() != null
&& (!targetData.getResumeToken().isEmpty()
|| targetData.getSnapshotVersion().compareTo(SnapshotVersion.NONE) > 0)) {
builder.setExpectedCount(Int32Value.newBuilder().setValue(targetData.getExpectedCount()));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code block is inconsistent with the web sdk. In the web sdk, it only sets expectedCount if a resume token or snapshot version is specified. Here, it is setting expectedCount regardless of whether or not a resume token or snapshot version is specified.

We generally aim to keep the sdks in sync as much as possible because it's confusing when things are done differently in one sdk compared to another.

Please make the two SDKs do the same thing in this scenario.

I think the way that the web sdk does it is best because it makes it very clear that expectedCount is only meaningful if a resume token or snapshot version is used.

https://github.com/firebase/firebase-js-sdk/blob/dd6683583b7c6b07586c2551f4d362b48fb83f7c/packages/firestore/src/remote/serializer.ts#L1013-L1025

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, this is the part that I am a bit hesitated. In web the if statments is like:

if (targetData.resumeToken.approximateByteSize() > 0) {
  } else if (targetData.snapshotVersion.compareTo(SnapshotVersion.min()) > 0) {

while in Android it is

if (targetData.getResumeToken().isEmpty()
        && targetData.getSnapshotVersion().compareTo(SnapshotVersion.NONE) > 0) {
} else{
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated the if statement to indicate resume token or snapshotVersion is required to add expectedCount:

   if (targetData.getExpectedCount() != null
        && (!targetData.getResumeToken().isEmpty()
            || targetData.getSnapshotVersion().compareTo(SnapshotVersion.NONE) > 0)) {
      builder.setExpectedCount(Int32Value.newBuilder().setValue(targetData.getExpectedCount()));
    }

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though the "if" statement has the extra check for targetData.getResumeToken().isEmpty(), we should still mirror the structure from the web sdk. We only want to set expected count if either the "if" or the "else" branch above is entered, so we may as well put the logic into those branches.

}

return builder.build();
}

Expand Down
6 changes: 6 additions & 0 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/remote/RemoteStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,12 @@ public void listen(TargetData targetData) {

private void sendWatchRequest(TargetData targetData) {
watchChangeAggregator.recordPendingTargetRequest(targetData.getTargetId());
if (!targetData.getResumeToken().isEmpty()
|| targetData.getSnapshotVersion().compareTo(SnapshotVersion.NONE) > 0) {
int expectedCount = this.getRemoteKeysForTarget(targetData.getTargetId()).size();
targetData = targetData.withExpectedCount(expectedCount);
}

watchStream.watchQuery(targetData);
}

Expand Down
3 changes: 2 additions & 1 deletion ...base-firestore/src/test/java/com/google/firebase/firestore/local/LocalSerializerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,8 @@ public void testEncodesTargetData() {
QueryPurpose.LISTEN,
snapshotVersion,
limboFreeVersion,
resumeToken);
resumeToken,
null);

// Let the RPC serializer test various permutations of query serialization.
com.google.firestore.v1.Target.QueryTarget queryTarget =
Expand Down
3 changes: 2 additions & 1 deletion ...base-firestore/src/test/java/com/google/firebase/firestore/local/TargetCacheTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,8 @@ private TargetData newTargetData(Query query, int targetId, long version) {
QueryPurpose.LISTEN,
version(version),
version(version),
resumeToken(version));
resumeToken(version),
null);
}

/** Adds the given query data to the targetCache under test, committing immediately. */
Expand Down
7 changes: 7 additions & 0 deletions firebase-firestore/src/test/java/com/google/firebase/firestore/spec/SpecTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1006,6 +1006,9 @@ private void validateExpectedState(@Nullable JSONObject expectedState) throws JS
targetData.withResumeToken(
ByteString.EMPTY, version(queryDataJson.getInt("readTime")));
}
if (queryDataJson.has("expectedCount")) {
targetData = targetData.withExpectedCount(queryDataJson.getInt("expectedCount"));
}

expectedActiveTargets.get(targetId).add(targetData);
}
Expand Down Expand Up @@ -1144,6 +1147,10 @@ private void validateActiveTargets() {
expectedTarget.getResumeToken().toStringUtf8(),
actualTarget.getResumeToken().toStringUtf8());

if (expectedTarget.getExpectedCount() != null) {
assertEquals(expectedTarget.getExpectedCount(), actualTarget.getExpectedCount());
}

actualTargets.remove(expected.getKey());
}

Expand Down
Loading