Backend: Make order search fields configurable #5776
Merged
Conversation
This file contains 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
github-actions
bot
added
the
changelog:solidus_backend
mamhoff
force-pushed
the
configurable-index-filters
branch
2 times, most recently
from
748932b
to
d661790
Compare
mamhoff
force-pushed
the
configurable-index-filters
branch
from
77d6b19
to
257c000
Compare
|
Failing because of rails/sprockets-rails#524 |
The order search depends on legacy promotion system associations to be
present, but we don't want to introduce Deface as a core dependency.
Therefore, we must make the search fields for orders configurable.
This introduces a new configuration option on the Backend configuration:
`Spree::Backend::Config.search_fields`. This Hash has controller paths
as keys, and arrays that holds hashes with a `:partial` key that indicates
which partial should render this search field.
Optionally, one can specify an `:if` key with a lambda as the value that
gets executed at runtime, so that unnecessary fields ("Store" for
installations with only one store instance) are not displayed.
Complex fields can be done by specifying a custom partial, such as the
`:date_range_picker` partial in this PR.
The third key, `:locals` contains a has of the local variables inside
the partial. Anything that needs to be computed dynamically should be
done with a lambda here.
mamhoff
force-pushed
the
configurable-index-filters
branch
from
257c000
to
05ca204
Compare
This search field depends on the `Spree::Order#promotions` relation to be available and searchable. This is not given with a null promotion system or the upcoming new promotion system, where relations will have a different name. So we only add it if solidus_legacy_promotions is also loaded.
mamhoff
force-pushed
the
configurable-index-filters
branch
from
05ca204
to
800d0f8
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5776 +/- ##
==========================================
+ Coverage 88.87% 88.89% +0.01%
==========================================
Files 711 711
Lines 16885 16906 +21
==========================================
+ Hits 15007 15028 +21
Misses 1878 1878 ☔ View full report in Codecov by Sentry. |
kennyadsl
approved these changes
Jun 7, 2024
There was a problem hiding this comment.
For the CHANGELOG entry:
If there are deface overrides with order search classes as targets, they need to be converted into search fields via preferences.:
Spree::Backend::Config.search_fields["spree/admin/orders"].push({
partial: "spree/admin/shared/search_fields/date_range_picker",
locals: {
attribute: :shipped_at,
label: -> { I18n.t(:date_range, scope: :spree) }
}
})
tvdeyen
approved these changes
Jun 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The order search depends on legacy promotion system associations to be present, but we don't want to introduce Deface as a core dependency. Therefore, we must make the search fields for orders configurable.
This introduces a new configuration option on the Backend configuration:
Spree::Backend::Config.order_search_fields. This Array holds hashes with a:partialkey that indicates which partial should render this search field.Optionally, one can specify an
:ifkey with a lambda as the value that gets executed at runtime, so that unnecessary fields ("Store" for installations with only one store instance) are not displayed.Complex fields can be done by specifying a custom partial, such as the
:date_range_pickerpartial in this PR.Labels for the search fields can be specified as two-value arrays that represent arguments to
I18n.t. By the time this array is loaded,I18ndoes not have its translations loaded, so I have to go this somewhat complicated route.Because the input fields have to be a flat list now, we can't do the sorting into columns thing we did before, but we can use a column for each input to make things flow nicely.
Before:
After:
Checklist
Check out our PR guidelines for more details.
The following are mandatory for all PRs: