Skip to content

feat(hugr-cli): Nicer error when passing a non-envelope file #2007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 20, 2025
Merged

feat(hugr-cli): Nicer error when passing a non-envelope file #2007

merged 1 commit into from
Mar 20, 2025

Conversation

aborgna-q
Copy link
Collaborator

@aborgna-q aborgna-q commented Mar 20, 2025 •
edited
Loading

Minor special-casing for CLI message error.

Before:

$ hugr validate invalid.hugr
Error decoding HUGR envelope: Bad magic number. expected 0x4855475269484A76 found 0x7B0A20202020226D

After:

$ hugr validate invalid.hugr
Input file is not a HUGR envelope. Invalid magic number.

Use `--hugr-json` to read a raw HUGR JSON file instead.

@aborgna-q aborgna-q requested a review from a team as a code owner March 20, 2025 11:41
@aborgna-q aborgna-q requested a review from doug-q March 20, 2025 11:41
@codecov Codecov
Copy link

codecov bot commented Mar 20, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.71%. Comparing base (a5e1881) to head (1540d76).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
hugr-cli/src/hugr_io.rs 75.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2007      +/-   ##
==========================================
- Coverage   83.71%   83.71%   -0.01%     
==========================================
  Files         209      209              
  Lines       39215    39217       +2     
  Branches    35886    35888       +2     
==========================================
+ Hits        32830    32831       +1     
- Misses       4541     4542       +1     
  Partials     1844     1844
Flag Coverage Δ
python 92.03% <ø> (ø)
rust 82.94% <75.00%> (-0.01%) ⬇️

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.

doug-q
doug-q approved these changes Mar 20, 2025
View reviewed changes
Copy link
Collaborator

@doug-q doug-q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

It would be nice if the incorrect magic number was printed on INFO or higher verbosity level, but not worth the effort I think. It can be retrieved with $ head --help and a little bit of thought

@aborgna-q
Copy link
Collaborator Author

There's no logger currently setup. We just eprintln errors after execution depending on the verbosity level.

We should add env_logger or something similar, but that's a different PR.

