Merge pull request #14492 from ethereum/quiz-patch

Fix: Custom quiz explanation override [Fixes #14490]
ethereum · Dec 18, 2024 · 279ea64 · 279ea64
2 parents c639b2a + e9646a8
commit 279ea64
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 14 deletions.
diff --git a/src/data/quizzes/questionBank.ts b/src/data/quizzes/questionBank.ts
@@ -1,4 +1,8 @@
-import type { QuestionBank, QuestionBankConfig } from "@/lib/types"
+import type {
+  ChoiceLetter,
+  QuestionBank,
+  QuestionBankConfig,
+} from "@/lib/types"
 
 /**
  * This file is used to generate the question bank for the quizzes.
@@ -30,13 +34,32 @@ import type { QuestionBank, QuestionBankConfig } from "@/lib/types"
  * - "what-is-ethereum-1-c-explanation"
  * - "what-is-ethereum-1-d-label"
  * - "what-is-ethereum-1-d-explanation"
+ *
+ * To re-use answer explanations from other choices within the same question,
+ * append an optional explanationOverrides array to the question object.
+ * This take the format of an array of 1-indexed answer choices to re-use, with
+ * the position in the array representing which question to override. First
+ * position is "a".
+ *
+ * Example - Re-use the first answer explanation for all choices:
+ * "what-is-ethereum": [
+ * { totalAnswers: 4, correctAnswer: 2, explanationOverrides: [1, 1, 1, 1] }
+ * ]
+ *
+ * With that alteration, requires the following strings in learn-quizzes.json:
+ * - "what-is-ethereum-1-prompt"
+ * - "what-is-ethereum-1-a-label"
+ * - "what-is-ethereum-1-a-explanation"
+ * - "what-is-ethereum-1-b-label"
+ * - "what-is-ethereum-1-c-label"
+ * - "what-is-ethereum-1-d-label"
  */
 const questionBankConfig: QuestionBankConfig = {
   "what-is-ethereum": [
     { totalAnswers: 4, correctAnswer: 2 },
     { totalAnswers: 4, correctAnswer: 1 },
     { totalAnswers: 4, correctAnswer: 4 },
-    { totalAnswers: 4, correctAnswer: 1 },
+    { totalAnswers: 4, correctAnswer: 1, explanationOverrides: [1, 1, 1, 1] },
     { totalAnswers: 4, correctAnswer: 4 },
   ],
   "what-is-ether": [
@@ -109,11 +132,11 @@ const questionBankConfig: QuestionBankConfig = {
   ],
   "run-a-node": [
     { totalAnswers: 4, correctAnswer: 1 },
-    { totalAnswers: 4, correctAnswer: 1 },
+    { totalAnswers: 4, correctAnswer: 1, explanationOverrides: [1, 1, 1, 1] },
     { totalAnswers: 4, correctAnswer: 4 },
     { totalAnswers: 4, correctAnswer: 3 },
     { totalAnswers: 4, correctAnswer: 1 },
-    { totalAnswers: 2, correctAnswer: 2 },
+    { totalAnswers: 2, correctAnswer: 2, explanationOverrides: [1, 1] },
   ],
   stablecoins: [
     { totalAnswers: 4, correctAnswer: 1 },
@@ -137,19 +160,26 @@ const charFromIdx = (idx: number) => String.fromCharCode(97 + idx)
 const questionBank = Object.entries(questionBankConfig).reduce(
   (acc, [topicKey, value]) => {
     for (const [idx, question] of value.entries()) {
-      const { totalAnswers, correctAnswer } = question
+      const { totalAnswers, correctAnswer, explanationOverrides } = question
       const questionKey = `${topicKey}-${idx + 1}`
       const questionObject = {
         prompt: `${questionKey}-prompt`,
         answers: Array(totalAnswers)
           .fill(0)
           .map((_, i) => {
-            const choice = charFromIdx(i) as "a" | "b" | "c" | "d"
+            const choice = charFromIdx(i) as ChoiceLetter
+            const exIdx =
+              explanationOverrides && explanationOverrides[i]
+                ? explanationOverrides[i] - 1
+                : i
+            const exLetter = charFromIdx(exIdx) as ChoiceLetter
+
             const id = `${questionKey}-${choice}`
+            const exId = `${questionKey}-${exLetter}`
             return {
               id,
               label: `${id}-label`,
-              explanation: `${id}-explanation`,
+              explanation: `${exId}-explanation`,
             }
           }),
         correctAnswerId: `${questionKey}-${charFromIdx(correctAnswer - 1)}`,

diff --git a/src/intl/en/learn-quizzes.json b/src/intl/en/learn-quizzes.json
@@ -58,10 +58,10 @@
   "what-is-ethereum-3-d-explanation": "Anyone running a node is a crucial part of Ethereum’s infrastructure. If you haven’t already, consider running an Ethereum node.",
   "what-is-ethereum-4-prompt": "Since Ethereum launched, how many times has the network been offline?",
   "what-is-ethereum-4-a-label": "Never",
+  "what-is-ethereum-4-a-explanation": "Ethereum has never gone completely offline (stopped producing blocks) since it launched.",
   "what-is-ethereum-4-b-label": "Once",
   "what-is-ethereum-4-c-label": "Four times",
   "what-is-ethereum-4-d-label": "More than ten times",
-  "what-is-ethereum-4-explanation": "Ethereum has never gone completely offline (stopped producing blocks) since it launched.",
   "what-is-ethereum-5-prompt": "Ethereum consumes more electricity than:",
   "what-is-ethereum-5-a-label": "Gold mining",
   "what-is-ethereum-5-a-explanation": "Gold mining uses ~131 Terawatt hours per year. Ethereum uses about 0.0026 Terawatt hours per year.",

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -161,13 +161,19 @@ export type LoadingState<T> =
   | { loading: false; data: T }
   | { loading: false; error: unknown }
 
-/**
- * Quiz data types
- */
-export type QuestionTemplate = {
-  totalAnswers: 2 | 3 | 4
-  correctAnswer: 1 | 2 | 3 | 4
+// Quiz data types
+
+export type ChoiceLetter = "a" | "b" | "c" | "d"
+
+type ChoiceNumber = 1 | 2 | 3 | 4
+type TotalAnswers = 2 | 3 | 4
+
+type QuestionTemplate = {
+  totalAnswers: TotalAnswers
+  correctAnswer: ChoiceNumber
+  explanationOverrides?: (ChoiceNumber | null)[] // Tuple<ChoiceNumber, QuestionTemplate["totalAnswers"]>
 }
+
 export type QuestionBankConfig = Record<string, QuestionTemplate[]>
 
 export type Answer = {