fix: include cause of parsing errors in action output logs #431

zimeg · 2025-04-22T20:19:52Z

Summary

This PR includes the cause of parsing errors in action output logs to fix #359.

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2025-04-22T20:20:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (c7dafcf) to head (b0c83a8).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #431   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files           7        7           
  Lines         703      709    +6     
=======================================
+ Hits          702      708    +6     
  Misses          1        1

☔ 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.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zimeg · 2025-04-22T20:28:55Z

📝 Example of invalid YAML:
https://github.com/zimeg/slack-sandbox/actions/runs/14603929191/job/40968479290#step:2:12

YAMLException: bad indentation of a mapping entry (2:19)

 1 | channel: ***,
 2 | text: "greetings!",
-----------------------^

📝 Example of invalid JSON:
https://github.com/zimeg/slack-sandbox/actions/runs/14603970704/job/40968613223#step:2:13

SyntaxError: Expected ',' or '}' after property value in JSON at position 52
    at JSON.parse (<anonymous>)

📝 Example of invalid attributes:
https://github.com/zimeg/slack-sandbox/actions/runs/14604005898/job/40968725587#step:2:14

Error: missing required field: channel
Error: SlackError: An API error occurred: invalid_arguments
Error: An API error occurred: invalid_arguments

zimeg

📣 A note on some strange patterns in these changes for the kind reviewers!

zimeg · 2025-04-22T20:30:28Z

src/index.js

+    /** @type {import('./errors.js').Cause} */
+    const causes = /** @type {any} */ (error.cause);
+    if (causes?.values) {
+      for (const cause of causes.values) {
+        core.info(`${cause.stack}`);
+      }
+    } else {
+      core.info(`${error.stack}`);
+    }


🔗 The error cause values is valid data but typescript treats causes as "unknown" so this worksaround that.

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause#providing_structured_data_as_the_error_cause

mwbrooks

✅ LGTM! Huge improvement to the error messages. Hopefully this helps folks debug issues more easily!

mwbrooks · 2025-04-22T20:54:06Z

src/index.js

@@ -6,13 +6,21 @@ import send from "./send.js";
 * from the send.js file for testing purposes.
 */
 try {
-  send(core);
+  await send(core);


zimeg · 2025-05-01T05:04:22Z

📝 Example of invalid YAML file:
https://github.com/zimeg/slack-sandbox/actions/runs/14770123380/job/41468715105#step:3:10

YAMLException: expected a single document in the stream, but found more
    at Object.load$1 [as load] (file:///home/runner/work/_actions/zimeg/slack-github-action/v2.0.1-rc.5/node_modules/js-yaml/dist/js-yaml.mjs:2812:1)

📝 Example of invalid JSON file:
https://github.com/zimeg/slack-sandbox/actions/runs/14770064204/job/41468560233#step:3:11

SyntaxError: Bad control character in string literal in JSON at position 21
    at JSON.parse (<anonymous>)

📝 Example of missing file:
https://github.com/zimeg/slack-sandbox/actions/runs/14770087484/job/41468622000#step:3:12

Error: ENOENT: no such file or directory, open '/home/runner/work/slack-sandbox/slack-sandbox/oop.yaml'
    at Object.readFileSync (node:fs:449:20)

zimeg · 2025-05-01T05:06:18Z

📝 Example of invalid arguments from a payload file too:
https://github.com/zimeg/slack-sandbox/actions/runs/14770107368/job/41468674575#step:3:14

Error: missing required field: channel
Error: SlackError: An API error occurred: invalid_arguments
Error: An API error occurred: invalid_arguments

zimeg · 2025-05-06T17:15:00Z

@mwbrooks @hello-ashleyintech 🫡

With both unexpected text and file inputs returning perhaps more meaningful errors, let's merge this! I might imagine follow up that continues to improve upon these outputs, perhaps logging the actual inputs, but for now this I hope is helpful.

After this merges, I will test a release candidate a few times for confidence. Then I look forward to a new release 🚀

zimeg added 2 commits April 22, 2025 13:07

fix: include cause of parsing errors in action output logs

f4bd263

fix: run the linter for consistent formatting applied

cccb0cd

zimeg added bug Something isn't working semver:patch labels Apr 22, 2025

zimeg added this to the 2.0.1 milestone Apr 22, 2025

zimeg requested review from mwbrooks and hello-ashleyintech April 22, 2025 20:19

zimeg self-assigned this Apr 22, 2025

zimeg temporarily deployed to staging April 22, 2025 20:19 — with GitHub Actions Inactive

zimeg mentioned this pull request Apr 22, 2025

actions(test): check error messaging outputs in a staged release zimeg/slack-sandbox#338

Closed

feat: remove error groups that hide outputs as a default

7a98fc3

zimeg temporarily deployed to staging April 22, 2025 20:22 — with GitHub Actions Inactive

zimeg commented Apr 22, 2025

View reviewed changes

zimeg marked this pull request as ready for review April 22, 2025 20:31

mwbrooks approved these changes Apr 22, 2025

View reviewed changes

test: confirm causes of error are thrown in an expected order

20f425b

zimeg temporarily deployed to staging May 1, 2025 04:07 — with GitHub Actions Inactive

fix: set the cause of file parsing errors to the error value

5b4b1bc

zimeg temporarily deployed to staging May 1, 2025 04:54 — with GitHub Actions Inactive

Merge branch 'main' into main

b0c83a8

zimeg temporarily deployed to staging May 6, 2025 17:10 — with GitHub Actions Inactive

zimeg merged commit ab965e5 into slackapi:main May 6, 2025
5 checks passed

zimeg mentioned this pull request May 6, 2025

Improve error reporting when action fail to parse correctly the payload #359

Closed

10 tasks

zimeg modified the milestones: 2.0.1, 2.1 May 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: include cause of parsing errors in action output logs #431

fix: include cause of parsing errors in action output logs #431

Uh oh!

zimeg commented Apr 22, 2025

Uh oh!

codecov bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

zimeg commented Apr 22, 2025

Uh oh!

zimeg left a comment

Uh oh!

zimeg Apr 22, 2025

Uh oh!

mwbrooks left a comment

Uh oh!

mwbrooks Apr 22, 2025

Uh oh!

zimeg commented May 1, 2025

Uh oh!

zimeg commented May 1, 2025

Uh oh!

zimeg commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

fix: include cause of parsing errors in action output logs #431

fix: include cause of parsing errors in action output logs #431

Uh oh!

Conversation

zimeg commented Apr 22, 2025

Summary

Requirements

Uh oh!

codecov bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zimeg commented Apr 22, 2025

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

mwbrooks Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

zimeg commented May 1, 2025

Uh oh!

zimeg commented May 1, 2025

Uh oh!

zimeg commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 22, 2025 •

edited

Loading