Added: Add translated_content model and update Experiment model

[drikusroor]

This PR adds the ExperimentTranslatedContent model to the application, along with its related functionality. It has the following properties:

Model

• experiment - FK to the Experiment model
• language - The language code for the content's language
• index - Sorting property, the content with the lowest index will be considered the fallback language/content (for now)
• title - This was originally the Experiment's title
• description - This was originally the Experiment's description
• consent - This was originally the Experiment's consent
• about_content - This was originally the Experiment's about_content

The PR also adds some helper methods to the Experiment model, get_fallback_content and get_translated_content. These are used to get the appropriate content for the given context.

MUSCLE/backend/experiment/models.py

Lines 68 to 87 in 5d90e4b

	def get_fallback_content(self):
	"""Get primary content for the experiment"""
	return self.translated_content.order_by("index").first()
	def get_translated_content(self, language: str, fallback: bool = True):
	"""Get content for a specific language"""
	content = self.translated_content.filter(language=language).first()
	if not content and fallback:
	fallback_content = self.get_fallback_content()
	if not fallback_content:
	raise ValueError("No primary content found for experiment")
	return fallback_content
	if not content:
	raise ValueError(f"No content found for language {language}")
	return content

Serialisation & active language handling

The languages of the configured ExperimentTranslatedContents for an Experiment determine the possible languages in which an experiment can be used. These languages will also determine the languages used at the SocialMediaConfig, ThemeConfig, and Block level. Right now, what happens is that the user has a preferred language that is used to get the appropriate content and fall back to the experiment's fallback language if it is not available. Django has the get_language helper function to determine the user's preferred language. This language is used to find the appropriate ExperimentTranslatedContent. If it cannot find it, it will take the experiment's translated content with the lowest index number. If that doesn't exist either, it will throw an error as an Experiment needs a content in order to work. (We might want to require at least one translated content per experiment during creation and updating.)

The language of the ExperimentTranslatedContent (preferred or fallback) will be used as the active language for the whole experiment, its related entities, and the non-experiment related content using Django activate(language) function (which was used earlier at the Block level depending on the configured language there.

MUSCLE/backend/experiment/views.py

Lines 128 to 136 in 066b938

	language_code = get_language()[0:2]
	translated_content = experiment.get_translated_content(language_code)
	if not translated_content:
	raise ValueError("No translated content found for this experiment")
	experiment_language = translated_content.language
	activate(experiment_language)

Consent

The retrieval of the consent form works slightly different. If a consent form cannot be found in the preferred language, but does exist at the fallback level, the consent form from the fallback language will be used. This gives the user flexibility in configuring consent form: Configure consent forms in all languages, configure consent forms in only one or a limited selection of the experiment languages, or configure no consent forms at all.

Things to do after merging this PR

The migrations copy the Experiment's content to a newly created ExperimentLanguageContent, with the language set to English. This means that we have to go over all experiments after the migration and set the language to Dutch or Chinese if that's the Experiment's original language.

Related to #1204

[sentry-io]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ ValueError: Rules do not exist (anymore): VISUAL_MATCHING_PAIRS for block VMP (vmp) /server/experiment/block/{slug}/ View Issue

_{Did you find this useful? React with a 👍 or 👎}