✨(@koex/passport): design a strategy for callback return error

- callback error should not throw, let it be handled by common error
middleware, should design a new method for it
- will face two situations
  - internal code logic error or strategy is not defined (passport.ts
  line 166 - 172)
  - remote provider error when exchange token by code or exchange user
  by token (passport.ts line 174 - 178)

Author: whatwewant

packages/passport/src/passport.ts

@@ -41,6 +41,10 @@ export interface InitializeOptions {
   onUnauthorized(ctx: Context, acceptJSON: boolean): Promise<void>;
 }
 
+export interface CallbackOptions {
+  onFail(error: Error, ctx: Context, next: any): Promise<void>;
+}
+
 export interface LoginOptions {
   render?(ctx: Context): Promise<void>;
   redirect?: string;
@@ -59,7 +63,7 @@ export interface IPassport {
   use(name: string, strategy: Strategy): void;
   initialize(options: InitializeOptions): Middleware<Context>;
   authenticate(): Middleware<Context>;
-  callback(): Middleware<Context>;
+  callback(options: CallbackOptions): Middleware<Context>;
   login(options?: LoginOptions): Middleware<Context>;
   logout(options?: LogoutOptions): Middleware<Context>;
 }
@@ -153,29 +157,33 @@ export class Passport implements IPassport {
     };
   }
 
-  public callback(): Middleware<Context> {
+  public callback(options: CallbackOptions): Middleware<Context> {
     return async (ctx, next) => {
-      const strategyName = ctx.params.strategy; // @TODO
-      const strategy = this.strategies[strategyName];
-
-      if (!strategyName) {
-        ctx.throw(500, `No Passport Strategy Name Provided`);
-      }
-
-      if (!strategy) {
-        ctx.throw(500, `No Passport Strategy provided named ${strategyName}`);
+      try {
+        const strategyName = ctx.params.strategy; // @TODO
+        const strategy = this.strategies[strategyName];
+        
+        if (!strategyName) {
+          ctx.throw(500, `No Passport Strategy Name Provided`, { strategy: strategyName, reasonBy: 'self' });
+        }
+  
+        if (!strategy) {
+          ctx.throw(500, `No Passport Strategy provided named ${strategyName}`, { strategy: strategyName, reasonBy: 'self' });
+        }
+  
+        const profile = await strategy.callback(ctx);
+  
+        this.session.set(strategyName, profile.id);
+  
+        const user = await strategy.getUserByStrategyProfile(ctx, strategyName, profile, Stage.authorize);
+  
+        // readonly, use it instead of ctx.user = user
+        defineReadonlyProperties(ctx, { user });
+  
+        return await next();
+      } catch (error) {
+        return await options.onFail(error, ctx, next);
       }
-
-      const profile = await strategy.callback(ctx);
-
-      this.session.set(strategyName, profile.id);
-
-      const user = await strategy.getUserByStrategyProfile(ctx, strategyName, profile, Stage.authorize);
-
-      // readonly, use it instead of ctx.user = user
-      defineReadonlyProperties(ctx, { user });
-
-      await next();
     };
   }
 

packages/passport/src/use.ts

@@ -159,9 +159,20 @@ export function usePassport(app: App, options: IUsePassport) {
   //  @S1 authenticate flow
   app.get(authenticatePath, passport.authenticate());
   //  @S2 callback flow
-  app.get(callbackPath, passport.callback(), async (ctx: Context) => {
-    await onAuthorized(ctx, _options);
-  });
+  app.get(
+    callbackPath,
+    passport.callback({
+      async onFail(error: any, ctx) {
+        // @TODO log erro
+        console.error('oauth callback error: ', error);
+        // @TODO send error to login page, should only once, login page should remove error
+        return ctx.redirect(`${loginPath}?error=${error.strategy}授权失败(来源: ${error.reasonBy})`);
+      },
+    }),
+    async (ctx: Context) => {
+      await onAuthorized(ctx, _options);
+    },
+  );
 
   // passport login url, you can act redirect or render page
   app.get(loginPath, passport.login({