fix: fixed magic link issues in dev environment #32

JazzarKarim · 2024-11-27T22:53:01Z

Issue #: /bcgov/entity#24363

Fixed a lot of bugs with the magic link that've been occurring in DEV
Refactored the whole flow; made things much cleaner
Fixed unit tests

I've been getting page not found non-stop in DEV. I changed the whole flow to make things cleaner and simpler.

New flow:

I removed the old directory + file. I deal now everything in index.vue (if there is a magic link). It's all conditional.
I've also noticed something. Before, when we click on the magic link, it sticks in the browser:

If a user presses refresh by mistake for example, the link will run again. That is not ideal.
New flow: Magic link is pressed --> Set the token in session storage (using a middleware) --> Redirect to home --> Check if token exists in session storage --> Yes? then process it then clear it from season storage. No? then skip the process.

JazzarKarim · 2024-11-29T02:40:31Z

/gcbrun

bcregistry-sre · 2024-11-29T02:43:55Z

Temporary Url for review: https://business-registry-dev--pr-32-64iszjjg.web.app

severinbeauvais · 2024-12-02T18:30:01Z

Karim, on the preview link, are you able to search for businesses (to affiliate them)?

JazzarKarim · 2024-12-02T18:40:41Z

Karim, on the preview link, are you able to search for businesses (to affiliate them)?

No Sev, I can't. I've been using kind of a workaround to test this.

What I'm doing is I'm going to the regular dev, https://business-registry-dev.web.app/en-CA, do the steps, get the link there by email, then replace the dev URL with the one here before the token.

JazzarKarim · 2024-12-02T22:02:50Z

/gcbrun

bcregistry-sre · 2024-12-02T22:06:15Z

Temporary Url for review: https://business-registry-dev--pr-32-64iszjjg.web.app

JazzarKarim · 2024-12-02T22:12:13Z

@severinbeauvais I haven't been able to fix the search issue in the preview link 😞

I'm pretty sure the issue is with the key. I've tried the API key I have locally and the one from 1Pass, both didn't work. I'm probably going to ping Thor or Dietrich and see what they think.

severinbeauvais · 2024-12-02T22:19:26Z

business-registry-dashboard/app/middleware/01.auth.global.ts

@@ -3,7 +3,7 @@ export default defineNuxtRouteMiddleware((to) => {
    const { $keycloak } = useNuxtApp()
    const localePath = useLocalePath()
    if (to.meta.order !== 0 && !$keycloak.authenticated) {
-      return navigateTo(localePath('/'))


Does this old function do anything extra (like set URL parameters)?

Does it matter that the old code sometimes returns something and the new code doesn't?

So I changed this Sev to use the new window.location.href only if the URL has a token.

What the old one is doing basically is the same as the new one except for the fact that window.location.href = localePath('/') causes a full page reload which is needed in this case.

Is this still needed?

business-registry-dashboard/app/pages/index.vue

severinbeauvais · 2024-12-02T22:25:16Z

business-registry-dashboard/app/middleware/02.magic-link.global.ts

+    if (token) {
+      sessionStorage.setItem('affiliationToken', token)
+    }
+    window.location.href = localePath('/')


So, if the path contains a token then you save it to session storage and then reload everything?

Yep, exactly.

Why so complicated? Why can't the token be handled directly? Why is a reload needed? Could you just push a new route?

Because any route that is not that the main route will give a page 404 error:

Whenever that link is pressed, we will get an error if we don't handle it using a middleware or something else. It's not possible to handle it from the index.vue file directly as we won't even make it to that file.

When I tried handling that via an actual route, I was getting that error as well since the email returned has a double slash //. The browser was standardizing the URL and removing org ID part. It's a weird thing really. That's why I moved away from that design as I tried countless things but couldn't manage to deal with all the edge cases properly.

This shouldn't be an issue now

~~I love the new design!~~

~~Please resolve this conversation.~~

I want to understand the new design.

severinbeauvais · 2024-12-02T22:27:46Z

business-registry-dashboard/app/pages/index.vue

+      console.error('Error accepting affiliation invitation:', e)
+    }
+  }
+})


I don't love this design of "check URL parameters + set session storage + reload + check session storage + handle token". It feels complicated and I keep thinking there are edge cases.

Can you check this design with someone else, like Travis?

OK, will check with Travis now and see what he thinks.

This shouldn't be an issue now

~~I love the new design!~~

~~Please resolve this conversation.~~

So what's the new design? Does it still update the URL, reload everything, etc?

JazzarKarim · 2024-12-04T00:02:00Z

/gcbrun

bcregistry-sre · 2024-12-04T00:05:24Z

Temporary Url for review: https://business-registry-dev--pr-32-64iszjjg.web.app

JazzarKarim · 2024-12-04T01:52:01Z

I'm closing this PR. This is because the whole thing changed. We're moving away from this sessionStorage solution and instead, the magic link format was changed in AUTH API: bcgov/sbc-auth#3166

So, the new PR and what I'm going to merge is this: #34

testing config values

613a39e

JazzarKarim self-assigned this Nov 27, 2024

JazzarKarim added 17 commits November 27, 2024 14:59

changed sample file for testing purposes

108bbbd

reverted change

108deda

testing a new middleware

3617447

testing new middleware again

4a95aa8

trying something out

c1436b2

test changes config

a745140

testing ssr off

7749eb7

test ssr off

a79bca9

testing new route

8277c07

added some debug code

ad985f4

more config

87b2dcd

error fix

371bf74

removed auth middleware

605667b

reverted all changes

13f2db1

changed the logic of magic link

6df4b54

cleanup

1566bc2

fixed unit tests

fdb04a1

bcgov deleted a comment from bcregistry-sre Nov 29, 2024

JazzarKarim changed the title ~~testing config values~~ fix: fixed magic link issues in dev environment Nov 29, 2024

bcgov deleted a comment from bcregistry-sre Nov 29, 2024

testing ld client

1be53a4

bcgov deleted a comment from bcregistry-sre Dec 2, 2024

JazzarKarim added 2 commits December 2, 2024 11:45

reverted change

303b8b8

fixed navigation when not logged in

71f013b

bcgov deleted a comment from bcregistry-sre Dec 2, 2024

JazzarKarim marked this pull request as ready for review December 2, 2024 22:10

JazzarKarim requested review from severinbeauvais and meawong December 2, 2024 22:10

severinbeauvais reviewed Dec 2, 2024

View reviewed changes

business-registry-dashboard/app/pages/index.vue Outdated Show resolved Hide resolved

severinbeauvais reviewed Dec 2, 2024

View reviewed changes

JazzarKarim added 2 commits December 2, 2024 14:32

changed auth middleware to deal with token conditionally

db476ea

changed to use StatusCodes enum

65ff8bb

JazzarKarim closed this Dec 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: fixed magic link issues in dev environment #32

fix: fixed magic link issues in dev environment #32

JazzarKarim commented Nov 27, 2024 •

edited

Loading

JazzarKarim commented Nov 29, 2024

bcregistry-sre commented Nov 29, 2024

severinbeauvais commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024

bcregistry-sre commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024 •

edited

Loading

severinbeauvais Dec 2, 2024

JazzarKarim Dec 2, 2024 •

edited

Loading

severinbeauvais Dec 4, 2024

severinbeauvais Dec 2, 2024

JazzarKarim Dec 2, 2024

severinbeauvais Dec 2, 2024 •

edited

Loading

JazzarKarim Dec 2, 2024

seeker25 Dec 4, 2024

severinbeauvais Dec 4, 2024 •

edited

Loading

severinbeauvais Dec 2, 2024

JazzarKarim Dec 2, 2024

seeker25 Dec 4, 2024

severinbeauvais Dec 4, 2024 •

edited

Loading

JazzarKarim commented Dec 4, 2024

bcregistry-sre commented Dec 4, 2024

JazzarKarim commented Dec 4, 2024

fix: fixed magic link issues in dev environment #32

fix: fixed magic link issues in dev environment #32

Conversation

JazzarKarim commented Nov 27, 2024 • edited Loading

JazzarKarim commented Nov 29, 2024

bcregistry-sre commented Nov 29, 2024

severinbeauvais commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024

bcregistry-sre commented Dec 2, 2024

JazzarKarim commented Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

JazzarKarim Dec 2, 2024 • 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

severinbeauvais Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

severinbeauvais Dec 4, 2024 • 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

severinbeauvais Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

JazzarKarim commented Dec 4, 2024

bcregistry-sre commented Dec 4, 2024

JazzarKarim commented Dec 4, 2024

JazzarKarim commented Nov 27, 2024 •

edited

Loading

JazzarKarim commented Dec 2, 2024 •

edited

Loading

JazzarKarim Dec 2, 2024 •

edited

Loading

severinbeauvais Dec 2, 2024 •

edited

Loading

severinbeauvais Dec 4, 2024 •

edited

Loading

severinbeauvais Dec 4, 2024 •

edited

Loading