Implement readTree on BitBucketUrlReader - Implement getBitbucketDownloadUrl and remove hash for Bitbucket Server

packages/integration/src/bitbucket/core.test.ts

@@ -15,7 +15,11 @@
  */
 
 import { BitbucketIntegrationConfig } from './config';
-import { getBitbucketFileFetchUrl, getBitbucketRequestOptions } from './core';
+import {
+  getBitbucketDownloadUrl,
+  getBitbucketFileFetchUrl,
+  getBitbucketRequestOptions,
+} from './core';
 
 describe('bitbucket core', () => {
   describe('getBitbucketRequestOptions', () => {
@@ -97,4 +101,48 @@ describe('bitbucket core', () => {
       );
     });
   });
+
+  describe('getBitbucketDownloadUrl', () => {
+    it('add path param if a path is specified', () => {
+      const config: BitbucketIntegrationConfig = {
+        host: 'bitbucket.mycompany.net',
+        apiBaseUrl: 'https://api.bitbucket.mycompany.net/rest/api/1.0',
+      };
+      const result = getBitbucketDownloadUrl(
+        'https://bitbucket.mycompany.net/projects/backstage/repos/mock/browse/docs',
+        config,
+      );
+      expect(result).toEqual(
+        'https://api.bitbucket.mycompany.net/rest/api/1.0/projects/backstage/repos/mock/archive?format=zip&prefix=backstage-mock&path=docs',
+      );
+    });
+
+    it('do not add path param if no path is specified', () => {
+      const config: BitbucketIntegrationConfig = {
+        host: 'bitbucket.mycompany.net',
+        apiBaseUrl: 'https://api.bitbucket.mycompany.net/rest/api/1.0',
+      };
+      const result = getBitbucketDownloadUrl(
+        'https://bitbucket.mycompany.net/projects/backstage/repos/mock/browse',
+        config,
+      );
+      expect(new URL(result).searchParams.get('format')).toEqual('zip');
+      expect(new URL(result).searchParams.get('prefix')).not.toBeNull();
+      expect(new URL(result).searchParams.get('path')).toBeNull();
+    });
+
+    it('do not add path param if the repository is hosted on bitbucket.org', () => {
+      const config: BitbucketIntegrationConfig = {
+        host: 'bitbucket.org',
+        apiBaseUrl: 'https://api.bitbucket.org/2.0',
+      };
+      const result = getBitbucketDownloadUrl(
+        'https://bitbucket.org/backstage/mock/src/master',
+        config,
+      );
+      expect(result).toEqual(
+        'https://bitbucket.org/backstage/mock/get/master.zip',
+      );
+    });
+  });
 });

packages/integration/src/bitbucket/core.ts

@@ -17,6 +17,38 @@
 import parseGitUrl from 'git-url-parse';
 import { BitbucketIntegrationConfig } from './config';
 
+/**
+ * Given a URL pointing to a path on a provider, returns a URL that is suitable
+ * for downloading the subtree.
+ *
+ * @param url A URL pointing to a path
+ */
+export function getBitbucketDownloadUrl(
+  url: string,
+  config: BitbucketIntegrationConfig,
+): string {
+  const {
+    name: repoName,
+    owner: project,
+    ref,
+    protocol,
+    resource,
+    filepath,
+  } = parseGitUrl(url);
+
+  const isHosted = resource === 'bitbucket.org';
+
+  // path will limit the downloaded content
+  // /docs will only download the docs folder and everything below it
+  // /docs/index.md will download the docs folder and everything below it
+  const path = filepath ? `&path=${encodeURIComponent(filepath)}` : '';
+  const archiveUrl = isHosted
+    ? `${protocol}://${resource}/${project}/${repoName}/get/${ref}.zip`
+    : `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/archive?format=zip&prefix=${project}-${repoName}${path}`;
+
+  return archiveUrl;
+}
+
 /**
  * Given a URL pointing to a file on a provider, returns a URL that is suitable
  * for fetching the contents of the data.

packages/integration/src/bitbucket/index.ts

@@ -19,4 +19,8 @@ export {
   readBitbucketIntegrationConfigs,
 } from './config';
 export type { BitbucketIntegrationConfig } from './config';
-export { getBitbucketFileFetchUrl, getBitbucketRequestOptions } from './core';
+export {
+  getBitbucketDownloadUrl,
+  getBitbucketFileFetchUrl,
+  getBitbucketRequestOptions,
+} from './core';