refactor(create-pull-request): extract methods to adhere to SRP and enhance maintainability

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

dist/index.js

@@ -397,11 +397,52 @@ function createPullRequest(inputs) {
     return __awaiter(this, void 0, void 0, function* () {
         let gitConfigHelper, git;
         try {
+            const { git, gitConfigHelper, repoPath } = yield prepareGitConfiguration(inputs);
+            const { branchRemoteName, ghBranch, branchRepository, ghPull, baseRemote } = yield initializePullRequestContext(inputs, gitConfigHelper, git);
+            // Apply the branch suffix if set
+            yield defineInputBranch(inputs, git);
+            // Output head branch
+            core.info(`Pull request branch to create or update set to '${inputs.branch}'`);
+            // Configure the committer and author
+            configureGitIdentity(inputs, git);
+            // Action outputs
+            const outputs = new Map();
+            outputs.set('pull-request-branch', inputs.branch);
+            outputs.set('pull-request-operation', 'none');
+            // Create or update the pull request branch
+            const result = yield createOrUpdatePullRequestBranch(git, inputs, branchRemoteName);
+            yield processPullRequestBranch(result, branchRemoteName, inputs, git, ghBranch, repoPath, branchRepository, outputs, ghPull, baseRemote);
+            yield exportOutputs(outputs, result, ghBranch, branchRepository);
+        }
+        catch (error) {
+            core.setFailed(utils.getErrorMessage(error));
+        }
+        finally {
+            core.startGroup('Restore git configuration');
+            if (inputs.pushToFork) {
+                yield (git === null || git === void 0 ? void 0 : git.exec(['remote', 'rm', 'fork']));
+            }
+            yield (gitConfigHelper === null || gitConfigHelper === void 0 ? void 0 : gitConfigHelper.close());
+            core.endGroup();
+        }
+    });
+}
+function prepareGitConfiguration(inputs) {
+    return __awaiter(this, void 0, void 0, function* () {
         core.startGroup('Prepare git configuration');
         const repoPath = utils.getRepoPath(inputs.path);
-            git = yield git_command_manager_1.GitCommandManager.create(repoPath);
+        const git = yield git_command_manager_1.GitCommandManager.create(repoPath);
-            gitConfigHelper = yield git_config_helper_1.GitConfigHelper.create(git);
+        const gitConfigHelper = yield git_config_helper_1.GitConfigHelper.create(git);
         core.endGroup();
+        return {
+            repoPath,
+            git,
+            gitConfigHelper
+        };
+    });
+}
+function initializePullRequestContext(inputs, gitConfigHelper, git) {
+    return __awaiter(this, void 0, void 0, function* () {
         core.startGroup('Determining the base and head repositories');
         const baseRemote = gitConfigHelper.getGitRemote();
         // Init the GitHub clients
@@ -459,7 +500,11 @@ function createPullRequest(inputs) {
         // https://github.com/peter-evans/create-pull-request/issues/633
         yield git.exec(['remote', 'prune', branchRemoteName]);
         core.endGroup();
-            // Apply the branch suffix if set
+        return { branchRemoteName, branchRepository, baseRemote, ghBranch, ghPull };
+    });
+}
+function defineInputBranch(inputs, git) {
+    return __awaiter(this, void 0, void 0, function* () {
         if (inputs.branchSuffix) {
             switch (inputs.branchSuffix) {
                 case 'short-commit-hash':
@@ -480,9 +525,9 @@ function createPullRequest(inputs) {
                     throw new Error(`Branch suffix '${inputs.branchSuffix}' is not a valid value. Unable to continue.`);
             }
         }
-            // Output head branch
+    });
-            core.info(`Pull request branch to create or update set to '${inputs.branch}'`);
+}
-            // Configure the committer and author
+function configureGitIdentity(inputs, git) {
     core.startGroup('Configuring the committer and author');
     const parsedAuthor = utils.parseDisplayNameEmail(inputs.author);
     const parsedCommitter = utils.parseDisplayNameEmail(inputs.committer);
@@ -499,19 +544,68 @@ function createPullRequest(inputs) {
     core.info(`Configured git committer as '${parsedCommitter.name} <${parsedCommitter.email}>'`);
     core.info(`Configured git author as '${parsedAuthor.name} <${parsedAuthor.email}>'`);
     core.endGroup();
-            // Action outputs
+}
-            const outputs = new Map();
+function createOrUpdatePullRequestBranch(git, inputs, branchRemoteName) {
-            outputs.set('pull-request-branch', inputs.branch);
+    return __awaiter(this, void 0, void 0, function* () {
-            outputs.set('pull-request-operation', 'none');
-            // Create or update the pull request branch
         core.startGroup('Create or update the pull request branch');
         const result = yield (0, create_or_update_branch_1.createOrUpdateBranch)(git, inputs.commitMessage, inputs.base, inputs.branch, branchRemoteName, inputs.signoff, inputs.addPaths);
+        core.endGroup();
+        return result;
+    });
+}
+function processPullRequestBranch(result, branchRemoteName, inputs, git, ghBranch, repoPath, branchRepository, outputs, ghPull, baseRemote) {
+    return __awaiter(this, void 0, void 0, function* () {
         outputs.set('pull-request-head-sha', result.headSha);
         // Set the base. It would have been '' if not specified as an input
         inputs.base = result.base;
-            core.endGroup();
         if (['created', 'updated'].includes(result.action)) {
             // The branch was created or updated
+            yield pushPullRequestBranch(branchRemoteName, inputs, git, ghBranch, result, repoPath, branchRepository, outputs);
+        }
+        if (result.hasDiffWithBase) {
+            yield createOrUpdatePullRequest(ghPull, inputs, baseRemote, branchRepository, outputs, result);
+        }
+        else {
+            // There is no longer a diff with the base
+            // Check we are in a state where a branch exists
+            if (['updated', 'not-updated'].includes(result.action)) {
+                core.info(`Branch '${inputs.branch}' no longer differs from base branch '${inputs.base}'`);
+                if (inputs.deleteBranch) {
+                    core.info(`Deleting branch '${inputs.branch}'`);
+                    yield git.push([
+                        '--delete',
+                        '--force',
+                        branchRemoteName,
+                        `refs/heads/${inputs.branch}`
+                    ]);
+                    outputs.set('pull-request-operation', 'closed');
+                }
+            }
+        }
+    });
+}
+function createOrUpdatePullRequest(ghPull, inputs, baseRemote, branchRepository, outputs, result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        core.startGroup('Create or update the pull request');
+        const pull = yield ghPull.createOrUpdatePullRequest(inputs, baseRemote.repository, branchRepository);
+        outputs.set('pull-request-number', pull.number.toString());
+        outputs.set('pull-request-url', pull.html_url);
+        if (pull.created) {
+            outputs.set('pull-request-operation', 'created');
+        }
+        else if (result.action == 'updated') {
+            outputs.set('pull-request-operation', 'updated');
+            // The pull request was updated AND the branch was updated.
+            // Convert back to draft if 'draft: always-true' is set.
+            if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
+                yield ghPull.convertToDraft(pull.node_id);
+            }
+        }
+        core.endGroup();
+    });
+}
+function pushPullRequestBranch(branchRemoteName, inputs, git, ghBranch, result, repoPath, branchRepository, outputs) {
+    return __awaiter(this, void 0, void 0, function* () {
         core.startGroup(`Pushing pull request branch to '${branchRemoteName}/${inputs.branch}'`);
         if (inputs.signCommits) {
             // Create signed commits via the GitHub API
@@ -533,42 +627,10 @@ function createPullRequest(inputs) {
             ]);
         }
         core.endGroup();
+    });
 }
