From a479e76604d4ab74bb854713975ce584e3c0c08c Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 12 Apr 2022 10:43:43 +0200 Subject: [PATCH] auth-backend: rename all built-in resolvers Signed-off-by: Patrik Oldsberg --- .changeset/loud-bags-run.md | 3 ++- packages/backend/src/plugins/auth.ts | 14 +++++++++----- plugins/auth-backend/api-report.md | 16 ++++++++-------- .../src/providers/bitbucket/provider.ts | 12 ++++++------ .../src/providers/github/provider.test.ts | 2 +- .../src/providers/github/provider.ts | 2 +- .../src/providers/google/provider.ts | 8 ++++---- .../src/providers/microsoft/provider.ts | 6 +++--- .../auth-backend/src/providers/okta/provider.ts | 7 ++++--- .../auth-backend/src/providers/saml/provider.ts | 7 ++++--- 10 files changed, 42 insertions(+), 35 deletions(-) diff --git a/.changeset/loud-bags-run.md b/.changeset/loud-bags-run.md index 7d8bb18be0..24d9c7d288 100644 --- a/.changeset/loud-bags-run.md +++ b/.changeset/loud-bags-run.md @@ -53,7 +53,8 @@ export default async function createPlugin( ...defaultAuthProviderFactories, google: providers.google.create({ signIn: { - resolver: providers.google.resolvers.lookupEmailAnnotation(), + resolver: + providers.google.resolvers.emailMatchingUserEntityAnnotation(), }, }), }, diff --git a/packages/backend/src/plugins/auth.ts b/packages/backend/src/plugins/auth.ts index 4b7348225b..8a60b4b4bd 100644 --- a/packages/backend/src/plugins/auth.ts +++ b/packages/backend/src/plugins/auth.ts @@ -40,7 +40,7 @@ export default async function createPlugin( // It is here for demo purposes only. github: providers.github.create({ signIn: { - resolver: providers.github.resolvers.byUsername(), + resolver: providers.github.resolvers.usernameMatchingUserEntityName(), }, }), gitlab: providers.gitlab.create({ @@ -56,22 +56,26 @@ export default async function createPlugin( }), microsoft: providers.microsoft.create({ signIn: { - resolver: providers.microsoft.resolvers.lookupEmailAnnotation(), + resolver: + providers.microsoft.resolvers.emailMatchingUserEntityAnnotation(), }, }), google: providers.google.create({ signIn: { - resolver: providers.google.resolvers.byEmailLocalPart(), + resolver: + providers.google.resolvers.emailLocalPartMatchingUserEntityName(), }, }), okta: providers.okta.create({ signIn: { - resolver: providers.okta.resolvers.lookupEmailAnnotation(), + resolver: + providers.okta.resolvers.emailMatchingUserEntityAnnotation(), }, }), bitbucket: providers.bitbucket.create({ signIn: { - resolver: providers.bitbucket.resolvers.lookupUsernameAnnotation(), + resolver: + providers.bitbucket.resolvers.usernameMatchingUserEntityAnnotation(), }, }), onelogin: providers.onelogin.create({ diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md index fb5f8ce86d..a01a309dd4 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.md @@ -811,8 +811,8 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - lookupUsernameAnnotation(): SignInResolver; - lookupUserIdAnnotation(): SignInResolver; + usernameMatchingUserEntityAnnotation(): SignInResolver; + userIdMatchingUserEntityAnnotation(): SignInResolver; }>; }>; gcpIap: Readonly<{ @@ -839,7 +839,7 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - byUsername: () => SignInResolver; + usernameMatchingUserEntityName: () => SignInResolver; }>; }>; gitlab: Readonly<{ @@ -871,8 +871,8 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - byEmailLocalPart: () => SignInResolver; - lookupEmailAnnotation(): SignInResolver; + emailLocalPartMatchingUserEntityName: () => SignInResolver; + emailMatchingUserEntityAnnotation(): SignInResolver; }>; }>; microsoft: Readonly<{ @@ -889,7 +889,7 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - lookupEmailAnnotation(): SignInResolver; + emailMatchingUserEntityAnnotation(): SignInResolver; }>; }>; oauth2: Readonly<{ @@ -945,7 +945,7 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - lookupEmailAnnotation(): SignInResolver; + emailMatchingUserEntityAnnotation(): SignInResolver; }>; }>; onelogin: Readonly<{ @@ -977,7 +977,7 @@ export const providers: Readonly<{ | undefined, ) => AuthProviderFactory; resolvers: Readonly<{ - byNameId(): SignInResolver; + nameIdMatchingUserEntityName(): SignInResolver; }>; }>; }>; diff --git a/plugins/auth-backend/src/providers/bitbucket/provider.ts b/plugins/auth-backend/src/providers/bitbucket/provider.ts index c26c501666..b149aa6d28 100644 --- a/plugins/auth-backend/src/providers/bitbucket/provider.ts +++ b/plugins/auth-backend/src/providers/bitbucket/provider.ts @@ -273,7 +273,7 @@ export const bitbucket = createAuthProviderIntegration({ /** * Looks up the user by matching their username to the `bitbucket.org/username` annotation. */ - lookupUsernameAnnotation(): SignInResolver { + usernameMatchingUserEntityAnnotation(): SignInResolver { return async (info, ctx) => { const { result } = info; @@ -291,7 +291,7 @@ export const bitbucket = createAuthProviderIntegration({ /** * Looks up the user by matching their user ID to the `bitbucket.org/user-id` annotation. */ - lookupUserIdAnnotation(): SignInResolver { + userIdMatchingUserEntityAnnotation(): SignInResolver { return async (info, ctx) => { const { result } = info; @@ -317,14 +317,14 @@ export const createBitbucketProvider = bitbucket.create; /** * @public - * @deprecated Use `providers.bitbucket.resolvers.lookupUsernameAnnotation()` instead. + * @deprecated Use `providers.bitbucket.resolvers.usernameMatchingUserEntityAnnotation()` instead. */ export const bitbucketUsernameSignInResolver = - bitbucket.resolvers.lookupUsernameAnnotation(); + bitbucket.resolvers.usernameMatchingUserEntityAnnotation(); /** * @public - * @deprecated Use `providers.bitbucket.resolvers.lookupUserIdAnnotation()` instead. + * @deprecated Use `providers.bitbucket.resolvers.userIdMatchingUserEntityAnnotation()` instead. */ export const bitbucketUserIdSignInResolver = - bitbucket.resolvers.lookupUserIdAnnotation(); + bitbucket.resolvers.userIdMatchingUserEntityAnnotation(); diff --git a/plugins/auth-backend/src/providers/github/provider.test.ts b/plugins/auth-backend/src/providers/github/provider.test.ts index 5cd605dcfe..18690a986b 100644 --- a/plugins/auth-backend/src/providers/github/provider.test.ts +++ b/plugins/auth-backend/src/providers/github/provider.test.ts @@ -38,7 +38,7 @@ describe('GithubAuthProvider', () => { token: `token-for-user:${entityRef.name}`, })), } as unknown as AuthResolverContext, - signInResolver: github.resolvers.byUsername(), + signInResolver: github.resolvers.usernameMatchingUserEntityName(), authHandler: async ({ fullProfile }) => ({ profile: makeProfileInfo(fullProfile), }), diff --git a/plugins/auth-backend/src/providers/github/provider.ts b/plugins/auth-backend/src/providers/github/provider.ts index 9cc3a32b90..e018a6cf99 100644 --- a/plugins/auth-backend/src/providers/github/provider.ts +++ b/plugins/auth-backend/src/providers/github/provider.ts @@ -367,7 +367,7 @@ export const github = createAuthProviderIntegration({ /** * Looks up the user by matching their GitHub username to the entity name. */ - byUsername: (): SignInResolver => { + usernameMatchingUserEntityName: (): SignInResolver => { return async (info, ctx) => { const { fullProfile } = info.result; diff --git a/plugins/auth-backend/src/providers/google/provider.ts b/plugins/auth-backend/src/providers/google/provider.ts index 277c3144b0..68925e7817 100644 --- a/plugins/auth-backend/src/providers/google/provider.ts +++ b/plugins/auth-backend/src/providers/google/provider.ts @@ -247,11 +247,11 @@ export const google = createAuthProviderIntegration({ /** * Looks up the user by matching their email local part to the entity name. */ - byEmailLocalPart: () => commonByEmailLocalPartResolver, + emailLocalPartMatchingUserEntityName: () => commonByEmailLocalPartResolver, /** * Looks up the user by matching their email to the `google.com/email` annotation. */ - lookupEmailAnnotation(): SignInResolver { + emailMatchingUserEntityAnnotation(): SignInResolver { return async (info, ctx) => { const { profile } = info; @@ -277,7 +277,7 @@ export const createGoogleProvider = google.create; /** * @public - * @deprecated Use `providers.google.resolvers.lookupEmailAnnotation()` instead. + * @deprecated Use `providers.google.resolvers.emailMatchingUserEntityAnnotation()` instead. */ export const googleEmailSignInResolver = - google.resolvers.lookupEmailAnnotation(); + google.resolvers.emailMatchingUserEntityAnnotation(); diff --git a/plugins/auth-backend/src/providers/microsoft/provider.ts b/plugins/auth-backend/src/providers/microsoft/provider.ts index bbd17944ee..5b3e80e679 100644 --- a/plugins/auth-backend/src/providers/microsoft/provider.ts +++ b/plugins/auth-backend/src/providers/microsoft/provider.ts @@ -273,7 +273,7 @@ export const microsoft = createAuthProviderIntegration({ /** * Looks up the user by matching their email to the `microsoft.com/email` annotation. */ - lookupEmailAnnotation(): SignInResolver { + emailMatchingUserEntityAnnotation(): SignInResolver { return async (info, ctx) => { const { profile } = info; @@ -299,7 +299,7 @@ export const createMicrosoftProvider = microsoft.create; /** * @public - * @deprecated Use `providers.microsoft.resolvers.lookupEmailAnnotation()` instead. + * @deprecated Use `providers.microsoft.resolvers.emailMatchingUserEntityAnnotation()` instead. */ export const microsoftEmailSignInResolver = - microsoft.resolvers.lookupEmailAnnotation(); + microsoft.resolvers.emailMatchingUserEntityAnnotation(); diff --git a/plugins/auth-backend/src/providers/okta/provider.ts b/plugins/auth-backend/src/providers/okta/provider.ts index 471052b832..b83e640731 100644 --- a/plugins/auth-backend/src/providers/okta/provider.ts +++ b/plugins/auth-backend/src/providers/okta/provider.ts @@ -277,7 +277,7 @@ export const okta = createAuthProviderIntegration({ /** * Looks up the user by matching their email to the `okta.com/email` annotation. */ - lookupEmailAnnotation(): SignInResolver { + emailMatchingUserEntityAnnotation(): SignInResolver { return async (info, ctx) => { const { profile } = info; @@ -303,6 +303,7 @@ export const createOktaProvider = okta.create; /** * @public - * @deprecated Use `providers.okta.resolvers.lookupEmailAnnotation()` instead. + * @deprecated Use `providers.okta.resolvers.emailMatchingUserEntityAnnotation()` instead. */ -export const oktaEmailSignInResolver = okta.resolvers.lookupEmailAnnotation(); +export const oktaEmailSignInResolver = + okta.resolvers.emailMatchingUserEntityAnnotation(); diff --git a/plugins/auth-backend/src/providers/saml/provider.ts b/plugins/auth-backend/src/providers/saml/provider.ts index 597dd24687..4f5076b410 100644 --- a/plugins/auth-backend/src/providers/saml/provider.ts +++ b/plugins/auth-backend/src/providers/saml/provider.ts @@ -215,7 +215,7 @@ export const saml = createAuthProviderIntegration({ /** * Looks up the user by matching their nameID to the entity name. */ - byNameId(): SignInResolver { + nameIdMatchingUserEntityName(): SignInResolver { return async (info, ctx) => { const id = info.result.fullProfile.nameID; @@ -239,6 +239,7 @@ export const createSamlProvider = saml.create; /** * @public - * @deprecated Use `providers.saml.resolvers.byNameId()` instead. + * @deprecated Use `providers.saml.resolvers.nameIdMatchingUserEntityName()` instead. */ -export const samlNameIdEntityNameSignInResolver = saml.resolvers.byNameId(); +export const samlNameIdEntityNameSignInResolver = + saml.resolvers.nameIdMatchingUserEntityName();