252 lines
18 KiB
JSON
252 lines
18 KiB
JSON
{
|
||
"name": "MongoDB and Mongoose",
|
||
"order": 3,
|
||
"time": "5 hours",
|
||
"helpRoom": "Help",
|
||
"challenges": [
|
||
{
|
||
"id": "587d7fb6367417b2b2512c06",
|
||
"title": "Install and Set Up Mongoose",
|
||
"description": [
|
||
"Add mongodb and mongoose to the project’s package.json. Then require mongoose. Store your mLab database URI in the private .env file as MONGO_URI. Connect to the database using mongoose.connect(<Your URI>)"
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "\"mongodb\" dependency should be in package.json",
|
||
"testString": "getUserInput => $.get(getUserInput('url') + '/_api/file/package.json').then(data => { var packJson = JSON.parse(data); assert.property(packJson.dependencies, 'mongodb'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
},
|
||
{
|
||
"text": "\"mongoose\" dependency should be in package.json",
|
||
"testString": "getUserInput => $.get(getUserInput('url') + '/_api/file/package.json').then(data => { var packJson = JSON.parse(data); assert.property(packJson.dependencies, 'mongoose'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
},
|
||
{
|
||
"text": "\"mongoose\" should be connected to a database",
|
||
"testString": "getUserInput => $.get(getUserInput('url') + '/_api/is-mongoose-ok').then(data => {assert.isTrue(data.isMongooseOk, 'mongoose is not connected')}, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb6367417b2b2512c07",
|
||
"title": "Create a Model",
|
||
"description": [
|
||
"First of all we need a Schema. Each schema maps to a MongoDB collection. It defines the shape of the documents within that collection.",
|
||
"Schemas are building block for Models. They can be nested to create complex models, but in this case we’ll keep things simple.",
|
||
"A model allows you to create instances of your objects, called documents.",
|
||
"Create a person having this prototype :",
|
||
"<code>- Person Prototype -</code>",
|
||
"<code>--------------------</code>",
|
||
"<code>name : string [required]</code>",
|
||
"<code>age : number</code>",
|
||
"<code>favoriteFoods : array of strings (*) </code>",
|
||
"Use the mongoose basic schema types. If you want you can also add",
|
||
"more fields, use simple validators like required or unique,",
|
||
"and set default values. See the <a href='http://mongoosejs.com/docs/guide.html'>mongoose docs</a>.",
|
||
"[C]RUD Part I - CREATE",
|
||
"Note: Glitch is a real server, and in real servers the interactions with the db happen in handler functions. These function are executed when some event happens (e.g. someone hits an endpoint on your API). We’ll follow the same approach in these exercises. The done() function is a callback that tells us that we can proceed after completing an asynchronous operation such as inserting, searching, updating or deleting. It’s following the Node convention and should be called as done(null, data) on success, or done(err) on error.",
|
||
"Warning - When interacting with remote services, errors may occur !",
|
||
"<code>/* Example */</code>",
|
||
"<code>var someFunc = function(done) {</code>",
|
||
"<code> //... do something (risky) ...</code>",
|
||
"<code> if(error) return done(error);</code>",
|
||
"<code> done(null, result);</code>",
|
||
"<code>};</code>"
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Creating an instance from a mongoose schema should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/mongoose-model', {name: 'Mike', age: 28, favoriteFoods: ['pizza', 'cheese']}).then(data => { assert.equal(data.name, 'Mike', '\"model.name\" is not what expected'); assert.equal(data.age, '28', '\"model.age\" is not what expected'); assert.isArray(data.favoriteFoods, '\"model.favoriteFoods\" is not an Array'); assert.include(data.favoriteFoods, 'pizza', '\"model.favoriteFoods\" does not include the expected items'); assert.include(data.favoriteFoods, 'cheese', '\"model.favoriteFoods\" does not include the expected items'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb6367417b2b2512c09",
|
||
"title": "Create and Save a Record of a Model",
|
||
"description": [
|
||
"Create a document instance using the Person constructor you build before. Pass to the constructor an object having the fields name, age, and favoriteFoods. Their types must be conformant to the ones in the Person Schema. Then call the method document.save() on the returned document instance. Pass to it a callback using the Node convention. This is a common pattern, all the following CRUD methods take a callback function like this as the last argument.",
|
||
"<code>/* Example */</code>",
|
||
"<code>// ...</code>",
|
||
"<code>person.save(function(err, data) {</code>",
|
||
"<code>// ...do your stuff here...</code>",
|
||
"<code>});</code>"
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Creating and saving a db item should succeed",
|
||
"testString": "getUserInput => $.get(getUserInput('url') + '/_api/create-and-save-person').then(data => { assert.isString(data.name, '\"item.name\" should be a String'); assert.isNumber(data.age, '28', '\"item.age\" should be a Number'); assert.isArray(data.favoriteFoods, '\"item.favoriteFoods\" should be an Array'); assert.equal(data.__v, 0, 'The db item should be not previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb7367417b2b2512c0a",
|
||
"title": "Create Many Records with model.create()",
|
||
"description": [
|
||
"Sometimes you need to create many instances of your models, e.g. when seeding a database with initial data. Model.create() takes an array of objects like [{name: 'John', ...}, {...}, ...] as the first argument, and saves them all in the db. Create many people with Model.create(), using the function argument arrayOfPeople."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Creating many db items at once should succeed",
|
||
"testString": "getUserInput => $.ajax({url: getUserInput('url') + '/_api/create-many-people', type: 'POST', contentType:'application/json', data: JSON.stringify([{name: 'John', age: 24, favoriteFoods: ['pizza', 'salad']}, {name: 'Mary', age: 21, favoriteFoods: ['onions', 'chicken']}])}).then(data => { assert.isArray(data, 'the response should be an array'); assert.equal(data.length, 2, 'the response does not contain the expected number of items'); assert.equal(data[0].name, 'John', 'The first item is not correct'); assert.equal(data[0].__v, 0, 'The first item should be not previously edited'); assert.equal(data[1].name, 'Mary', 'The second item is not correct'); assert.equal(data[1].__v, 0, 'The second item should be not previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb7367417b2b2512c0b",
|
||
"title": "Use model.find() to Search Your Database",
|
||
"description": [
|
||
"Find all the people having a given name, using Model.find() -> [Person]",
|
||
"In its simplest usage, Model.find() accepts a query document (a JSON object ) as the first argument, then a callback. It returns an array of matches. It supports an extremely wide range of search options. Check it in the docs. Use the function argument personName as search key."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Find all items corresponding to a criteria should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/find-all-by-name', {name: 'r@nd0mN4m3', age: 24, favoriteFoods: ['pizza']}).then(data => { assert.isArray(data, 'the response should be an Array'); assert.equal(data[0].name, 'r@nd0mN4m3', 'item.name is not what expected'); assert.equal(data[0].__v, 0, 'The item should be not previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb7367417b2b2512c0c",
|
||
"title": "Use model.findOne() to Return a Single Matching Document from Your Database",
|
||
"description": [
|
||
"Model.findOne() behaves like .find(), but it returns only one document (not an array), even if there are items. It is especially useful when searching by properties that you have declared as unique. Find just one person which has a certain food in her favorites, using Model.findOne() -> Person. Use the function argument food as search key."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Find one item should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/find-one-by-food', {name: 'Gary', age: 46, favoriteFoods: ['chicken salad']}).then(data => { assert.equal(data.name, 'Gary', 'item.name is not what expected'); assert.deepEqual(data.favoriteFoods, ['chicken salad'], 'item.favoriteFoods is not what expected'); assert.equal(data.__v, 0, 'The item should be not previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb7367417b2b2512c0d",
|
||
"title": "Use model.findById() to Search Your Database By _id",
|
||
"description": [
|
||
"When saving a document, mongodb automatically adds the field _id, and set it to a unique alphanumeric key. Searching by _id is an extremely frequent operation, so moongose provides a dedicated method for it. Find the (only!!) person having a given _id, using Model.findById() -> Person. Use the function argument personId as search key."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Find an item by Id should succeed",
|
||
"testString": "getUserInput => $.get(getUserInput('url') + '/_api/find-by-id').then(data => { assert.equal(data.name, 'test', 'item.name is not what expected'); assert.equal(data.age, 0, 'item.age is not what expected'); assert.deepEqual(data.favoriteFoods, ['none'], 'item.favoriteFoods is not what expected'); assert.equal(data.__v, 0, 'The item should be not previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb8367417b2b2512c0e",
|
||
"title": "Perform Classic Updates by Running Find, Edit, then Save",
|
||
"description": [
|
||
"In the good old days this was what you needed to do if you wanted to edit a document and be able to use it somehow e.g. sending it back in a server response. Mongoose has a dedicated updating method : Model.update(). It is binded to the low-level mongo driver. It can bulk edit many documents matching certain criteria, but it doesn’t send back the updated document, only a ‘status’ message. Furthermore it makes model validations difficult, because it just directly calls the mongo driver.",
|
||
"Find a person by _id ( use any of the above methods ) with the parameter personId as search key. Add “hamburger” to the list of her favoriteFoods (you can use Array.push()). Then - inside the find callback - save() the updated Person.",
|
||
"[*] Hint: This may be tricky if in your Schema you declared favoriteFoods as an Array, without specifying the type (i.e. [String]). In that casefavoriteFoods defaults to Mixed type, and you have to manually mark it as edited using document.markModified('edited-field'). (http://mongoosejs.com/docs/schematypes.html - #Mixed )"
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Find-edit-update an item should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/find-edit-save', {name:'Poldo', age: 40, favoriteFoods:['spaghetti']}).then(data => { assert.equal(data.name, 'Poldo', 'item.name is not what expected'); assert.equal(data.age, 40, 'item.age is not what expected'); assert.deepEqual(data.favoriteFoods, ['spaghetti', 'hamburger'], 'item.favoriteFoods is not what expected'); assert.equal(data.__v, 1, 'The item should be previously edited'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb8367417b2b2512c0f",
|
||
"title": "Perform New Updates on a Document Using model.findOneAndUpdate()",
|
||
"description": [
|
||
"Recent versions of mongoose have methods to simplify documents updating. Some more advanced features (i.e. pre/post hooks, validation) behave differently with this approach, so the Classic method is still useful in many situations. findByIdAndUpdate() can be used when searching by Id.",
|
||
"Find a person by Name and set her age to 20. Use the function parameter personName as search key.",
|
||
"Hint: We want you to return the updated document. o do that you need to pass the options document { new: true } as the 3rd argument to findOneAndUpdate(). By default these methods return the unmodified object."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "findOneAndUpdate an item should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/find-one-update', {name:'Dorian Gray', age: 35, favoriteFoods:['unknown']}).then(data => { assert.equal(data.name, 'Dorian Gray', 'item.name is not what expected'); assert.equal(data.age, 20, 'item.age is not what expected'); assert.deepEqual(data.favoriteFoods, ['unknown'], 'item.favoriteFoods is not what expected'); assert.equal(data.__v, 0, 'findOneAndUpdate does not increment version by design !!!'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb8367417b2b2512c10",
|
||
"title": "Delete One Document Using model.findByIdAndRemove",
|
||
"description": [
|
||
"Delete one person by her _id. You should use one of the methods findByIdAndRemove() or findOneAndRemove(). They are like the previous update methods. They pass the removed document to the cb. As usual, use the function argument personId as search key."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Deleting an item should succeed",
|
||
"testString": "getUserInput => $.post(getUserInput('url') + '/_api/remove-one-person', {name:'Jason Bourne', age: 36, favoriteFoods:['apples']}).then(data => { assert.equal(data.name, 'Jason Bourne', 'item.name is not what expected'); assert.equal(data.age, 36, 'item.age is not what expected'); assert.deepEqual(data.favoriteFoods, ['apples'], 'item.favoriteFoods is not what expected'); assert.equal(data.__v, 0); assert.equal(data.count, 0, 'the db items count is not what expected'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb8367417b2b2512c11",
|
||
"title": "Delete Many Documents with model.remove()",
|
||
"description": [
|
||
"Model.remove() is useful to delete all the documents matching given criteria. Delete all the people whose name is “Mary”, using Model.remove(). Pass to it a query ducument with the “name” field set, and of course a callback.",
|
||
"Note: Model.remove() doesn’t return the deleted document, but a JSON object containing the outcome of the operation, and the number of items affected. Don’t forget to pass it to the done() callback, since we use it in tests."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Deleting many items at once should succeed",
|
||
"testString": "getUserInput => $.ajax({url: getUserInput('url') + '/_api/remove-many-people', type: 'POST', contentType:'application/json', data: JSON.stringify([{name: 'Mary', age: 16, favoriteFoods: ['lollipop']}, {name: 'Mary', age: 21, favoriteFoods: ['steak']}])}).then(data => { assert.isTrue(!!data.ok, 'The mongo stats are not what expected'); assert.equal(data.n, 2, 'The number of items affected is not what expected'); assert.equal(data.count, 0, 'the db items count is not what expected'); }, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
},
|
||
{
|
||
"id": "587d7fb9367417b2b2512c12",
|
||
"title": "Chain Search Query Helpers to Narrow Search Results",
|
||
"description": [
|
||
"If you don’t pass the callback as the last argument to Model.find() (or to the other search methods), the query is not executed. You can store the query in a variable for later use. This kind of object enables you to build up a query using chaining syntax. The actual db search is executed when you finally chain the method .exec(). Pass your callback to this last method. There are many query helpers, here we’ll use the most ‘famous’ ones.",
|
||
"Find people who like \"burrito\". Sort them by name, limit the results to two documents, and hide their age. Chain .find(), .sort(), .limit(), .select(), and then .exec(). Pass the done(err, data) callback to exec()."
|
||
],
|
||
"tests": [
|
||
{
|
||
"text": "Chaining query helpers should succeed",
|
||
"testString": "getUserInput => $.ajax({url: getUserInput('url') + '/_api/query-tools', type: 'POST', contentType:'application/json', data: JSON.stringify([{name: 'Pablo', age: 26, favoriteFoods: ['burrito', 'hot-dog']}, {name: 'Ashley', age: 32, favoriteFoods: ['steak', 'burrito']}, {name: 'Mario', age: 51, favoriteFoods: ['burrito', 'prosciutto']} ]) }).then(data => { assert.isArray(data, 'the response should be an Array'); assert.equal(data.length, 2, 'the data array length is not what expected'); assert.notProperty(data[0], 'age', 'The returned first item has too many properties'); assert.equal(data[0].name, 'Ashley', 'The returned first item name is not what expected'); assert.notProperty(data[1], 'age', 'The returned second item has too many properties'); assert.equal(data[1].name, 'Mario', 'The returned second item name is not what expected');}, xhr => { throw new Error(xhr.responseText); })"
|
||
}
|
||
],
|
||
"solutions": [],
|
||
"hints": [],
|
||
"challengeType": 2,
|
||
"translations": {}
|
||
}
|
||
]
|
||
} |