Add MongoDB test application #7

AlexLLKong · 2022-05-04T00:00:39Z

Test application to demonstrate rudimentary CRUD operations on locally hosted node application and node instance.

There isn't much error handling.

nok-ko · 2022-05-04T01:48:37Z

I've included yargs as a dependency for command-line argument parsing, and made the app automatically try to connect to the MongoDB instance at mongodb://localhost:27017, using the database called test. If it fails, it tells you about it:

cli_demo.mp4

nok-ko · 2022-05-04T01:52:37Z

@AlexLLKong I think it's best to only open the connection once, and close it at the end of the app's lifetime – seems like that's the best practice.

I've made that change in the latest commit.

nok-ko · 2022-05-04T02:05:45Z

I've added some npm scripts:

npm start to start the server, using your local MongoDB instance
npm prod to do the same using the instance at db.nokko.me
npm test to run tests – currently none are defined, but I would like to use Jest for this purpose in the future.

nok-ko · 2022-05-04T02:18:07Z

Don't have proper tests yet, but everything works circa the latest commit:

TBD:

Add code that initializes the database with all the collections we need, if they don't exist yet
- (Need schema from Alex)
Make the app log in to the Mongo instance with the shakeguard user+pass
- Store the password secretly somehow – investigate the correct way to do this
Make a common cleanup() function that closes any open file handles/other resources in case the process needs to exit mid-run. Not such a big concern, but would be nice to not corrupt anything when exiting "nicely."
Make the existing Express routes respond with semantic error codes when failing – currently all responses are 200 OK and status is indicated in the response body. 👀

AlexLLKong · 2022-05-04T21:22:44Z

Using Insomnia to test endpoints. Postman was giving me issues and I'm too lazy to use curl.

Next up will be logout followed by signup.

AlexLLKong · 2022-05-04T22:07:04Z

Logout "works" but I wasn't able to work out a test for when it fails. Which probably means I'm not doing it right.

nok-ko

Good stuff! Are the Insomnia tests only on your local machine? Can you make them available to the rest of the team through the repo somehow?

nok-ko · 2022-05-04T22:07:43Z

mongoDbTest.js

