[Ingest Manager] Remove success: true as top-level API response #73223

jfsiii · 2020-07-25T16:45:07Z

Summary

Implementation resulting from proposal/discussion at #73221

Key changes

Deleted top-level success property from all responses except

/check-permissions (spec & handler). I figured we'd leave this as-is and make any changes in separate pass
in array of objects returned by /package_configs/delete (spec & service)

Open issues/questions

There are a few endpoints where the only response was success: true leaving them empty now. I'm not sure how I, or others, feel about this.

agent unenroll spec & handler
agent reassign spec & handler

Some tests only looked for 200 code & success property so deleting them means we only check for 200. e.g. https://github.com/elastic/kibana/pull/73223/files#diff-a1f7d4ab42c35079093986e3068feb23 Perhaps that's ok, or perhaps we could update them to look for item or some other expected property.

update: only server/routes/agent/{acks,actions}_handlers.test.ts tests reference the success property. IMO, removing it from them doesn't affect the tests other than to reflect the correct payload.

Left in check-permissions and in array of objects returned by delete package configs

jfsiii · 2020-07-28T18:03:11Z

@elasticmachine merge upstream

elasticmachine · 2020-07-28T18:09:46Z

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

nchaulet · 2020-07-28T18:14:05Z

@michalpristas @blakerouse Are you using the success field in the agent?

ph · 2020-07-28T19:16:08Z

There are a few places that we rely on Success but not much, we could remove it, most of the code already depends on HTTP code

elastic/beats#20288

jfsiii · 2020-07-28T19:29:24Z

@elasticmachine merge upstream

jfsiii · 2020-07-29T12:19:20Z

@elasticmachine merge upstream

jfsiii · 2020-07-29T19:45:16Z

@elasticmachine merge upstream

jfsiii · 2020-07-29T22:32:12Z

@elasticmachine merge upstream

jfsiii · 2020-08-05T11:35:08Z

@elasticmachine merge upstream

jfsiii · 2020-08-27T13:11:06Z

Failing tests are unrelated to this code. Watch #75808 for fix

jfsiii · 2020-08-27T13:50:23Z

@elasticmachine merge upstream

jfsiii · 2020-08-27T14:09:55Z

@elasticmachine merge upstream

jfsiii · 2020-08-27T17:20:46Z

@ph @michalpristas CI is 💚

nchaulet

🚀

jfsiii · 2020-08-27T20:31:05Z

@paul-tavares no worries at all. thanks for the 👀 Can you approve or ping the right people when you get a moment?

jfsiii · 2020-08-31T13:21:12Z

@elasticmachine merge upstream

paul-tavares

LGTM - had one question around the use of node-fetch and whether more code is needed to determine API error response.

Also - given the discussions today around upgrades and the possibility of pre-v7.10 agents communicating with a newer version of Kibana - is this a safe change for them? (I think you said it was not being used by the Agent, so we should be OK)

x-pack/plugins/ingest_manager/scripts/dev_agent/script.ts

jfsiii · 2020-08-31T15:52:47Z

@paul-tavares, Agent did need some changes but "not much", iiuc. @michalpristas did a PR elastic/beats#20449

I'll let @michalpristas or @blakerouse comment re: auto upgrades

jfsiii · 2020-08-31T17:30:12Z

x-pack/plugins/ingest_manager/scripts/dev_agent/script.ts

@@ -122,7 +122,7 @@ async function enroll(kibanaURL: string, apiKey: string, log: ToolingLog): Promi
  });
  const obj: PostAgentEnrollResponse = await res.json();

