IA-4776: Implemented data models for validation workflow by hugo093 · Pull Request #2750 · BLSQ/iaso

hugo093 · 2026-02-17T08:46:17Z

What problem is this PR solving?

Data modelling for the new validation workflow

Related JIRA tickets

IA-4776

Changes

Explain the changes that were made.

Added a base abstract CreatedAndUpdatedModel
Added django-autoslug
Created the main validation workflow models

Notes

Still WIP

bmonjoie · 2026-02-17T09:07:20Z

iaso/models/validation_workflow/run_instances.py

+    # we attach here any object, can be a form submission, an orgunit, whatever.
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    object_id = models.CharField(max_length=500, blank=True)
+    content_object = GenericForeignKey("content_type", "object_id")


As discussed, I am not a fan of GenericForeignKey, it lowers the performances and, AFAIK, doesn't give proper related fields on the other model.
I don't think we are going to have many (10+) different kinds of objects we want to validate so I would use nullable ForeignKeys instead.

I've never used GenericForeignKey, so I don't have any strong opinion (maybe I'll have one after I start using it? 😅)

It's a bit of a pain to use since it adds a level of indirection to foreign keys (you have to figure out what the models pointed at is before joining). It's neat as a concept, but I've found them difficult to optimize and handle.

As discussed, it's a good concept when you really don't know how many content types will be linked and/or there will be many content type. Otherwise adding nullable FKs is more than enough

bmonjoie · 2026-02-17T09:08:47Z

iaso/models/risp/__init__.py

+    "RISPNode",
+    "RISPNodeInstance",
+    "RISPTransition",
+    "RISPTransitionInstance",
+    "RISPWorkflow",
+    "RISPWorkflowInstance",


RISP is the client's account name. I don't think we should prefix any of the classes with it as this is going to be used by all clients.

bmonjoie · 2026-02-17T09:11:19Z

iaso/models/risp/run_instances.py

+from ..common import CreatedAndUpdatedModel
+
+
+class RISPWorkflowInstance(CreatedAndUpdatedModel):


Instance is also the name for Form's submissions. I think it's confusing to use it here.

Maybe ObjectValidationWorkflow ?

bmonjoie · 2026-02-17T09:11:53Z

iaso/models/validation_workflow/run_instances.py

+    """
+    Represents a running instance of the workflow
+    """


This is the same description as above

bmonjoie · 2026-02-17T09:12:35Z

iaso/models/risp/run_instances.py

+    content_object = GenericForeignKey("content_type", "object_id")
+
+
+class RISPNodeInstance(CreatedAndUpdatedModel):


Same remark about Instance.

Maybe ObjectValidationWorkflowNode

bmonjoie · 2026-02-17T09:20:30Z

iaso/models/risp/templates.py

+    slug = AutoSlugField(populate_from="name", unique=True)
+    description = models.TextField(blank=True, max_length=1024)
+
+    # is_active = models.BooleanField(default=True) => SoftDeletableModel ? needed ?


I would go with SoftDeletableModel as this is what is done everywhere else in the code base.

bmonjoie · 2026-02-17T09:21:19Z

iaso/models/risp/templates.py

+
+    # is_active = models.BooleanField(default=True) => SoftDeletableModel ? needed ?
+
+    owner = models.ForeignKey(get_user_model(), null=True, blank=True, on_delete=models.SET_NULL)


I'm not sure if this is useful. Probably a created_by and a updated_by fields make more sense to me

Yeah I agree, created_by and updated_by are the names we usually use in IASO whenever we need to store some kind of author/owner

bmonjoie · 2026-02-17T09:21:56Z

iaso/models/risp/templates.py

+from iaso.models.common import CreatedAndUpdatedModel
+
+
+class RISPWorkflow(CreatedAndUpdatedModel):


I would name it ValidationWorkflow

bmonjoie · 2026-02-17T09:22:12Z

iaso/models/risp/templates.py

+        ct = ContentType.objects.get_for_model(entity)
+        return self.allowed_content_types.filter(id=ct.id).exists()
+
+class RISPNode(CreatedAndUpdatedModel):


I would name it ValidationWorkflowNode

bmonjoie · 2026-02-17T09:22:46Z

iaso/models/risp/templates.py

+        return f"{self.workflow_id} - {self.name}"
+
+
+class RISPTransition(CreatedAndUpdatedModel):


I would name it ValidationWorkflowTransition.

Even though, I'm not sure I understand the role of this class. I think this class (and the corresponding "ObjectValidationWorkflowTransition") should be merged directly into the ValidationWorkflowNode class. To me, it adds unnecessary complexity but I might be missing something.

tdethier

I added some comments here and there.

Overall, it's good, and there are some nice ideas, but I think I'm missing something on the "instance" stuff. Maybe I misunderstood something.

We can discuss that later if you want

tdethier · 2026-02-17T12:44:43Z

iaso/migrations/0365_validationstateobject_validationstatetemplate_and_more.py

+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("iaso", "0364_alter_metricvalue_metric_type"),


I merged a PR with another migration yesterday, you should rebase develop and redo this migration file 😅

Will do at the end , thanks :)

