[Connectors] moves the connector deprecation check to the server side #130541

gmmorris · 2022-04-19T09:52:18Z

Summary

This PR moves the deprecation check for connectors to the server side.

This is groundwork needed to address an issue raised by this cases PR: #130372
With Cases supporting PreConfigured connectors again they need to be able to identify deprecated connectors even when they are PreConfigured.

This change is required as the deprecation check for ServiceNow relies on the configuration of the connector, and exposing this configuration to users can be problematic from a security perspective. While this is relatively safe with regular connectors, as we can perform a privilege check for these, it's less secure for preconfigured connectors, as these are not space aware.

To address this this PR:

Moved the deprecation check to the server side
Exposes the result of this check on all APIs that retried connectors using a new is_deprecated field on APIs such as get, getAll, create etc.

Checklist

Delete any items that are not applicable to this PR.

~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2022-04-21T12:11:43Z

Pinging @elastic/response-ops (Team:ResponseOps)

szabosteve

API docs changes LGTM!

gmmorris · 2022-04-21T13:54:57Z

@elasticmachine merge upstream

gmmorris · 2022-04-22T11:56:37Z

@elasticmachine merge upstream

gmmorris · 2022-04-25T08:38:23Z

@elasticmachine merge upstream

shahzad31

Uptime changes LGTM !!

kibana-ci · 2022-04-25T09:52:01Z

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`actions`	127	128	+1

Async chunks

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

id	before	after	diff
`synthetics`	783.7KB	783.7KB	+31.0B
`triggersActionsUi`	711.7KB	712.4KB	+750.0B
total			+781.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`triggersActionsUi`	100.2KB	100.0KB	-169.0B

Unknown metric groups

API count

id	before	after	diff
`actions`	127	128	+1

History

💔 Build #40033 failed d28b901
💚 Build #39826 succeeded 7c89635
💔 Build #39707 failed 713cec9
💔 Build #39272 failed 1ed02a3
💔 Build #39220 failed b9b44de

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

ersin-erdal · 2022-04-25T11:09:20Z

x-pack/plugins/actions/server/routes/update.test.ts

