Refine implicit relationships #1446

lgebhardt · 2024-01-29T16:35:24Z

Fixes an issue where v09 was missing polymorphic linkages. This again brings up the need to some consistency testing between the various resource retrieval strategies.

Better tracks the implicitly created polymorphic relationships. And by default will prevent them from being included.

All Submissions:

I've checked to ensure there aren't other open Pull Requests for the same update/change.
I've submitted a ticket for my issue if one did not already exist.
My submission passes all tests. (Please run the full test suite locally to cut down on noise from travis failures.)
I've used Github auto-closing keywords in the commit message or the description.
I've added/updated tests for this change.

New Feature Submissions:

I've submitted an issue that describes this feature, and received the go ahead from the maintainers.
My submission includes new tests.
My submission maintains compliance with JSON:API.

Bug fixes and Changes to Core Features:

I've included an explanation of what the changes do and why I'd like you to include them.
I've provided test(s) that fails without the change.

Test Plan:

Reviewer Checklist:

Maintains compliance with JSON:API
Adequate test coverage exists to prevent regressions

- also add dependabot workflow - also standardize rails/ruby version quoting/ordering

* refactor: easily quote table/column * refactor: extract table name when missing * fix: Reliably quote columns/tables * refactor: putting quoting methods together * Handle special case of * - tests * fix: hack mysql test query comparison

* fix: test the adapter-specific query ordering * test: make order independent * test: sort order-dependent response * test: skip failing mysql tests as ok for now

* Restore previous include directives behavior * Default sort use _primary_key * Remove support for pluck attributes * Pass relationship instead of relationship name * Update copyright date * Ignore docker-compose override files * add _relation_name method * Rework resource class to support using modules for retrieving resources by way of a `resource_retrieval_strategy` Removes BasicResource class and replaces ActiveRelationResource with a module * Use `_relationship` helper method * Add ActiveRelationRetrieval Allows retrieval of resources by querying the primary table and joining the source table - the opposite of the v10 version * Skip extra pluck queries when not caching a resource * Test Cleanup * Adjust tested query counts based on default_resource_retrieval_strategy * create_implicit_polymorphic_type_relationships * Add ActiveRelationRetrievalV09 * Move resource down in the load order * Use underscore instead of downcase * Refactor Resource to load retrieval strategy as class loads * Simplify loading resource retrieval strategy modules Add SimpleResource that does not load a resource retrieval strategy module * Remove no longer need deferred_relationship code * Add warning about potentially unused `records_for_populate` * Rework loading the resource_retrieval_strategy to fix issue in real projects * Use SortedSets for resource_identities * Add sorted_set gem * Remove rails 5 support

* fix: warnings * fix: warning * fix: warnings

* Restore `use_related_resource_records_for_joins` for v0_10 * Handle nil actual hashes * Add back join_options for v10 compatibility * Test JoinManager not JoinManagerV10 * Use sql_for_compare to account for different sql dialect quoating

handle gems like GraphQL which override `include?` ``` rake aborted! ArgumentError: wrong number of arguments (given 1, expected 3) gems/graphql-2.0.13/lib/graphql/schema/directive.rb:58:in `include?' ```

* Cleanup table definitions for Rails 7.1 * Test helper move require 'rails/test_help' * Test helper add `config.hosts` * Update test matrix to add rails 7.1 and remove ruby 2.6 Note: ruby 2.7 is also EOL, but I'm choosing to continue testing 2.7 for now

#1421) * Namespace references to Rails using `::Rails` to avoid conflicts with other gems * Use uppercase JSONAPI module name

* Make SortedSet for identity arrays optional * Fix tests to use sort_related_identities_by_primary_key option override * Keep SortedSet as a development dependency, unless required * Remove sorted_set dependency * Add better messaging about using SortedSet * Clarify setting sort_criteria for includes vs. related resources

Removes the need to allocate a new array for every comparison

add tests for ResourceIdentity, including that comparison does not allocate memory

* Reduce number of string allocations in LinkBuilder * Consistently access `include_related` * Remove unused class variable * Cache `id` after retrieving it from the model * Cache `module_path` * Cache resource_klass_for and resource_type_for * Remove no longer used method _setup_relationship * Delete nil values without creating a new object * Rework resource naming for method caches

