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.

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

Error handling - for package deployment #1582

Closed
4 tasks done
Madeline-UX opened this issue Apr 10, 2023 · 1 comment · Fixed by #1828
Closed
4 tasks done

Error handling - for package deployment #1582

Madeline-UX opened this issue Apr 10, 2023 · 1 comment · Fixed by #1828
Assignees
@mike-winberry
Labels
ux
Milestone
(2023.07.04)

Comments

@Madeline-UX
Copy link
Contributor

Madeline-UX commented Apr 10, 2023 •
edited by mike-winberry
Loading

User Flow

Given - Package deploys correctly
Then - modal shown with a success message and auto redirects back to the main page
If - Package fails to deploy
Then - Step that package failed in changes to error state AND the error message from CLI is in secondary text
And - Action buttons at the bottom of the screen are (secondary) Open Logs (primary) Return to Packages.

Updates

  • Stay on the deploy page when the package fails
  • Change state for stepper that package failed on to error state
  • Change action buttons to reflect error state options
  • Add error message as secondary text to stepper if possible

Design file

https://www.figma.com/file/MUItIzpzLBLuIyt225Bwgl/Zarf-UI?node-id=1369%3A58453&t=I6ve2QRHORWzJXZO-1

Image

Further UX Research Questions

Driving questions for future iterations:

  1. How much information does a user want to see upon success?
  2. What information is the user looking for upon failure?
  3. How does the user prefer to view that information CLI/Modal? More or less info
  4. How do we ensure the user knows what state the deployment is in if they walk away and come back and the deployment is completed while they were gone?
  5. If is deployment failed, how might we support quick and easy resolution?
@Madeline-UX Madeline-UX added this to the Zarf UI 2 milestone Apr 10, 2023
@github-project-automation github-project-automation bot moved this to New Requests in Zarf Project Board Apr 10, 2023
@Madeline-UX Madeline-UX added the ux label Apr 10, 2023
@Racer159 Racer159 modified the milestones: v0.27.0 (Zarf UI 2), v0.27.0 Apr 18, 2023
@Racer159 Racer159 mentioned this issue May 1, 2023
Open
3 tasks
@mike-winberry mike-winberry self-assigned this May 11, 2023
@Madeline-UX Madeline-UX mentioned this issue May 16, 2023
Closed
@Madeline-UX
Copy link
Contributor Author

Design is ready

mike-winberry added a commit that referenced this issue Jun 16, 2023
@mike-winberry
#1582. Removed the xterm dependency and rewrote the styling of the de…
5abf16f 
…ploy stream using ansi-to-html as it is a much smaller dependency and still meets the needs for the deploystream in addition to allowing much simpler custom styling
mike-winberry added a commit that referenced this issue Jun 16, 2023
@mike-winberry
#1582. Extracted out ansi-display component from deployment page. Add…
77e3ce9 
… the ansi color palette from figma to the ansi-display. Update font size, padding, scrolling behavior.
mike-winberry added a commit that referenced this issue Jun 16, 2023
@mike-winberry
#1582. Update the deployment page to add any errors to the step subti…
65a68e3 
…tle and set to the warning or error variant depending on the output.
@mike-winberry mike-winberry mentioned this issue Jun 16, 2023
Merged
2 tasks
@mike-winberry mike-winberry linked a pull request Jun 16, 2023 that will close this issue
1582 error handling for package deployment #1828
Merged
2 tasks
mike-winberry added a commit that referenced this issue Jun 20, 2023
@mike-winberry
#1582. Update the styling and added return to home button the deploy …
e5b541e 
…page. Create yaml-drawer component. Create zarf-prism-theme. Moved the ansi-display to lib. Updated get deployed packages to log an error instead of bailing
mike-winberry added a commit that referenced this issue Jun 20, 2023
@mike-winberry
#1582. Update the format script in package.json and ran format
e359573
mike-winberry added a commit that referenced this issue Jun 21, 2023
@mike-winberry
#1582. Update tests to handle the deploy logic for showing a warning …
8470065 
…while deploying, fixed the expanded search to ensure the button is connected prior to clicking in the deploy tests.
mike-winberry added a commit that referenced this issue Jun 21, 2023
@mike-winberry
#1582. Update timeout for the #sbom-info selector
17d2252
mike-winberry added a commit that referenced this issue Jun 21, 2023
@mike-winberry
#1582. Move SBOM test to post-init to see if there is an issue with t…
2876416 
…he init package sbom in the pipeline.
mike-winberry added a commit that referenced this issue Jun 21, 2023
@mike-winberry
#1582. Fix the expanded search logic in tests
d0f3a2e
mike-winberry added a commit that referenced this issue Jun 22, 2023
@mike-winberry
#1582. Update zarf.go GetDeployedZarfPackages() to return a slice of …
011c4bb 
…errors and a slice of types.DeployedPackage to allow for better error handling when some packages are unmarshaled and others are not. Update packages list.go and cmd package.go to reflect the changes. Update lang english.go with CmdPackageListUnmarshalErr for use when one or more unmarshaling errors occur when getting deployed zarf packages.
mike-winberry added a commit that referenced this issue Jun 22, 2023
@mike-winberry
#1582. Update packages deploy.go to parse the pterm stream output in …
7333fdc 
…order to properly send all the output in the stream. Fix ui deploy page to properly close the stream when navigating away from the route.
mike-winberry added a commit that referenced this issue Jun 22, 2023
@mike-winberry
#1582. Fix code drawer cut off scrolling. Add code viewer to the depl…
45f59bf 
…oyed package menu
mike-winberry added a commit that referenced this issue Jun 22, 2023
@mike-winberry
#1582. Rename message LogStream to LogWriter and updated all references.
a10b55a
mike-winberry added a commit that referenced this issue Jun 22, 2023
@mike-winberry
#1582. Remove unused dependency strip-ansi from package and vite config
d0c79a9
Racer159 added a commit that referenced this issue Jun 22, 2023
@mike-winberry @YrrepNoj @Racer159
1582 error handling for package deployment (#1828)
a6cf75f 
## Description
#1582 
#1606 


## Type of change

- [x] New feature (non-breaking change which adds functionality)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed

---------

Co-authored-by: Jonathan Perry <[email protected]>
Co-authored-by: Wayne Starr <[email protected]>
@mike-winberry mike-winberry mentioned this issue Jun 23, 2023
Merged
1 task
Racer159 pushed a commit that referenced this issue Jun 23, 2023
@mike-winberry
Fixed deploy page fatal and response error handling. (#1842)
4bc9f85 
## Description
Fixed the error handling in the deploy page to account for fatal errors
and to ensure the finalized state reflects the failed components.

Fixes #
#1582 

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mike-winberry mike-winberry

Labels
ux
Projects
None yet
Milestone
(2023.07.04)
Development

Successfully merging a pull request may close this issue.

1582 error handling for package deployment zarf-dev/zarf
3 participants
@Racer159 @mike-winberry @Madeline-UX