Add strict helpers #1987

reeganviljoen · 2024-02-12T07:23:31Z

closses #1976

What are you trying to accomplish?

Add a config.view_component.strict_helpers_enabled mode to view component which will throw an ViewComponent::StrictHelperError when helpers.<some_helper> is used.

This

What approach did you choose and why?

Anything you want to highlight for special attention from reviewers?

joelhawksley

One thought on naming.

As a bigger question: what happens if one turns this on for their app and then wants to use a gem that provides ViewComponents that use helpers?

joelhawksley · 2024-02-14T21:31:28Z

lib/view_component/base.rb

@@ -224,7 +232,7 @@ def controller
    # @return [ActionView::Base]
    def helpers
      raise HelpersCalledBeforeRenderError if view_context.nil?
-
+      raise StrictHelperError if ViewComponent::Base.config.strict_helpers_enabled


I wonder if this feature might be less confusing if we just had it be config.helpers_enabled and defaulting it to true?

@joelhawksley I think that's a good idea, when I have some time I will apply this feedback

@joelhawksley I have changed the config to this, if you could review it again it would be a massive

joelhawksley · 2024-03-04T22:35:57Z

@reeganviljoen thoughts on my comment from my review above?

As a bigger question: what happens if one turns this on for their app and then wants to use a gem that provides ViewComponents that use helpers?

reeganviljoen · 2024-03-06T06:01:34Z

One thought on naming.

As a bigger question: what happens if one turns this on for their app and then wants to use a gem that provides ViewComponents that use helpers?

@joelhawksley I don't think this will break any existing gems, unless the user enables the config, however if the user does, it might not work unless the gem documents which helpers are used so the user can add them themselves with the use_helpers method

I do think this is a positive improvement however, as just adding helpers increases coupling to global state, which I feel is bad and is against the whole point of view_component. If a gem wants to add helpers they should let the user decide what helpers and how much coupling to global state they want

boardfish · 2024-03-07T07:59:48Z

If a gem providing ViewComponents uses helpers, I'm not sure we should mandate that it's subject to strict_helpers in the same way as the rest of the app.

Gems providing components that use helpers would need to be updated to use the new syntax, and waiting on providers to do that doesn't feel like an ideal experience for devs using ViewComponent to me. It's absolutely something gem maintainers should do post-haste, but I think configuration could make the transition period easier for consumers of these gems.

I can see us going a few different ways with this:

Gems adhere to their own configuration. I don't think there's a layer of config in place to do this just yet – gems still inherit from app config.
Enabling strict_helpers enforces this for gems too. Making this available as an option would be good, but I don't think it should be the only one.
We expose a lambda for strict_helpers. This could allow folks the flexibility to allowlist on a gem-by-gem basis, or report strict helper violations (e.g. to an error reporting platform/in logs). I'd like to see this become something we do more often potentially. If we introduce configuration that controls a breaking change, this would be good to allow folks to understand (through their test suite or at runtime) where changes need to be made.

I'm sure there are options beyond that, but that's what comes to mind right now. Any thoughts?

joelhawksley · 2024-03-07T19:52:32Z

@boardfish thanks for sharing your concerns- I generally agree with you.

I think we might be better off having this be a macro folks can set on a component, likely on their ApplicationComponent.

reeganviljoen · 2024-03-14T13:40:00Z

@joelhawksley @boardfish noted, I wills see if I can work on something to macro based system working

danini-the-panini · 2024-07-04T07:47:39Z

I think we might be better off having this be a macro folks can set on a component, likely on their ApplicationComponent.

I am on board with this ☝🏻

Could we also allow it to be optionally a deprecation warning instead of an error, that way it won't break things but it will give devs the tool to migrate their existing components. This could be useful for e.g. very large code bases where it is infeasible to migrate all components at once

danini-the-panini · 2024-07-04T08:43:30Z

Another useful feature might be allowing to pass in a block that gets called every time helpers is referenced, so that devs can hook into their error tracker e.g. Sentry

joelhawksley · 2024-08-02T15:16:17Z

@reeganviljoen just checking in- are you planning to complete this work?

reeganviljoen · 2024-08-02T15:34:31Z

@joelhawksley Absolutely, just been verry busy

reeganviljoen · 2024-08-07T19:31:42Z

@joelhawksley what do you think about @danini-the-panini comment, I think its a good idea, I could work that into our current instrumentation setup in a seperate PR

reeganviljoen · 2024-08-07T19:34:33Z

