diff --git a/.test-summary/TEST_SUMMARY.md b/.test-summary/TEST_SUMMARY.md new file mode 100644 index 000000000..d3a57c403 --- /dev/null +++ b/.test-summary/TEST_SUMMARY.md @@ -0,0 +1,13 @@ +## Test Summary + +**Mentors**: For more information on how to review homework assignments, please refer to the [Review Guide](https://github.com/HackYourFuture/mentors/blob/main/assignment-support/review-guide.md). + +### 3-UsingAPIs - Week1 + +| Exercise | Passed | Failed | ESLint | +|-----------------------|--------|--------|--------| +| ex1-johnWho | 9 | - | ✓ | +| ex2-checkDoubleDigits | 11 | - | ✓ | +| ex3-rollDie | 7 | - | ✓ | +| ex4-pokerDiceAll | 7 | - | ✓ | +| ex5-pokerDiceChain | 5 | - | ✓ | diff --git a/3-UsingAPIs/Week1/assignment/ex1-johnWho.js b/3-UsingAPIs/Week1/assignment/ex1-johnWho.js index 5851c8c4f..4703f4816 100644 --- a/3-UsingAPIs/Week1/assignment/ex1-johnWho.js +++ b/3-UsingAPIs/Week1/assignment/ex1-johnWho.js @@ -1,28 +1,30 @@ /*------------------------------------------------------------------------------ -Full description at: https://github.com/HackYourFuture/Assignments/tree/main/3-UsingAPIs/Week1#exercise-1-john-who +Full description at: +https://github.com/HackYourFuture/Assignments/tree/main/3-UsingAPIs/Week1#exercise-1-john-who -Rewrite this function, but replace the callback syntax with the Promise syntax: -- Have the `getAnonName` function return a `new Promise`. -- If the Promise `resolves`, pass the full name as an argument to resolve with. -- If the Promise `rejects`, pass an error as the argument to reject with: "You - didn't pass in a first name!" +Rewrite this function using Promise syntax: +- Return a new Promise from getAnonName. +- resolve with the full name. +- reject with: "You didn't pass in a first name!" ------------------------------------------------------------------------------*/ -// TODO see above -export const getAnonName = (firstName, callback) => { - setTimeout(() => { - if (!firstName) { - callback(new Error("You didn't pass in a first name!")); - return; - } - const fullName = `${firstName} Doe`; - - callback(fullName); - }, 1000); +export const getAnonName = (firstName) => { + return new Promise((resolve, reject) => { + setTimeout(() => { + if (!firstName) { + reject(new Error("You didn't pass in a first name!")); + return; + } + const fullName = `${firstName} Doe`; + resolve(fullName); + }, 1000); + }); }; function main() { - getAnonName('John', console.log); + getAnonName('John') + .then(console.log) + .catch(err => console.error(err.message)); } // ! Do not change or remove the code below diff --git a/3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js b/3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js index 4b31d1927..486006572 100644 --- a/3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js +++ b/3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js @@ -11,10 +11,16 @@ Complete the function called `checkDoubleDigits` such that: "Expected a double digit number but got `number`", where `number` is the number that was passed as an argument. ------------------------------------------------------------------------------*/ -export function checkDoubleDigits(/* TODO add parameter(s) here */) { - // TODO complete this function -} +export function checkDoubleDigits(number) { + return new Promise((resolve, reject) => { + if (number >= 10 && number <= 99) { + resolve('This is a double digit number!'); + } else { + reject(new Error(`Expected a double digit number but got ${number}`)); + } + }); +} function main() { checkDoubleDigits(9) // should reject .then((message) => console.log(message)) diff --git a/3-UsingAPIs/Week1/assignment/ex3-rollDie.js b/3-UsingAPIs/Week1/assignment/ex3-rollDie.js index 7e4b77888..244abcebf 100644 --- a/3-UsingAPIs/Week1/assignment/ex3-rollDie.js +++ b/3-UsingAPIs/Week1/assignment/ex3-rollDie.js @@ -10,53 +10,45 @@ Full description at: https://github.com/HackYourFuture/Assignments/tree/main/3-U explanation? Add your answer as a comment to be bottom of the file. ------------------------------------------------------------------------------*/ -// TODO Remove callback and return a promise -export function rollDie(callback) { - // Compute a random number of rolls (3-10) that the die MUST complete - const randomRollsToDo = Math.floor(Math.random() * 8) + 3; - console.log(`Die scheduled for ${randomRollsToDo} rolls...`); - - const rollOnce = (roll) => { - // Compute a random die value for the current roll - const value = Math.floor(Math.random() * 6) + 1; - console.log(`Die value is now: ${value}`); - - // Use callback to notify that the die rolled off the table after 6 rolls - if (roll > 6) { - // TODO replace "error" callback - callback(new Error('Oops... Die rolled off the table.')); - } - - // Use callback to communicate the final die value once finished rolling - if (roll === randomRollsToDo) { - // TODO replace "success" callback - callback(null, value); - } - - // Schedule the next roll todo until no more rolls to do - if (roll < randomRollsToDo) { - setTimeout(() => rollOnce(roll + 1), 500); - } - }; - - // Start the initial roll - rollOnce(1); +export function rollDie() { + return new Promise((resolve, reject) => { + const randomRollsToDo = Math.floor(Math.random() * 8) + 3; + console.log(`Die scheduled for ${randomRollsToDo} rolls...`); + const rollOnce = (roll) => { + const value = Math.floor(Math.random() * 6) + 1; + console.log(`Die value is now: ${value}`); + if (roll > 6) { + reject(new Error('Oops... Die rolled off the table.')); + } + if (roll === randomRollsToDo) { + resolve(value); + return; + } + if (roll < randomRollsToDo) { + setTimeout(() => rollOnce(roll + 1), 500); + } + }; + rollOnce(1); + }); } - function main() { - // TODO Refactor to use promise - rollDie((error, value) => { - if (error !== null) { - console.log(error.message); - } else { + rollDie() + .then((value) => { console.log(`Success! Die settled on ${value}.`); - } - }); + }) + .catch((error) => { + console.log(error.message); + }); } - // ! Do not change or remove the code below if (process.env.NODE_ENV !== 'test') { main(); } - -// TODO Replace this comment by your explanation that was asked for in the assignment description. +/* +Explanation: +Removing the `return` after `reject(...)` ensures that `rollOnce` continues to +schedule and log the remaining rolls (up to the scheduled count), even after the +promise has been rejected because the die "rolled off the table". This matches +the exercise requirement: all scheduled rolls should complete, while the promise +still settles as a rejection at the moment of the "off the table" event. +*/ diff --git a/3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js b/3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js index d88cd71d2..6f3a1f801 100644 --- a/3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js +++ b/3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js @@ -21,26 +21,31 @@ yet finished their roll continue to do so. Can you explain why? Please add your answer as a comment to the end of the exercise file. ------------------------------------------------------------------------------*/ +/*------------------------------------------------------------------------------ +Full description at: https://github.com/HackYourFuture/Assignments/tree/main/3-UsingAPIs/Week1#exercise-4-throw-the-dice-for-a-poker-dice-game +------------------------------------------------------------------------------*/ -// The line below makes the rollDie() function available to this file. -// Do not change or remove it. import { rollDie } from '../../helpers/pokerDiceRoller.js'; - export function rollDice() { - // TODO Refactor this function const dice = [1, 2, 3, 4, 5]; - return rollDie(1); + const dicePromises = dice.map((die) => rollDie(die)); + return Promise.all(dicePromises); } - function main() { rollDice() .then((results) => console.log('Resolved!', results)) .catch((error) => console.log('Rejected!', error.message)); } - // ! Do not change or remove the code below if (process.env.NODE_ENV !== 'test') { main(); } -// TODO Replace this comment by your explanation that was asked for in the assignment description. +/* +Explanation: +`Promise.all()` runs all five dice rolls at the same time. +It returns a single Promise that resolves when all the dice finish rolling +and provides an array with all their results. +If any one die rejects (for example, rolls off the table), +the entire `Promise.all()` rejects immediately with that error. +*/ diff --git a/3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js b/3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js index 5b1394b84..2cbcf5afa 100644 --- a/3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js +++ b/3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js @@ -10,19 +10,28 @@ To throw the dice sequentially we will be using a _promise chain_. Your job is to expand the given promise chain to include five dice. ------------------------------------------------------------------------------*/ -// The line below makes the rollDie() function available to this file. -// Do not change or remove it. import { rollDie } from '../../helpers/pokerDiceRoller.js'; export function rollDice() { const results = []; - // TODO: expand the chain to include five dice return rollDie(1) .then((value) => { results.push(value); return rollDie(2); }) + .then((value) => { + results.push(value); + return rollDie(3); + }) + .then((value) => { + results.push(value); + return rollDie(4); + }) + .then((value) => { + results.push(value); + return rollDie(5); + }) .then((value) => { results.push(value); return results; @@ -39,3 +48,12 @@ function main() { if (process.env.NODE_ENV !== 'test') { main(); } + +/* +Explanation: +In this exercise, we use a Promise **chain** instead of `Promise.all()`. +Each `.then()` waits for the previous die to finish rolling before starting the next one. +This ensures the dice are rolled sequentially, not in parallel. +If any die rejects (for example, it falls off the table), +the chain stops immediately and the final Promise rejects with that error. +*/ diff --git a/3-UsingAPIs/Week1/test-reports/ex1-johnWho.report.txt b/3-UsingAPIs/Week1/test-reports/ex1-johnWho.report.txt new file mode 100644 index 000000000..d9662f0ed --- /dev/null +++ b/3-UsingAPIs/Week1/test-reports/ex1-johnWho.report.txt @@ -0,0 +1,21 @@ +*** Unit Test Error Report *** + + PASS .dist/3-UsingAPIs/Week1/unit-tests/ex1-johnWho.test.js + api-wk1-ex1-johnWho + ✅ should exist and be executable (2 ms) + ✅ should have all TODO comments removed (1 ms) + ✅ `getAnonName` should not contain unneeded console.log calls + ✅ should call `new Promise()` (1 ms) + ✅ should take a single argument + ✅ `resolve()` should be called with a one argument + ✅ `reject()` should be called with a one argument + ✅ should resolve when called with a string argument (1 ms) + ✅ should reject with an Error object when called without an argument (1 ms) + +Test Suites: 1 passed, 1 total +Tests: 9 passed, 9 total +Snapshots: 0 total +Time: 0.772 s, estimated 1 s +Ran all test suites matching /C:\\Users\\Rimha\\Assignments-Cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex1-johnWho.test.js/i. +No linting errors detected. +No spelling errors detected. diff --git a/3-UsingAPIs/Week1/test-reports/ex2-checkDoubleDigits.report.txt b/3-UsingAPIs/Week1/test-reports/ex2-checkDoubleDigits.report.txt new file mode 100644 index 000000000..a41df3dfe --- /dev/null +++ b/3-UsingAPIs/Week1/test-reports/ex2-checkDoubleDigits.report.txt @@ -0,0 +1,23 @@ +*** Unit Test Error Report *** + + PASS .dist/3-UsingAPIs/Week1/unit-tests/ex2-checkDoubleDigits.test.js + api-wk1-ex2-checkDoubleDigits + ✅ should exist and be executable (2 ms) + ✅ should have all TODO comments removed (1 ms) + ✅ `checkDoubleDigits` should not contain unneeded console.log calls + ✅ should call new Promise() + ✅ `resolve()` should be called with a one argument + ✅ `reject()` should be called with a one argument (1 ms) + ✅ should be a function that takes a single argument + ✅ (9) should return a rejected promise with an Error object (1 ms) + ✅ (10) should return a promise that resolves to "This is a double digit number!" (1 ms) + ✅ (99) should return a promise that resolves to "This is a double digit number!" + ✅ (100) should return a rejected promise with an Error object + +Test Suites: 1 passed, 1 total +Tests: 11 passed, 11 total +Snapshots: 0 total +Time: 0.785 s, estimated 1 s +Ran all test suites matching /C:\\Users\\Rimha\\Assignments-Cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex2-checkDoubleDigits.test.js/i. +No linting errors detected. +No spelling errors detected. diff --git a/3-UsingAPIs/Week1/test-reports/ex3-rollDie.report.txt b/3-UsingAPIs/Week1/test-reports/ex3-rollDie.report.txt new file mode 100644 index 000000000..77338bed8 --- /dev/null +++ b/3-UsingAPIs/Week1/test-reports/ex3-rollDie.report.txt @@ -0,0 +1,19 @@ +*** Unit Test Error Report *** + + PASS .dist/3-UsingAPIs/Week1/unit-tests/ex3-rollDie.test.js + api-wk1-ex3-rollDie + ✅ should exist and be executable (2 ms) + ✅ should have all TODO comments removed (1 ms) + ✅ should call `new Promise()` + ✅ `resolve()` should be called with a one argument (1 ms) + ✅ `reject()` should be called with a one argument + ✅ should resolve when the die settles successfully (1 ms) + ✅ should reject with an Error when the die rolls off the table (1 ms) + +Test Suites: 1 passed, 1 total +Tests: 7 passed, 7 total +Snapshots: 0 total +Time: 0.789 s, estimated 1 s +Ran all test suites matching /C:\\Users\\Rimha\\Assignments-Cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex3-rollDie.test.js/i. +No linting errors detected. +No spelling errors detected. diff --git a/3-UsingAPIs/Week1/test-reports/ex4-pokerDiceAll.report.txt b/3-UsingAPIs/Week1/test-reports/ex4-pokerDiceAll.report.txt new file mode 100644 index 000000000..f5893517d --- /dev/null +++ b/3-UsingAPIs/Week1/test-reports/ex4-pokerDiceAll.report.txt @@ -0,0 +1,19 @@ +*** Unit Test Error Report *** + + PASS .dist/3-UsingAPIs/Week1/unit-tests/ex4-pokerDiceAll.test.js + api-wk1-ex4-pokerDiceAll + ✅ should exist and be executable (2 ms) + ✅ should have all TODO comments removed (1 ms) + ✅ `rollDice` should not contain unneeded console.log calls + ✅ should use `dice.map()` (1 ms) + ✅ should use `Promise.all()` + ✅ should resolve when all dice settle successfully (11 ms) + ✅ should reject with an Error when a die rolls off the table (68 ms) + +Test Suites: 1 passed, 1 total +Tests: 7 passed, 7 total +Snapshots: 0 total +Time: 0.874 s, estimated 1 s +Ran all test suites matching /C:\\Users\\Rimha\\Assignments-Cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex4-pokerDiceAll.test.js/i. +No linting errors detected. +No spelling errors detected. diff --git a/3-UsingAPIs/Week1/test-reports/ex5-pokerDiceChain.report.txt b/3-UsingAPIs/Week1/test-reports/ex5-pokerDiceChain.report.txt new file mode 100644 index 000000000..0eccc2319 --- /dev/null +++ b/3-UsingAPIs/Week1/test-reports/ex5-pokerDiceChain.report.txt @@ -0,0 +1,17 @@ +*** Unit Test Error Report *** + + PASS .dist/3-UsingAPIs/Week1/unit-tests/ex5-pokerDiceChain.test.js + api-wk1-ex5-pokerDiceChain + ✅ should exist and be executable (1 ms) + ✅ should have all TODO comments removed + ✅ `rollDice` should not contain unneeded console.log calls (1 ms) + ✅ should resolve when all dice settle successfully (101 ms) + ✅ should reject with an Error when a die rolls off the table (92 ms) + +Test Suites: 1 passed, 1 total +Tests: 5 passed, 5 total +Snapshots: 0 total +Time: 1.05 s +Ran all test suites matching /C:\\Users\\Rimha\\Assignments-Cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex5-pokerDiceChain.test.js/i. +No linting errors detected. +No spelling errors detected.