Error reporting improvements by dspinellis · Pull Request #92 · uutils/sed

dspinellis · 2025-06-16T11:47:02Z

This PR improves the quality of runtime error reporting to include the associated sed command location and also the input file location when needed.

codecov · 2025-06-16T11:49:33Z

Codecov Report

Attention: Patch coverage is 0% with 189 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (cb9f729) to head (ab07fd5).
Report is 16 commits behind head on main.

Files with missing lines	Patch %	Lines
src/uu/sed/src/error_handling.rs	0.00%	66 Missing ⚠️
src/uu/sed/src/processor.rs	0.00%	65 Missing ⚠️
src/uu/sed/src/compiler.rs	0.00%	24 Missing ⚠️
src/uu/sed/src/named_writer.rs	0.00%	20 Missing ⚠️
src/uu/sed/src/command.rs	0.00%	11 Missing ⚠️
src/uu/sed/src/fast_io.rs	0.00%	1 Missing ⚠️
src/uu/sed/src/script_line_provider.rs	0.00%	1 Missing ⚠️
src/uu/sed/src/sed.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff          @@
##            main     #92   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files         12      13    +1     
  Lines       2632    2716   +84     
  Branches     225     224    -1     
=====================================
- Misses      2632    2716   +84

Flag	Coverage Δ
macos_latest	`0.00% <0.00%> (ø)`
ubuntu_latest	`0.00% <0.00%> (ø)`
windows_latest	`0.00% <0.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

dspinellis · 2025-06-17T16:14:39Z

@sylvestre This PR is ready for review.

Specify the argument number rather than its initial string, as the latter can be ambiguous.

Following row numbering and most common convention.

These can be used to improve runtime error reporting. The implementation required moving ScriptValue to script_line_provider to avoid the circular use chain.

This is needed for improved error reporting.

This will be used to also host the runtime error function.

In contrast to the whole mutable and large Command struct, this is immutable and small, and can therefore can be easily copied around for reporting runtime errors.

Only provide location to the Fancy RE engine, which is the only one requiring it. This should improve the following 2-10% fall in benchmark results that appeared with the improved error reporting. This is the original fall in performance after adding error location information.. no-op-short previous is 1.05 times faster than error-loc access-log-no-op previous is 1.05 times faster than error-loc access-log-no-subst previous is 1.06 times faster than error-loc access-log-subst previous is 1.05 times faster than error-loc access-log-no-del previous is 1.07 times faster than error-loc access-log-all-del previous is 1.05 times faster than error-loc access-log-translit previous is 1.06 times faster than error-loc access-log-complex-sub previous is 1.01 times faster than error-loc remove-cr previous is 1.07 times faster than error-loc genome-subst previous is 1.10 times faster than error-loc number-fix previous is 1.11 times faster than error-loc long-script previous is 1.03 times faster than error-loc hanoi error-loc is similarly fast as previous factorial previous is 1.02 times faster than error-loc The change of this commit improves performance in most cases as follows. no-op-short error-loc is 1.05 times faster than collaped-re access-log-no-op collaped-re is 1.04 times faster than error-loc access-log-no-subst collaped-re is 1.05 times faster than error-loc access-log-subst collaped-re is 1.04 times faster than error-loc access-log-no-del collaped-re is 1.05 times faster than error-loc access-log-all-del collaped-re is 1.05 times faster than error-loc access-log-translit error-loc is similarly fast as collaped-re access-log-complex-sub collaped-re is 1.02 times faster than error-loc remove-cr collaped-re is 1.05 times faster than error-loc genome-subst collaped-re is 1.06 times faster than error-loc number-fix collaped-re is 1.05 times faster than error-loc long-script collaped-re is 1.01 times faster than error-loc hanoi error-loc is 1.01 times faster than collaped-re factorial collaped-re is 1.03 times faster than error-loc This results in a smaller pessimization over the original version before the error location information was added. no-op-short previous is 1.10 times faster than collaped-re access-log-no-op previous is 1.02 times faster than collaped-re access-log-no-subst previous is 1.01 times faster than collaped-re access-log-subst collaped-re is similarly fast as previous access-log-no-del previous is 1.02 times faster than collaped-re access-log-all-del collaped-re is similarly fast as previous access-log-translit previous is 1.06 times faster than collaped-re access-log-complex-sub collaped-re is 1.01 times faster than previous remove-cr previous is 1.02 times faster than collaped-re genome-subst previous is 1.04 times faster than collaped-re number-fix previous is 1.06 times faster than collaped-re long-script previous is 1.02 times faster than collaped-re hanoi previous is 1.01 times faster than collaped-re factorial collaped-re is similarly fast as previous

Instead, detect and handle runtime errors at the point where regex methods are called. This is always faster or the same as the preceding method. no-op-short current is 1.03 times faster than preceding access-log-no-op current is similarly fast as preceding access-log-no-subst current is 1.05 times faster than preceding access-log-subst current is similarly fast as preceding access-log-no-del current is 1.05 times faster than preceding access-log-all-del current is 1.04 times faster than preceding access-log-translit current is similarly fast as preceding access-log-complex-sub current is similarly fast as preceding remove-cr current is 1.03 times faster than preceding genome-subst current is similarly fast as preceding number-fix current is similarly fast as preceding long-script current is 1.01 times faster than preceding hanoi current is 1.02 times faster than preceding factorial current is similarly fast as preceding Also, this rectified most performance pessimization introduced by adding error locations in fast_regex. no-op-short previous is 1.07 times faster than error-loc access-log-no-op previous is similarly fast as error-loc access-log-no-subst error-loc is 1.04 times faster than previous access-log-subst previous is similarly fast as error-loc access-log-no-del error-loc is 1.03 times faster than previous access-log-all-del error-loc is 1.04 times faster than previous access-log-translit previous is 1.06 times faster than error-loc access-log-complex-sub error-loc is 1.02 times faster than previous remove-cr previous is similarly fast as error-loc genome-subst previous is 1.04 times faster than error-loc number-fix previous is 1.06 times faster than error-loc long-script previous is similarly fast as error-loc hanoi previous is similarly fast as error-loc factorial previous is similarly fast as error-loc TODO: In fast_regex distinguish between UTF-8 conversion and regex errors. The former should be reported as I/O errors with input file location info, which the latter should be reported as script errors with script file location info.

dspinellis · 2025-07-08T16:08:14Z

Rebased and merged to avoid further divergence from the main branch.

dspinellis force-pushed the error-reporting branch from 3e93a46 to bc7a3dd Compare July 8, 2025 14:24

dspinellis added 15 commits July 8, 2025 17:37

Improve error reporting of script arguments

a795eb5

Specify the argument number rather than its initial string, as the latter can be ambiguous.

Report error columns in 1-based format

5f6d9dd

Following row numbering and most common convention.

Incorporate script coordinates in commands

25209fb

These can be used to improve runtime error reporting. The implementation required moving ScriptValue to script_line_provider to avoid the circular use chain.

Pass command to apply_captures

ee4d3b3

This is needed for improved error reporting.

Move error handling to dedicated module

af9de7f

This will be used to also host the runtime error function.

Improve error reporting for s captures, b, :

0416a89

Isolate error location into separate struct

fd3172e

In contrast to the whole mutable and large Command struct, this is immutable and small, and can therefore can be easily copied around for reporting runtime errors.

Improve error reporting for RE errors

60cba2b

Improve write file error reporting

a92be4e

Improve empty RE error reporting

f14f2e1

Allow for different errno strings

7d57a75

Error with script and input file/line when needed

f734ba3

Remove redundant struct member

ab07fd5

dspinellis force-pushed the error-reporting branch from bc7a3dd to ab07fd5 Compare July 8, 2025 14:38

dspinellis merged commit 6f5f5c0 into uutils:main Jul 8, 2025
18 of 19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Error reporting improvements#92

Error reporting improvements#92
dspinellis merged 15 commits intouutils:mainfrom
dspinellis:error-reporting

dspinellis commented Jun 16, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

dspinellis commented Jun 17, 2025

Uh oh!

Uh oh!

dspinellis commented Jul 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

dspinellis commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dspinellis commented Jun 17, 2025

Uh oh!

Uh oh!

dspinellis commented Jul 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dspinellis commented Jun 16, 2025 •

edited

Loading

codecov Bot commented Jun 16, 2025 •

edited

Loading