getOrRenewAccessToken #1507

jaredperreault-okta · 2024-04-12T15:15:37Z

No description provided.

glenfannin-okta

A few verbiage nits, but LGTM!

One question for my own understanding, how does the app know the difference between when no token exists (unauthenticated) vs when the access token is just not in storage?

glenfannin-okta · 2024-04-12T15:19:29Z

docs/autoRenew-notice.md

@@ -0,0 +1,28 @@
+#  Future of AuthJS `autoRenew`
+
+We have been tracking browsers the changes browsers has been making to long running timers, especially in inactive tabs, and have begun to receive reports of flaky and unpredictable behavior from our [Active AutoRenew](../README.md#autorenew-1). We have spiked on the usage of Web Worker based timers, however we decided not to move forward with that approach. Active AutoRenew served it's purpose, however the introduction of [refresh tokens](https://developer.okta.com/docs/guides/refresh-tokens/main/#about-refresh-tokens) have made it a bit antiquated. A better, more reliable approach to token renewal is renewing the token (if needed) when tokens are read from storage. The [isAuthenticated()](../README.md#isauthenticatedoptions) method already does this and we have added a new method [getOrRenewAccessToken()](../README.md#getorrenewaccesstoken) for convenience. Unfortunately we cannot make this the default behavior when tokens are read because storage operations are not `async` and performing a token renewal is (results in http request). 


Suggested change

We have been tracking browsers the changes browsers has been making to long running timers, especially in inactive tabs, and have begun to receive reports of flaky and unpredictable behavior from our [Active AutoRenew](../README.md#autorenew-1). We have spiked on the usage of Web Worker based timers, however we decided not to move forward with that approach. Active AutoRenew served it's purpose, however the introduction of [refresh tokens](https://developer.okta.com/docs/guides/refresh-tokens/main/#about-refresh-tokens) have made it a bit antiquated. A better, more reliable approach to token renewal is renewing the token (if needed) when tokens are read from storage. The [isAuthenticated()](../README.md#isauthenticatedoptions) method already does this and we have added a new method [getOrRenewAccessToken()](../README.md#getorrenewaccesstoken) for convenience. Unfortunately we cannot make this the default behavior when tokens are read because storage operations are not `async` and performing a token renewal is (results in http request).

We have been tracking the changes browsers have been making to long running timers, especially in inactive tabs, and have begun to receive reports of flaky and unpredictable behavior from our [Active AutoRenew](../README.md#autorenew-1). We have spiked on the usage of Web Worker based timers, however we decided not to move forward with that approach. Active AutoRenew served it's purpose, however the introduction of [refresh tokens](https://developer.okta.com/docs/guides/refresh-tokens/main/#about-refresh-tokens) have made it a bit antiquated. A better, more reliable approach to token renewal is renewing the token (if needed) when tokens are read from storage. The [isAuthenticated()](../README.md#isauthenticatedoptions) method already does this and we have added a new method [getOrRenewAccessToken()](../README.md#getorrenewaccesstoken) for convenience. Unfortunately we cannot make this the default behavior when tokens are read because storage operations are not `async` and performing a token renewal results in http request.

glenfannin-okta · 2024-04-12T15:22:54Z

lib/oidc/TokenManager.ts

@@ -439,6 +445,14 @@ export class TokenManager implements TokenManagerInterface {
      .then(tokens => {
        this.setTokens(tokens);

+        // return accessToken in case where access token doesn't exist
+        // but refresh token does exists


Suggested change

// but refresh token does exists

// but refresh token exists

glenfannin-okta · 2024-04-12T15:53:10Z

test/spec/OktaAuth/api.ts

+      expect(renewSpy).toHaveBeenCalled();
+    });
+
+    it('returns renewed access token when no stored access token exists', async () => {


nit: possibly consider including in the test name that only refresh token exists

Suggested change

it('returns renewed access token when no stored access token exists', async () => {

it('returns renewed access token when only stored refresh token exists', async () => {

lesterchoi-okta · 2024-04-12T16:20:31Z

README.md

+### `getOrRenewAccessToken()`
+
+Reads the `accessToken` from storage and will attempt a token renewal if expired.
+Returns the access token string or `null` if the doesn't exist or a renewal cannot be completed


Suggested change

Returns the access token string or `null` if the doesn't exist or a renewal cannot be completed

Returns the access token string if it exists. Returns `null` if the access token doesn't exist or a renewal cannot be completed

lesterchoi-okta · 2024-04-12T16:24:59Z

lib/oidc/mixin/index.ts

+      }
+      try {
+        const key = this.tokenManager.getStorageKeyByType('accessToken');
+        const token = await this.tokenManager.renew(key ?? 'accessToken') as AccessToken;


.renew() returns Promise<Token | undefined>. Shouldn't you check truthiness instead of using type coercion?

lesterchoi-okta · 2024-04-12T16:27:00Z

README.md

 ## Release Status

 :heavy_check_mark: The current stable major version series is: `7.x`

 | Version   | Status                           |
 | -------   | -------------------------------- |
 | `7.x`     | :heavy_check_mark: Stable        |
-| `6.x`     | :warning: Retiring on 2023-09-30 |
+| `6.x`     | :x: Retired  |


lesterchoi-okta · 2024-04-12T16:27:51Z

README.md

@@ -36,14 +36,19 @@ You can learn more on the [Okta + JavaScript][lang-landing] page in our document

 This library uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/).

+> :warning: :warning: :warning: :warning: :warning:<br>


tip: in markdown, two spaces at EOL will be a newline

lesterchoi-okta · 2024-04-12T16:29:29Z

test/spec/OktaAuth/api.ts

+      auth.tokenManager.clear();
+    });
+
+    const now = Math.floor(Date.now() / 1000);


nit: move now into tests or beforeEach for better isolation?

lesterchoi-okta · 2024-04-12T16:30:43Z

test/spec/TokenManager/core.ts

@@ -355,6 +355,32 @@ describe('TokenManager', function() {
      });
      return p1;
    });
+
+    it('performs renew when no access token exists but refresh token is present', async () => {
+      expect.assertions(4);


never knew this, TIL

lesterchoi-okta

I can re-approve if taking out of draft mode requires

glenfannin-okta approved these changes Apr 12, 2024

View reviewed changes

glenfannin-okta previously approved these changes Apr 12, 2024

View reviewed changes

lesterchoi-okta reviewed Apr 12, 2024

View reviewed changes

shuowu-okta previously approved these changes Apr 12, 2024

View reviewed changes

jaredperreault-okta dismissed stale reviews from shuowu-okta and glenfannin-okta via 117f0cc April 15, 2024 12:33

jaredperreault-okta added 2 commits April 15, 2024 08:33

first pass

397a7f5

fix test

2548831

jaredperreault-okta force-pushed the jp-OKTA-718696 branch from 117f0cc to 2548831 Compare April 15, 2024 12:34

lesterchoi-okta previously approved these changes Apr 15, 2024

View reviewed changes

handles undefined at

e7828a7

jaredperreault-okta dismissed lesterchoi-okta’s stale review via e7828a7 April 18, 2024 18:17

jaredperreault-okta marked this pull request as ready for review April 18, 2024 18:21

lesterchoi-okta approved these changes Apr 18, 2024

View reviewed changes

oktapp-aperture-okta bot merged commit 4269d34 into master Apr 18, 2024
1 check passed

oktapp-aperture-okta bot deleted the jp-OKTA-718696 branch April 18, 2024 20:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

getOrRenewAccessToken #1507

getOrRenewAccessToken #1507

jaredperreault-okta commented Apr 12, 2024

glenfannin-okta left a comment •

edited

Loading

glenfannin-okta Apr 12, 2024

glenfannin-okta Apr 12, 2024

glenfannin-okta Apr 12, 2024 •

edited

Loading

lesterchoi-okta Apr 12, 2024

lesterchoi-okta Apr 12, 2024

lesterchoi-okta Apr 12, 2024

lesterchoi-okta Apr 12, 2024

lesterchoi-okta Apr 12, 2024

lesterchoi-okta Apr 12, 2024

lesterchoi-okta left a comment

		@@ -0,0 +1,28 @@
		# Future of AuthJS `autoRenew`

		We have been tracking browsers the changes browsers has been making to long running timers, especially in inactive tabs, and have begun to receive reports of flaky and unpredictable behavior from our [Active AutoRenew](../README.md#autorenew-1). We have spiked on the usage of Web Worker based timers, however we decided not to move forward with that approach. Active AutoRenew served it's purpose, however the introduction of [refresh tokens](https://developer.okta.com/docs/guides/refresh-tokens/main/#about-refresh-tokens) have made it a bit antiquated. A better, more reliable approach to token renewal is renewing the token (if needed) when tokens are read from storage. The [isAuthenticated()](../README.md#isauthenticatedoptions) method already does this and we have added a new method [getOrRenewAccessToken()](../README.md#getorrenewaccesstoken) for convenience. Unfortunately we cannot make this the default behavior when tokens are read because storage operations are not `async` and performing a token renewal is (results in http request).

	it('returns renewed access token when no stored access token exists', async () => {
	it('returns renewed access token when only stored refresh token exists', async () => {

	Returns the access token string or `null` if the doesn't exist or a renewal cannot be completed
	Returns the access token string if it exists. Returns `null` if the access token doesn't exist or a renewal cannot be completed

		@@ -36,14 +36,19 @@ You can learn more on the [Okta + JavaScript][lang-landing] page in our document

		This library uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/).

		> :warning: :warning: :warning: :warning: :warning:<br>

getOrRenewAccessToken #1507

getOrRenewAccessToken #1507

Conversation

jaredperreault-okta commented Apr 12, 2024

glenfannin-okta left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glenfannin-okta Apr 12, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lesterchoi-okta left a comment

Choose a reason for hiding this comment

glenfannin-okta left a comment •

edited

Loading

glenfannin-okta Apr 12, 2024 •

edited

Loading