-
Notifications
You must be signed in to change notification settings - Fork 1
fix(datasource-active-record): mark non-polymorphic has_one :through identity joins read-only #381
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
Open
matthv
wants to merge
3
commits into
main
Choose a base branch
from
fix/379-non-polymorphic-has-one-through-identity-join
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+415
−57
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,6 +114,15 @@ def valid_many_to_many_source?(association) | |
| association.source_reflection&.belongs_to? | ||
| end | ||
|
|
||
| # Same criterion as unrepresentable_many_to_many?: a composite primary key can arrive as a | ||
| # real Array or already flattened by Rails into a mangled String -- checking column | ||
| # membership catches both forms, plus a custom primary_key pointing at a non-column, all of | ||
| # which would otherwise hit nil.column_type in build_one_to_one_schema (#379). | ||
| def unrepresentable_one_to_one?(association) | ||
| !association.klass.column_names.include?(association.klass.primary_key) || | ||
| !@model.column_names.include?(@model.primary_key) | ||
| end | ||
|
|
||
| def build_many_to_many_field(association, through_reflection, is_polymorphic, source_polymorphic) | ||
| ForestAdminDatasourceToolkit::Schema::Relations::ManyToManySchema.new( | ||
| foreign_collection: format_model_name(association.klass.name), | ||
|
|
@@ -157,15 +166,19 @@ def fetch_associations | |
|
|
||
| if many_to_many_shape | ||
| add_many_to_many_field(association, through_reflection, is_polymorphic, source_polymorphic) | ||
| elsif unrepresentable_one_to_one?(association) | ||
| warn_unrepresentable_one_to_one(association, through_reflection) | ||
| else | ||
| add_field( | ||
| association.name.to_s, | ||
| ForestAdminDatasourceToolkit::Schema::Relations::OneToOneSchema.new( | ||
| foreign_collection: format_model_name(association.klass.name), | ||
| origin_key: association.klass.primary_key, | ||
| origin_key_target: @model.primary_key | ||
| origin_key_target: @model.primary_key, | ||
| is_read_only: true | ||
| ) | ||
| ) | ||
| warn_readonly_identity_join(association, through_reflection) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| end | ||
| elsif association.inverse_of&.polymorphic? | ||
| add_field( | ||
|
|
@@ -362,6 +375,33 @@ def warn_identity_join(association, through_reflection) | |
| ) | ||
| end | ||
|
|
||
| def warn_unrepresentable_one_to_one(association, through_reflection) | ||
| logger = ActiveSupport::Logger.new($stdout) | ||
| logger.warn( | ||
| "[ForestAdmin] ⚠️ Skipping association '#{association.name}' in model '#{@model.name}': " \ | ||
| "this has_one :through (via '#{format_model_name(through_reflection.klass.name)}') can't be " \ | ||
| 'represented as a Forest Admin one-to-one -- one of its endpoints has a composite primary key.' | ||
| ) | ||
| end | ||
|
|
||
| # OneToOneSchema has no through_collection, so this publishes each side's own primary key | ||
| # as a placeholder join -- the columns exist on both sides, so GeneratorField's field | ||
| # lookups don't raise, but the join isn't meaningful data (it matches two unrelated | ||
| # sequences), which is exactly why it's marked read-only rather than left writable through | ||
| # what's really the foreign collection's own primary key (#379). | ||
| def warn_readonly_identity_join(association, through_reflection) | ||
| logger = ActiveSupport::Logger.new($stdout) | ||
| foreign_key = association.klass.primary_key | ||
| origin_key = @model.primary_key | ||
| logger.warn( | ||
| "[ForestAdmin] ⚠️ Association '#{association.name}' in model '#{@model.name}' is published " \ | ||
| "as a read-only one-to-one joining '#{format_model_name(association.klass.name)}'.'#{foreign_key}' " \ | ||
| "to this model's own '#{origin_key}': it's a has_one chained through " \ | ||
| "'#{format_model_name(through_reflection.klass.name)}', which OneToOneSchema can't express as a " \ | ||
| 'real two-hop join -- see #379 for background.' | ||
| ) | ||
| end | ||
|
|
||
| def warn_missing_polymorphic_columns(association) | ||
| missing_columns = [] | ||
| missing_columns << association.foreign_key unless schema[:fields][association.foreign_key] | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.