Fix workflow deletion and edge creation #28

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

Closed

Manas-Kenge wants to merge 81 commits into main from test-1

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,149 +1,89 @@
  
    # workflow-manager 🚀

    # Volto Workflow Manager

    [![Built with Cookieplone](https://img.shields.io/badge/built%20with-Cookieplone-0083be.svg?logo=cookiecutter)](https://github.com/plone/cookieplone-templates/)

    [![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

    [![Backend Tests](https://github.com/collective/workflow-manager/actions/workflows/backend.yml/badge.svg)](https://github.com/collective/workflow-manager/actions/workflows/backend.yml)

    [![Frontend Tests](https://github.com/collective/workflow-manager/actions/workflows/frontend.yml/badge.svg)](https://github.com/collective/workflow-manager/actions/workflows/frontend.yml)

    Volto Workflow Manager is a visual workflow editor for Plone.  

    It lets you create, manage, and edit workflows inside the Volto UI using a simple graph-based interface.

    A new project using Plone 6.

    ---

    ## Quick Start 🏁

    ## Installation

    ### Prerequisites ✅

    This package is a Volto add-on. To install it in your Volto project:

    -   An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.

    -   [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)

    -   [nvm](https://6.docs.plone.org/install/create-project-cookieplone.html#nvm)

    -   [Node.js and pnpm](https://6.docs.plone.org/install/create-project.html#node-js) 22

    -   [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)

    -   [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)

    -   [Docker](https://docs.docker.com/get-started/get-docker/) (optional)

    1. Add `workflow-manager` to your project's `package.json`:

    ### Installation 🔧

    1.  Clone this repository, then change your working directory.

        ```shell

        git clone git@github.com:collective/workflow-manager.git

        cd workflow-manager

        ```json

        {

          "addons": ["workflow-manager"]

        }

        ```

    2.  Install this code base.

    2. Install dependencies:

        ```shell

        make install

        ```bash

        pnpm install

        ```

    3. Start the Volto development server:

    ### Fire Up the Servers 🔥

    1.  Create a new Plone site on your first run.

        ```shell

        make backend-create-site

        ```bash

        pnpm start

        ```

    2.  Start the backend at http://localhost:8080/.

    ---

        ```shell

        make backend-start

        ```

    ## How to Use

    3.  In a new shell session, start the frontend at http://localhost:3000/.

    1. Open the **Control Panel** and select **Workflow Manager**.

    2. Create a new workflow if one does not exist.

    3. Add states and transitions using the graph interface.

    4. Edit state and transition details from the sidebar.

    5. Assign permissions and roles as needed.

    6. Save changes using the Volto toolbar.

        ```shell

        make frontend-start

        ```

    Voila! Your Plone site should be live and kicking! 🎉

    ### Local Stack Deployment 📦

    ---

    Deploy a local `Docker Compose` environment that includes:

    ## Development Setup

    - Docker images for Backend and Frontend 🖼️

    - A stack with a Traefik router and a Postgres database 🗃️

    - Accessible at [http://workflow-manager.localhost](http://workflow-manager.localhost) 🌐

    If you want to contribute or customize the add-on locally:

    Execute the following:

    ```shell

    make stack-start

    make stack-create-site

    ```

    ## Requirements

    And... you're all set! Your Plone site is up and running locally! 🚀

    - [Node.js 22](https://6.docs.plone.org/install/create-project.html#node-js) 

    - [pnpm](https://pnpm.io/)

    - [UV](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)

    ## Project Structure 🏗️

    ### Installation 

    This monorepo consists of the following distinct sections:

    1. Clone the repository:

    - **backend**: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named workflow.manager.

    - **frontend**: Contains the React (Volto) package.

    - **devops**: Encompasses Docker Stack, Ansible playbooks, and Cache settings.

    - **docs**: Scaffold for writing documentation for your project.

    ### Why This Structure? 🤔

    - All necessary codebases to run the site are contained within the repo (excluding existing addons for Plone and React).

    - Specific GitHub Workflows are triggered based on changes in each codebase (refer to .github/workflows).

    - Simplifies the creation of Docker images for each codebase.

    - Demonstrates Plone installation/setup without buildout.

    ## Code Quality Assurance 🧐

    To automatically format your code and ensure it adheres to quality standards, execute:

    ```shell

    make check

    ```sh

    git clone https://github.com/Manas-Kenge/workflow-manager.git

    cd workflow-manager

    ```

    ### Format the codebase

    2. Install dependencies for both Backend and Frontend:

    To format the codebase, it is possible to run `format`:

    ```shell

    make format

    ```sh

    make install

    ```

    | Section | Tool | Description | Configuration |

    | --- | --- | --- | --- |

    | backend | Ruff | Python code formatting, imports sorting  | [`backend/pyproject.toml`](./backend/pyproject.toml) |

    | backend | `zpretty` | XML and ZCML formatting  | -- |

    | frontend | ESLint | Fixes most common frontend issues | [`frontend/.eslintrc.js`](.frontend/.eslintrc.js) |

    | frontend | prettier | Format JS and Typescript code  | [`frontend/.prettierrc`](.frontend/.prettierrc) |

    | frontend | Stylelint | Format Styles (css, less, sass)  | [`frontend/.stylelintrc`](.frontend/.stylelintrc) |

    Formatters can also be run within the `backend` or `frontend` folders.

    ### Start the Servers

    ### Linting the codebase

    or `lint`:

    1. Start the **Backend** (Plone) at [http://localhost:8080/](http://localhost:8080/):

     ```shell

    make lint

    ```sh

    make backend-start

    ```

    | Section | Tool | Description | Configuration |

    | --- | --- | --- | --- |

    | backend | Ruff | Checks code formatting, imports sorting  | [`backend/pyproject.toml`](./backend/pyproject.toml) |

    | backend | Pyroma | Checks Python package metadata  | -- |

    | backend | check-python-versions | Checks Python version information  | -- |

    | backend | `zpretty` | Checks XML and ZCML formatting  | -- |

    | frontend | ESLint | Checks JS / Typescript lint | [`frontend/.eslintrc.js`](.frontend/.eslintrc.js) |

    | frontend | prettier | Check JS / Typescript formatting  | [`frontend/.prettierrc`](.frontend/.prettierrc) |

    | frontend | Stylelint | Check Styles (css, less, sass) formatting  | [`frontend/.stylelintrc`](.frontend/.stylelintrc) |

    Linters can be run individually within the `backend` or `frontend` folders.

    2. In a new terminal, start the **Frontend** (Volto) at [http://localhost:3000/](http://localhost:3000/):

    ## Internationalization 🌐

    ```sh

    make frontend-start

    ```

    Generate translation files for Plone and Volto with ease:

     Your Plone development environment is now live!

    ```shell

    make i18n

    ```

    ## Credits and Acknowledgements 🙏

    # License

    Generated using [Cookieplone (0.9.7)](https://github.com/plone/cookieplone) and [cookieplone-templates (684d5c7)](https://github.com/plone/cookieplone-templates/commit/684d5c7f43a6ebc3184e2a0106b0160820a96e66) on 2025-05-22 13:24:17.198737. A special thanks to all contributors and supporters!

    This project is licensed under the MIT License.

backend/src/workflow/manager/actionmanager.py

-Original file line number
+Diff line change
@@ -0,0 +1,115 @@
+    from zope.component import queryUtility
+    from plone.memoize.instance import memoize
+    from plone.contentrules.engine.interfaces import IRuleStorage, IRuleAssignmentManager
+    from plone.app.contentrules.conditions.wftransition import WorkflowTransitionCondition
+    from plone.contentrules.engine import utils
+    from plone.app.contentrules.rule import Rule, get_assignments
+    from plone.contentrules.engine.assignments import RuleAssignment
+    from Products.CMFCore.interfaces._events import IActionSucceededEvent
+    from Products.CMFCore.utils import getToolByName
+    from workflow.manager.utils import generateRuleName, generateRuleNameOld
+    from zope.i18nmessageid import MessageFactory
+    _ = MessageFactory("plone")
+    class RuleAdapter:
+        """Adapter for managing content rules with workflow transitions."""
+        def __init__(self, rule, transition):
+            self.rule = rule
+            self.transition = transition
+        @property
+        @memoize
+        def portal(self):
+            return getToolByName(self.transition, 'portal_url').getPortalObject()
+        def activate(self):
+            """
+) make sure condition is enabled for transition
+) enable at root and bubble to item below
+            """
+            c = WorkflowTransitionCondition()
+            c.wf_transitions = [self.transition.id]
+            self.rule.conditions = [c]
+            self.rule.event = IActionSucceededEvent
+            assignable = IRuleAssignmentManager(self.portal)
+            path = '/'.join(self.portal.getPhysicalPath())
+            assignable[self.rule.__name__] = RuleAssignment(
+                self.rule.id,
+                enabled=True,
+                bubbles=True
+            )
+            assignments = get_assignments(self.rule)
+            if path not in assignments:
+                assignments.insert(path)
+        @property
+        def id(self):
+            return self.rule.id
+        def get_action(self, index):
+            return self.rule.actions[index]
+        def action_index(self, action):
+            return self.rule.actions.index(action)
+        def action_url(self, action):
+            return f'{self.portal.absolute_url()}/{self.rule.id}/++action++{self.action_index(action)}/edit'
+        def delete_action(self, index):
+            self.rule.actions.remove(self.rule.actions[index])
+        @property
+        def actions(self):
+            return self.rule.actions
+    class ActionManager:
+        """Manager for workflow transition content rules and actions."""
+        def get_rule(self, transition):
+            rulename = generateRuleName(transition)
+            rulename_old = generateRuleNameOld(transition)
+            if self.storage is not None:
+                for rule in self.storage.values():
+                    if rule.__name__ in (rulename, rulename_old):
+                        return RuleAdapter(rule, transition)
+            return None
+        def create(self, transition):
+            rule = self.get_rule(transition)
+            if rule is None:
+                rule_id = generateRuleName(transition)
+                r = Rule()
+                r.title = _("%s transition content rule") % transition.id
+                r.description = _(
+                    "This content rule was automatically created by "
+                    "the workflow manager to create actions on "
+                    "workflow events. If you want the behavior to "
+                    "work as expected, do not modify this out of "
+                    "the workflow manager."
+                )
+                self.storage[rule_id] = r
+                rule = RuleAdapter(r, transition)
+                rule.activate()
+            return rule
+        @property
+        @memoize
+        def storage(self):
+            return queryUtility(IRuleStorage)
+        @property
+        @memoize
+        def available_actions(self):
+            return utils.allAvailableActions(IActionSucceededEvent)
+        def delete_rule_for(self, transition):
+            rule = self.get_rule(transition)
+            if rule is not None:
+                del self.storage[rule.rule.__name__]

backend/src/workflow/manager/api/__init__.py

Empty file.

backend/src/workflow/manager/api/configure.zcml

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    <configure
+        xmlns="http://namespaces.zope.org/zope"
+        xmlns:browser="http://namespaces.zope.org/browser"
+        xmlns:plone="http://namespaces.plone.org/plone"
+        i18n_domain="workflow.manager">
+      <!-- -*- extra stuff goes here -*- -->
+      <include package=".services" />
+    </configure>

backend/src/workflow/manager/api/services/__init__.py

Empty file.

backend/src/workflow/manager/api/services/configure.zcml

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    <configure
+        xmlns="http://namespaces.zope.org/zope"
+        xmlns:browser="http://namespaces.zope.org/browser"
+        xmlns:plone="http://namespaces.plone.org/plone"
+        i18n_domain="workflow.manager">
+      <!-- -*- extra stuff goes here -*- -->
+    <include package=".workflow" />
+    </configure>

backend/src/workflow/manager/api/services/workflow/__init__.py

Empty file.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix workflow deletion and edge creation #28

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!