Automatically saving workflows can result in overwriting changes made by others

[a5223594]

Self Checks

• This is only for bug report, if you would like to ask a quesion, please head to Discussions.
• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• Pleas do not modify this template :) and fill in all the required fields.

Dify version

latest

Cloud or Self Hosted

Self Hosted (Source)

Steps to reproduce

When developing a workflow together or forgetting to close the browser tab, the old configuration will be automatically saved, overwriting unpublished content from others

✔️ Expected Behavior

There should be a concept of version, where everyone can create a new version when making changes. It is prohibited to make changes to the old version, otherwise the same configuration can be easily overwritten. It should be clear which version the exposed interface references

❌ Actual Behavior

override the same configuration

[dosubot[bot]]

To address the issue of automatic workflow saves overwriting changes made by others, implementing version control is a practical solution. Here's a strategy to integrate version control into your workflow management:

1. Implement Version Tracking: Incorporate a version tracking system in your workflow data model. This could involve incrementing a version number or using timestamps/hashes for each change.

2. Adjust the publishWorkflow Function: Modify this function to create a new version on publish, rather than overwriting the existing workflow. This involves saving the workflow with a new version identifier.

3. Ensure Editing the Latest Version: Before allowing edits, verify the user is working on the latest version. This may require fetching the latest version from the server and comparing it with the user's version.

4. Concurrent Edits Handling: Develop a strategy to manage concurrent edits, which could include locking the workflow for a single user or merging changes from multiple users.

5. Update UI for Version Control: Reflect version control in the UI by disabling editing on older versions, showing version history, and providing options for version comparison or reversion.

Here's a basic example to start implementing these concepts:

const publishWorkflow = async (endpoint: string) => {
  const newVersionData = { ...workflowData, version: getNextVersion() };
  const response = await fetch(endpoint, {
    method: 'POST',
    body: JSON.stringify(newVersionData),
    headers: {
      'Content-Type': 'application/json',
    },
  });
  if (!response.ok) {
    throw new Error('Failed to publish new version');
  }
  return await response.json();
};

const getNextVersion = () => {
  return latestVersion + 1; // Simplified example, assumes tracking of the latest version
};

const checkIfLatestVersion = async () => {
  // Logic to fetch the latest version and compare with the current version
};

This approach ensures that each change creates a new version, preventing overwrites and facilitating clearer version management.

Sources

• web/app/components/workflow/header/index.tsx
• api/core/workflow/nodes/tool/tool_node.py
• api/controllers/console/app/workflow.py

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.