[EPM] Update UI to handle package versions and updates #64689

neptunian · 2020-04-28T19:02:21Z

Does not check for whether the user has auto updates turned on or make any mention of it because auto updating functionality doesn't exist yet and unlikely will for Alpha
Update the Settings tab for package detail page to display version information and update option
When the user clicks on a package from the list page they will go to the version they have installed
Fixes a bug where delete promises of saved objects assets were not being returned and awaited and resolving after some assets were installed so that the next time a delete or reinstall occurred, they did not exist

Testing instructions:

This scenario where user's have out of date packages in the UI would happen if the user had auto updates turned off which will be the case for alpha but the plan is to make auto updates default.

- Install an out of date package through the API:
  POST http://localhost:5603/ssg/api/ingest_manager/epm/packages/nginx-0.0.1
- Go to the package list page and click on the "installed integrations" tab.
- Click on the installed Nginx package and notice you are redirected to the version installed (0.0.1) and not the latest (0.0.2)
- Try to update the package

User has the most up to date version of package installed

User has out of date version installed

User clicks the "update" button. Uninstall button is hidden so they don't try to uninstall during an update

A successful update. they are redirected to the new package version page (change route) and there is a success toast

An unsuccessful update attempt

Edgecases where the user navigates to a version that is not the one they have installed (perhaps from a bookmark or history as we always link to the version they have installed or the most recent if not installed).

User goes to package version that is newer than the one they have installed. I am not too concerned about this view because they would have had to guess this URL as they always get sent to the version they have installed if they have one installed and update from that version
Navigate to http://localhost:5601/ssg/app/ingestManager#/epm/detail/nginx-0.0.2 with nginx-0.0.1 installed

Navigate to http://localhost:5601/ssg/app/ingestManager#/epm/detail/nginx-0.0.1 with nginx-0.0.2 installed
User directly navigates to the url of a package that is older than the version they have installed. There are no options for installing or removing the package because its not the version they have installed.

For the edgecases, Henry and I discussed possibility of changing the package detail route from /detail/nginx-0.0.1/ to /detail/nginx to simplify things, but this would be an issue for when we support installing multiple versions at once

@ruflin should we be blocking installations or updates to a version that is not the latest version?

elasticmachine · 2020-04-28T19:02:23Z

Pinging @elastic/ingest-management (Team:Ingest Management)

kibanamachine · 2020-04-28T22:53:52Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 67bbd65

History

💔 Build #43864 failed 0efa940

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

skh · 2020-04-29T04:16:20Z

Can you add instructions how to test all the cases?

ruflin · 2020-04-29T07:15:13Z

@neptunian What happens if a user will try to upgrade from the API? What are the API calls he has to make? Could you share an example?

neptunian · 2020-04-29T11:35:30Z

@ruflin It's the same as installing:
http://localhost:5603/ssg/api/ingest_manager/epm/packages/nginx-0.0.1

Those changes were made as part of a different PR where the update and install became idempotent.

I was going to add the API restriction where they cannot update to a lower version as part of another PR.

neptunian · 2020-04-29T11:38:37Z

@skh if you follow the user stories i have above each image, that was intended to be the instructions for testing. what did you have in mind?

skh · 2020-04-29T11:50:28Z

@neptunian Basically, how do I install an outdated package in the first place? Through the API?

neptunian · 2020-04-29T11:56:06Z

@skh good point. I updated the description with instructions

neptunian · 2020-04-29T12:00:19Z

@skh after i took screenshots the registry appears to have been updated with nginx version 0.0.2 being added and 1.2.0 removed so wherever you see 1.2.0 use or think of 0.0.2

ruflin · 2020-04-29T13:07:53Z

@neptunian We need to rethink the API here. Because someone using the API should not have to figure out first to which version he will upgrade or otherwise have an API endpoint that gives him this information. But let not block yourself on this and move forward with what you have.

neptunian · 2020-04-29T13:23:48Z

