[Fleet] Make integration names globally unique #115212

criamico · 2021-10-15T15:14:17Z

Summary

Implements #72948

Currently, when installing an integration package, the name has to be unique per agent policy. This allows to have several integrations across policies having the same name, which can be confusing for the user.

This PR changes the logic in PackagePolicyService to ensure that the name is globally unique and updates the component step_define_package_policy to change the naming displayed in the form to be incremented based on all the package policies.

Repro steps

Test case 1 (Adding an integration with an already used name)

Add an integration (for instance apache)
Go to the integration's policies tab ( app/integrations/detail/apache-1.1.1/policies), and click on Add Apache
When the editor opens up put the same name as before.
You should see a popup "There is already a package with the same name"
Repeat this case both with the same agent policy and with a different one

Test case 2 (Adding an integration with a unique name)

Click on Add Apache
In the editor choose a different name
The integration should install regularly

Test case 3 (Pre-filled name increments globally)

Click on Add Apache
Regardless of which agent policy you choose, check that the pre-filled name in the form is the highest number already present, incremented by one
For instance, if you had Apache-2 it should now be Apache-3:
If you just install it should work regularly

Test case 4 (Upgrading a policy)

Upgrade a policy (with or without conflicts)
The name shouldn't change

Test case 5 (Duplicating an agent policy)

Duplicate an agent policy, then open it
All the installed integration should now have name with format Name (copy)

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2021-10-15T15:49:04Z

Pinging @elastic/fleet (Team:Fleet)

criamico · 2021-10-18T09:00:36Z

@elasticmachine merge upstream

x-pack/plugins/fleet/server/services/package_policy.ts

...ations/fleet/sections/agent_policy/create_package_policy_page/step_define_package_policy.tsx

nchaulet · 2021-10-20T14:59:10Z

I think we could have an issue with that feature and preconfigured policy, we generate a package policy name for preconfigured policy and not sure how it will work with that feature

criamico · 2021-10-20T15:09:25Z

@nchaulet thanks for pointing it out. How can I test the preconfigured policy?

nchaulet · 2021-10-20T15:10:59Z

@criamico You can add some policies to your kibana config file, like this for example

xpack.fleet.agentPolicies:
  - name: Test agent policy 2
    id: test-policy-2
    monitoring_enabled: []
    package_policies:
      - package:
          name: fleet_server
        name: Fleet Server
        inputs:
          - type: fleet-server
            keep_enabled: true
            ```

kibanamachine · 2021-10-20T16:18:52Z

⏳ Build in-progress, with failures

continuous-integration/kibana-ci/pull-request
Commit: 766e9e8575c6cd935614c094b6be225cb31d37cc
Storybooks Preview
This comment will update when the build is complete

Failed CI Steps

History

💔 Build #163288 failed c10685f000dbc9b1b8f82a648538b5a30e1f80c2
💔 Build #162790 failed 09d42c9619cfaacffc33c81473c719ea0c6c8c86
💔 Build #162703 failed 8eab9fceface3948be34dd2839537eeb5ff1b1f1
💔 Build #161911 failed 74a21be59141af6ef91e4c1c9c50557e35b2127f
💔 Build #161538 failed 1dededf14e28ae8814ae699a06de26b97e323c73

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

cc @criamico

kibanamachine · 2021-11-03T15:54:45Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	615.7KB	615.9KB	+185.0B

History

💔 Build #3929 failed c02f5b7268f70278ace71625d3cc6ae43a5db455
💔 Build #3639 failed 6fd058c9a1c209cb5ba82fdf022b7126f845b28f
💔 Build #3574 failed 368381bd33854eb44f71888cd9b4c2124b788e39
💔 Build #2898 failed 03b95b65ed4d35a95b8d171d544be28c666af95f
💔 Build #2833 failed 2f158d3de23fd90ff24d892a269f3d66cae9f89c

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

cc @criamico

kibanamachine · 2021-11-03T16:41:39Z

The following labels were identified as gaps in your version labels and will be added automatically:

v8.1.0

If any of these should not be on your pull request, please manually remove them.

* [Fleet] Make integration names globally unique * Fix Jest tests * Append (copy) to names of integration packages belonging to duplicated policy * Update current policy maintaining its name * Fix failing tests

kibanamachine · 2021-11-03T16:44:29Z

💚 Backport successful

Status	Branch	Result
✅	8.0
✅	7.16

The backport PRs will be merged automatically after passing CI.

* [Fleet] Make integration names globally unique * Fix Jest tests * Append (copy) to names of integration packages belonging to duplicated policy * Update current policy maintaining its name * Fix failing tests Co-authored-by: Cristina Amico <[email protected]>

kibanamachine · 2021-11-04T16:49:49Z