Expand SeaORM entity generator with Seaography related data by karatakis · Pull Request #1599 · SeaQL/sea-orm

karatakis · 2023-04-15T00:17:50Z

PR Info

Related Reduce the generated code in file query_root.rs seaography#130

New Features

Add seaography flag to sea-orm-cli
Add generation of seaography related information to sea-orm-codegen
Add DeriveEntityRelated macro
Add generation of code that uses DeriveEntityRelated to sea-orm-codegen

billy1624 · 2023-04-16T16:36:57Z

sea-orm-codegen/tests/compact/cake.rs

-impl Related<super::fruit::Entity> for Entity {
-    fn to() -> RelationDef {
-        Relation::Fruit.def()
-    }
-}
-
-impl Related<super::filling::Entity> for Entity {
-    fn to() -> RelationDef {
-        super::cake_filling::Relation::Filling.def()
-    }
-    fn via() -> Option<RelationDef> {
-        Some(super::cake_filling::Relation::Cake.def().rev())
-    }
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelatedEntity)]
+pub enum RelatedEntity {
+    #[sea_orm(entity = "super::fruit::Entity", to = "Relation::Fruit.def()")]
+    Fruit,
+    #[sea_orm (entity = "super::filling::Entity", to = "super::cake_filling::Relation::Filling.def()", via = "Some(super::cake_filling::Relation::Cake.def().rev())")]
+    Filling


I think we should keep generating the plain old Related<T>. With that in mind, if user pass in a --seaography flag to the sea-orm-cli generate entity, then, an additional RelatedEntity enum will be generated.

I imagine the derive attribute of each variant in the RelatedEntity could be... to take advantage of the existing Related<T> impl and avoid saying the same thing twice.

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelatedEntity)] pub enum RelatedEntity { #[sea_orm (entity = "super::filling::Entity")] Filling }

billy1624 · 2023-04-16T16:37:29Z

sea-orm-codegen/tests/with_seaography/cake.rs

+impl seaography::RelationBuilder for Relation {
+    fn get_relation(&self, context: & 'static seaography::BuilderContext) -> async_graphql::dynamic::Field {
+        let builder = seaography::EntityObjectRelationBuilder { context };
+        match self {
+            Self::Fruit => builder.get_relation:: <Entity, super::fruit::Entity>("fruit", Self::Fruit.def()),
+            _ => panic!("No relations for this entity")
+        }
+    }
+}
+
+impl seaography::RelationBuilder for RelatedEntity {
+    fn get_relation(&self, context: & 'static seaography::BuilderContext) -> async_graphql::dynamic::Field {
+        let builder = seaography::EntityObjectViaRelationBuilder { context };
+        match self {
+            Self::Fruit => builder.get_relation:: <Entity, super::fruit::Entity>("fruit"),
+            Self::Filling => builder.get_relation:: <Entity, super::filling::Entity>("filling"),
+            _ => panic!("No relations for this entity")
+        }
+    }
+}


These async-graphql constructors for relations can be moved into sea-orm-macros in which those methods will be generated when the seaography feature is enabled

billy1624

Hey @karatakis, thanks for the huge PR! Great work! I just leave a few comments :)

* Bring old Related Impl trait generation * Modify DeriveRelatedEntity to gen impl seaography::RelationBuilder * Generate RelatedEntity enum when seaography flag is enabled

billy1624 · 2023-04-17T02:26:12Z

Hey @karatakis, thanks for the changes!! Please feel free to ping me once it's finished or you need help :P

karatakis · 2023-04-17T02:28:17Z

I am done.

@billy1624 could you please take a look if the last changes resolve the issues you pointed out ?

* relations with suffix are definition based * Rev => Reverse easier to read * snake_case to cameCase for name generation

karatakis · 2023-04-18T08:22:04Z

I used the proposed changes in the following SeaQL/seaography#131
Its still WIP but you can see how I am planning to use it :)

tyt2y3 · 2023-04-18T08:39:23Z

Great work. This is really significant. We will try to roll out SeaORM 0.12 sooner and I think this is really a 'killer app'

billy1624

Hey @karatakis, look good!! Neat and clean!

Can we update the Cargo.toml in SeaQL/seaography#131 and make it depends on this PR. I want to compile, see it in action and play with it :)

tyt2y3

I think we can arrange a merge @billy1624 if there is no other outstanding PR to sea-orm-cli
We want to be extra careful not to breaking any existing features though.

…s enabled

… without relation

billy1624

Hey @karatakis, I just added two commits

Derive impl seaography::RelationBuilder for RelatedEntity when seaography feature is enabled 0833478
A demo for how to construct the async-graphql query root for entity with/without RelatedEntity c84294e

Please check :)

tyt2y3 · 2023-05-19T11:34:54Z

The seaography feature in the root Cargo.toml needs a '?' for macros

Cargo.toml

Co-authored-by: Chris Tsang <[email protected]>

billy1624 · 2023-05-19T11:49:14Z

Indeed! Thanks @tyt2y3 for catching that

This reverts commit 6b16698.

billy1624 · 2023-05-19T11:53:58Z

Emmmm... no. We're wrong. sea-orm-macros is not a optional dependency. It's always on, just that we pass-through sea-orm-macros's feature via sea-orm's feature.

tyt2y3

No questions then!

