refactor: Error handling #284

aarondill · 2023-01-23T07:06:50Z

This PR refactors the code to enclose common error points in try catch blocks and outputting the message property on the error to the user on stderr. This further allows tolerant errors where the program is not halted, but instead continues to process other files.

aarondill · 2023-01-23T08:01:27Z

This and #283 will go well together, however this commit only relies on #281 before it can be merged

keithamus · 2023-01-30T11:30:47Z

@aarondill think we should close this one?

aarondill · 2023-01-30T12:27:24Z

@aarondill think we should close this one?

why's that?

keithamus · 2023-01-30T12:46:09Z

Perhaps it needs to be rebased/refactored. I'm struggling to see what it adds on top of #281

Stops any successful output. Errors are still outputted.

This commit creates stdout and stderr functions for outputting with respect to isQuiet and adds support for differing (easier to parse) messages if not connected to a TTY (eg. a pipe or process substitution) Additionally changes the 'No matching files.' message to output on stderr rather than on stdout as it was, which makes sense because this output represents erroneous usage.

these variables can be set to force output on the specified chanel as if it were connected to a terminal. macro.testCLI can now take an argument of the following form: isTerminal: { stderr: false, stdout: false },

The exit code is now the number of files which failed when sorting. On a successful run, this will be 0 and exit w/ success, but if any errors occur, this will be incremented. In check mode, this is fails + unsorted.

Wraps fs calls in trycatch to not throw and to count failures. Also better messages and script usage

fisker · 2023-01-30T13:27:06Z

👎 For increasing complex. Can't get why we need these changes.

fisker · 2023-01-30T13:29:39Z

Even if we want a better error message, we can just try/catch those possible errors and print a friendly message.

aarondill · 2023-01-30T13:30:35Z

I have rebased this onto keithamus/master and removed extra changes to make the diff slightly clearer. The history is a bit of a mess, I could clean it up if you'd like, but I figure it'll get squashed in the merge anyways.

This builds on 281 by improving the developer experience when using the CLI in shell scripts. You can read the changes in the new section of the readme, but it boils down to this:

Wrap common failure points in try catch and report errors without failing
Fully utilize stdout and stderr. This, for example, allows for sort-package-json **/package.json 2>/dev/null to output only success
Change the output depending on tty presence. This allows the user all the information, but gives only important information to scripts utilizing this, allowing for easier parsing.
- If there is not a tty
  - stderr contains only files which failed in either mode: sort-package-json **/package.json 2>&1 1>/dev/null | look-for-certain-failed-files
  - stdout contains files which were successful, in check mode, these are files which are already sorted.
- With a tty
  - stderr contains files which failed, and the Error.message which came with them
  - stdout contains the files which were successful, with human readable messages (ie package.json was sorted!)

aarondill · 2023-01-30T13:36:05Z

-1 For increasing complex. Can't get why we need these changes.

This does increase complexity, but it allows for much easier scripting, without difficult parsing. which is especially difficult if all messages are outputted to stdout.
Even if we decide to simplify to the extreme, we should still at least ensure that expected errors don't halt the program and that error messages are outputted to stderr rather than stdout.

keithamus · 2023-01-30T15:14:30Z

Don't mind untidy history, as long as the diff+description makes up for it 😉.

I see where you're going with this, and I don't mind improving the output for scripts, but I think we can perhaps improve error messaging in general. Let's first get better error messages in the general case, then let's work to figure out a way to make error messages more parseable. TTY detection is a bit too much magic for my preference.

aarondill · 2023-02-01T01:37:49Z

Some example runs from within this repo

./cli.js --check **/package.json:

Found 1220 files.
1 files could not be checked.
1193 files were not sorted.
26 files were already sorted.

./cli.js **/package.json:

Found 1220 files.
1 files could not be sorted.
1193 files successfully sorted.
26 files were already sorted.

fisker · 2023-02-01T01:52:08Z

I'd like to do a refactor.

aarondill · 2023-02-01T01:54:39Z

That seems like a good idea

fisker · 2023-02-01T02:45:30Z

@aarondill c5dd2cc WDYT?

aarondill · 2023-02-01T02:54:41Z

It looks good. To clarify, this doesn’t affect any of the output, correct? I didn’t see any changes in the snapshot

aarondill · 2023-02-01T02:58:45Z

also, this seems slightly overly verbose:

      isCheck
        ? `${status.failedFilesCount} files could not be checked.`
        : `${status.failedFilesCount} files could not be sorted.`,

perhaps this could be simplified to

`${status.failedFilesCount} files could not be ${isCheck ? 'checked' : 'sorted'}.`

potentially on the next line as well.

This is entirely stylistic though, and may be better in its current state if we ever plan to change these output statements

fisker · 2023-02-01T03:10:17Z

To clarify, this doesn’t affect any of the output, correct?

Not changed.

This is entirely stylistic though, and may be better in its current state if we ever plan to change these output statements

That's why I wrote like this.

fisker · 2023-02-01T03:33:12Z

Here comes the actual message change. b22d474

Good?

aarondill · 2023-02-01T04:04:34Z

Perhaps use template strings, rather than the console.log format strings(%s), in case our implementation of the log function changes in the future

aarondill · 2023-02-01T04:05:06Z

The message change itself looks good

