fix: create a mockup for all upload status exception published #2093

alli83 · 2024-11-18T00:32:21Z

Pull request for issue: #2033

This is a pull request for the following functionalities:

create a mockup for all upload status exception published
Also, save the dataset before creating the mockup

How to test?

Given I am on the dataset Admin page of any dataset with a status of anything EXCEPT "Published"
When I look at the bottom of the page
Then I should see a create/reset private URL button
And when I click that button it does create or reset the private URL for that dataset.

How have functionalities been implemented?

call submit action before calling create/reset url

Any issues with implementation?

Any changes to automated tests?

test added

Any changes to documentation?

Any technical debt repayment?

Any improvements to CI/CD pipeline?

kencho51 · 2024-11-29T09:02:49Z

tests/acceptance/AdminDatasetForm.feature

+  @ok
+  Scenario: Can't see create/reset private url
+    When I am on "/adminDataset/update/id/8"
+    Then I should not see "Create/Reset Private URL"
+


question: This scenario is also passing when I executed it from the develop branch, so I was wondering what is the purpose of this test?

it's just a rearrangement of tests. Since dataset 8 is already published, we might as well reuse it directly.

kencho51 · 2024-12-02T06:14:19Z

tests/acceptance/AdminDatasetForm.feature

+  @ok @test
+  Scenario: Links to create mockup is present for a submitted dataset
    Given I am on "/adminDataset/update/id/5"
-    And I select "Published" from the field "Dataset_upload_status"
+    And I select "DataAvailableForReview" from the field "Dataset_upload_status"
    And I press the button "Save"
    When I am on "/adminDataset/update/id/5"
-    Then I should not see "Create/Reset Private URL"
-    And I should not see "Open Private URL"
+    And I select "Submitted" from the field "Dataset_upload_status"
+    And I press the button "Save"
+    When I am on "/adminDataset/update/id/5"
+    Then I should see "Create/Reset Private URL"
+    And I press the button "Create/Reset Private URL"
+    And I wait "3" seconds
+    Then I should see current url contains "/dataset/100039/token/"
+    And I should see "Genomic data of the Puerto Rican Parrot (Amazona vittata) from a locally funded project."


question: Is this test still work in progress? Because it has tag @test. And is this test necessary as supposedly the following scenario should be implemented:

Given I am on the dataset Admin page of any dataset with a status of anything EXCEPT "Published" When I look at the bottom of the page Then I should see a create/reset private URL button And when I click that button it does create or reset the private URL for that dataset.

But in fact, the current existing scenario Links to create mockup or to open mockup are always present for a non-published dataset has covered it already.
suggestion: It seems that this PR will not bring in any changes from the UI, so I was wondering is it better to test the JS function if it is testable.

The tag will be removed, just used locally.
the problem was with the submitted status (there was an error)
The published status is already tested. I just swapped the tests

the problem was with the submitted status (there was an error)

If that is the case, may be the test can be:

Scenario: Cannot change status to Submitted from non DataAvailableForReview Given I am on "/adminDataset/update/id/668" And should see "Private" And I should see "Create/Reset Private URL" And I select `"Submitted"` from the field "Dataset_upload_status" When I press the button "Save" Then I am on "/adminDataset/update/id/668" And I should see "Failed to update status!" Scenario: Links to create mockup is present for a submitted dataset Given I am on "/adminDataset/update/id/5" And I should see "ImportFromEM" And I select "DataAvailableForReview" from the field "Dataset_upload_status" And I press the button "Save" And I should see "Updated successfully! " And I should see "Create/Reset Private URL" When I select "Submitted" from the field "Dataset_upload_status" And I press the button "Save" And I am on "/adminDataset/update/id/5" And I should see "Create/Reset Private URL" And I press the button "Create/Reset Private URL" And I wait "3" seconds Then I should see current url contains "/dataset/100039/token/" And I should see "Genomic data of the Puerto Rican Parrot (Amazona vittata) from a locally funded project."

why do you want to add "Cannot change status to Submitted from non DataAvailableForReview". it's another PR

Can you remind me which PR? If there is already a PR for it, you can ignore Cannot change status to Submitted from non DataAvailableForReview"

not opened yet

kencho51 · 2024-12-02T06:29:29Z

protected/controllers/AdminDatasetController.php

@@ -327,16 +327,26 @@ public function actionUpdate($id)
     */
    public function actionPrivate()
    {
-        $id = $_GET['identifier'];
+        $id = Yii::$app->request->get('identifier');


praise: Using Yii's built-in request handling, which is generally safer and more consistent

kencho51 · 2024-12-02T06:39:26Z

protected/views/adminDataset/_form.php

+    $(document).ready(function () {
+        $('#mockup').on('click', function (event) {
+            event.preventDefault();
+
+            mockupUrl = $(this).attr("href");
+            form = $('#dataset-form');
+
+            $.ajax({
+                url: form.attr('action'),
+                method: 'POST',
+                data: form.serialize(),
+                success: function (response, textStatus, xhr) {
+                    if (200 === xhr.status) {
+                        window.location.href = mockupUrl;
+                    } else {
+                        $('#flashError').html('An error occurred while trying to save the dataset')
+                    }
+
+                },
+                error: function (error) {
+                    $('#flashError').html('An error occurred while trying to save the dataset')
+                }
+            })
+        });
+    });
+


praise: This JS function/AJAX call makes sure to save any changes made in the form when clicking the Create/Reset Private URL, without refreshing or leaving the page. This can prevent loss of data and provide immediate feedback.
praise: Redirecting to the mockup page only after confirming the data in the form has been saved successfully.

alli83 requested review from kencho51, pli888 and rija as code owners November 18, 2024 00:32

kencho51 reviewed Nov 29, 2024

View reviewed changes

fix: create a mockup for all upload status exception published

46b51a5

alli83 force-pushed the fix-2033-create-a-mockup-for-all-upload-statuses-except-published branch from 9ee2a8d to 46b51a5 Compare December 1, 2024 21:24

kencho51 reviewed Dec 2, 2024

View reviewed changes

alli83 marked this pull request as draft December 9, 2024 08:38

pli888 mentioned this pull request Dec 16, 2024

blank screen and failure to create mockup #2033

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: create a mockup for all upload status exception published #2093

fix: create a mockup for all upload status exception published #2093

alli83 commented Nov 18, 2024

kencho51 Nov 29, 2024

alli83 Dec 1, 2024

kencho51 Dec 2, 2024 •

edited

Loading

alli83 Dec 2, 2024

kencho51 Dec 4, 2024 •

edited

Loading

alli83 Dec 4, 2024

kencho51 Dec 4, 2024

alli83 Dec 4, 2024

kencho51 Dec 2, 2024

kencho51 Dec 2, 2024

fix: create a mockup for all upload status exception published #2093

Are you sure you want to change the base?

fix: create a mockup for all upload status exception published #2093

Conversation

alli83 commented Nov 18, 2024

Pull request for issue: #2033

How to test?

How have functionalities been implemented?

Any issues with implementation?

Any changes to automated tests?

Any changes to documentation?

Any technical debt repayment?

Any improvements to CI/CD pipeline?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kencho51 Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kencho51 Dec 4, 2024 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kencho51 Dec 2, 2024 •

edited

Loading

kencho51 Dec 4, 2024 •

edited

Loading