feat: support Bitbucket Server/Data Center self-hosted instances

Ref #2

Author: Linkid

DOCUMENTATION.md

@@ -183,6 +183,8 @@ skips an instance until its permission is granted.
 Supported self-hosted software:
 - **GitLab** (CE/EE): https://docs.gitlab.com/ee/api/merge_requests.html
 - **Forgejo / Gitea**: https://forgejo.org/docs/latest/user/api-usage/
+- **Bitbucket Server / Data Center**: https://developer.atlassian.com/server/bitbucket/rest/latest/
+  (self-hosted only — a different API from Bitbucket Cloud)
 
 To support new self-hosted software, define its family and add it to
 `selfHostedFamilies`.

README.md

@@ -25,5 +25,5 @@ API rate limit and list pull requests from private repositories.
 - Bitbucket
 - Codeberg
 - GitLab
-- self-hosted GitLab (CE/EE) and Forgejo/Gitea instances (add them in the
-  extension's options)
+- self-hosted instances (GitLab CE/EE, Forgejo/Gitea, Bitbucket Server/Data
+  Center) — add them in the extension's options

forges.js

@@ -277,6 +277,67 @@ export const gitlab = instanceOf(gitlabFamily, {
     tokenStorageKey: "gitlabToken",
 })
 
+// Bitbucket Data Center / Server family: self-hosted only — Bitbucket Cloud
+// (the `bitbucket` adapter above) is a separate product with a different API.
+// Serves its REST API under /rest/api/latest and paginates in a `values` array.
+// API docs: https://developer.atlassian.com/server/bitbucket/rest/latest/
+const bitbucketServerFamily = {
+    label: "Bitbucket Server / Data Center",
+    apiPath: "/rest/api/latest",
+
+    parseUrl(url) {
+        // file view, project repo:  /projects/{projectKey}/repos/{repoSlug}/browse/{filepath}
+        // file view, personal repo: /users/{userSlug}/repos/{repoSlug}/browse/{filepath}
+        // (the branch/tag ref lives in the ?at= query, so filepath stays clean)
+        const m = url.pathname.match(
+            "^/(?<section>projects|users)/(?<owner>[^/]+)/repos/(?<repoSlug>[^/]+)/browse/(?<filepath>.+)$")
+        if (!m) return null
+        const { section, owner, repoSlug, filepath } = m.groups
+        // the API addresses a personal repo as the ~{userSlug} project
+        const projectKey = section === "users" ? `~${owner}` : owner
+        return { projectKey, repoSlug, filepath, origin: url.origin }
+    },
+
+    listPRsUrl(info) {
+        // the pull-requests endpoint defaults to OPEN, but be explicit
+        return `${this.base_url}/projects/${info.projectKey}/repos/${info.repoSlug}/pull-requests?state=OPEN`
+    },
+
+    // the list endpoint wraps the PRs in a paginated envelope
+    pullRequests(data) {
+        return data.values
+    },
+
+    filesUrl(info, pr) {
+        return `${this.base_url}/projects/${info.projectKey}/repos/${info.repoSlug}/pull-requests/${this.prNumber(pr)}/changes`
+    },
+
+    // each change carries the file path as `path.toString`
+    filenames(changes) {
+        return changes.values.map(change => change.path.toString)
+    },
+
+    prNumber(pr) {
+        return pr.id
+    },
+
+    prWebUrl(info, prNumber) {
+        // a personal repo (project key ~{userSlug}) lives under /users/{userSlug}
+        const repoPath = info.projectKey.startsWith("~")
+            ? `users/${info.projectKey.slice(1)}/repos/${info.repoSlug}`
+            : `projects/${info.projectKey}/repos/${info.repoSlug}`
+        return `${info.origin}/${repoPath}/pull-requests/${prNumber}`
+    },
+
+    // Bitbucket Server exposes no simple rate-limit endpoint.
+    rateLimit: null,
+
+    // Bitbucket Server accepts an HTTP access token as a Bearer credential.
+    authHeader(token) {
+        return { Authorization: `Bearer ${token}` }
+    },
+}
+
 // registry of forges matched by a static hostname
 const staticForges = [github, bitbucket, codeberg, gitlab]
 
@@ -299,6 +360,7 @@ export function authForges() {
 const selfHostedFamilies = {
     gitlab: gitlabFamily,
     forgejo: forgejoFamily,
+    "bitbucket-server": bitbucketServerFamily,
 }
 
 // software types selectable when adding a self-hosted instance, for the options

tests/forges.test.js

@@ -343,6 +343,7 @@ test("selfHostedTypes lists the supported software with labels", () => {
     assert.deepEqual(selfHostedTypes(), [
         { type: "gitlab", label: "GitLab" },
         { type: "forgejo", label: "Forgejo / Gitea" },
+        { type: "bitbucket-server", label: "Bitbucket Server / Data Center" },
     ])
 })
 
@@ -383,6 +384,69 @@ test("buildSelfHostedForge builds a Forgejo instance adapter reusing the codeber
     assert.deepEqual(forge.authHeader("cb_secret"), { Authorization: "token cb_secret" })
 })
 
+test("buildSelfHostedForge builds a Bitbucket Server instance adapter", () => {
+    const forge = buildSelfHostedForge({ type: "bitbucket-server", hostname: "bitbucket.example.com" })
+
+    assert.equal(forge.base_url, "https://bitbucket.example.com/rest/api/latest")
+    assert.equal(forge.selfHosted, true)
+
+    const info = { projectKey: "PRJ", repoSlug: "widget", origin: "https://bitbucket.example.com" }
+    assert.equal(
+        forge.listPRsUrl(info),
+        "https://bitbucket.example.com/rest/api/latest/projects/PRJ/repos/widget/pull-requests?state=OPEN")
+    assert.equal(
+        forge.filesUrl(info, { id: 7 }),
+        "https://bitbucket.example.com/rest/api/latest/projects/PRJ/repos/widget/pull-requests/7/changes")
+    assert.equal(
+        forge.prWebUrl(info, 7),
+        "https://bitbucket.example.com/projects/PRJ/repos/widget/pull-requests/7")
+    assert.equal(forge.prNumber({ id: 7 }), 7)
+    assert.deepEqual(forge.authHeader("bbs_secret"), { Authorization: "Bearer bbs_secret" })
+})
+
+test("bitbucket-server parseUrl extracts project, repo and filepath from a browse URL", () => {
+    const forge = buildSelfHostedForge({ type: "bitbucket-server", hostname: "bitbucket.example.com" })
+    const url = new URL("https://bitbucket.example.com/projects/PRJ/repos/widget/browse/src/app.js?at=refs%2Fheads%2Fmain")
+    assert.deepEqual(forge.parseUrl(url), {
+        projectKey: "PRJ",
+        repoSlug: "widget",
+        filepath: "src/app.js",
+        origin: "https://bitbucket.example.com",
+    })
+})
+
+test("bitbucket-server parseUrl maps a personal repo browse URL to the ~userSlug project", () => {
+    const forge = buildSelfHostedForge({ type: "bitbucket-server", hostname: "bitbucket.example.com" })
+    const url = new URL("https://bitbucket.example.com/users/jdoe/repos/widget/browse/dir/app.js?at=refs%2Fheads%2Fmain")
+    assert.deepEqual(forge.parseUrl(url), {
+        projectKey: "~jdoe",
+        repoSlug: "widget",
+        filepath: "dir/app.js",
+        origin: "https://bitbucket.example.com",
+    })
+})
+
+test("bitbucket-server addresses a personal repo as ~userSlug in the API but /users on the web", () => {
+    const forge = buildSelfHostedForge({ type: "bitbucket-server", hostname: "bitbucket.example.com" })
+    const info = { projectKey: "~jdoe", repoSlug: "widget", origin: "https://bitbucket.example.com" }
+    assert.equal(
+        forge.listPRsUrl(info),
+        "https://bitbucket.example.com/rest/api/latest/projects/~jdoe/repos/widget/pull-requests?state=OPEN")
+    assert.equal(
+        forge.prWebUrl(info, 7),
+        "https://bitbucket.example.com/users/jdoe/repos/widget/pull-requests/7")
+})
+
+test("bitbucket-server pullRequests and filenames unwrap the paginated envelopes", () => {
+    const forge = buildSelfHostedForge({ type: "bitbucket-server", hostname: "bitbucket.example.com" })
+    assert.deepEqual(forge.pullRequests({ values: [{ id: 1 }, { id: 2 }] }), [{ id: 1 }, { id: 2 }])
+    const changes = { values: [
+        { path: { toString: "a.js" } },
+        { path: { toString: "dir/b.js" } },
+    ] }
+    assert.deepEqual(forge.filenames(changes), ["a.js", "dir/b.js"])
+})
+
 test("the public instance and a self-hosted instance share one family", () => {
     // the inversion: gitlab.com is itself an instanceOf the GitLab family, the
     // same family a self-hosted GitLab is built from, so they share a prototype