fisker · 2023-02-01T04:18:09Z

in case our implementation of the log function changes in the future

We can still use util.format.

fisker · 2023-02-01T04:40:06Z

I extracted reporter to a separate file, you can just add changes to that file if you still want do the TTY thing, but I suggest we should keep things simple.

aarondill · 2023-02-01T04:51:31Z

For now, lets keep it simple, especially since @keithamus has said they prefer it that way

fisker · 2023-02-01T10:11:26Z

@aarondill We need update https://github.com/keithamus/sort-package-json#usage, since output changed.

github-actions · 2023-02-01T12:27:40Z

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

aarondill · 2023-02-01T12:48:01Z

@aarondill We need update https://github.com/keithamus/sort-package-json#usage, since output changed.

I notice that you merged this PR. would you like me to create a new PR or just continue to commit this change here?

fisker · 2023-02-01T12:48:43Z

This already merged, you can send a new one.

aarondill force-pushed the error_handling branch from a76fd84 to 407c4d1 Compare January 23, 2023 14:16

aarondill added 19 commits January 30, 2023 07:03

feat(cli): add --quiet / -q option

bc95bfd

Stops any successful output. Errors are still outputted.

fix(cli): change stderr to not respect --quiet

0037f07

fix(cli): change stdout to stderr in isTerminal

a1042b9

fix(tests): add STD(OUT/ERR)_IS_TTY env variables

dd596cd

these variables can be set to force output on the specified chanel as if it were connected to a terminal. macro.testCLI can now take an argument of the following form: isTerminal: { stderr: false, stdout: false },

fix(cli): improve output of CLI when not a tty

6417a87

test: added tests for --verson and --help

cb4147e

test: add tests for --quiet

bc8d156

test: include isTerminal in snapshot

b03c0f8

test: add tests for TTY detection and integration

864e834

test: typo, stderr --> stdout

296e580

fix(cli): exit code while sort is number of failed

192e4ca

The exit code is now the number of files which failed when sorting. On a successful run, this will be 0 and exit w/ success, but if any errors occur, this will be incremented. In check mode, this is fails + unsorted.

fix: wrap file operation in try catch

7f1d607

Wraps fs calls in trycatch to not throw and to count failures. Also better messages and script usage

docs: document changes to tty-based output

7635316

fix(test): compatability w/ node v14

c517e46

fix: compatability with node 12

f425764

test: add tests for improper usage

aae2cdb

test: support for node 12&14 in error test

5bc8c51

refactor: remove extra changes to improve diff

ea61369

aarondill force-pushed the error_handling branch from 91bcf47 to ea61369 Compare January 30, 2023 13:18

refactor: cleaner logic

c5dd2cc

refactor: pass files to constructor

acfbca0

fisker added 2 commits February 1, 2023 11:13

refactor: save matchedFilesCount to status

ffcb3de

fix: remove 0 files, use 1 file instead of 1 files

b22d474

fisker previously approved these changes Feb 1, 2023

View reviewed changes

fisker changed the title ~~Refactor: Error handling~~ refactor: Error handling Feb 1, 2023

refactor: extract Reporter

972be64

fisker dismissed their stale review via 972be64 February 1, 2023 04:31

fisker approved these changes Feb 1, 2023

View reviewed changes

aarondill mentioned this pull request Feb 1, 2023

refactor: Argument parsing (>= node 16) #283

Open

keithamus approved these changes Feb 1, 2023

View reviewed changes

keithamus merged commit 6b1c114 into keithamus:master Feb 1, 2023

github-actions bot added the released label Feb 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Error handling #284

refactor: Error handling #284

aarondill commented Jan 23, 2023 •

edited

aarondill commented Jan 23, 2023

keithamus commented Jan 30, 2023

aarondill commented Jan 30, 2023

keithamus commented Jan 30, 2023

fisker commented Jan 30, 2023

fisker commented Jan 30, 2023

aarondill commented Jan 30, 2023

aarondill commented Jan 30, 2023

keithamus commented Jan 30, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023 •

edited

aarondill commented Feb 1, 2023

aarondill commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023

aarondill commented Feb 1, 2023 •

edited

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023 •

edited

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

github-actions bot commented Feb 1, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

refactor: Error handling #284

refactor: Error handling #284

Conversation

aarondill commented Jan 23, 2023 • edited

aarondill commented Jan 23, 2023

keithamus commented Jan 30, 2023

aarondill commented Jan 30, 2023

keithamus commented Jan 30, 2023

fisker commented Jan 30, 2023

fisker commented Jan 30, 2023

aarondill commented Jan 30, 2023

aarondill commented Jan 30, 2023

keithamus commented Jan 30, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023 • edited

aarondill commented Feb 1, 2023

aarondill commented Feb 1, 2023 • edited

fisker commented Feb 1, 2023 • edited

fisker commented Feb 1, 2023

aarondill commented Feb 1, 2023 • edited

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023 • edited

fisker commented Feb 1, 2023 • edited

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

github-actions bot commented Feb 1, 2023

aarondill commented Feb 1, 2023

fisker commented Feb 1, 2023

aarondill commented Jan 23, 2023 •

edited

fisker commented Feb 1, 2023 •

edited

aarondill commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023 •

edited

aarondill commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023 •

edited

fisker commented Feb 1, 2023 •

edited