Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc #25202

RachelElysia · 2025-01-07T16:14:05Z

Issue

Part of #23528

Description

Improve software installation for failed policies: Add platform-specific filtering in the software dropdown, ensuring only compatible software are displayed based on each policy's targeted platforms
Better UX for users to only see dropdown options that match the policy's platform

Screenrecording of improvement

Notice that each dropdown only shows installable software that matches the policy's platform(s) targeted

Screen.Recording.2025-01-07.at.11.10.41.AM.mov

Checklist for submitter

If some of the following don't apply, delete the relevant line.

Changes file added for user-visible changes in changes/, orbit/changes/ or ee/fleetd-chrome/changes.
Potential test for this
A detailed QA plan exists on the associated ticket (if it isn't there, work with the product group's QA engineer to add it)
Manual QA for all new/changed functionality

codecov · 2025-01-07T16:41:09Z

Codecov Report

Attention: Patch coverage is 18.75000% with 13 lines in your changes missing coverage. Please review.

Project coverage is 63.53%. Comparing base (b902509) to head (cc49a7c).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...Titles/SoftwareTable/SoftwareTitlesTableConfig.tsx	0.00%	8 Missing ⚠️
frontend/services/entities/software.ts	0.00%	2 Missing ⚠️
frontend/context/policy.tsx	0.00%	1 Missing ⚠️
...es/edit/components/EditQueryForm/EditQueryForm.tsx	0.00%	1 Missing ⚠️
.../edit/components/SaveQueryModal/SaveQueryModal.tsx	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #25202      +/-   ##
==========================================
- Coverage   63.56%   63.53%   -0.03%     
==========================================
  Files        1619     1618       -1     
  Lines      154680   154342     -338     
  Branches     3955     3994      +39     
==========================================
- Hits        98315    98064     -251     
+ Misses      48610    48547      -63     
+ Partials     7755     7731      -24

Flag	Coverage Δ
frontend	`53.22% <18.75%> (-0.02%)`	⬇️

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.

RachelElysia · 2025-01-07T16:51:04Z

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx

@@ -22,18 +27,18 @@ import Button from "components/buttons/Button";
 import { ISoftwareTitle } from "interfaces/software";
 import TooltipWrapper from "components/TooltipWrapper";

