git-stack-cli 2.7.0 → 2.7.2

package/src/core/Metadata.test.ts

@@ -17,6 +17,7 @@ test("read handles bulleted lists", () => {
   const metadata = Metadata.read(body);
 
   expect(metadata).toEqual({
+    subject: "[feat] implement various features",
     id: "DdKIFyufW",
     title: "saved group title",
   });
@@ -63,6 +64,7 @@ test("read handles slashes in branch name", () => {
   const metadata = Metadata.read(body);
 
   expect(metadata).toEqual({
+    subject: "[fix] slash in branch name",
     id: "dev/noah/fix-slash-branch",
     title: "fix slash branch",
   });
@@ -109,6 +111,7 @@ test("read handles double quotes", () => {
   const metadata = Metadata.read(body);
 
   expect(metadata).toEqual({
+    subject: 'Revert "[abc / 123] subject (#1234)"',
     id: "dev/noah/fix-slash-branch",
     title: 'Revert \\"[abc / 123] subject (#1234)\\"',
   });

package/src/core/Metadata.ts

@@ -6,6 +6,7 @@ type InputMetadataValues = {
 };
 
 type OutputMetadataValues = {
+  subject: null | string;
   id: null | string;
   title: null | string;
 };
@@ -28,7 +29,14 @@ export function write(message: string, values: InputMetadataValues) {
 }
 
 export function read(message: string): OutputMetadataValues {
-  const values: OutputMetadataValues = { id: null, title: null };
+  const values: OutputMetadataValues = { subject: null, id: null, title: null };
+
+  const match_subject = message.match(RE.subject_line);
+
+  if (match_subject?.groups) {
+    values.subject = match_subject.groups["subject"];
+    invariant(values.subject, "subject must exist");
+  }
 
   const match_id = message.match(RE.stack_id);
 
@@ -69,6 +77,8 @@ const TEMPLATE = {
 };
 
 const RE = {
+  // https://regex101.com/r/pOrChS/1
+  subject_line: /^(?<subject>[^\n]*)/,
   // https://regex101.com/r/wLmGVq/1
   stack_id: new RegExp(`${TEMPLATE.stack_id("(?<id>[^\\s]+)")}`, "i"),
   group_title: new RegExp(TEMPLATE.group_title("(?<title>[^\\n^\\r]+)"), "i"),

package/src/core/__snapshots__/git.test.ts.snap

@@ -0,0 +1,95 @@
+// Bun Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`get_commits ABC..DEF: 
+[
+  {
+    "branch_id": null,
+    "full_message": "homebrew-git-stack 2.7.1",
+    "sha": "ba067f8ad641dda7e65e3c2acb2421c955843829",
+    "subject_line": "homebrew-git-stack 2.7.1",
+    "title": null,
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqhd033n6y5",
+    "full_message":
+"Rebase: debug logs
+
+git-stack-id: noah/paint-test---4gwpqhd033n6y5
+git-stack-title: Rebase: debug logs"
+,
+    "sha": "7c8da9f5fe681fc7459a0e737241df631983cd3c",
+    "subject_line": "Rebase: debug logs",
+    "title": "Rebase: debug logs",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqirewoudxa",
+    "full_message":
+"CommitMetadata: track last group id
+
+git-stack-id: noah/paint-test---4gwpqirewoudxa
+git-stack-title: CommitMetadata: track last group id"
+,
+    "sha": "47a69d37f8c5cc796884a91fa9e93fc1db5297dd",
+    "subject_line": "CommitMetadata: track last group id",
+    "title": "CommitMetadata: track last group id",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqjcpu7-isv",
+    "full_message":
+"Github: pr_list duration timer
+
+git-stack-id: noah/paint-test---4gwpqjcpu7-isv
+git-stack-title: Github: pr_list duration timer"
+,
+    "sha": "8ccf42a7c72aa194fafc7c326f5874f5a0a009c6",
+    "subject_line": "Github: pr_list duration timer",
+    "title": "Github: pr_list duration timer",
+  },
+]
+ 1`] = `
+[
+  {
+    "branch_id": null,
+    "full_message": "homebrew-git-stack 2.7.1",
+    "sha": "ba067f8ad641dda7e65e3c2acb2421c955843829",
+    "subject_line": "homebrew-git-stack 2.7.1",
+    "title": null,
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqhd033n6y5",
+    "full_message": 
+"Rebase: debug logs
+
+git-stack-id: noah/paint-test---4gwpqhd033n6y5
+git-stack-title: Rebase: debug logs"
+,
+    "sha": "7c8da9f5fe681fc7459a0e737241df631983cd3c",
+    "subject_line": "Rebase: debug logs",
+    "title": "Rebase: debug logs",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqirewoudxa",
+    "full_message": 
+"CommitMetadata: track last group id
+
+git-stack-id: noah/paint-test---4gwpqirewoudxa
+git-stack-title: CommitMetadata: track last group id"
+,
+    "sha": "47a69d37f8c5cc796884a91fa9e93fc1db5297dd",
+    "subject_line": "CommitMetadata: track last group id",
+    "title": "CommitMetadata: track last group id",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqjcpu7-isv",
+    "full_message": 
+"Github: pr_list duration timer
+
+git-stack-id: noah/paint-test---4gwpqjcpu7-isv
+git-stack-title: Github: pr_list duration timer"
+,
+    "sha": "8ccf42a7c72aa194fafc7c326f5874f5a0a009c6",
+    "subject_line": "Github: pr_list duration timer",
+    "title": "Github: pr_list duration timer",
+  },
+]
+`;

package/src/core/get_timeout_fn.ts

@@ -0,0 +1,11 @@
+export function get_timeout_fn(ms: number, message: string) {
+  return function timeout<T>(promise: Promise<T>) {
+    let id: ReturnType<typeof setTimeout>;
+
+    const timeout = new Promise<never>((_resolve, reject) => {
+      id = setTimeout(() => reject(new Error(message)), ms);
+    });
+
+    return Promise.race([promise, timeout]).finally(() => clearTimeout(id));
+  };
+}

package/src/core/git.test.ts

@@ -0,0 +1,54 @@
+import { test, expect } from "bun:test";
+
+import * as git from "~/core/git";
+
+test("get_commits ABC..DEF", async () => {
+  const commits = await git.get_commits("e781ede..8ccf42a");
+  expect(commits).toMatchSnapshot(`
+[
+  {
+    "branch_id": null,
+    "full_message": "homebrew-git-stack 2.7.1",
+    "sha": "ba067f8ad641dda7e65e3c2acb2421c955843829",
+    "subject_line": "homebrew-git-stack 2.7.1",
+    "title": null,
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqhd033n6y5",
+    "full_message":
+"Rebase: debug logs
+
+git-stack-id: noah/paint-test---4gwpqhd033n6y5
+git-stack-title: Rebase: debug logs"
+,
+    "sha": "7c8da9f5fe681fc7459a0e737241df631983cd3c",
+    "subject_line": "Rebase: debug logs",
+    "title": "Rebase: debug logs",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqirewoudxa",
+    "full_message":
+"CommitMetadata: track last group id
+
+git-stack-id: noah/paint-test---4gwpqirewoudxa
+git-stack-title: CommitMetadata: track last group id"
+,
+    "sha": "47a69d37f8c5cc796884a91fa9e93fc1db5297dd",
+    "subject_line": "CommitMetadata: track last group id",
+    "title": "CommitMetadata: track last group id",
+  },
+  {
+    "branch_id": "noah/paint-test---4gwpqjcpu7-isv",
+    "full_message":
+"Github: pr_list duration timer
+
+git-stack-id: noah/paint-test---4gwpqjcpu7-isv
+git-stack-title: Github: pr_list duration timer"
+,
+    "sha": "8ccf42a7c72aa194fafc7c326f5874f5a0a009c6",
+    "subject_line": "Github: pr_list duration timer",
+    "title": "Github: pr_list duration timer",
+  },
+]
+`);
+});

package/src/core/git.ts

@@ -0,0 +1,55 @@
+import * as Metadata from "~/core/Metadata";
+import { cli } from "~/core/cli";
+
+export type Commit = Awaited<ReturnType<typeof get_commits>>[0];
+
+export async function get_commits(dot_range: string) {
+  const log_result = await cli(`git log ${dot_range} --format=${FORMAT} --color=never`);
+
+  if (!log_result.stdout) {
+    return [];
+  }
+
+  const commit_list = [];
+
+  for (let record of log_result.stdout.split(SEP.record)) {
+    record = record.replace(/^\n/, "");
+    record = record.replace(/\n$/, "");
+
+    if (!record) continue;
+
+    const [sha, full_message] = record.split(SEP.field);
+
+    const metadata = Metadata.read(full_message);
+    const branch_id = metadata.id;
+    const subject_line = metadata.subject || "";
+    const title = metadata.title;
+
+    const commit = {
+      sha,
+      full_message,
+      subject_line,
+      branch_id,
+      title,
+    };
+
+    commit_list.push(commit);
+  }
+
+  commit_list.reverse();
+
+  return commit_list;
+}
+
+// Why these separators?
+// - Rare in human written text
+// - Supported in git %xNN to write bytes
+// - Supported in javascript \xNN to write bytes
+// - Used historically as separators in unicode
+//   https://en.wikipedia.org/wiki/C0_and_C1_control_codes#Field_separators
+const SEP = {
+  record: "\x1e",
+  field: "\x1f",
+};
+
+const FORMAT = `%H${SEP.field}%B${SEP.record}`;

package/src/core/github.tsx

@@ -8,6 +8,7 @@ import * as Ink from "ink-cjs";
 
 import { Brackets } from "~/app/Brackets";
 import { Store } from "~/app/Store";
+import { Timer } from "~/core/Timer";
 import { cli } from "~/core/cli";
 import { colors } from "~/core/colors";
 import { get_tmp_dir } from "~/core/get_tmp_dir";
@@ -19,6 +20,9 @@ export async function pr_list(): Promise<Array<PullRequest>> {
   const state = Store.getState();
   const actions = state.actions;
 
+  const timer = Timer();
+  actions.debug("start github.pr_list");
+
   const username = state.username;
   const repo_path = state.repo_path;
   invariant(username, "username must exist");
@@ -53,6 +57,8 @@ export async function pr_list(): Promise<Array<PullRequest>> {
     }
   });
 
+  const duration = timer.duration();
+  actions.debug(`end github.pr_list (duration=${duration})`);
   return result_pr_list;
 }