Refactored error propoagation in masonsystem,update and publish files #28339

tausiffmujawar · 2026-01-23T12:41:24Z

Overview

This PR continues the refactor of error handling in the Mason package manager. Internal functions now propagate MasonError to the top-level CLI handler instead of catching and calling exit(1) locally. This centralizes error-to-exit behavior, improves testability, and preserves user-visible behavior.

Changes

[Mason.chpl]

Centralized error handling: subcommands now propagate MasonError to the CLI handler, which is responsible for user-facing error reporting.
Removed exit(1) from subcommand error handling; now uses throw for MasonError.
Fixed extra brace and resolved merge conflict markers.

[MasonUpdate.chpl]

Combined changes to support both error propagation (throws) and the force argument for updateLock.
updateLock now has the signature: throws and force=false.
Ensured all error-prone logic is properly marked with throws.

[MasonExample.chpl]

Marked printAvailableExamples() with throws to comply with Chapel’s try/catch requirements.
Now propagates MasonError instead of handling exit locally.

[Other Mason source files: MasonSystem.chpl, MasonPublish.chpl, etc.]

Updated to propagate errors and match the new error handling pattern.
Ensured all functions using try/catch or throwing errors are marked with throws.

[Test files under test/mason] :

[mason-chpl-version-update.chpl]
[masonNewModule.chpl]
[masonNewTest.chpl]
[masonUpdateTest.chpl]

Reviewed above test files to ensure they catch MasonError and match the new error propagation pattern.

[docPkg.chpl]

The mason-doc tests were updated to reflect corrected error propagation. Previously, missing generated documentation files (Pkg.rst.txt, SubPkg.rst.txt, and in the withAuthor case index.html) were reported as successes. After the refactor, these failures are now surfaced correctly. The .good files were updated to match the test logic and actual filesystem state; no MasonDoc behavior was relaxed or changed.

[masonHelpTests.good]

The '--[no-]update' flag is no longer shown in this help output because it is not registered for this command after the refactor. This change is indirect—no option was removed explicitly—but the help text now reflects only supported flags. The .good file was updated accordingly.

[publishOffline.chpl]

After refactoring 'MasonPublish' to throw MasonError instead of calling 'exit(1)', the offline publish test began surfacing an uncaught exception. The test now catches MasonError and prints only the error message, preserving the original user-visible behavior. An empty catch-all is included to satisfy Chapel’s requirement for 'try' in a non-throwing 'main'

Rationale

Centralizing error handling at the top-level CLI (Mason.chpl) provides:

Unit testing: Internal functions can be tested without process exit.
Consistent error reporting: Single exit-to-user mapping.
Separation of concerns: Internal code handles logic; CLI handles user-facing exit behavior.

Local testing