@@ -146,6 +149,7 @@ describe('updateActionRoute', () => {
      name: 'My name',
      config: { foo: true },
      isPreconfigured: false,
+      isDeprecated: false,


Should we test at least one of the routes with a isDeprecated: true result?

As we have a few of those in the end-to-end tests I didn't think it was critical to have every possible output covered in the unit test as well at route level (it is tested on the client itself).

Thanks Ersin!

ersin-erdal

If we think that a positive test case is not required in for some test cases the rest LGTM :)

ymao1 · 2022-04-25T12:30:23Z

x-pack/plugins/actions/server/lib/is_conector_deprecated.ts

+export const isConnectorDeprecated = (
+  connector: RawAction | ConnectorWithOptionalDeprecation
+): boolean => {
+  if (connector.actionTypeId === '.servicenow' || connector.actionTypeId === '.servicenow-sir') {


Do we not need to worry about .servicenow-itom?

I don't know - I just moved the existing check to the server side.
@cnasikas ?

Christos is on PTO, so I'll leave that enhancement to another time (seeing as this is the existing functionality on main).

Thanks for the feedback @ymao1

Thank you @gmmorris for this PR 🚀 ! .servicenow-itom does not use an application so we do not have to worry about it.

YulNaumenko

Security Solution changes LGTM

…elastic#130541) This PR fixes a UI glitch where preconfigured connectors couldn't show a deprecation warning on SN connectors as the check on the client side couldn't support them.

moved deprecattion check to the server side

e37b832

gmmorris added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX labels Apr 19, 2022

gmmorris added 14 commits April 19, 2022 10:53

Merge branch 'main' into fix-connector-deprecation-for-preconfigured

4427d8b

fixed typing issues

2c787e0

fixed a bunch of unit tests

f00817f

fixed mocks

b2e6bb5

added missing isDeprecated field on mock connectors

8adeb96

added missing isDeprecated field on mock connectors

e9dbfe4

fixed typing in cases

de04c70

fixed tests

3d78a32

updated docs

6335866

fixed typing

896c734

fixed typing

b9b44de

fixed test

1ed02a3

fixed test

4d682c2

Merge branch 'main' into fix-connector-deprecation-for-preconfigured

713cec9

gmmorris marked this pull request as ready for review April 21, 2022 12:11

gmmorris requested review from a team as code owners April 21, 2022 12:11

gmmorris changed the title ~~moved depreciation check to the server side~~ [Connectors] moves the connector depreciation check to the server side Apr 21, 2022

szabosteve approved these changes Apr 21, 2022

View reviewed changes

gmmorris changed the title ~~[Connectors] moves the connector depreciation check to the server side~~ [Connectors] moves the connector deprecation check to the server side Apr 21, 2022

Merge branch 'main' into fix-connector-deprecation-for-preconfigured

7c89635

gmmorris added enhancement New value added to drive a business result release_note:enhancement and removed enhancement New value added to drive a business result labels Apr 21, 2022

gmmorris added the v8.3.0 label Apr 21, 2022

Merge branch 'main' into fix-connector-deprecation-for-preconfigured

d28b901

kibanamachine requested a review from a team as a code owner April 22, 2022 11:56

Merge branch 'main' into fix-connector-deprecation-for-preconfigured

8428a89

gmmorris mentioned this pull request Apr 25, 2022

[Actions] Expose config value for preconfigured connectors for GET all api/actions/connectors #119696

Closed

shahzad31 approved these changes Apr 25, 2022

View reviewed changes

ersin-erdal reviewed Apr 25, 2022

View reviewed changes

ersin-erdal approved these changes Apr 25, 2022

View reviewed changes

ymao1 reviewed Apr 25, 2022

View reviewed changes

YulNaumenko approved these changes Apr 25, 2022

View reviewed changes

gmmorris merged commit eb043f7 into elastic:main Apr 26, 2022

kibanamachine added the backport:skip This commit does not require backporting label Apr 26, 2022

cnasikas mentioned this pull request Apr 27, 2022

[Cases] Use the isDeprecated field to check for deprecated connectors. #131033

Closed

gmmorris added release_note:skip Skip the PR/issue when compiling release notes and removed release_note:enhancement labels Jun 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Connectors] moves the connector deprecation check to the server side #130541

[Connectors] moves the connector deprecation check to the server side #130541

gmmorris commented Apr 19, 2022 •

edited by cnasikas

Loading

elasticmachine commented Apr 21, 2022

szabosteve left a comment

gmmorris commented Apr 21, 2022

gmmorris commented Apr 22, 2022

gmmorris commented Apr 25, 2022

shahzad31 left a comment

kibana-ci commented Apr 25, 2022

API count

ersin-erdal Apr 25, 2022

gmmorris Apr 25, 2022

ersin-erdal left a comment

ymao1 Apr 25, 2022

gmmorris Apr 25, 2022

gmmorris Apr 26, 2022

cnasikas Apr 27, 2022

YulNaumenko left a comment •

edited

Loading

[Connectors] moves the connector deprecation check to the server side #130541

[Connectors] moves the connector deprecation check to the server side #130541

Conversation

gmmorris commented Apr 19, 2022 • edited by cnasikas Loading

Summary

Checklist

For maintainers

elasticmachine commented Apr 21, 2022

szabosteve left a comment

Choose a reason for hiding this comment

gmmorris commented Apr 21, 2022

gmmorris commented Apr 22, 2022

gmmorris commented Apr 25, 2022

shahzad31 left a comment

Choose a reason for hiding this comment

kibana-ci commented Apr 25, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

ersin-erdal Apr 25, 2022

Choose a reason for hiding this comment

gmmorris Apr 25, 2022

Choose a reason for hiding this comment

ersin-erdal left a comment

Choose a reason for hiding this comment

ymao1 Apr 25, 2022

Choose a reason for hiding this comment

gmmorris Apr 25, 2022

Choose a reason for hiding this comment

gmmorris Apr 26, 2022

Choose a reason for hiding this comment

cnasikas Apr 27, 2022

Choose a reason for hiding this comment

YulNaumenko left a comment • edited Loading

Choose a reason for hiding this comment

gmmorris commented Apr 19, 2022 •

edited by cnasikas

Loading

YulNaumenko left a comment •

edited

Loading