feat(rest): expose app.requestHandler function

[bajtos]

Each RestServer provides an HTTP handler function that can be used with core HTTP server or any compatible framework like Express.

This pull request exposes the handler function on the RestApplication class to simplify the usage.

See also:

• [Docs] Update documentation and examples to use RestApplication #846 [Docs] Update documentation and examples to use RestApplication
• fix(example-getting-started): use RestApplication #955 fix(example-getting-started): use RestApplication
• refactor: simplify app setup via RestApplication (part II) #968 refactor: simplify app setup via RestApplication (part II)
• feat(rest): app.route() and app.api() #994 feat(rest): app.route() and app.api()

Checklist

• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• Related API Documentation was updated
• (n/a) Affected artifact templates in packages/cli were updated
• Affected example projects in packages/example-* were updated

[bajtos]

I'd like to get few more approvals before merging this pull request. Since I'll be away from the computer for the next 10 days, could somebody from the approvers land the pull request for me please?

[virkt25]

Code looks good BUT I would like for us to reconsider the name for this function. handleHttp sounds odd and the the intent isn't clear / obvious. Some alternate proposals:

• requestHandler
• httpHandler (this is already in use though)
• handleHttpReq(uest)

[bajtos]

@virkt25 thank you for a thoughtful comment.

Let's review all different request-handling members we have in RestServer so that we can find the best new name.

• handleHttp is the handler function to pass to a core HTTP server instance, an Express app, etc. Right now, it's a simple wrapper around _handleHttpRequest, preserving this and providing error handling.
• _handleHttpRequest is the method which contains the core of request handling code.
• httpHandler is an instance of HttpHandler class, it deals with routing and Sequence invocation

In this light, I feel your proposals httpHandler, handleHttpReq and handleHttpRequest would only add more confusion.

What I dislike about requestHandler:

• Functions/method names should start with a verb.
• I'd like to include "http" in the method name, because an application can have request handlers for different protocols too.

On the other hand, we are not using requestHandler as a method, but we are passing it around as an object (something that can handle requests). Also if we are accessing this property (typically to pass it down to an HTTP server or Supertest), then we must already know we are dealing with HTTP handler, thus I guess it's ok to leave "http" out?

Initially, I wanted the RestApplication to use the same name as RestServer for this HTTP handler function. If I go with your proposal to use requestHandler as the name, then I would like to rename RestServer#handleHttp for consistency too. Is this fine with you?

[bajtos]

Performed the rename in aa5f5c5.

@virkt25 LGTY now?

[virkt25]

👏 I like the requestHandler much much much better than httpHandler 👍