-            if (result.hasDiffWithBase) {
+function exportOutputs(outputs, result, ghBranch, branchRepository) {
-                core.startGroup('Create or update the pull request');
+    return __awaiter(this, void 0, void 0, function* () {
-                const pull = yield ghPull.createOrUpdatePullRequest(inputs, baseRemote.repository, branchRepository);
-                outputs.set('pull-request-number', pull.number.toString());
-                outputs.set('pull-request-url', pull.html_url);
-                if (pull.created) {
-                    outputs.set('pull-request-operation', 'created');
-                }
-                else if (result.action == 'updated') {
-                    outputs.set('pull-request-operation', 'updated');
-                    // The pull request was updated AND the branch was updated.
-                    // Convert back to draft if 'draft: always-true' is set.
-                    if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
-                        yield ghPull.convertToDraft(pull.node_id);
-                    }
-                }
-                core.endGroup();
-            }
-            else {
-                // There is no longer a diff with the base
-                // Check we are in a state where a branch exists
-                if (['updated', 'not-updated'].includes(result.action)) {
-                    core.info(`Branch '${inputs.branch}' no longer differs from base branch '${inputs.base}'`);
-                    if (inputs.deleteBranch) {
-                        core.info(`Deleting branch '${inputs.branch}'`);
-                        yield git.push([
-                            '--delete',
-                            '--force',
-                            branchRemoteName,
-                            `refs/heads/${inputs.branch}`
-                        ]);
-                        outputs.set('pull-request-operation', 'closed');
-                    }
-                }
-            }
         core.startGroup('Setting outputs');
         // If the head commit is signed, get its verification status if we don't already know it.
         // This can happen if the branch wasn't updated (action = 'not-updated'), or GPG commit signing is in use.
@@ -595,18 +657,6 @@ function createPullRequest(inputs) {
             core.setOutput(key, value);
         }
         core.endGroup();
-        }
-        catch (error) {
-            core.setFailed(utils.getErrorMessage(error));
-        }
-        finally {
-            core.startGroup('Restore git configuration');
-            if (inputs.pushToFork) {
-                yield git.exec(['remote', 'rm', 'fork']);
-            }
-            yield gitConfigHelper.close();
-            core.endGroup();
-        }
     });
 }
 

