feat: Environments release using source control (#6653)

* initial telemetry setup and adjusted pull return * quicksave before merge * feat: add conflicting workflow list to pull modal * feat: update source control pull modal * fix: fix linting issue * feat: add Enter keydown event for submitting source control push modal (no-changelog) feat: add Enter keydown event for submitting source control push modal * quicksave * user workflow table for export * improve telemetry data * pull api telemetry * fix lint * Copy tweaks. * remove authorName and authorEmail and pick from user * rename owners.json to workflow_owners.json * ignore credential conflicts on pull * feat: several push/pull flow changes and design update * pull and push return same data format * fix: add One last step toast for successful pull * feat: add up to date pull toast * fix: add proper Learn more link for push and pull modals * do not await tracking being sent * fix import * fix await * add more sourcecontrolfile status * Minor copy tweak for "More info". * Minor copy tweak for "More info". * ignore variable_stub conflicts on pull * ignore whitespace differences * do not show remote workflows that are not yet created * fix telemetry * fix toast when pulling deleted wf * lint fix * refactor and make some imports dynamic * fix variable edit validation * fix telemetry response * improve telemetry * fix unintenional delete commit * fix status unknown issue * fix up to date toast * do not export active state and reapply versionid * use update instead of upsert * fix: show all workflows when clicking push to git * feat: update Up to date pull translation * fix: update read only env checks * do not update versionid of only active flag changes * feat: prevent access to new workflow and templates import when read only env * feat: send only active state and version if workflow state is not dirty * fix: Detect when only active state has changed and prevent generation a new version ID * feat: improve readonly env messages * make getPreferences public * fix telemetry issue * fix: add partial workflow update based on dirty state when changing active state * update unit tests * fix: remove unsaved changes check in readOnlyEnv * fix: disable push to git button when read onyl env * fix: update readonly toast duration * fix: fix pinning and title input in protected mode * initial commit (NOT working) * working push * cleanup and implement pull * fix getstatus * update import to new method * var and tag diffs are no conflicts * only show pull conflict for workflows * refactor and ignore faulty credentials * add sanitycheck for missing git folder * prefer fetch over pull and limit depth to 1 * back to pull... * fix setting branch on initial connect * fix test * remove clean workfolder * refactor: Remove some unnecessary code * Fixed links to docs. * fix getstatus query params * lint fix * dialog to show local and remote name on conflict * only show remote name on conflict * fix credential expression export * fix: Broken test * dont show toast on pull with empty var/tags and refactor * apply frontend changes from old branch * fix tag with same name import * fix buttons shown for non instance owners * prepare local storage key for removal * refactor: Change wording on pushing and pulling * refactor: Change menu item * test: Fix broken test * Update packages/cli/src/environments/sourceControl/types/sourceControlPushWorkFolder.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> --------- Co-authored-by: Alex Grozav <alex@grozav.com> Co-authored-by: Giulio Andreini <g.andreini@gmail.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com>
n8n-io · Aug 3, 2023 · c065ba0 · c065ba0
1 parent 4509bc0
commit c065ba0
Show file tree

Hide file tree

Showing 51 changed files with 2,194 additions and 1,048 deletions.
diff --git a/packages/cli/src/InternalHooks.ts b/packages/cli/src/InternalHooks.ts
@@ -54,6 +54,14 @@ function userToPayload(user: User): {
 export class InternalHooks implements IInternalHooksClass {
 	private instanceId: string;
 
+	public get telemetryInstanceId(): string {
+		return this.instanceId;
+	}
+
+	public get telemetryInstance(): Telemetry {
+		return this.telemetry;
+	}
+
 	constructor(
 		private telemetry: Telemetry,
 		private nodeTypes: NodeTypes,
@@ -1043,4 +1051,53 @@ export class InternalHooks implements IInternalHooksClass {
 	async onVariableCreated(createData: { variable_type: string }): Promise<void> {
 		return this.telemetry.track('User created variable', createData);
 	}
+
+	async onSourceControlSettingsUpdated(data: {
+		branch_name: string;
+		read_only_instance: boolean;
+		repo_type: 'github' | 'gitlab' | 'other';
+		connected: boolean;
+	}): Promise<void> {
+		return this.telemetry.track('User updated source control settings', data);
+	}
+
+	async onSourceControlUserStartedPullUI(data: {
+		workflow_updates: number;
+		workflow_conflicts: number;
+		cred_conflicts: number;
+	}): Promise<void> {
+		return this.telemetry.track('User started pull via UI', data);
+	}
+
+	async onSourceControlUserFinishedPullUI(data: { workflow_updates: number }): Promise<void> {
+		return this.telemetry.track('User finished pull via UI', {
+			workflow_updates: data.workflow_updates,
+		});
+	}
+
+	async onSourceControlUserPulledAPI(data: {
+		workflow_updates: number;
+		forced: boolean;
+	}): Promise<void> {
+		return this.telemetry.track('User pulled via API', data);
+	}
+
+	async onSourceControlUserStartedPushUI(data: {
+		workflows_eligible: number;
+		workflows_eligible_with_conflicts: number;
+		creds_eligible: number;
+		creds_eligible_with_conflicts: number;
+		variables_eligible: number;
+	}): Promise<void> {
+		return this.telemetry.track('User started push via UI', data);
+	}
+
+	async onSourceControlUserFinishedPushUI(data: {
+		workflows_eligible: number;
+		workflows_pushed: number;
+		creds_pushed: number;
+		variables_pushed: number;
+	}): Promise<void> {
+		return this.telemetry.track('User finished push via UI', data);
+	}
 }
diff --git a/packages/cli/src/Ldap/helpers.ts b/packages/cli/src/Ldap/helpers.ts
@@ -217,7 +217,7 @@ export const handleLdapInit = async (): Promise<void> => {
 	try {
 		await setGlobalLdapConfigVariables(ldapConfig);
 	} catch (error) {
-		Logger.error(
+		Logger.warn(
 			`Cannot set LDAP login enabled state when an authentication method other than email or ldap is active (current: ${getCurrentAuthenticationMethod()})`,
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 			error,

diff --git a/packages/cli/src/PublicApi/v1/handlers/sourceControl/sourceControl.handler.ts b/packages/cli/src/PublicApi/v1/handlers/sourceControl/sourceControl.handler.ts
@@ -6,7 +6,11 @@ import { authorize } from '../../shared/middlewares/global.middleware';
 import type { ImportResult } from '@/environments/sourceControl/types/importResult';
 import { SourceControlService } from '@/environments/sourceControl/sourceControl.service.ee';
 import { SourceControlPreferencesService } from '@/environments/sourceControl/sourceControlPreferences.service.ee';
-import { isSourceControlLicensed } from '@/environments/sourceControl/sourceControlHelper.ee';
+import {
+	getTrackingInformationFromPullResult,
+	isSourceControlLicensed,
+} from '@/environments/sourceControl/sourceControlHelper.ee';
+import { InternalHooks } from '@/InternalHooks';
 
 export = {
 	pull: [
@@ -32,12 +36,16 @@ export = {
 					force: req.body.force,
 					variables: req.body.variables,
 					userId: req.user.id,
-					importAfterPull: true,
 				});
-				if ((result as ImportResult)?.workflows) {
-					return res.status(200).send(result as ImportResult);
+
+				if (result.statusCode === 200) {
+					void Container.get(InternalHooks).onSourceControlUserPulledAPI({
+						...getTrackingInformationFromPullResult(result.statusResult),
+						forced: req.body.force ?? false,
+					});
+					return res.status(200).send(result.statusResult);
 				} else {
-					return res.status(409).send(result);
+					return res.status(409).send(result.statusResult);
 				}
 			} catch (error) {
 				return res.status(400).send((error as { message: string }).message);

diff --git a/packages/cli/src/environments/sourceControl/constants.ts b/packages/cli/src/environments/sourceControl/constants.ts
@@ -5,7 +5,7 @@ export const SOURCE_CONTROL_WORKFLOW_EXPORT_FOLDER = 'workflows';
 export const SOURCE_CONTROL_CREDENTIAL_EXPORT_FOLDER = 'credential_stubs';
 export const SOURCE_CONTROL_VARIABLES_EXPORT_FILE = 'variable_stubs.json';
 export const SOURCE_CONTROL_TAGS_EXPORT_FILE = 'tags.json';
-export const SOURCE_CONTROL_OWNERS_EXPORT_FILE = 'owners.json';
+export const SOURCE_CONTROL_OWNERS_EXPORT_FILE = 'workflow_owners.json';
 export const SOURCE_CONTROL_SSH_FOLDER = 'ssh';
 export const SOURCE_CONTROL_SSH_KEY_NAME = 'key';
 export const SOURCE_CONTROL_DEFAULT_BRANCH = 'main';
@@ -14,3 +14,5 @@ export const SOURCE_CONTROL_API_ROOT = 'source-control';
 export const SOURCE_CONTROL_README = `
 # n8n Source Control
 `;
+export const SOURCE_CONTROL_DEFAULT_NAME = 'n8n user';
+export const SOURCE_CONTROL_DEFAULT_EMAIL = 'n8n@example.com';
diff --git a/packages/cli/src/environments/sourceControl/sourceControl.controller.ee.ts b/packages/cli/src/environments/sourceControl/sourceControl.controller.ee.ts
@@ -1,19 +1,22 @@
-import express from 'express';
-import { Service } from 'typedi';
-import type { PullResult, PushResult, StatusResult } from 'simple-git';
 import { Authorized, Get, Post, Patch, RestController } from '@/decorators';
 import {
 	sourceControlLicensedMiddleware,
 	sourceControlLicensedAndEnabledMiddleware,
 } from './middleware/sourceControlEnabledMiddleware.ee';
 import { SourceControlService } from './sourceControl.service.ee';
 import { SourceControlRequest } from './types/requests';
-import type { SourceControlPreferences } from './types/sourceControlPreferences';
-import { BadRequestError } from '@/ResponseHelper';
-import type { ImportResult } from './types/importResult';
 import { SourceControlPreferencesService } from './sourceControlPreferences.service.ee';
+import type { SourceControlPreferences } from './types/sourceControlPreferences';
 import type { SourceControlledFile } from './types/sourceControlledFile';
 import { SOURCE_CONTROL_API_ROOT, SOURCE_CONTROL_DEFAULT_BRANCH } from './constants';
+import { BadRequestError } from '@/ResponseHelper';
+import type { PullResult } from 'simple-git';
+import express from 'express';
+import type { ImportResult } from './types/importResult';
+import Container, { Service } from 'typedi';
+import { InternalHooks } from '../../InternalHooks';
+import { getRepoType } from './sourceControlHelper.ee';
+import { SourceControlGetStatus } from './types/sourceControlGetStatus';
 
 @Service()
 @RestController(`/${SOURCE_CONTROL_API_ROOT}`)
@@ -23,7 +26,7 @@ export class SourceControlController {
 		private sourceControlPreferencesService: SourceControlPreferencesService,
 	) {}
 
-	@Authorized('any')
+	@Authorized('none')
 	@Get('/preferences', { middlewares: [sourceControlLicensedMiddleware] })
 	async getPreferences(): Promise<SourceControlPreferences> {
 		// returns the settings with the privateKey property redacted
@@ -56,14 +59,17 @@ export class SourceControlController {
 			);
 			if (sanitizedPreferences.initRepo === true) {
 				try {
-					await this.sourceControlService.initializeRepository({
-						...updatedPreferences,
-						branchName:
-							updatedPreferences.branchName === ''
-								? SOURCE_CONTROL_DEFAULT_BRANCH
-								: updatedPreferences.branchName,
-						initRepo: true,
-					});
+					await this.sourceControlService.initializeRepository(
+						{
+							...updatedPreferences,
+							branchName:
+								updatedPreferences.branchName === ''
+									? SOURCE_CONTROL_DEFAULT_BRANCH
+									: updatedPreferences.branchName,
+							initRepo: true,
+						},
+						req.user,
+					);
 					if (this.sourceControlPreferencesService.getPreferences().branchName !== '') {
 						await this.sourceControlPreferencesService.setPreferences({
 							connected: true,
@@ -76,7 +82,17 @@ export class SourceControlController {
 				}
 			}
 			await this.sourceControlService.init();
-			return this.sourceControlPreferencesService.getPreferences();
+			const resultingPreferences = this.sourceControlPreferencesService.getPreferences();
+			// #region Tracking Information
+			// located in controller so as to not call this multiple times when updating preferences
+			void Container.get(InternalHooks).onSourceControlSettingsUpdated({
+				branch_name: resultingPreferences.branchName,
+				connected: resultingPreferences.connected,
+				read_only_instance: resultingPreferences.branchReadOnly,
+				repo_type: getRepoType(resultingPreferences.repositoryUrl),
+			});
+			// #endregion
+			return resultingPreferences;
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
@@ -92,8 +108,6 @@ export class SourceControlController {
 				connected: undefined,
 				publicKey: undefined,
 				repositoryUrl: undefined,
-				authorName: undefined,
-				authorEmail: undefined,
 			};
 			const currentPreferences = this.sourceControlPreferencesService.getPreferences();
 			await this.sourceControlPreferencesService.validateSourceControlPreferences(
@@ -115,7 +129,14 @@ export class SourceControlController {
 				);
 			}
 			await this.sourceControlService.init();
-			return this.sourceControlPreferencesService.getPreferences();
+			const resultingPreferences = this.sourceControlPreferencesService.getPreferences();
+			void Container.get(InternalHooks).onSourceControlSettingsUpdated({
+				branch_name: resultingPreferences.branchName,
+				connected: resultingPreferences.connected,
+				read_only_instance: resultingPreferences.branchReadOnly,
+				repo_type: getRepoType(resultingPreferences.repositoryUrl),
+			});
+			return resultingPreferences;
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
@@ -146,18 +167,18 @@ export class SourceControlController {
 	async pushWorkfolder(
 		req: SourceControlRequest.PushWorkFolder,
 		res: express.Response,
-	): Promise<PushResult | SourceControlledFile[]> {
+	): Promise<SourceControlledFile[]> {
 		if (this.sourceControlPreferencesService.isBranchReadOnly()) {
 			throw new BadRequestError('Cannot push onto read-only branch.');
 		}
 		try {
+			await this.sourceControlService.setGitUserDetails(
+				`${req.user.firstName} ${req.user.lastName}`,
+				req.user.email,
+			);
 			const result = await this.sourceControlService.pushWorkfolder(req.body);
-			if ((result as PushResult).pushed) {
-				res.statusCode = 200;
-			} else {
-				res.statusCode = 409;
-			}
-			return result;
+			res.statusCode = result.statusCode;
+			return result.statusResult;
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
@@ -168,57 +189,48 @@ export class SourceControlController {
 	async pullWorkfolder(
 		req: SourceControlRequest.PullWorkFolder,
 		res: express.Response,
-	): Promise<SourceControlledFile[] | ImportResult | PullResult | StatusResult | undefined> {
+	): Promise<SourceControlledFile[] | ImportResult | PullResult | undefined> {
 		try {
 			const result = await this.sourceControlService.pullWorkfolder({
 				force: req.body.force,
 				variables: req.body.variables,
 				userId: req.user.id,
-				importAfterPull: req.body.importAfterPull ?? true,
 			});
-			if ((result as ImportResult)?.workflows) {
-				res.statusCode = 200;
-			} else {
-				res.statusCode = 409;
-			}
-			return result;
+			res.statusCode = result.statusCode;
+			return result.statusResult;
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
 	}
 
 	@Authorized(['global', 'owner'])
 	@Get('/reset-workfolder', { middlewares: [sourceControlLicensedAndEnabledMiddleware] })
-	async resetWorkfolder(
-		req: SourceControlRequest.PullWorkFolder,
-	): Promise<ImportResult | undefined> {
+	async resetWorkfolder(): Promise<ImportResult | undefined> {
 		try {
-			return await this.sourceControlService.resetWorkfolder({
-				force: req.body.force,
-				variables: req.body.variables,
-				userId: req.user.id,
-				importAfterPull: req.body.importAfterPull ?? true,
-			});
+			return await this.sourceControlService.resetWorkfolder();
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
 	}
 
 	@Authorized('any')
 	@Get('/get-status', { middlewares: [sourceControlLicensedAndEnabledMiddleware] })
-	async getStatus() {
+	async getStatus(req: SourceControlRequest.GetStatus) {
 		try {
-			return await this.sourceControlService.getStatus();
+			const result = (await this.sourceControlService.getStatus(
+				new SourceControlGetStatus(req.query),
+			)) as SourceControlledFile[];
+			return result;
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}
 	}
 
 	@Authorized('any')
 	@Get('/status', { middlewares: [sourceControlLicensedMiddleware] })
-	async status(): Promise<StatusResult> {
+	async status(req: SourceControlRequest.GetStatus) {
 		try {
-			return await this.sourceControlService.status();
+			return await this.sourceControlService.getStatus(new SourceControlGetStatus(req.query));
 		} catch (error) {
 			throw new BadRequestError((error as { message: string }).message);
 		}