feat(providers): support custom baseURL for Gitlab (#13260)

Co-authored-by: Alex Yang <[email protected]>

Author: Tobix99

docs/pages/getting-started/providers/gitlab.mdx

@@ -54,7 +54,14 @@ import NextAuth from "next-auth"
 import GitLab from "next-auth/providers/gitlab"
 
 export const { handlers, auth, signIn, signOut } = NextAuth({
-  providers: [GitLab],
+  providers: [
+    // Default (gitlab.com)
+    GitLab,
+    // Self-hosted example
+    GitLab({
+      baseUrl: "https://gitlab.example.com",
+    }),
+  ],
 })
 ```
 
@@ -67,7 +74,14 @@ import GitLab from "@auth/qwik/providers/gitlab"
 
 export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$(
   () => ({
-    providers: [GitLab],
+    providers: [
+      GitLab,
+      GitLab({
+        instance: {
+          baseUrl: "https://gitlab.example.com"
+        }
+      })
+    ],
   })
 )
 ```
@@ -80,7 +94,12 @@ import { SvelteKitAuth } from "@auth/sveltekit"
 import GitLab from "@auth/sveltekit/providers/gitlab"
 
 export const { handle, signIn, signOut } = SvelteKitAuth({
-  providers: [GitLab],
+  providers: [
+    GitLab,
+    GitLab({
+      baseUrl: "https://gitlab.example.com",
+    }),
+  ],
 })
 ```
 
@@ -91,7 +110,17 @@ export const { handle, signIn, signOut } = SvelteKitAuth({
 import { ExpressAuth } from "@auth/express"
 import GitLab from "@auth/express/providers/gitlab"
 
-app.use("/auth/*", ExpressAuth({ providers: [GitLab] }))
+app.use(
+  "/auth/*",
+  ExpressAuth({
+    providers: [
+      GitLab,
+      GitLab({
+        baseUrl: "https://gitlab.example.com",
+      }),
+    ],
+  })
+)
 ```
 
   </Code.Express>

packages/core/src/providers/gitlab.ts

@@ -109,18 +109,26 @@ export interface GitLabProfile extends Record<string, any> {
  * :::
  */
 export default function GitLab<P extends GitLabProfile>(
-  options: OAuthUserConfig<P>
+  options: OAuthUserConfig<P> & {
+    /**
+     * @default "https://gitlab.com"
+     */
+    baseUrl?: URL | string
+  }
 ): OAuthConfig<P> {
+  const baseUrl = options.baseUrl ?? "https://gitlab.com"
+  const url = new URL(baseUrl.toString())
+
   return {
     id: "gitlab",
     name: "GitLab",
     type: "oauth",
-    authorization: "https://gitlab.com/oauth/authorize?scope=read_user",
-    token: "https://gitlab.com/oauth/token",
-    userinfo: "https://gitlab.com/api/v4/user",
+    authorization: `${url}oauth/authorize?scope=read_user`,
+    token: `${url}oauth/token`,
+    userinfo: `${url}api/v4/user`,
     profile(profile) {
       return {
-        id: profile.sub?.toString(),
+        id: profile.sub?.toString() ?? profile.id?.toString(),
         name: profile.name ?? profile.username,
         email: profile.email,
         image: profile.avatar_url,

packages/core/test/providers/gitlab.test.ts

@@ -0,0 +1,16 @@
+import { expect, it } from "vitest"
+import GitLab from "../../src/providers/gitlab"
+
+it("GitLab should handle baseURL correctly", () => {
+  const config = GitLab({
+    baseUrl: "https://gitlab.example.com",
+  })
+  expect(config.id).toBe("gitlab")
+  expect(config.name).toBe("GitLab")
+  expect(config.type).toBe("oauth")
+  expect(config.authorization).toEqual(
+    "https://gitlab.example.com/oauth/authorize?scope=read_user"
+  )
+  expect(config.token).toEqual("https://gitlab.example.com/oauth/token")
+  expect(config.userinfo).toEqual("https://gitlab.example.com/api/v4/user")
+})