Implemented actions server API for supporting preconfigured connectors #62382

YulNaumenko · 2020-04-02T22:05:09Z

Summary

Current PR exposing server API for preconfigured connectors defined in kibana.yaml.

extended api/actions/get/{id} to support return preconfigured connector by id
add rejection for update and edit preconfigured connectors
exposed endpoint api/actions/_getAll for getting all connectors - preconfigured and saved objects. This endpoint is supposed to be used instead of api/actions/_find on the UI side for building Connectors table (currently all paging, sorting and filtering is done on the UI side).

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

…s defined in kibana.yaml

elasticmachine · 2020-04-02T22:05:12Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

mikecote

This is great, heading towards the right direction!

I think we should keep using the actions terminology in the server side (variable names, TS interfaces, etc) instead of introducing connectors (front-end term).

It looks like some tests need to be fixed / updated (changing expected result in switch statements). Let me know if you need help with those.

x-pack/plugins/actions/server/types.ts

x-pack/plugins/actions/server/config.ts

x-pack/plugins/actions/server/actions_client.ts

chrisronline

LGTM from stack monitoring!

…gured-connectors-api # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

gmmorris

LGTM, but I'd like to see that comment corrected or, ideally, covered by a unit test so that it can't go out of date again.

x-pack/plugins/actions/server/actions_client.ts

…gured-connectors-api # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

pmuellr

LGTM - made a few small comments/questions

I think there may be a couple more validation things we should do, in a follow-on issue/PR:

what happens if two pre-configured actions have the same id?
what happens if someone creates a pre-configured action, that has the same id as an non-pre-configured action. Thinking someone trying to hack the system. User A creates a new slack action. User B gets the id for that action, creates a pre-configured action with the same id. Which one will be used?

pmuellr · 2020-04-06T19:29:30Z

x-pack/plugins/actions/server/actions_client.ts

@@ -29,35 +36,12 @@ interface CreateOptions {
 action: Action;
 }

-interface FindOptions {


I guess we we never need this? :-)

Seems like if we do need something like this in the future, if listing everything is too much (even with client filtering), we could provide some simple search capabilities that would work in both ES and "manual" searches through the pre-configured ones. But I guess pagination is something we just can't support anymore ...

We discussed this with @mikecote and didn't find any real usage of 'find' API method in the Kibana plugins our UI implementation - seems like we don't need this (at least for now)

x-pack/plugins/alerting/server/alerts_client.ts

pmuellr · 2020-04-06T20:04:02Z

x-pack/plugins/actions/server/actions_client.test.ts

