API design: Fleet-maintained apps for macOS #21801

marko-lisica · 2024-09-04T13:26:35Z

API design for: #18865

codecov · 2024-09-04T13:29:32Z

Codecov Report

Attention: Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.

Project coverage is 63.67%. Comparing base (f5720d3) to head (8295ad9).
Report is 4 commits behind head on docs-v4.57.0.

Files with missing lines	Patch %	Lines
...s/Software/InstallStatusCell/InstallStatusCell.tsx	0.00%	2 Missing ⚠️
frontend/services/entities/software.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##           docs-v4.57.0   #21801      +/-   ##
================================================
+ Coverage         63.59%   63.67%   +0.08%     
================================================
  Files              1498     1498              
  Lines            118959   118996      +37     
  Branches           3503     3488      -15     
================================================
+ Hits              75647    75769     +122     
+ Misses            36465    36374      -91     
- Partials           6847     6853       +6

Flag	Coverage Δ
frontend	`52.27% <63.63%> (+0.01%)`	⬆️

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.

docs/REST API/rest-api.md

lukeheath

Looks good! One question a parameter.

@georgekarrv Would be good to get your eyes on this.

docs/REST API/rest-api.md

marko-lisica · 2024-09-05T11:03:32Z

docs/REST API/rest-api.md

+
+List available Fleet library apps.
+
+`GET /api/v1/fleet/software/fleet_library_apps`


Dev note:

List only apps that haven't added to a team yet.

If app is added and new version is released later, we still don't want to show that app in the list.

If user uploaded package, we want to exclude that app from the list as well

docs/REST API/rest-api.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

docs/REST API/rest-api.md

mna · 2024-09-10T12:59:54Z

docs/REST API/rest-api.md

