Skip to content
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.

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

feat(cloud_firestore_odm): add support for specifying class name prefix #9453

Merged

Conversation

Rexios80
Copy link
Contributor

@Rexios80 Rexios80 commented Sep 1, 2022

Description

Allows developers to specify the name prefix used for generated classes. This allows for reusing the same data class in multiple sub collections on the same parent collection.

Related Issues

#9452

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. Updating the pubspec.yaml and changelogs is not required.

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • 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 (melos run analyze) does not report any problems on my PR.
  • I read and followed the [Flutter Style Guide].
  • 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.
  • No, this is not a breaking change.

@russellwheatley russellwheatley added type: missing-feature A feature that is supported on the underlying Firebase SDK but has not been exposed to Dart API. plugin: odm labels Sep 6, 2022
@rrousselGit
Copy link
Contributor

I think another important thing to do for #9452 is to throw an error if the same Model is used on multiple collections. Could you add that?

@rrousselGit
Copy link
Contributor

Outside of error handling, LGTM

@Rexios80
Copy link
Contributor Author

Rexios80 commented Sep 6, 2022

I think another important thing to do for #9452 is to throw an error if the same Model is used on multiple collections. Could you add that?

I'm not sure what you mean. Do you mean throw an exception if the same model is used on multiple root collections?

@rrousselGit
Copy link
Contributor

rrousselGit commented Sep 6, 2022

Yes. If multiple @Collection annotation uses the same generics, it should throw (root or not)

Of course, specifying the added "prefix" parameter would disable this exception

@rrousselGit
Copy link
Contributor

LGTM thanks!

@rrousselGit rrousselGit merged commit 49921a4 into firebase:master Sep 12, 2022
@firebase firebase locked and limited conversation to collaborators Oct 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
plugin: odm type: missing-feature A feature that is supported on the underlying Firebase SDK but has not been exposed to Dart API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants