[benjaminwil]

Summary

This pull request creates a bespoke component for selecting taxons from a list of all of a store's taxons. This resolves #6643.

It also starts using the new component in two existing templates.

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

• I agree that my PR will be published under the same license as Solidus.
• I have written a thorough PR description.
• I have kept my commits small and atomic.
• I have localized any and all user-facing strings that I added to the source code.¹
• I have used clear, explanatory commit messages.

The following are not always needed:

• 📖 I have updated the README to account for my changes.
• 📑 I have documented new code with YARD.
• 🛣️ I have opened a PR to update the guides.
• ✅ I have added automated tests to cover my changes.
• 📸 I have attached screenshots to demo visual changes.

Footnotes

1. There is a JavaScript console error hard-coded in English. The intended audience is developers, though, not customers. ↩

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.48%. Comparing base (6f5b2b9) to head (3b7d2fa).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6653   +/-   ##
=======================================
  Coverage   92.47%   92.48%           
=======================================
  Files        1065     1066    +1     
  Lines       21541    21555   +14     
=======================================
+ Hits        19921    19935   +14     
  Misses       1620     1620           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[tvdeyen]

We should use the configured routes by using the routes helpers we have available in components, via the helpers proxy.

[benjaminwil]

I still think this is worth reviewing right now, but I have to go back and re-evaluate the tests due to timing issues.

There are indications that the remote data is not being loaded fast enough for the feature tests to fail. We're not waiting in quite the right ways.

[tvdeyen]

Looking good.

[tvdeyen]

This should be the default anyway, no?

Suggested change

	multiple: false %>
	%>

[benjaminwil]

From a data perspective, I thought that multiple: true makes sense as a default. Since you'd almost always want a collection of taxons to be associated with something.

But maybe from a developer experience perspective you're more correct.

[benjaminwil]

@tvdeyen @jarednorman I don't feel strongly about this, but I've left it with a multiple: true default for now. This felt like the natural thing to do, due to the method name (.select_taxons plural).

If you all feel strongly in the other direction, I can change this.

[benjaminwil]

There are indications that the remote data is not being loaded fast enough for the feature tests to fail. We're not waiting in quite the right ways.

I was wrong. The issue was that using URL helpers via SolidusAdmin::Engine needed to be explicitly configured for the test environment. I have added a commit that does this.

[jarednorman]

In my local testing this still caused issues outside of tests because the host wasn't set because this doesn't have a request context, but this complicates the JS.

What if we just add a taxon select component that renders our select component from the view layer and avoids all of this complexity.

[benjaminwil]

I'm not opposed to doing it that way.

But maybe it's worth discussing more? I feel like all of this is pointing to the fact that it's not easy enough to create select components that use remote data sources. Do we want to (and do we want application developers to) have to write view partials every time we (they) want a mildly complex select component in the admin interface?

I think the complexity is reasonably reduced if we can pass paths (rather than URLs) to the solidus_select.js we've built on top of Tom Select.

cc @tvdeyen

[jarednorman]

I don't have a strong preference either way. If accepting paths makes stuff easier and is reasonably easy to do, that approach has my blessing.

[tvdeyen]

Yes. What Jared says.

[benjaminwil]

@jarednorman @tvdeyen I added a new commit that tackles this issue by allowing the use of path helpers.

I chose this route because:

1. Currently the component is just a class method on the Form::Field::Component, so there would be some indirection and a lot more code to make a new component and component template. (Said another way: less code this way.)
2. I think I was able to offset the complexity of getting URLs in a reasonable way, after all. See the Apply host URL to solidus_select data-srcs commit.

Let me know what y'all think.

[benjaminwil]

Jared located the real issue with paths, which was actually a missing fallback URL in the Tom Select remote_with_pagination plugin code. So I think that makes a lot of the issues we were discussing go away. 👍

[jarednorman]

There's a race condition in admin/lib/solidus_admin/testing_support/feature_helpers.rb#51-58 that I think needs fixing as part of this.

[benjaminwil]

Just rebased against main to resolve conflicts after #6654 was merged.

[jarednorman]

I don't like the choice to skip auth. We need a pattern to handle routes like this properly. Just because it's safe here and now doesn't mean someone isn't going to customize these endpoints expecting them to be limited to admins.