[LABS] feat: adapter that wraps strategy #3056

jannyHou · 2019-06-06T19:08:49Z

Connect to #2311

This PR contains 2 potential solutions(you will find TWO adapter files in src + TWO unit tests + TWO acceptance tests) for converting the passport based strategies to the one defined in @loopback/authentication:

wrap the passport strategy, like BasicStrategy in passport-http: the 1st commit
is supposed to to wrap the passport middleware, but due to the type error I explained in 561f6b5#diff-fb7bcb47eeb0d22961f9f511534a7db6R76, it still takes in a strategy in the constructor
- so my code is more like a PoC that proves invoking passport.authenticate() works
- if we could solve the type error, I can quickly turn it into the expected adapter
- if the type error cannot be solved then we have to wrap the strategy not the middleware

Let's discuss which one do we want and discard the unwanted one. If both are good, I will extract one of them to a new package.

Update:

We decided to take the simple approach: wrapping the strategy, so please ignore the 2nd proposal above ^

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

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

👉 Check out how to submit a PR 👈

raymondfeng · 2019-06-06T21:54:04Z

...passport-adapter/src/__tests__/acceptance/authentication-with-passport-adapter.acceptance.ts

+  }
+
+  function verify(username: string, password: string, cb: Function) {
+    process.nextTick(() => {


Why do we need to wrap it into process.nextTick()? The users.find is already async.

raymondfeng · 2019-06-06T21:56:59Z

...passport-adapter/src/__tests__/acceptance/authentication-with-passport-adapter.acceptance.ts

+
+// FOR REVIWERS: THIS ACCEPTANCE TEST IS FOR `PassportAdapter`
+
+import { authenticate, AuthenticateFn, AuthenticationBindings, AuthenticationComponent, AuthenticationStrategy, UserProfile } from '@loopback/authentication';


The code does not follow prettier formatting style.

raymondfeng · 2019-06-06T22:08:20Z

labs/passport-adapter/README.md

+  convertToAuthStrategy(basic: BasicStrategy): AuthenticationStrategy {
+    return new StrategyAdapter(basic, AUTH_STRATEGY_NAME);
+  }
+}


What about the following idea?

Have one PassportAuthenticationStrategy provider to be registered with LB4 authentication strategies extension point.

The PassportAuthenticationStrategy supports passport:<name>

Inside PassportAuthenticationStrategy, we expose another extension point to register all passport strategies (for example, with a tag passport.strategy).

Creates one instance of passport

Discovers all passport strategy extensions

Calls passport.use() to register all passport strategies

@raymondfeng Having 2 extensions kind of falls back to the initial implementation in the draft PR #2822 (which unfortunately was squashed and cannot be recovered...)

The reason why I wrapped the passport strategy directly to a common implementation of AuthenticationStrategy is explained in `dbc51ce#r280376757

And I am able to perform an authentication by invoking passport.authenticate(), but not quite sure about the benefit of doing it (compared with invoking strategy.authenticate()), and describing the type of a passport instance is very problematic, see explanation
By saying that I didn't mean we have to define the passport in any function's parameter, but in case we have to do that, we need figure out a solution for the type issue.

raymondfeng · 2019-06-10T21:11:59Z

labs/passport-adapter/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2017,2019. All Rights Reserved.


Would it be better to name the package as authentication-passport?

+1 to use authentication-passport

raymondfeng · 2019-06-10T21:12:12Z

labs/passport-adapter/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2017,2019. All Rights Reserved.
+Node module: @loopback/authentication


Change the module name here.

raymondfeng · 2019-06-10T21:14:25Z

labs/passport-adapter/README.md

+  .tag({
+    [CoreTags.EXTENSION_FOR]:
+      AuthenticationBindings.AUTHENTICATION_STRATEGY_EXTENSION_POINT_NAME,
+  });


Maybe we should have a sugar method such as usePassportStrategy() here.

Yes we have it in https://github.com/strongloop/loopback-next/blob/master/packages/authentication/src/types.ts#L66
(my code was copied from the out of date draft.)

raymondfeng · 2019-06-10T21:18:52Z

labs/passport-adapter/README.md

+import {StrategyAdapter} from `@loopback/passport-adapter`;
+import {AuthenticationStrategy} from '@loopback/authentication';
+
+class PassportBasicAuthProvider implements Provider<AuthenticationStrategy> {


Another option is to use StrategyAdapter as the base class.

@raymondfeng Hmm is there a big difference between using the provider or using a class that extends StrategyAdapter?

bajtos · 2019-06-11T08:48:43Z

labs/passport-adapter/README.md

+import {AuthenticationStrategy} from '@loopback/authentication';
+
+class PassportBasicAuthProvider implements Provider<AuthenticationStrategy> {
+  constructor(@inject(VERIFY) verifyFn: BasicVerifyFunction);


Where is VERIFY constant defined?

bajtos · 2019-06-11T08:53:24Z

labs/passport-adapter/README.md

+    namespace:
+      AuthenticationBindings.AUTHENTICATION_STRATEGY_EXTENSION_POINT_NAME,
+  },
+);


I find this as not very elegant. Can we find a way how to simplify this registration step? For example, can we leverage @extension or @bind decorators to specify the extension point name in the code where we are defining PassportBasicAuthProvider.

@raymondfeng you are the author of addExtension and the extension-point/extension implementation. What is the recommended way for registering extensions? Are we missing any new helpers in @loopback/core to simplify this process?

My code is out of date we do have that sugar function :)

#3056 (comment)

raymondfeng · 2019-06-12T21:24:53Z

labs/authentication-passport/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2017,2019. All Rights Reserved.


It should be 2019.

raymondfeng · 2019-06-12T21:25:30Z

bin/mark-non-labs-packages-private.js

@@ -23,7 +23,7 @@ async function markNonLabsPackagesPrivate() {
    const dir = path.relative(pkg.rootPath, pkg.location);
    if (dir.startsWith('labs')) continue;
    const data = readJsonFile(pkg.manifestLocation);
-    let modified = !data.private;
+    const modified = !data.private;


Can we update the base branch with this change first?

good catch! updated in #3150

raymondfeng · 2019-06-12T21:26:48Z

labs/authentication-passport/README.md

@@ -0,0 +1,185 @@
+# Passport Strategy Adapter
+
+_Important: We suggest users understand LoopBack's authentication system[Link


We strongly recommend that users ...

And I updated the link as well since #2977 get merged

raymondfeng · 2019-06-12T21:27:01Z

labs/authentication-passport/README.md

+TBD](some loopback.io link) before using this module_
+
+This is an adapter module created for plugging in
+[`passport`](https://www.npmjs.com/package/passport) base strategies to the


base -> based

raymondfeng · 2019-06-12T21:27:28Z

labs/authentication-passport/README.md

+## Installation
+
+```sh
+npm i @loopback/passport-adapter --save


@loopback/authentication-passport

jannyHou · 2019-06-13T19:31:53Z

local tests pass

 [email protected] mocha /Users/jannyhou/2019/auth/adapter/loopback-next
> node packages/build/bin/run-mocha "labs/*/dist/__tests__/**/*.js"



  ․․․․․․․

  7 passing (90ms)


> [email protected] posttest /Users/jannyhou/2019/auth/adapter/loopback-next
> npm run lint


> [email protected] lint /Users/jannyhou/2019/auth/adapter/loopback-next
> npm run prettier:check && npm run eslint && node bin/check-package-locks


> [email protected] prettier:check /Users/jannyhou/2019/auth/adapter/loopback-next
> npm run prettier:cli -- -l


> [email protected] prettier:cli /Users/jannyhou/2019/auth/adapter/loopback-next
> node packages/build/bin/run-prettier "labs/**/*.ts" "labs/**/*.js" "labs/**/*.md" "-l"


> [email protected] eslint /Users/jannyhou/2019/auth/adapter/loopback-next
> node packages/build/bin/run-eslint --report-unused-disable-directives --cache .

raymondfeng · 2019-06-14T14:53:59Z

labs/authentication-passport/README.md

+
+## Usage
+
+### Simply Usage


Simple Usage or Basic Use

emonddr · 2019-06-14T15:53:23Z

@jannyHou

Created an instance of the passport strategy

Create an instance of the passport strategy

emonddr · 2019-06-14T17:23:45Z

@jannyHou

Take the basic strategy exported from passport-http as an example, first create an instance of the basic strategy with your verify function

Taking the basic strategy exported from passport-http as an example, first create an instance of the basic strategy with your verify function

jannyHou · 2019-06-14T17:31:53Z

For reviewers: the decreased code coverage is complaining about the packages/* modules, so I guess the coverage check script on branch labs/base need to be fixed, I am going to submit a PR for it.

see report in https://coveralls.io/builds/24001707

emonddr · 2019-06-14T17:30:59Z

labs/authentication-passport/README.md

+This is an adapter module created for plugging in
+[`passport`](https://www.npmjs.com/package/passport) base strategies to the
+authentication system in `@loopback/[email protected]`.
+


Please see two comments I added today, June 14 outside this review.

emonddr · 2019-06-14T17:34:16Z

labs/authentication-passport/README.md

+It's the similar configuration as you do when adding a strategy to a `passport`
+by calling `passport.use()`.
+
+But don't provide any passport specific options since we don't support the


But don't provide any passport specific options since we don't support the session manager.

Can you give an example of what you mean here? And what happens if that passport strategy requires a session manager? Will it not work?

I doubled checked the usage of passport-http, and realize the passport specific options are only provided when the strategy is invoked by passport.authenticate(), like https://github.com/jaredhanson/passport-http#authenticate-requests.
So, since we don't involve passport in this PR, we don't introduce that concern either. I will remove ~~"But don't provide any passport specific options since we don't support the session manager."~~

emonddr · 2019-06-14T17:35:42Z

labs/authentication-passport/README.md

+  // Give the strategy a name
+  // You'd better define your strategy name as a constant, like
+  // `const AUTH_STRATEGY_NAME = 'basic'`.
+  // So that you will decorate the APIs later with the same name.


// So that you will decorate the APIs later with the same name.

// You will need to decorate the APIs later with the same name

emonddr · 2019-06-14T17:38:25Z

labs/authentication-passport/README.md

+import {AuthenticationBindings} from '@loopback/authentication';
+
+app
+  .bind('authentication.strategies.basicAuthStrategy')


.bind('authentication.strategies.basicAuthStrategy')

Is there a constant that can be used from @authenticate to form the first two segments of this string?

e.g. https://github.com/strongloop/loopback-next/blob/master/packages/authentication/src/keys.ts#L108

I guess the class name of the strategy here

https://github.com/strongloop/loopback-next/blob/master/packages/authentication/src/types.ts#L65

is appended as the last segment of the string?

@emonddr The key itself could be any name, it is the tag that makes the strategy recognized by the extension point, and the name property defined in the strategy class that needs to match the name in decorator @authenticate('basic')

I don't have a strong opinion on using a string or leveraging the constant in https://github.com/strongloop/loopback-next/blob/master/packages/authentication/src/keys.ts#L108, I would respect your preference.

emonddr · 2019-06-14T17:42:48Z

labs/authentication-passport/README.md

+
+### With Provider
+
+If you need to inject stuff (e.g. the verify function) when configure the


If you need to inject stuff (e.g. the verify function) when configure the
strategy, you may want to provide your strategy as a provider.

If you need to inject stuff (e.g. the verify function) when configuring the
strategy, you may want to supply your strategy as a provider.

emonddr · 2019-06-14T17:43:47Z

labs/authentication-passport/README.md

+If you need to inject stuff (e.g. the verify function) when configure the
+strategy, you may want to provide your strategy as a provider.
+
+_Note: If you are not familiar with LoopBack provider, check the documentations


Note: If you are not familiar with LoopBack provider, check the documentations
in

Note: If you are not familiar with LoopBack providerS, check the documentation
in

emonddr · 2019-06-14T17:46:56Z

labs/authentication-passport/README.md

+  // Applies the `StrategyAdapter` to the configured basic strategy instance.
+  // You'd better define your strategy name as a constant, like
+  // `const AUTH_STRATEGY_NAME = 'basic'`
+  // So that you will decorate the APIs later with the same name


// So that you will decorate the APIs later with the same name

// You will decorate the APIs later with the same name

b-admike

Got some comments, but looks good to me overall 👍

labs/authentication-passport/README.md

b-admike · 2019-06-14T17:56:51Z

labs/authentication-passport/README.md

+first create an instance of the basic strategy with your `verify` function.
+
+```ts
+function verify(username: string, password: string, cb: Function) {


nitpick: would it help to show the import statement here?

labs/authentication-passport/README.md

b-admike · 2019-06-14T18:06:51Z

labs/authentication-passport/README.md

+    @inject('authentication.basic.verify') verifyFn: BasicVerifyFunction,
+  );
+  value(): AuthenticationStrategy {
+    const basicStrategy = this.configuredBasicStrategy(verify);


this.configuredBasicStrategy(verify); -> this.configuredBasicStrategy(verifyFn);

verifyFn is a type, verify is the real function.

Oh...where do we get verify from? I thought we are passing the injected variable here https://github.com/strongloop/loopback-next/pull/3056/files#diff-ac3170e38ad0d9561109e8d873e5e467R122. I thought verifyFn is the function and BasicVerifyFunction is the type.

b-admike · 2019-06-14T18:07:37Z

labs/authentication-passport/README.md

+  // `const AUTH_STRATEGY_NAME = 'basic'`
+  // So that you will decorate the APIs later with the same name
+  convertToAuthStrategy(basic: BasicStrategy): AuthenticationStrategy {
+    return new StrategyAdapter(basic, AUTH_STRATEGY_NAME);


can we show where AUTH_STRATEGY_NAME is declared or imported?

b-admike · 2019-06-14T18:09:19Z

labs/authentication-passport/README.md

+}
+
+app.bind('authentication.basic.verify').to(verify);
+registerAuthenticationStrategy(app, PassportBasicAuthProvider);


Can we include registerAuthenticationStrategy and PassportBasicAuthProvider imports at the top for this line?

labs/authentication-passport/src/strategy-adapter.ts

b-admike

LGTM 👍

b-admike · 2019-06-14T20:44:49Z

labs/authentication-passport/src/__tests__/unit/passport-strategy-adapter.unit.ts

+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+// FOR REVIWERS: THIS UNIT TEST IS FOR `StrategyAdapter`


nitpick: REVIWERS -> REVIEWERS

oh..another good catch, that comment should be moved too!

jannyHou mentioned this pull request Jun 6, 2019

[WIP] Experimental/passport adapter #2969

Closed

7 tasks

jannyHou self-assigned this Jun 6, 2019

jannyHou force-pushed the labs-dev/passport-adapter branch from 41acfec to 561f6b5 Compare June 6, 2019 21:22

raymondfeng reviewed Jun 6, 2019

View reviewed changes

bajtos changed the title ~~feat: adapter that wraps strategy~~ [LABS] feat: adapter that wraps strategy Jun 7, 2019

raymondfeng reviewed Jun 10, 2019

View reviewed changes

bajtos reviewed Jun 11, 2019

View reviewed changes

raymondfeng reviewed Jun 12, 2019

View reviewed changes

jannyHou force-pushed the labs/passport-adapter branch from b7ab68f to b862643 Compare June 13, 2019 16:36

jannyHou force-pushed the labs-dev/passport-adapter branch 4 times, most recently from 45a7f34 to c3cf0a3 Compare June 13, 2019 17:35

jannyHou force-pushed the labs/passport-adapter branch from 1a4af5b to ec4a4f6 Compare June 13, 2019 18:09

jannyHou force-pushed the labs-dev/passport-adapter branch from 5dd90f5 to 117545a Compare June 13, 2019 18:11

jannyHou force-pushed the labs/passport-adapter branch from ec4a4f6 to 638cd4d Compare June 13, 2019 18:44

jannyHou force-pushed the labs-dev/passport-adapter branch from 117545a to 3f5ca61 Compare June 13, 2019 18:44

jannyHou force-pushed the labs/passport-adapter branch from 638cd4d to b80934a Compare June 13, 2019 19:57

jannyHou force-pushed the labs-dev/passport-adapter branch from 3f5ca61 to ee204de Compare June 13, 2019 19:58

raymondfeng reviewed Jun 14, 2019

View reviewed changes

raymondfeng approved these changes Jun 14, 2019

View reviewed changes

emonddr self-requested a review June 14, 2019 17:22

emonddr suggested changes Jun 14, 2019

View reviewed changes

b-admike reviewed Jun 14, 2019

View reviewed changes

labs/authentication-passport/src/strategy-adapter.ts Show resolved Hide resolved

jannyHou force-pushed the labs-dev/passport-adapter branch from 7034146 to e861966 Compare June 14, 2019 19:17

emonddr approved these changes Jun 14, 2019

View reviewed changes

b-admike approved these changes Jun 14, 2019

View reviewed changes

feat: adapter that wraps strategy

62cb56e

jannyHou force-pushed the labs-dev/passport-adapter branch from e861966 to 62cb56e Compare June 17, 2019 02:47

jannyHou merged commit fac3ae7 into labs/passport-adapter Jun 17, 2019

delete-merged-branch bot deleted the labs-dev/passport-adapter branch June 17, 2019 04:09

emonddr mentioned this pull request Jun 19, 2019

Add back references to passport adapter in authentication docs #3183

Closed

2 tasks


		// FOR REVIWERS: THIS ACCEPTANCE TEST IS FOR `PassportAdapter`

		import { authenticate, AuthenticateFn, AuthenticationBindings, AuthenticationComponent, AuthenticationStrategy, UserProfile } from '@loopback/authentication';

		@@ -0,0 +1,25 @@
		Copyright (c) IBM Corp. 2017,2019. All Rights Reserved.

		@@ -0,0 +1,25 @@
		Copyright (c) IBM Corp. 2017,2019. All Rights Reserved.
		Node module: @loopback/authentication

		@@ -0,0 +1,185 @@
		# Passport Strategy Adapter

		_Important: We suggest users understand LoopBack's authentication system[Link


		### With Provider

		If you need to inject stuff (e.g. the verify function) when configure the

[LABS] feat: adapter that wraps strategy #3056

[LABS] feat: adapter that wraps strategy #3056

Conversation

jannyHou commented Jun 6, 2019 • edited Loading

Checklist

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

jannyHou Jun 7, 2019 • edited Loading

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

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

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

jannyHou commented Jun 13, 2019

Choose a reason for hiding this comment

emonddr commented Jun 14, 2019 • edited Loading

emonddr commented Jun 14, 2019 • edited Loading

jannyHou commented Jun 14, 2019 • edited Loading

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

jannyHou Jun 14, 2019 • edited Loading

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

b-admike 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

b-admike left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jannyHou commented Jun 6, 2019 •

edited

Loading

jannyHou Jun 7, 2019 •

edited

Loading

emonddr commented Jun 14, 2019 •

edited

Loading

emonddr commented Jun 14, 2019 •

edited

Loading

jannyHou commented Jun 14, 2019 •

edited

Loading

jannyHou Jun 14, 2019 •

edited

Loading