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

[InfraUI] Remove (to be deprecated) rest_total_hits_as_int parameter #30826

Merged
merged 1 commit into from
Feb 13, 2019
Merged

[InfraUI] Remove (to be deprecated) rest_total_hits_as_int parameter #30826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion x-pack/plugins/infra/server/lib/adapters/framework/adapter_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,10 @@ export interface InfraDatabaseSearchResponse<Hit = {}, Aggregations = undefined>
};
aggregations?: Aggregations;
hits: {
total: number;
total: {
value: number;
relation: string;
};
hits: Hit[];
};
}
Expand Down
5 changes: 3 additions & 2 deletions x-pack/plugins/infra/server/lib/adapters/metrics/lib/check_valid_node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ export const checkValidNode = async (
): Promise<boolean> => {
const params = {
index: indexPattern,
rest_total_hits_as_int: true,
terminateAfter: 1,
body: {
size: 0,
Expand All @@ -25,5 +24,7 @@ export const checkValidNode = async (
},
},
};
return (await search(params)).hits.total > 0;

const result = await search(params);
return result && result.hits && result.hits.total && result.hits.total.value > 0;
Copy link
Member

Choose a reason for hiding this comment

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

I've been struggling with things like this too where we need to grab a value off some deeply nested object that has optional parts all the way down 🐢. I wonder if we shouldn't just standardize on using Lodash get for things like this since we are only concerned with the value at the end of the path. That's was standard practice at one point in time for the Kibana team. I only started using the same pattern as you when I started with Typescript.

const result = await search(params)
const value = get(result, 'hits.total.value', 0);
return value > 0;

You don't need to make this change, unless you like it. Technically they are both the same so I will let you decide.

Copy link
Member

@weltenwort weltenwort Feb 12, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

The APM team has implemented some typesafer getter pattern which we might want to copy: https://github.com/elastic/kibana/blob/master/x-pack/plugins/apm/common/idx.ts

example usage here:

kibana/x-pack/plugins/apm/public/components/app/ErrorGroupDetails/DetailView/index.tsx

Line 116 in d9735bc

idx(error, _ => _.context.page.url) ||

Copy link
Member

Choose a reason for hiding this comment

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

We should settle on something because personally I don't like typing result & result.total & result.total.value, I like editing it even less, especially when the structure changes.

Copy link
Member

Choose a reason for hiding this comment

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

indeed... the idx (which could be named better) has a few nice properties:

  • preserves the return type
  • auto-completion in the accessor
  • simple, local implementation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, I agree it's annoying and if we can decide on a standardised solution (be it Lodash's get, APM's idx, or a tweaked custom function of our own) that'd be great. I'll merge this as is for now as it's managed to get a green build amid the CI issues. But I'll add an agenda issue for the next Infrastructure & Service Monitoring UI Sync meeting and we can decide which to use.

};