Skip to content

feat: migrate to simple-git #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: next
Choose a base branch
from
Draft

Conversation

jcha0713
Copy link
Collaborator

This PR replaces direct git utilities with simple-git wrappers.

  • use simple-git wrapper for branch/project metadata extraction
  • add unit tests to check returning error types

This resolves #35.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @jcha0713, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors how the application interacts with Git. By migrating to the simple-git library and introducing a dedicated Git service, the codebase becomes more modular, testable, and resilient to Git-related errors. This change improves the overall stability and maintainability of the application's Git integration.

Highlights

  • Refactoring Git Interactions: Replaced direct git utility calls with the simple-git library for more robust and maintainable Git operations, centralizing all Git-related logic.
  • Improved Error Handling: Introduced custom error classes (GitError, EmptyCommitMessageError, IsNotGitRepositoryError) for better clarity and structured handling of Git-related issues.
  • Comprehensive Unit Testing: Added a new test suite using Vitest to thoroughly test the GitService methods, covering various scenarios including successful operations and specific error conditions.
  • Asynchronous Operations: Updated relevant parts of the codebase (cli.ts, branch.ts, project.ts, QueryContext.tsx) to handle the new asynchronous nature of Git operations, ensuring proper flow control.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This PR migrates git interactions to simple-git, introducing a GitService and unit tests. The review focuses on improving robustness, maintainability, and performance, including ensuring distinct error names, improving project identifiers, reducing code duplication, and adopting a singleton pattern for GitService.

export function ensureBranch(projectId: string) {
const branchMeta = getBranchMetadata(projectId);
export async function ensureBranch(projectId: string) {
const { getBranchMetadata } = createGitService();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Calling createGitService() here creates a new instance each time, re-initializing the service and its internal cache. Use a singleton pattern to ensure a single instance of the git service is reused across the application for performance and consistency.

export function ensureProject() {
const projectMeta = getProjectMetadata();
export async function ensureProject() {
const { getProjectMetadata } = createGitService();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Calling createGitService() here creates a new instance. Since this function is also called in ensureBranch, this leads to multiple instances of the service being created. Use a singleton pattern to ensure a single instance of the git service is reused across the application for performance and consistency.

Comment on lines +9 to +11
constructor(message: string) {
super(message);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For improved error identification, define the name property for EmptyCommitMessageError. This ensures the error type is correctly identified in logs and error handling.

  constructor(message: string) {
    super(message);
    this.name = "EmptyCommitMessageError";
  }

Comment on lines +14 to +16
export class IsNotGitRepositoryError extends GitError {
constructor(message: string) {
super(message);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Define the name property for IsNotGitRepositoryError to ensure correct error type identification during debugging and error handling.

Suggested change
export class IsNotGitRepositoryError extends GitError {
constructor(message: string) {
super(message);
constructor(message: string) {
super(message);
this.name = "IsNotGitRepositoryError";
}

Comment on lines +51 to +56
const isGitRepo = await checkIsRepo();
if (!isGitRepo) {
throw new IsNotGitRepositoryError(
"Current directory is not a git repository",
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The git repository check is duplicated across getProjectMetadata, getBranchMetadata, and commit. Refactor this into a private helper function within createGitService to reduce redundancy and improve maintainability.

const repoName = path.basename(repoPath);

return {
id: repoPath, // TODO: make it unique
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using repoPath as the project id is not robust as it changes if the repository is moved. Use a more stable unique identifier, such as the hash of the initial commit (git rev-list --max-parents=0 HEAD).

Comment on lines +93 to +98
const currentBranchFull = await git.raw("symbolic-ref", "HEAD");
const currentBranchShort = await git.raw(
"symbolic-ref",
"HEAD",
"--short",
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The branchSummary object from git.branchLocal() contains the current branch's short name in branchSummary.current. Use this directly instead of calling git.raw for efficiency.

      const currentBranchFull = await git.raw("symbolic-ref", "HEAD");
      const currentBranchShort = branchSummary.current;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate from child_process git commands to simple-git library
1 participant