forked from n8n-io/n8n
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Introduce debug info button (n8n-io#9895)
- Loading branch information
Showing
10 changed files
with
288 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| import { useSettingsStore } from '@/stores/settings.store'; | ||
| import type { WorkflowSettings } from 'n8n-workflow'; | ||
|
|
||
| type DebugInfo = { | ||
| core: { | ||
| n8nVersion: string; | ||
| platform: 'docker (cloud)' | 'docker (self-hosted)' | 'npm'; | ||
| nodeJsVersion: string; | ||
| database: 'sqlite' | 'mysql' | 'mariadb' | 'postgres'; | ||
| executionMode: 'regular' | 'scaling'; | ||
| license: 'community' | 'enterprise (production)' | 'enterprise (sandbox)'; | ||
| consumerId: string; | ||
| concurrency: number; | ||
| }; | ||
| storage: { | ||
| success: WorkflowSettings.SaveDataExecution; | ||
| error: WorkflowSettings.SaveDataExecution; | ||
| progress: boolean; | ||
| manual: boolean; | ||
| binaryMode: 'memory' | 'filesystem' | 's3'; | ||
| }; | ||
| pruning: | ||
| | { | ||
| enabled: false; | ||
| } | ||
| | { | ||
| enabled: true; | ||
| maxAge: `${number} hours`; | ||
| maxCount: `${number} executions`; | ||
| }; | ||
| /** | ||
| * Reported only if insecure settings are found. | ||
| */ | ||
| security?: { | ||
| secureCookie?: boolean; | ||
| blockFileAccessToN8nFiles?: boolean; | ||
| }; | ||
| }; | ||
|
|
||
| export function useDebugInfo() { | ||
| const store = useSettingsStore(); | ||
|
|
||
| const coreInfo = () => { | ||
| return { | ||
| n8nVersion: store.versionCli, | ||
| platform: | ||
| store.isDocker && store.deploymentType === 'cloud' | ||
| ? 'docker (cloud)' | ||
| : store.isDocker | ||
| ? 'docker (self-hosted)' | ||
| : 'npm', | ||
| nodeJsVersion: store.nodeJsVersion, | ||
| database: | ||
| store.databaseType === 'postgresdb' | ||
| ? 'postgres' | ||
| : store.databaseType === 'mysqldb' | ||
| ? 'mysql' | ||
| : store.databaseType, | ||
| executionMode: store.isQueueModeEnabled ? 'scaling' : 'regular', | ||
| concurrency: store.settings.concurrency, | ||
| license: | ||
| store.planName === 'Community' | ||
| ? (store.planName.toLowerCase() as 'community') | ||
| : store.settings.license.environment === 'production' | ||
| ? 'enterprise (production)' | ||
| : 'enterprise (sandbox)', | ||
| consumerId: store.consumerId, | ||
| } as const; | ||
| }; | ||
|
|
||
| const storageInfo = (): DebugInfo['storage'] => { | ||
| return { | ||
| success: store.saveDataSuccessExecution, | ||
| error: store.saveDataErrorExecution, | ||
| progress: store.saveDataProgressExecution, | ||
| manual: store.saveManualExecutions, | ||
| binaryMode: store.binaryDataMode === 'default' ? 'memory' : store.binaryDataMode, | ||
| }; | ||
| }; | ||
|
|
||
| const pruningInfo = () => { | ||
| if (!store.pruning.isEnabled) return { enabled: false } as const; | ||
|
|
||
| return { | ||
| enabled: true, | ||
| maxAge: `${store.pruning.maxAge} hours`, | ||
| maxCount: `${store.pruning.maxCount} executions`, | ||
| } as const; | ||
| }; | ||
|
|
||
| const securityInfo = () => { | ||
| const info: DebugInfo['security'] = {}; | ||
|
|
||
| if (!store.security.blockFileAccessToN8nFiles) info.blockFileAccessToN8nFiles = false; | ||
| if (!store.security.secureCookie) info.secureCookie = false; | ||
|
|
||
| if (Object.keys(info).length === 0) return; | ||
|
|
||
| return info; | ||
| }; | ||
|
|
||
| const gatherDebugInfo = () => { | ||
| const debugInfo: DebugInfo = { | ||
| core: coreInfo(), | ||
| storage: storageInfo(), | ||
| pruning: pruningInfo(), | ||
| }; | ||
|
|
||
| const security = securityInfo(); | ||
|
|
||
| if (security) debugInfo.security = security; | ||
|
|
||
| return debugInfo; | ||
| }; | ||
|
|
||
| const toMarkdown = (debugInfo: DebugInfo): string => { | ||
| let markdown = '# Debug info\n\n'; | ||
|
|
||
| for (const sectionKey in debugInfo) { | ||
| markdown += `## ${sectionKey}\n\n`; | ||
|
|
||
| const section = debugInfo[sectionKey as keyof DebugInfo]; | ||
|
|
||
| if (!section) continue; | ||
|
|
||
| for (const itemKey in section) { | ||
| const itemValue = section[itemKey as keyof typeof section]; | ||
| markdown += `- ${itemKey}: ${itemValue}\n`; | ||
| } | ||
|
|
||
| markdown += '\n'; | ||
| } | ||
|
|
||
| return markdown; | ||
| }; | ||
|
|
||
| const appendTimestamp = (markdown: string) => { | ||
| return `${markdown}Generated at: ${new Date().toISOString()}`; | ||
| }; | ||
|
|
||
| const generateDebugInfo = () => { | ||
| return appendTimestamp(toMarkdown(gatherDebugInfo())); | ||
| }; | ||
|
|
||
| return { | ||
| generateDebugInfo, | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.