$ ./util/start_test test/mason
[Test Summary - 260125.121934]
[Summary: #Successes = 114 | #Failures = 0 | #Futures = 0 | #Warnings = 0 ]
[Summary: #Passing Suppressions = 0 | #Passing Futures = 0 ]
[END]

Branch: mason/issue-28120-fix-third-PR
Environment: macOS, CHPL_HOME=/Users/tausiffhussainum/workspace/open-source/chapel

Notes

All commits include DCO sign-off:
Signed-off-by: Tausif Mujawar [email protected]

This PR continues work on: Refactor mason error handling for better unit testing #28120

Request for reviewers:
Please review the above files and the respective test cases. The change is intended to be behavior-preserving for end users (error messages and exit codes continue to be handled by the top-level CLI). Please provide any feedback that can improve the fix.

Signed-off-by: Tausif Mujawar <[email protected]>

…ed after refactor Signed-off-by: Tausif Mujawar <[email protected]>

Signed-off-by: Tausif Mujawar <[email protected]>

tausiffmujawar · 2026-01-25T07:10:24Z

@jabraham17 Can you please review my PR and let me know if i need to make any changes. I had general doubt, if i should retain "throws" in proc main() in test files or instead use "catch-all" method in test cases. i will update accordingly.

jabraham17 · 2026-01-26T16:56:36Z

tools/mason/Mason.chpl

    } catch ex: MasonError {
-      stderr.writeln(ex.message());
-      exit(1);
+      throw ex;


This change should not be included. It should be the only exit in Mason. If you wanted to be "pure", you could have it print the error and set the return code

Have made the change as per your comment.

jabraham17 · 2026-01-26T16:57:00Z

tools/mason/MasonExample.chpl

-    stderr.writeln(e.message());
-    exit(1);
+    throw e;
  }


This try/catch is not needed at all

I want to confirm if you want the 'try/catch' removed entirely here so the 'MasonError' propagates, rather than handling it locally? . This doesnt mean i need to revert back to original code as before right.

Correct. There is no need to catch and rethrow the error, just let it propagate

jabraham17 · 2026-01-26T16:57:17Z

tools/mason/MasonExample.chpl

  catch e: MasonError {
-    stderr.writeln(e.message());
-    exit(1);
+    throw e;


This try/catch is not needed at all

jabraham17 · 2026-01-26T16:57:36Z

tools/mason/MasonPublish.chpl

      catch e: MasonError {
-        writeln(e.message());
-        exit(1);
+        throw e;


This try/catch is not needed at all

jabraham17 · 2026-01-26T16:58:06Z

tools/mason/MasonPublish.chpl

  catch e : MasonError {
-    writeln(e.message());
-    exit(1);
+    throw e;
  }


same here, try/catch is no longer needed.

and I believe the exit above this should be converted to throws. If there is no test for it, it should be added

I had removed exit(1) as part of refactor logic. Now i removed (not yet committed) try/catch block as well to let error propogate to the caller. So i want to know where i need to add 'throws' in the current context of code (after removing try/catch) or the condition for which i need to "throw".

I believe masonPublish is already marked throws, so just removing the try/catch (and letting the errors propagate) is sufficient

jabraham17 · 2026-01-26T17:04:04Z

test/mason/mason-update-toml-error/mason-chpl-version-update.chpl

+proc main() throws {
+  try {


instead of proc main() throws, either use try! or add a catch all

test/mason/masonNewModule.chpl

test/mason/mason-doc/docPkg.1-1.good

jabraham17 · 2026-01-26T17:06:37Z

test/mason/masonNewTest.chpl

+use MasonUtils;

-proc main() {
+proc main() throws {
  var args = ['new', 'Test'];
-  masonNew(args);
+  try {
+    masonNew(args);
+  } catch e: MasonError {
+    writeln(e.message());
+  }


since these are not error cases, its much easier to just write try! masonNew

Have made the change as per your comment.

jabraham17 · 2026-01-26T17:07:02Z

test/mason/masonUpdateTest.chpl

+    temp.close();
+    lock.close();
+  } catch e: MasonError {
+    writeln(e.message());


Just use try! updateLock

Have made the change as per your comment.

Signed-off-by: Tausif Mujawar <[email protected]>

tausiffmujawar added 8 commits January 23, 2026 18:09

Refactored error propoagation in masonsystem,update and publish files

933ee4c

Signed-off-by: Tausif Mujawar <[email protected]>

Resolved merge conflicts in masonupdate.chpl and mason.chpl

56bc875

Signed-off-by: Tausif Mujawar <[email protected]>

Fixed trailing space issue in CI/CD

e084c1e

Signed-off-by: Tausif Mujawar <[email protected]>

Fixed trailing space issue again

ca54fff

Signed-off-by: Tausif Mujawar <[email protected]>

Fixed build error in CI CD pipeline

bfa3b9c

Signed-off-by: Tausif Mujawar <[email protected]>

Fixed docPkg error propogation and updated .good files

509c1c8

Signed-off-by: Tausif Mujawar <[email protected]>

Updated .good file to remove --[no-]update , as option is not support…

0722a23

…ed after refactor Signed-off-by: Tausif Mujawar <[email protected]>

Added try catch for publishOffline for error propogation

e57386a

Signed-off-by: Tausif Mujawar <[email protected]>

tausiffmujawar marked this pull request as ready for review January 25, 2026 07:06

jabraham17 requested changes Jan 26, 2026

View reviewed changes

Addressed review comments to remove try catch and update .good files

6cc05d1

Signed-off-by: Tausif Mujawar <[email protected]>

Refactored error propoagation in masonsystem,update and publish files #28339

Are you sure you want to change the base?

Refactored error propoagation in masonsystem,update and publish files #28339

Uh oh!

Conversation

tausiffmujawar commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Changes

Rationale

Local testing

Notes

Uh oh!

tausiffmujawar commented Jan 25, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jabraham17 Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jabraham17 Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tausiffmujawar commented Jan 23, 2026 •

edited

Loading

jabraham17 Jan 27, 2026 •

edited

Loading

jabraham17 Jan 28, 2026 •

edited

Loading