-
-
Notifications
You must be signed in to change notification settings - Fork 24.4k
fix: preserve chatflow id on API create #6419
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
Open
puneetdixit200
wants to merge
1
commit into
FlowiseAI:main
Choose a base branch
from
puneetdixit200:bugfix/preserve-chatflow-api-id
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
102 changes: 102 additions & 0 deletions
102
packages/server/src/controllers/chatflows/index.test.ts
This file contains hidden or 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,102 @@ | ||
| jest.mock('../../database/entities/ChatFlow', () => ({ | ||
| ChatFlow: class ChatFlow {} | ||
| })) | ||
|
|
||
| jest.mock('../../enterprise/services/workspace-user.service', () => ({ | ||
| WorkspaceUserErrorMessage: { | ||
| WORKSPACE_USER_NOT_FOUND: 'Workspace user not found' | ||
| }, | ||
| WorkspaceUserService: jest.fn() | ||
| })) | ||
|
|
||
| jest.mock('../../services/chatflows', () => ({ | ||
| __esModule: true, | ||
| default: { | ||
| getAllChatflowsCountByOrganization: jest.fn(), | ||
| saveChatflow: jest.fn() | ||
| } | ||
| })) | ||
|
|
||
| jest.mock('../../utils/getRunningExpressApp', () => ({ | ||
| getRunningExpressApp: jest.fn().mockReturnValue({ usageCacheManager: {} }) | ||
| })) | ||
|
|
||
| jest.mock('../../utils/quotaUsage', () => ({ | ||
| checkUsageLimit: jest.fn().mockResolvedValue(undefined) | ||
| })) | ||
|
|
||
| jest.mock('../../utils/rateLimit', () => ({ | ||
| RateLimiterManager: { | ||
| getInstance: jest.fn().mockReturnValue({ updateRateLimiter: jest.fn() }) | ||
| } | ||
| })) | ||
|
|
||
| jest.mock('../../utils/sanitizeFlowData', () => ({ | ||
| sanitizeFlowDataForPublicEndpoint: jest.fn() | ||
| })) | ||
|
|
||
| jest.mock('../../services/apikey', () => ({ | ||
| __esModule: true, | ||
| default: {} | ||
| })) | ||
|
|
||
| jest.mock('../../services/schedule', () => ({ | ||
| __esModule: true, | ||
| default: {} | ||
| })) | ||
|
|
||
| jest.mock('../../schedule/ScheduleBeat', () => ({ | ||
| ScheduleBeat: { | ||
| getInstance: jest.fn().mockReturnValue({ onScheduleChanged: jest.fn() }) | ||
| } | ||
| })) | ||
|
|
||
| import chatflowsController from './index' | ||
| import chatflowsService from '../../services/chatflows' | ||
| import { checkUsageLimit } from '../../utils/quotaUsage' | ||
|
|
||
| const mockChatflowsService = chatflowsService as jest.Mocked<typeof chatflowsService> | ||
| const mockCheckUsageLimit = checkUsageLimit as jest.Mock | ||
|
|
||
| describe('chatflowsController.saveChatflow', () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks() | ||
| mockChatflowsService.getAllChatflowsCountByOrganization.mockResolvedValue(0) | ||
| mockChatflowsService.saveChatflow.mockImplementation(async (chatflow) => chatflow) | ||
| mockCheckUsageLimit.mockResolvedValue(undefined) | ||
| }) | ||
|
|
||
| it('preserves a caller-provided chatflow id when creating a chatflow', async () => { | ||
| const chatflowId = '11111111-1111-4111-8111-111111111111' | ||
| const req = { | ||
| body: { | ||
| id: chatflowId, | ||
| name: 'Restored flow', | ||
| flowData: JSON.stringify({ nodes: [], edges: [] }), | ||
| type: 'CHATFLOW' | ||
| }, | ||
| user: { | ||
| activeOrganizationId: 'org-1', | ||
| activeWorkspaceId: 'ws-1', | ||
| activeOrganizationSubscriptionId: 'sub-1' | ||
| } | ||
| } | ||
| const res = { json: jest.fn() } | ||
| const next = jest.fn() | ||
|
|
||
| await chatflowsController.saveChatflow(req as any, res as any, next) | ||
|
|
||
| expect(next).not.toHaveBeenCalled() | ||
| expect(mockChatflowsService.saveChatflow).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| id: chatflowId, | ||
| workspaceId: 'ws-1' | ||
| }), | ||
| 'org-1', | ||
| 'ws-1', | ||
| 'sub-1', | ||
| {} | ||
| ) | ||
| expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ id: chatflowId })) | ||
| }) | ||
| }) |
This file contains hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
Object.prototype.hasOwnProperty.callon a class instance likenewChatFlow(which is an instance of theChatFlowentity) can be unreliable. Depending on the TypeScript configuration (specificallyuseDefineForClassFields), class properties might be initialized toundefinedin the constructor, which would causehasOwnPropertyto returntrueeven if the property wasn't explicitly provided by the caller. This would lead to aBAD_REQUESTerror on every chatflow creation where an ID is not provided. A safer and more idiomatic approach is to use a nullish check.References