refactor(platform): Extract getRawFile method (#9404)

renovatebot · Apr 5, 2021 · 1473047 · 1473047
1 parent 430249d
commit 1473047
Show file tree

Hide file tree

Showing 17 changed files with 376 additions and 53 deletions.
diff --git a/lib/platform/azure/index.spec.ts b/lib/platform/azure/index.spec.ts
@@ -1196,6 +1196,18 @@ describe('platform/azure', () => {
       const res = await azure.getJsonFile('file.json');
       expect(res).toEqual(data);
     });
+    it('returns null for malformed JSON', async () => {
+      azureApi.gitApi.mockImplementationOnce(
+        () =>
+          ({
+            getItemContent: jest.fn(() =>
+              Promise.resolve(Readable.from('!@#'))
+            ),
+          } as any)
+      );
+      const res = await azure.getJsonFile('file.json');
+      expect(res).toBeNull();
+    });
     it('returns null on errors', async () => {
       azureApi.gitApi.mockImplementationOnce(
         () =>

diff --git a/lib/platform/azure/index.ts b/lib/platform/azure/index.ts
@@ -104,15 +104,27 @@ export async function getRepos(): Promise<string[]> {
   return repos.map((repo) => `${repo.project.name}/${repo.name}`);
 }
 
-export async function getJsonFile(
+export async function getRawFile(
   fileName: string,
   repo: string = config.repoId
-): Promise<any | null> {
+): Promise<string | null> {
   try {
     const azureApiGit = await azureApi.gitApi();
     const buf = await azureApiGit.getItemContent(repo, fileName);
     const str = await streamToString(buf);
-    return JSON.parse(str);
+    return str;
+  } catch (err) {
+    return null;
+  }
+}
+
+export async function getJsonFile(
+  fileName: string,
+  repo: string = config.repoId
+): Promise<any | null> {
+  try {
+    const raw = await getRawFile(fileName, repo);
+    return raw && JSON.parse(raw);
   } catch (err) {
     return null;
   }

diff --git a/lib/platform/bitbucket-server/__snapshots__/index.spec.ts.snap b/lib/platform/bitbucket-server/__snapshots__/index.spec.ts.snap
@@ -1972,6 +1972,47 @@ Array [
 ]
 `;
 
+exports[`platform/bitbucket-server/index endpoint with no path getJsonFile() returns null for malformed JSON 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/rest/api/1.0/projects/SOME/repos/repo",
+  },
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/rest/api/1.0/projects/SOME/repos/repo/branches/default",
+  },
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/rest/api/1.0/projects/SOME/repos/repo/browse/file.json?limit=20000",
+  },
+]
+`;
+
 exports[`platform/bitbucket-server/index endpoint with no path getJsonFile() returns null on errors 1`] = `
 Array [
   Object {
@@ -2310,22 +2351,6 @@ Array [
 
 exports[`platform/bitbucket-server/index endpoint with no path getPr() returns null for no prNo 1`] = `Array []`;
 
-exports[`platform/bitbucket-server/index endpoint with no path massageMarkdown() returns diff files 1`] = `"**foo**bartext"`;
-
-exports[`platform/bitbucket-server/index endpoint with no path massageMarkdown() sanitizes HTML comments in the body 1`] = `
-"---
-
-- [ ] If you want to rebase/retry this PR, check this box
-- [ ] <a href=\\"/some/link\\">Update renovate/renovate to 16.1.2</a>
-
----
-
-Empty comment.
-
-Followed by some information.
-"
-`;
-
 exports[`platform/bitbucket-server/index endpoint with no path getPrList() has pr 1`] = `
 Array [
   Object {
@@ -2579,6 +2604,22 @@ Array [
 ]
 `;
 
+exports[`platform/bitbucket-server/index endpoint with no path massageMarkdown() returns diff files 1`] = `"**foo**bartext"`;
+
+exports[`platform/bitbucket-server/index endpoint with no path massageMarkdown() sanitizes HTML comments in the body 1`] = `
+"---
+
+- [ ] If you want to rebase/retry this PR, check this box
+- [ ] <a href=\\"/some/link\\">Update renovate/renovate to 16.1.2</a>
+
+---
+
+Empty comment.
+
+Followed by some information.
+"
+`;
+
 exports[`platform/bitbucket-server/index endpoint with no path mergePr() posts Merge 1`] = `
 Array [
   Object {
@@ -6062,6 +6103,47 @@ Array [
 ]
 `;
 
+exports[`platform/bitbucket-server/index endpoint with path getJsonFile() returns null for malformed JSON 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/vcs/rest/api/1.0/projects/SOME/repos/repo",
+  },
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/vcs/rest/api/1.0/projects/SOME/repos/repo/branches/default",
+  },
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "stash.renovatebot.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+      "x-atlassian-token": "no-check",
+    },
+    "method": "GET",
+    "url": "https://stash.renovatebot.com/vcs/rest/api/1.0/projects/SOME/repos/repo/browse/file.json?limit=20000",
+  },
+]
+`;
+
 exports[`platform/bitbucket-server/index endpoint with path getJsonFile() returns null on errors 1`] = `
 Array [
   Object {
@@ -6400,22 +6482,6 @@ Array [
 
 exports[`platform/bitbucket-server/index endpoint with path getPr() returns null for no prNo 1`] = `Array []`;
 
-exports[`platform/bitbucket-server/index endpoint with path massageMarkdown() returns diff files 1`] = `"**foo**bartext"`;
-
-exports[`platform/bitbucket-server/index endpoint with path massageMarkdown() sanitizes HTML comments in the body 1`] = `
-"---
-
-- [ ] If you want to rebase/retry this PR, check this box
-- [ ] <a href=\\"/some/link\\">Update renovate/renovate to 16.1.2</a>
-
----
-
-Empty comment.
-
-Followed by some information.
-"
-`;
-
 exports[`platform/bitbucket-server/index endpoint with path getPrList() has pr 1`] = `
 Array [
   Object {
@@ -6669,6 +6735,22 @@ Array [
 ]
 `;
 
+exports[`platform/bitbucket-server/index endpoint with path massageMarkdown() returns diff files 1`] = `"**foo**bartext"`;
+
+exports[`platform/bitbucket-server/index endpoint with path massageMarkdown() sanitizes HTML comments in the body 1`] = `
+"---
+
+- [ ] If you want to rebase/retry this PR, check this box
+- [ ] <a href=\\"/some/link\\">Update renovate/renovate to 16.1.2</a>
+
+---
+
+Empty comment.
+
+Followed by some information.
+"
+`;
+
 exports[`platform/bitbucket-server/index endpoint with path mergePr() posts Merge 1`] = `
 Array [
   Object {

diff --git a/lib/platform/bitbucket-server/index.spec.ts b/lib/platform/bitbucket-server/index.spec.ts
@@ -2107,6 +2107,20 @@ Followed by some information.
           expect(res).toEqual(data);
           expect(httpMock.getTrace()).toMatchSnapshot();
         });
+        it('returns null for malformed JSON', async () => {
+          const scope = await initRepo();
+          scope
+            .get(
+              `${urlPath}/rest/api/1.0/projects/SOME/repos/repo/browse/file.json?limit=20000`
+            )
+            .reply(200, {
+              isLastPage: true,
+              lines: [{ text: '!@#' }],
+            });
+          const res = await bitbucket.getJsonFile('file.json');
+          expect(res).toBeNull();
+          expect(httpMock.getTrace()).toMatchSnapshot();
+        });
         it('returns null for long content', async () => {
           const scope = await initRepo();
           scope

diff --git a/lib/platform/bitbucket-server/index.ts b/lib/platform/bitbucket-server/index.ts
@@ -118,17 +118,17 @@ export async function getRepos(): Promise<string[]> {
   }
 }
 
-export async function getJsonFile(
+export async function getRawFile(
   fileName: string,
   repo: string = config.repository
-): Promise<any | null> {
+): Promise<string | null> {
   try {
     const [project, slug] = repo.split('/');
     const fileUrl = `./rest/api/1.0/projects/${project}/repos/${slug}/browse/${fileName}?limit=20000`;
     const res = await bitbucketServerHttp.getJson<FileData>(fileUrl);
     const { isLastPage, lines, size } = res.body;
     if (isLastPage) {
-      return JSON.parse(lines.map(({ text }) => text).join(''));
+      return lines.map(({ text }) => text).join('');
     }
     logger.warn({ size }, `The file is too big`);
   } catch (err) {
@@ -137,6 +137,18 @@ export async function getJsonFile(
   return null;
 }
 
+export async function getJsonFile(
+  fileName: string,
+  repo: string = config.repository
+): Promise<any | null> {
+  try {
+    const raw = await getRawFile(fileName, repo);
+    return raw && JSON.parse(raw);
+  } catch (err) {
+    return null;
+  }
+}
+
 // Initialize BitBucket Server by getting base branch
 export async function initRepo({
   repository,

diff --git a/lib/platform/bitbucket/__snapshots__/index.spec.ts.snap b/lib/platform/bitbucket/__snapshots__/index.spec.ts.snap
@@ -908,6 +908,21 @@ Array [
     "method": "GET",
     "url": "https://api.bitbucket.org/2.0/repositories/some/repo",
   },
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "api.bitbucket.org",
+      "user-agent": "https://github.com/renovatebot/renovate",
+    },
+    "method": "GET",
+    "url": "https://api.bitbucket.org/2.0/repositories/some/repo/src/HEAD/file.json",
+  },
+]
+`;
+
+exports[`platform/bitbucket getJsonFile() returns null for malformed JSON 1`] = `
+Array [
   Object {
     "headers": Object {
       "accept": "application/json",
@@ -917,6 +932,16 @@ Array [
       "user-agent": "https://github.com/renovatebot/renovate",
     },
     "method": "GET",
+    "url": "https://api.bitbucket.org/2.0/repositories/some/repo",
+  },
+  Object {
+    "headers": Object {
+      "accept-encoding": "gzip, deflate",
+      "authorization": "Basic YWJjOjEyMw==",
+      "host": "api.bitbucket.org",
+      "user-agent": "https://github.com/renovatebot/renovate",
+    },
+    "method": "GET",
     "url": "https://api.bitbucket.org/2.0/repositories/some/repo/src/HEAD/file.json",
   },
 ]
@@ -937,7 +962,6 @@ Array [
   },
   Object {
     "headers": Object {
-      "accept": "application/json",
       "accept-encoding": "gzip, deflate",
       "authorization": "Basic YWJjOjEyMw==",
       "host": "api.bitbucket.org",

diff --git a/lib/platform/bitbucket/index.spec.ts b/lib/platform/bitbucket/index.spec.ts
@@ -851,6 +851,15 @@ describe('platform/bitbucket', () => {
       expect(res).toEqual(data);
       expect(httpMock.getTrace()).toMatchSnapshot();
     });
+    it('returns null for malformed JSON', async () => {
+      const scope = await initRepoMock();
+      scope
+        .get('/2.0/repositories/some/repo/src/HEAD/file.json')
+        .reply(200, '!@#');
+      const res = await bitbucket.getJsonFile('file.json');
+      expect(res).toBeNull();
+      expect(httpMock.getTrace()).toMatchSnapshot();
+    });
     it('returns null on errors', async () => {
       const scope = await initRepoMock();
       scope

diff --git a/lib/platform/bitbucket/index.ts b/lib/platform/bitbucket/index.ts
@@ -99,21 +99,33 @@ export async function getRepos(): Promise<string[]> {
   }
 }
 
-export async function getJsonFile(
+export async function getRawFile(
   fileName: string,
   repo: string = config.repository
-): Promise<any | null> {
+): Promise<string | null> {
   try {
     // See: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/src/%7Bcommit%7D/%7Bpath%7D
     const path = fileName;
     const url = `/2.0/repositories/${repo}/src/HEAD/${path}`;
-    const res = await bitbucketHttp.getJson(url);
+    const res = await bitbucketHttp.get(url);
     return res.body;
   } catch (err) {
     return null;
   }
 }
 
+export async function getJsonFile(
+  fileName: string,
+  repo: string = config.repository
+): Promise<any | null> {
+  try {
+    const raw = await getRawFile(fileName, repo);
+    return raw && JSON.parse(raw);
+  } catch (err) {
+    return null;
+  }
+}
+
 // Initialize bitbucket by getting base branch and SHA
 export async function initRepo({
   repository,