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

rizan_ibrahim-UsingAPIs-w1-assingment #57

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .test-summary/TEST_SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## 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 | - | ✕ |
24 changes: 13 additions & 11 deletions 3-UsingAPIs/Week1/assignment/ex1-johnWho.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,24 @@ 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;
}

const fullName = `${firstName} Doe`;
export const getAnonName = (firstName) => {
return new Promise((resolve, reject) => {
setTimeout(() => {
if (!firstName) {
reject(new Error("You didn't pass in a first name!"));
return;
}

callback(fullName);
}, 1000);
const fullName = `${firstName} Doe`;

resolve(fullName);
}, 1000);
});
};

function main() {
getAnonName('John', console.log);
getAnonName('John').then(console.log).catch(console.log);
}

// ! Do not change or remove the code below
Expand Down
11 changes: 9 additions & 2 deletions 3-UsingAPIs/Week1/assignment/ex2-checkDoubleDigits.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@ 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}`));
}
});

Choose a reason for hiding this comment

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

👍

}

function main() {
Expand Down
75 changes: 36 additions & 39 deletions 3-UsingAPIs/Week1/assignment/ex3-rollDie.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,53 +10,50 @@ 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) {
export function rollDie() {
// 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);
return new Promise((resolve, reject) => {
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) {
reject(new Error('Oops... Die rolled off the table.'));
}

// Use callback to communicate the final die value once finished rolling
if (roll === randomRollsToDo) {
resolve(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);
});
}

function main() {
// TODO Refactor to use promise
rollDie((error, value) => {
if (error !== null) {
console.log(error.message);
} else {
console.log(`Success! Die settled on ${value}.`);
}
});
rollDie()
.then((value) => console.log(`success! Die value is: ${value}`))
.catch((error) => console.log(error.message));

Choose a reason for hiding this comment

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

👍

}

// ! Do not change or remove the code below

Choose a reason for hiding this comment

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

There is still a TODO left to be done.

if (process.env.NODE_ENV !== 'test') {
main();
}

// TODO Replace this comment by your explanation that was asked for in the assignment description.
/*
Explanation:
The `rollDie` function simulates rolling a die until it lands on a value of 6. It uses a recursive function `rollOnce` to keep rolling the die. The function returns a promise that resolves when the die lands on 6 and rejects if an error occurs. The `rollOnce` function logs each attempt and rolls the die again after a 1-second delay if the value is not 6.
*/

Choose a reason for hiding this comment

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

This explains what the promise version does, not why the behaviour is different from the callback version of the code. The key point here is that when a die rolls off the table if calls reject() and then continues its scheduled rolls while off the table. When it has completed its scheduled rolls it finally calls resolve(). But contrary to the callback version this has no effect because once a promise is settled, either by a call to reject() or to resolve(), subsequent calls to either of them are ignored.

11 changes: 8 additions & 3 deletions 3-UsingAPIs/Week1/assignment/ex4-pokerDiceAll.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ 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);
const promises = dice.map(rollDie);
return Promise.all(promises);

}

function main() {
Expand All @@ -43,4 +45,7 @@ if (process.env.NODE_ENV !== 'test') {
main();
}

// TODO Replace this comment by your explanation that was asked for in the assignment description.
/*
Explanation:
When using `Promise.all`, if one of the promises is rejected, the entire `Promise.all` is rejected immediately with that reason. However, the other promises that have not yet finished their roll will continue to execute. This is because `Promise.all` does not cancel the remaining promises; it simply stops waiting for them once one promise is rejected.
*/

Choose a reason for hiding this comment

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

Excellent explanation. This is exactly right.

14 changes: 13 additions & 1 deletion 3-UsingAPIs/Week1/assignment/ex5-pokerDiceChain.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,24 @@ import { rollDie } from '../../helpers/pokerDiceRoller.js';
export function rollDice() {
const results = [];

// TODO: expand the chain to include five dice
// 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);
})

Choose a reason for hiding this comment

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

👍

.then((value) => {
results.push(value);
return results;
Expand Down
21 changes: 21 additions & 0 deletions 3-UsingAPIs/Week1/test-reports/ex1-johnWho.report.txt
Original file line number Diff line number Diff line change
@@ -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

Test Suites: 1 passed, 1 total
Tests: 9 passed, 9 total
Snapshots: 0 total
Time: 0.497 s, estimated 1 s
Ran all test suites matching /C:\\Users\\rizan\\Assignments-cohort51\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex1-johnWho.test.js/i.
No linting errors detected.
No spelling errors detected.
23 changes: 23 additions & 0 deletions 3-UsingAPIs/Week1/test-reports/ex2-checkDoubleDigits.report.txt
Original file line number Diff line number Diff line change
@@ -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
✅ should be a function that takes a single argument (1 ms)
✅ (9) should return a rejected promise with an Error object
✅ (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!" (1 ms)
✅ (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.629 s
Ran all test suites matching /C:\\Users\\rizan\\Assignments-cohort51\\.dist\\3-UsingAPIs\\Week1\\unit-tests\\ex2-checkDoubleDigits.test.js/i.
No linting errors detected.
No spelling errors detected.