auth-backend: move passport helpers into separate lib

plugins/auth-backend/src/lib/oauth/types.ts

@@ -15,8 +15,7 @@
  */
 
 import express from 'express';
-import { AuthResponse } from '../../providers/types';
-import { RedirectInfo } from '../PassportStrategyHelper';
+import { AuthResponse, RedirectInfo } from '../../providers/types';
 
 /**
  * Common options for passport.js-based OAuth providers

plugins/auth-backend/src/lib/passport/PassportStrategyHelper.ts

@@ -17,7 +17,7 @@
 import express from 'express';
 import passport from 'passport';
 import jwtDecoder from 'jwt-decode';
-import { ProfileInfo } from '../providers/types';
+import { ProfileInfo, RedirectInfo } from '../../providers/types';
 
 export type PassportDoneCallback<Res, Private = never> = (
   err?: Error,
@@ -64,17 +64,6 @@ export const makeProfileInfo = (
   };
 };
 
-export type RedirectInfo = {
-  /**
-   * URL to redirect to
-   */
-  url: string;
-  /**
-   * Status code to use for the redirect
-   */
-  status?: number;
-};
-
 export const executeRedirectStrategy = async (
   req: express.Request,
   providerStrategy: passport.Strategy,

plugins/auth-backend/src/lib/passport/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export {
+  executeFetchUserProfileStrategy,
+  executeFrameHandlerStrategy,
+  executeRedirectStrategy,
+  executeRefreshTokenStrategy,
+  makeProfileInfo,
+} from './PassportStrategyHelper';
+export type { PassportDoneCallback } from './PassportStrategyHelper';

plugins/auth-backend/src/providers/auth0/provider.ts

@@ -32,9 +32,8 @@ import {
   executeRefreshTokenStrategy,
   makeProfileInfo,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import { Config } from '@backstage/config';
 
 type PrivateInfo = {

plugins/auth-backend/src/providers/github/provider.ts

@@ -21,9 +21,8 @@ import {
   executeRedirectStrategy,
   makeProfileInfo,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import {
   OAuthProvider,
   OAuthProviderOptions,

plugins/auth-backend/src/providers/gitlab/provider.ts

@@ -21,9 +21,8 @@ import {
   executeRedirectStrategy,
   makeProfileInfo,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import {
   OAuthProvider,
   OAuthProviderOptions,

plugins/auth-backend/src/providers/google/provider.ts

@@ -23,9 +23,8 @@ import {
   makeProfileInfo,
   executeFetchUserProfileStrategy,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import {
   OAuthProvider,
   OAuthProviderHandlers,

plugins/auth-backend/src/providers/microsoft/provider.ts

@@ -25,10 +25,9 @@ import {
   makeProfileInfo,
   executeFetchUserProfileStrategy,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
+} from '../../lib/passport';
 
-import { AuthProviderConfig } from '../types';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 
 import {
   OAuthProvider,

plugins/auth-backend/src/providers/oauth2/provider.ts

@@ -32,9 +32,8 @@ import {
   executeRefreshTokenStrategy,
   makeProfileInfo,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import { Config } from '@backstage/config';
 
 type PrivateInfo = {

plugins/auth-backend/src/providers/okta/provider.ts

@@ -29,9 +29,8 @@ import {
   makeProfileInfo,
   executeFetchUserProfileStrategy,
   PassportDoneCallback,
-  RedirectInfo,
-} from '../../lib/PassportStrategyHelper';
-import { AuthProviderConfig } from '../types';
+} from '../../lib/passport';
+import { AuthProviderConfig, RedirectInfo } from '../types';
 import { Logger } from 'winston';
 import { StateStore } from 'passport-oauth2';
 import { TokenIssuer } from '../../identity';

plugins/auth-backend/src/providers/saml/provider.ts

@@ -24,7 +24,7 @@ import {
   executeFrameHandlerStrategy,
   executeRedirectStrategy,
   PassportDoneCallback,
-} from '../../lib/PassportStrategyHelper';
+} from '../../lib/passport';
 import {
   AuthProviderConfig,
   AuthProviderRouteHandlers,

plugins/auth-backend/src/providers/types.ts

@@ -32,6 +32,17 @@ export type AuthProviderConfig = {
   appUrl: string;
 };
 
+export type RedirectInfo = {
+  /**
+   * URL to redirect to
+   */
+  url: string;
+  /**
+   * Status code to use for the redirect
+   */
+  status?: number;
+};
+
 /**
  * Any Auth provider needs to implement this interface which handles the routes in the
  * auth backend. Any auth API requests from the frontend reaches these methods.