@@ -83,6 +84,7 @@ describe('create()', () => {
 });
 expect(result).toEqual({
 id: '1',
+ isPreconfigured: false,


I'm wondering why isPreconfigured is something we're returning here. Guessing it will be nice, eventually, to somehow indicate this to the user, with some kind of "lock" icon or something. But I don't think it's really needed for anything but that, is it? Just curious, I'm +1 on having it, now that I see it, but guessing I might not have returned it if I had implemented this PR.

x-pack/test/detection_engine_api_integration/common/config.ts

x-pack/plugins/actions/server/config.ts

pmuellr · 2020-04-06T21:17:09Z

x-pack/plugins/actions/server/plugin.ts

+ const actionsConfig = (await this.config) as ActionsConfig;
+ const actionsConfigUtils = getActionsConfigurationUtilities(actionsConfig);
+
+ this.preconfiguredActions.push(


I think we should probably be running these through the actionType validators, to make sure the config/secrets get validated by the actionType. I don't think that's happening right now. I made some comments in my earlier review about other validations we should be doing, I think it's fine to do them all in a separate issue/PR.

FrankHassanabad

LGTM

mikecote

Changes LGTM! 👍

…gured-connectors-api # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

kibanamachine · 2020-04-08T16:53:13Z

💛 Build succeeded, but was flaky

continuous-integration/kibana-ci/pull-request
Commit: 3a45ea4
Flaky suites:
- xpack-siemCypress

Test Failures

Kibana Pipeline / kibana-xpack-agent / Sorts by activated rules.Signal detection rules Sorts by activated rules

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has failed 20 times on tracked branches: https:/elastic/kibana/issues/62763

Stack Trace

CypressError: Timed out retrying: expected '<a.euiLink.euiLink--primary>' to have text 'Hping Process Activity', but the text was 'User Discovery via Whoami'
    at cypressErr (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:138644:9)
    at throwErr (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:138577:11)
    at Object.throwErrByPath (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:138625:3)
    at retry (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:132905:19)
    at onFailFn (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:121122:16)
    at tryCatcher (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:165465:23)
    at Promise._settlePromiseFromHandler (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:163401:31)
    at Promise._settlePromise (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:163458:18)
    at Promise._settlePromise0 (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:163503:10)
    at Promise._settlePromises (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:163578:18)
    at Async../node_modules/bluebird/js/release/async.js.Async._drainQueue (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:160190:16)
    at Async../node_modules/bluebird/js/release/async.js.Async._drainQueues (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:160200:10)
    at Async.drainQueues (http://elastic:changeme@localhost:61121/__cypress/runner/cypress_runner.js:160074:14)

History

💔 Build #39457 failed 1b7ece6
💔 Build #39445 failed 3320dad
💔 Build #39434 failed 5669b63
💔 Build #39392 failed d475511
💔 Build #39350 failed e47b2c7

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

elastic#62382) * Implemented actions server API for supporting preconfigured connectors defined in kibana.yaml * Fixed type check * Fixed due to comments and extended functional tests * Fixed tests and renamed connectors * fixed jest tests * Fixed type checks * Fixed failing alert save * Fixed alert client tests * fixed type checks * Fixed language check error * Fixed jest tests * Added missing comments and docs * fixed due to comments * Fixed json config for preconfigured * fixed type check, reverted config * config experiment with json stringify * revert experiment * Removed the spaces from connector names in config

#62382) (#62980) * Implemented actions server API for supporting preconfigured connectors defined in kibana.yaml * Fixed type check * Fixed due to comments and extended functional tests * Fixed tests and renamed connectors * fixed jest tests * Fixed type checks * Fixed failing alert save * Fixed alert client tests * fixed type checks * Fixed language check error * Fixed jest tests * Added missing comments and docs * fixed due to comments * Fixed json config for preconfigured * fixed type check, reverted config * config experiment with json stringify * revert experiment * Removed the spaces from connector names in config

Implemented actions server API for supporting preconfigured connector…

9cfa2b0

…s defined in kibana.yaml

YulNaumenko added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.8 labels Apr 2, 2020

YulNaumenko requested a review from a team as a code owner April 2, 2020 22:05

YulNaumenko self-assigned this Apr 2, 2020

Fixed type check

cf47ef1

YulNaumenko requested a review from a team as a code owner April 3, 2020 03:50

mikecote self-requested a review April 3, 2020 12:59

mikecote reviewed Apr 3, 2020

View reviewed changes

Fixed due to comments and extended functional tests

9fa5f74

YulNaumenko requested review from a team and mikecote April 3, 2020 19:20

chrisronline approved these changes Apr 3, 2020

View reviewed changes

YulNaumenko added 2 commits April 3, 2020 14:41

Fixed tests and renamed connectors

8afc89c

gmmorris approved these changes Apr 6, 2020

View reviewed changes

x-pack/plugins/actions/server/actions_client.ts Outdated Show resolved Hide resolved

YulNaumenko added 2 commits April 6, 2020 07:33

fixed jest tests

50c55ff

pmuellr self-assigned this Apr 6, 2020

YulNaumenko added 2 commits April 6, 2020 11:11

Fixed type checks

7433623

Fixed failing alert save

104478a

mikecote added v7.8.0 and removed v7.8 labels Apr 6, 2020

YulNaumenko added 2 commits April 6, 2020 11:35

Fixed alert client tests

8323688

fixed type checks

6d936ac

Fixed language check error

5682ecb

pmuellr approved these changes Apr 6, 2020

View reviewed changes

pmuellr reviewed Apr 6, 2020

View reviewed changes

x-pack/plugins/actions/server/config.ts Outdated Show resolved Hide resolved

pmuellr reviewed Apr 6, 2020

View reviewed changes

Fixed jest tests

3d8b430

FrankHassanabad approved these changes Apr 6, 2020

View reviewed changes

Added missing comments and docs

3b78330

mikecote approved these changes Apr 7, 2020

View reviewed changes

YulNaumenko added 6 commits April 7, 2020 09:56

fixed due to comments

fc56995

Fixed json config for preconfigured

d475511

fixed type check, reverted config

5669b63

config experiment with json stringify

3320dad

revert experiment

1b7ece6

pmuellr mentioned this pull request Apr 8, 2020

[Alerting][pmuellr-experiments] Implemented actions server API for supporting preconfigured connectors #62901

Closed

Removed the spaces from connector names in config

3a45ea4

YulNaumenko merged commit 730dcbf into elastic:master Apr 8, 2020

YulNaumenko mentioned this pull request Apr 8, 2020

[7.x] Implemented actions server API for supporting preconfigured connectors (#62382) #62980

Merged

pmuellr removed their assignment Apr 9, 2020

pmuellr mentioned this pull request Apr 9, 2020

[Alerting] url collision between pre-registered actions and existing GET urls #63130

Closed

mikecote added release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Apr 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented actions server API for supporting preconfigured connectors #62382

Implemented actions server API for supporting preconfigured connectors #62382

YulNaumenko commented Apr 2, 2020 •

edited

Loading

elasticmachine commented Apr 2, 2020

mikecote left a comment

chrisronline left a comment

gmmorris left a comment

pmuellr left a comment

pmuellr Apr 6, 2020

YulNaumenko Apr 6, 2020

pmuellr Apr 6, 2020

pmuellr Apr 6, 2020

FrankHassanabad left a comment

mikecote left a comment

kibanamachine commented Apr 8, 2020

Standard Out

Stack Trace

Implemented actions server API for supporting preconfigured connectors #62382

Implemented actions server API for supporting preconfigured connectors #62382

Conversation

YulNaumenko commented Apr 2, 2020 • edited Loading

Summary

Checklist

elasticmachine commented Apr 2, 2020

mikecote left a comment

Choose a reason for hiding this comment

chrisronline left a comment

Choose a reason for hiding this comment

gmmorris left a comment

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

pmuellr Apr 6, 2020

Choose a reason for hiding this comment

YulNaumenko Apr 6, 2020

Choose a reason for hiding this comment

pmuellr Apr 6, 2020

Choose a reason for hiding this comment

pmuellr Apr 6, 2020

Choose a reason for hiding this comment

FrankHassanabad left a comment

Choose a reason for hiding this comment

mikecote left a comment

Choose a reason for hiding this comment

kibanamachine commented Apr 8, 2020

💛 Build succeeded, but was flaky

Test Failures

Standard Out

Stack Trace

History

YulNaumenko commented Apr 2, 2020 •

edited

Loading