@aborgna-q aborgna-q added this pull request to the merge queue Mar 20, 2025
Merged via the queue into main with commit 907acca Mar 20, 2025
25 of 26 checks passed
@aborgna-q aborgna-q deleted the ab/cli-envelope-error branch March 20, 2025 12:06
@hugrbot hugrbot mentioned this pull request Mar 20, 2025
Merged
github-merge-queue bot pushed a commit that referenced this pull request Mar 21, 2025
@hugrbot @doug-q
chore: release (#2002)
c90545d 
## 🤖 New release

* `hugr-model`: 0.18.0 -> 0.18.1 (✓ API compatible changes)
* `hugr-core`: 0.15.0 -> 0.16.0 (✓ API compatible changes)
* `hugr-llvm`: 0.15.0 -> 0.16.0 (✓ API compatible changes)
* `hugr-passes`: 0.15.0 -> 0.16.0 (✓ API compatible changes)
* `hugr`: 0.15.0 -> 0.16.0 (✓ API compatible changes)
* `hugr-cli`: 0.15.0 -> 0.16.0 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr-model`

<blockquote>

##
[0.18.0](hugr-model-v0.17.1...hugr-model-v0.18.0)
- 2025-03-14

### Bug Fixes

- Hugr-model using undeclared derive_more features
([#1940](#1940))

### New Features

- *(hugr-model)* [**breaking**] Add `read_from_reader` and
`write_to_writer` for streaming reads and writes.
([#1871](#1871))
- `hugr-model` AST ([#1953](#1953))

### Refactor

- *(hugr-model)* Reexport `bumpalo` from `hugr-model`
([#1870](#1870))
</blockquote>

## `hugr-core`

<blockquote>

##
[0.16.0](hugr-core-v0.15.0...hugr-core-v0.16.0)
- 2025-03-21

### Bug Fixes

- correct `CallIndirect` tag from `FnCall` to `DataflowChild`
([#2006](#2006))
- StaticArrayValue serialisation
([#2009](#2009))

### New Features

- traits for transforming Types/TypeArgs/etc.
([#1991](#1991))
- add exit operation to prelude
([#2008](#2008))
- Add llvm codegen for collections.static_array
([#2003](#2003))
</blockquote>

## `hugr-llvm`

<blockquote>

##
[0.16.0](hugr-llvm-v0.15.0...hugr-llvm-v0.16.0)
- 2025-03-21

### Bug Fixes

- Remove return from val_or_panic
([#1999](#1999))

### New Features

- add exit operation to prelude
([#2008](#2008))
- Add llvm codegen for collections.static_array
([#2003](#2003))
</blockquote>

## `hugr-passes`

<blockquote>

##
[0.16.0](hugr-passes-v0.15.0...hugr-passes-v0.16.0)
- 2025-03-21

### Bug Fixes

- correct `CallIndirect` tag from `FnCall` to `DataflowChild`
([#2006](#2006))
</blockquote>

## `hugr`

<blockquote>

##
[0.16.0](hugr-v0.15.0...hugr-v0.16.0)
- 2025-03-21

### Bug Fixes

- correct `CallIndirect` tag from `FnCall` to `DataflowChild`
([#2006](#2006))
- StaticArrayValue serialisation
([#2009](#2009))

### New Features

- traits for transforming Types/TypeArgs/etc.
([#1991](#1991))
- add exit operation to prelude
([#2008](#2008))
- Add llvm codegen for collections.static_array
([#2003](#2003))
- *(hugr-py)* Support envelope compression
([#1994](#1994))
</blockquote>

## `hugr-cli`

<blockquote>

##
[0.16.0](hugr-cli-v0.15.0...hugr-cli-v0.16.0)
- 2025-03-21

### New Features

- *(hugr-cli)* Nicer error when passing a non-envelope file
([#2007](#2007))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

---------

Co-authored-by: Douglas Wilson <[email protected]>
@hugrbot hugrbot mentioned this pull request Mar 21, 2025
Merged
github-merge-queue bot pushed a commit that referenced this pull request Mar 21, 2025
@hugrbot
chore: release v0.15.2 (#2016)
31c431d 
## 🤖 New release

* `hugr-core`: 0.15.1 -> 0.15.2 (✓ API compatible changes)
* `hugr-llvm`: 0.15.1 -> 0.15.2
* `hugr-passes`: 0.15.1 -> 0.15.2
* `hugr`: 0.15.1 -> 0.15.2 (✓ API compatible changes)
* `hugr-cli`: 0.15.1 -> 0.15.2

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr-core`

<blockquote>

##
[0.15.2](hugr-core-v0.15.1...hugr-core-v0.15.2)
- 2025-03-21

### Bug Fixes

- Don't enable envelope compression by default (yet)
([#2014](#2014))
- Inconsistent behaviour in `SiblingSubgraph::from_nodes`
([#2011](#2011))
</blockquote>

## `hugr-llvm`

<blockquote>

##
[0.15.1](hugr-llvm-v0.15.0...hugr-llvm-v0.15.1)
- 2025-03-21

### Bug Fixes

- Remove return from val_or_panic
([#1999](#1999))

### New Features

- add exit operation to prelude
([#2008](#2008))
- Add llvm codegen for collections.static_array
([#2003](#2003))
</blockquote>

## `hugr-passes`

<blockquote>

##
[0.15.1](hugr-passes-v0.15.0...hugr-passes-v0.15.1)
- 2025-03-21

### Bug Fixes

- correct `CallIndirect` tag from `FnCall` to `DataflowChild`
([#2006](#2006))
</blockquote>

## `hugr`

<blockquote>

##
[0.15.2](hugr-v0.15.1...hugr-v0.15.2)
- 2025-03-21

### Bug Fixes

- Don't enable envelope compression by default (yet)
([#2014](#2014))
- Inconsistent behaviour in `SiblingSubgraph::from_nodes`
([#2011](#2011))
</blockquote>

## `hugr-cli`

<blockquote>

##
[0.15.1](hugr-cli-v0.15.0...hugr-cli-v0.15.1)
- 2025-03-21

### New Features

- *(hugr-cli)* Nicer error when passing a non-envelope file
([#2007](#2007))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
@hugrbot hugrbot mentioned this pull request Mar 22, 2025
Closed
@hugrbot hugrbot mentioned this pull request Apr 1, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@doug-q doug-q doug-q approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aborgna-q @doug-q