Skip to content
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.

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

protect workflow from errors in executive summary? #335

Open
cjyetman opened this issue Jul 2, 2024 · 6 comments
Open

protect workflow from errors in executive summary? #335

cjyetman opened this issue Jul 2, 2024 · 6 comments

Comments

@cjyetman
Copy link
Member

cjyetman commented Jul 2, 2024

@jdhoffa should I wrap the executive summary stuff in a tryCatch() or something to protect against errors?

@AlexAxthelm
Copy link
Collaborator

I think that's a bad idea, since if would mean that errors in the ES would fail silently in our testing pipelines (which should be breaking if something is wrong on main)

@cjyetman
Copy link
Member Author

cjyetman commented Jul 2, 2024

maybe ES should have more robust testing on that end?

@AlexAxthelm
Copy link
Collaborator

🤷 Yeah. But I don't know enough about the content to be the one to set that up.

@jdhoffa
Copy link
Member

jdhoffa commented Jul 2, 2024

1 - I agree with @AlexAxthelm and dont think anything should be done in this repo to changing how the errors of the dependent package are handled
2 - I agree with @cjyetman and pacta.executive.suymmary absolutely needs a way more robust testing framework, but don't have anybody with capacity that can/ wants to do this right now. @cjyetman if you're interested in giving it a go then by all means, but right now there are plenty of other actual content changes we need to make to ES on a pretty tight timeline

@cjyetman
Copy link
Member Author

cjyetman commented Jul 2, 2024

It's kinda frustrating to leave this repo in a state where its entire testing process breaks if a minor error is made somewhere else that I have little to no control over just to catch any problems with another repo, but I get that we don't have much capacity to improve the situation at the moment

@jdhoffa
Copy link
Member

jdhoffa commented Jul 2, 2024

Yeah for sure. Although adding tests to pacta.executive.summary wouldn't have caught the issue either.

The problem is that a breaking change was introduced to pacta.executive.summary (the addition of a new/ necessary function parameter), that was not being called in workflow.transition.monitor.

Unit tests don't catch breaking changes to function APIs, that's gotta be noticed and communicated by the maintainer and/or reviewer, and PRs to broken dependencies should be opened simultaneously...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants