Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Uptime] Index Status API to Rest #59657

Merged
merged 7 commits into from
Mar 16, 2020
Merged

[Uptime] Index Status API to Rest #59657

merged 7 commits into from
Mar 16, 2020

Conversation

shahzad31
Copy link
Contributor

Summary

As part of #58020

Convert Index Status API from GQL to rest !!

@andrewvc andrewvc mentioned this pull request Mar 9, 2020
Closed
4 tasks
@shahzad31 shahzad31 self-assigned this Mar 9, 2020
@shahzad31 shahzad31 added release_note:skip Skip the PR/issue when compiling release notes v7.7.0 v8.0.0 labels Mar 9, 2020
@shahzad31 shahzad31 added the Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability label Mar 9, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/uptime (Team:uptime)

justinkambic
justinkambic reviewed Mar 10, 2020
View reviewed changes
Copy link
Contributor

@justinkambic justinkambic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good to me, had one comment that we maybe should chat about offline.

x-pack/legacy/plugins/uptime/common/constants/rest_api.ts
*/

export enum REST_API_URLS {
INDEX_STATUS = '/api/uptime/index_status',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the thinking that we will add all the URL paths here as we touch them? If so it might be good to add a follow-up issue for this so to jumpstart adoption.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

already done in https://github.com/elastic/kibana/pull/59881/files#diff-a031a8d6fa7f865508620d9c4408ad4d

x-pack/legacy/plugins/uptime/public/state/api/index_status.ts
if (!response.ok) {
throw new Error(response.statusText);
}
const responseData = await response.json();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We keep adding such similar boilerplate for making fetch requests, I think we could really abstract a lot of this code away with a generic function.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also done in https://github.com/elastic/kibana/pull/59881/files

x-pack/legacy/plugins/uptime/public/state/effects/index_status.ts
export function* fetchIndexStatusEffect() {
yield takeLatest(
indexStatusAction.get,
fetchEffectFactory(fetchIndexStatus, indexStatusAction.success, indexStatusAction.fail)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

fetchEffectFactory(fetchIndexStatus, indexStatusAction.success, indexStatusAction.fail)

I like this get, success, fail pattern.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, it really makes usage simple.

x-pack/plugins/uptime/server/rest_api/index_state/get_index_status.ts
},
});
} catch (e) {
return response.internalError({ body: { message: e.message } });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrewvc has expressed reservations about returning descriptive error messages, this might be something we want to discuss here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i am not sure what do you mean by that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrewvc would you have any issue with returning this message? I thought I remembered you expressing concern about security implications of exposing error messages in API responses.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created elastic/uptime#156 to address this.

justinkambic
justinkambic approved these changes Mar 13, 2020
View reviewed changes
Copy link
Contributor

@justinkambic justinkambic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shahzad31
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

History

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

@shahzad31 shahzad31 merged commit 168239c into elastic:master Mar 16, 2020
@shahzad31 shahzad31 deleted the index-status-api branch March 16, 2020 11:39
gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 16, 2020
@gmmorris
Merge branch 'master' into alerting/view-in-app
5d3a7ef 
* master:
  [Step 1][App Arch] Saved object migrations from kibana plugin to new platform  (elastic#59044)
  adds new test (elastic#60064)
  [Uptime] Index Status API to Rest (elastic#59657)
gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 16, 2020
@gmmorris
Merge branch 'master' into alerting/tls-warning
7cc50e3 
* master: (40 commits)
  skips 'config_open.ts' files from linter check (elastic#60248)
  [Searchprofiler] Spacing between rendered shards (elastic#60238)
  Add UiSettings validation & Kibana default route redirection (elastic#59694)
  [SIEM][CASE] Change configuration button (elastic#60229)
  [Step 1][App Arch] Saved object migrations from kibana plugin to new platform  (elastic#59044)
  adds new test (elastic#60064)
  [Uptime] Index Status API to Rest (elastic#59657)
  [SIEM] Adds 'Closes and opens signals' Cypress test (elastic#59950)
  [NP] Graph migration (elastic#59409)
  [ML] Clone analytics job  (elastic#59791)
  Move VALUE_CLICK_TRIGGER and APPLY_FILTER_TRIGGER to ui_action… (elastic#60202)
  Handle improperly defined Watcher Logging Action text parameter. (elastic#60169)
  Move select range trigger to uiActions (elastic#60168)
  [SIEM][CASES] Configure cases: Final (elastic#59358)
  Closes elastic#59784. Sets xpack.apm.serviceMapEnabled default value true. (elastic#60153)
  [siem/cypress] update junit filename to be picked up by runbld (elastic#60156)
  OSS logic added to test environment  (elastic#60134)
  Move canvas setup into app mount (elastic#59926)
  enable triggers_actions_ui plugin by default (elastic#60137)
  Expose Elasticsearch from start and deprecate from setup (elastic#59886)
  ...
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 17, 2020
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 59657 or prevent reminders by adding the backport:skip label.

1 similar comment
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 59657 or prevent reminders by adding the backport:skip label.

@shahzad31 shahzad31 mentioned this pull request Mar 18, 2020
Merged
shahzad31 added a commit to shahzad31/kibana that referenced this pull request Mar 18, 2020
@shahzad31 @elasticmachine
[Uptime] Index Status API to Rest (elastic#59657)
cfe25e9 
* gql to rest

* update snap

* fix api

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 18, 2020
shahzad31 added a commit that referenced this pull request Mar 18, 2020
@shahzad31 @elasticmachine
[Uptime] Index Status API to Rest (#59657) (#60512)
9441f63 
* gql to rest

* update snap

* fix api

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justinkambic justinkambic justinkambic approved these changes

Assignees

@shahzad31 shahzad31

Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v7.7.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shahzad31 @elasticmachine @kibanamachine @justinkambic