src/create-or-update-branch.ts

@@ -157,7 +157,7 @@ function splitLines(multilineString: string): string[] {
     .filter(x => x !== '')
 }
 
-interface CreateOrUpdateBranchResult {
+export interface CreateOrUpdateBranchResult {
   action: string
   base: string
   hasDiffWithBase: boolean

src/create-pull-request.ts

@@ -1,12 +1,13 @@
 import * as core from '@actions/core'
 import {
   createOrUpdateBranch,
+  CreateOrUpdateBranchResult,
   getWorkingBaseAndType,
   WorkingBaseType
 } from './create-or-update-branch'
 import {GitHubHelper} from './github-helper'
 import {GitCommandManager} from './git-command-manager'
-import {GitConfigHelper} from './git-config-helper'
+import {GitConfigHelper, GitRemote} from './git-config-helper'
 import * as utils from './utils'
 
 export interface Inputs {
@@ -39,25 +40,110 @@ export interface Inputs {
   maintainerCanModify: boolean
 }
 
+type Ouputs = Map<string, string>
+
 export async function createPullRequest(inputs: Inputs): Promise<void> {
-  let gitConfigHelper, git
+  let gitConfigHelper: GitConfigHelper | undefined,
+    git: GitCommandManager | undefined
+
   try {
+    const {git, gitConfigHelper, repoPath} =
+      await prepareGitConfiguration(inputs)
+
+    const {branchRemoteName, ghBranch, branchRepository, ghPull, baseRemote} =
+      await initializePullRequestContext(inputs, gitConfigHelper, git)
+
+    // Apply the branch suffix if set
+    await defineInputBranch(inputs, git)
+
+    // Output head branch
+    core.info(
+      `Pull request branch to create or update set to '${inputs.branch}'`
+    )
+
+    // Configure the committer and author
+    configureGitIdentity(inputs, git)
+
+    // Action outputs
+    const outputs: Ouputs = new Map<string, string>()
+    outputs.set('pull-request-branch', inputs.branch)
+    outputs.set('pull-request-operation', 'none')
+
+    // Create or update the pull request branch
+    const result = await createOrUpdatePullRequestBranch(
+      git,
+      inputs,
+      branchRemoteName
+    )
+
+    await processPullRequestBranch(
+      result,
+      branchRemoteName,
+      inputs,
+      git,
+      ghBranch,
+      repoPath,
+      branchRepository,
+      outputs,
+      ghPull,
+      baseRemote
+    )
+
+    await exportOutputs(outputs, result, ghBranch, branchRepository)
+  } catch (error) {
+    core.setFailed(utils.getErrorMessage(error))
+  } finally {
+    core.startGroup('Restore git configuration')
+    if (inputs.pushToFork) {
+      await git?.exec(['remote', 'rm', 'fork'])
+    }
+    await gitConfigHelper?.close()
+    core.endGroup()
+  }
+}
+
+async function prepareGitConfiguration(inputs: Inputs): Promise<{
+  repoPath: string
+  git: GitCommandManager
+  gitConfigHelper: GitConfigHelper
+}> {
   core.startGroup('Prepare git configuration')
   const repoPath = utils.getRepoPath(inputs.path)
-    git = await GitCommandManager.create(repoPath)
+  const git = await GitCommandManager.create(repoPath)
-    gitConfigHelper = await GitConfigHelper.create(git)
+  const gitConfigHelper = await GitConfigHelper.create(git)
   core.endGroup()
+  return {
+    repoPath,
+    git,
+    gitConfigHelper
+  }
+}
 
+async function initializePullRequestContext(
+  inputs: Inputs,
+  gitConfigHelper: GitConfigHelper,
+  git: GitCommandManager
+): Promise<{
+  branchRemoteName: string
+  branchRepository: string
+  baseRemote: GitRemote
+  ghBranch: GitHubHelper
+  ghPull: GitHubHelper
+}> {
   core.startGroup('Determining the base and head repositories')
+
   const baseRemote = gitConfigHelper.getGitRemote()
+
   // Init the GitHub clients
   const ghBranch = new GitHubHelper(baseRemote.hostname, inputs.branchToken)
   const ghPull = new GitHubHelper(baseRemote.hostname, inputs.token)
+
   // Determine the head repository; the target for the pull request branch
   const branchRemoteName = inputs.pushToFork ? 'fork' : 'origin'
   const branchRepository = inputs.pushToFork
     ? inputs.pushToFork
     : baseRemote.repository
+
   if (inputs.pushToFork) {
     // Check if the supplied fork is really a fork of the base
     core.info(
@@ -81,6 +167,7 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
         `Repository '${branchRepository}' is not a fork of '${baseRemote.repository}', nor are they siblings. Unable to continue.`
       )
     }
+
     // Add a remote for the fork
     const remoteUrl = utils.getRemoteUrl(
       baseRemote.protocol,
@@ -90,9 +177,7 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
     await git.exec(['remote', 'add', 'fork', remoteUrl])
   }
   core.endGroup()
-    core.info(
+  core.info(`Pull request branch target repository set to ${branchRepository}`)
-      `Pull request branch target repository set to ${branchRepository}`
-    )
 
   // Configure auth
   if (baseRemote.protocol == 'HTTPS') {
@@ -104,6 +189,7 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
   core.startGroup('Checking the base repository state')
   const [workingBase, workingBaseType] = await getWorkingBaseAndType(git)
   core.info(`Working base is ${workingBaseType} '${workingBase}'`)
+
   // When in detached HEAD state (checked out on a commit), we need to
   // know the 'base' branch in order to rebase changes.
   if (workingBaseType == WorkingBaseType.Commit && !inputs.base) {
@@ -111,8 +197,10 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
       `When the repository is checked out on a commit instead of a branch, the 'base' input must be supplied.`
     )
   }
+
   // If the base is not specified it is assumed to be the working base.
   const base = inputs.base ? inputs.base : workingBase
+
   // Throw an error if the base and branch are not different branches
   // of the 'origin' remote. An identically named branch in the `fork`
   // remote is perfectly fine.
@@ -121,15 +209,20 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
       `The 'base' and 'branch' for a pull request must be different branches. Unable to continue.`
     )
   }
+
   // For self-hosted runners the repository state persists between runs.
   // This command prunes the stale remote ref when the pull request branch was
   // deleted after being merged or closed. Without this the push using
   // '--force-with-lease' fails due to "stale info."
   // https://github.com/peter-evans/create-pull-request/issues/633
   await git.exec(['remote', 'prune', branchRemoteName])
+
   core.endGroup()
 
-    // Apply the branch suffix if set
+  return {branchRemoteName, branchRepository, baseRemote, ghBranch, ghPull}
+}
+
+async function defineInputBranch(inputs: Inputs, git: GitCommandManager) {
   if (inputs.branchSuffix) {
     switch (inputs.branchSuffix) {
       case 'short-commit-hash':
@@ -152,13 +245,9 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
         )
     }
   }
+}
 