tdethier · 2026-02-17T14:46:17Z

iaso/models/validation_workflow/run_instances.py

+    # we attach here any object, can be a form submission, an orgunit, whatever.
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    object_id = models.CharField(max_length=500, blank=True)
+    content_object = GenericForeignKey("content_type", "object_id")


I've never used GenericForeignKey, so I don't have any strong opinion (maybe I'll have one after I start using it? 😅)

tdethier · 2026-02-17T14:51:44Z

iaso/models/validation_workflow/templates.py

+    slug = AutoSlugField(populate_from="name", unique=True)
+    description = models.TextField(blank=True, max_length=1024)
+
+    # is_active = models.BooleanField(default=True) => SoftDeletableModel ? needed ?


Yeah I can see workflows being deleted by mistake, I would use SoftDeletableModel

tdethier · 2026-02-17T14:53:44Z

iaso/models/validation_workflow/templates.py

+class ValidationNode(CreatedAndUpdatedModel):
+    workflow = models.ForeignKey(ValidationWorkflow, on_delete=models.CASCADE, related_name="nodes")
+    name = models.CharField(max_length=256)
+    slug = AutoSlugField(populate_from="name")


Interesting! Does this mean that slug will be automatically updated when name changes or it's just set once on creation?

It can be yes, depends how you configure it. I've added some tests in models so you have an example. Otherwise the doc is quite simple and explicit

tdethier · 2026-02-17T14:55:21Z

iaso/models/validation_workflow/templates.py

+    from_node = models.ForeignKey(ValidationNode, on_delete=models.CASCADE, related_name="from_node")
+    to_node = models.ForeignKey(ValidationNode, on_delete=models.CASCADE, related_name="to_node")
+
+    roles_required = models.ManyToManyField(UserRole, blank=True)


So, this means that reusing UserRole sounds like the best plan to you?

Don't have any strong opinion on this tbh 😄

tdethier · 2026-02-17T15:04:16Z

iaso/models/validation_workflow/run_instances.py

+from .templates import ValidationNode, ValidationWorkflow
+
+
+class ValidationWorkflowInstance(CreatedAndUpdatedModel):


It's annoying to have Instance in the name of these models since it already means something else in IASO and is confusing.
Maybe we should remove Instance from these names (or maybe it's time to finally rename Instance to Submission 🤓)

Understood, I renamed most of the models to have a more meaningful business logic, also tried to avoid using instance

tdethier · 2026-02-17T15:08:35Z

iaso/models/validation_workflow/run_instances.py

+    )
+
+
+class ValidationTransitionInstance(CreatedAndUpdatedModel):


I agree with Benjamin, I'm not sure about this class. I understand the ones in templates.py, but I'm not sure about this and ValidationNodeInstance.

Maybe there's something that I'm missing

tdethier · 2026-02-17T15:09:29Z

iaso/models/risp/templates.py

+
+    # is_active = models.BooleanField(default=True) => SoftDeletableModel ? needed ?
+
+    owner = models.ForeignKey(get_user_model(), null=True, blank=True, on_delete=models.SET_NULL)


Yeah I agree, created_by and updated_by are the names we usually use in IASO whenever we need to store some kind of author/owner

tdethier · 2026-02-17T15:10:45Z

iaso/models/risp/templates.py

+    """
+    The main workflow object that is a template, a static definition of a workflow
+    """
+    uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)


In IASO, UUIDs are usually generated by the mobile app and stored in parallel to a standard int ID that's used mostly for the backend.

When there's no object creation on mobile, we usually don't add UUIDs

… on the engine + added some tests

tdethier · 2026-02-19T16:19:21Z

iaso/tests/test_engine/test_validation_workflow.py

+        # get the next step pending => how? => need to find a better way ?
+        step_object = ValidationStepObject.objects.filter(step_template=self.step).first()
+
+        WorkflowEngine.complete_step(step_object, True, self.other_user)


I would expect the workflow to know where we're currently at

tdethier · 2026-02-19T16:25:27Z

iaso/tests/test_engine/test_validation_workflow.py

+        # we check the ending state object has not been created
+        self.assertFalse(
+            ValidationStateObject.objects.filter(
+                workflow_object=workflow_object, state_template=self.end_state
+            ).exists()
+        )


I'm not sure why there's no object created here

madewulf · 2026-02-20T08:28:05Z

iaso/models/validation_workflow/run_instances.py

I don't understand the name of the file

madewulf · 2026-02-20T08:29:24Z

iaso/models/validation_workflow/run_instances.py

+    CANCELLED = "cancelled", _("Cancelled")
+
+
+class ValidationWorkflowObject(CreatedAndUpdatedModel):