@joelhawksley I think that this api is complete as the main concern was gem compatibility but the recent addition to use_helpers provides a path to working. with gems in a strict mode

joelhawksley · 2024-08-08T17:26:14Z

@reeganviljoen thanks for cleaning up this PR. For now, I'm going to mark it as blocked on @boardfish's work here: #1945 (comment) ❤️

boardfish · 2024-09-04T15:54:08Z

This might actually be ideal as the first component-local config option due to the small scope of the PR. I'll see if I can grab some time this weekend to figure out if I can use this to make a start.

boardfish · 2024-09-08T13:34:58Z

Had a very scrappy crack at this in 35017a9 – it looks possible, and we could probably even ship that with a few more tests behind it and some cleanup (still need to document things and get the use of the private variable names vs. public method names straight). Going forward, though, we probably want to make a nice internal DSL that'll support migrating these config options across slowly but surely.

reeganviljoen · 2024-09-08T17:36:14Z

@boardfish I aprreciate the help, if you want to pair on this issue I be happy to help.

boardfish · 2024-09-08T18:40:08Z

There's perhaps an even cleaner solution in ActiveSupport::Configurable that I've now found - we were previously including this but hadn't perhaps used it to its full extent as far as I'm aware. I've got a busy week ahead but I'd like to look at wrapping it up as soon as I can to unblock you - I'd appreciate any early feedback anyone has on the PR.

joelhawksley · 2025-03-13T18:08:04Z

@reeganviljoen I'm going to move this to draft as it is pretty out of date and remains blocked by @boardfish's work ❤️

boardfish · 2025-03-14T12:31:57Z

Hopefully it should be unblocked soon – I need to extract the component-local config work out of #2210 so that we can introduce this in V3.

reeganviljoen · 2025-03-18T05:48:31Z

@joelhawksley I am sorry I haven't been too active lately, but I will be taking a look at this shortly

@boardfish I would really appreciate that but no rush, if push comes to shove I will rebase this branch to get something workable

boardfish · 2025-03-18T09:06:36Z

@reeganviljoen #2230 is in a position that you now may want to rebase off that branch instead. (Easier said than done by the looks of things – let me know if you need any help, and you can always force this branch back to 51e99fb (its current most recent commit) if things go sideways!)

joelhawksley · 2025-05-07T17:50:15Z

@reeganviljoen I believe this PR is no longer blocked. Are you still hoping to land it?

reeganviljoen · 2025-05-08T15:48:42Z

@joelhawksley Ill get working on it now, thanks

ViewComponent::Base itself will always use the defaults. Any classes inheriting from ViewComponent::Base will cascade config down using InheritableOptions, only specifying any overrides. Generate options being on their own "layer of config is currently unresolved - it might be that config needs to be a new object inheriting from InheritableOptions that has method accessors for everything in that namespace. This was initially written to support extracting the incoming strict_helpers_enabled? option, but applies to everything.

…config as necessary

No settings actually use it, but this would be the way to introduce it once we come to need it.

reeganviljoen requested a review from boardfish as a code owner February 12, 2024 07:23

reeganviljoen requested review from camertron, joelhawksley, boardfish and BlakeWilliams and removed request for boardfish February 12, 2024 07:23

reeganviljoen force-pushed the rv-add-strict-helpers branch from d6fe052 to 3c74fd8 Compare February 12, 2024 07:27

joelhawksley reviewed Feb 14, 2024

View reviewed changes

reeganviljoen requested a review from joelhawksley March 4, 2024 06:18

joelhawksley mentioned this pull request Mar 29, 2024

Rails Engine support #1945

Closed

reeganviljoen mentioned this pull request May 27, 2024

Add from to use_helpers to add macro like syntax #2034

Merged

joelhawksley added the blocked label Aug 8, 2024

reeganviljoen mentioned this pull request Aug 9, 2024

Add helper instrumentation #2072

Closed

boardfish mentioned this pull request Sep 8, 2024

WIP: Extract strict_helpers_enabled? to component-local config #2092

Closed

boardfish force-pushed the introduce-component-local-config branch from 3ef2840 to 51e99fb Compare January 27, 2025 18:03

joelhawksley marked this pull request as draft March 13, 2025 18:08

reeganviljoen changed the base branch from introduce-component-local-config to main May 8, 2025 15:50

reeganviljoen removed the blocked label May 8, 2025

boardfish and others added 18 commits May 8, 2025 17:52

Source test controller from Rails config if available

