@inrupt/solid-client-authn-browser 1.13.3 → 1.14.0

package/src/defaultSession.spec.ts

@@ -19,6 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
+import { EVENTS } from "@inrupt/solid-client-authn-core";
 import { jest, it, expect } from "@jest/globals";
 import {
   fetch,
@@ -29,33 +30,34 @@ import {
   onLogin,
   onSessionRestore,
   onLogout,
+  events,
 } from "./defaultSession";
-import type * as SessionModuleType from "./Session";
-
-jest.mock("../src/Session.ts");
-
-it("does not instantiate a Session without calling one of its methods", () => {
-  const mockedSession = jest.requireMock(
-    "../src/Session.ts"
-  ) as typeof SessionModuleType;
-
-  expect(mockedSession.Session).not.toHaveBeenCalled();
+import * as SessionModule from "./Session";
+
+it("instantiates the default session lazily", () => {
+  const singletonSession = new SessionModule.Session();
+  const spiedConstructor = jest
+    .spyOn(SessionModule, "Session")
+    .mockImplementation(() => singletonSession);
+  expect(spiedConstructor).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
+  expect(spiedConstructor).toHaveBeenCalled();
 });
 
 it("re-uses the same Session when calling multiple methods", () => {
-  const mockedSession = jest.requireMock(
-    "../src/Session.ts"
-  ) as typeof SessionModuleType;
+  const singletonSession = new SessionModule.Session();
+  const spiedConstructor = jest
+    .spyOn(SessionModule, "Session")
+    .mockImplementation(() => singletonSession);
 
-  expect(mockedSession.Session).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
 
-  onLogin(jest.fn());
+  expect(spiedConstructor).toHaveBeenCalledTimes(1);
 
-  expect(mockedSession.Session).toHaveBeenCalledTimes(1);
+  events().on(EVENTS.LOGOUT, jest.fn());
 
-  onLogout(jest.fn());
-
-  expect(mockedSession.Session).toHaveBeenCalledTimes(1);
+  // No new session has been instantiated.
+  expect(spiedConstructor).toHaveBeenCalledTimes(1);
 });
 
 it("all functions pass on their arguments to the default session", () => {
@@ -73,6 +75,7 @@ it("all functions pass on their arguments to the default session", () => {
   const onLoginSpy = jest.spyOn(defaultSession, "onLogin");
   const onLogoutSpy = jest.spyOn(defaultSession, "onLogout");
   const onSessionRestoreSpy = jest.spyOn(defaultSession, "onSessionRestore");
+  const eventsOnSpy = jest.spyOn(defaultSession.events, "on");
 
   expect(fetchSpy).not.toHaveBeenCalled();
   // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -94,6 +97,12 @@ it("all functions pass on their arguments to the default session", () => {
   handleIncomingRedirect("https://example.com");
   expect(handleIncomingRedirectSpy).toHaveBeenCalledTimes(1);
 
+  // onLogin will internall call events.on(...), so the following test
+  // must come first.
+  expect(eventsOnSpy).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
+  expect(eventsOnSpy).toHaveBeenCalledTimes(1);
+
   expect(onLoginSpy).not.toHaveBeenCalled();
   onLogin(jest.fn());
   expect(onLoginSpy).toHaveBeenCalledTimes(1);

package/src/defaultSession.ts

@@ -21,7 +21,7 @@
 
 import { Session } from "./Session";
 
-let defaultSession: Session;
+let defaultSession: Session | undefined;
 
 /**
  * Obtain the {@link Session} used when not explicitly instantiating one yourself.
@@ -97,6 +97,8 @@ export const handleIncomingRedirect: Session["handleIncomingRedirect"] = (
  * @since 1.3.0
  *
  * @param callback The function called when a user completes login.
+ * @deprecated Prefer events.on(EVENTS.LOGIN, callback)
+
  */
 export const onLogin: Session["onLogin"] = (...args) => {
   const session = getDefaultSession();
@@ -108,6 +110,8 @@ export const onLogin: Session["onLogin"] = (...args) => {
  *
  * @param callback The function called when a user completes logout.
  * @since 1.3.0
+ * @deprecated Prefer events.on(EVENTS.LOGOUT, callback)
+
  */
 export const onLogout: Session["onLogout"] = (...args) => {
   const session = getDefaultSession();
@@ -119,8 +123,18 @@ export const onLogout: Session["onLogout"] = (...args) => {
  *
  * @param callback The function called when a session is restored.
  * @since 1.3.0
+ * @deprecated Prefer events.on(EVENTS.SESSION_RESTORED, callback)
  */
 export const onSessionRestore: Session["onSessionRestore"] = (...args) => {
   const session = getDefaultSession();
   return session.onSessionRestore(...args);
 };
+
+/**
+ * {@link SessionEventEmitter} instance to subscribe to events by the default session.
+ *
+ * @since Unreleased
+ */
+export const events = (): Session["events"] => {
+  return getDefaultSession().events;
+};

package/src/index.ts

@@ -34,4 +34,5 @@ export {
   NotImplementedError,
   ConfigurationError,
   InMemoryStorage,
+  EVENTS,
 } from "@inrupt/solid-client-authn-core";

package/src/login/oidc/incomingRedirectHandler/AuthCodeRedirectHandler.spec.ts

@@ -35,7 +35,7 @@ import type * as SolidClientAuthnCore from "@inrupt/solid-client-authn-core";
 import { jest, it, describe, expect } from "@jest/globals";
 import { CodeExchangeResult, getBearerToken } from "@inrupt/oidc-client-ext";
 import type * as OidcClientExt from "@inrupt/oidc-client-ext";
-import { Response } from "cross-fetch";
+import { Response, Headers } from "cross-fetch";
 import { JWK, importJWK } from "jose";
 import { KeyObject } from "crypto";
 import { AuthCodeRedirectHandler } from "./AuthCodeRedirectHandler";
@@ -470,11 +470,6 @@ describe("AuthCodeRedirectHandler", () => {
         storageUtility: mockedStorage,
       });
       await authCodeRedirectHandler.handle(mockRedirectUrl());
-      await expect(
-        mockedStorage.getForUser("mySession", "redirectUrl", {
-          secure: false,
-        })
-      ).resolves.toBe("https://some.redirect.uri/?state=oauth2StateValue");
 
       // The ID token should not have been stored
       await expect(
@@ -484,7 +479,7 @@ describe("AuthCodeRedirectHandler", () => {
       ).resolves.toBeUndefined();
     });
 
-    it("preserves any query strings from the redirect URI", async () => {
+    it("does not override the previously stored redirect URL", async () => {
       mockOidcClient();
 
       window.fetch = (jest.fn() as any).mockReturnValue(
@@ -509,9 +504,8 @@ describe("AuthCodeRedirectHandler", () => {
         mockedStorage.getForUser("mySession", "redirectUrl", {
           secure: false,
         })
-      ).resolves.toBe(
-        "https://some.redirect.uri/?state=oauth2StateValue&someKey=someValue"
-      );
+        // The redirect URL already in storage shouldn't be overriden on redirect.
+      ).resolves.toBe(DEFAULT_REDIRECT_URL);
     });
 
     it("returns the expiration time normalised to the current time", async () => {

package/src/login/oidc/incomingRedirectHandler/AuthCodeRedirectHandler.ts

@@ -175,19 +175,6 @@ export class AuthCodeRedirectHandler implements IIncomingRedirectHandler {
       },
       { secure: true }
     );
-    // Clear the code query param from the redirect URL before storing it, but
-    // preserve any state that my have been provided by the client and returned
-    // by the IdP.
-    url.searchParams.delete("code");
-    await this.storageUtility.setForUser(
-      storedSessionId,
-      {
-        redirectUrl: url.toString(),
-      },
-      {
-        secure: false,
-      }
-    );
 
     const sessionInfo = await this.sessionInfoManager.get(storedSessionId);
     if (!sessionInfo) {