Add a default_include_tree config variable to ActiveModel::Serializer #1426

Empact · 2016-01-12T22:34:18Z

This is useful to set application-wide default behavior - e.g. in
previous versions of AMS the default behavior was to serialize the
full object graph by default - equivalent to the '**' include tree.

Currently just the global setting, but I think this could also work
on a per-serializer basis, with more attention.

bf4 · 2016-01-12T22:50:57Z

lib/active_model/serializer/adapter/attributes.rb

@@ -4,7 +4,9 @@ module Adapter
      class Attributes < Base
        def initialize(serializer, options = {})
          super
-          @include_tree = IncludeTree.from_include_args(options[:include] || '*')
+          @include_tree = IncludeTree.from_include_args(
+            options[:include] || ActiveModel::Serializer.config.default_include_tree


s//ActiveModelSerializers.config

bf4 · 2016-01-12T22:58:12Z

rubocop failures

beauby · 2016-01-13T03:55:05Z

I 👍 the idea.

groyoh · 2016-02-25T01:57:04Z

docs/general/configuration_options.md

@@ -9,6 +9,8 @@ preferably inside an initializer.

 - `adapter`: The [adapter](adapters.md) to use. Possible values: `:attributes, :json, :json_api`. Default: `:attributes`.
 - `serializer_lookup_enabled`: When `false`, serializers must be explicitly specified. Default: `true`
+- `default_includes`: What relationships to serialize by default.  Default: `'*'`, which includes one level of related
+  objects. See [includes](adapters.md#included) for more info.


Shouldn't it be See [included] since the anchor is called included?

Hmm. I wrote this to match the config key, although I can see it being a little disconcerting to click through and find a different header. Of course, the thing actually being described is the include option, which doesn't match either of these 100%. And, of course, it's a little weird to be linking to docs for the JSON API adapter to show behavior that is also applicable to adapters like Attributes. 😞

You're right. What we're actually missing here is a general documentation of the include option for all the adapters.

noahsilas · 2016-03-01T21:28:51Z

Fixed conflicts, added changelog entry.

bf4 · 2016-03-02T00:09:49Z

@noahsilas looks good. I don't see the changelog...

noahsilas · 2016-03-02T01:17:41Z

D'oh. Updated again with the changelog entry.

bf4 · 2016-03-02T04:26:59Z

CHANGELOG.md

@@ -14,6 +14,7 @@ Features:
 - [#1454](https://github.com/rails-api/active_model_serializers/pull/1454) Add support for
  relationship-level links and meta attributes. (@beauby)
 - [#1340](https://github.com/rails-api/active_model_serializers/pull/1340) Add support for resource-level meta. (@beauby)
+- [#1426](https://github.com/rails-api/active_model_serializers/pull/1426) Add ActiveModelSerializers.config.default_includes (@empact)


@Empact @noahsilas put at top of features plz (sorry)

remear · 2016-03-15T14:34:00Z

Any progress on this?

noahsilas · 2016-05-09T23:45:28Z

I've rebased to fix merge conflicts, and updated tests to match feedback that we weren't covering the most common cases to use this config option. How do y'all feel now?

noahsilas · 2016-05-09T23:55:44Z

I'm surprised to see this build failing. It seems like this failure is related to the RuboCop 0.40 release. (https://github.com/bbatsov/rubocop/releases/tag/v0.40.0)

Running with 0.39 locally, there are no errors.

beauby · 2016-05-10T01:49:43Z

You have the full list of rubocop offences here.

remear · 2016-05-11T00:44:40Z

Would you please rebase this again to pull in the latest master that pins rubocop to 0.39.0.

hut8 · 2016-05-11T20:08:24Z

This is awesome - any chance of it being merged shorrtly?

bf4 · 2016-05-11T20:15:07Z

lib/active_model/serializer/associations.rb

+          @default_include_tree ||= ActiveModel::Serializer::IncludeTree.from_include_args(
+            ActiveModelSerializers.config.default_includes
+          )
+        end


nice 'cause easy to override. should this be a private api? I'd consider making it public, but no need to delay this PR

bf4 · 2016-05-11T20:19:45Z

Looks good to me, though I have some followup questions

noahsilas · 2016-05-12T21:52:02Z

I've updated the memoized default include tree to be used in more places. I made it a public API on ActiveModelSerializers, which has a couple of benefits:

Only one instance, instead of one instance per serializer class
Easy to clear this cache, for instance when testing different configurations (see test/action_controller/json/include_test.rb).

beauby · 2016-05-16T07:49:24Z

lib/active_model_serializers/adapter/attributes.rb

        @cached_attributes = options[:cache_attributes] || {}
+        @include_tree = \


No need for \ here.

@Empact, can you address this?

NullVoxPopuli · 2016-05-25T00:53:47Z

needs rebase :-(

noahsilas · 2016-05-25T17:54:09Z

Rebased :-)

This is useful to set application-wide default behavior - e.g. in previous versions of AMS the default behavior was to serialize the full object graph by default - equivalent to the '**' include tree. Currently just the global setting, but I think this could also work on a per-serializer basis, with more attention.

NullVoxPopuli · 2016-05-26T00:23:55Z

LGTM

hut8 · 2016-05-26T17:33:38Z

Thanks so much for this, @noahsilas and others! Awesome job 👍

Empact · 2016-05-26T23:19:53Z

Same, thanks @noahsilas for finishing it off. 👍

bf4 reviewed Jan 12, 2016
View reviewed changes

bf4 added C: Feature V: 0.10.x S: Changelog Missing labels Jan 12, 2016

bf4 added the S: Needs Submitter Response label Jan 19, 2016

noahsilas force-pushed the default-include branch from 9a0fbba to 0ea5328 Compare February 25, 2016 01:42

groyoh reviewed Feb 25, 2016
View reviewed changes

groyoh removed the S: Needs Submitter Response label Feb 25, 2016

noahsilas force-pushed the default-include branch from 0ea5328 to 2029ba5 Compare March 1, 2016 21:28

noahsilas force-pushed the default-include branch from 2029ba5 to 0b9d674 Compare March 2, 2016 01:16

bf4 reviewed Mar 2, 2016
View reviewed changes

noahsilas force-pushed the default-include branch 2 times, most recently from 8eb1ef4 to cfe798b Compare March 15, 2016 02:06

noahsilas mentioned this pull request Mar 15, 2016

Add :except as an option to Adapter::Attributes #1538

Closed

remear mentioned this pull request Mar 15, 2016

JSON API loading unnecessary relationships #1539

Closed

bf4 mentioned this pull request Apr 1, 2016

Optional fields in associations (priority on serializer) #1628

Closed

bf4 mentioned this pull request Apr 28, 2016

Allow configuration of the default include tree #1709

Closed

noahsilas force-pushed the default-include branch from cfe798b to 628fc58 Compare May 9, 2016 23:32

noahsilas mentioned this pull request May 10, 2016

Fix RuboCop 0.40 linter errors #1722

Merged

noahsilas force-pushed the default-include branch from 628fc58 to 2a5fac0 Compare May 11, 2016 00:47

bf4 reviewed May 11, 2016
View reviewed changes

bf4 added S: Needs followup and removed S: Changelog Missing labels May 11, 2016

noahsilas force-pushed the default-include branch from 2a5fac0 to e1def82 Compare May 12, 2016 21:49

beauby reviewed May 16, 2016
View reviewed changes

noahsilas force-pushed the default-include branch from e1def82 to ba6b211 Compare May 25, 2016 17:24

noahsilas force-pushed the default-include branch from ba6b211 to 8c18d18 Compare May 26, 2016 00:16

NullVoxPopuli merged commit 7d7329b into rails-api:master May 26, 2016

y-yagi mentioned this pull request Jun 1, 2016

respect config.default_includes in #serializable_hash #1762

Closed

bf4 added the C: Deep Nesting label Feb 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a default_include_tree config variable to ActiveModel::Serializer #1426

Add a default_include_tree config variable to ActiveModel::Serializer #1426

Empact commented Jan 12, 2016

bf4 Jan 12, 2016

bf4 commented Jan 12, 2016

beauby commented Jan 13, 2016

groyoh Feb 25, 2016

noahsilas Feb 25, 2016

groyoh Feb 25, 2016

noahsilas commented Mar 1, 2016

bf4 commented Mar 2, 2016

noahsilas commented Mar 2, 2016

bf4 Mar 2, 2016

noahsilas Mar 2, 2016

remear commented Mar 15, 2016

noahsilas commented May 9, 2016

noahsilas commented May 9, 2016

beauby commented May 10, 2016

remear commented May 11, 2016

hut8 commented May 11, 2016

bf4 May 11, 2016

bf4 commented May 11, 2016

noahsilas commented May 12, 2016

beauby May 16, 2016

NullVoxPopuli May 25, 2016

noahsilas May 26, 2016

NullVoxPopuli commented May 25, 2016

noahsilas commented May 25, 2016

NullVoxPopuli commented May 26, 2016

hut8 commented May 26, 2016

Empact commented May 26, 2016

		@cached_attributes = options[:cache_attributes] \|\| {}
		@include_tree = \

Add a default_include_tree config variable to ActiveModel::Serializer #1426

Add a default_include_tree config variable to ActiveModel::Serializer #1426

Conversation

Empact commented Jan 12, 2016

Choose a reason for hiding this comment

bf4 commented Jan 12, 2016

beauby commented Jan 13, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

noahsilas commented Mar 1, 2016

bf4 commented Mar 2, 2016

noahsilas commented Mar 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

remear commented Mar 15, 2016

noahsilas commented May 9, 2016

noahsilas commented May 9, 2016

beauby commented May 10, 2016

remear commented May 11, 2016

hut8 commented May 11, 2016

Choose a reason for hiding this comment

bf4 commented May 11, 2016

noahsilas commented May 12, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NullVoxPopuli commented May 25, 2016

noahsilas commented May 25, 2016

NullVoxPopuli commented May 26, 2016

hut8 commented May 26, 2016

Empact commented May 26, 2016