fix(d1): intercept and stringify errors thrown in --json mode

[rozenmd]

This PR fixes STOR-3055 internally, and closes #4871 on GitHub.

[changeset-bot]

🦋 Changeset detected

Latest commit: 1e28bfe

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
wrangler	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7785453083/npm-package-wrangler-4872

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/4872/npm-package-wrangler-4872

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7785453083/npm-package-wrangler-4872 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7785453083/npm-package-create-cloudflare-4872 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7785453083/npm-package-miniflare-4872

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7785453083/npm-package-cloudflare-pages-shared-4872

Note that these links will no longer work once the GitHub Actions artifact expires.

---

wrangler@3.26.0 includes the following runtime dependencies:

Package	Constraint	Resolved
miniflare	workspace:*	3.20240129.0
workerd	1.20240129.0	1.20240129.0
workerd --version	1.20240129.0	2024-01-29

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

[codecov]

Codecov Report

Attention: 13 lines in your changes are missing coverage. Please review.

Comparison is base (fcbde34) 70.62% compared to head (1e28bfe) 70.71%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4872      +/-   ##
==========================================
+ Coverage   70.62%   70.71%   +0.09%     
==========================================
  Files         292      292              
  Lines       15187    15198      +11     
  Branches     3865     3869       +4     
==========================================
+ Hits        10726    10748      +22     
+ Misses       4461     4450      -11     

Files	Coverage Δ
packages/wrangler/src/errors.ts	100.00% <100.00%> (ø)
packages/wrangler/src/index.ts	89.90% <100.00%> (+0.06%)	⬆️
packages/wrangler/src/d1/execute.tsx	59.73% <43.47%> (+2.68%)	⬆️

... and 7 files with indirect coverage changes

[rozenmd]

This no longer closes wrangler with exitCode = 1 without doing it explicitly (and breaking tests), any tips on what you'd do here @petebacondarwin?

[petebacondarwin]

Our approach is to throw a new FatalError() which can bubble up to the top level exit the process with a non-zero code.

[rozenmd]

Is the output of that clean, though?

[rozenmd]

We want wrangler to output JSON-friendly errors here, like:

{
	"error": {
		"text": "A request to the Cloudflare API (/accounts/xxxx/d1/database/xxxxxxx/query) failed.",
		"notes": [
			{
				"text": "no such column: asdf at offset 7 [code: 7500]"
			}
		],
		"kind": "error",
		"name": "APIError",
		"code": 7500
	}
}

[rozenmd]

Ah nope:

✘ [ERROR] {

    "error": {
      "text": "A request to the Cloudflare API
  (/accounts/xxx/d1/database/xxx/query)
  failed.",
      "notes": [
        {
          "text": "no such column: asdf at offset 7 [code: 7500]"
        }
      ],
      "kind": "error",
      "name": "APIError",
      "code": 7500
    }
  }


If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose
🪵  Logs were written to "/Users/rozenmd/.wrangler/logs/wrangler-2024-01-31_10-44-47_583.log"

[petebacondarwin]

😢

OK so we really need to do a more holistic fix for --json output across the whole of Wrangler.
But in the meantime, how about you add a property to FatalError that tells us to log the error as JSON?

[petebacondarwin]

Basically check it here: https://github.com/cloudflare/workers-sdk/blob/main/packages/wrangler/src/index.ts#L822

[rozenmd]

Gotcha, cheers @petebacondarwin !

[petebacondarwin]

Our approach is to throw a new FatalError() which can bubble up to the top level exit the process with a non-zero code.

[petebacondarwin]

One minor nit.

[petebacondarwin]

To avoid the casts perhaps you could do?

Suggested change

	if (json) {
	if (json && error instanceof Error) {

[rozenmd]

Cheers, fixed