-  if (!obj.success) {
+  if (!res.ok) {


/cc @paul-tavares

jfsiii · 2020-09-02T13:45:41Z

@elasticmachine merge upstream

kibanamachine · 2020-09-02T16:04:26Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: a29e9f5

Build metrics

async chunks size

id	value	diff	baseline
ingestManager	1.1MB	-272.0B	1.1MB

History

💚 Build #71366 succeeded b43aff0
💚 Build #71249 succeeded 58727a5
💚 Build #70858 succeeded dfccf25
💚 Build #70845 succeeded 1546bef
💔 Build #70812 failed 92e7cf1

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

…tic#73223) * Big bang commit removing top-level success property in API response Left in check-permissions and in array of objects returned by delete package configs * Remove success property from mocks * Resolve conflict from upstream changes * Remove success property (after upstream merge) * Remove more 'success'es after merging in upstream * Remove success from some tests * Remove success from OpenAPI spec * Revert prior try/catch. Use res.ok Co-authored-by: Elastic Machine <[email protected]>

…) (#76542) * Big bang commit removing top-level success property in API response Left in check-permissions and in array of objects returned by delete package configs * Remove success property from mocks * Resolve conflict from upstream changes * Remove success property (after upstream merge) * Remove more 'success'es after merging in upstream * Remove success from some tests * Remove success from OpenAPI spec * Revert prior try/catch. Use res.ok Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

jfsiii · 2020-09-04T13:04:29Z

@ph @ruflin can/should this go to 7.9.2? It's not a big conceptual/functional change, but it does have a pretty large surface area. I was hoping to avoid merge conflicts later with the many places that still have success: true in 7.9.

ph · 2020-09-04T14:40:47Z

@jfsiii I would prefer we do not backport that to 7.9.2. This has too many risks, we should keep 7.9.2 stable and really limit our backports to major issues.

See elastic/kibana#73223

* fix: "success" was remove from response See elastic/kibana#73223 * chore: double max timeout when waiting for agent's events * chore: enrich error log message * chore: add a descrciptive comment about dates as strings

Big bang commit removing top-level success property in API response

666eaf6

Left in check-permissions and in array of objects returned by delete package configs

jfsiii changed the title ~~Big bang commit removing top-level success property in API response~~ [Ingest Manager] Remove success: true as top-level API response Jul 25, 2020

Remove success property from mocks

79aa8f5

jfsiii mentioned this pull request Jul 26, 2020

[Ingest Manager] [Discuss] success property in API responses #73221

Closed

jfsiii self-assigned this Jul 26, 2020

Merge branch 'master' into 73221-remove-success

f1100e9

jfsiii marked this pull request as ready for review July 28, 2020 18:09

jfsiii requested a review from a team as a code owner July 28, 2020 18:09

jfsiii requested a review from a team July 28, 2020 18:09

jfsiii requested a review from a team as a code owner July 28, 2020 18:09

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Jul 28, 2020

jfsiii added release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v8.0.0 labels Jul 28, 2020

Merge branch 'master' into 73221-remove-success

6a5507e

Merge branch 'master' into 73221-remove-success

13be0ed

Merge branch 'master' into 73221-remove-success

3b3f719

elasticmachine and others added 2 commits July 29, 2020 16:32

Merge branch 'master' into 73221-remove-success

6b12840

Resolve conflict from upstream changes

d75323c

elasticmachine and others added 2 commits August 5, 2020 05:35

Merge branch 'master' into 73221-remove-success

4ecbb85

Remove success property (after upstream merge)

c536b0e

Remove success from OpenAPI spec

92e7cf1

Merge branch 'master' into 73221-remove-success

1546bef

Merge branch 'master' into 73221-remove-success

dfccf25

nchaulet approved these changes Aug 27, 2020

View reviewed changes

Merge branch 'master' into 73221-remove-success

58727a5

jfsiii requested review from a user and EricDavisX August 31, 2020 15:11

paul-tavares approved these changes Aug 31, 2020

View reviewed changes

x-pack/plugins/ingest_manager/scripts/dev_agent/script.ts Outdated Show resolved Hide resolved

Revert prior try/catch. Use res.ok

b43aff0

jfsiii commented Aug 31, 2020

View reviewed changes

Merge branch 'master' into 73221-remove-success

a29e9f5

jfsiii merged commit 71b9ded into elastic:master Sep 2, 2020

jfsiii mentioned this pull request Sep 2, 2020

[7.x] [Ingest Manager] Remove success: true as top-level API response (#73223) #76542

Merged

michalpristas mentioned this pull request Sep 3, 2020

Cherry-pick #20449 to 7.x: Remove Success from fleet contract elastic/beats#20947

Merged

6 tasks

mdelapenya added a commit to mdelapenya/e2e-testing that referenced this pull request Sep 9, 2020

fix: "success" was remove from response

b29774c

See elastic/kibana#73223

mdelapenya mentioned this pull request Sep 9, 2020

fix: "success" was removed from response elastic/e2e-testing#278

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Ingest Manager] Remove success: true as top-level API response #73223

[Ingest Manager] Remove success: true as top-level API response #73223

jfsiii commented Jul 25, 2020 •

edited

Loading

jfsiii commented Jul 28, 2020

elasticmachine commented Jul 28, 2020

nchaulet commented Jul 28, 2020

ph commented Jul 28, 2020

jfsiii commented Jul 28, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Aug 5, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

nchaulet left a comment

jfsiii commented Aug 27, 2020

jfsiii commented Aug 31, 2020

paul-tavares left a comment

jfsiii commented Aug 31, 2020

jfsiii Aug 31, 2020

jfsiii commented Sep 2, 2020

kibanamachine commented Sep 2, 2020

jfsiii commented Sep 4, 2020

ph commented Sep 4, 2020

[Ingest Manager] Remove success: true as top-level API response #73223

[Ingest Manager] Remove success: true as top-level API response #73223

Conversation

jfsiii commented Jul 25, 2020 • edited Loading

Summary

Key changes

Open issues/questions

jfsiii commented Jul 28, 2020

elasticmachine commented Jul 28, 2020

nchaulet commented Jul 28, 2020

ph commented Jul 28, 2020

jfsiii commented Jul 28, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Jul 29, 2020

jfsiii commented Aug 5, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

jfsiii commented Aug 27, 2020

nchaulet left a comment

Choose a reason for hiding this comment

jfsiii commented Aug 27, 2020

jfsiii commented Aug 31, 2020

paul-tavares left a comment

Choose a reason for hiding this comment

jfsiii commented Aug 31, 2020

jfsiii Aug 31, 2020

Choose a reason for hiding this comment

jfsiii commented Sep 2, 2020

kibanamachine commented Sep 2, 2020

💚 Build Succeeded

Build metrics

async chunks size

History

jfsiii commented Sep 4, 2020

ph commented Sep 4, 2020

jfsiii commented Jul 25, 2020 •

edited

Loading