feat: add aurora entra id login by stuartmclean · Pull Request #839 · ReDI-School/connect

stuartmclean · 2023-12-23T14:18:03Z

Important notes:

This is not a complete reimplementation of the talent-connect auth process - it's merely a first step in that direction, presenting a working demonstration of several interactions with the Azure backend.

It should be safe to merge with the following feature flag: NX_ENTRA_ID_ENABLED=false although the other flags mentioned below should also be set in the production with at least empty string values to avoid issues during deployment.

Further steps required (should be done in separate tickets):

Extend the login steps to verify the user has an account registered in Salesforce and direct them to the correct page.
Enable Azure login option to existing users of connect
Enable Azure login option to existing users of talent-pool
Allow new users to register using Entra ID
Try to add additional methods of login that are not completely dependent on a user having a microsoft account (this should be possible through Entra ID as well).
Remove legacy auth implementation.

How to test:

This feature requires the following new env params:

NX_FRONTEND_URI="http://localhost:3000"
NX_ENTRA_ID_ENABLED=true
NX_ENTRA_ID_CLOUD_INSTANCE="https://login.microsoftonline.com"
NX_ENTRA_ID_TENANT_ID="https://login.microsoftonline.com"
NX_ENTRA_ID_CLIENT_ID="<get from Azure or PM me>"
NX_ENTRA_ID_CLIENT_SECRET="<get from Azure or PM me>"

entra-id-login-screen-recording.mov

Implementation summary:

When a customer clicks the "Log in with Microsoft" button:

they are redirected to the nestjs backend, which queries azure to...
form a unique URL, to which the nestjs backend redirects the user
the user logs in in azure using their own details
azure redirects the user to the nestjs backend
the nestjs backend calls azure to verify that the login was successful

helloanil · 2024-01-02T23:05:13Z

apps/nestjs-api/src/auth-entra-id/entra-id-config.provider.ts

+      system: {
+        loggerOptions: {
+          loggerCallback(logLevel, message, containsPii) {
+            if (!containsPii) {


Such a cool trick. I wonder if AWS has a similar feature.

Yeah, I was really happy to see this too. 😊

apps/redi-connect/src/pages/front/login/Login.tsx

apps/redi-connect/src/services/api/api.tsx

helloanil · 2024-01-02T23:34:32Z

apps/nestjs-api/src/main.ts

  app.setGlobalPrefix(globalPrefix)
  app.use(json({ limit: '1mb' }))
  app.use(urlencoded({ extended: true, limit: '1mb' }))
+  app.use(cookieParser())


ericbolikowski

Awesome progress, @stuartmclean! Great prototyping. I like your prototyping approach with feature flags so we can gradually roll this out.

I've left a few inline comments.

libs/shared-config/src/lib/config.ts

apps/nestjs-api/src/auth-entra-id/entra-id.service.ts

ericbolikowski · 2024-01-06T21:10:44Z

apps/nestjs-api/src/auth-entra-id/entra-id-login.middleware.ts

+import { VerificationData } from './verification-data.interface'
+
+@Injectable()
+export class EntraIdLoginMiddleware implements NestMiddleware {


Nice work here!

I've never used NestJS middleware. Is there a reason we're using it instead of a simple controller?

It seemed like the easiest way to protect this route and make it reusable for other routes.

Co-authored-by: Anıl Akarsu <anil@redi-school.org> Signed-off-by: Stuart McLean <stuart.mclean@soundcloud.com>

coderabbitai · 2024-01-07T20:38:17Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

apps/nestjs-api/src/entra-id/entra-id.service.ts

ericbolikowski

❤️

stuartmclean · 2024-01-07T21:53:28Z

❤️

😊 Thanks @ericbolikowski - I ran another manual test and discovered a flaw in my last commits - should be fixed by the most recent commit.

helloanil · 2024-01-21T18:44:42Z

apps/redi-connect/src/routes/routes__logged-out.tsx

    path: '/front/login/entra-redirect',
    component: () => {
-      window.location.href = `${NEST_API_URL}/auth/entra-id`
+      window.location.href = `${NEST_API_URL}/api/auth/entra-id`


@stuartmclean What's the reason for this change? Is it a common practice to set a URL on the browser to what seems to be an API URL?

Hi @helloanil This is a bit of a hack, I agree, but it doesn't actually display anything to the user and it's the only way I could make this work without setting up a whole different root url just for this one endpoint. Happy to hear other suggestions though. 😎

stuartmclean added 10 commits December 19, 2023 11:23

initial nestjs boilerplate

b7b999e

add fe boilerplate

d6efe52

test backend connection

52d076c

call for entra login url from login page

1fb6b56

enable cors in dev env

b0561b5

wip: preparing module with dependencies

53c938a

wip

bf49abd

redirect to api

7946050

refactor

95cc31b

request body verification finally working

88b2e84

stuartmclean marked this pull request as draft December 23, 2023 14:18

stuartmclean added 2 commits December 23, 2023 16:02

refactor

fac1f34

add feature flag to disable entra id

5d70aa8

stuartmclean changed the title ~~feat/add aurora entra id login~~ feat: add aurora entra id login Dec 23, 2023

stuartmclean marked this pull request as ready for review December 23, 2023 15:32

stuartmclean requested review from ericbolikowski and helloanil December 23, 2023 15:32

helloanil closed this Jan 2, 2024

helloanil reopened this Jan 2, 2024

helloanil reviewed Jan 2, 2024

View reviewed changes

apps/redi-connect/src/pages/front/login/Login.tsx Outdated Show resolved Hide resolved

helloanil reviewed Jan 2, 2024

View reviewed changes

apps/redi-connect/src/services/api/api.tsx Outdated Show resolved Hide resolved

helloanil reviewed Jan 2, 2024

View reviewed changes

ericbolikowski requested changes Jan 6, 2024

View reviewed changes

Update apps/redi-connect/src/pages/front/login/Login.tsx

ae2a5bc

Co-authored-by: Anıl Akarsu <anil@redi-school.org> Signed-off-by: Stuart McLean <stuart.mclean@soundcloud.com>

remove unused files

d71a5d4

ericbolikowski reviewed Jan 7, 2024

View reviewed changes

apps/nestjs-api/src/entra-id/entra-id.service.ts Outdated Show resolved Hide resolved

stuartmclean added 2 commits January 7, 2024 22:03

simplify service instantiator

3e25cc6

centralize nest api url and usage thereof

eae75ee

ericbolikowski approved these changes Jan 7, 2024

View reviewed changes

repair nest api url usage

c485208

stuartmclean requested review from ericbolikowski and helloanil January 7, 2024 21:53

helloanil reviewed Jan 21, 2024

View reviewed changes

helloanil approved these changes Jan 21, 2024

View reviewed changes

Comments

Conversation

stuartmclean commented Dec 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Important notes:

Further steps required (should be done in separate tickets):

How to test:

Implementation summary:

Uh oh!

helloanil Jan 2, 2024

Choose a reason for hiding this comment

Uh oh!

stuartmclean Jan 14, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

helloanil Jan 2, 2024

Choose a reason for hiding this comment

Uh oh!

ericbolikowski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ericbolikowski Jan 6, 2024

Choose a reason for hiding this comment

Uh oh!

stuartmclean Jan 7, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Jan 7, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

Uh oh!

Uh oh!

ericbolikowski left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmclean commented Jan 7, 2024

Uh oh!

helloanil Jan 21, 2024

Choose a reason for hiding this comment

Uh oh!

stuartmclean Jan 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stuartmclean commented Dec 23, 2023 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

stuartmclean Jan 23, 2024 •

edited

Loading