github-mirror/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2026-05-12 16:10:30 +02:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity

refactor functions

Browse Source
This commit is contained in:
Mutasem Aldmour 2026-05-12 14:50:38 +02:00
parent 932d4fa8a5
commit 191995f533
No known key found for this signature in database
GPG Key ID: 3DFA8122BB7FD6B8
2 changed files with 150 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
packages/@n8n/workflow-sdk/src/codegen/emit-instance-ai.test.ts
View File

@ -1,4 +1,10 @@
import { emitInstanceAi, buildImports, hoistSharedCredentials } from './emit-instance-ai';
import * as sdk from '../index';
import {
emitInstanceAi,
buildImports,
hoistSharedCredentials,
SDK_FUNCTIONS,
} from './emit-instance-ai';
import type { WorkflowJSON } from '../types/base';
describe('emit-instance-ai', () => {
@ -201,6 +207,140 @@ describe('emit-instance-ai', () => {
});
});
describe('SDK_FUNCTIONS drift guard', () => {
// Every function exported from `@n8n/workflow-sdk` falls into one of two buckets:
// - SDK_FUNCTIONS → workflow-callable, must appear in generated import line
// - INTENTIONALLY_EXCLUDED → utility/codegen/validation/type guard, never appears
// inside an emitted workflow body
// When a new export is added, this test fails until it's categorised. That's the
// signal to decide whether `emit-instance-ai` should know about it.
const INTENTIONALLY_EXCLUDED = new Set<string>([
// Classes
'PluginRegistry',
'ValidationError',
'ValidationWarning',
// Expression helpers (workflows use `expr()` only; the rest are parser internals)
'createFromAIExpression',
'isExpression',
'nodeJson',
'parseExpression',
// Type guards (callable but never appear in workflow bodies)
'isDataTableType',
'isHttpRequestType',
'isIfNodeType',
'isMergeNodeType',
'isNodeChain',
'isNodeInstance',
'isSplitInBatchesType',
'isStickyNoteType',
'isSwitchNodeType',
'isWebhookType',
// Codegen + parse round-trip
'emitInstanceAi',
'generateWorkflowCode',
'parseWorkflowCode',
'parseWorkflowCodeToBuilder',
// Code-step helpers — appear as arguments to `.code()` callbacks, not as
// standalone calls in the emitted body
'runOnceForAllItems',
'runOnceForEachItem',
// Safe-access utilities (used inside .code() callbacks too)
'getProperty',
'hasProperty',
'isPlainObject',
// Validation
'validateNodeConfig',
'validateWorkflow',
'setSchemaBaseDirs',
// Pin-data + schema discovery
'discoverOutputSchemaForNode',
'discoverSchemasForNode',
'findSchemaForOperation',
'inferSchemasFromRunData',
'needsPinData',
'normalizePinData',
// Display-options matching
'matchesDisplayOptions',
// Plugin registration
'registerDefaultPlugins',
// Generate-types module (build-time type generation, never appears in workflows)
'buildDiscriminatorTree',
'extractDiscriminatorCombinations',
'extractOutputTypes',
'filterPropertiesForVersion',
'generateDiscriminatedUnion',
'generateDiscriminatorSchemaFile',
'generateIndexFile',
'generateJsonSchemaFromData',
'generateNodeJSDoc',
'generateNodeTypeFile',
'generatePropertyJSDoc',
'generatePropertyLine',
'generateResourceIndexSchemaFile',
'generateSchemaIndexFile',
'generateSchemaPropertyLine',
'generateSingleVersionSchemaFile',
'generateSingleVersionTypeFile',
'generateSplitVersionIndexSchemaFile',
'generateSubnodeUnionTypes',
'generateSubnodesFile',
'generateTypes',
'generateVersionIndexFile',
'getHighestVersion',
'getPackageName',
'getPropertiesForCombination',
'getSubnodeOutputType',
'groupNodesByOutputType',
'groupVersionsByProperties',
'hasDiscriminatorPattern',
'jsonSchemaToTypeScript',
'literalUnion',
'loadNodeTypes',
'mapPropertyToZodSchema',
'mapPropertyType',
'multiOptionsSchema',
'nodeNameToFileName',
'optionsWithExpression',
'orchestrateGeneration',
'planSplitVersionFiles',
'planSplitVersionSchemaFiles',
'propertyAppliesToVersion',
'versionToFileName',
'versionToTypeName',
]);
const sdkFunctionExports = new Set(
Object.entries(sdk)
.filter(([, v]) => typeof v === 'function')
.map(([k]) => k),
);
it('categorises every SDK function export', () => {
const categorised = new Set([...SDK_FUNCTIONS, ...INTENTIONALLY_EXCLUDED]);
const uncategorised = [...sdkFunctionExports].filter((n) => !categorised.has(n)).sort();
expect(uncategorised).toEqual([]);
});
it('has no stale entries in SDK_FUNCTIONS', () => {
const stale = SDK_FUNCTIONS.filter((n) => !sdkFunctionExports.has(n)).sort();
expect(stale).toEqual([]);
});
it('has no stale entries in INTENTIONALLY_EXCLUDED', () => {
const stale = [...INTENTIONALLY_EXCLUDED].filter((n) => !sdkFunctionExports.has(n)).sort();
expect(stale).toEqual([]);
});
it('does not double-list a function in both sets', () => {
const overlap = SDK_FUNCTIONS.filter((n) => INTENTIONALLY_EXCLUDED.has(n)).sort();
expect(overlap).toEqual([]);
});
});
describe('hoistSharedCredentials', () => {
it('is a no-op when there are no credentials', () => {
const body = 'const x = node({ ... });';

11
packages/@n8n/workflow-sdk/src/codegen/emit-instance-ai.ts
View File

@ -25,8 +25,15 @@ function generateWorkflowCode(workflow: WorkflowJSON): string {
return generateCode(tree, workflow, graph, {});
}
/** SDK functions a workflow file may call. Order matters only for tidiness. */
const SDK_FUNCTIONS = [
/**
* SDK functions a workflow file may call. Order matters only for tidiness.
*
* A drift test (`emit-instance-ai.test.ts`) asserts this list stays in sync with the
* function exports of `@n8n/workflow-sdk`. When you add or remove a function export,
* the test will fail until the new name is placed either here (if a workflow file
* may call it) or in the test's intentional-exclusion list (if it's a utility).
*/
export const SDK_FUNCTIONS = [
'workflow',
'trigger',
'node',