@ruflin we need to change the routes to support this but we could do something like:
POST http://localhost:5603/ssg/api/ingest_manager/epm/packages/nginx or some specific update flag.
I am not sure whether to always take into mind the idea of having multiple packages installed at once because that impacts design a lot.

skh

@neptunian Thank you for the updated description!

Works as described, nice job. 👍

jfsiii

Fantastic description with testing instructions and screenshots of user states / flows ✨

I left some comments but nothing too big.

I would like to avoid the new items in PackageAdditions, but we can come back to that later if at all.

Nice work

jfsiii · 2020-04-29T13:35:21Z

...ingest_manager/public/applications/ingest_manager/sections/epm/hooks/use_package_install.tsx

+            version,
+            panel: 'settings',
+          });
+          window.location.href = settingsUrl;


I think we should use useHistory or something besides window here, but this isn't the only place we do this so not a blocker.

jfsiii · 2020-04-29T13:49:17Z

x-pack/plugins/ingest_manager/server/services/epm/packages/index.ts

@@ -43,6 +43,7 @@ export function createInstallableFrom<T>(
    ? {
        ...from,
        status: InstallationStatus.installed,
+        installedVersion: savedObject.attributes.version,


Isn't this available already using status and version independently?

Here is an example of a response when you have 0.0.1 installed but GET api/ingest_manager/epm/packages/nginx-0.0.2. The version returned is the version you requested. The installedVersion is the saved object one and the latestVersion is the latest available. They can all be different. I put them in this endpoint because I didn't want to have to make different requests to get the latest or installed version.

jfsiii · 2020-04-29T13:59:27Z

x-pack/plugins/ingest_manager/server/services/epm/packages/install.ts

@@ -106,7 +106,7 @@ export async function installPackage(options: {
    try {
      await deleteKibanaSavedObjectsAssets(savedObjectsClient, installedPkg.attributes.installed);
    } catch (err) {
-      // some assets may not exist if deleting during a failed update
+      // log these errors, some assets may not exist if deleted during a failed update


Add logging or a ticket for it?

I'm not sure what we should be logging. I've created another issue to track it #64814

* link to installed version of detail page * add latestVersion property to EPM get package endpoint * add updates available notices * add update package button * handle various states and send installedVersion from package endpoint * fix type errors * fix install error because not returning promises * track version in state * handle unsuccessful update attempt * remove unused variable

* link to installed version of detail page * add latestVersion property to EPM get package endpoint * add updates available notices * add update package button * handle various states and send installedVersion from package endpoint * fix type errors * fix install error because not returning promises * track version in state * handle unsuccessful update attempt * remove unused variable Co-authored-by: Elastic Machine <[email protected]>

…bana into pipeline-editor-part-mvp-2 * 'feature/ingest-node-pipelines' of github.com:elastic/kibana: (90 commits) remove unused import address review feedback [Ingest pipelines] Cleanup (elastic#64794) [Ingest] Edit datasource UI (elastic#64727) [Lens] Bind all time fields to the time picker (elastic#63874) [Lens] Use suggestion system in chart switcher for subtypes (elastic#64613) Improve alpha messaging (elastic#64692) [Ingest] Allow to enable monitoring of elastic agent (elastic#63598) [Metrics UI] Fix alerting when a filter query is present (elastic#64575) skip flaky suite (elastic#64812) (elastic#64723) [Maps] do not display EMS or kibana layer wizards when not configured (elastic#64554) [Reporting/Test] Convert functional test code to Typescript (elastic#64601) make inserting timestamp with navigate methods optional with default true (elastic#64655) [EPM] Update UI to handle package versions and updates (elastic#64689) Minimize dependencies required by our telemetry middleware (elastic#64665) [Telemetry] oss api tests (elastic#64602) [ML] Adding endpoint capability checks (elastic#64662) Update jest config for coverage (elastic#64648) [SIEM][NP] Fixes bug in ML signals promotion (elastic#64720) share single data plugin bundle (elastic#64549) ...

neptunian added 9 commits April 28, 2020 13:37

link to installed version of detail page

10ab20e

add latestVersion property to EPM get package endpoint

fff1528

add updates available notices

91995fc

add update package button

8726816

handle various states and send installedVersion from package endpoint

ce3c1e9

fix type errors

d01fa2b

fix install error because not returning promises

0239251

track version in state

b7bef4f

handle unsuccessful update attempt

0efa940

neptunian added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Feature:EPM Fleet team's Elastic Package Manager (aka Integrations) project v7.8.0 Team:Fleet Team label for Observability Data Collection Fleet team labels Apr 28, 2020

neptunian requested a review from a team April 28, 2020 19:02

neptunian self-assigned this Apr 28, 2020

neptunian changed the title ~~[EPM] Update UI to handle package versions~~ [EPM] Update UI to handle package versions and updates Apr 28, 2020

remove unused variable

67bbd65

skh approved these changes Apr 29, 2020

View reviewed changes

jfsiii approved these changes Apr 29, 2020

View reviewed changes

neptunian merged commit 53ff229 into elastic:master Apr 29, 2020

neptunian mentioned this pull request Apr 29, 2020

[7.x] [EPM] Update UI to handle package versions and updates (#64689) #64819

Merged

neptunian mentioned this pull request Apr 29, 2020

[EPM] add restrictions to update/install packages #64820

Closed

jen-huang mentioned this pull request Apr 30, 2020

[EPM] Handle outdated package versions #64255

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[EPM] Update UI to handle package versions and updates #64689

[EPM] Update UI to handle package versions and updates #64689

neptunian commented Apr 28, 2020 •

edited

Loading

elasticmachine commented Apr 28, 2020

kibanamachine commented Apr 28, 2020

skh commented Apr 29, 2020

ruflin commented Apr 29, 2020

neptunian commented Apr 29, 2020 •

edited

Loading

neptunian commented Apr 29, 2020

skh commented Apr 29, 2020

neptunian commented Apr 29, 2020

neptunian commented Apr 29, 2020 •

edited

Loading

ruflin commented Apr 29, 2020

neptunian commented Apr 29, 2020 •

edited

Loading

skh left a comment

jfsiii left a comment

jfsiii Apr 29, 2020

jfsiii Apr 29, 2020

neptunian Apr 29, 2020 •

edited

Loading

jfsiii Apr 29, 2020

neptunian Apr 29, 2020

[EPM] Update UI to handle package versions and updates #64689

[EPM] Update UI to handle package versions and updates #64689

Conversation

neptunian commented Apr 28, 2020 • edited Loading

Testing instructions:

Edgecases where the user navigates to a version that is not the one they have installed (perhaps from a bookmark or history as we always link to the version they have installed or the most recent if not installed).

elasticmachine commented Apr 28, 2020

kibanamachine commented Apr 28, 2020

💚 Build Succeeded

History

skh commented Apr 29, 2020

ruflin commented Apr 29, 2020

neptunian commented Apr 29, 2020 • edited Loading

neptunian commented Apr 29, 2020

skh commented Apr 29, 2020

neptunian commented Apr 29, 2020

neptunian commented Apr 29, 2020 • edited Loading

ruflin commented Apr 29, 2020

neptunian commented Apr 29, 2020 • edited Loading

skh left a comment

Choose a reason for hiding this comment

jfsiii left a comment

Choose a reason for hiding this comment

jfsiii Apr 29, 2020

Choose a reason for hiding this comment

jfsiii Apr 29, 2020

Choose a reason for hiding this comment

neptunian Apr 29, 2020 • edited Loading

Choose a reason for hiding this comment

jfsiii Apr 29, 2020

Choose a reason for hiding this comment

neptunian Apr 29, 2020

Choose a reason for hiding this comment

neptunian commented Apr 28, 2020 •

edited

Loading

neptunian commented Apr 29, 2020 •

edited

Loading

neptunian commented Apr 29, 2020 •

edited

Loading

neptunian commented Apr 29, 2020 •

edited

Loading

neptunian Apr 29, 2020 •

edited

Loading