auth-backend: added new to legacy sign-in resolvers transform

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-08-08 10:04:59 +02:00
parent 7d29ca8e8c
commit 549dd6db12
3 changed files with 137 additions and 0 deletions
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * 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.
+ */
+
+import {
+  AuthResolverContext,
+  PassportProfile,
+} from '@backstage/plugin-auth-node';
+import { adaptOAuthSignInResolverToLegacy } from './adaptOAuthSignInResolverToLegacy';
+
+describe('adaptOAuthSignInResolverToLegacy', () => {
+  it('should pass through an empty object', () => {
+    const legacyResolvers = adaptOAuthSignInResolverToLegacy({});
+    expect(legacyResolvers).toEqual({});
+
+    // @ts-expect-error
+    legacyResolvers.missing?.();
+  });
+
+  it('should adapt a collection of sign-in resolvers', () => {
+    const resolverA = jest.fn();
+    const resolverB = jest.fn();
+
+    const legacyResolvers = adaptOAuthSignInResolverToLegacy({
+      resolverA,
+      resolverB,
+    });
+
+    const legacyResolverA = legacyResolvers.resolverA();
+    legacyResolverA(
+      {
+        profile: { email: 'em@i.l' },
+        result: {
+          fullProfile: { id: 'id' } as PassportProfile,
+          accessToken: 'token',
+          refreshToken: 'refresh-token',
+          params: {
+            scope: 'sco pe',
+            id_token: 'id-token',
+            expires_in: 3,
+            token_type: 'bear',
+          },
+        },
+      },
+      { ctx: 'ctx' } as unknown as AuthResolverContext,
+    );
+
+    expect(resolverA).toHaveBeenCalledWith(
+      {
+        profile: { email: 'em@i.l' },
+        result: {
+          fullProfile: { id: 'id' } as PassportProfile,
+          session: {
+            accessToken: 'token',
+            expiresInSeconds: 3,
+            scope: 'sco pe',
+            tokenType: 'bear',
+            idToken: 'id-token',
+            refreshToken: 'refresh-token',
+          },
+        },
+      },
+      { ctx: 'ctx' },
+    );
+
+    expect(resolverB).not.toHaveBeenCalled();
+    legacyResolvers.resolverB()({} as any, {} as any);
+    expect(resolverB).toHaveBeenCalled();
+  });
+});
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * 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.
+ */
+
+import {
+  OAuthAuthenticatorResult,
+  PassportProfile,
+  SignInResolver,
+} from '@backstage/plugin-auth-node';
+import { OAuthResult } from '../oauth';
+
+export function adaptOAuthSignInResolverToLegacy<
+  TKeys extends string,
+>(resolvers: {
+  [key in TKeys]: SignInResolver<OAuthAuthenticatorResult<PassportProfile>>;
+}): { [key in TKeys]: () => SignInResolver<OAuthResult> } {
+  const legacyResolvers = {} as {
+    [key in TKeys]: () => SignInResolver<OAuthResult>;
+  };
+  for (const name of Object.keys(resolvers) as TKeys[]) {
+    const resolver = resolvers[name];
+    legacyResolvers[name] = () => async (input, ctx) =>
+      resolver(
+        {
+          profile: input.profile,
+          result: {
+            fullProfile: input.result.fullProfile,
+            session: {
+              accessToken: input.result.accessToken,
+              expiresInSeconds: input.result.params.expires_in,
+              scope: input.result.params.scope,
+              idToken: input.result.params.id_token,
+              tokenType: input.result.params.token_type ?? 'bearer',
+              refreshToken: input.result.refreshToken,
+            },
+          },
+        },
+        ctx,
+      );
+  }
+  return legacyResolvers;
+}
@@ -16,3 +16,4 @@

 export { adaptLegacyOAuthHandler } from './adaptLegacyOAuthHandler';
 export { adoptLegacyOAuthSignInResolver } from './adoptLegacyOAuthSignInResolver';
+export { adaptOAuthSignInResolverToLegacy } from './adaptOAuthSignInResolverToLegacy';