refactor(rest): use Express req/res types #1326

bajtos · 2018-05-15T15:06:52Z

Redesign the REST layer to internally assume than Express has already processed and enhanced the request and response objects.

The public API for creating a listening HTTP server remains unchanged for now, i.e. our RestServer can be still used directly with the core http/https Server classes.

This pull request is a follow-up for #1082 and a part of #1253, it also fixes #191.

Checklist

npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
API Documentation in code was updated
Documentation in /docs/site was updated
Affected artifact templates in packages/cli were updated
Affected example projects in examples/* were updated

raymondfeng · 2018-05-15T15:21:01Z

packages/authentication/src/providers/authentication.provider.ts

@@ -14,14 +14,14 @@ import {AuthenticationBindings} from '../keys';
 * Passport monkey-patches Node.js' IncomingMessage prototype
 * and adds extra methods like "login" and "isAuthenticated"
 */
-export type PassportRequest = ParsedRequest & Express.Request;
+export type PassportRequest = Request & Express.Request;


Do we still have to keep & Express.Request?

Good catch, I'll refactor and clean up the authentication module as part of this PR.

Actually, Express.Request is not the Request object from express js! Instead, it's a passport interface describing additional API added by passport middleware to the request object.

raymondfeng

Please fix CI failures.

raymondfeng · 2018-05-16T03:59:32Z

Please rebase to latest master to pick up a fix that passes the CI.

bajtos · 2018-05-16T11:41:16Z

Rebased on top of the latest master.
Reviewed all places using Request, Response, ServerRequest and ServerResponse and fixed as necessary. See 1bf73d4, I'll squash this commit before merging.
Performed additional cleanup in authentication extension, see 7099c99

raymondfeng · 2018-05-16T15:47:35Z

Please fix the lint error before merging:

ERROR: /home/travis/build/strongloop/loopback-next/packages/rest/src/sequence.ts[11, 3]: 'Request' is declared but its value is never read.
ERROR: /home/travis/build/strongloop/loopback-next/packages/rest/test/acceptance/sequence/sequence.acceptance.ts[7, 3]: 'Request' is declared but its value is never read.

virkt25

Should https://github.com/strongloop/loopback-next/blob/c271b25245889834581aa5e9803fd43ef6029072/packages/rest/src/rest.server.ts#L345-L348 be updated to be Request/Response instead of ServerRequest/ServerResponse?

virkt25 · 2018-05-17T00:13:56Z

packages/authentication/test/unit/fixtures/mock-strategy.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT

 import {Strategy, AuthenticateOptions} from 'passport';
-import {PassportRequest} from '../../..';
+import {Request} from 'express';


Shouldn't this be imported from @loopback/rest?

Here is my reasoning: MockStrategy is extending from Passport Strategy, which uses Request from express.

If we ever change @loopback/rest to export Request as a different type, then MockStrategy still needs to keep using Request from express, because that's what the Strategy interface requires.

virkt25 · 2018-05-17T00:19:25Z

packages/rest/src/rest.server.ts

 import {RestBindings} from './keys';
-import {RequestContext} from '.';
+import {RequestContext} from './request-context';
+import * as express from 'express';

 export type HttpRequestListener = (
  req: ServerRequest,


Should this be Request not ServerRequest?

No. HttpRequestListener is passed to http.createServer, it must work with core ServerRequest/ServerResponse (no Express additions).

virkt25 · 2018-05-17T00:32:10Z

packages/testlab/src/shot.ts

@@ -8,6 +8,8 @@
 * https://github.com/hapijs/shot
 */

+// tslint:disable:no-any
+
 import {ServerRequest, ServerResponse} from 'http';


Shouldn't this be Request / Response from express now?

There are two ways how to use these Shot helpers:

To test LB4 code like a Sequence action. To do that, we need to mock Express Request/Response objects.

To test LB4 RestServer's request handler in isolation, without calling http.createServer. In this case, we need to mock core HTTP ServerRequest/ServerResponse objects.

That's why I am importing both Express and core HTTP types.

bajtos · 2018-05-17T06:32:33Z

@virkt25 regarding _redirectToSwaggerUI - good catch! I'll also leverage res.redirect API provided by Express to further simplify that method 👍

Redesign the REST layer to internally assume than Express has already processed and enhanced the request and response objects. The public API for creating a listening HTTP server remains unchanged for now, i.e. our RestServer can be still used directly with the core http/https Server classes.

Now that the REST layer uses Express request/response types internally, we can simplify StrategyAdapter by removing ShimRequest. While making these changes, other places are cleaned up as well.

bajtos · 2018-05-17T07:13:02Z

Landed. I'll address any additional comments in a follow-up pull request if needed.

bajtos added refactor REST Issues related to @loopback/rest package and REST transport in general labels May 15, 2018

bajtos added this to the May Milestone milestone May 15, 2018

bajtos self-assigned this May 15, 2018

bajtos requested review from raymondfeng and hacksparrow May 15, 2018 15:06

raymondfeng reviewed May 15, 2018

View reviewed changes

raymondfeng approved these changes May 15, 2018

View reviewed changes

raymondfeng requested changes May 15, 2018

View reviewed changes

bajtos force-pushed the feature/leverage-express-server branch from 6b31cc5 to 7099c99 Compare May 16, 2018 11:39

raymondfeng approved these changes May 16, 2018

View reviewed changes

virkt25 reviewed May 17, 2018

View reviewed changes

bajtos added 2 commits May 17, 2018 08:38

refactor(authentication): leverage Express req/res types

8925db8

Now that the REST layer uses Express request/response types internally, we can simplify StrategyAdapter by removing ShimRequest. While making these changes, other places are cleaned up as well.

bajtos force-pushed the feature/leverage-express-server branch from c271b25 to 8925db8 Compare May 17, 2018 06:38

bajtos merged commit f864688 into master May 17, 2018

bajtos deleted the feature/leverage-express-server branch May 17, 2018 07:12

This was referenced May 17, 2018

Blog post: Leveraging Express for a more robust HTTP processing #1337

Closed

Robust HTTP processing capabilities (DP3) #1038

Closed

refactor(rest): mount CORS as a regular middleware #1338

Merged

dhmlau mentioned this pull request May 17, 2018

Monthly Milestone - May 2018 #1172

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(rest): use Express req/res types #1326

refactor(rest): use Express req/res types #1326

bajtos commented May 15, 2018 •

edited

Loading

raymondfeng May 15, 2018

bajtos May 16, 2018

bajtos May 16, 2018

raymondfeng left a comment

raymondfeng commented May 16, 2018

bajtos commented May 16, 2018

raymondfeng commented May 16, 2018

virkt25 left a comment

virkt25 May 17, 2018

bajtos May 17, 2018

virkt25 May 17, 2018

bajtos May 17, 2018

virkt25 May 17, 2018

bajtos May 17, 2018

bajtos commented May 17, 2018

bajtos commented May 17, 2018

refactor(rest): use Express req/res types #1326

refactor(rest): use Express req/res types #1326

Conversation

bajtos commented May 15, 2018 • edited Loading

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raymondfeng left a comment

Choose a reason for hiding this comment

raymondfeng commented May 16, 2018

bajtos commented May 16, 2018

raymondfeng commented May 16, 2018

virkt25 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bajtos commented May 17, 2018

bajtos commented May 17, 2018

bajtos commented May 15, 2018 •

edited

Loading