@usehercules/auth 1.0.42 → 1.0.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { useCallback, useMemo } from "react";
1
+ import { useCallback, useMemo, useRef } from "react";
2
2
  import { useAuth } from "react-oidc-context";
3
3
  import { jsx } from "react/jsx-runtime";
4
4
  import { ConvexProviderWithAuth } from "convex/react";
@@ -22,12 +22,21 @@ function ConvexProviderWithHerculesAuth({ children, client }) {
22
22
  function useUseAuthFromHercules() {
23
23
  const { isAuthenticated, user, isLoading, signinSilent } = useAuth();
24
24
  const idToken = user?.id_token;
25
- const fetchAccessToken = useCallback(async ({ forceRefreshToken: _ignore }) => {
26
- try {
27
- return idToken ?? null;
28
- } catch {
29
- return null;
30
- }
25
+ const inFlightRefresh = useRef(null);
26
+ const fetchAccessToken = useCallback(async ({ forceRefreshToken }) => {
27
+ if (!forceRefreshToken) return idToken ?? null;
28
+ if (inFlightRefresh.current) return inFlightRefresh.current;
29
+ const refresh = (async () => {
30
+ try {
31
+ return (await signinSilent())?.id_token ?? null;
32
+ } catch {
33
+ return null;
34
+ } finally {
35
+ inFlightRefresh.current = null;
36
+ }
37
+ })();
38
+ inFlightRefresh.current = refresh;
39
+ return refresh;
31
40
  }, [idToken, signinSilent]);
32
41
  return useMemo(() => ({
33
42
  isLoading,
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":[],"sources":["../../src/convex-react/ConvexProviderWithHercules.tsx"],"sourcesContent":["\"use client\";\n\nimport type { ReactNode } from \"react\";\nimport { ConvexProviderWithAuth, type ConvexReactClient } from \"convex/react\";\nimport { useCallback, useMemo } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\nimport type { HerculesAuthProvider } from \"../react/HerculesAuthProvider\";\n\n/**\n * A wrapper React component which provides a {@link ConvexReactClient}\n * authenticated with Hercules Auth.\n *\n * It must be wrapped by a configured `{@link HerculesAuthProvider}`.\n *\n * @public\n */\nexport function ConvexProviderWithHerculesAuth({\n children,\n client,\n}: {\n children: ReactNode;\n client: ConvexReactClient;\n}) {\n return (\n <ConvexProviderWithAuth client={client} useAuth={useUseAuthFromHercules}>\n {children}\n </ConvexProviderWithAuth>\n );\n}\n\nfunction useUseAuthFromHercules() {\n const { isAuthenticated, user, isLoading, signinSilent } = useAuth();\n const idToken = user?.id_token;\n const fetchAccessToken = useCallback(\n async ({ forceRefreshToken: _ignore }: { forceRefreshToken: boolean }) => {\n try {\n // if (forceRefreshToken) {\n // const user = await signinSilent();\n // return user?.id_token ?? null;\n // }\n return idToken ?? null;\n } catch {\n return null;\n }\n },\n [idToken, signinSilent],\n );\n return useMemo(\n () => ({\n isLoading,\n isAuthenticated,\n fetchAccessToken,\n }),\n [isLoading, isAuthenticated, fetchAccessToken],\n );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,SAAgB,+BAA+B,EAC7C,UACA,UAIC;AACD,QACE,oBAAC;EAA+B;EAAQ,SAAS;EAC9C;GACsB;;AAI7B,SAAS,yBAAyB;CAChC,MAAM,EAAE,iBAAiB,MAAM,WAAW,iBAAiB,SAAS;CACpE,MAAM,UAAU,MAAM;CACtB,MAAM,mBAAmB,YACvB,OAAO,EAAE,mBAAmB,cAA8C;AACxE,MAAI;AAKF,UAAO,WAAW;UACZ;AACN,UAAO;;IAGX,CAAC,SAAS,aAAa,CACxB;AACD,QAAO,eACE;EACL;EACA;EACA;EACD,GACD;EAAC;EAAW;EAAiB;EAAiB,CAC/C"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../../src/convex-react/ConvexProviderWithHercules.tsx"],"sourcesContent":["\"use client\";\n\nimport type { ReactNode } from \"react\";\nimport { ConvexProviderWithAuth, type ConvexReactClient } from \"convex/react\";\nimport { useCallback, useMemo, useRef } from \"react\";\nimport { useAuth } from \"react-oidc-context\";\nimport type { HerculesAuthProvider } from \"../react/HerculesAuthProvider\";\n\n/**\n * A wrapper React component which provides a {@link ConvexReactClient}\n * authenticated with Hercules Auth.\n *\n * It must be wrapped by a configured `{@link HerculesAuthProvider}`.\n *\n * @public\n */\nexport function ConvexProviderWithHerculesAuth({\n children,\n client,\n}: {\n children: ReactNode;\n client: ConvexReactClient;\n}) {\n return (\n <ConvexProviderWithAuth client={client} useAuth={useUseAuthFromHercules}>\n {children}\n </ConvexProviderWithAuth>\n );\n}\n\nfunction useUseAuthFromHercules() {\n const { isAuthenticated, user, isLoading, signinSilent } = useAuth();\n const idToken = user?.id_token;\n\n const inFlightRefresh = useRef<Promise<string | null> | null>(null);\n\n const fetchAccessToken = useCallback(\n async ({ forceRefreshToken }: { forceRefreshToken: boolean }) => {\n if (!forceRefreshToken) {\n return idToken ?? null;\n }\n if (inFlightRefresh.current) {\n return inFlightRefresh.current;\n }\n const refresh = (async () => {\n try {\n const refreshed = await signinSilent();\n return refreshed?.id_token ?? null;\n } catch {\n return null;\n } finally {\n inFlightRefresh.current = null;\n }\n })();\n inFlightRefresh.current = refresh;\n return refresh;\n },\n [idToken, signinSilent],\n );\n return useMemo(\n () => ({\n isLoading,\n isAuthenticated,\n fetchAccessToken,\n }),\n [isLoading, isAuthenticated, fetchAccessToken],\n );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,SAAgB,+BAA+B,EAC7C,UACA,UAIC;AACD,QACE,oBAAC;EAA+B;EAAQ,SAAS;EAC9C;GACsB;;AAI7B,SAAS,yBAAyB;CAChC,MAAM,EAAE,iBAAiB,MAAM,WAAW,iBAAiB,SAAS;CACpE,MAAM,UAAU,MAAM;CAEtB,MAAM,kBAAkB,OAAsC,KAAK;CAEnE,MAAM,mBAAmB,YACvB,OAAO,EAAE,wBAAwD;AAC/D,MAAI,CAAC,kBACH,QAAO,WAAW;AAEpB,MAAI,gBAAgB,QAClB,QAAO,gBAAgB;EAEzB,MAAM,WAAW,YAAY;AAC3B,OAAI;AAEF,YADkB,MAAM,cAAc,GACpB,YAAY;WACxB;AACN,WAAO;aACC;AACR,oBAAgB,UAAU;;MAE1B;AACJ,kBAAgB,UAAU;AAC1B,SAAO;IAET,CAAC,SAAS,aAAa,CACxB;AACD,QAAO,eACE;EACL;EACA;EACA;EACD,GACD;EAAC;EAAW;EAAiB;EAAiB,CAC/C"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@usehercules/auth",
3
- "version": "1.0.42",
3
+ "version": "1.0.43",
4
4
  "description": "Authentication utilities for Hercules applications using OIDC",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -0,0 +1,196 @@
1
+ import { describe, it, expect, vi, beforeEach } from "vitest";
2
+ import type { ReactNode } from "react";
3
+ import { renderHook, act, configure } from "@testing-library/react";
4
+ import { ConvexProviderWithHerculesAuth } from "./ConvexProviderWithHercules.js";
5
+
6
+ configure({ reactStrictMode: true });
7
+
8
+ const mockSigninSilent = vi.fn();
9
+
10
+ let mockAuthState: Record<string, unknown> = {};
11
+
12
+ vi.mock("react-oidc-context", () => ({
13
+ useAuth: () => mockAuthState,
14
+ }));
15
+
16
+ type CapturedUseAuth = () => {
17
+ isLoading: boolean;
18
+ isAuthenticated: boolean;
19
+ fetchAccessToken: (args: {
20
+ forceRefreshToken: boolean;
21
+ }) => Promise<string | null>;
22
+ };
23
+
24
+ let capturedUseAuth: CapturedUseAuth | null = null;
25
+
26
+ vi.mock("convex/react", () => ({
27
+ ConvexProviderWithAuth: ({
28
+ children,
29
+ useAuth,
30
+ }: {
31
+ children: ReactNode;
32
+ useAuth: CapturedUseAuth;
33
+ }) => {
34
+ capturedUseAuth = useAuth;
35
+ return children;
36
+ },
37
+ }));
38
+
39
+ function setAuthState(overrides: Record<string, unknown>) {
40
+ mockAuthState = {
41
+ isLoading: false,
42
+ isAuthenticated: true,
43
+ user: { id_token: "cached-token" },
44
+ signinSilent: mockSigninSilent,
45
+ ...overrides,
46
+ };
47
+ }
48
+
49
+ beforeEach(() => {
50
+ setAuthState({});
51
+ mockSigninSilent.mockReset();
52
+ capturedUseAuth = null;
53
+ });
54
+
55
+ function renderUseAuth() {
56
+ renderHook(() => null, {
57
+ wrapper: ({ children }) => (
58
+ <ConvexProviderWithHerculesAuth client={{} as never}>
59
+ {children}
60
+ </ConvexProviderWithHerculesAuth>
61
+ ),
62
+ });
63
+ if (!capturedUseAuth) {
64
+ throw new Error("useAuth not captured");
65
+ }
66
+ const captured = capturedUseAuth;
67
+ return renderHook(() => captured());
68
+ }
69
+
70
+ describe("ConvexProviderWithHerculesAuth fetchAccessToken", () => {
71
+ it("returns the cached id token when forceRefreshToken is false", async () => {
72
+ const { result } = renderUseAuth();
73
+
74
+ const token = await result.current.fetchAccessToken({
75
+ forceRefreshToken: false,
76
+ });
77
+
78
+ expect(token).toBe("cached-token");
79
+ expect(mockSigninSilent).not.toHaveBeenCalled();
80
+ });
81
+
82
+ it("calls signinSilent and returns the refreshed token when forceRefreshToken is true", async () => {
83
+ mockSigninSilent.mockResolvedValue({ id_token: "fresh-token" });
84
+
85
+ const { result } = renderUseAuth();
86
+
87
+ let token: string | null = null;
88
+ await act(async () => {
89
+ token = await result.current.fetchAccessToken({
90
+ forceRefreshToken: true,
91
+ });
92
+ });
93
+
94
+ expect(token).toBe("fresh-token");
95
+ expect(mockSigninSilent).toHaveBeenCalledOnce();
96
+ });
97
+
98
+ it("returns null when signinSilent throws", async () => {
99
+ mockSigninSilent.mockRejectedValue(new Error("refresh failed"));
100
+
101
+ const { result } = renderUseAuth();
102
+
103
+ let token: string | null = "unset";
104
+ await act(async () => {
105
+ token = await result.current.fetchAccessToken({
106
+ forceRefreshToken: true,
107
+ });
108
+ });
109
+
110
+ expect(token).toBeNull();
111
+ expect(mockSigninSilent).toHaveBeenCalledOnce();
112
+ });
113
+
114
+ it("returns null when signinSilent resolves without a user", async () => {
115
+ mockSigninSilent.mockResolvedValue(null);
116
+
117
+ const { result } = renderUseAuth();
118
+
119
+ let token: string | null = "unset";
120
+ await act(async () => {
121
+ token = await result.current.fetchAccessToken({
122
+ forceRefreshToken: true,
123
+ });
124
+ });
125
+
126
+ expect(token).toBeNull();
127
+ expect(mockSigninSilent).toHaveBeenCalledOnce();
128
+ });
129
+
130
+ it("dedupes concurrent forceRefreshToken calls into a single signinSilent", async () => {
131
+ let resolveSilent: ((value: { id_token: string }) => void) | null = null;
132
+ mockSigninSilent.mockImplementation(
133
+ () =>
134
+ new Promise<{ id_token: string }>((resolve) => {
135
+ resolveSilent = resolve;
136
+ }),
137
+ );
138
+
139
+ const { result } = renderUseAuth();
140
+
141
+ let firstToken: string | null = null;
142
+ let secondToken: string | null = null;
143
+ let thirdToken: string | null = null;
144
+
145
+ await act(async () => {
146
+ const first = result.current.fetchAccessToken({
147
+ forceRefreshToken: true,
148
+ });
149
+ const second = result.current.fetchAccessToken({
150
+ forceRefreshToken: true,
151
+ });
152
+ const third = result.current.fetchAccessToken({
153
+ forceRefreshToken: true,
154
+ });
155
+
156
+ resolveSilent?.({ id_token: "fresh-token" });
157
+
158
+ [firstToken, secondToken, thirdToken] = await Promise.all([
159
+ first,
160
+ second,
161
+ third,
162
+ ]);
163
+ });
164
+
165
+ expect(firstToken).toBe("fresh-token");
166
+ expect(secondToken).toBe("fresh-token");
167
+ expect(thirdToken).toBe("fresh-token");
168
+ expect(mockSigninSilent).toHaveBeenCalledOnce();
169
+ });
170
+
171
+ it("allows a new refresh after the in-flight refresh settles", async () => {
172
+ mockSigninSilent
173
+ .mockResolvedValueOnce({ id_token: "first-fresh" })
174
+ .mockResolvedValueOnce({ id_token: "second-fresh" });
175
+
176
+ const { result } = renderUseAuth();
177
+
178
+ let firstToken: string | null = null;
179
+ let secondToken: string | null = null;
180
+
181
+ await act(async () => {
182
+ firstToken = await result.current.fetchAccessToken({
183
+ forceRefreshToken: true,
184
+ });
185
+ });
186
+ await act(async () => {
187
+ secondToken = await result.current.fetchAccessToken({
188
+ forceRefreshToken: true,
189
+ });
190
+ });
191
+
192
+ expect(firstToken).toBe("first-fresh");
193
+ expect(secondToken).toBe("second-fresh");
194
+ expect(mockSigninSilent).toHaveBeenCalledTimes(2);
195
+ });
196
+ });
@@ -2,7 +2,7 @@
2
2
 
3
3
  import type { ReactNode } from "react";
4
4
  import { ConvexProviderWithAuth, type ConvexReactClient } from "convex/react";
5
- import { useCallback, useMemo } from "react";
5
+ import { useCallback, useMemo, useRef } from "react";
6
6
  import { useAuth } from "react-oidc-context";
7
7
  import type { HerculesAuthProvider } from "../react/HerculesAuthProvider";
8
8
 
@@ -31,17 +31,29 @@ export function ConvexProviderWithHerculesAuth({
31
31
  function useUseAuthFromHercules() {
32
32
  const { isAuthenticated, user, isLoading, signinSilent } = useAuth();
33
33
  const idToken = user?.id_token;
34
+
35
+ const inFlightRefresh = useRef<Promise<string | null> | null>(null);
36
+
34
37
  const fetchAccessToken = useCallback(
35
- async ({ forceRefreshToken: _ignore }: { forceRefreshToken: boolean }) => {
36
- try {
37
- // if (forceRefreshToken) {
38
- // const user = await signinSilent();
39
- // return user?.id_token ?? null;
40
- // }
38
+ async ({ forceRefreshToken }: { forceRefreshToken: boolean }) => {
39
+ if (!forceRefreshToken) {
41
40
  return idToken ?? null;
42
- } catch {
43
- return null;
44
41
  }
42
+ if (inFlightRefresh.current) {
43
+ return inFlightRefresh.current;
44
+ }
45
+ const refresh = (async () => {
46
+ try {
47
+ const refreshed = await signinSilent();
48
+ return refreshed?.id_token ?? null;
49
+ } catch {
50
+ return null;
51
+ } finally {
52
+ inFlightRefresh.current = null;
53
+ }
54
+ })();
55
+ inFlightRefresh.current = refresh;
56
+ return refresh;
45
57
  },
46
58
  [idToken, signinSilent],
47
59
  );