Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Ajouter dans le didacticiel un embed sans complétion requise (PIX-13091) #9445

Merged

Conversation

dlahaye
Copy link
Contributor

@dlahaye dlahaye commented Jul 3, 2024

🦄 Problème

Nous débutons l'implémentation au sein de Modulix d'embed ne nécessitant pas de complétion. Mais nous n'avons pas encore cette typologie d'élément dans le référentiel.

🤖 Proposition

Ajouter cette typologie d'élément dans le référentiel.

🌈 Remarques

Revue du modèle de données

Suite au premier craquage sur le sujet, nous considérions deux types d'embed, ceux qui sont auto, et ceux qui sont non-auto.
En prenant de la hauteur fonctionnelle sur le sujet, il nous est venu que ces deux types ne remplissaient pas correctement les différents cas d'usage des embed dans Modulix.
Nous avons finalement opté pour un seul type "embed", et nous avons différencié deux cas d'usage via une propriété boolean isCompletionRequired. Ces deux cas sont les suivants:

  1. Les embed que l'utilisateur est invité à finir et qui annoncent lorsqu'ils sont complétés (cf. des simulateurs dans pix-editor considérés comme embed-auto)
  2. Les embed que l'utilisateur est invité à utiliser mais dont la complétion n'entre pas en ligne de compte (cf. des simulateurs qui permettent de répondre à un qcm, ou bien des simulateurs qui ne sont utilisés que pour de l'engagement).

Le premier cas aura donc isCompletionRequired à true
Le second cas aura donc isCompletionRequired à false

Bien que la complétion du simulateur n'est jamais réellement requise (car le user peut cliquer sur "Passer"), ce terme a été validé par le contenu métier. Néanmoins, il pourra être challengé par la suite si on trouve mieux.

Validation Joi

Étant donné que nous commençons à implémenter les embed qui n'ont pas de complétion requise, nous avons fait le choix de forcer l'usage du isCompletionRequired à false lors de la validation Joi, cela afin d'éviter qu'on contribue à un nouvel embed qui aurait isCompletionRequired à true avant que ce genre de comportement ne soit implémenté.

Pour la hauteur d'un embed, nous avons proposé naïvement de mettre un minimum de 0 dans la validation Joi.

💯 Pour tester

Tests de non régression fonctionnels

  1. Se rendre sur le didacticiel
  2. Parcourir le module
  3. Vérifier que rien n'est cassé

Tests de non régression contribution

  1. Récupérer cette branche en local
  2. Lancer le script npm run modulix:test
  3. S'assurer que tous les tests passent au vert

@dlahaye dlahaye self-assigned this Jul 3, 2024
@dlahaye dlahaye requested a review from a team as a code owner July 3, 2024 12:48
@pix-bot-github
Copy link

Une fois les applications déployées, elles seront accessibles via les liens suivants :

Les variables d'environnement seront accessibles via les liens suivants :

@dlahaye dlahaye force-pushed the pix-13091-add-non-auto-embed-to-modulix-tutorial branch 2 times, most recently from 9ff574c to fb9320e Compare July 3, 2024 13:04
Copy link
Contributor

@AnaisAllamand AnaisAllamand left a comment

Choose a reason for hiding this comment

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

OK pour moi

Copy link
Contributor

@mgout mgout left a comment

Choose a reason for hiding this comment

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

👍

@dlahaye dlahaye force-pushed the pix-13091-add-non-auto-embed-to-modulix-tutorial branch 2 times, most recently from c92d8ff to cd09d90 Compare July 4, 2024 14:32
@dlahaye dlahaye changed the title [FEATURE] Ajouter un embed non-auto au référentiel du didacticiel Modulix (PIX-13091) [FEATURE] Ajouter dans le didacticiel un embed sans complétion requise (PIX-13091) Jul 4, 2024
Copy link
Contributor Author

Choose a reason for hiding this comment

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

reboucler avec Anaïs pour valider que le métier n'a pas besoin de relier fortement un embed à sa modalité

…ix.json

Co-authored-by: Clément Latzarus <clement.latzarus@pix.fr>
@pix-service-auto-merge pix-service-auto-merge force-pushed the pix-13091-add-non-auto-embed-to-modulix-tutorial branch from cd09d90 to d2a26b6 Compare July 9, 2024 07:26
@pix-service-auto-merge pix-service-auto-merge merged commit ac3bb35 into dev Jul 9, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants