Feature/TR-5854/Detect delivery concurrency #2420

jsconan · 2023-11-24T15:33:07Z

Related to: https://oat-sa.atlassian.net/browse/TR-5854

Requires:

Feature/TR-5854/Detect delivery concurrency tao-test-runner-qti-fe#522

Summary

Add a mechanism for detecting concurrent delivery sessions.

Details

Install the preventConcurrency plugin.

When the test runner initializes, a sequence number is stored in the browser's storage. Each time the duration is updated, the sequence number is read from the storage and compared with the value created at the beginning. If a discrepancy is discovered this means another test runner started meanwhile and updated the storage. A dialog message is presented to the user and the test runner is stopped.

How to test

The feature flag FEATURE_FLAG_PAUSE_CONCURRENT_SESSIONS needs to be set.

php index.php 'oat\tao\scripts\tools\FeatureFlag\FeatureFlagTool' -s FEATURE_FLAG_PAUSE_CONCURRENT_SESSIONS -v true

checkout the branch feature/TR-5858/detect-delivery-concurrency
make sure the frontend is up to date: cd taoQtiTest/views && npm ci
run taoUpdate
launch a delivery
duplicate the tab or launch another delivery
the first tab should show a message and stop the test

…livery-concurrency

shpran · 2023-11-27T07:21:25Z

migrations/Version202311241512382260_taoQtiTest.php

