[PLAT-1181] Waffle all Prereg Challenge specific parts of the codebase #8833

Johnetordoff · 2018-11-30T17:57:38Z

Purpose

We have to shut down all prereg challenge registration capbilities at midmight on New's Years Eve, the PR covers some of the gaps.

Changes

disables challenge submit button with waffle switch
disables submit/ endpoint with waffle switch (not they can hit it through the browser anyway
disables email task with waffle switch

QA Notes

According to David the admin commenting ability doesn't effect users, so it can be totally removed in the future, so no need to waffle now.

Documentation

technical task, no docs.

Side Effects

No that I know of.

Ticket

https://openscience.atlassian.net/browse/PLAT-1181

Johnetordoff · 2018-11-30T17:59:36Z

website/templates/project/register_draft.mako

+          %if waffle.switch_is_active(features.OSF_PREREGISTRATION):
+          <button type="button" class="btn btn-success pull-right"
+                  data-toggle="tooltip" data-placement="top" title="The Prereg Challenge has expired"
+                  style="margin-left: 5px;


Weird use of style tags here because the disabled class unjustly disables tooltips, so it's hacked to look and act disabled.

Johnetordoff · 2018-11-30T18:00:58Z

scripts/remind_draft_preregistrations.py

-    if not dry_run:
-        add_file_logger(logger, __file__)
-    main(dry_run=dry_run)
+    if not waffle.switch_is_active(features.OSF_PREREGISTRATION):


It might seem better to waffle this in the Celery config in defaults.py then here inside the running task, but that causes a circular import in waffle

Discussed with David M. in person and we can completely remove this reminder email now (no sense reminding people to finish their prereg draft when there's two weeks remaining...). Go ahead and remove the script, task, and email template.

caseyrollins

Just a few minor suggestions and a bit more code that can be removed. Thanks for your work on this @Johnetordoff, looks good!

caseyrollins · 2018-12-04T14:29:43Z

website/prereg/views.py

-    """Landing page for the prereg challenge"""
-    return views._view_registries_landing_page('prereg', **kwargs)
+    """Landing page for osf prereg"""
+    if waffle.switch_is_active(features.OSF_PREREGISTRATION):


Are the changes to this function necessary? The same mako template is returned regardless of the switch and it doesn't look like _view_registraties_landing_page was changed.

Ah, campaign is used to determine which draft registrations to load on the landing page. Got it.

caseyrollins · 2018-12-04T14:31:57Z

website/templates/project/register_draft.mako

-
+          %if waffle.switch_is_active(features.OSF_PREREGISTRATION):
+          <button type="button" class="btn btn-success pull-right"
+                  data-toggle="tooltip" data-placement="top" title="The Prereg Challenge has expired"


How about "The Prereg Challenge has ended."? Ended sounds a bit more accurate than expired imo.

caseyrollins · 2018-12-04T17:03:12Z

website/project/views/drafts.py

@@ -121,6 +123,9 @@ def submit_draft_for_review(auth, node, draft, *args, **kwargs):
    :rtype: dict
    :raises: HTTPError if embargo end date is invalid
    """
+    if waffle.switch_is_active(features.OSF_PREREGISTRATION):


Can you add a test to ensure that this function doesn't execute when the switch is active?

caseyrollins · 2018-12-04T17:12:53Z

scripts/remind_draft_preregistrations.py

-    if not dry_run:
-        add_file_logger(logger, __file__)
-    main(dry_run=dry_run)
+    if not waffle.switch_is_active(features.OSF_PREREGISTRATION):


Discussed with David M. in person and we can completely remove this reminder email now (no sense reminding people to finish their prereg draft when there's two weeks remaining...). Go ahead and remove the script, task, and email template.

caseyrollins · 2018-12-05T14:58:01Z

@Johnetordoff, we should also go ahead and remove the custom messaging that's passed here to this template (it's also passed to 5 or so other templates -- do a global find to find them all). We don't want to mention the Prereg Challenge if someone registers an existing draft in January,

caseyrollins · 2018-12-05T17:22:11Z

When the osf_preregistration switch is active, I still see this tooltip on the "Register without review" button. I think we should remove both of these buttons and replace with a single "Register" (like all other forms) when the switch is active.

Also, this modal appears when I click "Register for review" and should be removed.

caseyrollins · 2018-12-05T17:28:17Z

I'm seeing these buttons when creating an "OSF Preregistration" registration. The "Submit for review" button shouldn't exist for this schema.

caseyrollins · 2018-12-06T18:36:08Z

website/templates/project/register_draft.mako

+            <span data-bind="if: (draft.metaSchema.name === 'Prereg Challenge' && !draft.isPendingApproval)">
+              <button id="register-submit" type="button" class="btn btn-primary pull-right" data-toggle="tooltip" data-placement="top" title="Not eligible for the Pre-Registration Challenge" data-bind="click: draft.registerWithoutReview.bind(draft)">Register without review</button>
+            </span>
+        %endif:


minor: : after endif should be removed

caseyrollins · 2018-12-06T18:41:17Z

@Johnetordoff, one minor comment and a merge conflict that needs resolving. Looks great when testing locally!

into winddown-waffle-the-rest * 'develop' of https://github.com/CenterForOpenScience/osf.io: Bump version and update changelog [PLAT-1254] Fix embargoing pre-registrations Update export_user_account script for files-on-anything Add an absolute_url property to Institutions model Move call to delete files on a node to a celery task Expect 410 gone again rather than not permission for less confusion Allow sorting search results by "modified" Downgrade DRF to 3.8.2 Raise 410 instead of 404, include helpful message Update entity ID for Ferris When viewing a deleted file on a private node with no access, raise 404 If a node is deleted, show No files in the file browser when viewing tombstone metadata Update index settings, post-bulk indexing Limit the number of buckets in ES aggregation for preprints Upgrade django-elasticsearch-metrics; speed up backfill Reduce batch size; show progress Delete files on nodes removed from bulk destroy Fix related lookup contenttype restriction Change URL for captured raven message to send to Sentry chore: upgrade to osf-style@1.8.0 # Conflicts: # website/project/views/drafts.py

sloria · 2018-12-06T19:13:19Z

osf_tests/test_prereg.py

                'is_logged_in': False,
            }
        )

+        cache.delete(Switch._cache_key(OSF_PREREGISTRATION))


Is this necessary? If you're using override_switch to set the value of a switch, you shouldn't have to worry about the cache.

sloria · 2018-12-06T19:38:22Z

osf_tests/test_prereg.py

+                }
+            )
+
+        cache.delete(Switch._cache_key(OSF_PREREGISTRATION))


These are unnecessary, too, right?

sloria · 2018-12-06T19:40:57Z

website/project/views/drafts.py

@@ -121,6 +123,12 @@ def submit_draft_for_review(auth, node, draft, *args, **kwargs):
    :rtype: dict
    :raises: HTTPError if embargo end date is invalid
    """
+    if waffle.switch_is_active(features.OSF_PREREGISTRATION):
+        raise HTTPError(http.GONE, data={
+            'message_short': 'The Prereg Challenge has ended.',


Nit: message_short isn't usually a sentence, because it gets rendered as the page title when the OsfWebRenderer is used. Is this ever rendered to HTML?

No this should never actually be hittable by the UI.

sloria · 2018-12-06T19:43:27Z

website/project/views/drafts.py

+    if waffle.switch_is_active(features.OSF_PREREGISTRATION):
+        raise HTTPError(http.GONE, data={
+            'message_short': 'The Prereg Challenge has ended.',
+            'message_long': 'The Prereg Challenge has ended. This endpoint is currently depreciated.'


Typo: "deprecated". That said, this endpoint isn't really deprecated (I mean...all of v1 is deprecated, but that's besides the point)--it is still used for other schemas.

Maybe it makes sense for message_long to be The Prereg Challenge has ended. No new submissions are accepted at this time. message_short` can be unset, I think.

it is still used for other schemas.

Just to clarify Prereg Challenge is the only schema that uses this endpoint because it's the only one where requiresApproval is set to true

Oh, ok. Then I suppose it's fine to deprecate this endpoint. Just need to make sure we weren't exposing language like "deprecated endpoint" in the UI.

sloria

Just took a quick glance. Looks good to go to staging. Just a few nits.

caseyrollins · 2018-12-07T14:43:06Z

Deployed to staging3 🎉

Remove mention of remind_draft_preregistrations script

caseyrollins · 2018-12-11T18:54:55Z

Latest commits headed to staging3

OSF Preregistration form copy edits [PLAT-1279]

sloria · 2018-12-18T15:21:22Z

website/project/metadata/osf-preregistration.json

@@ -144,7 +144,7 @@
                },
                {
                    "text": "Registration following analysis of the data",
-                    "tooltip": "As of the date of submission, you have accessed and analyzed some of the data relevant to the research plan. This includes preliminary analysis of variables, calculation of descriptive statistics, and observation of data distributions. Please contact us (prereg@cos.io) and we will be happy to help you."
+                    "tooltip": "As of the date of submission, you have accessed and analyzed some of the data relevant to the research plan. This includes preliminary analysis of variables, calculation of descriptive statistics, and observation of data distributions. Please see https://cos.io/prereg for more information."


@Johnetordoff Will these changes require a migration?

Oh that's my bad. I pushed a migration to release/next-platform but not to this branch because I thought this PR already had an ensure_schemas migration. This PR will need a migration like this: 8cbe44b

@sloria Yes we'll have to run ensure_schemas to see any effect.

Oh ok. @Johnetordoff Can you please add that?

Also, please document in "Side Effects" that python manage.py migrate needs to be run when this is released (and any other necessary steps).

Add migration to ensure schemas

sloria · 2018-12-18T21:06:25Z

I got this up to date with develop in release/18.9.0. I canceled the build so that we can get that release branch's build started. If that passes, I'll go ahead and release.

Johnetordoff commented Nov 30, 2018

View reviewed changes

Johnetordoff force-pushed the winddown-waffle-the-rest branch from 6878f0d to 084e37c Compare November 30, 2018 19:41

caseyrollins force-pushed the feature/prereg-winddown branch from 2146788 to 297a59b Compare November 30, 2018 20:45

Johnetordoff force-pushed the winddown-waffle-the-rest branch from a84f7ea to 9b18b28 Compare December 3, 2018 21:19

Johnetordoff mentioned this pull request Dec 3, 2018

[PLAT-1180] Create new prereg landing page #8825

Closed

Johnetordoff added 5 commits December 3, 2018 16:29

add to tests for new prereg landing page

3f32b5b

add and rename prereg landing page images

b2d26f4

waffle language and images for new osf prereg landing page

d6afc55

waffle reminder emails for osf prereg challenge

d854276

waffle prereg challenge views to prevent new entries from being made.

c0514ba

Johnetordoff force-pushed the winddown-waffle-the-rest branch from 9b18b28 to c0514ba Compare December 3, 2018 21:36

caseyrollins suggested changes Dec 4, 2018

View reviewed changes

Johnetordoff added 3 commits December 4, 2018 15:49

change tooltip language

30594d9

add test for Prereg challenge depreciation and change error message

4a29ea8

remove prereg_reminder email and task

bc920db

Johnetordoff force-pushed the winddown-waffle-the-rest branch from 32a9030 to bc920db Compare December 4, 2018 21:05

Johnetordoff added 3 commits December 5, 2018 13:48

remove custom message from email templates

4486c60

fix waffling for form registering buttons

60aa3d0

fix email templates for prereg tests

795f2d0

caseyrollins reviewed Dec 6, 2018

View reviewed changes

caseyrollins changed the base branch from feature/prereg-winddown to develop December 6, 2018 18:39

caseyrollins approved these changes Dec 6, 2018

View reviewed changes

Johnetordoff added 2 commits December 6, 2018 13:44

remove colon typo

9bfe36a

sloria reviewed Dec 6, 2018

View reviewed changes

osf_tests/test_prereg.py Outdated

}

)

cache.delete(Switch._cache_key(OSF_PREREGISTRATION))

Copy link

Contributor

sloria Dec 6, 2018

Choose a reason for hiding this comment

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

These are unnecessary, too, right?

sloria reviewed Dec 6, 2018

View reviewed changes

remove extraneous cache cleaning

d97ced0

Johnetordoff force-pushed the winddown-waffle-the-rest branch from 886f197 to d9b5bf8 Compare December 6, 2018 20:30

clean up error response for prereg wind down

b021d50

Johnetordoff force-pushed the winddown-waffle-the-rest branch from d9b5bf8 to b021d50 Compare December 6, 2018 20:58

caseyrollins and others added 2 commits December 11, 2018 13:48

Remove mention of remind_draft_preregistrations script.

039c0b2

Merge pull request #6 from caseyrollins/winddown-waffle-the-rest

551d857

Remove mention of remind_draft_preregistrations script

caseyrollins and others added 2 commits December 15, 2018 16:16

OSF Prereg copy edits

965c95e

Merge pull request #7 from caseyrollins/feature/prereg-copy-edits

7c89dc3

OSF Preregistration form copy edits [PLAT-1279]

sloria reviewed Dec 18, 2018

View reviewed changes

caseyrollins and others added 2 commits December 18, 2018 15:41

Add ensure_schemas migration.

876c235

Merge pull request #8 from caseyrollins/prereg-add-migration

816c61b

Add migration to ensure schemas

sloria merged commit 816c61b into CenterForOpenScience:develop Dec 19, 2018

Johnetordoff deleted the winddown-waffle-the-rest branch August 17, 2023 15:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PLAT-1181] Waffle all Prereg Challenge specific parts of the codebase #8833

[PLAT-1181] Waffle all Prereg Challenge specific parts of the codebase #8833

Johnetordoff commented Nov 30, 2018

Johnetordoff Nov 30, 2018 •

edited

Johnetordoff Nov 30, 2018 •

edited

caseyrollins Dec 4, 2018

caseyrollins left a comment

caseyrollins Dec 4, 2018

caseyrollins Dec 4, 2018

caseyrollins Dec 4, 2018

caseyrollins Dec 4, 2018

Johnetordoff Dec 4, 2018

caseyrollins Dec 4, 2018

caseyrollins commented Dec 5, 2018

caseyrollins commented Dec 5, 2018

caseyrollins commented Dec 5, 2018

caseyrollins Dec 6, 2018

caseyrollins commented Dec 6, 2018

sloria Dec 6, 2018

sloria Dec 6, 2018

sloria Dec 6, 2018

Johnetordoff Dec 6, 2018

sloria Dec 6, 2018

Johnetordoff Dec 6, 2018

sloria Dec 6, 2018

sloria left a comment

caseyrollins commented Dec 7, 2018

caseyrollins commented Dec 11, 2018

sloria Dec 18, 2018

caseyrollins Dec 18, 2018 •

edited

Johnetordoff Dec 18, 2018

sloria Dec 18, 2018

sloria Dec 18, 2018

sloria commented Dec 18, 2018

[PLAT-1181] Waffle all Prereg Challenge specific parts of the codebase #8833

[PLAT-1181] Waffle all Prereg Challenge specific parts of the codebase #8833

Conversation

Johnetordoff commented Nov 30, 2018

Purpose

Changes

QA Notes

Documentation

Side Effects

Ticket

Johnetordoff Nov 30, 2018 • edited

Choose a reason for hiding this comment

Johnetordoff Nov 30, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caseyrollins left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caseyrollins commented Dec 5, 2018

caseyrollins commented Dec 5, 2018

caseyrollins commented Dec 5, 2018

Choose a reason for hiding this comment

caseyrollins commented Dec 6, 2018

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

Choose a reason for hiding this comment

sloria left a comment

Choose a reason for hiding this comment

caseyrollins commented Dec 7, 2018

caseyrollins commented Dec 11, 2018

Choose a reason for hiding this comment

caseyrollins Dec 18, 2018 • edited

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

sloria commented Dec 18, 2018

Johnetordoff Nov 30, 2018 •

edited

Johnetordoff Nov 30, 2018 •

edited

caseyrollins Dec 18, 2018 •

edited