auth-backend: added legacy authHandler transform

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/auth-backend/src/index.ts

@@ -31,6 +31,9 @@ export * from './lib/flow';
 // OAuth wrapper over a passport or a custom `strategy`.
 export * from './lib/oauth';
 
+// Helpers to convert new API in @backstage/plugin-auth-node to old API
+export * from './lib/legacy';
+
 export * from './lib/catalog';
 
 export { getDefaultOwnershipEntityRefs } from './lib/resolvers';

plugins/auth-backend/src/lib/legacy/adaptLegacyOAuthHandler.test.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 } from '@backstage/plugin-auth-node';
+import { AuthHandler } from '../../providers';
+import { OAuthResult } from '../oauth';
+import { PassportProfile } from '../passport/types';
+import { adaptLegacyOAuthHandler } from './adaptLegacyOAuthHandler';
+
+describe('adaptLegacyOAuthHandler', () => {
+  it('should pass through undefined', () => {
+    expect(adaptLegacyOAuthHandler(undefined)).toBeUndefined();
+  });
+
+  it('should convert an old auth handler to a new profile transform', () => {
+    const authHandler: AuthHandler<OAuthResult> = jest.fn();
+    const profileTransform = adaptLegacyOAuthHandler(authHandler);
+
+    profileTransform?.(
+      {
+        fullProfile: { id: 'id' } as PassportProfile,
+        session: {
+          accessToken: 'token',
+          expiresInSeconds: 3,
+          scope: 'sco pe',
+          tokenType: 'bear',
+          idToken: 'id-token',
+          refreshToken: 'refresh-token',
+        },
+      },
+      { ctx: 'ctx' } as unknown as AuthResolverContext,
+    );
+
+    expect(authHandler).toHaveBeenCalledWith(
+      {
+        fullProfile: { id: 'id' },
+        accessToken: 'token',
+        params: {
+          scope: 'sco pe',
+          id_token: 'id-token',
+          expires_in: 3,
+          token_type: 'bear',
+        },
+      },
+      { ctx: 'ctx' },
+    );
+  });
+});

plugins/auth-backend/src/lib/legacy/adaptLegacyOAuthHandler.ts

@@ -0,0 +1,46 @@
+/*
+ * 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,
+  ProfileTransform,
+} from '@backstage/plugin-auth-node';
+import { AuthHandler } from '../../providers';
+import { OAuthResult } from '../oauth';
+import { PassportProfile } from '../passport/types';
+
+/** @public */
+export function adaptLegacyOAuthHandler(
+  authHandler?: AuthHandler<OAuthResult>,
+): ProfileTransform<OAuthAuthenticatorResult<PassportProfile>> | undefined {
+  return (
+    authHandler &&
+    (async (result, ctx) =>
+      authHandler(
+        {
+          fullProfile: result.fullProfile,
+          accessToken: result.session.accessToken,
+          params: {
+            scope: result.session.scope,
+            id_token: result.session.idToken,
+            token_type: result.session.tokenType,
+            expires_in: result.session.expiresInSeconds,
+          },
+        },
+        ctx,
+      ))
+  );
+}

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

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export { adaptLegacyOAuthHandler } from './adaptLegacyOAuthHandler';