#167750066 Users should be able to comment on Travel requests

[oyewoas]

What does this PR do?
This PR implements Travel request comments features

Description of tasks to be completed?

• setup controller for user to comment on requests
• setup route for user to comment on requests
• setup unit test for user to comment on requests route

How should this be manually tested/checked?

1. In your terminal, run git clone https://github.com/andela/wolfsbane-backend.git
2. Run cd wolfsbane-backend
3. Run git fetch origin ft-create-accommodation-facilities-167750066
4. Run git checkout origin/ft-create-accommodation-facilities-167750066
5. Run npm install
6. Run npm run pre-test to run migrations and seed the database
7. Run npm test
8. To test using postman run npm run migrate and npm run seed to migrate and seed the database
9. Run npm run start:dev to start the development server
10. Open Postman and send a POST request to http://localhost:3000/api/v1/users/signin using the following details as a JSON object:

{
    "email" : "[email protected]",
    "password" : "funmi1234"
}

11. Copy the token property in the response object
12. Click the Authorization tab and in the Type dropdown, choose Bearer Token, then paste the token you copied into the token input field.
13. Go to src/database/seeders/create-6-request.js then copy any of the id values
14. To add a comment send a POST request to http://localhost:3000/api/v1/requests/:requestId/comments , replace :requestId with the id copied in 13 above:
    Sample request:

 {
	"comment": "i need to comment"
 }

Sample response:

 {
    "status": 200,
    "message": "Comment added successfully",
    "data": {
        "id": "e94c1c79-88b0-475c-909e-6868f0793446",
        "comment": "i need to comment",
        "userId": "e71c28fd-73d8-4d92-9125-ab3d022093b9",
        "requestId": "2b770fbc-76e6-4b5a-afab-882759fd1f06",
        "updatedAt": "2019-09-11T17:45:24.699Z",
        "createdAt": "2019-09-11T17:45:24.699Z"
    }
}

15. To get all comments on a request send a GET request to http://localhost:3000/api/v1/requests/:requestId/comments , replace :requestId with the id copied in 13 above:
    Sample response:

 {
    "status": 200,
    "message": "Comment retrieved successfully",
    "data": {
        "id": "2b770fbc-76e6-4b5a-afab-882759fd1f06",
        "comment": "i need to comment",
        "userId": "e71c28fd-73d8-4d92-9125-ab3d022093b9",
        "requestId": "2b770fbc-76e6-4b5a-afab-882759fd1f06",
        "updatedAt": "2019-09-11T17:45:24.699Z",
        "createdAt": "2019-09-11T17:45:24.699Z"
        "theUser": {
                "id": "e71c28fd-73d8-4d92-9125-ab3d022093b9",
                "firstName": "",
                "lastName": "",
                "email": "[email protected]"
            }
    }
}

16. To get a single comment send a GET request to http://localhost:3000/api/v1/comments/:commentId, replace :commentId with the id of one of the returned comment in 15 above:
    Sample response:

 {
    "status": 200,
    "message": "Comment retrieved successfully",
    "data": {
        "id": "2b770fbc-76e6-4b5a-afab-882759fd1f06",
        "comment": "i need to comment",
        "userId": "e71c28fd-73d8-4d92-9125-ab3d022093b9",
        "requestId": "2b770fbc-76e6-4b5a-afab-882759fd1f06",
        "updatedAt": "2019-09-11T17:45:24.699Z",
        "createdAt": "2019-09-11T17:45:24.699Z"
        "theUser": {
                "id": "e71c28fd-73d8-4d92-9125-ab3d022093b9",
                "firstName": "",
                "lastName": "",
                "email": "[email protected]"
            }
    }
}

17. To update a single comment send a PUT request to http://localhost:3000/api/v1/comments/:commentId, replace :commentId with the id of one of the returned comment in 15 above:
    Sample response:

 {
    "status": 200,
    "message": "Comment updated successfully",
}

18. To delete a single comment send a DELETE request to http://localhost:3000/api/v1/comments/:commentId, replace :commentId with the id of one of the returned comment in 15 above:
    Sample response:

 {
    "status": 200,
    "message": "Comment deleted successfully",
}

Any background context you want to provide?
Make sure you drop your database tables, then run migrations and seeds again, both for test and development environments

What are the relevant pivotal tracker stories?
#167750066

[darasimiolaifa]

Hi @oyewoas. Nice work so far. But I'd like to suggest, can we take advantage of the model relationships to fetch more details? For example, here, can we also get the user details and also the request details related to the comment?

Please check using include in Sequelize queries.

[oyewoas]

why do you think we need extra details apart from the comment @darasimiolaifa

[darasimiolaifa]

Say for instance, currently, what you're going to send to the frontend is the userId of the person who made the comment. But the frontend needs more than that. It needs the firstName, and lastname of the person, because that is what will be displayed. So, rather than send the userId, and then discover later that you still need to make another round trip to the database to fetch the user details, you can do it in one full query sweep by using include.

[darasimiolaifa]

You forgot to 'un-comment' these lines before pushing. Merge conflicts lurking.

[feobaby]

Very good job @oyewoas

• if i update, I should be able to get a response of the update, i only got a message.
• I tried to do some security checks and I realized that anybody could get all comments/single comment, update or delete. It would be better it if its only the user that created the comment to be able to update/delete/get