Skip to content

Commit

Permalink
fix(editor): Adding branch color (#6380)
Browse files Browse the repository at this point in the history 
* fix(editor): Adding branch color

* fix(editor): backend refactor preferences update

* fix(editor): frontend refactor preferences update
  • Loading branch information
@cstuncsik
cstuncsik authored Jun 6, 2023
1 parent e95e8de commit dba3f44
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 110 deletions.
6 changes: 3 additions & 3 deletions packages/cli/src/environments/versionControl/types/versionControlPreferences.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ export class VersionControlPreferences {
): VersionControlPreferences {
return new VersionControlPreferences({
connected: preferences.connected ?? defaultPreferences.connected,
authorEmail: preferences.authorEmail ?? defaultPreferences.authorEmail,
repositoryUrl: preferences.repositoryUrl ?? defaultPreferences.repositoryUrl,
authorName: preferences.authorName ?? defaultPreferences.authorName,
authorEmail: preferences.authorEmail ?? defaultPreferences.authorEmail,
branchName: preferences.branchName ?? defaultPreferences.branchName,
branchColor: preferences.branchColor ?? defaultPreferences.branchColor,
branchReadOnly: preferences.branchReadOnly ?? defaultPreferences.branchReadOnly,
repositoryUrl: preferences.repositoryUrl ?? defaultPreferences.repositoryUrl,
branchColor: preferences.branchColor ?? defaultPreferences.branchColor,
});
}
}
46 changes: 32 additions & 14 deletions packages/cli/src/environments/versionControl/versionControl.controller.ee.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Authorized, Get, Post, RestController } from '@/decorators';
import { Authorized, Get, Post, Patch, RestController } from '@/decorators';
import {
versionControlLicensedMiddleware,
versionControlLicensedAndEnabledMiddleware,
Expand Down Expand Up @@ -83,10 +83,38 @@ export class VersionControlController {
}

@Authorized(['global', 'owner'])
@Post('/set-read-only', { middlewares: [versionControlLicensedMiddleware] })
async setReadOnly(req: VersionControlRequest.SetReadOnly) {
@Patch('/preferences', { middlewares: [versionControlLicensedMiddleware] })
async updatePreferences(req: VersionControlRequest.UpdatePreferences) {
try {
this.versionControlPreferencesService.setBranchReadOnly(req.body.branchReadOnly);
const sanitizedPreferences: Partial<VersionControlPreferences> = {
...req.body,
initRepo: false,
connected: undefined,
publicKey: undefined,
repositoryUrl: undefined,
authorName: undefined,
authorEmail: undefined,
};
const currentPreferences = this.versionControlPreferencesService.getPreferences();
await this.versionControlPreferencesService.validateVersionControlPreferences(
sanitizedPreferences,
);
if (
sanitizedPreferences.branchName &&
sanitizedPreferences.branchName !== currentPreferences.branchName
) {
await this.versionControlService.setBranch(sanitizedPreferences.branchName);
}
if (sanitizedPreferences.branchColor || sanitizedPreferences.branchReadOnly !== undefined) {
await this.versionControlPreferencesService.setPreferences(
{
branchColor: sanitizedPreferences.branchColor,
branchReadOnly: sanitizedPreferences.branchReadOnly,
},
true,
);
}
await this.versionControlService.init();
return this.versionControlPreferencesService.getPreferences();
} catch (error) {
throw new BadRequestError((error as { message: string }).message);
Expand All @@ -113,16 +141,6 @@ export class VersionControlController {
}
}

@Authorized(['global', 'owner'])
@Post('/set-branch', { middlewares: [versionControlLicensedMiddleware] })
async setBranch(req: VersionControlRequest.SetBranch) {
try {
return await this.versionControlService.setBranch(req.body.branch);
} catch (error) {
throw new BadRequestError((error as { message: string }).message);
}
}

@Authorized(['global', 'owner'])
@Post('/push-workfolder', { middlewares: [versionControlLicensedAndEnabledMiddleware] })
async pushWorkfolder(
Expand Down
36 changes: 1 addition & 35 deletions packages/cli/src/environments/versionControl/versionControl.service.ee.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export class VersionControlService {
async setBranch(branch: string): Promise<{ branches: string[]; currentBranch: string }> {
await this.versionControlPreferencesService.setPreferences({
branchName: branch,
connected: true,
connected: branch?.length > 0,
});
return this.gitService.setBranch(branch);
}
Expand Down Expand Up @@ -216,40 +216,6 @@ export class VersionControlService {
});
}

// async pushWorkfolder(
// options: VersionControlPushWorkFolder,
// ): Promise<PushResult | VersionControlledFile[]> {
// await this.gitService.fetch();
// await this.export(); // refresh workfolder
// await this.stage(options);
// await this.gitService.commit(options.message ?? 'Updated Workfolder');
// return this.gitService.push({
// branch: this.versionControlPreferencesService.getBranchName(),
// force: options.force ?? false,
// });
// }

// TODO: Alternate implementation for pull
// async pullWorkfolder(
// options: VersionControllPullOptions,
// ): Promise<ImportResult | VersionControlledFile[] | PullResult | undefined> {
// const diffResult = await this.getStatus();
// const possibleConflicts = diffResult?.filter((file) => file.conflict);
// if (possibleConflicts?.length > 0 || options.force === true) {
// await this.unstage();
// if (options.force === true) {
// return this.resetWorkfolder(options);
// } else {
// return diffResult;
// }
// }
// const pullResult = await this.gitService.pull();
// if (options.importAfterPull) {
// return this.import(options);
// }
// return pullResult;
// }

async pullWorkfolder(
options: VersionControllPullOptions,
): Promise<ImportResult | StatusResult | undefined> {
Expand Down
9 changes: 0 additions & 9 deletions packages/cli/src/environments/versionControl/versionControlPreferences.service.ee.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,19 +114,10 @@ export class VersionControlPreferencesService {
return this.versionControlPreferences;
}

setBranchReadOnly(branchReadOnly: boolean): void {
this._versionControlPreferences.branchReadOnly = branchReadOnly;
}

async validateVersionControlPreferences(
preferences: Partial<VersionControlPreferences>,
allowMissingProperties = true,
): Promise<ValidationError[]> {
if (this.isVersionControlConnected()) {
if (preferences.repositoryUrl !== this._versionControlPreferences.repositoryUrl) {
throw new Error('Cannot change repository while connected');
}
}
const preferencesObject = new VersionControlPreferences(preferences);
const validationResult = await validate(preferencesObject, {
forbidUnknownValues: false,
Expand Down
32 changes: 10 additions & 22 deletions packages/editor-ui/src/api/versionControl.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ import type { IDataObject } from 'n8n-workflow';

const versionControlApiRoot = '/version-control';

const createPreferencesRequestFn =
(method: 'POST' | 'PATCH') =>
async (
context: IRestApiContext,
preferences: Partial<VersionControlPreferences>,
): Promise<VersionControlPreferences> =>
makeRestApiRequest(context, method, `${versionControlApiRoot}/preferences`, preferences);

export const pushWorkfolder = async (
context: IRestApiContext,
data: IDataObject,
Expand All @@ -29,19 +37,8 @@ export const getBranches = async (
return makeRestApiRequest(context, 'GET', `${versionControlApiRoot}/get-branches`);
};

export const setBranch = async (
context: IRestApiContext,
branch: string,
): Promise<{ branches: string[]; currentBranch: string }> => {
return makeRestApiRequest(context, 'POST', `${versionControlApiRoot}/set-branch`, { branch });
};

export const setPreferences = async (
context: IRestApiContext,
preferences: Partial<VersionControlPreferences>,
): Promise<VersionControlPreferences> => {
return makeRestApiRequest(context, 'POST', `${versionControlApiRoot}/preferences`, preferences);
};
export const savePreferences = createPreferencesRequestFn('POST');
export const updatePreferences = createPreferencesRequestFn('PATCH');

export const getPreferences = async (
context: IRestApiContext,
Expand All @@ -68,15 +65,6 @@ export const disconnect = async (
});
};

export const setBranchReadonly = async (
context: IRestApiContext,
branchReadOnly: boolean,
): Promise<string> => {
return makeRestApiRequest(context, 'POST', `${versionControlApiRoot}/set-read-only`, {
branchReadOnly,
});
};

export const generateKeyPair = async (context: IRestApiContext): Promise<string> => {
return makeRestApiRequest(context, 'POST', `${versionControlApiRoot}/generate-key-pair`);
};
12 changes: 8 additions & 4 deletions packages/editor-ui/src/components/MainSidebarVersionControl.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ async function pullWorkfolder() {
</script>

<template>
<div :class="{ [$style.sync]: true, [$style.collapsed]: isCollapsed }">
<div
:class="{ [$style.sync]: true, [$style.collapsed]: isCollapsed }"
:style="{ borderLeftColor: versionControlStore.preferences.branchColor }"
>
<span>
<n8n-icon icon="code-branch" />
{{ currentBranch }}
Expand Down Expand Up @@ -128,10 +131,11 @@ async function pullWorkfolder() {

<style lang="scss" module>
.sync {
padding: var(--spacing-s) var(--spacing-s) var(--spacing-s) var(--spacing-l);
padding: var(--spacing-s) var(--spacing-s) var(--spacing-s) var(--spacing-m);
margin: 0 calc(var(--spacing-l) * -1) calc(var(--spacing-m) * -1);
background: var(--color-background-light);
border-top: 1px solid var(--color-foreground-light);
border-top: var(--border-width-base) var(--border-style-base) var(--color-foreground-base);
border-left: var(--spacing-3xs) var(--border-style-base) var(--color-foreground-base);
font-size: var(--font-size-2xs);
span {
Expand All @@ -145,7 +149,7 @@ async function pullWorkfolder() {
.collapsed {
text-align: center;
margin-left: calc(var(--spacing-xl) * -1);
padding-left: var(--spacing-xs);
> span {
display: none;
Expand Down
24 changes: 10 additions & 14 deletions packages/editor-ui/src/stores/versionControl.store.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ export const useVersionControlStore = defineStore('versionControl', () => {
Object.assign(preferences, data);
};

const makePreferencesAction =
(action: typeof vcApi.savePreferences | typeof vcApi.updatePreferences) =>
async (preferences: Partial<VersionControlPreferences>) => {
const data = await action(rootStore.getRestApiContext, preferences);
setPreferences(data);
};

const getBranches = async () => {
const data = await vcApi.getBranches(rootStore.getRestApiContext);
setPreferences(data);
Expand All @@ -58,15 +65,9 @@ export const useVersionControlStore = defineStore('versionControl', () => {
setPreferences(data);
};

const savePreferences = async (preferences: Partial<VersionControlPreferences>) => {
const data = await vcApi.setPreferences(rootStore.getRestApiContext, preferences);
setPreferences(data);
};
const savePreferences = makePreferencesAction(vcApi.savePreferences);

const setBranch = async (branch: string) => {
const data = await vcApi.setBranch(rootStore.getRestApiContext, branch);
setPreferences({ ...data, connected: true });
};
const updatePreferences = makePreferencesAction(vcApi.updatePreferences);

const disconnect = async (keepKeyPair: boolean) => {
await vcApi.disconnect(rootStore.getRestApiContext, keepKeyPair);
Expand All @@ -90,10 +91,6 @@ export const useVersionControlStore = defineStore('versionControl', () => {
return vcApi.getAggregatedStatus(rootStore.getRestApiContext);
};

const setBranchReadonly = async (branchReadOnly: boolean) => {
return vcApi.setBranchReadonly(rootStore.getRestApiContext, branchReadOnly);
};

return {
isEnterpriseVersionControlEnabled,
state,
Expand All @@ -105,10 +102,9 @@ export const useVersionControlStore = defineStore('versionControl', () => {
generateKeyPair,
getBranches,
savePreferences,
setBranch,
updatePreferences,
disconnect,
getStatus,
getAggregatedStatus,
setBranchReadonly,
};
});
18 changes: 9 additions & 9 deletions packages/editor-ui/src/views/SettingsVersionControl.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
import { computed, reactive, onBeforeMount, ref } from 'vue';
import type { Rule, RuleGroup } from 'n8n-design-system/types';
import { MODAL_CONFIRM, VALID_EMAIL_REGEX } from '@/constants';
import { useVersionControlStore } from '@/stores/versionControl.store';
import { useUIStore } from '@/stores/ui.store';
import { useUIStore, useVersionControlStore } from '@/stores';
import { useToast, useMessage, useLoadingService, useI18n } from '@/composables';
import CopyInput from '@/components/CopyInput.vue';
Expand Down Expand Up @@ -67,10 +66,11 @@ const onDisconnect = async () => {
const onSave = async () => {
loadingService.startLoading();
try {
await Promise.all([
versionControlStore.setBranch(versionControlStore.preferences.branchName),
versionControlStore.setBranchReadonly(versionControlStore.preferences.branchReadOnly),
]);
await versionControlStore.updatePreferences({
branchName: versionControlStore.preferences.branchName,
branchReadOnly: versionControlStore.preferences.branchReadOnly,
branchColor: versionControlStore.preferences.branchColor,
});
toast.showMessage({
title: locale.baseText('settings.versionControl.saved.title'),
type: 'success',
Expand All @@ -92,7 +92,7 @@ const goToUpgrade = () => {
uiStore.goToUpgrade('version-control', 'upgrade-version-control');
};
onBeforeMount(async () => {
onBeforeMount(() => {
if (versionControlStore.preferences.connected) {
isConnected.value = true;
void versionControlStore.getBranches();
Expand Down Expand Up @@ -318,12 +318,12 @@ async function refreshSshKey() {
</i18n>
</n8n-checkbox>
</div>
<!-- <div :class="$style.group">
<div :class="$style.group">
<label>{{ locale.baseText('settings.versionControl.color') }}</label>
<div>
<n8n-color-picker size="small" v-model="versionControlStore.preferences.branchColor" />
</div>
</div> -->
</div>
<div :class="[$style.group, 'pt-s']">
<n8n-button
@click="onSave"
Expand Down

0 comments on commit dba3f44

Please sign in to comment.