Add opaque_id to user tests

prandla · prandla · commit 050f5d1d1b9b · 2025-08-31T11:10:42.000+03:00
diff --git a/cms/db/__init__.py b/cms/db/__init__.py
@@ -81,7 +81,7 @@
 
 # Instantiate or import these objects.
 
-version = 46
+version = 47
 
 engine = create_engine(config.database.url, echo=config.database.debug,
                        pool_timeout=60, pool_recycle=120)
diff --git a/cms/db/submission.py b/cms/db/submission.py
@@ -27,7 +27,6 @@
 """
 
 from datetime import datetime
-import random
 from sqlalchemy import Boolean
 from sqlalchemy.dialects.postgresql import ARRAY, JSONB
 from sqlalchemy.orm import relationship
@@ -187,25 +186,6 @@ def tokened(self) -> bool:
         """
         return self.token is not None
 
-    @classmethod
-    def generate_opaque_id(cls, session, participation_id):
-        randint_upper_bound = 2**63-1
-
-        opaque_id = random.randint(0, randint_upper_bound)
-
-        # Note that in theory this may cause the transaction to fail by
-        # generating a non-actually-unique ID. This is however extremely
-        # unlikely (prob. ~num_parallel_submissions_per_contestant^2/2**63).
-        while (session
-               .query(Submission)
-               .filter(Submission.participation_id == participation_id)
-               .filter(Submission.opaque_id == opaque_id)
-               .first()
-               is not None):
-            opaque_id = random.randint(0, randint_upper_bound)
-
-        return opaque_id
-
 
 class File(Base):
     """Class to store information about one file submitted within a
diff --git a/cms/db/usertest.py b/cms/db/usertest.py
@@ -40,12 +40,20 @@ class UserTest(Base):
 
     """
     __tablename__ = 'user_tests'
+    __table_args__ = (
+        UniqueConstraint("participation_id", "opaque_id"),
+    )
 
     # Auto increment primary key.
     id: int = Column(
         Integer,
         primary_key=True)
 
+    # Opaque ID to be used to refer to this user test.
+    opaque_id: int = Column(
+        BigInteger,
+        nullable=False)
+
     # User and Contest, thus Participation (id and object) that did the
     # submission.
     participation_id: int = Column(
diff --git a/cms/db/util.py b/cms/db/util.py
@@ -23,6 +23,7 @@
 
 """
 
+import random
 import sys
 import logging
 
@@ -372,3 +373,24 @@ def enumerate_files(
     digests = set(r[0] for r in session.execute(union(*queries)))
     digests.discard(Digest.TOMBSTONE)
     return digests
+
+def generate_opaque_id(
+    cls: type[Submission | UserTest], session: Session, participation_id: int
+):
+    randint_upper_bound = 2**63-1
+
+    opaque_id = random.randint(0, randint_upper_bound)
+
+    # Note that in theory this may cause the transaction to fail by
+    # generating a non-actually-unique ID. This is however extremely
+    # unlikely (prob. ~num_parallel_submissions_per_contestant^2/2**63).
+    while (
+        session.query(cls)
+        .filter(cls.participation_id == participation_id)
+        .filter(cls.opaque_id == opaque_id)
+        .first()
+        is not None
+    ):
+        opaque_id = random.randint(0, randint_upper_bound)
+
+    return opaque_id
diff --git a/cms/server/contest/handlers/contest.py b/cms/server/contest/handlers/contest.py
@@ -263,15 +263,12 @@ def get_task(self, task_name: str) -> Task | None:
             .one_or_none()
 
     def get_submission(self, task: Task, opaque_id: str | int) -> Submission | None:
-        """Return the num-th contestant's submission on the given task.
+        """Return a contestant's specific submission on the given task.
 
         task: a task for the contest that is being served.
-        submission_num: a positive number, in decimal encoding.
+        opaque_id: submission's opaque_id
 
-        return: the submission_num-th submission
-            (1-based), in chronological order, that was sent by the
-            currently logged in contestant on the given task (None if
-            not found).
+        return: Submission with this opaque_id, or None if not found.
 
         """
         return self.sql_session.query(Submission) \
@@ -280,22 +277,19 @@ def get_submission(self, task: Task, opaque_id: str | int) -> Submission | None:
             .filter(Submission.opaque_id == int(opaque_id)) \
             .first()
 
-    def get_user_test(self, task: Task, user_test_num: int) -> UserTest | None:
-        """Return the num-th contestant's test on the given task.
+    def get_user_test(self, task: Task, opaque_id: str | int) -> UserTest | None:
+        """Return a contestant's specific user test on the given task.
 
         task: a task for the contest that is being served.
-        user_test_num: a positive number, in decimal encoding.
+        opaque_id: user test's opaque_id
 
-        return: the user_test_num-th user test, in
-            chronological order, that was sent by the currently logged
-            in contestant on the given task (None if not found).
+        return: User test with this opaque_id, or None if not found.
 
         """
         return self.sql_session.query(UserTest) \
             .filter(UserTest.participation == self.current_user) \
             .filter(UserTest.task == task) \
-            .order_by(UserTest.timestamp) \
-            .offset(int(user_test_num) - 1) \
+            .filter(UserTest.opaque_id == int(opaque_id)) \
             .first()
 
     def add_notification(
diff --git a/cms/server/contest/handlers/taskusertest.py b/cms/server/contest/handlers/taskusertest.py
@@ -224,15 +224,15 @@ class UserTestDetailsHandler(ContestHandler):
     @api_login_required
     @actual_phase_required(0)
     @multi_contest
-    def get(self, task_name, user_test_num):
+    def get(self, task_name, opaque_id):
         if not self.r_params["testing_enabled"]:
             raise tornado.web.HTTPError(404)
 
         task = self.get_task(task_name)
         if task is None:
             raise tornado.web.HTTPError(404)
 
-        user_test = self.get_user_test(task, user_test_num)
+        user_test = self.get_user_test(task, opaque_id)
         if user_test is None:
             raise tornado.web.HTTPError(404)
 
@@ -249,15 +249,15 @@ class UserTestIOHandler(FileHandler):
     @tornado.web.authenticated
     @actual_phase_required(0)
     @multi_contest
-    def get(self, task_name, user_test_num, io):
+    def get(self, task_name, opaque_id, io):
         if not self.r_params["testing_enabled"]:
             raise tornado.web.HTTPError(404)
 
         task = self.get_task(task_name)
         if task is None:
             raise tornado.web.HTTPError(404)
 
-        user_test = self.get_user_test(task, user_test_num)
+        user_test = self.get_user_test(task, opaque_id)
         if user_test is None:
             raise tornado.web.HTTPError(404)
 
@@ -283,15 +283,15 @@ class UserTestFileHandler(FileHandler):
     @tornado.web.authenticated
     @actual_phase_required(0)
     @multi_contest
-    def get(self, task_name, user_test_num, filename):
+    def get(self, task_name, opaque_id, filename):
         if not self.r_params["testing_enabled"]:
             raise tornado.web.HTTPError(404)
 
         task = self.get_task(task_name)
         if task is None:
             raise tornado.web.HTTPError(404)
 
-        user_test = self.get_user_test(task, user_test_num)
+        user_test = self.get_user_test(task, opaque_id)
         if user_test is None:
             raise tornado.web.HTTPError(404)
 
diff --git a/cms/server/contest/submission/workflow.py b/cms/server/contest/submission/workflow.py
@@ -32,6 +32,8 @@
 import logging
 import typing
 
+from cms.db.util import generate_opaque_id
+
 if typing.TYPE_CHECKING:
     from tornado.httputil import HTTPFile
 
@@ -270,7 +272,7 @@ def accept_submission(
 
     submission = Submission(
         timestamp=timestamp,
-        opaque_id=Submission.generate_opaque_id(sql_session, participation.id),
+        opaque_id=generate_opaque_id(Submission, sql_session, participation.id),
         language=language.name if language is not None else None,
         task=task,
         participation=participation,
@@ -486,6 +488,7 @@ def accept_user_test(
 
     user_test = UserTest(
         timestamp=timestamp,
+        opaque_id=generate_opaque_id(UserTest, sql_session, participation.id),
         language=language.name if language is not None else None,
         input=digests["input"],
         participation=participation,
diff --git a/cms/server/contest/templates/macro/submission.html b/cms/server/contest/templates/macro/submission.html
@@ -87,7 +87,6 @@
     {% else %}
         {% for s in submissions|sort(attribute="timestamp")|reverse %}
             {% if s.official == official %}
-                {# loop.revindex is broken: https://github.com/pallets/jinja/issues/794 #}
                 {{ row(
                     url,
                     contest_url,
diff --git a/cms/server/contest/templates/test_interface.html b/cms/server/contest/templates/test_interface.html
@@ -214,8 +214,6 @@ <h2 style="margin: 40px 0 10px">{% trans %}Previous tests{% endtrans %}</h2>
     </thead>
     <tbody>
     {% for t in user_tests[task.id]|sort(attribute="timestamp")|reverse %}
-        {# loop.revindex is broken: https://github.com/pallets/jinja/issues/794 #}
-        {% set t_idx = user_tests[task.id]|length - loop.index0 %}
         {% set tr = t.get_result(t.task.active_dataset) or undefined %}
         {% include "user_test_row.html" %}
     {% else %}
diff --git a/cms/server/contest/templates/user_test_row.html b/cms/server/contest/templates/user_test_row.html
@@ -1,5 +1,5 @@
 {% set status = tr.get_status() if tr is defined else UserTestResult.COMPILING %}
-<tr data-user-test="{{ t_idx }}" data-status="{{ status }}">
+<tr data-user-test="{{ t.opaque_id }}" data-status="{{ status }}">
 {% if show_date %}
     <td class="datetime">{{ t.timestamp|format_datetime }}</td>
 {% else %}
@@ -37,7 +37,7 @@
     </td>
 {% endif %}
     <td class="input">
-        <a class="btn" href="{{ contest_url("tasks", task.name, "tests", t_idx, "input") }}">
+        <a class="btn" href="{{ contest_url("tasks", task.name, "tests", t.opaque_id, "input") }}">
             {% trans %}Download{% endtrans %}
         </a>
     </td>
@@ -52,7 +52,7 @@
             {% trans %}N/A{% endtrans %}
         </a>
         {% else %}
-        <a class="btn btn-primary" href="{{ contest_url("tasks", task.name, "tests", t_idx, "output") }}">
+        <a class="btn btn-primary" href="{{ contest_url("tasks", task.name, "tests", t.opaque_id, "output") }}">
             {% trans %}Download{% endtrans %}
         </a>
         {% endif %}
@@ -70,7 +70,7 @@
         {% elif files|length == 1 %}
             {% set filename = next(iter(t.files.keys())) %}
             {% set real_filename = filename|replace(".%l", (t.language|to_language).source_extension) %}
-        <a class="btn" href="{{ contest_url("tasks", task.name, "tests", t_idx, "files", real_filename) }}">
+        <a class="btn" href="{{ contest_url("tasks", task.name, "tests", t.opaque_id, "files", real_filename) }}">
             {% trans %}Download{% endtrans %}
         </a>
         {% else %}
@@ -87,7 +87,7 @@
                     {% set real_filename = filename %}
                 {% endif %}
                 <li>
-                    <a href="{{ contest_url("tasks", task.name, "tests", t_idx, "files", real_filename) }}">
+                    <a href="{{ contest_url("tasks", task.name, "tests", t.opaque_id, "files", real_filename) }}">
                         {{ real_filename }}
                     </a>
                 </li>
diff --git a/cmscontrib/AddSubmission.py b/cmscontrib/AddSubmission.py
@@ -28,6 +28,7 @@
 from cms.db import File, Participation, SessionGen, Submission, Task, User, \
     ask_for_contest
 from cms.db.filecacher import FileCacher
+from cms.db.util import generate_opaque_id
 from cms.grading.language import Language
 from cms.grading.languagemanager import filename_to_language, get_language
 from cms.io import RemoteServiceClient
@@ -160,7 +161,7 @@ def add_submission(
             language=language_name,
             participation=participation,
             task=task,
-            opaque_id=Submission.generate_opaque_id(session, participation.id)
+            opaque_id=generate_opaque_id(Submission, session, participation.id)
         )
         for filename, digest in file_digests.items():
             session.add(File(filename, digest, submission=submission))
diff --git a/cmscontrib/updaters/update_47.py b/cmscontrib/updaters/update_47.py
@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+# Contest Management System - http://cms-dev.github.io/
+# Copyright © 2025 Luca Versari <veluca93@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""A class to update a dump created by CMS.
+
+Used by DumpImporter and DumpUpdater.
+
+Adds opaque_id to user tests.
+
+"""
+
+
+import random
+
+
+class Updater:
+
+    def __init__(self, data):
+        assert data["_version"] == 46
+        self.objs = data
+
+    def run(self):
+        used_ids = set()
+        for k, v in self.objs.items():
+            if k.startswith("_"):
+                continue
+            if v["_class"] == "UserTest":
+                while "opaque_id" not in v or v["opaque_id"] in used_ids:
+                    v["opaque_id"] = random.randint(0, 2**63-1)
+                used_ids.add(v["opaque_id"])
+
+        return self.objs
+
diff --git a/cmscontrib/updaters/update_from_1.5.sql b/cmscontrib/updaters/update_from_1.5.sql
@@ -45,4 +45,10 @@ ALTER TABLE user_test_results DROP COLUMN evaluation_sandbox;
 -- https://github.com/cms-dev/cms/pull/1486
 ALTER TABLE public.tasks ADD COLUMN allowed_languages varchar[];
 
+-- https://github.com/cms-dev/cms/pull/1526
+ALTER TABLE user_tests ADD COLUMN opaque_id BIGINT;
+UPDATE user_tests SET opaque_id = id WHERE opaque_id IS NULL;
+ALTER TABLE user_tests ADD CONSTRAINT user_tests_participation_id_opaque_id_key UNIQUE (participation_id, opaque_id);
+ALTER TABLE user_tests ALTER COLUMN opaque_id SET NOT NULL;
+
 COMMIT;
diff --git a/cmstestsuite/unit_tests/databasemixin.py b/cmstestsuite/unit_tests/databasemixin.py
@@ -456,6 +456,7 @@ def add_user_test(self, task=None, participation=None, **kwargs):
             "participation": participation,
             "input": unique_digest(),
             "timestamp": (task.contest.start + timedelta(0, unique_long_id())),
+            "opaque_id": unique_long_id(),
         }
         args.update(kwargs)
         user_test = UserTest(**args)
