Skip to content
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

fix(core): Set source control repository to track remote if ready #9532

Merged
merged 1 commit into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ export class SourceControlGitService {
}
try {
await this.git.addRemote(SOURCE_CONTROL_ORIGIN, sourceControlPreferences.repositoryUrl);
this.logger.debug(`Git remote added: ${sourceControlPreferences.repositoryUrl}`);
} catch (error) {
if ((error as Error).message.includes('remote origin already exists')) {
this.logger.debug(`Git remote already exists: ${(error as Error).message}`);
Expand All @@ -189,6 +190,9 @@ export class SourceControlGitService {
: SOURCE_CONTROL_DEFAULT_NAME,
user.email ?? SOURCE_CONTROL_DEFAULT_EMAIL,
);

await this.trackRemoteIfReady(sourceControlPreferences.branchName);

if (sourceControlPreferences.initRepo) {
try {
const branches = await this.getBranches();
Expand All @@ -201,6 +205,28 @@ export class SourceControlGitService {
}
}

/**
* If this is a new local repository being set up after remote is ready,
* then set this local to start tracking remote's target branch.
*/
private async trackRemoteIfReady(targetBranch: string) {
if (!this.git) return;

await this.fetch();

const { currentBranch, branches: remoteBranches } = await this.getBranches();

if (!currentBranch && remoteBranches.some((b) => b === targetBranch)) {
await this.git.checkout(targetBranch);

const upstream = [SOURCE_CONTROL_ORIGIN, targetBranch].join('/');

await this.git.branch([`--set-upstream-to=${upstream}`, targetBranch]);

this.logger.info('Set local git repository to track remote', { upstream });
}
}

async setGitUserDetails(name: string, email: string): Promise<void> {
if (!this.git) {
throw new ApplicationError('Git is not initialized (setGitUserDetails)');
Expand Down
39 changes: 39 additions & 0 deletions packages/cli/test/unit/GitService.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { SourceControlGitService } from '@/environments/sourceControl/sourceControlGit.service.ee';
import { mock } from 'jest-mock-extended';
import type { SourceControlPreferences } from '@/environments/sourceControl/types/sourceControlPreferences';
import type { User } from '@/databases/entities/User';
import type { SimpleGit } from 'simple-git';

describe('GitService', () => {
describe('initRepository', () => {
describe('when local repo is set up after remote is ready', () => {
it('should track remote', async () => {
/**
* Arrange
*/
const gitService = new SourceControlGitService(mock(), mock(), mock());
const prefs = mock<SourceControlPreferences>({ branchName: 'main' });
const user = mock<User>();
const git = mock<SimpleGit>();
const checkoutSpy = jest.spyOn(git, 'checkout');
const branchSpy = jest.spyOn(git, 'branch');
gitService.git = git;
jest.spyOn(gitService, 'setGitSshCommand').mockResolvedValue();
jest
.spyOn(gitService, 'getBranches')
.mockResolvedValue({ currentBranch: '', branches: ['main'] });

/**
* Act
*/
await gitService.initRepository(prefs, user);

/**
* Assert
*/
expect(checkoutSpy).toHaveBeenCalledWith('main');
expect(branchSpy).toHaveBeenCalledWith(['--set-upstream-to=origin/main', 'main']);
});
});
});
});
Loading