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

Fix common router request handler issue #32275

Merged
merged 3 commits into from
Mar 6, 2019
Merged

Fix common router request handler issue #32275

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6bc05c6
Add `await` to common router request handler
jen-huang Mar 1, 2019
253a210
Remove once() from common license checker and call with request facto…
jen-huang Mar 6, 2019
31424a5
Merge remote-tracking branch 'upstream/master' into fix/shared-router
jen-huang Mar 6, 2019
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
11 changes: 5 additions & 6 deletions x-pack/server/lib/create_router/call_with_request_factory/call_with_request_factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@

import { once } from 'lodash';

const callWithRequest = once(server => {
const cluster = server.plugins.elasticsearch.getCluster('data');
return cluster.callWithRequest;
});

export const callWithRequestFactory = (server, request) => {
return (...args) => {
return callWithRequest(server)(request, ...args);
const callWithRequest = server => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this also wasn't necessarily an issue, but since this is now common code shared by multiple plugins, it should be a true factory

const cluster = server.plugins.elasticsearch.getCluster('data');
return cluster.callWithRequest;
};
return once(callWithRequest)(server)(request, ...args);
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm sure we've had discussion about this before and I just missed it, but what's the benefit of using once here? If it's not needed, then this code could be simplified a bit. I tested this locally and it seemed OK:

export const callWithRequestFactory = (server, request) => {
  const { callWithRequest } = server.plugins.elasticsearch.getCluster('data');
  return (...args) => {
    return callWithRequest(request, ...args);
  };
};

Copy link
Contributor Author

Choose a reason for hiding this comment

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

once was used in the original code to safeguard against multiple factory calls. now that the factory code for call with request and license checker is shared, you're right that it is no longer needed. I pushed an update to remove once from both factories

};
};
6 changes: 3 additions & 3 deletions x-pack/server/lib/create_router/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ export const createRouter = (server, pluginId, apiBasePath = '') => {
const requestHandler = (handler) => async (request, h) => {
const callWithRequest = callWithRequestFactory(server, request);
try {
return handler(request, callWithRequest, h);
return await handler(request, callWithRequest, h);
} catch (err) {
if (isEsError(err)) {
throw wrapEsError(err);
return wrapEsError(err);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

usage of throw wasn't an issue, but I changed it to return since that is more commonly used to return errors in x-pack server code

Copy link
Contributor

Choose a reason for hiding this comment

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

@jen-huang Just seeing this. Have you tested this? It seems that by not throwing we would never be able to catch an error...

}

throw wrapUnknownError(err);
return wrapUnknownError(err);
}
};

Expand Down