mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-11-09 22:24:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Iván Ovejero 2024-05-29 10:21:21 +02:00 committed by GitHub
parent ec0373f666
commit dbaac82f79
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 65 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
packages/cli/src/environments/sourceControl/sourceControlGit.service.ee.ts
View file

@ -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}`);
@ -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();
@ -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)');

39
packages/cli/test/unit/GitService.test.ts Normal file
View file

@ -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']);
});
});
});
});