feat: add the ability to skip loading profiles from SessionProvider (#695)

This is useful when using the React SDK to build a start/provisioning app, where the user will be able to login, but won't yet have a profile or WebID

Author: ThisIsMissEm

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+- Added the ability to prevent the automatic loading of WebID's and Profiles from SessionProvider, this is useful when building provisioning applications where the user has logged in, but doesn't yet have a WebID or Pod or Profile documents.
+
 ## 2.8.1 ( October 10, 2022)
 
 - Upgrade Inrupt SDKs to latest versions

src/context/sessionContext/index.test.tsx

@@ -31,6 +31,8 @@ import {
   onSessionRestore,
 } from "@inrupt/solid-client-authn-browser";
 
+import { getProfileAll } from "@inrupt/solid-client";
+
 import { SessionContext, SessionProvider } from ".";
 
 jest.mock("@inrupt/solid-client-authn-browser");
@@ -217,6 +219,42 @@ describe("SessionContext functionality", () => {
     expect(mockedClientModule.getProfileAll).toHaveBeenCalled();
   });
 
+  it("allows skipping fetching the user's profile if logging in succeeds", async () => {
+    (handleIncomingRedirect as jest.Mock).mockResolvedValueOnce({
+      webId: "https://some.webid",
+    });
+
+    (getProfileAll as jest.Mock).mockResolvedValue({
+      webIdProfile: null,
+      altProfileAll: [],
+    });
+
+    const session = {
+      info: {
+        isLoggedIn: true,
+        webId: "https://fakeurl.com/me",
+      },
+      on: jest.fn(),
+    } as any;
+
+    (getDefaultSession as jest.Mock).mockReturnValue(session);
+
+    const screen = render(
+      <SessionProvider skipLoadingProfile>
+        <ChildComponent />
+      </SessionProvider>
+    );
+    await waitFor(async () => {
+      expect(screen.getByTestId("profile").textContent).toBe(
+        "No profile found"
+      );
+    });
+
+    expect(screen.getByTestId("profile").textContent).toBe("No profile found");
+    expect(getProfileAll).not.toHaveBeenCalled();
+    expect(handleIncomingRedirect).toHaveBeenCalled();
+  });
+
   it("uses the login and logout functions from session", async () => {
     (handleIncomingRedirect as jest.Mock).mockResolvedValueOnce(null);
 

src/context/sessionContext/index.tsx

@@ -75,6 +75,11 @@ export interface ISessionProvider {
   restorePreviousSession?: boolean;
   /** @since 2.3.0 */
   onSessionRestore?: (url: string) => void;
+  /**
+   * @since unreleased
+   * @experimental
+   * */
+  skipLoadingProfile?: boolean;
 }
 
 /**
@@ -86,6 +91,7 @@ export const SessionProvider = ({
   onError,
   sessionRequestInProgress: defaultSessionRequestInProgress,
   restorePreviousSession,
+  skipLoadingProfile,
   onSessionRestore,
 }: ISessionProvider): ReactElement => {
   const restoreSession =
@@ -119,18 +125,19 @@ export const SessionProvider = ({
       url: window.location.href,
       restorePreviousSession: restoreSession,
     })
-      .then((sessionInfo) =>
+      .then(async (sessionInfo) => {
+        if (skipLoadingProfile === true) {
+          return;
+        }
+
         // If handleIncomingRedirect logged the session in, we know what the current
         // user's WebID is.
-        sessionInfo?.webId !== undefined
-          ? getProfileAll(sessionInfo?.webId, {
-              fetch: session.fetch,
-            })
-          : undefined
-      )
-      .then((foundProfile) => {
-        if (foundProfile !== undefined) {
-          setProfile(foundProfile);
+        if (sessionInfo?.webId !== undefined) {
+          const profiles = await getProfileAll(sessionInfo?.webId, {
+            fetch: session.fetch,
+          });
+
+          setProfile(profiles);
         }
       })
       .catch((error: Error) => {
@@ -149,7 +156,14 @@ export const SessionProvider = ({
       // TODO force a refresh
       setSession(getDefaultSession());
     });
-  }, [session, sessionId, onError, currentLocation, restoreSession]);
+  }, [
+    session,
+    sessionId,
+    onError,
+    currentLocation,
+    restoreSession,
+    skipLoadingProfile,
+  ]);
 
   const contextLogin = async (options: Parameters<typeof login>[0]) => {
     setSessionRequestInProgress(true);

stories/authentication/sessionProvider.stories.tsx

@@ -20,6 +20,8 @@
  */
 
 import React, { ReactElement, useContext, useState } from "react";
+import { ComponentMeta } from "@storybook/react";
+
 import {
   SessionContext,
   SessionProvider,
@@ -65,8 +67,12 @@ export default {
       description: `Function to be called on session restore. It is invoked with the URL of the refreshed page as its parameter`,
       control: { type: null },
     },
+    skipLoadingProfile: {
+      description: `**Experimental:** When set to true, prevents the SessionProvider from automatically loading the WebID / Profiles`,
+      defaultValue: false,
+    },
   },
-};
+} as ComponentMeta<typeof SessionProvider>;
 
 function Dashboard(): ReactElement {
   const { session, sessionRequestInProgress } = useContext(SessionContext);