-    // Output head branch
+function configureGitIdentity(inputs: Inputs, git: GitCommandManager) {
-    core.info(
-      `Pull request branch to create or update set to '${inputs.branch}'`
-    )
-
-    // Configure the committer and author
   core.startGroup('Configuring the committer and author')
   const parsedAuthor = utils.parseDisplayNameEmail(inputs.author)
   const parsedCommitter = utils.parseDisplayNameEmail(inputs.committer)
@@ -179,13 +268,13 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
     `Configured git author as '${parsedAuthor.name} <${parsedAuthor.email}>'`
   )
   core.endGroup()
+}
 
-    // Action outputs
+async function createOrUpdatePullRequestBranch(
-    const outputs = new Map<string, string>()
+  git: GitCommandManager,
-    outputs.set('pull-request-branch', inputs.branch)
+  inputs: Inputs,
-    outputs.set('pull-request-operation', 'none')
+  branchRemoteName: string
-
+) {
-    // Create or update the pull request branch
   core.startGroup('Create or update the pull request branch')
   const result = await createOrUpdateBranch(
     git,
@@ -196,13 +285,109 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
     inputs.signoff,
     inputs.addPaths
   )
+  core.endGroup()
+  return result
+}
+
+async function processPullRequestBranch(
+  result: CreateOrUpdateBranchResult,
+  branchRemoteName: string,
+  inputs: Inputs,
+  git: GitCommandManager,
+  ghBranch: GitHubHelper,
+  repoPath: string,
+  branchRepository: any,
+  outputs: Ouputs,
+  ghPull: GitHubHelper,
+  baseRemote: GitRemote
+) {
   outputs.set('pull-request-head-sha', result.headSha)
   // Set the base. It would have been '' if not specified as an input
   inputs.base = result.base
-    core.endGroup()
 
   if (['created', 'updated'].includes(result.action)) {
     // The branch was created or updated
+    await pushPullRequestBranch(
+      branchRemoteName,
+      inputs,
+      git,
+      ghBranch,
+      result,
+      repoPath,
+      branchRepository,
+      outputs
+    )
+  }
+
+  if (result.hasDiffWithBase) {
+    await createOrUpdatePullRequest(
+      ghPull,
+      inputs,
+      baseRemote,
+      branchRepository,
+      outputs,
+      result
+    )
+  } else {
+    // There is no longer a diff with the base
+    // Check we are in a state where a branch exists
+    if (['updated', 'not-updated'].includes(result.action)) {
+      core.info(
+        `Branch '${inputs.branch}' no longer differs from base branch '${inputs.base}'`
+      )
+      if (inputs.deleteBranch) {
+        core.info(`Deleting branch '${inputs.branch}'`)
+        await git.push([
+          '--delete',
+          '--force',
+          branchRemoteName,
+          `refs/heads/${inputs.branch}`
+        ])
+        outputs.set('pull-request-operation', 'closed')
+      }
+    }
+  }
+}
+
+async function createOrUpdatePullRequest(
+  ghPull: GitHubHelper,
+  inputs: Inputs,
+  baseRemote: GitRemote,
+  branchRepository: any,
+  outputs: Ouputs,
+  result: CreateOrUpdateBranchResult
+) {
+  core.startGroup('Create or update the pull request')
+  const pull = await ghPull.createOrUpdatePullRequest(
+    inputs,
+    baseRemote.repository,
+    branchRepository
+  )
+  outputs.set('pull-request-number', pull.number.toString())
+  outputs.set('pull-request-url', pull.html_url)
+  if (pull.created) {
+    outputs.set('pull-request-operation', 'created')
+  } else if (result.action == 'updated') {
+    outputs.set('pull-request-operation', 'updated')
+    // The pull request was updated AND the branch was updated.
+    // Convert back to draft if 'draft: always-true' is set.
+    if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
+      await ghPull.convertToDraft(pull.node_id)
+    }
+  }
+  core.endGroup()
+}
+
+async function pushPullRequestBranch(
+  branchRemoteName: string,
+  inputs: Inputs,
+  git: GitCommandManager,
+  ghBranch: GitHubHelper,
+  result: CreateOrUpdateBranchResult,
+  repoPath: string,
+  branchRepository: any,
+  outputs: Ouputs
+) {
   core.startGroup(
     `Pushing pull request branch to '${branchRemoteName}/${inputs.branch}'`
   )
@@ -237,46 +422,12 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
   core.endGroup()
 }
 
