feat(express,next,node): support fetchUserInfo

packages/express-sample/src/app.ts

@@ -24,7 +24,6 @@ const app = express();
 app.use(cookieParser());
 app.use(session({ secret: 'keyboard cat', cookie: { maxAge: 14 * 24 * 60 * 60 } }));
 app.use(handleAuthRoutes(config));
-app.use(withLogto(config));
 
 app.get('/', (request, response) => {
   response.setHeader('content-type', 'text/html');
@@ -37,11 +36,23 @@ app.get('/', (request, response) => {
   );
 });
 
-app.get('/user', (request, response) => {
+app.get('/local-user-claims', withLogto(config), (request, response) => {
   response.json(request.user);
 });
 
-app.get('/protected', requireAuth, (request, response) => {
+app.get(
+  '/remote-full-user',
+  withLogto({
+    ...config,
+    // Fetch user info from remote, this may slowdown the response time, not recommended.
+    fetchUserInfo: true,
+  }),
+  (request, response) => {
+    response.json(request.user);
+  }
+);
+
+app.get('/protected', withLogto(config), requireAuth, (request, response) => {
   response.end('protected resource');
 });
 

packages/express/src/index.ts

@@ -82,7 +82,7 @@ export const withLogto =
   (config: LogtoExpressConfig): Middleware =>
   async (request: IncomingMessage, response: Response, next: NextFunction) => {
     const client = createNodeClient(request, response, config);
-    const user = await client.getContext(config.getAccessToken);
+    const user = await client.getContext(config.getAccessToken, config.fetchUserInfo);
     // eslint-disable-next-line @silverhand/fp/no-mutating-methods
     Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
     next();

packages/express/src/types.ts

@@ -11,4 +11,5 @@ declare module 'http' {
 export type LogtoExpressConfig = LogtoConfig & {
   baseUrl: string;
   getAccessToken?: boolean;
+  fetchUserInfo?: boolean;
 };

packages/next-sample/pages/api/logto/user-info.ts

@@ -0,0 +1,3 @@
+import { logtoClient } from '../../../libraries/logto';
+
+export default logtoClient.handleUser({ fetchUserInfo: true });

packages/next-sample/pages/index.tsx

@@ -4,17 +4,20 @@ import { useMemo } from 'react';
 import useSWR from 'swr';
 
 const Home = () => {
+  // Use server's id token claims
   const { data } = useSWR<LogtoContext>('/api/logto/user');
+  // Remote full user info
+  const { data: dataWithUserInfo } = useSWR<LogtoContext>('/api/logto/user-info');
   const { data: protectedResource } = useSWR<{ data: string }>('/api/protected-resource');
 
-  const userInfo = useMemo(() => {
+  const claims = useMemo(() => {
     if (!data?.isAuthenticated || !data.claims) {
       return null;
     }
 
     return (
       <div>
-        <h2>User info:</h2>
+        <h2>Claims:</h2>
         <table>
           <thead>
             <tr>
@@ -35,6 +38,34 @@ const Home = () => {
     );
   }, [data]);
 
+  const userInfo = useMemo(() => {
+    if (!dataWithUserInfo?.isAuthenticated || !dataWithUserInfo.userInfo) {
+      return null;
+    }
+
+    return (
+      <div>
+        <h2>User info:</h2>
+        <table>
+          <thead>
+            <tr>
+              <th>Name</th>
+              <th>Value</th>
+            </tr>
+          </thead>
+          <tbody>
+            {Object.entries(dataWithUserInfo.userInfo).map(([key, value]) => (
+              <tr key={key}>
+                <td>{key}</td>
+                <td>{JSON.stringify(value)}</td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    );
+  }, [dataWithUserInfo]);
+
   return (
     <div>
       <header>
@@ -51,6 +82,7 @@ const Home = () => {
           </Link>
         )}
       </nav>
+      {claims}
       {userInfo}
       {protectedResource && (
         <div>

packages/next/src/index.ts

@@ -84,7 +84,11 @@ export default class LogtoClient {
 
   withLogtoApiRoute = (handler: NextApiHandler, config: WithLogtoConfig = {}): NextApiHandler =>
     withIronSessionApiRoute(async (request, response) => {
-      const user = await this.getLogtoUserFromRequest(request, config.getAccessToken);
+      const user = await this.getLogtoUserFromRequest(
+        request,
+        config.getAccessToken,
+        config.fetchUserInfo
+      );
 
       // eslint-disable-next-line @silverhand/fp/no-mutating-methods
       Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
@@ -128,9 +132,13 @@ export default class LogtoClient {
     };
   }
 
-  private async getLogtoUserFromRequest(request: IncomingMessage, getAccessToken?: boolean) {
+  private async getLogtoUserFromRequest(
+    request: IncomingMessage,
+    getAccessToken?: boolean,
+    fetchUserInfo?: boolean
+  ) {
     const nodeClient = this.createNodeClient(request);
 
-    return nodeClient.getContext(getAccessToken);
+    return nodeClient.getContext(getAccessToken, fetchUserInfo);
   }
 }

packages/next/src/types.ts

@@ -28,4 +28,5 @@ export type LogtoNextConfig = LogtoConfig & {
  */
 export type WithLogtoConfig = {
   getAccessToken?: boolean;
+  fetchUserInfo?: boolean;
 };

packages/node/src/index.test.ts

@@ -11,6 +11,7 @@ const storage = {
 };
 
 const getAccessToken = jest.fn(async () => true);
+const fetchUserInfo = jest.fn(async () => ({ name: 'name' }));
 const getIdTokenClaims = jest.fn(async () => ({ sub: 'sub' }));
 const isAuthenticated = jest.fn(async () => true);
 jest.mock('@logto/client', () => ({
@@ -19,6 +20,7 @@ jest.mock('@logto/client', () => ({
     getAccessToken,
     getIdTokenClaims,
     isAuthenticated,
+    fetchUserInfo,
   })),
   createRequester: jest.fn(),
 }));
@@ -33,6 +35,7 @@ describe('LogtoClient', () => {
   describe('getContext', () => {
     beforeEach(() => {
       getAccessToken.mockClear();
+      fetchUserInfo.mockClear();
     });
 
     it('should set isAuthenticated to false when "getAccessToken" is enabled and is unable to getAccessToken', async () => {
@@ -42,14 +45,24 @@ describe('LogtoClient', () => {
       expect(getAccessToken).toHaveBeenCalled();
     });
 
-    it('should return context and not call getAccessToken by default', async () => {
+    it('should fetch remote user info and return when "fetchUserInfo" is enabled', async () => {
+      const client = new LogtoClient({ endpoint, appId }, { navigate, storage });
+      await expect(client.getContext(false, true)).resolves.toMatchObject({
+        claims: { sub: 'sub' },
+        userInfo: { name: 'name' },
+      });
+      expect(fetchUserInfo).toHaveBeenCalled();
+    });
+
+    it('should return context and not call getAccessToken and fetchUserInfo by default', async () => {
       const client = new LogtoClient({ endpoint, appId }, { navigate, storage });
       await expect(client.getContext()).resolves.toEqual({
         isAuthenticated: true,
         claims: { sub: 'sub' },
       });
       expect(getIdTokenClaims).toHaveBeenCalled();
       expect(getAccessToken).not.toHaveBeenCalled();
+      expect(fetchUserInfo).not.toHaveBeenCalled();
     });
   });
 });

packages/node/src/index.ts

@@ -1,4 +1,5 @@
 import BaseClient, { LogtoConfig, createRequester, ClientAdapter } from '@logto/client';
+import { conditional } from '@silverhand/essentials';
 import fetch from 'node-fetch';
 
 import { LogtoContext } from './types';
@@ -55,7 +56,8 @@ export default class LogtoClient extends BaseClient {
     });
   }
 
-  getContext = async (getAccessToken = false): Promise<LogtoContext> => {
+  /* eslint-disable complexity */
+  getContext = async (getAccessToken = false, fetchUserInfo = false): Promise<LogtoContext> => {
     const isAuthenticated = await this.isAuthenticated();
 
     if (!isAuthenticated) {
@@ -70,6 +72,7 @@ export default class LogtoClient extends BaseClient {
       return {
         isAuthenticated,
         claims,
+        userInfo: conditional(fetchUserInfo && (await this.fetchUserInfo())),
       };
     }
 
@@ -79,6 +82,7 @@ export default class LogtoClient extends BaseClient {
       return {
         isAuthenticated,
         claims: await this.getIdTokenClaims(),
+        userInfo: conditional(fetchUserInfo && (await this.fetchUserInfo())),
         accessToken,
       };
     } catch {
@@ -87,4 +91,5 @@ export default class LogtoClient extends BaseClient {
       };
     }
   };
+  /* eslint-enable complexity */
 }

packages/node/src/types.ts

@@ -1,4 +1,4 @@
-import { IdTokenClaims } from '@logto/client';
+import { IdTokenClaims, UserInfoResponse } from '@logto/client';
 
 declare module 'http' {
   // Honor module definition
@@ -12,4 +12,5 @@ export type LogtoContext = {
   isAuthenticated: boolean;
   claims?: IdTokenClaims;
   accessToken?: string;
+  userInfo?: UserInfoResponse;
 };