-const getPlatformDisplayFromPackageExtension = (ext: string | undefined) => {
+const getPlatformFromExtension = (ext: string | undefined): Platform | null => {
  switch (ext) {


I think this’ll break for zip files, which we might use for FMA for Windows. Will follow up in a PR comment. Thinking we should use for software title source instead as that’s more reliable.

@iansltx We are currently showing display text of macOS for zip files in the dropdown

Yeah, we can fix that if/when we run across FMAs for Windows (or Linux?) that are delivered by zip file. Mainly trying to avoid writing new brittle code that we have to remember to fix elsewhere, and we know source on the software title won't have that issue (though it requires a mapping rather than having an explicit platform field).

iansltx · 2025-01-07T17:01:30Z

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx

+  const availableSoftwareOptions = (policy: IFormPolicy) => {
+    return titlesAFI
+      ?.filter((title) => {
+        const splitName = title.software_package?.name.split(".") ?? "";


As implemented, this breaks on VPP apps because we have app_store_app rather than software_package.

Also, we'll want to tweak the API call we make to:

Explicitly ask for macos,windows,linux platforms (to filter out iOS/iPadOS)

Filter by installable titles rather than titles with software packages, so we can see VPP apps

Display the correct item in the dropdown when we're dealing with a VPP app

I realize this is expanding the scope of this PR, but these changes are intertwined enough that you'll want to do them all at once.

This also means this PR will need to be stacked on top of the backend PR so you have the API changes you need. I don't think we need a dedicated feature branch on this as we can merge the backend to main first, at which point the FE PR will repoint.

I don't see 1 get software titles API call where I can get macos, windows, or linux all together without ios/ipados. Unless we want to make 3 calls every time we open this modal? So I did 1 call, but filter for each since there's only max 25 policies in the list that we will filter the software titles. I could refactor and make a list for macos, windows, linux and then apply to those policies only. In that case, policies that target more than 1 platform, should that show software for all platforms it targets, or no platforms it targets? wdyt @iansltx

Done!

Done!

So, multi-platform support is new (was in-scope for the BE for this ticket; see the end of this table); it'll work if you code against the BE PR. Definitely not worth making three API calls for this.

For multi-platform policies, I think we go with showing all compatible titles (which IIRC is how you have it implemented now). While the chances of someone checking the automation box on a multi-platform automation are low (for that to be useful we'd really need grouped policies for e.g. "Install Firefox on all the things"), if they do they shouldn't be greeted with a no-op.

Definitely not worth making three API calls for this.

+1

which IIRC is how you have it implemented now

yup

if they do they shouldn't be greeted with a no-op

1

~~TODO: Change titlesAFI call to not include ipados or ios~~ done

iansltx

Think we can do some simplification here, provided we're willing to add another mapping (source -> platform). Good catch on missing pieces of the type; hopefully the struct descriptions are helpful there.

iansltx · 2025-01-09T22:26:14Z

frontend/interfaces/software.ts

@@ -105,6 +105,10 @@ export interface IAppStoreApp {
    failed: number;
  };
  install_during_setup?: boolean;
+  automatic_installed_policies?: null; // why isn't this on this interface but in the api?


Suggested change

automatic_installed_policies?: null; // why isn't this on this interface but in the api?

automatic_install_policies?: null;

This is pretty new, and must've gotten missed. Maybe @ghernandez345 knows why it isn't here?

FWIW this value is an array of these objects:

type AutomaticInstallPolicy struct { ID uint `json:"id" db:"id"` Name string `json:"name" db:"name"` TitleID uint `json:"-" db:"software_title_id"` }

For reference:
API call:
https://dogfood.fleetdm.com/api/latest/fleet/software/titles?page=0&per_page=20&order_direction=desc&order_key=hosts_count&team_id=2&vulnerable=false&exploit=false&available_for_install=true
returns a software with the following key

"app_store_app": { "app_store_id": "1333542190", "automatic_install_policies": null, "version": "7.9.11", "self_service": false, "icon_url": "https://is1-ssl.mzstatic.com/image/thumb/Purple116/v4/55/48/f1/5548f17e-3ac3-d19c-a9b2-4e5e636c19b9/AppIcon-0-0-85-220-0-0-0-0-4-0-0-0-2x-sRGB-0-0-0-0-0.png/512x512bb.png", "last_install": null, "last_uninstall": null, "package_url": null },

@iansltx I'm wondering if it wasn't suppose to be returning with this API at all? that's why it's all null?

We don't do omitempty on it, so while I'm not 100% why it's null (I'd expect an array length 0), it should show up.

iansltx · 2025-01-09T22:30:56Z

frontend/interfaces/software.ts

+  last_install?: string; // why isn't this on this interface but in the api
+  last_uninstall?: string; // why isn't this on this interface but in the api
+  version?: string; // why isn't this on this interface but in the api


Good question. FWIW last_install seems to already exist on the JS side with ISoftwareLastInstall, though it doesn't include the entire struct. The last_uninstall bit is MIA. Structs look like this:

// HostSoftwareInstall represents installation of software on a host from a // Fleet software installer. type HostSoftwareInstall struct { // InstallUUID is the the UUID of the script execution issued to install the related software. This // field is only used if the install we're describing was for an uploaded software installer. // Empty if the install was for an App Store app. InstallUUID string `json:"install_uuid,omitempty"` // CommandUUID is the UUID of the MDM command issued to install the related software. This field // is only used if the install we're describing was for an App Store app. // Empty if the install was for an uploaded software installer. CommandUUID string `json:"command_uuid,omitempty"` InstalledAt time.Time `json:"installed_at"` } // HostSoftwareUninstall represents uninstallation of software from a host with a // Fleet software installer. type HostSoftwareUninstall struct { // ExecutionID is the UUID of the script execution that uninstalled the software. ExecutionID string `json:"script_execution_id,omitempty"` UninstalledAt time.Time `json:"uninstalled_at"` }

version is indeed a string, and not sure why it isn't there.

iansltx · 2025-01-09T23:03:44Z

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx

+        const splitName = title.software_package?.name.split(".") ?? "";
+        const ext =
+          splitName.length > 1 ? splitName[splitName.length - 1] : undefined;
+        const platform = getPlatformFromExtension(ext);


Thinking we can unify/simplify the filtering by having:

Platform list (splitting commas) defined ~L167.

packagePlatform = PLATFORMS_BY_SOURCE[title?.source] ?? null which works for both VPP and installer-based titles

result of step 1 includes result of step 2 for the filter

We don't have a PLATFORM_BY_SOURCE conversion. I tried to update our interface for source since I realized it was missing linux sources, but theres a ton... I think they're all the keys of SOURCE_TYPE_CONVERSION but I don't have a map to platform, so I'm just going to keep using the goofy getPlatformFromExtension and leave a note.

export const SOURCE_PLATFORM_CONVERSION = { apt_sources: "linux", deb_packages: "linux", portage_packages: "linux", rpm_packages: "linux", yum_sources: "linux", apps: "darwin", ios_apps: "ios", ipados_apps: "ipados", homebrew_packages: "darwin", programs: "windows", chocolatey_packages: "windows", pkg_packages: "macos", } as const;

Shorter list that's still a superset of software titles with installers that we'll actually see

TODO comment committed here: e823c3a

@iansltx goat. I'll put it in Monday

@iansltx I am working in the sky today about to commit this update. I just realized if we are improving this to find the platform from the source instead of by extension, we need to update this tooltip. Ian, could you confirm this change and new tooltip with @eugkuo ?

iansltx · 2025-01-09T23:07:05Z

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx

+        return isAvailableSoftwarePackageOption || isAvailableVPPOption;
+      })
+      .map((title) => {
+        const vppOption = title.source === "apps" && !!title.app_store_app;


Seems like this would wind up simpler if we handled all of the VPP logic behind an if + early return and then fell back to the installer logic if we got there. Means duplicating L210-212 but I think that in return we'll be able to get rid of a few lines of ternaries and get the code a bi cleaner.

RachelElysia · 2025-01-10T18:52:18Z

Only other question @iansltx is around activities as I don't see any app store app activities figma that use "Fleet" as the actor in the current code. I'll also want to add tests to activityitem.tests.tsx

iansltx · 2025-01-10T18:59:30Z

"Fleet" is new for VPP. Actor will be literal "Fleet" from server side with no user ID or email, same as automated scripts and policies do now.

eugkuo · 2025-01-13T13:19:46Z

@iansltx I am working in the sky today about to commit this update. I just realized if we are improving this to find the platform from the source instead of by extension, we need to update this tooltip. Ian, could you confirm this change and new tooltip with @eugkuo ?

It sounds like we're looking for something like so (figma link)?

cc @RachelElysia

iansltx · 2025-01-13T13:32:07Z

@eugkuo tbh I'm not sure what that tooltip adds (even before this change), as it's already out of date (zips and DMGs for Fleet Maintained Apps aren't mentioned, not are VPP apps). Swapping to source listings doesn't clear things up as we don't show the raw package sources in the UI anywhere (and the revised filtering shouldn't show them either).

I'm thinking the compatibility tooltip got added as a workaround for us not filtering the software lists by platform so it's vestigial now that we filter. @noahtalerman does that sound familiar?

eugkuo · 2025-01-13T13:42:58Z

@iansltx Ah. I'm all for dropping it if we don't think it's really adding value.

cc @noahtalerman

iansltx

Thanks for the changes! Going to do the tweak I'm commenting on, as well as drop the compatible platforms tooltip entirely, as those are quick fixes, and will use this branch on top of the BE branch to test.

Since this does need the BE branch to work, 30min from now would probably be a good time to stack it.

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx

…erCard

…s for both installer types)

…s feature and we now have platform filtering

iansltx

Tested and we're looking good.

Note that I'm approving for the code I didn't write; @RachelElysia will comment to confirm review of the 4 commits of mine.

RachelElysia · 2025-01-13T18:03:38Z

@iansltx all your change are belong to us

fr everything looks good, let's merge asap after BE. lmk if there's anything else. I'm ready to test again once E2E is on main

RachelElysia requested a review from a team as a code owner January 7, 2025 16:14

RachelElysia temporarily deployed to Docker Hub January 7, 2025 16:14 — with GitHub Actions Inactive

RachelElysia assigned iansltx Jan 7, 2025

RachelElysia commented Jan 7, 2025

View reviewed changes

iansltx reviewed Jan 7, 2025

View reviewed changes

RachelElysia marked this pull request as draft January 9, 2025 15:07

RachelElysia had a problem deploying to Docker Hub January 9, 2025 22:06 — with GitHub Actions Error

RachelElysia temporarily deployed to Docker Hub January 9, 2025 22:13 — with GitHub Actions Inactive

iansltx reviewed Jan 9, 2025

View reviewed changes

RachelElysia temporarily deployed to Docker Hub January 10, 2025 15:34 — with GitHub Actions Inactive

RachelElysia had a problem deploying to Docker Hub January 10, 2025 18:35 — with GitHub Actions Error

RachelElysia force-pushed the 23528-install-sw-options-platform-filtered branch from c47b08d to 0845e1d Compare January 10, 2025 18:36

RachelElysia had a problem deploying to Docker Hub January 10, 2025 18:36 — with GitHub Actions Error

RachelElysia temporarily deployed to Docker Hub January 10, 2025 18:41 — with GitHub Actions Inactive

RachelElysia changed the title ~~Fleet UI: Only show compatible software to policy's target platform~~ Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc Jan 10, 2025

RachelElysia temporarily deployed to Docker Hub January 10, 2025 22:10 — with GitHub Actions Inactive

RachelElysia temporarily deployed to Docker Hub January 13, 2025 11:56 — with GitHub Actions Inactive

iansltx reviewed Jan 13, 2025

View reviewed changes

...d/pages/policies/ManagePoliciesPage/components/InstallSoftwareModal/InstallSoftwareModal.tsx Outdated Show resolved Hide resolved

iansltx temporarily deployed to Docker Hub January 13, 2025 14:51 — with GitHub Actions Inactive

RachelElysia added 5 commits January 13, 2025 11:15

Fleet UI: Only show compatible software to policy's target platform

25a32f5

Add vpp apps and version, other small nits

dc3c0ab

Add comment

3f4cf5b

Optimize code for less redundant runs

24af802

Update naming conventions, integrate app_store_app to SoftwareInstall…

37d9195

…erCard

RachelElysia added 4 commits January 13, 2025 11:15

Update changelog

7507cbf

Add TODO comment

d62ca28

Update tests to include app_store_app data for SoftwareDetailsPage

4defd59

Update platform mapping from extension to software source

9c3ba81

iansltx temporarily deployed to Docker Hub January 13, 2025 16:17 — with GitHub Actions Inactive

Update CSS classname

536a935

RachelElysia force-pushed the 23528-install-sw-options-platform-filtered branch from ed76903 to 536a935 Compare January 13, 2025 16:29

RachelElysia temporarily deployed to Docker Hub January 13, 2025 16:30 — with GitHub Actions Inactive

iansltx added 4 commits January 13, 2025 11:56

Drop redundant app store app check for platform selection (title work…

143fc11

…s for both installer types)

Clean up naming, imports

c952eda

Drop compatibility tooltip as it was already out of date prior to thi…

cad7c39

…s feature and we now have platform filtering

Wire up automatic install type for VPP apps in software titles list

e31d42d

iansltx temporarily deployed to Docker Hub January 13, 2025 17:56 — with GitHub Actions Inactive

iansltx marked this pull request as ready for review January 13, 2025 17:59

iansltx previously approved these changes Jan 13, 2025

View reviewed changes

Merge branch 'main' into 23528-install-sw-options-platform-filtered

cc49a7c

RachelElysia dismissed iansltx’s stale review via cc49a7c January 14, 2025 00:00

RachelElysia had a problem deploying to Docker Hub January 14, 2025 00:00 — with GitHub Actions Failure

iansltx approved these changes Jan 14, 2025

View reviewed changes

RachelElysia temporarily deployed to Docker Hub January 14, 2025 00:23 — with GitHub Actions Inactive

RachelElysia merged commit 4362843 into main Jan 14, 2025
14 checks passed

RachelElysia deleted the 23528-install-sw-options-platform-filtered branch January 14, 2025 00:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc #25202

Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc #25202

RachelElysia commented Jan 7, 2025 •

edited by iansltx

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

RachelElysia Jan 7, 2025

iansltx Jan 7, 2025

iansltx Jan 7, 2025

RachelElysia Jan 9, 2025

iansltx Jan 9, 2025

RachelElysia Jan 10, 2025 •

edited

Loading

RachelElysia Jan 10, 2025 •

edited

Loading

iansltx left a comment

iansltx Jan 9, 2025

RachelElysia Jan 10, 2025

RachelElysia Jan 10, 2025

iansltx Jan 10, 2025

iansltx Jan 9, 2025

iansltx Jan 9, 2025

RachelElysia Jan 10, 2025

iansltx Jan 10, 2025

RachelElysia Jan 10, 2025

RachelElysia Jan 10, 2025

RachelElysia Jan 13, 2025 •

edited

Loading

iansltx Jan 9, 2025

RachelElysia commented Jan 10, 2025

iansltx commented Jan 10, 2025

eugkuo commented Jan 13, 2025

iansltx commented Jan 13, 2025

eugkuo commented Jan 13, 2025

iansltx left a comment

iansltx left a comment

RachelElysia commented Jan 13, 2025

	automatic_installed_policies?: null; // why isn't this on this interface but in the api?
	automatic_install_policies?: null;

Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc #25202

Fleet UI: VPP auto install software on failed policies, filter software compatible to policy's target platform, etc #25202

Conversation

RachelElysia commented Jan 7, 2025 • edited by iansltx Loading

Issue

Description

Screenrecording of improvement

Checklist for submitter

codecov bot commented Jan 7, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RachelElysia Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

RachelElysia Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

iansltx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RachelElysia Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RachelElysia commented Jan 10, 2025

iansltx commented Jan 10, 2025

eugkuo commented Jan 13, 2025

iansltx commented Jan 13, 2025

eugkuo commented Jan 13, 2025

iansltx left a comment

Choose a reason for hiding this comment

iansltx left a comment

Choose a reason for hiding this comment

RachelElysia commented Jan 13, 2025

RachelElysia commented Jan 7, 2025 •

edited by iansltx

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

RachelElysia Jan 10, 2025 •

edited

Loading

RachelElysia Jan 10, 2025 •

edited

Loading

RachelElysia Jan 13, 2025 •

edited

Loading