feat: check git state equal will skip force pull

Author: linonetwo

src/commitAndSync.ts

@@ -72,16 +72,15 @@ export async function commitAndSync(options: ICommitAndSyncOptions): Promise<voi
     });
 
   // preflight check
-  const repoStartingState = await getGitRepositoryState(dir, logger);
-  if (repoStartingState.length === 0 || repoStartingState === '|DIRTY') {
-    logProgress(GitStep.PrepareSync);
-    logDebug(`${dir} repoStartingState: ${repoStartingState}, ${gitUserName} <${email ?? defaultGitInfo.email}>`, GitStep.PrepareSync);
-  } else if (repoStartingState === 'NOGIT') {
-    throw new CantSyncGitNotInitializedError(dir);
-  } else {
-    // we may be in middle of a rebase, try fix that
-    await continueRebase(dir, gitUserName, email ?? defaultGitInfo.email, logger, repoStartingState);
-  }
+  await syncPreflightCheck({
+    dir,
+    logger,
+    logProgress,
+    logDebug,
+    defaultGitInfo,
+    userInfo,
+  });
+
   if (await haveLocalChanges(dir)) {
     logProgress(GitStep.HaveThingsToCommit);
     logDebug(commitMessage, GitStep.HaveThingsToCommit);
@@ -189,3 +188,32 @@ export async function commitAndSync(options: ICommitAndSyncOptions): Promise<voi
     await credentialOff(dir, remoteUrl);
   }
 }
+
+/**
+ * Check for git repo state, if it is not clean, try fix it. If not init will throw error.
+ * This method is used by commitAndSync and forcePull before they doing anything.
+ */
+export async function syncPreflightCheck(configs: {
+  /** defaultGitInfo from ICommitAndSyncOptions */
+  defaultGitInfo?: typeof defaultDefaultGitInfo;
+  dir: string;
+  logDebug?: (message: string, step: GitStep) => unknown;
+  logProgress?: (step: GitStep) => unknown;
+  logger?: ILogger;
+  /** userInfo from ICommitAndSyncOptions */
+  userInfo?: IGitUserInfos;
+}) {
+  const { dir, logger, logProgress, logDebug, defaultGitInfo = defaultDefaultGitInfo, userInfo } = configs;
+  const { gitUserName, email } = userInfo ?? defaultGitInfo;
+
+  const repoStartingState = await getGitRepositoryState(dir, logger);
+  if (repoStartingState.length === 0 || repoStartingState === '|DIRTY') {
+    logProgress?.(GitStep.PrepareSync);
+    logDebug?.(`${dir} repoStartingState: ${repoStartingState}, ${gitUserName} <${email ?? defaultGitInfo.email}>`, GitStep.PrepareSync);
+  } else if (repoStartingState === 'NOGIT') {
+    throw new CantSyncGitNotInitializedError(dir);
+  } else {
+    // we may be in middle of a rebase, try fix that
+    await continueRebase(dir, gitUserName, email ?? defaultGitInfo.email, logger, repoStartingState);
+  }
+}

src/forcePull.ts

@@ -1,8 +1,9 @@
 import { GitProcess } from 'dugite';
+import { syncPreflightCheck } from './commitAndSync';
 import { credentialOff, credentialOn } from './credential';
 import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
 import { CantForcePullError, SyncParameterMissingError } from './errors';
-import { getDefaultBranchName, getRemoteName } from './inspect';
+import { getDefaultBranchName, getRemoteName, getSyncState } from './inspect';
 import { GitStep, IGitUserInfos, ILogger } from './interface';
 import { fetchRemote } from './sync';
 
@@ -58,12 +59,28 @@ export async function forcePull(options: IForcePullOptions) {
     });
 
   logProgress(GitStep.StartForcePull);
-  logDebug(`Successfully Running git init for force pull in dir ${dir}`, GitStep.StartForcePull);
+  logDebug(`Do preflight Check before force pull in dir ${dir}`, GitStep.StartForcePull);
+  // preflight check
+  await syncPreflightCheck({
+    dir,
+    logger,
+    logProgress,
+    logDebug,
+    defaultGitInfo,
+    userInfo,
+  });
   logProgress(GitStep.StartConfiguringGithubRemoteRepository);
   await credentialOn(dir, remoteUrl, gitUserName, accessToken, remoteName);
   try {
     logProgress(GitStep.StartFetchingFromGithubRemote);
     await fetchRemote(dir, defaultGitInfo.remote, defaultGitInfo.branch);
+    const syncState = await getSyncState(dir, defaultBranchName, remoteName, logger);
+    logDebug(`syncState in dir ${dir} is ${syncState}`, GitStep.StartFetchingFromGithubRemote);
+    if (syncState === 'equal') {
+      // if there is no new commit in remote (and nothing messy in local), we don't need to pull.
+      logProgress(GitStep.SkipForcePull);
+      return;
+    }
     logProgress(GitStep.StartResettingLocalToRemote);
     await hardResetLocalToRemote(dir, branch, remoteName);
     logProgress(GitStep.FinishForcePull);

src/interface.ts

@@ -60,6 +60,7 @@ export enum GitStep {
   RebaseConflictNeedsResolve = 'RebaseConflictNeedsResolve',
   RebaseResultChecking = 'RebaseResultChecking',
   RebaseSucceed = 'RebaseSucceed',
+  SkipForcePull = 'SkipForcePull',
   StartBackupToGitRemote = 'StartBackupToGitRemote',
   StartConfiguringGithubRemoteRepository = 'StartConfiguringGithubRemoteRepository',
   StartFetchingFromGithubRemote = 'StartFetchingFromGithubRemote',