Sort tests

Author: tom-andersen

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentReference.java

@@ -71,7 +71,7 @@ public final class DocumentReference {
   }
 
   /** @hide */
-  static DocumentReference forPath(ResourcePath path, FirebaseFirestore firestore) {
+  public static DocumentReference forPath(ResourcePath path, FirebaseFirestore firestore) {
     if (path.length() % 2 != 0) {
       throw new IllegalArgumentException(
           "Invalid document reference. Document references must have an even number "

firebase-firestore/src/main/java/com/google/firebase/firestore/Pipeline.kt

@@ -786,6 +786,9 @@ internal constructor(
   fun select(fieldName: String, vararg additionalSelections: Any): RealtimePipeline =
     append(SelectStage.of(fieldName, *additionalSelections))
 
+  fun sort(order: Ordering, vararg additionalOrders: Ordering): RealtimePipeline =
+    append(SortStage(arrayOf(order, *additionalOrders)))
+
   fun where(condition: BooleanExpr): RealtimePipeline = append(WhereStage(condition))
 }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/pipeline/evaluation.kt

@@ -20,6 +20,7 @@ import com.google.common.math.LongMath
 import com.google.common.math.LongMath.checkedAdd
 import com.google.common.math.LongMath.checkedMultiply
 import com.google.common.math.LongMath.checkedSubtract
+import com.google.firebase.firestore.FirebaseFirestore
 import com.google.firebase.firestore.UserDataReader
 import com.google.firebase.firestore.model.MutableDocument
 import com.google.firebase.firestore.model.Values
@@ -42,7 +43,10 @@ import kotlin.math.log10
 import kotlin.math.pow
 import kotlin.math.sqrt
 
-internal class EvaluationContext(val userDataReader: UserDataReader)
+internal class EvaluationContext(
+  val db: FirebaseFirestore,
+  val userDataReader: UserDataReader
+)
 
 internal typealias EvaluateDocument = (input: MutableDocument) -> EvaluateResult
 

firebase-firestore/src/main/java/com/google/firebase/firestore/pipeline/expressions.kt

@@ -23,6 +23,9 @@ import com.google.firebase.firestore.Pipeline
 import com.google.firebase.firestore.UserDataReader
 import com.google.firebase.firestore.VectorValue
 import com.google.firebase.firestore.model.DocumentKey
+import com.google.firebase.firestore.model.FieldPath.CREATE_TIME_PATH
+import com.google.firebase.firestore.model.FieldPath.KEY_PATH
+import com.google.firebase.firestore.model.FieldPath.UPDATE_TIME_PATH
 import com.google.firebase.firestore.model.FieldPath as ModelFieldPath
 import com.google.firebase.firestore.model.MutableDocument
 import com.google.firebase.firestore.model.Values
@@ -295,10 +298,12 @@ abstract class Expr internal constructor() {
      */
     @JvmStatic
     fun field(name: String): Field {
-      if (name == DocumentKey.KEY_FIELD_NAME) {
-        return Field(ModelFieldPath.KEY_PATH)
+      return when (name) {
+        DocumentKey.KEY_FIELD_NAME -> Field(KEY_PATH)
+        ModelFieldPath.CREATE_TIME_NAME -> Field(CREATE_TIME_PATH)
+        ModelFieldPath.UPDATE_TIME_NAME -> Field(UPDATE_TIME_PATH)
+        else -> Field(FieldPath.fromDotSeparatedPath(name).internalPath)
       }
-      return Field(FieldPath.fromDotSeparatedPath(name).internalPath)
     }
 
     /**
@@ -4189,11 +4194,13 @@ class Field internal constructor(private val fieldPath: ModelFieldPath) : Select
   internal fun toProto(): Value =
     Value.newBuilder().setFieldReferenceValue(fieldPath.canonicalString()).build()
 
-  override fun evaluateContext(context: EvaluationContext) = ::evaluateInternal
-
-  private fun evaluateInternal(input: MutableDocument): EvaluateResult {
-    val value: Value? = input.getField(fieldPath)
-    return if (value === null) EvaluateResultUnset else EvaluateResultValue(value)
+  override fun evaluateContext(context: EvaluationContext) = block@{ input: MutableDocument ->
+    EvaluateResultValue(when (fieldPath) {
+      KEY_PATH -> encodeValue(DocumentReference.forPath(input.key.path, context.db))
+      CREATE_TIME_PATH -> encodeValue(input.createTime.timestamp)
+      UPDATE_TIME_PATH -> encodeValue(input.version.timestamp)
+      else -> input.getField(fieldPath) ?: return@block EvaluateResultUnset
+    })
   }
 }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/pipeline/stage.kt

@@ -30,7 +30,9 @@ import com.google.firestore.v1.Value
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.flow
+import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.take
 import kotlinx.coroutines.flow.toList
 
 sealed class BaseStage<T : BaseStage<T>>(
@@ -244,6 +246,13 @@ private constructor(private val collectionId: String, options: InternalOptions)
   override fun self(options: InternalOptions) = CollectionGroupSource(collectionId, options)
   override fun args(userDataReader: UserDataReader): Sequence<Value> =
     sequenceOf(Value.newBuilder().setReferenceValue("").build(), encodeValue(collectionId))
+  override fun evaluate(
+    context: EvaluationContext,
+    inputs: Flow<MutableDocument>
+  ): Flow<MutableDocument> {
+    // TODO: Does this need to do more?
+    return inputs
+  }
 
   companion object {
 
@@ -511,6 +520,11 @@ internal class LimitStage
 internal constructor(private val limit: Int, options: InternalOptions = InternalOptions.EMPTY) :
   BaseStage<LimitStage>("limit", options) {
   override fun self(options: InternalOptions) = LimitStage(limit, options)
+  override fun evaluate(
+    context: EvaluationContext,
+    inputs: Flow<MutableDocument>
+  ): Flow<MutableDocument> = if (limit > 0) inputs.take(limit) else flowOf()
+
   override fun args(userDataReader: UserDataReader): Sequence<Value> =
     sequenceOf(encodeValue(limit))
 }

firebase-firestore/src/test/java/com/google/firebase/firestore/pipeline/PipelineTests.kt

@@ -19,6 +19,7 @@ import com.google.firebase.firestore.RealtimePipelineSource
 import com.google.firebase.firestore.TestUtil
 import com.google.firebase.firestore.model.MutableDocument
 import com.google.firebase.firestore.pipeline.Expr.Companion.field
+import com.google.firebase.firestore.runPipeline
 import com.google.firebase.firestore.testutil.TestUtilKtx.doc
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.toList
@@ -39,7 +40,7 @@ internal class PipelineTests {
     val doc2: MutableDocument = doc("foo/2", 0, mapOf("bar" to "43"))
     val doc3: MutableDocument = doc("xxx/1", 0, mapOf("bar" to 42))
 
-    val list = runPipeline(pipeline, flowOf(doc1, doc2, doc3)).toList()
+    val list = runPipeline(firestore, pipeline, flowOf(doc1, doc2, doc3)).toList()
 
     assertThat(list).hasSize(1)
   }