84f2df8

Make GlobalConfig a proxy for Rails app config or ViewComponent base …

e234efb

…config as necessary

Ensure Rails.application is defined, use in preview source feature

58608f0

Use GlobalConfig as config entrypoint in test engine

7a6541a

Don't attempt to write to show_previews_source in engine initializer

bb88a9d

Remove component-local config for now

cc037b4

No settings actually use it, but this would be the way to introduce it once we come to need it.

Lint

5052b30

add: use_helper to base

8303eaf

add: strict helpers

2c6faaa

Merge branch 'main' into rv-add-strict-helpers

44e4aae

fix tests

d7d684f

replace helper delegation with use_helpers

0132c59

replace strict_helpers_enabled with helpers_enabled

1a98e04

add: test for missing coverage

56efc0b

fix: comment location for csrf and csp nonces

6a447d0

update changelog

5381fc6

Derive strict_helpers_enabled from component-local config

94fa1ed

reeganviljoen force-pushed the rv-add-strict-helpers branch from dbfc516 to 94fa1ed Compare May 8, 2025 16:33

dix sopme trebase issue

26d02fe

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add strict helpers #1987

Add strict helpers #1987

reeganviljoen commented Feb 12, 2024

joelhawksley left a comment

joelhawksley Feb 14, 2024

reeganviljoen Feb 16, 2024

reeganviljoen Mar 4, 2024

joelhawksley commented Mar 4, 2024

reeganviljoen commented Mar 6, 2024 •

edited

Loading

boardfish commented Mar 7, 2024 •

edited

Loading

joelhawksley commented Mar 7, 2024

reeganviljoen commented Mar 14, 2024 •

edited

Loading

danini-the-panini commented Jul 4, 2024 •

edited

Loading

danini-the-panini commented Jul 4, 2024

joelhawksley commented Aug 2, 2024

reeganviljoen commented Aug 2, 2024

reeganviljoen commented Aug 7, 2024

reeganviljoen commented Aug 7, 2024 •

edited

Loading

joelhawksley commented Aug 8, 2024

boardfish commented Sep 4, 2024

boardfish commented Sep 8, 2024

reeganviljoen commented Sep 8, 2024

boardfish commented Sep 8, 2024

joelhawksley commented Mar 13, 2025

boardfish commented Mar 14, 2025

reeganviljoen commented Mar 18, 2025

boardfish commented Mar 18, 2025

joelhawksley commented May 7, 2025

reeganviljoen commented May 8, 2025

Add strict helpers #1987

Are you sure you want to change the base?

Add strict helpers #1987

Conversation

reeganviljoen commented Feb 12, 2024

What are you trying to accomplish?

What approach did you choose and why?

Anything you want to highlight for special attention from reviewers?

joelhawksley left a comment

Choose a reason for hiding this comment

joelhawksley Feb 14, 2024

Choose a reason for hiding this comment

reeganviljoen Feb 16, 2024

Choose a reason for hiding this comment

reeganviljoen Mar 4, 2024

Choose a reason for hiding this comment

joelhawksley commented Mar 4, 2024

reeganviljoen commented Mar 6, 2024 • edited Loading

boardfish commented Mar 7, 2024 • edited Loading

joelhawksley commented Mar 7, 2024

reeganviljoen commented Mar 14, 2024 • edited Loading

danini-the-panini commented Jul 4, 2024 • edited Loading

danini-the-panini commented Jul 4, 2024

joelhawksley commented Aug 2, 2024

reeganviljoen commented Aug 2, 2024

reeganviljoen commented Aug 7, 2024

reeganviljoen commented Aug 7, 2024 • edited Loading

joelhawksley commented Aug 8, 2024

boardfish commented Sep 4, 2024

boardfish commented Sep 8, 2024

reeganviljoen commented Sep 8, 2024

boardfish commented Sep 8, 2024

joelhawksley commented Mar 13, 2025

boardfish commented Mar 14, 2025

reeganviljoen commented Mar 18, 2025

boardfish commented Mar 18, 2025

joelhawksley commented May 7, 2025

reeganviljoen commented May 8, 2025

reeganviljoen commented Mar 6, 2024 •

edited

Loading

boardfish commented Mar 7, 2024 •

edited

Loading

reeganviljoen commented Mar 14, 2024 •

edited

Loading

danini-the-panini commented Jul 4, 2024 •

edited

Loading

reeganviljoen commented Aug 7, 2024 •

edited

Loading