Add Prolific provider (#1008)

.gitignore

@@ -8,6 +8,7 @@ mephisto.egg-info/*
 tmp/*
 **/node_modules/*
 mephisto/server/**/package-lock.json
+mephisto/abstractions/**/package-lock.json
 mephisto/server/blueprints/**/build/*
 
 **/*.log
@@ -25,12 +26,15 @@ mephisto/scripts/metrics/*
 # Examples
 examples/simple_static_task/hydra_configs/conf/*
 !examples/simple_static_task/hydra_configs/conf/example.yaml
+!examples/simple_static_task/hydra_configs/conf/prolific_example.yaml
 !examples/simple_static_task/hydra_configs/conf/onboarding_example.yaml
 examples/**/build/*
 
 # PyCharm
 .idea
 
+# VSCode
+.vscode
 
 # https://next.yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
 .yarn/*
@@ -42,4 +46,12 @@ examples/**/build/*
 !.yarn/versions
 .pnp.*
 
-docs/storybook/storybook-static/*
+docs/storybook/storybook-static/*
+
+# local deploy
+hydra_configs/profile/*.yaml
+!hydra_configs/profile/local_dev.yaml
+aws_credentials
+docker-compose.local.*
+env.local
+my-review-interface

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
   "typescript.tsdk": "mephisto/mephisto/webapp/node_modules/typescript/lib",
   "python.linting.pylintEnabled": false,
-  "python.linting.mypyEnabled": true,
-  "python.linting.enabled": true
+  "python.linting.mypyEnabled": false,
+  "python.linting.enabled": true,
+  "python.linting.flake8Enabled": true
 }

Dockerfile

@@ -5,6 +5,13 @@ ARG BASE_IMAGE=nikolaik/python-nodejs:$BASE_TAG
 
 FROM $BASE_IMAGE
 
+# ec2 architect requires `ssh-keygen` util, so we need to install it.
+# Firstly, remove `yarn` repo as it causes error that stops building a container. Error:
+# (Error: The repository 'https://dl.yarnpkg.com/debian stable InRelease' is not signed)
+RUN rm /etc/apt/sources.list.d/yarn.list
+RUN apt update
+RUN apt install keychain -y
+
 COPY . /mephisto
 RUN mkdir ~/.mephisto
 

docker/aws_credentials.example

@@ -0,0 +1,7 @@
+[ec2-profile-name]
+aws_access_key_id=XXXXXXXXX
+aws_secret_access_key=XXXXXXXXX
+
+[MTurk-profile-name]
+aws_access_key_id=XXXXXXXXX
+aws_secret_access_key=XXXXXXXXX

docker/docker-compose.dev.vscode.yml

@@ -0,0 +1,31 @@
+version: '3'
+
+services:
+  fb_mephisto_vscode:
+    container_name: fb_mephisto_vscode
+    build:
+      context: ..
+      dockerfile: Dockerfile
+    ports:
+      - '8081:8000'
+      - '3001:3000'
+      - '5678:5678'
+    volumes:
+      - ..:/mephisto
+      - ./entrypoints/server.sh:/entrypoint.sh
+      - ./aws_credentials:/root/.aws/credentials
+      - ./ssh_known_hosts:/root/.ssh/known_hosts
+    entrypoint: /entrypoint.sh
+    env_file: envs/env.local
+    command: [
+      "sh",
+      "-c",
+      "pip install debugpy -t /tmp
+       &&
+       python
+          /tmp/debugpy
+          --wait-for-client
+          --listen 0.0.0.0:5678
+          /mephisto/examples/simple_static_task/static_test_script.py
+      "
+    ]

docker/docker-compose.dev.yml

@@ -0,0 +1,20 @@
+version: '3'
+
+services:
+  fb_mephisto:
+    container_name: fb_mephisto
+    build:
+      context: ..
+      dockerfile: Dockerfile
+    ports:
+      - '8081:8000'
+      - '3001:3000'
+    volumes:
+      - ..:/mephisto
+      - ./entrypoints/server.prolific.sh:/entrypoint.sh
+      - ./aws_credentials:/root/.aws/credentials
+      - ./ssh_known_hosts:/root/.ssh/known_hosts
+    entrypoint: /entrypoint.sh
+    env_file: envs/env.dev
+    command: tail -f /dev/null
+

docker/entrypoints/server.mturk.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+pip install pytest
+cd /mephisto
+mkdir -p "data" && chmod 777 "data"
+
+mephisto register mturk_sandbox \
+    name=$MTURK_SANDBOX_NAME \
+    access_key_id=$MTURK_SANDBOX_ACCESS_KEY_ID \
+    secret_access_key=$MTURK_SANDBOX_SECRET_ACCESS_KEY
+
+exec "$@"

docker/entrypoints/server.prolific.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+set -e
+
+pip install pytest black
+cd /mephisto
+mkdir -p "data" && chmod 777 "data"
+
+mephisto register prolific name=prolific api_key=$PROLIFIC_API_KEY
+
+exec "$@"

docker/envs/env.dev

@@ -0,0 +1 @@
+PROLIFIC_API_KEY="dev"

examples/simple_static_task/data_prolific.csv

@@ -0,0 +1,2 @@
+character_name,character_description
+Loaded Character 1,I'm a Prolific character loaded from Mephisto!

examples/simple_static_task/hydra_configs/conf/prolific_example.yaml

@@ -0,0 +1,48 @@
+#@package _global_
+defaults:
+  - /mephisto/blueprint: static_task
+  - /mephisto/architect: ec2
+  - /mephisto/provider: prolific
+mephisto:
+  architect:
+    _architect_type: ec2
+    profile_name: mephisto-router-iam
+    subdomain: '0623.1'
+  blueprint:
+    data_csv: ${task_dir}/data_prolific.csv
+    task_source: ${task_dir}/server_files/demo_task.html
+    preview_source: ${task_dir}/server_files/demo_preview.html
+    extra_source_dir: ${task_dir}/server_files/extra_refs
+    units_per_assignment: 1
+  log_level: 'debug'
+  task:
+    task_name: '0623'
+    task_title: '0623 Task'
+    task_description: 'This is a simple test of static Prolific tasks.'
+    task_reward: 70
+    task_tags: 'static,task,testing'
+  provider:
+    prolific_external_study_url: 'https://example.com?participant_id={{%PROLIFIC_PID%}}&study_id={{%STUDY_ID%}}&submission_id={{%SESSION_ID%}}'
+    prolific_id_option: 'url_parameters'
+    prolific_workspace_name: 'My Workspace'
+    prolific_project_name: 'Project'
+    prolific_allow_list_group_name: 'Allow list'
+    prolific_block_list_group_name: 'Block list'
+    prolific_total_available_places: 1
+    prolific_eligibility_requirements:
+      - name: 'CustomWhitelistEligibilityRequirement'
+        white_list:
+          - '6463d16eb92a24a0c3fdc8d5'
+#          - '6463d32f50a18041930b71be'
+#          - '6463d3922d7d99360896228f'
+#      - name: 'AgeRangeEligibilityRequirement'
+#        min_age: 10
+#        max_age: 20
+#      - name: 'ApprovalNumbersEligibilityRequirement'
+#        minimum_approvals: 100
+#        maximum_approvals: 200
+#      - name: 'ApprovalRateEligibilityRequirement'
+#        minimum_approval_rate: 10
+#        maximum_approval_rate: 20
+#      - name: 'JoinedBeforeEligibilityRequirement'
+#        joined_before: ''

examples/simple_static_task/static_test_prolific_script.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+# Copyright (c) Facebook, Inc. and its affiliates.
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+from omegaconf import DictConfig
+
+from mephisto.abstractions.blueprints.abstract.static_task.static_blueprint import (
+    SharedStaticTaskState,
+)
+from mephisto.data_model.qualification import QUAL_GREATER_EQUAL
+from mephisto.tools.scripts import task_script
+from mephisto.utils.qualifications import make_qualification_dict
+
+
+@task_script(default_config_file='prolific_example')
+def main(operator, cfg: DictConfig) -> None:
+    shared_state = SharedStaticTaskState()
+
+    # Mephisto qualifications
+    shared_state.qualifications = [
+        make_qualification_dict('ok', QUAL_GREATER_EQUAL, 1),
+    ]
+
+    # Prolific qualifications
+    # shared_state.prolific_specific_qualifications = [
+    #     {
+    #         # Without `web.eligibility.models.` as API requires. We will add it in the code
+    #         'name': 'AgeRangeEligibilityRequirement',
+    #         # Prolific Eligibility Requirement attributes and its values
+    #         'min_age': 20,
+    #         'max_age': 100,
+    #     },
+    # ]
+
+    operator.launch_task_run(cfg.mephisto, shared_state)
+    operator.wait_for_runs_then_shutdown(skip_input=True, log_rate=30)
+
+
+if __name__ == '__main__':
+    main()

examples/simple_static_task/static_test_script.py

@@ -4,9 +4,6 @@
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-from mephisto.abstractions.blueprints.static_html_task.static_html_blueprint import (
-    BLUEPRINT_TYPE_STATIC_HTML,
-)
 from mephisto.tools.scripts import task_script
 from omegaconf import DictConfig