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

feat(editor): Allow enabling canvas v2 via instance settings (no-changelog) #11447

Merged
merged 2 commits into from
Oct 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
1 change: 1 addition & 0 deletions packages/@n8n/api-types/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"dist/**/*"
],
"devDependencies": {
"@n8n/config": "workspace:*",
"n8n-workflow": "workspace:*"
},
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions packages/@n8n/api-types/src/frontend-settings.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { FrontendBetaFeatures } from '@n8n/config';
import type { ExpressionEvaluatorType, LogLevel, WorkflowSettings } from 'n8n-workflow';

export interface IVersionNotificationSettings {
Expand Down Expand Up @@ -169,4 +170,5 @@ export interface FrontendSettings {
security: {
blockFileAccessToN8nFiles: boolean;
};
betaFeatures: FrontendBetaFeatures[];
}
11 changes: 11 additions & 0 deletions packages/@n8n/config/src/configs/frontend.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Config, Env } from '../decorators';
import { StringArray } from '../utils';

export type FrontendBetaFeatures = 'canvas_v2';

@Config
export class FrontendConfig {
/** Which UI experiments to enable. Separate multiple values with a comma `,` */
@Env('N8N_UI_BETA_FEATURES')
betaFeatures: StringArray<FrontendBetaFeatures> = [];
}
1 change: 1 addition & 0 deletions packages/@n8n/config/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { Config, Env, Nested } from './decorators';
export { Config, Env, Nested } from './decorators';
export { TaskRunnersConfig } from './configs/runners.config';
export { SecurityConfig } from './configs/security.config';
export { FrontendBetaFeatures, FrontendConfig } from './configs/frontend.config';
export { LOG_SCOPES } from './configs/logging.config';
export type { LogScope } from './configs/logging.config';

Expand Down
4 changes: 3 additions & 1 deletion packages/cli/src/services/frontend.service.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { FrontendSettings, ITelemetrySettings } from '@n8n/api-types';
import { GlobalConfig, SecurityConfig } from '@n8n/config';
import { GlobalConfig, FrontendConfig, SecurityConfig } from '@n8n/config';
import { createWriteStream } from 'fs';
import { mkdir } from 'fs/promises';
import uniq from 'lodash/uniq';
Expand Down Expand Up @@ -47,6 +47,7 @@ export class FrontendService {
private readonly instanceSettings: InstanceSettings,
private readonly urlService: UrlService,
private readonly securityConfig: SecurityConfig,
private readonly frontendConfig: FrontendConfig,
) {
loadNodesAndCredentials.addPostProcessor(async () => await this.generateTypes());
void this.generateTypes();
Expand Down Expand Up @@ -228,6 +229,7 @@ export class FrontendService {
security: {
blockFileAccessToN8nFiles: this.securityConfig.blockFileAccessToN8nFiles,
},
betaFeatures: this.frontendConfig.betaFeatures,
};
}

Expand Down
1 change: 1 addition & 0 deletions packages/editor-ui/src/__tests__/defaults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,5 @@ export const defaultSettings: FrontendSettings = {
aiAssistant: {
enabled: false,
},
betaFeatures: [],
};
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export function useNodeViewVersionSwitcher() {

const nodeViewVersion = useLocalStorage(
'NodeView.version',
settingsStore.deploymentType === 'n8n-internal' ? '2' : '1',
settingsStore.isCanvasV2Enabled ? '2' : '1',
);

function setNodeViewSwitcherDropdownOpened(visible: boolean) {
Expand Down
5 changes: 5 additions & 0 deletions packages/editor-ui/src/stores/settings.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ export const useSettingsStore = defineStore(STORES.SETTINGS, () => {

const isDevRelease = computed(() => settings.value.releaseChannel === 'dev');

const isCanvasV2Enabled = computed(() =>
(settings.value.betaFeatures ?? []).includes('canvas_v2'),
);

const setSettings = (newSettings: FrontendSettings) => {
settings.value = newSettings;
userManagement.value = newSettings.userManagement;
Expand Down Expand Up @@ -418,6 +422,7 @@ export const useSettingsStore = defineStore(STORES.SETTINGS, () => {
saveDataProgressExecution,
isCommunityPlan,
isAskAiEnabled,
isCanvasV2Enabled,
reset,
testLdapConnection,
getLdapConfig,
Expand Down
10 changes: 9 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading