Rewrite model check as validation check re #10079 (#11646)

jacobtylerwalls · web-flow · commit b9dc94fb9507 · 2024-12-03T12:10:43.000-05:00
* Rewrite model check as validation check re #10079 This model check should have been skippped by checking the `databases` kwarg provided when `check()` is called, but that reduces the circumstances on which this check is run to either: - manage.py migrate - manage.py check --databases So, given how infrequently this would be run, better to just implement this in our validation framework. This also prevents the possibility of failures when migrating.
diff --git a/.github/actions/build-and-test-branch/action.yml b/.github/actions/build-and-test-branch/action.yml
@@ -33,7 +33,7 @@ runs:
 
     - name: Ensure frontend configuration files exist
       run: |
-          python manage.py check --tag=compatibility
+          python manage.py check
       shell: bash
 
     - name: Install Arches applications
@@ -74,7 +74,7 @@ runs:
 
     - name: Check for missing migrations
       run: |
-        python manage.py makemigrations --check --skip-checks
+        python manage.py makemigrations --check
       shell: bash
 
     - name: Ensure previous Python coverage data is erased
diff --git a/arches/app/const.py b/arches/app/const.py
@@ -4,13 +4,15 @@
 IntegrityCheckDescriptions = {
     1005: "Nodes with ontologies found in graphs without ontologies",
     1012: "Node Groups without matching nodes",
+    1014: "Publication missing for language",
 }
 
 
 @unique
 class IntegrityCheck(Enum):
     NODE_HAS_ONTOLOGY_GRAPH_DOES_NOT = 1005
     NODELESS_NODE_GROUP = 1012
+    PUBLICATION_MISSING_FOR_LANGUAGE = 1014
 
     def __str__(self):
         return IntegrityCheckDescriptions[self.value]
diff --git a/arches/app/models/models.py b/arches/app/models/models.py
@@ -613,39 +613,6 @@ def save(self, *args, **kwargs):
 
         super(GraphModel, self).save(*args, **kwargs)
 
-    @classmethod
-    def check(cls, **kwargs):
-        errors = super().check(**kwargs)
-        errors.extend(cls._check_publication_in_every_language())
-        return errors
-
-    @classmethod
-    def _check_publication_in_every_language(cls):
-        errors = []
-        system_languages = {lang[0] for lang in settings.LANGUAGES}
-
-        for graph in (
-            cls.objects.filter(publication__isnull=False)
-            .select_related("publication")
-            .prefetch_related("publication__publishedgraph_set")
-        ):
-            languages_with_a_publication = {
-                published_graph.language_id
-                for published_graph in graph.publication.publishedgraph_set.all()
-            }
-            missing_languages = system_languages - languages_with_a_publication
-            if missing_languages:
-                errors.append(
-                    checks.Error(
-                        "This graph is not published in all enabled languages.",
-                        hint="Run python manage.py graph publish --update",
-                        obj=graph,
-                        id="arches.E004",  # TODO: enum in arches 8
-                    )
-                )
-
-        return errors
-
     def __str__(self):
         return str(self.name)
 
diff --git a/arches/install/arches-templates/.github/actions/build-and-test-branch/action.yml b/arches/install/arches-templates/.github/actions/build-and-test-branch/action.yml
@@ -33,7 +33,7 @@ runs:
     
     - name: Ensure frontend configuration files exist
       run: |
-          python manage.py check --tag=compatibility
+          python manage.py check
       shell: bash
 
     - name: Install Arches applications
@@ -74,7 +74,7 @@ runs:
 
     - name: Check for missing migrations
       run: |
-        python manage.py makemigrations --check --skip-checks
+        python manage.py makemigrations --check
       shell: bash
 
     - name: Ensure previous Python coverage data is erased
diff --git a/arches/management/commands/graph.py b/arches/management/commands/graph.py
@@ -23,14 +23,7 @@
 
 
 class Command(BaseCommand):
