move away from deprecated types, import from auth-node

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
backstage · Feb 16, 2024 · f5e04e3 · f5e04e3
1 parent a5e494c
commit f5e04e3
Show file tree

Hide file tree

Showing 37 changed files with 166 additions and 133 deletions.
diff --git a/.changeset/smart-frogs-help.md b/.changeset/smart-frogs-help.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-auth-backend': patch
+---
+
+Internal refactor to no longer use deprecated types
diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md
diff --git a/plugins/auth-backend/src/identity/StaticTokenIssuer.ts b/plugins/auth-backend/src/identity/StaticTokenIssuer.ts
@@ -13,12 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AnyJWK, TokenIssuer, TokenParams } from './types';
+
+import { AnyJWK, TokenIssuer } from './types';
 import { SignJWT, importJWK, JWK } from 'jose';
 import { parseEntityRef } from '@backstage/catalog-model';
 import { AuthenticationError } from '@backstage/errors';
 import { LoggerService } from '@backstage/backend-plugin-api';
 import { StaticKeyStore } from './StaticKeyStore';
+import { TokenParams } from '@backstage/plugin-auth-node';
 
 const MS_IN_S = 1000;
 

diff --git a/plugins/auth-backend/src/identity/TokenFactory.ts b/plugins/auth-backend/src/identity/TokenFactory.ts
@@ -13,14 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import { parseEntityRef } from '@backstage/catalog-model';
 import { AuthenticationError } from '@backstage/errors';
 import { exportJWK, generateKeyPair, importJWK, JWK, SignJWT } from 'jose';
 import { DateTime } from 'luxon';
 import { v4 as uuid } from 'uuid';
 import { LoggerService } from '@backstage/backend-plugin-api';
-
-import { AnyJWK, KeyStore, TokenIssuer, TokenParams } from './types';
+import { TokenParams } from '@backstage/plugin-auth-node';
+import { AnyJWK, KeyStore, TokenIssuer } from './types';
 
 const MS_IN_S = 1000;
 const MAX_TOKEN_LENGTH = 32768; // At 64 bytes per entity ref this still leaves room for about 500 entities

diff --git a/plugins/auth-backend/src/identity/types.ts b/plugins/auth-backend/src/identity/types.ts
@@ -37,7 +37,7 @@ export type TokenIssuer = {
   /**
    * Issues a new ID Token
    */
-  issueToken(params: TokenParams): Promise<string>;
+  issueToken(params: _TokenParams): Promise<string>;
 
   /**
    * List all public keys that are currently being used to sign tokens, or have been used

diff --git a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts
@@ -17,8 +17,8 @@
 import express from 'express';
 import { THOUSAND_DAYS_MS, TEN_MINUTES_MS, OAuthAdapter } from './OAuthAdapter';
 import { encodeState } from './helpers';
-import { OAuthHandlers, OAuthLogoutRequest, OAuthState } from './types';
-import { CookieConfigurer } from '../../providers/types';
+import { OAuthHandlers, OAuthLogoutRequest } from './types';
+import { CookieConfigurer, OAuthState } from '@backstage/plugin-auth-node';
 
 const mockResponseData = {
   providerInfo: {

diff --git a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts
@@ -18,14 +18,13 @@ import express, { CookieOptions } from 'express';
 import crypto from 'crypto';
 import { URL } from 'url';
 import {
+  AuthProviderConfig,
+  AuthProviderRouteHandlers,
   BackstageIdentityResponse,
   BackstageSignInResult,
-} from '@backstage/plugin-auth-node';
-import {
-  AuthProviderRouteHandlers,
-  AuthProviderConfig,
   CookieConfigurer,
-} from '../../providers/types';
+  OAuthState,
+} from '@backstage/plugin-auth-node';
 import {
   AuthenticationError,
   InputError,
@@ -42,7 +41,6 @@ import {
   OAuthHandlers,
   OAuthStartRequest,
   OAuthRefreshRequest,
-  OAuthState,
   OAuthLogoutRequest,
 } from './types';
 import { prepareBackstageIdentityResponse } from '../../providers/prepareBackstageIdentityResponse';

diff --git a/plugins/auth-backend/src/lib/oauth/helpers.ts b/plugins/auth-backend/src/lib/oauth/helpers.ts
@@ -15,9 +15,9 @@
  */
 
 import express from 'express';
-import { OAuthState } from './types';
-import { CookieConfigurer } from '../../providers/types';
 import {
+  CookieConfigurer,
+  OAuthState,
   decodeOAuthState,
   encodeOAuthState,
 } from '@backstage/plugin-auth-node';

diff --git a/plugins/auth-backend/src/lib/oauth/types.ts b/plugins/auth-backend/src/lib/oauth/types.ts
@@ -18,9 +18,10 @@ import express from 'express';
 import { Profile as PassportProfile } from 'passport';
 import {
   BackstageSignInResult,
+  ProfileInfo,
   OAuthState as _OAuthState,
 } from '@backstage/plugin-auth-node';
-import { OAuthStartResponse, ProfileInfo } from '../../providers/types';
+import { OAuthStartResponse } from '../../providers/types';
 
 /**
  * Common options for passport.js-based OAuth providers