Properly handle Git worktrees

ecraig12345 · ecraig12345 · commit fe295eb46cc4 · 2018-12-12T17:22:58.000-08:00
diff --git a/apps/rush-lib/package.json b/apps/rush-lib/package.json
@@ -30,7 +30,7 @@
     "@yarnpkg/lockfile": "~1.0.2",
     "builtins": "~1.0.3",
     "colors": "~1.2.1",
-    "git-repo-info": "~1.1.4",
+    "git-repo-info": "~2.1.0",
     "glob": "~7.0.5",
     "glob-escape": "~0.0.1",
     "https-proxy-agent": "~2.2.1",
diff --git a/apps/rush-lib/src/api/ChangeFile.ts b/apps/rush-lib/src/api/ChangeFile.ts
@@ -2,7 +2,6 @@
 // See LICENSE in the project root for license information.
 
 import * as path from 'path';
-import gitInfo = require('git-repo-info');
 
 import { JsonFile } from '@microsoft/node-core-library';
 
@@ -11,6 +10,7 @@ import {
   IChangeFile,
   IChangeInfo
 } from './ChangeManagement';
+import { Git } from '../logic/Git';
 
 /**
  * This class represents a single change file.
@@ -81,7 +81,7 @@ export class ChangeFile {
   public generatePath(): string {
     let branch: string | undefined = undefined;
     try {
-      branch = gitInfo().branch;
+      branch = Git.getGitInfo()!.branch;
     } catch (error) {
       console.log('Could not automatically detect git branch name, using timestamp instead.');
     }
diff --git a/apps/rush-lib/src/logic/Git.ts b/apps/rush-lib/src/logic/Git.ts
@@ -3,6 +3,7 @@
 
 import gitInfo = require('git-repo-info');
 import * as os from 'os';
+import * as path from 'path';
 import { Executable } from '@microsoft/node-core-library';
 
 import { Utilities } from '../utilities/Utilities';
@@ -18,6 +19,8 @@ interface IResultOrError<TResult> {
 export class Git {
   private static _checkedGitPath: boolean = false;
   private static _gitPath: string | undefined;
+  private static _checkedGitInfo: boolean = false;
+  private static _gitInfo: gitInfo.GitRepoInfo | undefined;
 
   private static _gitEmailResult: IResultOrError<string> | undefined = undefined;
 
@@ -42,11 +45,16 @@ export class Git {
 
   /**
    * Returns true if the Git binary was found and the current path is under a Git working tree.
+   * @param repoInfo - If provided, do the check based on this Git repo info. If not provided,
+   * the result of `Git.getGitInfo()` is used.
    */
-  public static isPathUnderGitWorkingTree(): boolean {
+  public static isPathUnderGitWorkingTree(repoInfo?: gitInfo.GitRepoInfo): boolean {
     if (Git.isGitPresent()) { // Do we even have a Git binary?
       try {
-        return !!gitInfo().sha;
+        if (!repoInfo) {
+          repoInfo = Git.getGitInfo();
+        }
+        return !!repoInfo!.sha;
       } catch (e) {
         return false; // Unexpected, but possible if the .git directory is corrupted.
       }
@@ -104,6 +112,37 @@ export class Git {
     return emailResult.result;
   }
 
+  /**
+   * Get the folder where Git hooks should go for the current working tree.
+   * Returns undefined if the current path is not under a Git working tree.
+   */
+  public static getHooksFolder(): string | undefined {
+    const repoInfo: gitInfo.GitRepoInfo | undefined = Git.getGitInfo();
+    if (repoInfo && repoInfo.worktreeGitDir) {
+      return path.join(repoInfo.worktreeGitDir, 'hooks');
+    }
+    return undefined;
+  }
+
+  /**
+   * Get information about the current Git working tree.
+   * Returns undefined if the current path is not under a Git working tree.
+   */
+  public static getGitInfo(): Readonly<gitInfo.GitRepoInfo> | undefined {
+    if (!Git._checkedGitInfo) {
+      try {
+        const repoInfo: gitInfo.GitRepoInfo = gitInfo();
+        if (Git.isPathUnderGitWorkingTree(repoInfo)) {
+          Git._gitInfo = repoInfo;
+        }
+      } catch (ex) {
+        // ignore
+      }
+      Git._checkedGitInfo = true;
+    }
+    return Git._gitInfo;
+  }
+
   private static _tryGetGitEmail(): IResultOrError<string> {
     if (Git._gitEmailResult === undefined) {
       if (!Git.isGitPresent()) {
diff --git a/apps/rush-lib/src/logic/InstallManager.ts b/apps/rush-lib/src/logic/InstallManager.ts
@@ -20,7 +20,6 @@ import {
   FileSystem,
   FileConstants,
   Sort,
-  FolderConstants,
   PosixModeBits
 } from '@microsoft/node-core-library';
 
@@ -30,6 +29,7 @@ import { BaseLinkManager } from '../logic/base/BaseLinkManager';
 import { BaseShrinkwrapFile } from '../logic/base/BaseShrinkwrapFile';
 import { PolicyValidator } from '../logic/policy/PolicyValidator';
 import { IRushTempPackageJson } from '../logic/base/BasePackage';
+import { Git } from '../logic/Git';
 import { LastInstallFlag } from '../api/LastInstallFlag';
 import { LinkManagerFactory } from '../logic/LinkManagerFactory';
 import { PurgeManager } from './PurgeManager';
@@ -272,9 +272,9 @@ export class InstallManager {
 
       // Git hooks are only installed if the repo opts in by including files in /common/git-hooks
       const hookSource: string = path.join(this._rushConfiguration.commonFolder, 'git-hooks');
-      const hookDestination: string = path.join(this._rushConfiguration.rushJsonFolder, FolderConstants.Git, 'hooks');
+      const hookDestination: string | undefined = Git.getHooksFolder();
 
-      if (FileSystem.exists(hookSource)) {
+      if (FileSystem.exists(hookSource) && hookDestination) {
         const hookFilenames: Array<string> = FileSystem.readFolder(hookSource);
         if (hookFilenames.length > 0) {
           console.log(os.EOL + colors.bold('Found files in the "common/git-hooks" folder.'));
diff --git a/apps/rush-lib/typings/git-repo-info/git-repo-info.d.ts b/apps/rush-lib/typings/git-repo-info/git-repo-info.d.ts
diff --git a/apps/rush-lib/typings/tsd.d.ts b/apps/rush-lib/typings/tsd.d.ts
@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-/// <reference path="git-repo-info/git-repo-info.d.ts" />
 /// <reference path="builtins/builtins.d.ts" />
 /// <reference path="glob-escape/glob-escape.d.ts" />
 /// <reference path="npm-package-arg/npm-package-arg.d.ts" />
diff --git a/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json b/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.0.3",
+    "toolVersion": "7.0.4",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/common/changes/@microsoft/rush/git-worktrees_2018-12-13-01-22.json b/common/changes/@microsoft/rush/git-worktrees_2018-12-13-01-22.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Properly handle Git worktrees",
+      "packageName": "@microsoft/rush",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "ecraig12345@users.noreply.github.com"
+}
diff --git a/common/config/rush/shrinkwrap.yaml b/common/config/rush/shrinkwrap.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"metadata": {`
`3`	`3`	`"toolPackage": "@microsoft/api-extractor",`
`4`		`- "toolVersion": "7.0.3",`
	`4`	`+ "toolVersion": "7.0.4",`
`5`	`5`	`"schemaVersion": 1000`
`6`	`6`	`},`
`7`	`7`	`"kind": "Package",`