* fix: check if relation retrieval in included via included_modules * require 'jsonapi/relation_retrieval' * feat: raise when cannot include different retrieval strategy * test: multiple retrieval strategies --------- Co-authored-by: lgebhardt <[email protected]>

* refactor: lookup polymorphic types only once * refactor: polymorphic lookups to utility module * refactor: separate polymorphic functions * Refactor into PolymorphicTypesLookup --------- Co-authored-by: lgebhardt <[email protected]>

* feat: teach JR in tests to parse the response * use response.parsed_body instead of JSON.parse when evaluating responses in tests --------- Co-authored-by: lgebhardt <[email protected]>

* chore(deprecation): test_fixture= has been deprecated in favor of tests_fixtures= * chore(deprecations): ActiveSupport::Deprecation.silenced ``` ActiveSupport::Deprecation is deprecated and will be removed from Rails (use Rails.application.deprecators.silenced= instead) ``` * chore(deprecation): prefer ActiveSupport.deprectator or our own deprecator. since https://github.com/rails/rails/pull/47354/files

* test: failing request posting sti with polymorphic has one * fix: polymorphic resource assignment * Add polymorphic_type_for method * Favor classify over singularize.camelize --------- Co-authored-by: lgebhardt <[email protected]>

* chore: fix file typo * fix: railtie to use correct load hook

* fix: more flexible polymorphic types lookup * test: add polymorphic lookup tests they pass on v-11-dev I'm going to look into the existing lookup warnings now ``` [POLYMORPHIC TYPE NOT FOUND] No polymorphic types found for fileable [POLYMORPHIC TYPE] No polymorphic types found for FilePropertiesResource fileable [POLYMORPHIC TYPE NOT FOUND] No polymorphic types found for respondent [POLYMORPHIC TYPE] No polymorphic types found for QuestionResource respondent [POLYMORPHIC TYPE NOT FOUND] No polymorphic types found for respondent [POLYMORPHIC TYPE] No polymorphic types found for AnswerResource respondent [POLYMORPHIC TYPE NOT FOUND] No polymorphic types found for keepable [POLYMORPHIC TYPE] No polymorphic types found for KeeperResource keepable ``` * Revert "test: add polymorphic lookup tests" This reverts commit 0979a7243b6bc816dd2327d3ff23f70209c52dce. * feat: easily clear the lookup * feat: add a descendents strategy * test: polymorphic type lookup * feat: make polymorphic type lookup configurable * feat: clear polymorphic lookup after initialize

* Add warning about disabling eager loading * Fix overriding polymorphic types on a relationship

bf4 · 2024-01-29T21:54:04Z

lib/jsonapi/relationship.rb

+                :inverse_relationship,
+                :hidden,
+                :use_related_resource_records_for_joins,
+                :find_related_through,


🆕 find_related_through

(but not used)

bf4 · 2024-01-29T21:54:13Z

lib/jsonapi/relationship.rb

+                :hidden,
+                :use_related_resource_records_for_joins,
+                :find_related_through,
+                :implicit_relationship,


🆕 implicit_relationship

bf4 · 2024-01-29T21:54:20Z

lib/jsonapi/relationship.rb

+                :use_related_resource_records_for_joins,
+                :find_related_through,
+                :implicit_relationship,
+                :polymorphic_type_relationship_for


🆕 polymorphic_type_relationship_for

bf4 · 2024-01-29T21:56:45Z

lib/jsonapi/relationship.rb

@@ -37,6 +52,8 @@ def initialize(name, options = {})

      @hidden = options.fetch(:hidden, false) == true

+      @polymorphic_type_relationship_for = options[:polymorphic_type_relationship_for]


how is this different from polymorphic_relations?

bf4 and others added 30 commits September 19, 2023 14:22