+        $registry = PluginRegistry::getRegistry();
+        if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {


Suggested change

$registry = PluginRegistry::getRegistry();

if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

$registry = PluginRegistry::getRegistry();

if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

shpran · 2023-11-27T07:21:34Z

migrations/Version202311241512382260_taoQtiTest.php

+        $registry = PluginRegistry::getRegistry();
+        if ($registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {


Suggested change

$registry = PluginRegistry::getRegistry();

if ($registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

$registry = PluginRegistry::getRegistry();

if ($registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

shpran · 2023-11-27T07:22:36Z

migrations/Version202311241512382260_taoQtiTest.php

+    public function up(Schema $schema): void
+    {
+        $registry = PluginRegistry::getRegistry();
+        if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {


We can store 'taoQtiTest/runner/plugins/controls/session/preventConcurrency' in a separate class variable to avoid duplications 🙂
But not critical

gabrielfs7 · 2023-11-27T07:32:58Z

migrations/Version202311241512382260_taoQtiTest.php

+                'bundle' => 'taoQtiTest/loader/testPlugins.min',
+                'description' => 'Detect concurrent deliveries launched from the same user session',
+                'category' => 'controls',
+                'active' => true,


We discussed this will not be activated by default, right? Maybe we should set it to false?

*Even if it will be handled by feature flag later, maybe to be on the safe side, still worth to make it disabled by default to be consistent. Wdyt?

cc: @jsconan

Actually, the feature is conditioned by a feature flag. We can install the plugin and have it always active, then set the feature flag FEATURE_FLAG_PAUSE_CONCURRENT_SESSIONS when needed. This ways it will work all together with the backend feature.

gabrielfs7 · 2023-11-27T07:33:34Z

views/package.json

@@ -9,6 +9,6 @@
    "license": "GPL-2.0",
    "dependencies": {
        "@oat-sa/tao-test-runner": "^1.0.0",
-        "@oat-sa/tao-test-runner-qti": "^4.0.0"
+        "@oat-sa/tao-test-runner-qti": "https://github.com/oat-sa/tao-test-runner-qti-fe#feature/TR-5858/detect-delivery-concurrency"


Please do not forget to update with proper version before merge

gabrielfs7 · 2023-11-27T07:36:59Z

migrations/Version202311241512382260_taoQtiTest.php

+    public function up(Schema $schema): void
+    {
+        $registry = PluginRegistry::getRegistry();
+        if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {


Would not be easier to keep the plugin declaration configs on RegisterTestRunnerPlugins and only get it here? Example (does not need to be the same)

$registry->register(TestPlugin::fromArray(RegisterTestRunnerPlugins::getPlugin('preventConcurrency')));

We could, but we would need to refactor the class RegisterTestRunnerPlugins.

Suggestion applied

scripts/install/RegisterTestRunnerPlugins.php

migrations/Version202311241512382260_taoQtiTest.php

gabrielfs7

Thanks @jsconan !

New code is covered by tests (if applicable)
Tests are running successfully (old and new ones) on my local machine (if applicable)
New code is respecting code style rules
New code is respecting best practices
New code is not subject to concurrency issues (if applicable)
Feature is working correctly on my local machine (if applicable)
Acceptance criteria are respected
Pull request title and description are meaningful

Co-authored-by: Gabriel Felipe Soares <gabrielfs7@gmail.com> Signed-off-by: Jean-Sébastien CONAN <jsconan@gmail.com>

Co-authored-by: Héctor Arroyo <hector.arroyo@taotesting.com> Signed-off-by: Jean-Sébastien CONAN <jsconan@gmail.com>

jsconan added 2 commits November 24, 2023 16:09

chore: update tao-test-runner-qti to branch feature/TR-5858/detect-de…

8112ceb

…livery-concurrency

chore: install the preventConcurrency plugin

53cbf36

This was referenced Nov 24, 2023

Feature/TR-5854/Detect delivery concurrency oat-sa/tao-test-runner-qti-fe#522

Merged

Feature/TR-5854/Detect delivery concurrency oat-sa/extension-lti-test-review#136

Merged

jsconan requested review from hectoras, erkobridee, gabrielfs7, shaveko and shpran November 24, 2023 15:39

shpran approved these changes Nov 27, 2023

View reviewed changes

gabrielfs7 reviewed Nov 27, 2023

View reviewed changes

refactor: use plugin definition defined in the install script

74d6494

jsconan requested a review from gabrielfs7 November 27, 2023 11:56

gabrielfs7 reviewed Nov 27, 2023

View reviewed changes

scripts/install/RegisterTestRunnerPlugins.php Outdated Show resolved Hide resolved

hectoras reviewed Nov 27, 2023

View reviewed changes

migrations/Version202311241512382260_taoQtiTest.php Outdated Show resolved Hide resolved

gabrielfs7 approved these changes Nov 27, 2023

View reviewed changes

chore: update signature to allow return null

1f82a04

Co-authored-by: Gabriel Felipe Soares <gabrielfs7@gmail.com> Signed-off-by: Jean-Sébastien CONAN <jsconan@gmail.com>

hectoras approved these changes Nov 27, 2023

View reviewed changes

chore: remove auto-generated comment

c1dbc0c

Co-authored-by: Héctor Arroyo <hector.arroyo@taotesting.com> Signed-off-by: Jean-Sébastien CONAN <jsconan@gmail.com>

jsconan merged commit 721c2f4 into feat/RFE-748-integration-branch Nov 27, 2023
1 check failed

jsconan deleted the feature/TR-5858/detect-delivery-concurrency branch November 27, 2023 12:14

jsconan changed the title ~~Feature/TR-5858/Detect delivery concurrency~~ Feature/TR-5854/Detect delivery concurrency Nov 27, 2023

jsconan mentioned this pull request Nov 28, 2023

feat: Prevent execution of multiple deliveries by the same test taker #2419

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/TR-5854/Detect delivery concurrency #2420

Feature/TR-5854/Detect delivery concurrency #2420

jsconan commented Nov 24, 2023

shpran Nov 27, 2023

shpran Nov 27, 2023

shpran Nov 27, 2023

jsconan Nov 27, 2023

gabrielfs7 Nov 27, 2023 •

edited

Loading

jsconan Nov 27, 2023

gabrielfs7 Nov 27, 2023

gabrielfs7 Nov 27, 2023 •

edited

Loading

jsconan Nov 27, 2023

jsconan Nov 27, 2023

gabrielfs7 Nov 27, 2023

gabrielfs7 left a comment

		$registry = PluginRegistry::getRegistry();
		if (!$registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

		$registry = PluginRegistry::getRegistry();
		if ($registry->isRegistered('taoQtiTest/runner/plugins/controls/session/preventConcurrency')) {

Feature/TR-5854/Detect delivery concurrency #2420

Feature/TR-5854/Detect delivery concurrency #2420

Conversation

jsconan commented Nov 24, 2023

Related to: https://oat-sa.atlassian.net/browse/TR-5854

Summary

Details

How to test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrielfs7 Nov 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrielfs7 Nov 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrielfs7 left a comment

Choose a reason for hiding this comment

gabrielfs7 Nov 27, 2023 •

edited

Loading

gabrielfs7 Nov 27, 2023 •

edited

Loading