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

fix(editor): Add workflow scopes when initializing workflow #10455

Merged
merged 7 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
31 changes: 30 additions & 1 deletion packages/editor-ui/src/__tests__/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import {
SET_NODE_TYPE,
STICKY_NODE_TYPE,
} from '@/constants';
import type { INodeUi } from '@/Interface';
import type { INodeUi, IWorkflowDb } from '@/Interface';

export const mockNode = ({
id = uuid(),
Expand Down Expand Up @@ -147,6 +147,35 @@ export function createTestWorkflowObject({
});
}

export function createTestWorkflow({
id = uuid(),
name = 'Test Workflow',
nodes = [],
connections = {},
active = false,
settings = {
timezone: 'DEFAULT',
executionOrder: 'v1',
},
pinData = {},
...rest
}: Partial<IWorkflowDb> = {}): IWorkflowDb {
return {
createdAt: '',
updatedAt: '',
id,
name,
nodes,
connections,
active,
settings,
versionId: '1',
meta: {},
pinData,
...rest,
};
}

export function createTestNode(node: Partial<INode> = {}): INode {
return {
id: uuid(),
Expand Down
138 changes: 115 additions & 23 deletions packages/editor-ui/src/composables/__tests__/useWorkflowHelpers.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import { useWorkflowHelpers } from '@/composables/useWorkflowHelpers';
import router from '@/router';
import { createTestingPinia } from '@pinia/testing';
import { setActivePinia } from 'pinia';
import { useWorkflowsStore } from '@/stores/workflows.store';
import { useWorkflowsEEStore } from '@/stores/workflows.ee.store';
import { useTagsStore } from '@/stores/tags.store';
import { createTestWorkflow } from '@/__tests__/mocks';

const getDuplicateTestWorkflow = (): IWorkflowDataUpdate => ({
name: 'Duplicate webhook test',
Expand Down Expand Up @@ -50,32 +54,23 @@ const getDuplicateTestWorkflow = (): IWorkflowDataUpdate => ({
connections: {},
});

vi.mock('@/stores/workflows.store', () => ({
useWorkflowsStore: vi.fn(() => ({
workflowsById: {},
createNewWorkflow: vi.fn(() => {}),
addWorkflow: vi.fn(() => {}),
setActive: vi.fn(() => {}),
setWorkflowId: vi.fn(() => {}),
setWorkflowVersionId: vi.fn(() => {}),
setWorkflowName: vi.fn(() => {}),
setWorkflowSettings: vi.fn(() => {}),
setNodeValue: vi.fn(() => {}),
setWorkflowTagIds: vi.fn(() => {}),
getCurrentWorkflow: vi.fn(() => ({})),
})),
}));

describe('useWorkflowHelpers', () => {
describe('saveAsNewWorkflow', () => {
beforeAll(() => {
setActivePinia(createTestingPinia());
});
let workflowsStore: ReturnType<typeof useWorkflowsStore>;
let workflowsEEStore: ReturnType<typeof useWorkflowsEEStore>;
let tagsStore: ReturnType<typeof useTagsStore>;

afterEach(() => {
vi.clearAllMocks();
});
beforeAll(() => {
setActivePinia(createTestingPinia());
workflowsStore = useWorkflowsStore();
workflowsEEStore = useWorkflowsEEStore();
tagsStore = useTagsStore();
});

afterEach(() => {
vi.clearAllMocks();
});

describe('saveAsNewWorkflow', () => {
it('should respect `resetWebhookUrls: false` when duplicating workflows', async () => {
const workflow = getDuplicateTestWorkflow();
if (!workflow.nodes) {
Expand Down Expand Up @@ -120,4 +115,101 @@ describe('useWorkflowHelpers', () => {
expect(pathsPreSave).not.toEqual(pathsPostSave);
});
});

describe('initState', () => {
it('should initialize workflow state with provided data', () => {
const { initState } = useWorkflowHelpers({ router });

const workflowData = createTestWorkflow({
id: '1',
name: 'Test Workflow',
active: true,
pinData: {},
meta: {},
scopes: ['workflow:create'],
usedCredentials: [],
sharedWithProjects: [],
tags: [],
});
const addWorkflowSpy = vi.spyOn(workflowsStore, 'addWorkflow');
const setActiveSpy = vi.spyOn(workflowsStore, 'setActive');
const setWorkflowIdSpy = vi.spyOn(workflowsStore, 'setWorkflowId');
const setWorkflowNameSpy = vi.spyOn(workflowsStore, 'setWorkflowName');
const setWorkflowSettingsSpy = vi.spyOn(workflowsStore, 'setWorkflowSettings');
const setWorkflowPinDataSpy = vi.spyOn(workflowsStore, 'setWorkflowPinData');
const setWorkflowVersionIdSpy = vi.spyOn(workflowsStore, 'setWorkflowVersionId');
const setWorkflowMetadataSpy = vi.spyOn(workflowsStore, 'setWorkflowMetadata');
const setWorkflowScopesSpy = vi.spyOn(workflowsStore, 'setWorkflowScopes');
const setUsedCredentialsSpy = vi.spyOn(workflowsStore, 'setUsedCredentials');
const setWorkflowSharedWithSpy = vi.spyOn(workflowsEEStore, 'setWorkflowSharedWith');
const setWorkflowTagIdsSpy = vi.spyOn(workflowsStore, 'setWorkflowTagIds');
const upsertTagsSpy = vi.spyOn(tagsStore, 'upsertTags');

initState(workflowData);

expect(addWorkflowSpy).toHaveBeenCalledWith(workflowData);
expect(setActiveSpy).toHaveBeenCalledWith(true);
expect(setWorkflowIdSpy).toHaveBeenCalledWith('1');
expect(setWorkflowNameSpy).toHaveBeenCalledWith({
newName: 'Test Workflow',
setStateDirty: false,
});
expect(setWorkflowSettingsSpy).toHaveBeenCalledWith({
executionOrder: 'v1',
timezone: 'DEFAULT',
});
expect(setWorkflowPinDataSpy).toHaveBeenCalledWith({});
expect(setWorkflowVersionIdSpy).toHaveBeenCalledWith('1');
expect(setWorkflowMetadataSpy).toHaveBeenCalledWith({});
expect(setWorkflowScopesSpy).toHaveBeenCalledWith(['workflow:create']);
expect(setUsedCredentialsSpy).toHaveBeenCalledWith([]);
expect(setWorkflowSharedWithSpy).toHaveBeenCalledWith({
workflowId: '1',
sharedWithProjects: [],
});
expect(setWorkflowTagIdsSpy).toHaveBeenCalledWith([]);
expect(upsertTagsSpy).toHaveBeenCalledWith([]);
});

it('should handle missing `usedCredentials` and `sharedWithProjects` gracefully', () => {
const { initState } = useWorkflowHelpers({ router });

const workflowData = createTestWorkflow({
id: '1',
name: 'Test Workflow',
active: true,
pinData: {},
meta: {},
scopes: [],
tags: [],
});
const setUsedCredentialsSpy = vi.spyOn(workflowsStore, 'setUsedCredentials');
const setWorkflowSharedWithSpy = vi.spyOn(workflowsEEStore, 'setWorkflowSharedWith');

initState(workflowData);

expect(setUsedCredentialsSpy).not.toHaveBeenCalled();
expect(setWorkflowSharedWithSpy).not.toHaveBeenCalled();
});

it('should handle missing `tags` gracefully', () => {
const { initState } = useWorkflowHelpers({ router });

const workflowData = createTestWorkflow({
id: '1',
name: 'Test Workflow',
active: true,
pinData: {},
meta: {},
scopes: [],
});
const setWorkflowTagIdsSpy = vi.spyOn(workflowsStore, 'setWorkflowTagIds');
const upsertTagsSpy = vi.spyOn(tagsStore, 'upsertTags');

initState(workflowData);

expect(setWorkflowTagIdsSpy).toHaveBeenCalledWith([]);
expect(upsertTagsSpy).toHaveBeenCalledWith([]);
});
});
});
1 change: 1 addition & 0 deletions packages/editor-ui/src/composables/useWorkflowHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1116,6 +1116,7 @@ export function useWorkflowHelpers(options: { router: ReturnType<typeof useRoute
workflowsStore.setWorkflowPinData(workflowData.pinData ?? {});
workflowsStore.setWorkflowVersionId(workflowData.versionId);
workflowsStore.setWorkflowMetadata(workflowData.meta);
workflowsStore.setWorkflowScopes(workflowData.scopes);

if (workflowData.usedCredentials) {
workflowsStore.setUsedCredentials(workflowData.usedCredentials);
Expand Down
5 changes: 5 additions & 0 deletions packages/editor-ui/src/stores/workflows.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -699,6 +699,10 @@ export const useWorkflowsStore = defineStore(STORES.WORKFLOWS, () => {
};
}

function setWorkflowScopes(scopes: IWorkflowDb['scopes']): void {
workflow.value.scopes = scopes;
mutdmour marked this conversation as resolved.
Show resolved Hide resolved
}

function setWorkflowMetadata(metadata: WorkflowMetadata | undefined): void {
workflow.value.meta = metadata;
}
Expand Down Expand Up @@ -1634,6 +1638,7 @@ export const useWorkflowsStore = defineStore(STORES.WORKFLOWS, () => {
setWorkflowTagIds,
addWorkflowTagIds,
removeWorkflowTagId,
setWorkflowScopes,
setWorkflowMetadata,
addToWorkflowMetadata,
setWorkflow,
Expand Down
Loading