Remove default EXE install/uninstall scripts, require entering install/uninstall scripts on EXE upload #27268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #27268 +/- ##
==========================================
- Coverage 63.72% 63.72% -0.01%
==========================================
Files 1747 1748 +1
Lines 165935 166129 +194
Branches 4518 4583 +65
==========================================
+ Hits 105748 105866 +118
- Misses 51924 51987 +63
- Partials 8263 8276 +13
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
iansltx
commented
Mar 19, 2025
Comment on lines
37
to
45
| Use the $INSTALLER_PATH variable to point to the installer.{" "} | ||
| {getSupportedScriptTypeText(pkgType)}.{" "} | ||
| <CustomLink | ||
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | ||
| text="EXE install scripts must be built manually." | ||
| newTab | ||
| />{" "} | ||
| Fleet can automatically build install and uninstall scripts for MSI | ||
| packages and Fleet-maintained Apps. |
There was a problem hiding this comment.
iansltx
commented
Mar 19, 2025
Comment on lines
73
to
83
| return ( | ||
| <> | ||
| $PACKAGE_ID will be populated with the {PKG_TYPE_TO_ID_TEXT[pkgType]}{" "} | ||
| from the .{pkgType} file after the software is added.{" "} | ||
| {getSupportedScriptTypeText(pkgType)}{" "} | ||
| <CustomLink | ||
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | ||
| text="EXE uninstall scripts must be built manually." | ||
| newTab | ||
| />{" "} | ||
| Fleet can automatically build install and uninstall scripts for MSI | ||
| packages and Fleet-maintained Apps. | ||
| </> |
There was a problem hiding this comment.
frontend/pages/SoftwarePage/components/PackageAdvancedOptions/PackageAdvancedOptions.tsx
Outdated
Show resolved
Hide resolved
Comment on lines
75
to
84
| $PACKAGE_ID will be populated with the {PKG_TYPE_TO_ID_TEXT[pkgType]}{" "} | ||
| from the .{pkgType} file after the software is added.{" "} | ||
| {getSupportedScriptTypeText(pkgType)}{" "} | ||
| <CustomLink | ||
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | ||
| text="EXE uninstall scripts must be built manually." | ||
| newTab | ||
| />{" "} | ||
| Fleet can automatically build install and uninstall scripts for MSI | ||
| packages and Fleet-maintained Apps. |
There was a problem hiding this comment.
Suggested change
| $PACKAGE_ID will be populated with the {PKG_TYPE_TO_ID_TEXT[pkgType]}{" "} | |
| from the .{pkgType} file after the software is added.{" "} | |
| {getSupportedScriptTypeText(pkgType)}{" "} | |
| <CustomLink | |
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | |
| text="EXE uninstall scripts must be built manually." | |
| newTab | |
| />{" "} | |
| Fleet can automatically build install and uninstall scripts for MSI | |
| packages and Fleet-maintained Apps. | |
| For Windows, Fleet only creates uninstall scripts for .msi packages. $PACKAGE_ID will be populated with the software name from the .exe file after it's added. | |
| {getSupportedScriptTypeText(pkgType)}{" "} | |
| <CustomLink | |
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | |
| text="Learn more" | |
| newTab | |
| /> |
lukeheath
reviewed
Mar 19, 2025
| return ( | ||
| <> | ||
| For Windows, Fleet only creates install scripts for .msi packages. Use the $INSTALLER_PATH variable to point to the installer. {" "} | ||
| {getSupportedScriptTypeText(pkgType)}.{" "} |
There was a problem hiding this comment.
Suggested change
| {getSupportedScriptTypeText(pkgType)}.{" "} | |
| {getSupportedScriptTypeText(pkgType)}{" "} |
There was a problem hiding this comment.
I think this may result in a double period.
lukeheath
reviewed
Mar 19, 2025
frontend/pages/SoftwarePage/components/PackageAdvancedOptions/PackageAdvancedOptions.tsx
Outdated
Show resolved
Hide resolved
lukeheath
reviewed
Mar 19, 2025
frontend/pages/SoftwarePage/components/PackageAdvancedOptions/PackageAdvancedOptions.tsx
Outdated
Show resolved
Hide resolved
| url={`${LEARN_MORE_ABOUT_BASE_LINK}/exe-install-scripts`} | ||
| text="Learn more" | ||
| newTab | ||
| />{" "} |
There was a problem hiding this comment.
Suggested change
| />{" "} | |
| /> |
We don't need this right?
There was a problem hiding this comment.
This inserts a space, so not unless there's text after it.
| @@ -389,6 +392,9 @@ func (svc *Service) UpdateSoftwareInstaller(ctx context.Context, payload *fleet. | |||
| if uninstallScript == "" { // extension can't change on an edit so we can generate off of the existing file | |||
| uninstallScript = file.GetUninstallScript(existingInstaller.Extension) | |||
| } | |||
| if uninstallScript == "" { | |||
| return nil, ctxerr.New(ctx, fmt.Sprintf("uninstall script must be provided for %s packages", strings.ToUpper(existingInstaller.Extension))) | |||
There was a problem hiding this comment.
@iansltx I think we want the "Couldn't add. Install script is required for .exe packages":
Same tweak for uninstall error.
|
@iansltx jumping on finishing this now |
RachelElysia
force-pushed
the
27267-drop-exe-install-scripts
branch
from
31ef6a3 to
9796ebf
Compare
|
Since the form originally has the Add software button disabled, I added validation to keep it disabled if .exe file was chosen but install and uninstall scripts are not filled out. See screenshots below. WDYT? @iansltx @noahtalerman 
|
|
Deferring to @noahtalerman on copy here, but the behavior LGTM! Nice and clear, and keeps folks from doing something that we know will fail server-side. |
iansltx
force-pushed
the
27267-drop-exe-install-scripts
branch
from
7a68265 to
c7234d9
Compare
iansltx
force-pushed
the
27267-drop-exe-install-scripts
branch
from
a56f5cb to
1282182
Compare
…l/uninstall scripts on EXE upload For #27267. TODO: * Tests * GitOps requirements changes * Disabling add button/adding errors when required scripts aren't specified
…PackageAdvancedOptions.tsx Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
…PackageAdvancedOptions.tsx
…PackageAdvancedOptions.tsx
…, revise uninstall copy based on @noahtalerman's suggestion
Still need to fix the integration test
iansltx
force-pushed
the
27267-drop-exe-install-scripts
branch
from
1282182 to
20d860b
Compare
…s with parse errors when validating YAML If the URL path doesn't end with .exe, we'll still catch EXEs later in the process when the package is downloaded by Fleet, but for easier cases we might as well fail early.
|
@ghernandez345 Assigning you here since Rachel and I have both touched this on the FE side so this should get a separate set of eyes. @ksykulev Your review responsibilities are backend + gitops + associated tests only. |
iansltx
requested review from
georgekarrv,
sharon-fdm and
mostlikelee
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #27267.
Below is what's shown immediately after selecting an EXE:
TODO:
Checklist for submitter
If some of the following don't apply, delete the relevant line.
changes/,orbit/changes/oree/fleetd-chrome/changes.See Changes files for more information.
SELECT *is avoided, SQL injection is prevented (using placeholders for values in statements)