Question about handleIncomingRedirect

Greetings · April 11, 2022, 11:53am

Hello, I was going through the solid-client-authn-browser API.
And in the description of handleIncomingRedirect function, the types that this function accepts as inputOptions are: string | IHandleIncomingRedirectOptions. So I have two questions:

What happens with the input options passed
What is this IHandleIncomingRedirectOptions, where can I find some info about it?
I guess that things like:
restorePreviousSession: true
useEssSession: false

Would be of this type, but I want to find some more info.
Thank you in advance

aveltens · April 11, 2022, 4:16pm

Hi,

here is the part in the inrupt docs about session restore:

https://docs.inrupt.com/developer-tools/javascript/client-libraries/tutorial/restore-session-browser-refresh/?highlight=onsessionrestore#enable-session-restore

Details about IHandleIncomingRedirectOptions can be found directly in the source code (I do not know why those comments are not part of the rendered API docs on the inrupt site):

github.com

inrupt/solid-client-authn-js/blob/39a19d97/packages/browser/src/Session.ts#L58

      
        
              /**
               * Details about the current session
               */
              sessionInfo: ISessionInfo;
              /**
               * An instance of the library core. Typically obtained using `getClientAuthenticationWithDependencies`.
               */
              clientAuthentication: ClientAuthentication;
            }
            
            
export interface IHandleIncomingRedirectOptions {
              /**
               * If the user has signed in before, setting this to `true` will automatically
               * redirect them to their Solid Identity Provider, which will then attempt to
               * re-activate the session and send the user back to your app without
               * requiring user interaction.
               * If your app's access has not expired yet and re-activation completed
               * successfully, a `sessionRestore` event will be fired with the URL the user
               * was at before they were redirected to their Solid Identity Provider.
               * {@see onSessionRestore}
               */

zwifi · April 12, 2022, 12:53pm

@aveltens interesting, thanks for pointing that out! We are currently working on fixing some issues with out API docs, I’m adding this to the list. And also, thanks for your response, which is completely on point.

Just some additional precisions: note that the options may all be omitted, resulting in the current browser location being used as the input URL. And @Greetings you’re right, { restorePreviousSession: true } is typically what you’d pass as an option. When set to true, the library tries to automatically log the user back in after the page has been reloaded or refreshed. The operation succeeds if there is still an active cookie on the Identity Provider.

The useEssSession option has recently been deprecated, and should no longer be used.

Greetings · April 19, 2022, 1:56pm

@aveltens, @zwifi thank you very much for your help, your replies solved my question.

Topic		Replies	Views
How to keep the Session Logged In Build a Solid App	1	414	March 6, 2023
Session restore with solid-client-authn-browser Solid App Development FAQs	4	978	April 7, 2022
isLoggedIn property returning false every time	4	450	February 22, 2021
How to set post_logout_redirect_uris in inrupt's solid_client_auth_browser libraries Solid App Development FAQs	12	380	February 27, 2024
Error: A redirection handler must be provided in the Node environment	4	513	December 29, 2022

Question about handleIncomingRedirect

Related topics