@@ -82,6 +84,15 @@ try {


 app.use(express.json());
+app.use(session(
+	{
+	  secret: "shhhh...secret",


Yep, still need to figure out how to keep secrets properly. Hng.

Going to write a proper secret-grabbing thing after #9 is merged.

nok-ko · 2022-05-04T22:09:06Z

mongoDbTest.js

+			res.status(401).send("Invalid email");
+		} else if (results.length > 1) {
+			// Many users with same email
+			// TODO: This is bad and should let someone know


Might be worth keeping a log file for this kind of thing.

mongoDbTest.js

nok-ko

Not sure what error code this should be, not sure when the error case would be hit… not sure of much of anything, but this shouldn't be a 400. Minor quibble, really – don't worry.

mongoDbTest.js

AlexLLKong · 2022-05-04T23:20:34Z

Making a user account works. No sanitization at the moment though

nok-ko · 2022-05-05T00:28:15Z

mongoDbTest.js

+	const date = new Date().toISOString();
+	const achievements = req.body.achievements;
+	const admin = false;
+	const kit = req.body.kit;


Shouldn't the kit be created without any involvement from the code calling into the API?

Is a user able to start building a kit before signing up? If not, then I guess that can be changed to a default skeleton object

What's the expected value for the kit property in a user's document? I think this might just be me being confused, I should take a look at the schema.

nok-ko · 2022-05-05T00:29:42Z

public/js/mongoTestClient.js

+			headers: {
+				'Content-Type' : 'application/json'
+			},
+			body: JSON.stringify({


I guess whether we send the request data in the body or the query parameters doesn't really matter, but I thought we were going to use query parameters. 😅

If you don't want to change it, just say so.

Oh, actually, don't change this! It makes sense for this to be in a body parameter, at least from reading this blog post.

General rule seems to be:

Path parameters for getting a specific thing out of the API

For example: GET /people/katy_p

Query parameters for filtering, or otherwise limiting the output of a query for lots of things

For example: GET /people/katy_p/friends?limit=10&nameLike=Alex

Body parameters for supplying data needed to fulfill a request to the endpoint

For example: POST /create-cat, body: {name:"Fluffy"}

nok-ko · 2022-05-05T02:42:16Z

Once #9 is merged, we should rebase this branch on top of main and make sure everything still works.

nok-ko

Mostly good, take a look at my suggestions though.

mongoDbTest.js

package.json

nok-ko · 2022-05-06T02:44:40Z

AT LAST! Latest commit should super-duper fix #8. @AlexLLKong if you could make up a random session secret on the db.nokko.me server and use my new shakeguardSecrets.js module to load it in, that'd be great. (Secrets are in /home/shakeguard/.secrets if you don't recall.)

Here:

app.use(session(
	{
	  secret: "shhhh...secret", // load it in from the secrets object instead!
	  name: "ShakeGuardSessionID",
	  resave: false,
	  // create a unique identifier for that client
	  saveUninitialized: true
	})
  );

nok-ko

Right, that seems to fix everything I brought up, excellent work. Maybe do a nice thing for our front-end folks and document what all the messages mean somewhere – API.md or something? Maybe there's a better way, or maybe it's a bit early to put effort into that kind of thing, but would be nice. 👍

nok-ko

Whoops.

package.json

…ne place.

Co-authored-by: Katy Petrova <[email protected]>

… to save

…llection

Add MongoDB + Node backend

nok-ko force-pushed the Alex-Mongo-Test branch from 3d456a4 to 2bbb778 Compare May 4, 2022 02:22

nok-ko assigned nok-ko and AlexLLKong May 4, 2022

nok-ko reviewed May 4, 2022

View reviewed changes

nok-ko requested changes May 4, 2022

View reviewed changes

mongoDbTest.js Outdated Show resolved Hide resolved

nok-ko mentioned this pull request May 4, 2022

Keep secrets secret #8

Closed

12 tasks

nok-ko linked an issue May 4, 2022 that may be closed by this pull request

Implement API between Front- and Back-end code #4

Open

11 tasks

nok-ko reviewed May 5, 2022

View reviewed changes

nok-ko mentioned this pull request May 5, 2022

Implement API between Front- and Back-end code #4

Open

11 tasks

AlexLLKong requested a review from nok-ko May 5, 2022 21:18

nok-ko requested changes May 5, 2022

View reviewed changes

AlexLLKong force-pushed the Alex-Mongo-Test branch from 9b3ce93 to adca4bd Compare May 5, 2022 21:58

nok-ko approved these changes May 6, 2022

View reviewed changes

nok-ko reviewed May 6, 2022

View reviewed changes

package.json Show resolved Hide resolved

AlexLLKong and others added 7 commits May 6, 2022 10:51

Add MongoDB test application

9e35417

Rebase onto Jay's frontend code.

2e2afc5

Add command-line arguments, put all the database connection code in o…

67eefa2

…ne place.

Add npm scripts

caf86e7

Fix variable scope issue in connectMongo(…)

171895b

Add login endpoint

d54a4bf

Add logout endpoint

0fedab0

AlexLLKong and others added 11 commits May 6, 2022 10:52

Add signup endpoint

cee90cc

Remove the need for the client to provide a kit to create a user

8bc426d

Change status code for failing to logout

2706466

Co-authored-by: Katy Petrova <[email protected]>

Add Ctrl/Cmd click functionality for test server url

f2409c1

Co-authored-by: Katy Petrova <[email protected]>

Cleanup some responses messages

fd4a7e1

Remove some of the initial testing code such as CRUD examples

99026b1

No longer lying to the client about successful login if session fails…

bd8789b

… to save

Remove Jay's starter application

28c3590

Make npm run prod use secret credentials to login to the DB.

54ffc10

Add preprod secrets-downloading script.

906fa91

Changed default localhost db to 'COMP2800' instead of 'test'

a86e121

nok-ko force-pushed the Alex-Mongo-Test branch from 9386883 to a86e121 Compare May 6, 2022 18:02

AlexLLKong added 3 commits May 6, 2022 13:40

Add json files so that db can be setup on instructor's computer

6f75c1d

Create an unique index for email addresses when initializing users co…

ccb57a4

…llection

Add comment about magic error code from Mongo

0a5c2a3

AlexLLKong marked this pull request as ready for review May 6, 2022 22:02

AlexLLKong merged commit 0044dbc into dev May 6, 2022

nok-ko pushed a commit that referenced this pull request May 20, 2022

Merge pull request #7 from ShakeGuard/Alex-Mongo-Test

d52ab9f

Add MongoDB + Node backend

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MongoDB test application #7

Add MongoDB test application #7

AlexLLKong commented May 4, 2022

nok-ko commented May 4, 2022

nok-ko commented May 4, 2022 •

edited

Loading

nok-ko commented May 4, 2022

nok-ko commented May 4, 2022 •

edited

Loading

AlexLLKong commented May 4, 2022

AlexLLKong commented May 4, 2022

nok-ko left a comment

nok-ko May 4, 2022

nok-ko May 5, 2022

nok-ko May 4, 2022

nok-ko left a comment

AlexLLKong commented May 4, 2022

nok-ko May 5, 2022

AlexLLKong May 5, 2022

nok-ko May 5, 2022

nok-ko May 5, 2022

nok-ko May 5, 2022

nok-ko commented May 5, 2022

nok-ko left a comment

nok-ko commented May 6, 2022 •

edited

Loading

nok-ko left a comment

nok-ko left a comment

Add MongoDB test application #7

Add MongoDB test application #7

Conversation

AlexLLKong commented May 4, 2022

nok-ko commented May 4, 2022

nok-ko commented May 4, 2022 • edited Loading

nok-ko commented May 4, 2022

nok-ko commented May 4, 2022 • edited Loading

TBD:

AlexLLKong commented May 4, 2022

AlexLLKong commented May 4, 2022

nok-ko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nok-ko left a comment

Choose a reason for hiding this comment

AlexLLKong commented May 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nok-ko commented May 5, 2022

nok-ko left a comment

Choose a reason for hiding this comment

nok-ko commented May 6, 2022 • edited Loading

nok-ko left a comment

Choose a reason for hiding this comment

nok-ko left a comment

Choose a reason for hiding this comment

nok-ko commented May 4, 2022 •

edited

Loading

nok-ko commented May 4, 2022 •

edited

Loading

nok-ko commented May 6, 2022 •

edited

Loading