Allow adding custom loopback client in acquireTokenInteractive #5578

derisen · 2023-01-17T03:20:38Z

This PR adds a loopback client interface to InteractiveRequest for devs who would like to run their own server for listening the authZ code response in acquireTokenInteractive API.

codecov-commenter · 2023-01-17T05:34:29Z

Codecov Report

Merging #5578 (cbd368b) into dev (a7d7ecc) will not change coverage.
The diff coverage is 100.00%.

Flag	Coverage Δ	*Carryforward flag
msal-angular	`96.50% <ø> (ø)`	Carriedforward from a7d7ecc
msal-browser	`86.46% <ø> (ø)`	Carriedforward from a7d7ecc
msal-common	`84.54% <ø> (ø)`	Carriedforward from a7d7ecc
msal-core	`82.84% <ø> (ø)`	Carriedforward from a7d7ecc
msal-node	`83.39% <100.00%> (ø)`
msal-node-extensions	`75.64% <ø> (ø)`	Carriedforward from a7d7ecc
msal-react	`94.68% <ø> (ø)`	Carriedforward from a7d7ecc
node-token-validation	`88.88% <ø> (ø)`	Carriedforward from a7d7ecc

*This pull request uses carry forward flags. Click here to find out more.

Impacted Files	Coverage Δ
lib/msal-node/src/index.ts	`100.00% <ø> (ø)`
...ib/msal-node/src/client/PublicClientApplication.ts	`76.31% <100.00%> (ø)`
lib/msal-node/src/network/LoopbackClient.ts	`63.63% <100.00%> (ø)`

ghost · 2023-01-30T15:00:54Z

