Skip to content

Add a ToString function to create human-readable debug descriptions #2384

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 15 commits into from
Feb 15, 2019
Merged

Add a ToString function to create human-readable debug descriptions #2384

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3215889
Initial
var-const Feb 13, 2019
07758ea
Fix
var-const Feb 13, 2019
0a1b145
style.sh
var-const Feb 13, 2019
3428867
Remove DocumentKey->FSTDocumentKey conversion
var-const Feb 13, 2019
ce8da11
Review feedback
var-const Feb 13, 2019
4084c57
Review feedback
var-const Feb 13, 2019
f39d23f
Review feedback
var-const Feb 13, 2019
193301f
Review feedback
var-const Feb 14, 2019
026f517
style.sh
var-const Feb 14, 2019
fadadb9
Review feedback
var-const Feb 14, 2019
6b157c4
Quick fix
var-const Feb 14, 2019
ea32eab
Review feedback
var-const Feb 14, 2019
baff0e6
Review feedback
var-const Feb 14, 2019
292cdcd
Fix
var-const Feb 15, 2019
eaa8f5f
Review feedback
var-const Feb 15, 2019
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
4 changes: 4 additions & 0 deletions Firestore/Example/Firestore.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@
B67BF449216EB43000CA9097 /* create_noop_connectivity_monitor.cc in Sources */ = {isa = PBXBuildFile; fileRef = B67BF448216EB43000CA9097 /* create_noop_connectivity_monitor.cc */; };
B686F2AF2023DDEE0028D6BE /* field_path_test.cc in Sources */ = {isa = PBXBuildFile; fileRef = B686F2AD2023DDB20028D6BE /* field_path_test.cc */; };
B686F2B22025000D0028D6BE /* resource_path_test.cc in Sources */ = {isa = PBXBuildFile; fileRef = B686F2B02024FFD70028D6BE /* resource_path_test.cc */; };
B68B1E012213A765008977EF /* to_string_apple_test.mm in Sources */ = {isa = PBXBuildFile; fileRef = B68B1E002213A764008977EF /* to_string_apple_test.mm */; };
B68FC0E521F6848700A7055C /* watch_change_test.mm in Sources */ = {isa = PBXBuildFile; fileRef = B68FC0E421F6848700A7055C /* watch_change_test.mm */; };
B6BBE43121262CF400C6A53E /* grpc_stream_test.cc in Sources */ = {isa = PBXBuildFile; fileRef = B6BBE42F21262CF400C6A53E /* grpc_stream_test.cc */; };
B6D1B68520E2AB1B00B35856 /* exponential_backoff_test.cc in Sources */ = {isa = PBXBuildFile; fileRef = B6D1B68420E2AB1A00B35856 /* exponential_backoff_test.cc */; };
Expand Down Expand Up @@ -522,6 +523,7 @@
B67BF448216EB43000CA9097 /* create_noop_connectivity_monitor.cc */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = create_noop_connectivity_monitor.cc; sourceTree = "<group>"; };
B686F2AD2023DDB20028D6BE /* field_path_test.cc */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = field_path_test.cc; sourceTree = "<group>"; };
B686F2B02024FFD70028D6BE /* resource_path_test.cc */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = resource_path_test.cc; sourceTree = "<group>"; };
B68B1E002213A764008977EF /* to_string_apple_test.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = to_string_apple_test.mm; sourceTree = "<group>"; };
B68FC0E421F6848700A7055C /* watch_change_test.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = watch_change_test.mm; sourceTree = "<group>"; };
B69CF05A219B9105004C434D /* FIRFirestore+Testing.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "FIRFirestore+Testing.h"; sourceTree = "<group>"; };
B6BBE42F21262CF400C6A53E /* grpc_stream_test.cc */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = grpc_stream_test.cc; sourceTree = "<group>"; };
Expand Down Expand Up @@ -717,6 +719,7 @@
54740A561FC913EB00713A1A /* util */ = {
isa = PBXGroup;
children = (
B68B1E002213A764008977EF /* to_string_apple_test.mm */,
Copy link
Contributor

Choose a reason for hiding this comment

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

If you run scripts/sync_project.rb does this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

B6FB4680208EA0BE00554BA2 /* async_queue_libdispatch_test.mm */,
B6FB4681208EA0BE00554BA2 /* async_queue_std_test.cc */,
B6FB467B208E9A8200554BA2 /* async_queue_test.cc */,
Expand Down Expand Up @@ -2002,6 +2005,7 @@
5492E09D2021552D00B64F25 /* FSTLocalStoreTests.mm in Sources */,
5CC9650520A0E9BD00A2D6A1 /* FSTMemoryLRUGarbageCollectorTests.mm in Sources */,
5492E0A12021552D00B64F25 /* FSTMemoryLocalStoreTests.mm in Sources */,
B68B1E012213A765008977EF /* to_string_apple_test.mm in Sources */,
5492E0AD2021552D00B64F25 /* FSTMemoryMutationQueueTests.mm in Sources */,
5492E0A42021552D00B64F25 /* FSTMemoryQueryCacheTests.mm in Sources */,
5492E0A52021552D00B64F25 /* FSTMemoryRemoteDocumentCacheTests.mm in Sources */,
Expand Down
11 changes: 7 additions & 4 deletions Firestore/Example/Tests/Model/FSTFieldValueTests.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@
} else if ([value isKindOfClass:[FSTDocumentKeyReference class]]) {
// We directly convert these here so that the databaseIDs can be different.
FSTDocumentKeyReference *reference = (FSTDocumentKeyReference *)value;
wrappedValue = [FSTReferenceValue referenceValue:reference.key
databaseID:reference.databaseID];
wrappedValue =
[FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:reference.key]
databaseID:reference.databaseID];
} else {
wrappedValue = FSTTestFieldValue(value);
}
Expand Down Expand Up @@ -258,7 +259,7 @@ - (void)testWrapResourceNames {
for (FSTDocumentKeyReference *value in values) {
FSTFieldValue *wrapped = FSTTestFieldValue(value);
XCTAssertEqualObjects([wrapped class], [FSTReferenceValue class]);
XCTAssertEqualObjects([wrapped value], value.key);
XCTAssertEqualObjects([wrapped value], [FSTDocumentKey keyWithDocumentKey:value.key]);
XCTAssertTrue(*((FSTReferenceValue *)wrapped).databaseID ==
*(const DatabaseId *)(value.databaseID));
}
Expand Down Expand Up @@ -459,7 +460,9 @@ - (void)testValueEquality {
],
@[ FSTTestFieldValue(FSTTestGeoPoint(1, 0)) ],
@[
[FSTReferenceValue referenceValue:FSTTestDocKey(@"coll/doc1") databaseID:&database_id],
[FSTReferenceValue
referenceValue:[FSTDocumentKey keyWithDocumentKey:FSTTestDocKey(@"coll/doc1")]
databaseID:&database_id],
FSTTestFieldValue(FSTTestRef("project", DatabaseId::kDefault, @"coll/doc1"))
],
@[ FSTTestRef("project", "(default)", @"coll/doc2") ],
Expand Down
18 changes: 11 additions & 7 deletions Firestore/Source/API/FIRQuery.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,11 +470,13 @@ - (FIRQuery *)queryWithFilterOperator:(FSTRelationFilterOperator)filterOperator
"a valid document ID, but it was an empty string.");
}
ResourcePath path = self.query.path.Append([documentKey UTF8String]);
fieldValue = [FSTReferenceValue referenceValue:DocumentKey{path}
databaseID:self.firestore.databaseID];
fieldValue =
[FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:DocumentKey{path}]
databaseID:self.firestore.databaseID];
} else if ([value isKindOfClass:[FIRDocumentReference class]]) {
FIRDocumentReference *ref = (FIRDocumentReference *)value;
fieldValue = [FSTReferenceValue referenceValue:ref.key databaseID:self.firestore.databaseID];
fieldValue = [FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:ref.key]
databaseID:self.firestore.databaseID];
} else {
FSTThrowInvalidArgument(@"Invalid query. When querying by document ID you must provide a "
"valid string or DocumentReference, but it was of type: %@",
Expand Down Expand Up @@ -568,8 +570,9 @@ - (FSTBound *)boundFromSnapshot:(FIRDocumentSnapshot *)snapshot isBefore:(BOOL)i
// orders), multiple documents could match the position, yielding duplicate results.
for (FSTSortOrder *sortOrder in self.query.sortOrders) {
if (sortOrder.field == FieldPath::KeyFieldPath()) {
[components addObject:[FSTReferenceValue referenceValue:document.key
databaseID:self.firestore.databaseID]];
[components addObject:[FSTReferenceValue
referenceValue:[FSTDocumentKey keyWithDocumentKey:document.key]
databaseID:self.firestore.databaseID]];
} else {
FSTFieldValue *value = [document fieldForPath:sortOrder.field];
if (value != nil) {
Expand Down Expand Up @@ -610,8 +613,9 @@ - (FSTBound *)boundFromFieldValues:(NSArray<id> *)fieldValues isBefore:(BOOL)isB
@"Invalid query. Document ID '%@' contains a slash.", documentID);
}
const DocumentKey key{self.query.path.Append([documentID UTF8String])};
[components addObject:[FSTReferenceValue referenceValue:key
databaseID:self.firestore.databaseID]];
[components
addObject:[FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:key]
databaseID:self.firestore.databaseID]];
} else {
FSTFieldValue *fieldValue = [self.firestore.dataConverter parsedQueryValue:rawValue];
[components addObject:fieldValue];
Expand Down
3 changes: 2 additions & 1 deletion Firestore/Source/API/FSTUserDataConverter.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,8 @@ - (nullable FSTFieldValue *)parseScalarValue:(nullable id)input context:(ParseCo
self.databaseID->project_id().c_str(), self.databaseID->database_id().c_str(),
context.FieldDescription().c_str());
}
return [FSTReferenceValue referenceValue:reference.key databaseID:self.databaseID];
return [FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:reference.key]
databaseID:self.databaseID];

} else {
FSTThrowInvalidArgument(@"Unsupported type: %@%s", NSStringFromClass([input class]),
Expand Down
6 changes: 3 additions & 3 deletions Firestore/Source/Core/FSTView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ - (BOOL)isEqual:(id)other {

- (NSUInteger)hash {
NSUInteger hash = self.type;
hash = hash * 31u + [self.key hash];
hash = hash * 31u + self.key.Hash();
return hash;
}

Expand Down Expand Up @@ -241,8 +241,8 @@ - (FSTViewDocumentChanges *)computeChangesWithDocuments:(const MaybeDocumentMap
newDoc = (FSTDocument *)maybeNewDoc;
}
if (newDoc) {
HARD_ASSERT(key == newDoc.key, "Mismatching key in document changes: %s != %s", key,
newDoc.key.ToString());
HARD_ASSERT(key == newDoc.key, "Mismatching key in document changes: %s != %s",
key.ToString(), newDoc.key.ToString());
if (![self.query matchesDocument:newDoc]) {
newDoc = nil;
}
Expand Down
2 changes: 1 addition & 1 deletion Firestore/Source/Core/FSTViewSnapshot.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ - (NSString *)description {
std::string result = absl::StrJoin(
_changeMap, ",",
[](std::string *out, const std::pair<DocumentKey, FSTDocumentViewChange *> &kv) {
out->append(StringFormat("%s: %s", kv.first, kv.second));
out->append(StringFormat("%s: %s", kv.first.ToString(), kv.second));
});
return WrapNSString(std::string{"{"} + result + "}");
}
Expand Down
6 changes: 3 additions & 3 deletions Firestore/Source/Model/FSTDocument.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ - (BOOL)isEqual:(id)other {
}

- (NSUInteger)hash {
NSUInteger result = [self.key hash];
NSUInteger result = self.key.Hash();
result = result * 31 + self.version.Hash();
result = result * 31 + [self.data hash];
result = result * 31 + _documentState;
Expand Down Expand Up @@ -212,7 +212,7 @@ - (BOOL)isEqual:(id)other {
}

- (NSUInteger)hash {
NSUInteger result = [self.key hash];
NSUInteger result = self.key.Hash();
result = result * 31 + self.version.Hash();
result = result * 31 + (_hasCommittedMutations ? 1 : 0);
return result;
Expand Down Expand Up @@ -250,7 +250,7 @@ - (BOOL)isEqual:(id)other {
}

- (NSUInteger)hash {
NSUInteger result = [self.key hash];
NSUInteger result = self.key.Hash();
result = result * 31 + self.version.Hash();
return result;
}
Expand Down
3 changes: 2 additions & 1 deletion Firestore/Source/Remote/FSTSerializerBeta.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,8 @@ - (FSTReferenceValue *)decodedReferenceValue:(NSString *)resourceName {
HARD_ASSERT(database_id == *self.databaseID, "Database %s:%s cannot encode reference from %s:%s",
self.databaseID->project_id(), self.databaseID->database_id(),
database_id.project_id(), database_id.database_id());
return [FSTReferenceValue referenceValue:key databaseID:self.databaseID];
return [FSTReferenceValue referenceValue:[FSTDocumentKey keyWithDocumentKey:key]
databaseID:self.databaseID];
}

- (GCFSArrayValue *)encodedArrayValue:(FSTArrayValue *)arrayValue {
Expand Down
3 changes: 3 additions & 0 deletions Firestore/core/src/firebase/firestore/immutable/sorted_map.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_IMMUTABLE_SORTED_MAP_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_IMMUTABLE_SORTED_MAP_H_

#include <type_traits>
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean to include util/type_traits.h?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Leftover, sorry. I tried adding some static_asserts, but that didn't turn out to be very useful, because compilation attempts proceed after hitting a static_assert, drowning it in a pool of useless noise.

#include <utility>

#include "Firestore/core/src/firebase/firestore/immutable/array_sorted_map.h"
Expand All @@ -38,6 +39,8 @@ namespace immutable {
template <typename K, typename V, typename C = util::Comparator<K>>
class SortedMap : public impl::SortedMapBase {
public:
using key_type = K;
using mapped_type = V;
/** The type of the entries stored in the map. */
using value_type = std::pair<K, V>;
using array_type = impl::ArraySortedMap<K, V, C>;
Expand Down
4 changes: 0 additions & 4 deletions Firestore/core/src/firebase/firestore/model/document_key.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ class DocumentKey {
explicit DocumentKey(ResourcePath&& path);

#if defined(__OBJC__)
operator FSTDocumentKey*() const {
return [FSTDocumentKey keyWithDocumentKey:*this];
}

NSUInteger Hash() const {
return util::Hash(ToString());
}
Expand Down
Loading