Quiz creation DEBUG data improvements #11662
Conversation
github-actions
bot
added
APP: Coach
Build Artifacts
|
There was a problem hiding this comment.
Thanks @nucleogenesis! I added one non-blocking question. I think overall there might be some additional improvements to the comments that can be made in the spec as the feature gets closer and closer to being done, but let's go ahead and merge this so it's available for next week, and we can continue to tweak the comments and names of things if needed as development continues.
| @@ -70,7 +70,7 @@ export default function useQuizCreation(DEBUG = false) { | |||
| console.error("You're trying to generate test data in production. Please set DEBUG = false."); | |||
| } | |||
| // First let's make some QuizQuestion objects so we have them to initialize resources with | |||
| // Typically this data would be fetched and usable from the useQuizResources module | |||
| // Typically this data would be fetched and usable from the useExerciseResources module | |||
There was a problem hiding this comment.
what is the difference between a quiz exercise (i.e. useExerciseResources and a QuizExercise). Is it because the useExerciseResources module will be shared and repurposed beyond "quizzes"?
There was a problem hiding this comment.
maybe this is actually now a commit that got overwritten, but there is still a reference to useExerciseResources in the new diff.
There was a problem hiding this comment.
Yeah the useExerciseResources module is what I'm calling the "navigating the tree, checkbox logic, assessmentmetadata annotations, etc" module.
I think that it will be used in future updates to Lesson as well (or at least want it to be an option for that).
Summary
DEBUG data
Improves the DEBUG data generation when the
DEBUGflag is set totruein theuseQuizCreationmodule.This relies heavily on the
quizCreationSpecs.jsmodule which defines a set of "types" which are referenced throughout the greater quiz creation module.We generate a bunch of questions (
QuizQuestion) and then we create a bunch of resources (QuizResource- representing aContentNodeobject suitable for our uses (aka, it hasassessmentidswhich map to theQuizQuestion.question_id).Those resources are then used to generate the
resource_poolproperties for some sections (QuizSection) and then sets that sectionsquestions(QuizQuestion[]) array to the items in our dummy questions that match the section'sresource_poolresources.IRL a separate module will be handling the business of fetching and storing the
QuizQuestiondata which we can read from based on the data in a quiz section. For example -- when a user "selects resources" the section'sresource_poolwill list the resources selected. This gives us a list ofassessment_idswhich we can use to fetch and display actual questions from within each resource.Removing
ExerciseResourceI previously envisioned that the module would work in a way where the
resource_poolcould house either a Topic OR an Exercise and then we'd be able to answer the question "should the checkbox for this Topic here be checked, indeterminate (ie, we have some but not all children of the topic), or unchecked?" by reducing theresource_poolto list of all of the exercises within selected topics and so forth.However, after chatting w/ @rtibbles we're going to lean on the
fetchTreeAPI method which will allow us to basically get 2 generations of a tree at any time so we will only give the topic a checkbox if we can get all of its children using this. We'll calculate this by comparing the "total resources in this topic" with the "total resources among this topics children and grandchildren" -- if they're different, then we cannot access all of the Exercises in the Topic and won't show the checkbox at all.The point is -- we only now are concerned with one "type", the
QuizResourcewhich will be an Exercise and have the assessment_ids we need to get the actual questions.Bonus fixes
Reviewer guidance
Code Review