Ahmad-W1-APIs-Assignment

.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    |   -    |   ✓    |

3-UsingAPIs/Week1/assignment/ex1-johnWho.js

@@ -7,25 +7,26 @@ Rewrite this function, but replace the callback syntax with the Promise syntax:
 - If the Promise `rejects`, pass an error as the argument to 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;
-    }
+export const getAnonName = (firstName) => {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => {
+      if (!firstName) {
+        return reject(new Error("You didn't pass in a first name!"));
+      }
 
-    const fullName = `${firstName} Doe`;
-
-    callback(fullName);
-  }, 1000);
+      const fullName = `${firstName} Doe`;
+      resolve(fullName);
+    }, 1000);
+  });
 };
 
 function main() {
-  getAnonName('John', console.log);
+  getAnonName('John')
+    .then(console.log)
+    .catch(console.error);
 }
 
 // ! Do not change or remove the code below
 if (process.env.NODE_ENV !== 'test') {
   main();
-}
+}

3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js

@@ -11,8 +11,14 @@ 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() {
@@ -37,3 +43,4 @@ function main() {
 if (process.env.NODE_ENV !== 'test') {
   main();
 }
+

3-UsingAPIs/Week1/assignment/ex3-rollDie.js

@@ -10,53 +10,54 @@ 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) {
+export function rollDie() {
+  return new Promise((resolve, reject) => {
+    // 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}`);
+
+      // If the die rolled more than 6 times, reject the promise
+      if (roll > 6) {
+        reject(new Error('Oops... Die rolled off the table.'));
+        return;
+      }
+
+      // If finished rolling successfully, resolve with the final value
+      if (roll === randomRollsToDo) {
+        resolve(value);
+        return;
+      }
+
+      // Schedule the next roll until no more rolls to do
       setTimeout(() => rollOnce(roll + 1), 500);
-    }
-  };
+    };
 
-  // Start the initial roll
-  rollOnce(1);
+    // Start the initial roll
+    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.
+/* With Promises, the computation "settles" only once. After the first resolve() or
+reject(), further calls are ignored. We also added explicit `return` statements
+right after resolve/reject to prevent any further scheduling. As a result, the
+described problem no longer occurs.*/

3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js

@@ -27,9 +27,18 @@ exercise file.
 import { rollDie } from '../../helpers/pokerDiceRoller.js';
 
 export function rollDice() {
-  // TODO Refactor this function
   const dice = [1, 2, 3, 4, 5];
-  return rollDie(1);
+
+  // Create an array of Promises using .map()
+  const rollPromises = dice.map((dieNumber) =>
+    rollDie(dieNumber).catch(() => {
+      // Re-throw the error with the die number
+      throw new Error(`Die ${dieNumber} rolled off the table.`);
+    })
+  );
+
+  // Wait for all dice to settle
+  return Promise.all(rollPromises);
 }
 
 function main() {
@@ -43,4 +52,19 @@ if (process.env.NODE_ENV !== 'test') {
   main();
 }
 
-// TODO Replace this comment by your explanation that was asked for in the assignment description.
+/*
+Explanation (why other dice keep rolling after a rejection):
+
+- We start *all* five asynchronous roll operations immediately.
+- `Promise.all([...])` rejects as soon as the *first* promise rejects, but it
+  does not cancel the other, already-started operations.
+- JavaScript Promises are not cancellable by default; timers inside `rollDie`
+  (e.g. setTimeout) keep firing, so remaining dice keep logging their intermediate
+  values even after the overall `Promise.all` has already rejected.
+
+- We start *all* five asynchronous roll operations immediately.
+- `Promise.all([...])` rejects as soon as the *first* promise rejects, but it
+  does not cancel the other, already-started operations.
+- JavaScript Promises are not cancellable by default; timers inside `rollDie`
+  (e.g. setTimeout) keep firing, so remaining dice keep logging their intermediate
+  values even after the overall `Promise.all` has already rejected. */

3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js

@@ -17,18 +17,22 @@ import { rollDie } from '../../helpers/pokerDiceRoller.js';
 export function rollDice() {
   const results = [];
 
-  // TODO: expand the chain to include five dice
-  return rollDie(1)
-    .then((value) => {
+  // Helper function: rolls a die, stores the result, and returns the promise
+  function rollAndStore(n) {
+    return rollDie(n).then((value) => {
       results.push(value);
-      return rollDie(2);
-    })
-    .then((value) => {
-      results.push(value);
-      return results;
+      return value;
     });
-}
+  }
 
+  // Chain all rolls sequentially using the helper
+  return rollAndStore(1)
+    .then(() => rollAndStore(2))
+    .then(() => rollAndStore(3))
+    .then(() => rollAndStore(4))
+    .then(() => rollAndStore(5))
+    .then(() => results);
+}
 function main() {
   rollDice()
     .then((results) => console.log('Resolved!', results))

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
+    ✅ `getAnonName` should not contain unneeded console.log calls (1 ms)
+    ✅ should call `new Promise()`
+    ✅ should take a single argument (1 ms)
+    ✅ `resolve()` should be called with a one argument
+    ✅ `reject()` should be called with a one argument
+    ✅ should resolve when called with a string argument (5 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.773 s, estimated 1 s
+Ran all test suites matching /D:\\Assignment-cohort54\\Assignments-cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex1-johnWho.test.js/i.
+No linting errors detected.
+No spelling errors detected.

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 (1 ms)
+    ✅ should call new Promise()
+    ✅ `resolve()` should be called with a one argument (3 ms)
+    ✅ `reject()` should be called with a one argument
+    ✅ 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.996 s, estimated 1 s
+Ran all test suites matching /D:\\Assignment-cohort54\\Assignments-cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex2-checkDoubleDigits.test.js/i.
+No linting errors detected.
+No spelling errors detected.

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 (3 ms)
+    ✅ should call `new Promise()` (1 ms)
+    ✅ `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
+
+Test Suites: 1 passed, 1 total
+Tests:       7 passed, 7 total
+Snapshots:   0 total
+Time:        0.83 s, estimated 1 s
+Ran all test suites matching /D:\\Assignment-cohort54\\Assignments-cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex3-rollDie.test.js/i.
+No linting errors detected.
+No spelling errors detected.

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 (3 ms)
+    ✅ should have all TODO comments removed
+    ✅ `rollDice` should not contain unneeded console.log calls (1 ms)
+    ✅ should use `dice.map()` (1 ms)
+    ✅ should use `Promise.all()`
+    ✅ should resolve when all dice settle successfully (13 ms)
+    ✅ should reject with an Error when a die rolls off the table (76 ms)
+
+Test Suites: 1 passed, 1 total
+Tests:       7 passed, 7 total
+Snapshots:   0 total
+Time:        1.035 s
+Ran all test suites matching /D:\\Assignment-cohort54\\Assignments-cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex4-pokerDiceAll.test.js/i.
+No linting errors detected.
+No spelling errors detected.

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
+    ✅ should resolve when all dice settle successfully (98 ms)
+    ✅ should reject with an Error when a die rolls off the table (96 ms)
+
+Test Suites: 1 passed, 1 total
+Tests:       5 passed, 5 total
+Snapshots:   0 total
+Time:        1.145 s
+Ran all test suites matching /D:\\Assignment-cohort54\\Assignments-cohort54\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex5-pokerDiceChain.test.js/i.
+No linting errors detected.
+No spelling errors detected.