Merge branch 'upstream-development'

Author: pol-rivero

.vscode/settings.json

@@ -26,6 +26,7 @@
   "prettier.singleQuote": true,
   "prettier.trailingComma": "es5",
   "editor.formatOnSave": true,
+  "prettier.prettierPath": "./node_modules/prettier",
   "editor.codeActionsOnSave": {
     "source.organizeImports": "never"
   },

app/package.json

@@ -4,7 +4,7 @@
   "productName": "GitHub Desktop Plus",
   "bundleID": "com.github.GitHubClient",
   "companyName": "GitHub, Inc.",
-  "version": "3.5.5-beta3",
+  "version": "3.5.5-beta4",
   "main": "./main.js",
   "repository": {
     "type": "git",

app/src/lib/feature-flag.ts

@@ -108,3 +108,5 @@ export function enableAccessibleListToolTips(): boolean {
 }
 
 export const enableHooksEnvironment = enableBetaFeatures
+
+export const enableHooksByDefault = enableBetaFeatures

app/src/lib/git/core.ts

@@ -35,18 +35,17 @@ export type TerminalOutputListener = (cb: (chunk: TerminalOutput) => void) => {
 
 export type TerminalOutputCallback = (subscribe: TerminalOutputListener) => void
 
-export type HookProgress =
+export type HookProgress = {
+  readonly hookName: string
+} & (
   | {
-      readonly hookName: string
-    } & (
-      | {
-          readonly status: 'started'
-          readonly abort: () => void
-        }
-      | {
-          readonly status: 'finished' | 'failed'
-        }
-    )
+      readonly status: 'started'
+      readonly abort: () => void
+    }
+  | {
+      readonly status: 'finished' | 'failed'
+    }
+)
 
 export type HookCallbackOptions = {
   readonly onHookProgress?: (progress: HookProgress) => void

app/src/lib/git/rebase.ts

@@ -21,6 +21,7 @@ import {
   gitRebaseArguments,
   IGitStringExecutionOptions,
   IGitStringResult,
+  HookCallbackOptions,
 } from './core'
 import { stageManualConflictResolution } from './stage'
 import { stageFiles } from './update-index'
@@ -438,8 +439,7 @@ export async function continueRebase(
   repository: Repository,
   files: ReadonlyArray<WorkingDirectoryFileChange>,
   manualResolutions: ReadonlyMap<string, ManualConflictResolution> = new Map(),
-  progressCallback?: (progress: IMultiCommitOperationProgress) => void,
-  gitEditor: string = ':'
+  opts?: RebaseInteractiveOptions
 ): Promise<RebaseResult> {
   const trackedFiles = files.filter(f => {
     return f.status.kind !== AppFileStatusKind.Untracked
@@ -484,13 +484,13 @@ export async function continueRebase(
       GitError.UnresolvedConflicts,
     ]),
     env: {
-      GIT_EDITOR: gitEditor,
+      GIT_EDITOR: opts?.gitEditor ?? ':',
     },
   }
 
   let options = baseOptions
 
-  if (progressCallback !== undefined) {
+  if (opts?.progressCallback) {
     const snapshot = await getRebaseSnapshot(repository)
 
     if (snapshot === null) {
@@ -502,17 +502,24 @@ export async function continueRebase(
 
     options = configureOptionsForRebase(baseOptions, {
       commits: snapshot.commits,
-      progressCallback,
+      progressCallback: opts.progressCallback,
     })
   }
 
+  options = {
+    ...options,
+    onTerminalOutputAvailable: opts?.onTerminalOutputAvailable,
+    onHookFailure: opts?.onHookFailure,
+    onHookProgress: opts?.onHookProgress,
+  }
+
   if (trackedFilesAfter.length === 0) {
     log.warn(
       `[rebase] no tracked changes to commit for ${rebaseCurrentCommit}, continuing rebase but skipping this commit`
     )
 
     const result = await git(
-      ['rebase', '--skip'],
+      ['rebase', '--skip', ...(opts?.noVerify ? ['--no-verify'] : [])],
       repository.path,
       'continueRebaseSkipCurrentCommit',
       options
@@ -522,7 +529,7 @@ export async function continueRebase(
   }
 
   const result = await git(
-    ['rebase', '--continue'],
+    ['rebase', '--continue', ...(opts?.noVerify ? ['--no-verify'] : [])],
     repository.path,
     'continueRebase',
     options
@@ -531,6 +538,22 @@ export async function continueRebase(
   return parseRebaseResult(result)
 }
 
+export type RebaseInteractiveOptions = {
+  /**
+   * a description of the action to be displayed in the progress dialog - i.e. Squash, Amend, etc..
+   */
+  action?: string
+
+  /**
+   * the GIT_EDITOR environment variable to use during the interactive rebase,
+   * defaults to ':' which is a no-op command
+   */
+  gitEditor?: string
+  progressCallback?: (progress: IMultiCommitOperationProgress) => void
+  commits?: ReadonlyArray<Commit>
+  noVerify?: boolean
+} & HookCallbackOptions
+
 /**
  * Method for initiating interactive rebase in the app.
  *
@@ -543,30 +566,27 @@ export async function continueRebase(
  * @param lastRetainedCommitRef the commit before the earliest commit to be
  * changed during the interactive rebase or null if commit is root (first commit
  * in history) of branch
- * @param action a description of the action to be displayed in the progress
- * dialog - i.e. Squash, Amend, etc..
  */
 export async function rebaseInteractive(
   repository: Repository,
   pathOfGeneratedTodo: string,
   lastRetainedCommitRef: string | null,
-  action: string = 'Interactive rebase',
-  gitEditor: string = ':',
-  progressCallback?: (progress: IMultiCommitOperationProgress) => void,
-  commits?: ReadonlyArray<Commit>
+  opts?: RebaseInteractiveOptions
 ): Promise<RebaseResult> {
   const baseOptions: IGitStringExecutionOptions = {
     expectedErrors: new Set([GitError.RebaseConflicts]),
     env: {
       GIT_SEQUENCE_EDITOR: undefined,
-      GIT_EDITOR: gitEditor,
+      GIT_EDITOR: opts?.gitEditor ?? ':',
     },
   }
 
   let options = baseOptions
 
-  if (progressCallback !== undefined) {
-    if (commits === undefined) {
+  const { progressCallback, commits } = opts ?? {}
+
+  if (progressCallback) {
+    if (!commits) {
       log.warn(`Unable to interactively rebase if no commits`)
       return RebaseResult.Error
     }
@@ -577,6 +597,13 @@ export async function rebaseInteractive(
     })
   }
 
+  options = {
+    ...options,
+    onHookProgress: opts?.onHookProgress,
+    onHookFailure: opts?.onHookFailure,
+    onTerminalOutputAvailable: opts?.onTerminalOutputAvailable,
+  }
+
   /* If the commit is the first commit in the branch, we cannot reference it
   using the sha thus if lastRetainedCommitRef is null (we couldn't define it),
   we must use the --root flag */
@@ -587,11 +614,12 @@ export async function rebaseInteractive(
       // This replaces interactive todo with contents of file at pathOfGeneratedTodo
       `sequence.editor=cat "${pathOfGeneratedTodo}" >`,
       'rebase',
+      ...(opts?.noVerify ? ['--no-verify'] : []),
       '-i',
       ref,
     ],
     repository.path,
-    action,
+    opts?.action ?? 'Interactive rebase',
     options
   )
 

app/src/lib/git/reorder.ts

@@ -134,10 +134,11 @@ export async function reorder(
       repository,
       todoPath,
       lastRetainedCommitRef,
-      MultiCommitOperationKind.Reorder,
-      undefined,
-      progressCallback,
-      commits
+      {
+        action: MultiCommitOperationKind.Reorder,
+        progressCallback,
+        commits,
+      }
     )
   } catch (e) {
     log.error(e)

app/src/lib/git/squash.ts

@@ -149,10 +149,12 @@ export async function squash(
       repository,
       todoPath,
       lastRetainedCommitRef,
-      MultiCommitOperationKind.Squash,
-      gitEditor,
-      progressCallback,
-      [...toSquash, squashOnto]
+      {
+        action: MultiCommitOperationKind.Squash,
+        gitEditor,
+        progressCallback,
+        commits: [...toSquash, squashOnto],
+      }
     )
   } catch (e) {
     log.error(e)

app/src/lib/hooks/config.ts

@@ -1,7 +1,7 @@
-import { enableHooksEnvironment } from '../feature-flag'
+import { enableHooksByDefault, enableHooksEnvironment } from '../feature-flag'
 import { getBoolean, setBoolean } from '../local-storage'
 
-export const defaultHooksEnvEnabledValue = false
+export const defaultHooksEnvEnabledValue = enableHooksByDefault()
 
 /**
  * Whether the hooks environment is enabled, takes into account the

app/src/lib/stores/app-store.ts

@@ -6125,12 +6125,9 @@ export class AppStore extends TypedBaseStore<IAppState> {
 
     const gitStore = this.gitStoreCache.get(repository)
     const result = await gitStore.performFailableOperation(() =>
-      continueRebase(
-        repository,
-        workingDirectory.files,
-        manualResolutions,
-        progressCallback
-      )
+      continueRebase(repository, workingDirectory.files, manualResolutions, {
+        progressCallback,
+      })
     )
 
     return result || RebaseResult.Error

app/test/unit/git/rebase/progress-test.ts

@@ -187,7 +187,7 @@ describe('git/rebase', () => {
 async function resolveAndContinue(
   repository: Repository,
   strategy: ManualConflictResolution,
-  progressCb: (progress: IMultiCommitOperationProgress) => void
+  progressCallback: (progress: IMultiCommitOperationProgress) => void
 ) {
   const status = await getStatus(repository)
   const files = status?.workingDirectory.files ?? []
@@ -199,5 +199,7 @@ async function resolveAndContinue(
     }
   }
 
-  return continueRebase(repository, files, resolutions, progressCb)
+  return continueRebase(repository, files, resolutions, {
+    progressCallback,
+  })
 }