Fix Ensure check methods can't modify tokens array and add Ruby 3.4 testing
#233
+46
−28
Conversation
This file contains hidden or 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
alexjfisher
force-pushed
the
fix_duplicated_tokens
branch
from
2257895 to
ec82d69
Compare
|
After a bit more testing, it looks like |
|
lol |
The functionality originally released in rodjek#296 was probably broken at the time, possibly made worse by later rubocop 'fixes' and also incompatible with ruby 3.4. We now look at the stack trace only from the `tokens` wrapper method in `checkplugin`. Fixes puppetlabs#225
alexjfisher
force-pushed
the
fix_duplicated_tokens
branch
from
ec82d69 to
ff0337e
Compare
ekohl
reviewed
Feb 14, 2025
| @tokens | ||
| end | ||
| def tokens(duplicate: false) | ||
| duplicate ? @tokens.dup : @tokens |
There was a problem hiding this comment.
I had a crazy thought: rather than duplicating, would it make sense to freeze it? https://rubyapi.org/o/array#method-i-freeze says it will not do anything if already frozen, so should be cheap and you can't modify it.
There was a problem hiding this comment.
There wasn't much information I could find about to why this was originally introduced, but other methods (such as fix) definitely do need to be able to modify the array.
| end | ||
|
|
||
| def fix | ||
| tokens << :fix_token |
There was a problem hiding this comment.
I don't think this is supposed to be a valid API because there's also the add_token to actually modify it.
| def check | ||
| # Since we're calling `tokens` from a `check` method, we should get our own Array object. | ||
| # If we add an extra token to it, PuppetLint::Data.tokens should remain unchanged. | ||
| tokens << :extra_token |
There was a problem hiding this comment.
When returning a frozen array it will raise a FrozenError. Perhaps we should catch that and raise a deprecation warning?
|
Any progress here? I think more and more people are stumbling over this issue 🙂 |
|
hello, when is please planned next release of puppet-lint? |
|
I raised a support ticket for this: #01446430 |
SimonHoenscheid
approved these changes
Sep 23, 2025
LukasAud
changed the title
Ensure check methods can't modify tokens arrayEnsure check methods can't modify tokens array and add Ruby 3.4 testing
bastelfreak
added a commit
to bastelfreak/voxpupuli-puppet-lint-plugins
that referenced
this pull request
Sep 25, 2025
This pulls in three bigger changes in puppet-lint: * Avoid using the manifest lexer on YAML [#239](puppetlabs/puppet-lint#239) (tokenrove) * Add abstract data types to lexer type tokens list [#240](puppetlabs/puppet-lint#240) (kenyon) * Fix Ensure check methods can't modify tokens array and add Ruby 3.4 testing [#233](puppetlabs/puppet-lint#233) (alexjfisher) In a previous PR, voxpupuli#64, we switched to Ruby 3.2 as a minimal Ruby version. The new puppet-lint release did a Ruby version bump. We don't want to end up in a situation where different users have different ruby versions, which leads to different puppet-lint versions, which leads to different linting of your puppet code. Because of that, we cannot allow puppet-lint 4 & 5, but have to pint to 5.1 (5.0 doesn't support Ruby 3.4). All puppet-lint plugins were also updated for puppet-lint 5.1, which also required major releases.
bastelfreak
added a commit
to bastelfreak/voxpupuli-puppet-lint-plugins
that referenced
this pull request
Sep 25, 2025
This pulls in three bigger changes in puppet-lint: * Avoid using the manifest lexer on YAML [#239](puppetlabs/puppet-lint#239) (tokenrove) * Add abstract data types to lexer type tokens list [#240](puppetlabs/puppet-lint#240) (kenyon) * Fix Ensure check methods can't modify tokens array and add Ruby 3.4 testing [#233](puppetlabs/puppet-lint#233) (alexjfisher) In a previous PR, voxpupuli#64, we switched to Ruby 3.2 as a minimal Ruby version. The new puppet-lint release did a Ruby version bump. We don't want to end up in a situation where different users have different ruby versions, which leads to different puppet-lint versions, which leads to different linting of your puppet code. Because of that, we cannot allow puppet-lint 4 & 5, but have to pint to 5.1 (5.0 doesn't support Ruby 3.4). All puppet-lint plugins were also updated for puppet-lint 5.1, which also required major releases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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 functionality originally released in rodjek#296 was probably broken at the time, possibly made worse by later rubocop 'fixes' and also incompatible with ruby 3.4.
We now look at the stack trace only from the
tokenswrapper method incheckplugin.Fixes #225