Handle uncaught handlebars exception (#526)

Resolves handlebars errors like:
```
runSequentially failed Parse error on line 11:
```metadata={{
          extraA
-----------------------^\nExpecting 'ID', 'STRING', 'NUMBER', 'BOOLEAN', 'UNDEFINED', 'NULL', 'DATA', got 'INVALID'
```

Author: sorenlouv

.vscode/settings.json

@@ -13,7 +13,7 @@
     "github-schema.graphql": true,
     "LICENSE.txt": true
   },
-  "editor.formatOnSave": true,
+  "editor.formatOnSave": false,
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },

docs/config-file-options.md

@@ -342,7 +342,8 @@ Template values:
 - `{{targetBranch}}`: Branch the backport PR will be targeting
 - `{{sourcePullRequest}}`: Original pull request object (see [`Commit` interface](https://github.com/sorenlouv/backport/blob/main/src/lib/sourceCommit/parseSourceCommit.ts))
 - `{{commitMessages}}`: Message of backported commit. For multiple commits the messages will be separated by pipes (`|`).
-- `{{commits}}`: A list of commits ([`Commit` interface](https://github.com/sorenlouv/backport/blob/main/src/lib/sourceCommit/parseSourceCommit.ts))
+- `{{commits}}`: An array of selected commits ([`Commit` interface](https://github.com/sorenlouv/backport/blob/main/src/lib/sourceCommit/parseSourceCommit.ts))
+- `{{commitsStringified}}`: Array of commits stringified for easier output
 
 **Default**
 

src/backportRun.ts

@@ -9,6 +9,8 @@ import { createStatusComment } from './lib/github/v3/createStatusComment';
 import { GithubV4Exception } from './lib/github/v4/apiRequestV4';
 import { consoleLog, initLogger } from './lib/logger';
 import { ora } from './lib/ora';
+import { registerHandlebarsHelpers } from './lib/registerHandlebarsHelpers';
+import { runSequentially, Result } from './lib/runSequentially';
 import { setupRepo } from './lib/setupRepo';
 import { Commit } from './lib/sourceCommit/parseSourceCommit';
 import { ConfigFileOptions } from './options/ConfigOptions';
@@ -22,7 +24,8 @@ import {
   getOptions,
   ValidConfigOptions,
 } from './options/options';
-import { runSequentially, Result } from './runSequentially';
+
+registerHandlebarsHelpers();
 
 export type BackportAbortResponse = {
   status: 'aborted';

src/entrypoint.api.ts

@@ -18,7 +18,7 @@ export type {
   HandledErrorResult,
   SuccessResult,
   UnhandledErrorResult,
-} from './runSequentially';
+} from './lib/runSequentially';
 export type {
   BackportAbortResponse,
   BackportFailureResponse,

src/lib/cherrypickAndCreateTargetPullRequest/cherrypickAndCreateTargetPullRequest.ts

@@ -13,10 +13,10 @@ import { addLabelsToPullRequest } from '../github/v3/addLabelsToPullRequest';
 import { addReviewersToPullRequest } from '../github/v3/addReviewersToPullRequest';
 import {
   createPullRequest,
-  getTitle,
-  getPullRequestBody,
   PullRequestPayload,
-} from '../github/v3/createPullRequest';
+} from '../github/v3/getPullRequest/createPullRequest';
+import { getPullRequestBody } from '../github/v3/getPullRequest/getPullRequestBody';
+import { getTitle } from '../github/v3/getPullRequest/getTitle';
 import { validateTargetBranch } from '../github/v4/validateTargetBranch';
 import { consoleLog } from '../logger';
 import { sequentially } from '../sequentially';

src/lib/cherrypickAndCreateTargetPullRequest/getBackportBranchName.test.ts

@@ -2,28 +2,78 @@ import { Commit } from '../../entrypoint.api';
 import { ValidConfigOptions } from '../../options/options';
 import { getBackportBranchName } from './getBackportBranchName';
 
-const commit = { sourcePullRequest: { number: 1234 } } as Commit;
-
 describe('getBackportBranchName', () => {
-  it('returns the default name', () => {
-    const name = getBackportBranchName({
-      options: {
-        backportBranchName: undefined,
-      } as ValidConfigOptions,
-      targetBranch: '7.x',
-      commits: [commit],
+  describe('when options.backportBranchName is not set', () => {
+    it('returns the default name with PR number', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: { backportBranchName: undefined } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('backport/7.x/pr-1234');
+    });
+
+    it('returns the default name with commit sha', () => {
+      const commits = [{ sourceCommit: { sha: 'abcde' } }] as Commit[];
+      const name = getBackportBranchName({
+        options: { backportBranchName: undefined } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('backport/7.x/commit-abcde');
     });
-    expect(name).toBe('backport/7.x/pr-1234');
   });
 
-  it('returns a custom name', () => {
-    const name = getBackportBranchName({
-      options: {
-        backportBranchName: 'bp/pull-{{sourcePullRequest.number}}',
-      } as ValidConfigOptions,
-      targetBranch: '7.x',
-      commits: [commit],
+  describe('template variables are supported when using options.backportBranchName', () => {
+    it('{{targetBranch}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/target-{{targetBranch}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/target-7.x');
+    });
+
+    it('{{refValues}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/ref-{{refValues}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/ref-pr-1234');
+    });
+
+    it('{{sourcePullRequest.number}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/pr-{{sourcePullRequest.number}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/pr-1234');
+    });
+
+    it('{{sourcePullRequest.title}}', () => {
+      const commits = [
+        { sourcePullRequest: { title: 'My PR title', number: 1234 } },
+      ] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/pr-{{sourcePullRequest.title}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/pr-My PR title');
     });
-    expect(name).toBe('bp/pull-1234');
   });
 });

src/lib/cherrypickAndCreateTargetPullRequest/getBackportBranchName.ts

@@ -28,13 +28,16 @@ export function getBackportBranchName({
     )
     .join('_')
     .slice(0, 200);
+
+  const sourcePullRequest = commits[0].sourcePullRequest; // assume that all commits are from the same PR
   const defaultBackportBranchName = 'backport/{{targetBranch}}/{{refValues}}';
-  const template = Handlebars.compile(
-    options.backportBranchName ?? defaultBackportBranchName,
-  );
 
+  const backportBranchName =
+    options.backportBranchName ?? defaultBackportBranchName;
+
+  const template = Handlebars.compile(backportBranchName);
   return template({
-    sourcePullRequest: commits[0].sourcePullRequest, // assume that all commits are from the same PR
+    sourcePullRequest,
     targetBranch,
     refValues,
   });