I'm quite sure this should be a SoftDeletableModel

As probably all the models that are in this PR

Ok, since this is not something that users will be allowed to delete, it does make sense that it's not soft deletable

madewulf · 2026-02-21T10:08:15Z

iaso/models/validation_workflow/templates.py

+
+    roles_required = models.ManyToManyField(UserRole, blank=True)  # todo : define if we want roles or permissions ?
+
+    priority = models.PositiveIntegerField(default=0)


I don't understand why we need this and where this notion comes from

madewulf · 2026-02-21T10:12:45Z

iaso/models/validation_workflow/run_instances.py

+    ACTIVE = "active", _("Active")
+    APPROVED = "approved", _("Approved")
+    REJECTED = "rejected", _("Rejected")
+    CANCELLED = "cancelled", _("Cancelled")


What does it mean for a validation state to be cancelled, approved or rejected?
It feels like my states have states ;-)

madewulf · 2026-02-21T10:19:53Z

iaso/engine/validation_workflow.py

+
+        state_template = state_object.state_template
+        # transitions = node_object.outgoing_transition_objects.all()
+        #


My impression is that commented code should not be here (but I know it's a draft, so, this will probably be removed)

madewulf · 2026-02-21T10:29:32Z

iaso/engine/validation_workflow.py

+
+        # Create ValidationStepObject for all steps outgoing from this state
+        with transaction.atomic():
+            ValidationStepObject.objects.bulk_create(


I find it a bit wasteful to create in advance all the possible transitions. Why not just create the transition that really happened and compute the possibilities on the fly when presenting to the users (instead of loading that from te database). It will also lends itsefl better to have workflows that are changed on the fly. (If you remove a step in a workflow in the current implementation, you have to remove all the tentative steps in the workflow objects if you want to allow users to adapt)

madewulf · 2026-02-21T10:32:01Z

iaso/engine/validation_workflow.py

+        # START node auto-completes
+        if state_template.state_type == ValidationStateTemplateType.START:
+            state_object.status = ValidationStateObjectStatus.COMPLETED
+            state_object.save(update_fields=["status"])


I don't totally see the sense of having states to be completed. I would say that the state of a workflow object is just the last state it was in, all previous states are in the past and consequently "completed"

Implemented models, added django-autoslug

5ccd9e4

hugo093 requested review from bmonjoie, madewulf, quang-le and tdethier February 17, 2026 09:01

Rename from risp to validation_workflow, remove services, ruff checks

e2c5115

bmonjoie reviewed Feb 17, 2026

View reviewed changes

tdethier reviewed Feb 17, 2026

View reviewed changes

hugo093 added 3 commits February 17, 2026 18:04

Started the engine, added some tests, model adaptations

f9f4a05

Renaming classes and models for better understanding, started working…

1cab1ca

… on the engine + added some tests

rename rejection_comment to comment, added tests for permission check

c81375e

tdethier reviewed Feb 19, 2026

View reviewed changes

undo feature for step

0295bb3

madewulf reviewed Feb 20, 2026

View reviewed changes

iaso/models/validation_workflow/run_instances.py

Copy link

Member

madewulf Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the name of the file

madewulf reviewed Feb 20, 2026

View reviewed changes

madewulf reviewed Feb 21, 2026

View reviewed changes

		from ..common import CreatedAndUpdatedModel


		class RISPWorkflowInstance(CreatedAndUpdatedModel):

		content_object = GenericForeignKey("content_type", "object_id")


		class RISPNodeInstance(CreatedAndUpdatedModel):


		# is_active = models.BooleanField(default=True) => SoftDeletableModel ? needed ?

		owner = models.ForeignKey(get_user_model(), null=True, blank=True, on_delete=models.SET_NULL)

		from iaso.models.common import CreatedAndUpdatedModel


		class RISPWorkflow(CreatedAndUpdatedModel):

		return f"{self.workflow_id} - {self.name}"


		class RISPTransition(CreatedAndUpdatedModel):

		from .templates import ValidationNode, ValidationWorkflow


		class ValidationWorkflowInstance(CreatedAndUpdatedModel):

		)


		class ValidationTransitionInstance(CreatedAndUpdatedModel):

		CANCELLED = "cancelled", _("Cancelled")


		class ValidationWorkflowObject(CreatedAndUpdatedModel):


		roles_required = models.ManyToManyField(UserRole, blank=True) # todo : define if we want roles or permissions ?

		priority = models.PositiveIntegerField(default=0)

Comments

Conversation

hugo093 commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What problem is this PR solving?

Related JIRA tickets

Changes

Notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdethier left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdethier Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

hugo093 commented Feb 17, 2026 •

edited

Loading

tdethier left a comment •

edited

Loading

tdethier Feb 17, 2026 •

edited

Loading

madewulf Feb 21, 2026 •

edited

Loading

madewulf Feb 21, 2026 •

edited

Loading