""",
+ "study_type": "Choose what type of study you are creating - this will change the fields that appear in the Experiment Details section.",
"structure": PROTOCOL_HELP_TEXT_INITIAL,
- "priority": f"This affects how studies are ordered at your lab's custom URL, not the main study page. If you leave all studies at the highest priority (99), then all of your lab's active/discoverable studies will be shown in a randomized order on your lab page. If you lower the priority of this study to 1, then it will appear last in the list on your lab page. You can find your lab's custom URL from the labs page. For more info, see the documentation on study prioritization.",
+ "priority": "This affects how studies are ordered at your lab's custom URL, not the main study page. If you leave all studies at the highest priority (99), then all of your lab's active/discoverable studies will be shown in a randomized order on your lab page. If you lower the priority of this study to 1, then it will appear last in the list on your lab page. You can find your lab's custom URL from the labs page. For more info, see the documentation on study prioritization.",
}
@@ -380,8 +382,6 @@ class StudyEditForm(StudyForm):
def __init__(self, user=None, *args, **kwargs):
super().__init__(*args, **kwargs)
- self.fields["external"].disabled = True
- self.fields["structure"].help_text = PROTOCOL_HELP_TEXT_EDIT
# Restrict ability to edit study lab based on user permissions
can_change_lab = user.has_study_perms(
StudyPermission.CHANGE_STUDY_LAB, self.instance
@@ -411,16 +411,19 @@ def __init__(self, user=None, *args, **kwargs):
)
self.fields["lab"].disabled = True
- def clean_external(self):
- study = self.instance
- external = self.cleaned_data["external"]
+ #####
+ # TODO: Remove this commented code after external view has been built
- if (not external and study.study_type.is_external) or (
- external and study.study_type.is_ember_frame_player
- ):
- raise forms.ValidationError("Attempt to change study type not allowed.")
+ # def clean_external(self):
+ # study = self.instance
+ # external = self.cleaned_data["external"]
+
+ # if (not external and study.study_type.is_external) or (
+ # external and study.study_type.is_ember_frame_player
+ # ):
+ # raise forms.ValidationError("Attempt to change study type not allowed.")
- return external
+ # return external
class StudyCreateForm(StudyForm):
@@ -428,7 +431,6 @@ class StudyCreateForm(StudyForm):
def __init__(self, user=None, *args, **kwargs):
super().__init__(*args, **kwargs)
- self.fields["structure"].help_text = PROTOCOL_HELP_TEXT_EDIT
# Limit initial lab options to labs this user is a member of & can create studies in
self.fields["lab"].queryset = Lab.objects.filter(
id__in=get_objects_for_user(
@@ -445,3 +447,76 @@ class EmailParticipantsForm(forms.Form):
recipients = forms.ChoiceField(widget=EmailRecipientSelectMultiple())
subject = forms.CharField()
body = forms.CharField(widget=forms.Textarea())
+
+
+class ExperimentRunnerForm(ModelForm):
+ player_repo_url = forms.URLField()
+ last_known_player_sha = forms.CharField()
+ structure = forms.CharField(
+ widget=AceOverlayWidget(
+ mode="json",
+ wordwrap=True,
+ theme="textmate",
+ width="100%",
+ height="100%",
+ showprintmargin=False,
+ ),
+ required=False,
+ )
+ generator = forms.CharField(
+ widget=AceOverlayWidget(
+ mode="javascript",
+ wordwrap=True,
+ theme="textmate",
+ width="100%",
+ height="100%",
+ showprintmargin=False,
+ ),
+ required=False,
+ )
+
+ class Meta:
+ model = Study
+ fields = ("use_generator", "generator", "structure")
+
+ def clean_structure(self):
+ try:
+ structure = json.loads(self.cleaned_data["structure"])
+ structure["exact_text"] = self.cleaned_data["structure"]
+ return structure
+ except json.JSONDecodeError:
+ raise forms.ValidationError(
+ "Saving protocol configuration failed due to invalid JSON! Please use valid JSON and save again. If you reload this page, all changes will be lost."
+ )
+
+ def clean_generator(self):
+ try:
+ generator = self.cleaned_data["generator"]
+ js2py.eval_js(generator)
+ return generator
+ except js2py.internals.simplex.JsException:
+ raise forms.ValidationError(
+ "Generator javascript seems to be invalid. Please edit and save again. If you reload this page, all changes will be lost."
+ )
+
+ def clean_player_repo_url(self):
+ player_repo_url = self.cleaned_data["player_repo_url"]
+
+ if not requests.get(player_repo_url).ok:
+ raise forms.ValidationError(
+ f"Frameplayer repo url {player_repo_url} does not work."
+ )
+
+ return player_repo_url
+
+ def clean_last_known_player_sha(self):
+ last_known_player_sha = self.cleaned_data["last_known_player_sha"]
+ player_repo_url = self.cleaned_data["player_repo_url"]
+
+ if last_known_player_sha and player_repo_url:
+ if not requests.get(f"{player_repo_url}/commit/{last_known_player_sha}").ok:
+ raise forms.ValidationError(
+ f"Frameplayer commit {last_known_player_sha} does not exist."
+ )
+
+ return last_known_player_sha
From 12b5a2163cbe76bc8c4d000dfe4fb99bbb204a54 Mon Sep 17 00:00:00 2001
From: CJ Green <44074998+okaycj@users.noreply.github.com>
Date: Wed, 26 Jul 2023 13:22:45 -0400
Subject: [PATCH 05/45] Add exp runner edit button to detail view
---
studies/templates/studies/study_detail.html | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/studies/templates/studies/study_detail.html b/studies/templates/studies/study_detail.html
index b18e225c4..df619e368 100644
--- a/studies/templates/studies/study_detail.html
+++ b/studies/templates/studies/study_detail.html
@@ -130,7 +130,7 @@
method="post"
style="display:none">
{% csrf_token %}
-
+
@@ -59,7 +50,7 @@
title=""
id="id_min_age_years">
{% for x, y in form.fields.min_age_years.choices %}
-
{% endfor %}
@@ -93,7 +84,7 @@
name="min_age_days"
title="">
{% for x, y in form.fields.min_age_days.choices %}
-
{% endfor %}
@@ -123,7 +114,7 @@
title=""
id="id_max_age_years">
{% for x, y in form.fields.max_age_years.choices %}
-
{% endfor %}
@@ -140,8 +131,7 @@
name="max_age_months"
title="">
{% for x, y in form.fields.max_age_months.choices %}
-
{% endfor %}
@@ -158,7 +148,7 @@
name="max_age_days"
title="">
{% for x, y in form.fields.max_age_days.choices %}
-
{% endfor %}
@@ -180,18 +170,18 @@
{% bootstrap_field form.must_have_participated label_class="form-label fw-bold" wrapper_class="mb-4" %}
{% bootstrap_field form.must_not_have_participated label_class="form-label fw-bold" wrapper_class="mb-4" %}
{% bootstrap_field form.criteria_expression label_class="form-label fw-bold" wrapper_class="mb-4" %}
-
-
+{% comment %} {% endcomment %}
+{% comment %}
Now it's time for the actual study! For internal studies, you will add a protocol configuration or generator. For external studies, you will paste in your study or scheduling link. If you don't see what you expect, check the "External" and "Scheduled" checkboxes at the top of this form!