Reminder: The next release is scheduled for next week and this PR appears to be stale :(

If changes have been requested please address feedback.
If this PR is still a work in progress please mark as draft.

lib/msal-node/src/client/PublicClientApplication.ts

tnorling · 2023-02-06T19:22:28Z

lib/msal-node/src/request/InteractiveRequest.ts

 import { AuthorizationUrlRequest } from "./AuthorizationUrlRequest";

 export type InteractiveRequest = Pick<AuthorizationUrlRequest, "authority"|"correlationId"|"claims"|"azureCloudOptions"|"account"|"extraQueryParameters"|"tokenQueryParameters"|"extraScopesToConsent"|"loginHint"|"prompt"> & {
    openBrowser: (url: string) => Promise<void>;
    scopes?: Array<string>;
    successTemplate?: string;
    errorTemplate?: string;
+    customLoopbackClient?: ILoopbackClient


Let's just call this loopbackClient

Suggested change

customLoopbackClient?: ILoopbackClient

loopbackClient?: ILoopbackClient

tnorling

Looks good, 2 nits and any docs or samples we can add to help illustrate usage?

Co-authored-by: Thomas Norling <thomas.l.norling@gmail.com>

tnorling

Looks good, thanks!

tnorling · 2023-02-06T21:50:48Z

lib/msal-node/src/client/PublicClientApplication.ts

     */
-    async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {
+    public async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {


nit: not needed

Suggested change

public async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {

async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {

true, but given the rest of acquireToken* implementations has the modifier explicitly, shouldn't we keep this for consistency?

derisen · 2023-02-06T22:10:15Z

Looks good, 2 nits and any docs or samples we can add to help illustrate usage?

done and done!

sameerag

Looks good. Do we have a docs (and .md file) defining why someone would need a loop back server? If yes, please link here, if not, can we add it? Can be handled as a separate PR.

…icrosoft-authentication-library-for-js into custom-loopback-client

derisen · 2023-02-06T23:11:11Z

Looks good. Do we have a docs (and .md file) defining why someone would need a loop back server? If yes, please link here, if not, can we add it? Can be handled as a separate PR.

Thanks! Added comments for API documentation and also to an Electron sample for usage. Need to update/re-organize some of our .md docs for API usage -so probably best to tackle this separately in another PR

ghost · 2023-03-07T20:54:44Z

🎉@azure/msal-node@v1.16.0 has been released which incorporates this pull request.:tada:

Handy links:

Allow adding custom loopback client in acquireTokenInteractive

119d7d7

derisen requested review from sameerag, tnorling, hectormmg, peterzenz, jennyf19, jmprieur, bgavrilMS and Robbie-Microsoft as code owners January 17, 2023 03:20

derisen marked this pull request as draft January 17, 2023 03:20

github-actions bot added the msal-node Related to msal-node package label Jan 17, 2023

derisen and others added 4 commits January 16, 2023 19:22

Change files

956d66b

change email

cede511

fix failing test

78b8a2e

fix failing test

30ec458

peterzenz approved these changes Jan 17, 2023

View reviewed changes

change file correction

e93c46a

derisen marked this pull request as ready for review January 18, 2023 16:54

derisen mentioned this pull request Jan 18, 2023

Allow setting a preferred port in acquireTokenInteractive #5575

Closed

ghost added the Needs: Attention 👋 Awaiting response from the MSAL.js team label Jan 30, 2023

tnorling reviewed Feb 6, 2023

View reviewed changes

lib/msal-node/src/client/PublicClientApplication.ts Outdated Show resolved Hide resolved

ghost removed the Needs: Attention 👋 Awaiting response from the MSAL.js team label Feb 6, 2023

tnorling reviewed Feb 6, 2023

View reviewed changes

Doğan Erişen and others added 4 commits February 6, 2023 11:41

Update lib/msal-node/src/client/PublicClientApplication.ts

1628834

Co-authored-by: Thomas Norling <thomas.l.norling@gmail.com>

Update lib/msal-node/src/request/InteractiveRequest.ts

ddc6cfa

Co-authored-by: Thomas Norling <thomas.l.norling@gmail.com>

rename property

25999c2

add api documentation

13df73a

tnorling approved these changes Feb 6, 2023

View reviewed changes

update electron sample to make use of ILoopbackClient

1edab37

github-actions bot added the samples Related to the samples apps for the library. label Feb 6, 2023

Merge branch 'dev' into custom-loopback-client

16daeec

This was linked to issues Feb 6, 2023

Problem with ElectronSystemBrowserTestApp deep linking with acquireTokenInteractive() #5442

Closed

Missing API documentation for AcquireTokenInteractive #5647

Closed

sameerag approved these changes Feb 6, 2023

View reviewed changes

derisen added 2 commits February 6, 2023 15:00

add more comments

f617b2e

Merge branch 'custom-loopback-client' of https://github.com/AzureAD/m…

cbd368b

…icrosoft-authentication-library-for-js into custom-loopback-client

derisen removed a link to an issue Feb 6, 2023

Missing API documentation for AcquireTokenInteractive #5647

Closed

Merge branch 'dev' into custom-loopback-client

012ec3b

derisen merged commit a5027ce into dev Feb 6, 2023

derisen deleted the custom-loopback-client branch February 6, 2023 23:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow adding custom loopback client in acquireTokenInteractive #5578

Allow adding custom loopback client in acquireTokenInteractive #5578

derisen commented Jan 17, 2023 •

edited

codecov-commenter commented Jan 17, 2023 •

edited

ghost commented Jan 30, 2023

tnorling Feb 6, 2023

derisen Feb 6, 2023

tnorling left a comment

tnorling left a comment

tnorling Feb 6, 2023

derisen Feb 6, 2023

derisen commented Feb 6, 2023

sameerag left a comment

derisen commented Feb 6, 2023

ghost commented Mar 7, 2023

	customLoopbackClient?: ILoopbackClient
	loopbackClient?: ILoopbackClient

	public async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {
	async acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult> {

Allow adding custom loopback client in acquireTokenInteractive #5578

Allow adding custom loopback client in acquireTokenInteractive #5578

Conversation

derisen commented Jan 17, 2023 • edited

codecov-commenter commented Jan 17, 2023 • edited

Codecov Report

ghost commented Jan 30, 2023

tnorling Feb 6, 2023

Choose a reason for hiding this comment

derisen Feb 6, 2023

Choose a reason for hiding this comment

tnorling left a comment

Choose a reason for hiding this comment

tnorling left a comment

Choose a reason for hiding this comment

tnorling Feb 6, 2023

Choose a reason for hiding this comment

derisen Feb 6, 2023

Choose a reason for hiding this comment

derisen commented Feb 6, 2023

sameerag left a comment

Choose a reason for hiding this comment

derisen commented Feb 6, 2023

ghost commented Mar 7, 2023

derisen commented Jan 17, 2023 •

edited

codecov-commenter commented Jan 17, 2023 •

edited