[cli] Add git metadata to vc deploy (vercel#7910)

Currently, git metadata is not included on the Vercel dashboard when a project is deployed via the CLI. This PR populates the git metadata.

### 📋 Checklist

<!--
  Please keep your PR as a Draft until the checklist is complete
-->

#### Tests

- [x] The code changed/added as part of this PR has been covered with tests
- [x] All tests pass locally with `yarn test-unit`

#### Code Review

- [ ] This PR has a concise title and thorough description useful to a reviewer
- [ ] Issue from task tracker has a link to this PR

Author: MatthewStanciu

.gitattributes

@@ -8,3 +8,7 @@ packages/*/test/* linguist-vendored
 # Go build fails with Windows line endings.
 *.go text eol=lf
 go.mod text eol=lf
+
+# Mark certain files as "binary" -- hide diffs
+**/test/fixtures/**/git/**/* binary
+**/test/fixtures/**/git/**/* linguist-generated

packages/cli/package.json

@@ -71,6 +71,7 @@
     "@types/fs-extra": "9.0.13",
     "@types/glob": "7.1.1",
     "@types/http-proxy": "1.16.2",
+    "@types/ini": "1.3.31",
     "@types/inquirer": "7.3.1",
     "@types/jest": "27.4.1",
     "@types/jest-expect-message": "1.0.3",
@@ -130,8 +131,10 @@
     "fast-deep-equal": "3.1.3",
     "fs-extra": "10.0.0",
     "get-port": "5.1.1",
+    "git-last-commit": "1.0.1",
     "glob": "7.1.2",
     "http-proxy": "1.18.1",
+    "ini": "3.0.0",
     "inquirer": "7.0.4",
     "is-docker": "2.2.1",
     "is-port-reachable": "3.0.0",

packages/cli/src/commands/deploy/index.ts

@@ -65,6 +65,7 @@ import { help } from './args';
 import { getDeploymentChecks } from '../../util/deploy/get-deployment-checks';
 import parseTarget from '../../util/deploy/parse-target';
 import getPrebuiltJson from '../../util/deploy/get-prebuilt-json';
+import { createGitMeta } from '../../util/deploy/create-git-meta';
 
 export default async (client: Client) => {
   const { output } = client;
@@ -417,6 +418,8 @@ export default async (client: Client) => {
     parseMeta(argv['--meta'])
   );
 
+  const gitMetadata = await createGitMeta(path, output);
+
   // Merge dotenv config, `env` from vercel.json, and `--env` / `-e` arguments
   const deploymentEnv = Object.assign(
     {},
@@ -479,6 +482,7 @@ export default async (client: Client) => {
       nowConfig: localConfig,
       regions,
       meta,
+      gitMetadata,
       deployStamp,
       target,
       skipAutoDetectionConfirmation: autoConfirm,

packages/cli/src/types.ts

@@ -296,6 +296,15 @@ export interface Token {
   teamId?: string;
 }
 
+export interface GitMetadata {
+  commitAuthorName?: string | undefined;
+  commitMessage?: string | undefined;
+  commitRef?: string | undefined;
+  commitSha?: string | undefined;
+  dirty?: boolean | undefined;
+  remoteUrl: string;
+}
+
 /**
  * An object representing a Build on Vercel
  */

packages/cli/src/util/deploy/create-git-meta.ts

@@ -0,0 +1,79 @@
+import fs from 'fs-extra';
+import { join } from 'path';
+import ini from 'ini';
+import git from 'git-last-commit';
+import { exec } from 'child_process';
+import { GitMetadata } from '../../types';
+import { Output } from '../output';
+
+export function isDirty(directory: string): Promise<boolean> {
+  return new Promise((resolve, reject) => {
+    exec('git status -s', { cwd: directory }, function (err, stdout, stderr) {
+      if (err) return reject(err);
+      if (stderr)
+        return reject(
+          new Error(
+            `Failed to determine if git repo has been modified: ${stderr.trim()}`
+          )
+        );
+      resolve(stdout.trim().length > 0);
+    });
+  });
+}
+
+function getLastCommit(directory: string): Promise<git.Commit> {
+  return new Promise((resolve, reject) => {
+    git.getLastCommit(
+      (err, commit) => {
+        if (err) return reject(err);
+        resolve(commit);
+      },
+      { dst: directory }
+    );
+  });
+}
+
+export async function getRemoteUrl(
+  configPath: string,
+  output: Output
+): Promise<string | null> {
+  let gitConfig;
+  try {
+    gitConfig = ini.parse(await fs.readFile(configPath, 'utf-8'));
+  } catch (error) {
+    output.debug(`Error while parsing repo data: ${error.message}`);
+  }
+  if (!gitConfig) {
+    return null;
+  }
+
+  const originUrl: string = gitConfig['remote "origin"']?.url;
+  if (originUrl) {
+    return originUrl;
+  }
+  return null;
+}
+
+export async function createGitMeta(
+  directory: string,
+  output: Output
+): Promise<GitMetadata | undefined> {
+  const remoteUrl = await getRemoteUrl(join(directory, '.git/config'), output);
+  // If we can't get the repo URL, then don't return any metadata
+  if (!remoteUrl) {
+    return;
+  }
+  const [commit, dirty] = await Promise.all([
+    getLastCommit(directory),
+    isDirty(directory),
+  ]);
+
+  return {
+    remoteUrl,
+    commitAuthorName: commit.author.name,
+    commitMessage: commit.subject,
+    commitRef: commit.branch,
+    commitSha: commit.hash,
+    dirty,
+  };
+}

packages/cli/src/util/index.ts

@@ -14,7 +14,7 @@ import { responseError } from './error';
 import stamp from './output/stamp';
 import { APIError, BuildError } from './errors-ts';
 import printIndications from './print-indications';
-import { Org } from '../types';
+import { GitMetadata, Org } from '../types';
 import { VercelConfig } from './dev/types';
 import Client, { FetchOptions, isJSONObject } from './client';
 import { Dictionary } from '@vercel/client';
@@ -38,6 +38,7 @@ export interface CreateOptions {
   prebuilt?: boolean;
   rootDirectory?: string;
   meta: Dictionary<string>;
+  gitMetadata?: GitMetadata;
   regions?: string[];
   quiet?: boolean;
   env: Dictionary<string>;
@@ -116,6 +117,7 @@ export default class Now extends EventEmitter {
       rootDirectory,
       wantsPublic,
       meta,
+      gitMetadata,
       regions,
       quiet = false,
       env,
@@ -142,6 +144,7 @@ export default class Now extends EventEmitter {
       name,
       project,
       meta,
+      gitMetadata,
       regions,
       target: target || undefined,
       projectSettings,

packages/cli/src/util/output/create-output.ts

@@ -16,7 +16,7 @@ export interface LogOptions extends PrintOptions {
 }
 
 export class Output {
-  private debugEnabled: boolean;
+  debugEnabled: boolean;
   private spinnerMessage: string;
   private _spinner: StopSpinner | null;
   isTTY: boolean;