* Optional Field SeaQL/sea-orm#1513 * .gitignore SeaQL/sea-orm#1334 * migration table custom name SeaQL/sea-orm#1511 * OR condition relation SeaQL/sea-orm#1433 * DerivePartialModel SeaQL/sea-orm#1597 * space for migration file naming SeaQL/sea-orm#1570 * composite key up to 12 SeaQL/sea-orm#1508 * seaography integration SeaQL/sea-orm#1599 * QuerySelect SimpleExpr SeaQL/sea-orm#1702 * sqlErr SeaQL/sea-orm#1707 * migration check SeaQL/sea-orm#1519 * postgres array SeaQL/sea-orm#1565 * param intoString SeaQL/sea-orm#1439 * **skipped** re-export SeaQL/sea-orm#1661 * ping SeaQL/sea-orm#1627 * on empty do nothing SeaQL/sea-orm#1708 * on conflict do nothing SeaQL/sea-orm#1712 * **skipped** upgrade versions * active enum fail safe SeaQL/sea-orm#1374 * relation generation check SeaQL/sea-orm#1435 * entity generation bug SeaQL/sea-schema#105 * **skipped** bug fix that does not require edits * EnumIter change SeaQL/sea-orm#1535 * completed and fixed a previous todo SeaQL/sea-orm#1570 * amended wordings and structures * Edit * Remove temp file --------- Co-authored-by: Billy Chan <[email protected]>

github-actions · 2023-08-02T17:12:06Z

🎉 Released In 0.12.1 🎉

Thank you everyone for the contribution!
This feature is now available in the latest release. Now is a good time to upgrade!
Your participation is what makes us unique; your adoption is what drives us forward.
You can support SeaQL 🌊 by starring our repos, sharing our libraries and becoming a sponsor ⭐.

karatakis and others added 13 commits April 15, 2023 01:12

Add DeriveRelatedEntity macro

f03864e

Add generation for related enum and seaography

d9c6579

Add seaography cli param

0ecc57c

update codegen tests

474f471

Fix DeriveRelatedEntity macro doc and includes

ff01616

Fix all RelatedEntity variants for RelationBuilder

e9ff1c0

Add tests for code

04bd604

Cargo format

516272b

Fix clippy code

f60d9d6

Fix format

0e188ca

Merge branch 'SeaQL:master' into seaography-generator

5b37895

Fix unit tests

f23cd63

Fix unit tests

77e46dc

karatakis marked this pull request as ready for review April 15, 2023 11:49

Provide default for seaography::RelationBuilder

215bd04

billy1624 assigned karatakis Apr 15, 2023

Update changelog

eedc835

billy1624 reviewed Apr 16, 2023

View reviewed changes

karatakis added 5 commits April 17, 2023 03:00

Update tests

6428de1

Modify code to match feedback

2616fd4

* Bring old Related Impl trait generation * Modify DeriveRelatedEntity to gen impl seaography::RelationBuilder * Generate RelatedEntity enum when seaography flag is enabled

Update documentation

499ce88

Update Changelog

cbbbf10

Fix format errors

b49d416

karatakis added 2 commits April 18, 2023 10:55

Fix code generation

fc5232c

* relations with suffix are definition based * Rev => Reverse easier to read * snake_case to cameCase for name generation

Fix unit tests

fa86415

karatakis mentioned this pull request Apr 18, 2023

Slim query root SeaQL/seaography#131

Merged

3 tasks

billy1624 reviewed Apr 20, 2023

View reviewed changes

tyt2y3 approved these changes Apr 25, 2023

View reviewed changes

karatakis and others added 4 commits April 28, 2023 00:24

Merge branch 'master' into seaography-generator

9ebf2bf

Update lib.rs

433f7c4

derive seaography::RelationBuilder only when seaography feature i…

0833478

…s enabled

Try constructing async-graphql root for "related entity" and "entity"…

c84294e

… without relation

billy1624 reviewed May 17, 2023

View reviewed changes

billy1624 added 3 commits May 18, 2023 16:59

Merge branch 'master' into pr/1599

494d527

Update demo

2ecfdb9

CHANGELOG

4117664

billy1624 requested review from billy1624 and tyt2y3 May 18, 2023 12:40

tyt2y3 reviewed May 19, 2023

View reviewed changes

Cargo.toml Show resolved Hide resolved

Update Cargo.toml

6b16698

Co-authored-by: Chris Tsang <[email protected]>

Revert "Update Cargo.toml"

2e1f4a5

This reverts commit 6b16698.

tyt2y3 approved these changes May 19, 2023

View reviewed changes

billy1624 merged commit 3300336 into SeaQL:master May 19, 2023

darkmmon added a commit to darkmmon/seaql.github.io that referenced this pull request Jul 12, 2023

seaography integration SeaQL/sea-orm#1599

7ea184d

karatakis deleted the seaography-generator branch August 7, 2023 10:24

Uh oh!

Conversation

karatakis commented Apr 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Info

New Features

Uh oh!

billy1624 Apr 16, 2023

Choose a reason for hiding this comment

Uh oh!

billy1624 Apr 16, 2023

Choose a reason for hiding this comment

Uh oh!

billy1624 left a comment

Choose a reason for hiding this comment

Uh oh!

billy1624 commented Apr 17, 2023

Uh oh!

karatakis commented Apr 17, 2023

Uh oh!

karatakis commented Apr 18, 2023

Uh oh!

tyt2y3 commented Apr 18, 2023

Uh oh!

billy1624 left a comment

Choose a reason for hiding this comment

Uh oh!

tyt2y3 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

billy1624 left a comment

Choose a reason for hiding this comment

Uh oh!

tyt2y3 commented May 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

billy1624 commented May 19, 2023

Uh oh!

billy1624 commented May 19, 2023

Uh oh!

tyt2y3 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 2, 2023

🎉 Released In 0.12.1 🎉

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

karatakis commented Apr 15, 2023 •

edited

Loading

tyt2y3 left a comment •

edited

Loading

tyt2y3 commented May 19, 2023 •

edited

Loading