Edit packages

[marko-lisica]

Goal

User story
As an IT admin,
I want to edit a package by uploading a new package and/or editing the package's attributes (pre-install condition, install script, post-install script, self-service, etc.)
so that I can update the software on my workstations.

Context

• Requestor(s): @lukeheath @pintomi1989 @ddribeiro @zayhanlon @Patagonia121
• Product designer: @rachaelshaw

Changes

Product

• UI changes: Figma link
• CLI usage changes: N/A
• REST API changes: PRs here and here
• Fleet's agent (fleetd) changes: N/A
• Permissions changes: Permissions: edit software #22426
• Changes to paid features or tiers: N/A

Engineering

• Reference documentation changes: TODO
• Usage documentation changes: TODO
• Database schema migrations: TODO
• Load testing: TODO

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

QA

Risk assessment

• Requires load testing: TODO
• Risk level: Low / High TODO
• Risk description: TODO

Manual testing steps

Because @xpkoala is out, leaving initials and date of final QA
QA DRI: @RachelElysia

• RP 9/17 Only populate install/uninstall scripts when adding software but not editing software
• RP 9/17 Ability to edit and save new software file, self-service, and all advanced options
• RP 9/17 Ability to edit all advanced options (for each: blank o populated, populated to different populated, and populated to blank)
• RP 9/17 Ensure pending install and uninstall counts reset after editing
• RP 9/17 Ensure failed install and uninstalled count do not reset after editing (editing everything but the package)
• IL&RP 9/17 Ensure failed install and uninstalled count do reset after updating the package
• IL&RP 9/17 Ensure installed count do not reset after editing (editing everything but the package)
• IL&RP 9/17 Ensure installed count do reset after updating the package
• RP 9/17 Ensure backend return error state "The selected package is for different software."
• RP 9/17 Ensure backend return error state "The selected package is for different file type."
• RP 9/17 Ensure adding software loading behavior
• RP 9/17 Ensure cancels pending uninstall and install with Save changes? modal upon all changes
• RP 9/17 all counts do not reset and pending actions are not cancelled when only self-service is changed (unreleased bug found)
• RP 9/17 Editing software should save changes and stay on the same page (unreleased bug found and fixed in (Unreleased bugs) Fleet UI: 20404 edit software feature #22168)
• IL 9/13 Test for no teams packages
• RP 9/17 initial & date Test for team packages
• RP 9/17 Global activity is created for editing software with no bugs (unreleased unspecced bug found, updating spec and BE to surface software_package to match adding software activity fixed in Use previous package filename for activity if installer edit doesn't change the package #22177)

GitOps QA workflow found on the gitops ticket: #21612

Testing notes

Confirmation

1. Engineer (@____): Added comment to user story confirming successful completion of QA.
2. QA (@____): Added comment to user story confirming successful completion of QA.

[noahtalerman]

Thanks for tracking this @marko-lisica!

This is a clear UX improvement and probably a quick win so it makes sense to take this as part of the upcoming design sprint.

I think I've heard this request come from several customers and folks at Fleet internally.

cc @lukeheath @pintomi1989 @ddribeiro @zayhanlon @Patagonia121

[noahtalerman]

@marko-lisica I think it makes sense to include editing "self-service" as part of this story too.

Closing out the "Switch software to self-service after it has already been uploaded" story (#20372).

cc @pintomi1989

[noahtalerman]

Hey @marko-lisica heads up, I updated this issue to user story format and moved your original issue description here:

Problem

After the upload, there's no way to edit the software's advanced options (install script, post-install script, etc.). The only way is to remove software package and re-upload with new options. This isn't very pleasant if a user is testing new package and scripts attached to it.

New packages are usually tested before production deployment. IT admin should be able to test different options easily before pushing to production.

I experienced this while dogfooding and testing scripts for .exe installers.

Potential solutions

After the software package is uploaded, allow user to edit stuff in the advanced options modal.

[noahtalerman]

Mike: Let's be aware of where this heads w/ Andriod i.e. esper (and iOS)

[iansltx]

So, while we lock down playform by holding extension constant (400 if it changes), someone could switch from a .pkg to a .app-with-a-.pkg-extension or vice versa, looks like. Probably prevented from client-side, but I'm guessing that if someone uploads something that switches, we just swap the source on the existing installer entry, which is fine since we're zeroing out install counts anyway.

@noahtalerman that sound right?

[iansltx]

Actually looks like things are keyed by source pretty heavily, so we should bail if there's a source mismatch. Going with that approach here.

[iansltx]

Known frontend issues as of now:

• Software installer package update form is inoperable
• Install script change detection (for save button) doesn't work
• Need more tests

Known backend issues as of now:

• Expose bundle IDs in software installer struct, switch to using rather than existing file metadata
• Expose installer extension in software installer struct (will be added to Uninstall packages #20320 work), switch to using rather than existing file metadata
• Cancel uninstalls on installer changes (currently only cancels installs)
• Handle minor PR feedback from @mostlikelee
• Add tests

Plus, GitOps items:

• Cancel installs/uninstalls on installer changes
• Reset counts on installer package changes

Also, guide updates for:

• Edit software
• Uninstall

[sharon-fdm]

QA DRI - @RachelElysia

[noahtalerman]

Hey @zayhanlon heads up we shipped this user story in 4.57 🎉

[fleet-release]

Software's ebb and flow,
Edit packages, ease the change,
Workstations aglow.