deps: Add MySQL to CI workflow (#1398)

be970f4

- also add dependabot workflow - also standardize rails/ruby version quoting/ordering

fix: Reliably quote columns/tables (#1400)

896459c

* refactor: easily quote table/column * refactor: extract table name when missing * fix: Reliably quote columns/tables * refactor: putting quoting methods together * Handle special case of * - tests * fix: hack mysql test query comparison

Add docker testing setup (#1403)

1da2cb7

fix: test the adapter-specific query ordering (#1402)

f2bcba9

* fix: test the adapter-specific query ordering * test: make order independent * test: sort order-dependent response * test: skip failing mysql tests as ok for now

Add frozen_string_literal: true

c70bd4c

Restore missing requires

2f69096

fix: warnings (#1401)

ac46d89

* fix: warnings * fix: warning * fix: warnings

Bump jsonapi-resources to 0.11.0.beta2

bdce601

fix: more reliable check of module is included (#1418)

81e4ecf

handle gems like GraphQL which override `include?` ``` rake aborted! ArgumentError: wrong number of arguments (given 1, expected 3) gems/graphql-2.0.13/lib/graphql/schema/directive.rb:58:in `include?' ```

Namespace references to Rails using ::Rails to avoid conflicts with… (

1bdacf1

#1421) * Namespace references to Rails using `::Rails` to avoid conflicts with other gems * Use uppercase JSONAPI module name

chore: remove sorted_set dependency (#1423)

ef0551d

Store the resource_klass and id in an array for efficiency (#1428)

cd1a529

Removes the need to allocate a new array for every comparison

Rework ResourceIdentity <=> operator (#1430)

0bbbc0b

add tests for ResourceIdentity, including that comparison does not allocate memory

refactor: separate polymorphic functions (#1433)

76ef777

* refactor: lookup polymorphic types only once * refactor: polymorphic lookups to utility module * refactor: separate polymorphic functions * Refactor into PolymorphicTypesLookup --------- Co-authored-by: lgebhardt <[email protected]>

feat: teach JR in tests to parse the response (#1437)

f193a35

* feat: teach JR in tests to parse the response * use response.parsed_body instead of JSON.parse when evaluating responses in tests --------- Co-authored-by: lgebhardt <[email protected]>

fix: railtie to use correct load hook (#1438)

e4c9707

* chore: fix file typo * fix: railtie to use correct load hook

Update the testing matrix (#1442)

c529c23

Polymorphic types override per relationship (#1440)

f75acdb

* Add warning about disabling eager loading * Fix overriding polymorphic types on a relationship

Fix issue with relationship sorts due to missing join_manager (#1443)

07888a9

Define relationships more consistently

cccd332

Rework implicit relationships

7084ffa

lgebhardt marked this pull request as ready for review January 29, 2024 16:46

lgebhardt requested a review from bf4 January 29, 2024 18:58

bf4 reviewed Jan 29, 2024

View reviewed changes

lgebhardt force-pushed the v0-11-dev branch from 2cd1dc8 to 05c10bd Compare April 18, 2024 16:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refine implicit relationships #1446

Refine implicit relationships #1446

lgebhardt commented Jan 29, 2024 •

edited

Loading

bf4 Jan 29, 2024

bf4 Jan 29, 2024

bf4 Jan 29, 2024

bf4 Jan 29, 2024

bf4 Jan 29, 2024

		@@ -37,6 +52,8 @@ def initialize(name, options = {})

		@hidden = options.fetch(:hidden, false) == true

		@polymorphic_type_relationship_for = options[:polymorphic_type_relationship_for]

Refine implicit relationships #1446

Are you sure you want to change the base?

Refine implicit relationships #1446

Conversation

lgebhardt commented Jan 29, 2024 • edited Loading

All Submissions:

New Feature Submissions:

Bug fixes and Changes to Core Features:

Test Plan:

Reviewer Checklist:

bf4 Jan 29, 2024

Choose a reason for hiding this comment

bf4 Jan 29, 2024

Choose a reason for hiding this comment

bf4 Jan 29, 2024

Choose a reason for hiding this comment

bf4 Jan 29, 2024

Choose a reason for hiding this comment

bf4 Jan 29, 2024

Choose a reason for hiding this comment

lgebhardt commented Jan 29, 2024 •

edited

Loading