+  "fleet_maintained_app": {
+    "id": 1,
+    "name": "1Password",
+    "file_name": "1Password-8.10.44-aarch64.zip",


@marko-lisica The filename seems to be the installer's filename from this example. We don't have this info explicitly in the brew API, should I fill this with just the last section of the installer's URL? In most case this would give a sensible filename like what you have here, but for some apps (like WhatsApp: https://web.whatsapp.com/desktop/mac_native/release/?version=2.24.16.80&extension=zip&configuration=Release&branch=relbranch), the filename would end up a bit weird (in this case, the last path segment is release, and for VSCode it would be stable).

(side-note: I think this should be called filename without underscore? We have some API parameters that accept a filename and we use filename - or at least that's the field name for the name of the file in uploads)

Hey @mna, is there any other way to retrieve filename? Could we make it if the URL doesn't end with extensions like: .dmg, .zip, .pkg, etc. then Fleet tries to download a file to get the name? Is that too complex? I think having release or stable as filename could be confusing.

I agree, we should be consistent and use filename without _. I'll update PR.

We cannot download it at the time we process the brew metadata, as this cron job only calls the JSON API, it does not start downloading the installers (we do this only when adding the maintained app to a team).

I'm curious though - what is the purpose of that field besides a light (non-critical) piece of information? Given a URL like WhatsApp , the filename of the installer could be whatever we want it to be (i.e. this is just a URL that sends some bytes, we can save those bytes under whatever filename we want). I'm thinking we could just generate a filename from the app name and installer type in this case (e.g. "whatsapp.dmg").

@mna I think I added it so users understand what will be added to Fleet. Is it .pkg, .dmg, or something else. They'll see the $INSTALLER_PATH variable in the install script, it will help understand what's behind that variable.

Since you brought this up, I think we should probably remove it or convey information that the installer will be downloaded and uploaded to Fleet server in a different way. I'm going to bring this to design review today for expedited drafting.

I added it so users understand what will be added to Fleet. Is it .pkg, .dmg, or something else. They'll see the $INSTALLER_PATH variable in the install script, it will help understand what's behind that variable.

Gotcha, makes sense.

I'm going to bring this to design review today for expedited drafting.

Sounds good, not a blocker for the moment but of course the sooner we can clarify, the better. Thanks!

@marko-lisica correct, yes we (will) have a JSON file that describes the list of maintained apps, (e.g. it contains the "brew identifier" - the part to use in the API call e.g. 1password in https://formulae.brew.sh/api/cask/1password.json), the bundle identifier associated with this app (since we can't get it from brew) and the "installer format" which is an arbitrary string that defines how the installer is bundled, and comes from your research in the google doc (e.g. "dmg:app"). At least that's the plan at the moment, see

fleet/server/mdm/maintainedapps/apps.json

Line 1 in fa62b4c

[

.

Maybe we could add the filename as part of this hard-coded JSON file? Only thing is if we want to include the version as part of the filename, that part is dynamic (we could make the filename some kind of template string that we fill with brew data). But that's a possibility!

I didn't know that we'd hardcode installer_format, but it makes sense.

Maybe we could add the filename as part of this hard-coded JSON file? Only thing is if we want to include the version as part of the filename, that part is dynamic (we could make the filename some kind of template string that we fill with brew data). But that's a possibility!

Could we simplify that, so filename is optional in this apps.json, and we provide it only for apps that have "weird" URLs (WhatsApp and VS Code)? Since we'll be defining apps that will appear in the Fleet-maintained tab, and we committed that we'll test it the first time to make sure, install/uninstall scripts work, we can do that as part of the process of adding new apps.

I think if we want accurate name we'll need it dynamic (template string that we fill with brew data)

Could we simplify that, so filename is optional in this apps.json, and we provide it only for apps that have "weird" URLs (WhatsApp and VS Code)?

Absolutely! Makes sense to me.

I think if we want accurate name we'll need it dynamic (template string that we fill with brew data)

Allright, so we want the version in there and the extension to reflect its format, correct?

@mna We decided to cut filename and use name instead. See Figma here.

@marko-lisica sounds good, thanks!

docs/REST API/rest-api.md

API design for: #18865 Old PR with discussions to remind if necessary: #21801 --------- Co-authored-by: Rachael Shaw <r@rachael.wtf> Co-authored-by: Roberto Dip <dip.jesusr@gmail.com>

Update rest-api.md

8295ad9

marko-lisica temporarily deployed to Docker Hub September 4, 2024 13:26 — with GitHub Actions Inactive

marko-lisica changed the base branch from docs-v4.57.0 to main September 4, 2024 13:29

API design - adding new endpoints for Fleet app library story

27d0734

marko-lisica temporarily deployed to Docker Hub September 4, 2024 14:10 — with GitHub Actions Inactive

marko-lisica mentioned this pull request Sep 4, 2024

Fleet-maintained apps for macOS #18865

Closed

14 tasks

marko-lisica requested a review from noahtalerman September 4, 2024 14:16

marko-lisica commented Sep 4, 2024

View reviewed changes

docs/REST API/rest-api.md Outdated Show resolved Hide resolved

lukeheath reviewed Sep 4, 2024

View reviewed changes

docs/REST API/rest-api.md Outdated Show resolved Hide resolved

Remove team_id for get Fleet library app endpoint

84207ac

marko-lisica temporarily deployed to Docker Hub September 4, 2024 15:36 — with GitHub Actions Inactive

georgekarrv reviewed Sep 4, 2024

View reviewed changes

docs/REST API/rest-api.md Outdated Show resolved Hide resolved

mna reviewed Sep 4, 2024

View reviewed changes

docs/REST API/rest-api.md Show resolved Hide resolved

georgekarrv reviewed Sep 4, 2024

View reviewed changes

docs/REST API/rest-api.md Show resolved Hide resolved

Changes discussed during estimation

b2de7fa

marko-lisica temporarily deployed to Docker Hub September 5, 2024 10:58 — with GitHub Actions Inactive

marko-lisica commented Sep 5, 2024

View reviewed changes

Changes related to 'Fleet app library' -> 'Fleet-maintaned apps'

9e6b563

marko-lisica temporarily deployed to Docker Hub September 6, 2024 11:19 — with GitHub Actions Inactive

noahtalerman changed the title ~~API design: Fleet app library for macOS~~ API design: Fleet-maintained apps for macOS Sep 6, 2024

fleet-release previously approved these changes Sep 6, 2024

View reviewed changes

noahtalerman reviewed Sep 6, 2024

View reviewed changes

docs/REST API/rest-api.md Outdated Show resolved Hide resolved

Update docs/REST API/rest-api.md

f0aa19e

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

marko-lisica dismissed fleet-release’s stale review via f0aa19e September 9, 2024 09:35

marko-lisica had a problem deploying to Docker Hub September 9, 2024 09:35 — with GitHub Actions Error

Add hyphen to all places mentioning Fleet maintained apps

6293fc3

marko-lisica temporarily deployed to Docker Hub September 9, 2024 09:40 — with GitHub Actions Inactive

mna mentioned this pull request Sep 9, 2024

API: Add list Fleet software library endpoint #21777

Closed

dantecatalfamo reviewed Sep 9, 2024

View reviewed changes

docs/REST API/rest-api.md Show resolved Hide resolved

mna reviewed Sep 10, 2024

View reviewed changes

remove underscore from file_name key

97b7fb1

marko-lisica temporarily deployed to Docker Hub September 10, 2024 13:20 — with GitHub Actions Inactive

mna reviewed Sep 10, 2024

View reviewed changes

docs/REST API/rest-api.md Show resolved Hide resolved

mna mentioned this pull request Sep 10, 2024

Ingest Fleet app library metadata from Homebrew Cask API #21773

Closed

8 tasks

jahzielv reviewed Sep 11, 2024

View reviewed changes

docs/REST API/rest-api.md Outdated Show resolved Hide resolved

Update

e1fda54

marko-lisica temporarily deployed to Docker Hub September 12, 2024 16:33 — with GitHub Actions Inactive

Update

f41a3b8

marko-lisica temporarily deployed to Docker Hub September 12, 2024 17:08 — with GitHub Actions Inactive

Update

b5063f9

marko-lisica temporarily deployed to Docker Hub September 18, 2024 12:16 — with GitHub Actions Inactive

Update

46aada2

marko-lisica had a problem deploying to Docker Hub September 18, 2024 12:51 — with GitHub Actions Error

Update

484446a

marko-lisica temporarily deployed to Docker Hub September 18, 2024 12:53 — with GitHub Actions Inactive

marko-lisica closed this Oct 1, 2024

marko-lisica mentioned this pull request Oct 1, 2024

API design: Fleet-maintained apps for macOS #22552

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API design: Fleet-maintained apps for macOS #21801

API design: Fleet-maintained apps for macOS #21801

marko-lisica commented Sep 4, 2024 •

edited

Loading

codecov bot commented Sep 4, 2024

lukeheath left a comment

marko-lisica Sep 5, 2024

mna Sep 10, 2024

marko-lisica Sep 10, 2024

mna Sep 10, 2024

marko-lisica Sep 10, 2024

mna Sep 10, 2024

mna Sep 10, 2024

marko-lisica Sep 10, 2024

mna Sep 10, 2024

marko-lisica Sep 10, 2024

mna Sep 10, 2024


		List available Fleet library apps.

		`GET /api/v1/fleet/software/fleet_library_apps`

API design: Fleet-maintained apps for macOS #21801

API design: Fleet-maintained apps for macOS #21801

Conversation

marko-lisica commented Sep 4, 2024 • edited Loading

codecov bot commented Sep 4, 2024

Codecov Report

lukeheath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dev note:

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

marko-lisica commented Sep 4, 2024 •

edited

Loading