Extend StandardMessageCodec for Cloud Firestore #429

Skylled · 2018-03-20T13:39:10Z

Redux of #343 with the new API courtesy of @mravn-google. Fixes flutter/flutter#13043 et al.

Currently testing on Android. Needs iOS testing.

Skylled · 2018-03-20T14:06:41Z

packages/cloud_firestore/android/build.gradle

-        api 'com.google.firebase:firebase-firestore:[11.4.0,12.0['
-        api 'com.google.firebase:firebase-core:[11.4.0,12.0['
+        api 'com.google.firebase:firebase-firestore:[11.6.0,12.0['
+        api 'com.google.firebase:firebase-core:[11.6.0,12.0['


To any reviewers, please see the Firebase Release Notes for 11.6.

Key quote: "Added support for deserializing field types with wildcard generic parameters (e.g. kotlin.Map)."

mravn-google

LGTM

mravn-google · 2018-03-20T20:19:25Z

packages/cloud_firestore/CHANGELOG.md

+
+* Add GeoPoint class
+* Allow for reading and writing DocumentReference, DateTime, and GeoPoint
+  values to and from Documents.


from and to, I guess

mravn-google · 2018-03-20T20:26:37Z

...e/android/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java

+    } else if (value instanceof GeoPoint) {
+      stream.write(GEO_POINT);
+      writeValue(stream, ((GeoPoint) value).getLatitude());
+      writeValue(stream, ((GeoPoint) value).getLongitude());


You could use writeDouble here twice to avoid the redundant type discriminator byte you get with each call to writeValue. That would of course require changing the corresponding reader as well as the Dart and iOS sides too.

mravn-google · 2018-03-20T20:27:08Z

...e/android/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java

+      writeValue(stream, ((GeoPoint) value).getLongitude());
+    } else if (value instanceof DocumentReference) {
+      stream.write(DOCUMENT_REFERENCE);
+      writeValue(stream, ((DocumentReference) value).getPath());


Similarly, you could use writeBytes(stream, path.getBytes(UTF8)) here, unless the path can be null.

mravn-google · 2018-03-20T20:49:10Z

packages/cloud_firestore/test/cloud_firestore_test.dart

+      // Java is only precise to millisecond, Dart to microsecond.
+      // The mismatch between millisecond and microsecond precision will fail this test.
+      final DateTime testTime = new DateTime.fromMillisecondsSinceEpoch(
+          new DateTime.now().millisecondsSinceEpoch);


You might be able to simplify this using a suitable hard-coded value rather than DateTime.now().

mravn-google

LGTM

mravn-google · 2018-03-21T07:25:34Z

...e/android/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java

      case DOCUMENT_REFERENCE:
-        return FirebaseFirestore.getInstance().document((String) readValue(buffer));
+        final byte[] bytes = readBytes(buffer);
+        String path = new String(bytes, UTF8);


[nit] final String path = for consistency with the line above.

mravn-google · 2018-03-21T07:29:29Z

...e/android/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java

@@ -523,9 +525,12 @@ protected Object readValueOfType(byte type, ByteBuffer buffer) {
      case DATE_TIME:
        return new Date(buffer.getLong());
      case GEO_POINT:
-        return new GeoPoint((Double) readValue(buffer), (Double) readValue(buffer));
+        readAlignment(buffer, 8);


Good catch.

mravn-google · 2018-03-21T07:39:29Z

packages/cloud_firestore/lib/src/firestore.dart

-        return Firestore.instance.document(readValue(buffer));
+        final int length = readSize(buffer);
+        final String path = utf8.decoder.convert(buffer.getUint8List(length));
+        return Firestore.instance.document(path);


Looking at the changes you had to do to replace read/writeValue with directly typed alternatives, it becomes painfully clear to me that the standard codec APIs could be much more consistent across Dart, Java, and ObjC. flutter/flutter#15779

I don't think that should hold this PR back.

I already had the code that did not use read/writeValue from the original version of PR. I had switched to improve readability, but I hadn't considered the excess step of processing the type and the extra bytes in the buffer. This style with known types will be marginally faster.

mravn-google · 2018-03-21T20:15:46Z

@Skylled You need to rebase your changes to tip of tree to avoid the ObjC compilation errors.

mdanics · 2018-03-21T22:26:05Z

Any update on when this will be working?

googlebot · 2018-03-22T01:23:40Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for the commit author(s). If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

Skylled · 2018-03-22T01:27:02Z

Not sure why my CLAs got messed with, but that should do it there.

mravn-google · 2018-03-22T08:31:25Z

@Skylled Seems your rebase just pulled in a lot of commits made by other people. I guess that is why the CLA is no longer acceptable to the bot. You may have to undo that.

Can I ask you to do a git rebase upstream/master then git push -f origin or similar so that this PR involves only changes made by yourself?

I'm not a git wizard

Was I half-asleep when I wrote this?

googlebot · 2018-03-22T15:44:54Z

CLAs look good, thanks!

Skylled · 2018-03-22T15:46:36Z

Thanks for the advice. My git-fu is very weak.

mravn-google

One small fix remaining, I think. Otherwise LGTM.

mravn-google · 2018-03-22T20:11:21Z

...e/android/src/main/java/io/flutter/plugins/firebase/cloudfirestore/CloudFirestorePlugin.java

+      writeLong(stream, ((Date) value).getTime());
+    } else if (value instanceof GeoPoint) {
+      stream.write(GEO_POINT);
+      writeDouble(stream, ((GeoPoint) value).getLatitude());


writeAlignment missing

Skylled · 2018-03-23T14:10:04Z

Thank you for the assistance @mravn-google. Java and ObjC are not my forte. I'm so glad to see this project done.

mravn-google · 2018-03-23T14:13:07Z

@Skylled Me too :-) Thanks for your contribution and your patience.

googlebot added the cla: yes label Mar 20, 2018

Skylled mentioned this pull request Mar 20, 2018

Updated Firestore codec #343

Closed

Skylled commented Mar 20, 2018

View reviewed changes

mravn-google approved these changes Mar 20, 2018

View reviewed changes

mravn-google self-assigned this Mar 20, 2018

mravn-google approved these changes Mar 21, 2018

View reviewed changes

googlebot added cla: no and removed cla: yes labels Mar 22, 2018

Kyle Bradshaw added 17 commits March 22, 2018 10:42

New fork from master

11e69d8

I'm not a git wizard

First draft of Codec in new API

8f544ba

Typo

3b2c9fa

Typo2

9029a08

Update iOS codec API

20b9aeb

Fix types, imports and casting.

21f4e79

Use correct API

eb4530b

Typoes in iOS

3d7cfe5

Was I half-asleep when I wrote this?

Bump version number

d9c074e

Add tests for codec

f505cae

Formatting for Travis

c6bc618

Double newline

e965a97

Fixes based on review

2949d1b

Nit

06623c9

Thanks Travis

8bd8903

Fix interface/implementation in iOS

3a84c20

Missing "class" in iOS

65dd8d3

Skylled force-pushed the firestore_ext_codec branch from cfd81cf to 65dd8d3 Compare March 22, 2018 15:44

googlebot added cla: yes and removed cla: no labels Mar 22, 2018

mravn-google approved these changes Mar 22, 2018

View reviewed changes

Missing writeAlignment

713fb07

mravn-google merged commit fbcf37f into flutter:master Mar 23, 2018

Skylled deleted the firestore_ext_codec branch March 23, 2018 14:09

Skylled mentioned this pull request Mar 26, 2018

java.lang.IllegalArgumentException when reading a Firestore document flutter/flutter#14767

Closed

slightfoot pushed a commit to slightfoot/plugins that referenced this pull request Jun 5, 2018

Extend StandardMessageCodec for Cloud Firestore (flutter#429)

088b4a2

Skylled mentioned this pull request Sep 26, 2018

Additional Firestore Query methods #369

Merged

julianscheel pushed a commit to jusst-engineering/plugins that referenced this pull request Mar 11, 2020

Extend StandardMessageCodec for Cloud Firestore (flutter#429)

9f8f460

Extend StandardMessageCodec for Cloud Firestore #429

Extend StandardMessageCodec for Cloud Firestore #429

Uh oh!

Conversation

Skylled commented Mar 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mravn-google left a comment

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!

mravn-google left a comment

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!

mravn-google commented Mar 21, 2018

Uh oh!

mdanics commented Mar 21, 2018

Uh oh!

googlebot commented Mar 22, 2018

Uh oh!

Skylled commented Mar 22, 2018

Uh oh!

mravn-google commented Mar 22, 2018

Uh oh!

googlebot commented Mar 22, 2018

Uh oh!

Skylled commented Mar 22, 2018

Uh oh!

mravn-google left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Skylled commented Mar 23, 2018

Uh oh!

mravn-google commented Mar 23, 2018

Uh oh!

Uh oh!