Skip to content

[cloud_firestore] migrate to platform interface #1945

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

Jump to bottom
Merged
merged 147 commits into from
Feb 6, 2020
Merged

[cloud_firestore] migrate to platform interface #1945

merged 147 commits into from
Feb 6, 2020

Conversation

amrfarid140
Copy link
Contributor

Description

Migrate cloud_firestore to use cloud_firestore_platform_interface

Related Issues

This is part of the changes mentioned in this PR.

It is a follow-up of an the following merged [PR] (#1686)

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • If the pull request affects only one plugin, the PR title starts with the name of the plugin in brackets (e.g. [cloud_firestore])
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@amrfarid140
- Created cloud_firestore_platform interface package
647c213 
- Migrated DocumentReference and CollectionReference to use interfaces
@amrfarid140
- Created cloud_firestore_web package
9ed7d8c
@amrfarid140
Created query interface
7fdd1c8
@amrfarid140
created base QuerySnapshot
14bad9c
@amrfarid140
organised platform_interface module
552305d
@amrfarid140
- created query_web
63f3488 
- added where support
@amrfarid140
- fixed method_channel_query_snapshot
9c7ea4a
@amrfarid140
- implemented query_web
250f017
@amrfarid140
- delegated collection_reference_web to use query_web
dfaa02a
@amrfarid140
- added firestore web to firestore package
46349f6
@amrfarid140
- create delegate for collection reference
d731ecd
@amrfarid140
- create delegate for document related items
9ad5779
@amrfarid140
- create delegate for transaction and query
8557df2
@amrfarid140
delegate cloud_firestore to abstract types
fa06657
@amrfarid140
- added method_channel_firestore_test
993b86a 
- fixed test failure causes
@amrfarid140
Use support multiple apps in FirestoreWeb
2a160d5
@amrfarid140
added transaction implementation
3e24ca2
@amrfarid140
updated readmes
76037e7
@amrfarid140
Merge pull request #1 from amrfarid140/feature/firestore_web_support
e1f1591 
Feature/firestore web support
@amrfarid140
fixed copy typo on readme
ffb12cd
@amrfarid140
- Added change log
c30f1f7 
- use any as versions
@amrfarid140
Added support for field value
65984ff 
Created FieldValueFactory to provide platform-specific FieldValue instances
@amrfarid140
Build example for web and mobile
ec595fe 
Added NO-OP folders for android & ios in firestore web package
@amrfarid140
Support new FieldValueInterface on mobile
aa7d422
@amrfarid140
Fix query delegation on web
082baa3 
- Removed unnecessary tracking of collection reference delegate and used the more generic query type instead
- fixed breakage
@amrfarid140
Use PlaformUtils for conversions in DocumentChange
61cc5b1
@amrfarid140
Fixed typo in variable name
aa3089e
@amrfarid140
Pass timeout value for transaction
2d3e712
@amrfarid140
Delete unused cloud_firestore/firestore_message_codec
abed99e
@amrfarid140
removed unused imports
269d71e
ditman and others added 10 commits February 3, 2020 17:36
@ditman
Use Source and DocumentChangeType enums from PlatformInterface.
7009ef6 
Rename SnapshotMetadata and DocumentSnapshot in PlatformInterface to
SnapshotMetadataPlatform and DocumentSnapshotPlatform so they don't
collide with class names exported by the core plugin.
@ditman
Transaction constructor is properly public, not visibleForTesting. da…
3b30165 
…rtfmt -w
@ditman
Do not export auto_id_generator from PlatformInterface.
926ba55 
* Web doesn't need it, it can delegate all that logic to the JS client.
* It's only required for MethodChannel. Move it to method_channel/utils.
@ditman
Remove as much logic as possible from FieldValue instances.
4cb361c 
This change exposes the FieldValuePlatform abstract class to plugin
users, so they can have a way of typing the result of calling the
FieldValue.whatever() methods, without having to keep an internal
'instance' as part of the exposed interface.
@ditman
FieldValue now internally stores the platform-dependent value.
7c92e7c 
Refactor tests and code around the new API.
@amrfarid140
Merge pull request #2 from amrfarid140/amr-master-pr
542a8e3 
Changed from FlutterFire Maintainers
@amrfarid140
Merge branch 'master' of github.com:FirebaseExtended/flutterfire and …
12277b0 
…fix conflicts
@amrfarid140
Merge branch 'master' of github.com:FirebaseExtended/flutterfire
00e04ed
@amrfarid140
Use published version of cloud_firestore_platform_interface
48e5ba3
@amrfarid140
Remove references of _web and update changelog
60ae8e7
collinjackson
collinjackson approved these changes Feb 6, 2020
View reviewed changes
ditman
ditman approved these changes Feb 6, 2020
View reviewed changes
@ditman ditman merged commit 1b45082 into firebase:master Feb 6, 2020
@ditman
Copy link
Contributor

ditman commented Feb 6, 2020

Tagged and published cloud_firestore 0.13.1!

@ditman ditman mentioned this pull request Feb 7, 2020
Closed
5 tasks
@amrfarid140 amrfarid140 mentioned this pull request Feb 7, 2020
Merged
13 tasks
@tecbot
Copy link

tecbot commented Feb 15, 2020

This PR introduced a breaking change which is not documented. Before the PR it was possible to add data to the data property in DocumentSnapshot. E.g. we have added the documentID to the data object before calling fromJson methods. Maybe it was not the safest way to do it like this but i could imagine some others have done it as well. Now the data object gets always computed new if accessing so we lost the previously changed data:
1b45082#diff-fe42784719077ee49f318229149be8e7R23

Maybe this should be highlighted.

@collinjackson collinjackson mentioned this pull request Feb 17, 2020
Closed
@collinjackson
Copy link
Contributor

Thanks @tecbot. You're absolutely right that this is confusing, and I've filed #2007 to address it.

@byrek3d
Copy link

byrek3d commented May 3, 2020

Any news on supporting Realtime Database as well?

@ditman
Copy link
Contributor

ditman commented May 4, 2020

@byrek3d work started (but seems to be stalled) here. Your contribution would be very welcome! :D

@firebase firebase locked and limited conversation to collaborators Aug 3, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@collinjackson collinjackson collinjackson approved these changes

@ditman ditman ditman approved these changes

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@amrfarid140 @ditman @tecbot @collinjackson @byrek3d @googlebot