-    if (result.hasDiffWithBase) {
+async function exportOutputs(
-      core.startGroup('Create or update the pull request')
+  outputs: Ouputs,
-      const pull = await ghPull.createOrUpdatePullRequest(
+  result: CreateOrUpdateBranchResult,
-        inputs,
+  ghBranch: GitHubHelper,
-        baseRemote.repository,
+  branchRepository: string
-        branchRepository
+) {
-      )
-      outputs.set('pull-request-number', pull.number.toString())
-      outputs.set('pull-request-url', pull.html_url)
-      if (pull.created) {
-        outputs.set('pull-request-operation', 'created')
-      } else if (result.action == 'updated') {
-        outputs.set('pull-request-operation', 'updated')
-        // The pull request was updated AND the branch was updated.
-        // Convert back to draft if 'draft: always-true' is set.
-        if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
-          await ghPull.convertToDraft(pull.node_id)
-        }
-      }
-      core.endGroup()
-    } else {
-      // There is no longer a diff with the base
-      // Check we are in a state where a branch exists
-      if (['updated', 'not-updated'].includes(result.action)) {
-        core.info(
-          `Branch '${inputs.branch}' no longer differs from base branch '${inputs.base}'`
-        )
-        if (inputs.deleteBranch) {
-          core.info(`Deleting branch '${inputs.branch}'`)
-          await git.push([
-            '--delete',
-            '--force',
-            branchRemoteName,
-            `refs/heads/${inputs.branch}`
-          ])
-          outputs.set('pull-request-operation', 'closed')
-        }
-      }
-    }
-
   core.startGroup('Setting outputs')
   // If the head commit is signed, get its verification status if we don't already know it.
   // This can happen if the branch wasn't updated (action = 'not-updated'), or GPG commit signing is in use.
@@ -311,14 +462,4 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
     core.setOutput(key, value)
   }
   core.endGroup()
-  } catch (error) {
-    core.setFailed(utils.getErrorMessage(error))
-  } finally {
-    core.startGroup('Restore git configuration')
-    if (inputs.pushToFork) {
-      await git.exec(['remote', 'rm', 'fork'])
-    }
-    await gitConfigHelper.close()
-    core.endGroup()
-  }
 }

src/git-config-helper.ts

@@ -5,7 +5,7 @@ import * as path from 'path'
 import {URL} from 'url'
 import * as utils from './utils'
 
-interface GitRemote {
+export interface GitRemote {
   hostname: string
   protocol: string
   repository: string