Include ToString() in Firestore's Query::Comparator() assertion failure message (#9489)

dconeybe · web-flow · commit c61018e62a61 · 2022-03-21T19:39:19.000-04:00
diff --git a/Firestore/CHANGELOG.md b/Firestore/CHANGELOG.md
@@ -1,3 +1,7 @@
+# Unreleased
+- [changed] Add more details to the assertion failure in Query::Comparator() to
+  help with future debugging (#9258).
+
 # v8.14.0
 - [fixed] Fixed compiler warnings in `local_serializer.cc` about "implicit
   conversion loses integer precision" that were introduced in 8.13.0 (#9430).
diff --git a/Firestore/core/src/core/query.cc b/Firestore/core/src/core/query.cc
@@ -279,8 +279,10 @@ model::DocumentComparator Query::Comparator() const {
       break;
     }
   }
-  HARD_ASSERT(has_key_ordering,
-              "QueryComparator needs to have a key ordering.");
+
+  if (!has_key_ordering) {
+    HARD_FAIL("QueryComparator needs to have a key ordering: %s", ToString());
+  }
 
   return DocumentComparator(
       [ordering](const Document& doc1, const Document& doc2) {

Original file line number	Diff line number	Diff line change
`@@ -279,8 +279,10 @@ model::DocumentComparator Query::Comparator() const {`
`279`	`279`	`break;`
`280`	`280`	`}`
`281`	`281`	`}`
`282`		`- HARD_ASSERT(has_key_ordering,`
`283`		`- "QueryComparator needs to have a key ordering.");`
	`282`	`+`
	`283`	`+ if (!has_key_ordering) {`
	`284`	`+ HARD_FAIL("QueryComparator needs to have a key ordering: %s", ToString());`
	`285`	`+ }`
`284`	`286`
`285`	`287`	`return DocumentComparator(`
`286`	`288`	`[ordering](const Document& doc1, const Document& doc2) {`