-    """
-    Commands for adding arches test users
-
-    """
-
-    # Silence system checks since this command is the cure for
-    # one of the system checks (arches.E004)
-    requires_system_checks = []
+    """Commands for updating graphs."""
 
     def add_arguments(self, parser):
         parser.add_argument(
diff --git a/arches/management/commands/packages.py b/arches/management/commands/packages.py
@@ -73,9 +73,6 @@ class Command(BaseCommand):
 
     """
 
-    # Silence system checks: if run with -db, should always succeed.
-    requires_system_checks = []
-
     def add_arguments(self, parser):
         parser.add_argument(
             "-o",
diff --git a/arches/management/commands/setup_db.py b/arches/management/commands/setup_db.py
@@ -36,9 +36,6 @@ class Command(BaseCommand):
     during development.
     """
 
-    # Silence system checks: this command should always succeed.
-    requires_system_checks = []
-
     def add_arguments(self, parser):
 
         parser.add_argument(
diff --git a/arches/management/commands/updateproject.py b/arches/management/commands/updateproject.py
@@ -51,30 +51,3 @@ def update_to_v8(self):
             os.remove(declarations_test_file_path)
 
         self.stdout.write("Done!")
-
-        # Update certain lines in GitHub Actions workflows.
-        self.stdout.write("Updating GitHub Actions...")
-        action_path = os.path.join(
-            settings.APP_ROOT,
-            "..",
-            ".github",
-            "actions",
-            "build-and-test-branch",
-            "action.yml",
-        )
-        if os.path.exists(action_path):
-            first_find = "python manage.py check\n"
-            first_replace = "python manage.py check --tag=compatibility\n"
-            second_find = "python manage.py makemigrations --check\n"
-            second_replace = "python manage.py makemigrations --check --skip-checks\n"
-            with open(action_path, "r") as f:
-                content = f.readlines()
-            for i, line in enumerate(content):
-                if line.endswith(first_find):
-                    content[i] = line.replace(first_find, first_replace)
-                elif line.endswith(second_find):
-                    content[i] = line.replace(second_find, second_replace)
-            with open(action_path, "w") as f:
-                f.writelines(content)
-
-        self.stdout.write("Done!")
diff --git a/arches/management/commands/validate.py b/arches/management/commands/validate.py
@@ -18,19 +18,23 @@
 
 from datetime import datetime
 
+from django.conf import settings
+from django.contrib.postgres.aggregates import ArrayAgg
+from django.core.management import BaseCommand, CommandError, call_command
+from django.db import transaction
+from django.db.models import Exists, OuterRef, Q, Subquery
+
 from arches import __version__
 from arches.app.const import IntegrityCheck
 from arches.app.models import models
-from django.core.management.base import BaseCommand, CommandError
-from django.db import transaction
-from django.db.models import Exists, OuterRef
 
 # Command modes
 FIX = "fix"
 VALIDATE = "validate"
 
 # Fix actions
 DELETE_QUERYSET = "delete queryset"
+UPDATE_GRAPH_PUBLICATIONS = "manage.py graph --update"
 
 
 class Command(BaseCommand):
@@ -116,6 +120,36 @@ def handle(self, *args, **options):
             ),
             fix_action=DELETE_QUERYSET,
         )
+        self.check_integrity(
+            check=IntegrityCheck.PUBLICATION_MISSING_FOR_LANGUAGE,  # 1014
+            queryset=(
+                models.GraphModel.objects.filter(
+                    isresource=True,
+                    publication__isnull=False,
+                    source_identifier=None,
+                )
+                .annotate(
+                    publications_in_system_languages=ArrayAgg(
+                        Subquery(
+                            models.PublishedGraph.objects.filter(
+                                pk=OuterRef("publication__publishedgraph"),
+                            )
+                            .values("language")
+                            .distinct()
+                        ),
+                        filter=Q(
+                            publication__publishedgraph__language__in=[
+                                lang[0] for lang in settings.LANGUAGES
+                            ]
+                        ),
+                    )
+                )
+                .filter(
+                    publications_in_system_languages__len__lt=len(settings.LANGUAGES)
+                )
+            ),
+            fix_action=UPDATE_GRAPH_PUBLICATIONS,
+        )
 
     def check_integrity(self, check, queryset, fix_action):
         # 500 not set as a default earlier: None distinguishes whether verbose output implied
@@ -146,10 +180,24 @@ def check_integrity(self, check, queryset, fix_action):
             elif queryset.exists():
                 fix_status = self.style.ERROR("No")  # until actually fixed below
                 # Perform fix action
-                if fix_action is DELETE_QUERYSET:
+                if fix_action == DELETE_QUERYSET:
                     with transaction.atomic():
                         queryset.delete()
                     fix_status = self.style.SUCCESS("Yes")
+                elif fix_action == UPDATE_GRAPH_PUBLICATIONS:
+                    call_command(
+                        "graph",
+                        "publish",
+                        "--update",
+                        "-g",
+                        ",".join(
+                            str(pk) for pk in queryset.values_list("pk", flat=True)
+                        ),
+                        verbosity=self.options["verbosity"],
+                        stdout=self.stdout,
+                        stderr=self.stderr,
+                    )
+                    fix_status = self.style.SUCCESS("Yes")
                 else:
                     raise NotImplementedError
             else:
diff --git a/releases/8.0.0.md b/releases/8.0.0.md
@@ -19,7 +19,6 @@ Arches 8.0.0 Release Notes
 
 ### Additional highlights
 - Add session-based REST APIs for login, logout [#11261](https://github.com/archesproject/arches/issues/11261)
-- Add system check advising next action when enabling additional languages without updating graphs [#10079](https://github.com/archesproject/arches/issues/10079)
 - Improve handling of longer model names [#11317](https://github.com/archesproject/arches/issues/11317)
 - Support more expressive plugin URLs [#11320](https://github.com/archesproject/arches/issues/11320)
 - Make node aliases not nullable [#10437](https://github.com/archesproject/arches/issues/10437)
@@ -107,6 +106,12 @@ JavaScript:
 
 4. Update your Graph publications and Resource instances to point to the newly published Graphs by running `python manage.py graph publish --update -ui`
 
+1. Also consider running validation checks:
+    ```
+    python manage.py validate
+    python manage.py validate --fix [error]
+    ```
+
 5. Within your project with your Python 3 virtual environment activated:
     ```
     python manage.py es reindex_database
