the get image endpoint and cardPut with the image #45

chomosuke · 2021-08-28T17:42:07Z

Turns out a certain member of our team is right again, image turns out to be very easy.

Closes #23 and #30

This suffer from the same problem as #43

Note that this pull request does not address #25 and #26, which I'm hoping for someone else to do.

…llyPro into cardApi

… into cardApi

…kBellyPro into cardRESTfulApi

For: non existent tagId, tagId of a tag that belong to the wrong user, and a request without an email

To test this on postman, you need a dataURL in your image field in the body. To do that, pick an image, go online and find a webside that do image to dataURL conversion

shangzhel

Almost done. Minor changes needed, but remove server/package-lock.json. I suspect it got there because you ran npm install inside server.

shangzhel · 2021-08-29T13:49:54Z

package.json

@@ -23,5 +23,9 @@
    "server",
    "shared",
    "web"
-  ]
+  ],
+  "dependencies": {


The dependencies are already added to server/package.json. They do not need to be here.

shangzhel · 2021-08-29T13:52:00Z

server/jest.config.js

@@ -6,6 +6,7 @@ module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testPathIgnorePatterns: [
-    'src/__tests__/(.*\.)?helpers.[jt]sx?$'
+    'src/__tests__/(.*\.)?helpers.[jt]sx?$',
+    'src/__tests__/api/authenticated/imageUri.ts'


The helpers rule above exists so that test-exclusive helper files do not trigger test failures. Rename imageUri.ts to image.helpers.ts instead.

shangzhel · 2021-08-29T13:56:33Z

server/src/__tests__/api/authenticated/cardPut.ts

+import { HttpStatusError } from '../../../api/HttpStatusError';
+import { imageUri } from './imageUri';
+
+describe('cardPut unit tests', () => {


Describe the tests with its route name: PUT /api/card unit tests

shangzhel · 2021-08-29T14:02:05Z

server/src/__tests__/api/authenticated/image.ts

+import { User } from './auth';
+import { mockRequest } from './helpers';
+
+describe('image unit tests', () => {


Describe the unit tests with its route name: /api/image unit tests

shangzhel · 2021-08-29T14:06:38Z

server/src/api/authenticated/image.ts

+      throw new HttpStatusError(404);
+    }
+    const imageData = cardDoc.image;
+    if (imageData === undefined) {


Use == null to relax the test so that it catches both undefined and null.

shangzhel · 2021-08-29T14:10:06Z

server/src/api/authenticated/cardPut.ts

+        throw new HttpStatusError(400);
+      }
+      try {
+        image = await Jimp.read(Buffer.from(image.substr(dataURIPrefix.length), 'base64'));


Do not reuse the image variable. Store the results of the Jimp buffer in a new variable.

shangzhel · 2021-08-29T14:10:28Z

server/src/api/authenticated/cardPut.ts

+      } catch (e) {
+        throw new HttpStatusError(400);
+      }
+      image = await image.getBufferAsync(Jimp.MIME_JPEG);


Same as above, do not reuse the image variable, store the buffer in a new variable.

shangzhel · 2021-08-29T14:11:45Z

server/src/api/authenticated/cardPut.ts

+          email: cardDoc.email,
+          jobTitle: cardDoc.jobTitle,
+          company: cardDoc.company,
+          hasImage: !!cardDoc.image,


Do not use the double negation pattern to get a boolean. Compare it against null instead: cardDoc.image != null.

…e larger than 100KB

…r/package.json

…rule in jest.config.js

shangzhel · 2021-08-29T15:51:26Z

Revert e5925d1 because requestLimiter is useless

This reverts commit e5925d1, reversing changes made to 70adeed.

shangzhel

Just one unsanitized input usage, fix that and it will be good to go.

server/src/api/authenticated/image.ts

server/src/__tests__/api/authenticated/cardPut.ts

shangzhel · 2021-08-30T15:17:06Z

server/src/api/authenticated/image.ts

+    const { cardId } = params;
+
+    try {
+      Types.ObjectId(cardId);


I meant also saving the ObjectId into a local variable then passing it into findById later.

wait but it essentially does the same thing no?

Mongoose will perform the conversion by itself one more time if the argument type does not match.

shangzhel

Looks good to me.

Shang Zhe Lee and others added 22 commits August 26, 2021 17:15

Merge branch 'master' into HEAD

976f43a

Merge branch 'dbconnection' of github.com:chomosuke/IT-PROJECT-PorkBe…

058c56d

…llyPro into cardApi

Preparing for db pull

e7c052f

Merge branch 'master' of github.com:chomosuke/IT-PROJECT-PorkBellyPro…

b35bffd

… into cardApi

prototyped logics

90d7d32

prototyped test : To change for schema edit and await save

7c21bdd

Add AuthenticatedRouter class.

f31f1bc

preparing to merge login

517e359

Merge branch 'shangzhel/login' of github.com:chomosuke/IT-PROJECT-Por…

9a9992a

…kBellyPro into cardRESTfulApi

resolved merge for now

d40bf35

Merge branch 'richard/docs-to-shared' into cardRESTfulApi

ad90974

cardPut endpoint

3f2f0f6

Merge branch 'master' into cardRESTfulApi

f0f4a9a

written success test for cardPut handler

afd42e4

wrote 3 more failure test for cardPut endpoint

8c95110

For: non existent tagId, tagId of a tag that belong to the wrong user, and a request without an email

cardPut image processing seems good for now

7c739d0

image get endPoint completed

59ac08b

To test this on postman, you need a dataURL in your image field in the body. To do that, pick an image, go online and find a webside that do image to dataURL conversion

wrote cardPut test for images

d8c04de

deleted unused cardInterface.ts

d3f437c

written image endpoint success test

497f99a

written 3 image endpoint fail test

b1fb5f7

shortened test for cardPut

3ef65c4

chomosuke requested review from shangzhel, waltervan00 and pep1032314 August 28, 2021 17:42

chomosuke self-assigned this Aug 28, 2021

chomosuke added this to the Sprint 1 milestone Aug 28, 2021

chomosuke added this to In progress in Sprint 1 via automation Aug 28, 2021

chomosuke added this to Sprint 1 in Product backlog via automation Aug 28, 2021

chomosuke added the enhancement New feature or request label Aug 28, 2021

Merge branch 'issues/46' into richard/image

e5925d1

shangzhel requested changes Aug 29, 2021

View reviewed changes

chomosuke added 2 commits August 30, 2021 00:33

Deleted package-lock.json in server

7728db7

Modified json middleware limit for cardPut endpoint so it allows imag…

f3306bb

…e larger than 100KB

chomosuke requested review from shangzhel and removed request for shangzhel August 29, 2021 14:36

chomosuke added 6 commits August 30, 2021 00:40

removed dependencies from package.json as they already exist in serve…

2a536a7

…r/package.json

renamed imageUri.ts to imageUri.helpers.ts to conform to the helpers …

a958006

…rule in jest.config.js

renamed unit tests name

f400621

check imageData against both null and undefined in image endPoint

7f093ea

stopped reusing image variable in image.ts

ca6baae

compare against null instead of !! in image.ts

41ba15f

chomosuke requested a review from shangzhel August 29, 2021 14:58

Revert "Merge branch 'issues/46' into richard/image"

ddc8bd1

This reverts commit e5925d1, reversing changes made to 70adeed.

chomosuke mentioned this pull request Aug 29, 2021

cardPut endpoint without the image. #43

Closed

shangzhel requested changes Aug 30, 2021

View reviewed changes

server/src/api/authenticated/image.ts Outdated Show resolved Hide resolved

shangzhel reviewed Aug 30, 2021

View reviewed changes

server/src/__tests__/api/authenticated/cardPut.ts Show resolved Hide resolved

image, check for malformed cardId

e95bd0d

shangzhel reviewed Aug 30, 2021

View reviewed changes

chomosuke added 2 commits August 31, 2021 01:19

Merge remote-tracking branch 'origin' into richard/image

0cc3674

only doing ObjectId(cardId) conversion once

ca9d5f1

chomosuke requested a review from shangzhel August 30, 2021 15:24

shangzhel approved these changes Aug 30, 2021

View reviewed changes

fixed failing success test for image.ts

a75fa11

chomosuke merged commit fb33776 into master Aug 30, 2021

Sprint 1 automation moved this from In review to Done Aug 30, 2021

Product backlog automation moved this from Sprint 1 to Sprint 1 Done Aug 30, 2021

chomosuke removed the request for review from pep1032314 August 30, 2021 15:33

chomosuke deleted the richard/image branch August 30, 2021 15:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

the get image endpoint and cardPut with the image #45

the get image endpoint and cardPut with the image #45

chomosuke commented Aug 28, 2021 •

edited by shangzhel

Loading

shangzhel left a comment

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel Aug 29, 2021

shangzhel commented Aug 29, 2021

shangzhel left a comment

shangzhel Aug 30, 2021 •

edited

Loading

chomosuke Aug 30, 2021

shangzhel Aug 30, 2021

shangzhel left a comment

the get image endpoint and cardPut with the image #45

the get image endpoint and cardPut with the image #45

Conversation

chomosuke commented Aug 28, 2021 • edited by shangzhel Loading

shangzhel 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

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

shangzhel commented Aug 29, 2021

shangzhel left a comment

Choose a reason for hiding this comment

shangzhel Aug 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shangzhel left a comment

Choose a reason for hiding this comment

chomosuke commented Aug 28, 2021 •

edited by shangzhel

Loading

shangzhel Aug 30, 2021 •

edited

Loading