feat: Version control mvp (#6271)

* implement basic git service

* cleanup connected prop

* add skeleton of git functions

* initial import/export setup

* split out export service

* refactor and improve export

* begin import

* more commands and basic import

* clean up imports with transactions

* work folder import functions

* reintroduce versionid

* add missing import to pull workfolder

* add get-status endpoint

* add cleanup to disconnect

* add initRepo options

* add more checks and cleanup

* minor cleanup

* refactor prefs

* fix server.ts

* fix sending deleted files

* rename files to ee

* add variable override and fix critical cred import bug

* fix mkdir race condition

* make initRepo default to true

* fix front back integration

* improve connect flow

* add comment to generated ssh key

* fix(editor): use useToast composable

* fix buttons size

* commenting out repo init for now

* fix(editor): update UI logic

* fix(editor): remove console.log

* fix(editor): remove unused ref

* adjust endpoints for improved UI

* fix(editor): add push and pull buttons

* keep or not ssh key

* switching file name to id

* fix(editor): add success messages, fix save button

* fixed faulty diff preventing pull

* fix build

* fix(editor): adding loader to VC components

* removing duplicate exports

* improve conflict finding on push pull

* manage pull conflict

* alternate push pull

* fix pull confirmation

* fix rm and credential export/import

* switch to alternative pull implementation

* fix initial commit

* fix(editor): subscribing to VC store action to refresh lists

* fix(editor): wrap VC store actions with try

* feat: add fine-grained file selection for push action

* fix: close modal after successful push

* fix(editor): VC preferences validation

* fix confirm

* fix: update endpoint to /get-status

* feat: update pull modal override changes message

* fix missing wf error

* undo

* removing connect endpoint

* fix(editor): add button titles

* fix(editor): cleaning up store action

* add version-control/set-read-only protection

* fix(editor): adding set branch readonly

* fix(editor): remove Push button if branch set to readonly

* fix(editor): fix some styles

* fix(editor): remove duplicate and delete actions in WF list when branch is readonly

* fix: load status before opening selective push modal

* fix(editor): extend readonly logic

* add cleanup after failed initRepo

* fix deleted files crashing get-status

* fix n8n-checkbox in staging dialog

* fix(editor): fix loading

* fix(editor): resize buttons

* fix(editor): fix translation

* fix(editor): fix copy text size

* fix(editor): fix copy text size

* fix(editor): add disconnection confirmation

* fix(editor): add disconnection confirmation

* fix(editor): set large buttons

* add public api Pull endpoint

* feat: add refresh ssh key

* return prefs when new keys are generated

* fix(editor): adding readOnly mode to main header

* fix(editor): adding readOnly mode to workflow settings

* improve credential owner import

* add middleware to endpoints

* improve public api error/doc

* do not create branch if one already exists

* update wordings for connect toasts

* fix(editor): updating and separating readonly modes

* fix(editor): fix readonly mode in WF list

* fix(editor): disable elements dragging on canvas in readonly mode (WIP: not working when NodeView page is loaded first)

* fix(editor): fix canvas draggables in readonly env

* fix(editor): remove unused variables

* fix(editor): hide actions in node connections when readonly

* fix(editor): hide actions in node connections when readonly

* fix(editor): disable Save button when readonly

* fix(editor): disable Save settings if no branch is selected

* fix(editor): lint fix

* fix(editor): update snapshots

* fix(editor): replace Loading... text

* fix(editor): reset Loading... text

* reset branchname on disconnect

* fix(editor): adding some translations

* fix(editor): fix unit test

* fix(editor): fix loading

* fix(editor): set settings saved message

* fix(editor): update connection flag

* fix branchName not returning after connect

* temporary (but still breaking) fix for postgres

* fix(editor): adding tooltip to Push/Pull buttons when they're collapsed

* fix(editor): enabled activator in readonly mode

* fix test

* fix(editor): disabling new item addition for workflows in readonly mode

* fix(editor): modify Pull/Push button tooltips

* do not commit empty variables file

---------

Co-authored-by: Michael Auerswald <michael.auerswald@gmail.com>
Co-authored-by: Romain Minaud <romain.minaud@gmail.com>
Co-authored-by: Alex Grozav <alex@grozav.com>

packages/editor-ui/src/utils/__tests__/userUtils.test.ts

@@ -2,8 +2,7 @@ import { beforeAll } from 'vitest';
 import { setActivePinia, createPinia } from 'pinia';
 import { merge } from 'lodash-es';
 import { isAuthorized } from '@/utils';
-import { useSettingsStore } from '@/stores/settings.store';
-import { useSSOStore } from '@/stores/sso.store';
+import { useSettingsStore, useSSOStore } from '@/stores';
 import type { IUser } from '@/Interface';
 import { routes } from '@/router';
 import { VIEWS } from '@/constants';

packages/editor-ui/src/utils/__tests__/versionControlUtils.test.ts

@@ -0,0 +1,56 @@
+import type { VersionControlStatus } from '@/Interface';
+import { beforeEach } from 'vitest';
+import { aggregateVersionControlFiles } from '@/utils';
+
+describe('versionControlUtils', () => {
+	describe('aggregateVersionControlFiles()', () => {
+		let status: VersionControlStatus;
+
+		beforeEach(() => {
+			status = {
+				ahead: 0,
+				behind: 0,
+				conflicted: [],
+				created: [],
+				current: 'main',
+				deleted: [],
+				detached: false,
+				files: [],
+				modified: [],
+				not_added: [],
+				renamed: [],
+				staged: [],
+				tracking: null,
+			};
+		});
+
+		it('should be empty array if no files', () => {
+			expect(aggregateVersionControlFiles(status)).toEqual([]);
+		});
+
+		it('should contain list of conflicted, created, deleted, modified, and renamed files', () => {
+			status.files = [
+				{ path: 'conflicted.json', index: 'A', working_dir: '' },
+				{ path: 'created.json', index: 'A', working_dir: '' },
+				{ path: 'deleted.json', index: 'A', working_dir: '' },
+				{ path: 'modified.json', index: 'A', working_dir: '' },
+				{ path: 'renamed.json', index: 'A', working_dir: '' },
+			];
+
+			status.conflicted.push('conflicted.json');
+			status.created.push('created.json');
+			status.deleted.push('deleted.json');
+			status.modified.push('modified.json');
+			status.renamed.push('renamed.json');
+			status.staged = status.files.map((file) => file.path);
+
+			expect(aggregateVersionControlFiles(status)).toEqual([
+				{ path: 'conflicted.json', status: 'conflicted', staged: true },
+				{ path: 'created.json', status: 'created', staged: true },
+				{ path: 'deleted.json', status: 'deleted', staged: true },
+				{ path: 'modified.json', status: 'modified', staged: true },
+				{ path: 'renamed.json', status: 'renamed', staged: true },
+			]);
+		});
+	});
+});

packages/editor-ui/src/utils/index.ts

@@ -8,3 +8,4 @@ export * from './pairedItemUtils';
 export * from './typeGuards';
 export * from './typesUtils';
 export * from './userUtils';
+export * from './versionControlUtils';

packages/editor-ui/src/utils/versionControlUtils.ts

@@ -0,0 +1,27 @@
+import type { VersionControlAggregatedFile, VersionControlStatus } from '@/Interface';
+
+export function aggregateVersionControlFiles(versionControlStatus: VersionControlStatus) {
+	return versionControlStatus.files.reduce<VersionControlAggregatedFile[]>((acc, file) => {
+		const staged = versionControlStatus.staged.includes(file.path);
+
+		let status = '';
+		(
+			['conflicted', 'created', 'deleted', 'modified', 'renamed'] as Array<
+				keyof VersionControlStatus
+			>
+		).forEach((key) => {
+			const filesForStatus = versionControlStatus[key] as string[];
+			if (filesForStatus.includes(file.path)) {
+				status = key;
+			}
+		});
+
+		acc.push({
+			path: file.path,
+			status,
+			staged,
+		});
+
+		return acc;
+	}, []);
+}