Add version_error_behavior config option

[modosc]

NOTE: all the specs pass locally but rubocop is failing on a complexity check - i'm unsure exactly how to simplify this code to satisfy rubocop without making the intent less clear. happy to hear suggestions? for now i've disabled the check around the offending method

Currently when creating a new versioned record an error is raised if the Version cannot be created - this is because #save! is used:

paper_trail/lib/paper_trail/record_trail.rb

Line 62 in 47dbc22

version.save!

However, when updating, using update_columns, or destroying a versioned record no error is raised if the Version cannot be created:

paper_trail/lib/paper_trail/record_trail.rb

Line 111 in 47dbc22

if version.save

paper_trail/lib/paper_trail/record_trail.rb

Line 301 in 47dbc22

version = versions_assoc.create(data)

paper_trail/lib/paper_trail/record_trail.rb

Line 84 in 47dbc22

version = @record.class.paper_trail.version_class.create(data)

This pr adds a always_raise_on_error global config option. When set, all of the above failures will raise an error.

Fixes #1449

Thank you for your contribution!

Check the following boxes:

• Wrote good commit messages.
• Feature branch is up-to-date with master (if not - rebase it).
• Squashed related commits together.
• Added tests.
• Added an entry to the Changelog if the new
  code introduces user-observable changes.
• The PR relates to only one subject with a clear title
  and description in grammatically correct, complete sentences.

[github-actions]

This PR has been automatically marked as stale due to inactivity.
The resources of our volunteers are limited.
If this is something you are committed to continue working on, please address any concerns raised by review and/or ping us again.
Thank you for all your contributions.

[modosc]

is there any chance of getting this looked at? silently not saving version data is a pretty serious issue imho.

[github-actions]

This PR has been automatically marked as stale due to inactivity.
The resources of our volunteers are limited.
If this is something you are committed to continue working on, please address any concerns raised by review and/or ping us again.
Thank you for all your contributions.

[modosc]

still not stale, still waiting for maintainers to chime in.

or alternately i'm happy to help out if someone wants to add permissions.

[jaredbeck]

Thanks for your contribution.

• Instead of a boolean configuration option, how about a Symbol, like version_error_behavior: :log # or :exception, :silent
• Please do not use rubocop: disable comments

i'm unsure exactly how to simplify this code to satisfy rubocop without making the intent less clear.

How about extracting private method(s)?

[modosc]

hi @jaredbeck

Instead of a boolean configuration option, how about a Symbol, like version_error_behavior: :log # or :exception, :silent

this would be a breaking change because of how the existing code works since currently an error is raised when creating but not updating. if that's ok then i'm happy to make the change.

[modosc]

• Please do not use rubocop: disable comments

i'm unsure exactly how to simplify this code to satisfy rubocop without making the intent less clear.

How about extracting private method(s)?

done.

[github-actions]

This PR has been automatically marked as stale due to inactivity.
The resources of our volunteers are limited.
If this is something you are committed to continue working on, please address any concerns raised by review and/or ping us again.
Thank you for all your contributions.

[modosc]

not stale, waiting for reviewers

[jrodden1]

not stale, waiting for reviewers

+1

I'm pretty sure I've run into this issue with it silently failing and not raising an error. In the past, I only caught it because I happened to watch some :debug console output and then fixed the code that was keeping the version from saving/updating.

It would be rather nice to have this option merged. I would tend to agree with @modosc that this bug when left unfixed causes data integrity / traceability issues and that feels fairly significant. #my2cents

[jaredbeck]

Instead of a boolean configuration option, how about a Symbol, like version_error_behavior: :log # or :exception, :silent

this would be a breaking change because of how the existing code works since currently an error is raised when creating but not updating. if that's ok then i'm happy to make the change.

How about version_error_behavior: :legacy # or :log, :exception, :silent? I'd like to have a single, unified configuration option.

[modosc]

Instead of a boolean configuration option, how about a Symbol, like version_error_behavior: :log # or :exception, :silent

this would be a breaking change because of how the existing code works since currently an error is raised when creating but not updating. if that's ok then i'm happy to make the change.

How about version_error_behavior: :legacy # or :log, :exception, :silent? I'd like to have a single, unified configuration option.

@jaredbeck i've made this change, please take a look. thanks!

[jaredbeck]

Looks great. I appreciate the thorough tests.

[jjb]

nice - should there be documentation for how to use this in the readme?

[modosc]

nice - should there be documentation for how to use this in the readme?

i will try to add some in the next few days