Feature/ideation endpoints v2 #20

awlFCCamp · 2023-10-16T18:49:15Z

Description

implemented service layer of the ideation GitHub issue

Issue link

#16
Fixes #16

Type of change for the service layer of ideation

create Ideation
get ProjectIdeas by VoyageTeamId
update Ideation
delete Ideation (only if ideation has no votes)
create Ideation Vote (only one allowed per user per ideation)
delete Ideation Vote

How Has This Been Tested?

I tested using Swagger
SM- Also tested via swagger

Checklist:

[ X] My code follows the style guidelines of this project
[ X] I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
[X ] My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

prisma/schema.prisma

src/ideation/dto/create-ideation-vote.dto.ts

src/ideation/ideation.controller.ts

src/ideation/ideation.service.ts

cherylli · 2023-10-18T01:58:51Z

I also recommend changing the resource to plural form, like ideations as that's what nest does and consistent with the rest of the project

https://docs.nestjs.com/recipes/crud-generator

Dan-Y-Ko

I'd like to see the methods in the controller and service more descriptive. I have no idea what create and update is supposed to refer to. Also use the same name in the controller and service (that is the convention).

Remember that we have to support editing project idea and increasing/decreasing votes. In a way, both could be applied to a method called "update", hence why it's not clear to me.

src/ideation/ideation.controller.ts

fixed updatedAt fix projectIdea field to camel case

yarn add class-validator

validators added

implemented ProjectIdea from schema updated projectIdeaVotes property

adding userId to body when possible

cherylli

all endpoint works but all errors are just the default 500 server error. I'm not sure how much of these error handling are required for this.

Also, should a vote be automatically added when a person contribute to an idea? I mean the person should "like" that idea if they posted it?

voteCount is not needed as mentioned it can be obtained by the length of projectIdeaVotes

"projectIdeaVotes": [
      {
        "id": 2,
        "voyageTeamMemberId": 5,
        "projectIdeaId": 16,
        "createdAt": "2023-10-24T13:47:44.394Z",
        "updatedAt": "2023-10-24T13:47:44.394Z",
        "votedBy": {
          "id": 5,
          "userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
          "voyageTeamId": 3,
          "voyageRoleId": 7,
          "statusId": 4,
          "hrPerSprint": 15,
          "createdAt": "2023-10-24T13:30:54.444Z",
          "updatedAt": "2023-10-24T13:30:54.444Z",
          "member": {
            "id": "dd532498-16f7-4d32-b054-e0ed5518cb11",
            "avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
            "firstName": "Larry",
            "lastName": "Castro"
          }
        }
      }

Dan-Y-Ko · 2023-10-24T21:35:57Z

Idk how to group multiple things and leave a comment on them so I'll just comment here. Generally speaking, you should denote any methods that are not called by the controller as private methods. Not only for all the reasons why you'd want private methods, but it also helps us see easily which are just "utility" methods in the service.
These are just things I saw from glancing at the code. I'll test the endpoints tomorrow.

Does Nestjs have a way of denoting private methods or are you looking for grouping with a note? It's late but I'm not finding a private method yet from researching like what Java has :/

use private keyword https://www.typescriptlang.org/docs/handbook/2/classes.html#private Also I saw you wrote comment to denote them but that's not necessary. It's common convention to put private methods either at the top of the file or at the bottom. I have no preference to either.

Dan-Y-Ko · 2023-10-24T21:38:23Z

all endpoint works but all errors are just the default 500 server error. I'm not sure how much of these error handling are required for this.

Also, should a vote be automatically added when a person contribute to an idea? I mean the person should "like" that idea if they posted it?

voteCount is not needed as mentioned it can be obtained by the length of projectIdeaVotes
"projectIdeaVotes": [
      {
        "id": 2,
        "voyageTeamMemberId": 5,
        "projectIdeaId": 16,
        "createdAt": "2023-10-24T13:47:44.394Z",
        "updatedAt": "2023-10-24T13:47:44.394Z",
        "votedBy": {
          "id": 5,
          "userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
          "voyageTeamId": 3,
          "voyageRoleId": 7,
          "statusId": 4,
          "hrPerSprint": 15,
          "createdAt": "2023-10-24T13:30:54.444Z",
          "updatedAt": "2023-10-24T13:30:54.444Z",
          "member": {
            "id": "dd532498-16f7-4d32-b054-e0ed5518cb11",
            "avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
            "firstName": "Larry",
            "lastName": "Castro"
          }
        }
      }

Good point. I think we should be consistent and just add a vote for themself for everything in this project.

Editing this as I thought about it, let's worry about error handling for this pr specifically later as it's very high priority to get this merged.

smurph7894 · 2023-10-24T22:02:04Z

sorry pressed the wrong button

cherylli · 2023-10-25T00:21:29Z

"projectIdeaVotes": [
      {
        "id": 2,
        "voyageTeamMemberId": 5,
        "projectIdeaId": 16,
        "createdAt": "2023-10-24T13:47:44.394Z",
        "updatedAt": "2023-10-24T13:47:44.394Z",
        "votedBy": {
          "id": 5,
          "userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
          "voyageTeamId": 3,
          "voyageRoleId": 7,
          "statusId": 4,
          "hrPerSprint": 15,
          "createdAt": "2023-10-24T13:30:54.444Z",
          "updatedAt": "2023-10-24T13:30:54.444Z",
          "member": {
            "id": "dd532498-16f7-4d32-b054-e0ed5518cb11",
            "avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
            "firstName": "Larry",
            "lastName": "Castro"
          }
        }
      }

sorry posted this but forgot to say anything about it, for this endpoint, I believe all these are not needed

"id": 5,
"userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
"voyageTeamId": 3,
"voyageRoleId": 7,
"statusId": 4,
"hrPerSprint": 15,
"createdAt": "2023-10-24T13:30:54.444Z",
"updatedAt": "2023-10-24T13:30:54.444Z",

private added to helper methods create ideation also adds creators vote delete ideation also removed creators vote

Dan-Y-Ko · 2023-10-25T01:11:33Z

"projectIdeaVotes": [
      {
        "id": 2,
        "voyageTeamMemberId": 5,
        "projectIdeaId": 16,
        "createdAt": "2023-10-24T13:47:44.394Z",
        "updatedAt": "2023-10-24T13:47:44.394Z",
        "votedBy": {
          "id": 5,
          "userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
          "voyageTeamId": 3,
          "voyageRoleId": 7,
          "statusId": 4,
          "hrPerSprint": 15,
          "createdAt": "2023-10-24T13:30:54.444Z",
          "updatedAt": "2023-10-24T13:30:54.444Z",
          "member": {
            "id": "dd532498-16f7-4d32-b054-e0ed5518cb11",
            "avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
            "firstName": "Larry",
            "lastName": "Castro"
          }
        }
      }

sorry posted this but forgot to say anything about it, for this endpoint, I believe all these are not needed

"id": 5,
"userId": "dd532498-16f7-4d32-b054-e0ed5518cb11",
"voyageTeamId": 3,
"voyageRoleId": 7,
"statusId": 4,
"hrPerSprint": 15,
"createdAt": "2023-10-24T13:30:54.444Z",
"updatedAt": "2023-10-24T13:30:54.444Z",

Which endpoint is this for?

cherylli · 2023-10-25T01:24:50Z

Which endpoint is this for?

return votes I think, should only need first name, last name and avatar, maybe id

prisma/schema.prisma

smurph7894 · 2023-10-25T01:54:18Z

Which endpoint is this for?

return votes I think, should only need first name, last name and avatar, maybe id

The only endpoint that returns all that information is getIdeationsByVoyageTeam. I've removed the votedBy info from the response section ( info from the voyageTeamMember table). This is the updated current return:
[
{
"id": 1,
"title": "Write a poem",
"description": "A poem is a form of writing that tries to stimulate an emotional response or imaginative awareness within the reader. Many poems have a rhyming structure or follow an established format.",
"vision": "If you've never written poetry before, start by reading other writers' poems.",
"createdAt": "2023-10-24T09:05:20.506Z",
"contributedBy": {
"member": {
"id": "688fd40d-569b-4e5f-bf38-b81bfd67d95d",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=wavatar&r=x",
"firstName": "Joso",
"lastName": "Mađar"
}
},
"projectIdeaVotes": []
},
{
"id": 15,
"title": "newProjectIdea3",
"description": "test",
"vision": "test",
"createdAt": "2023-10-24T23:08:08.790Z",
"contributedBy": {
"member": {
"id": "5978bce0-51be-42e5-8aa8-04f0495b96ae",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
"firstName": "Larry",
"lastName": "Castro"
}
},
"projectIdeaVotes": [
{
"id": 7,
"voyageTeamMemberId": 2,
"projectIdeaId": 15,
"createdAt": "2023-10-24T23:08:08.800Z",
"updatedAt": "2023-10-24T23:08:08.800Z",
"votedBy": {
"member": {
"id": "5978bce0-51be-42e5-8aa8-04f0495b96ae",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
"firstName": "Larry",
"lastName": "Castro"
}
}
}
]
},
{
"id": 7,
"title": "Temperature Converter Website",
"description": "Developing a website that converts temperature recorded in one unit to another can be an excellent place for web developers to move forward in their web development journey.",
"vision": "The measuring units of the temperature recorded in a particular unit can be converted with a temperature converter, necessitating you to build a dropdown menu with temperature scales. You can also more functionality to the website by providing some other converters.",
"createdAt": "2023-10-24T09:05:20.532Z",
"contributedBy": {
"member": {
"id": "ac4107a2-b0fc-4f7f-84bb-3eaf5348ad70",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=robohash&r=x",
"firstName": "Jessica",
"lastName": "Williamson"
}
},
"projectIdeaVotes": []
},
{
"id": 19,
"title": "Test Idea",
"description": "test",
"vision": "test",
"createdAt": "2023-10-25T01:49:08.425Z",
"contributedBy": {
"member": {
"id": "ac4107a2-b0fc-4f7f-84bb-3eaf5348ad70",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=robohash&r=x",
"firstName": "Jessica",
"lastName": "Williamson"
}
},
"projectIdeaVotes": [
{
"id": 11,
"voyageTeamMemberId": 3,
"projectIdeaId": 19,
"createdAt": "2023-10-25T01:49:08.443Z",
"updatedAt": "2023-10-25T01:49:08.443Z",
"votedBy": {
"member": {
"id": "ac4107a2-b0fc-4f7f-84bb-3eaf5348ad70",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=robohash&r=x",
"firstName": "Jessica",
"lastName": "Williamson"
}
}
},
{
"id": 12,
"voyageTeamMemberId": 2,
"projectIdeaId": 19,
"createdAt": "2023-10-25T01:49:58.168Z",
"updatedAt": "2023-10-25T01:49:58.168Z",
"votedBy": {
"member": {
"id": "5978bce0-51be-42e5-8aa8-04f0495b96ae",
"avatar": "https://gravatar.com/avatar/3bfaef00e02a22f99e17c66e7a9fdd31?s=400&d=monsterid&r=x",
"firstName": "Larry",
"lastName": "Castro"
}
}
}
]
}
]

I removed a few objects so it wasn't as long as it was so some { may be off.

remove voyageTeamMember information from Get query results

making description and vision required per Figma

cherylli

looks good, more error handling can be added later

Dan-Y-Ko · 2023-10-25T05:07:15Z

/api/v1/teams/{teamId}/ideation-vote should have the project idea id in the paramter and not the body.
both delete endpoints should have user id moved to body.

Other than that, this looks good to merge. Great job on this Sarah :)

removed projectIdeaId requirement from create ideationVote added dto to deleteIdeation and deleteIdeationVote to move userId to body from parameter

updating for userId to be in body and add Dto files verify ids are uniform

update createIdeationVote endpoint parameters remove userId from endpoint and add to body for deleteIdeation and deleteIdeationVote

smurph7894 · 2023-10-25T07:00:32Z

Both delete endpoints use a body for userId and ideation vote endpoint has ideationId moved to a parameter.

jenny-alexander

LGTM - great job taking in all comments and incorporating them into your code.
I tested endpoints locally.
Endpoints should be plural - we will take care of that in another task

Angela Lee added 5 commits October 16, 2023 11:13

findAll update

a091d66

delete

db5318a

createNew

4730ab0

uncomment controller

72f675b

hardcode userid in create

ad31e9b

awlFCCamp requested a review from Dan-Y-Ko October 16, 2023 18:49

awlFCCamp closed this Oct 16, 2023

jenny-alexander requested review from jenny-alexander and removed request for Dan-Y-Ko October 17, 2023 04:05

Angela Lee added 2 commits October 17, 2023 08:57

update schema as discussion

61933c6

migration

b656a7e

jenny-alexander reopened this Oct 17, 2023

Angela Lee added 2 commits October 17, 2023 10:54

changing endpoints in controller

0573526

updated endpoints in controller as the trello card specs

34d3a90

cherylli reviewed Oct 18, 2023

View reviewed changes

Dan-Y-Ko self-requested a review October 18, 2023 22:49

Dan-Y-Ko reviewed Oct 18, 2023

View reviewed changes

src/ideation/ideation.controller.ts Outdated Show resolved Hide resolved

smurph7894 added 4 commits October 18, 2023 19:37

update Ideation folder to follow naming standards

807d9fe

remove duplicate info

66454e1

create entity class

44a5213

updating Ideation schema tables

392a265

fixed updatedAt fix projectIdea field to camel case

smurph7894 changed the title ~~Feature/ideation endpoints v2~~ Draft: Feature/ideation endpoints v2 Oct 20, 2023

smurph7894 changed the title ~~Draft: Feature/ideation endpoints v2~~ Feature/ideation endpoints v2 Oct 20, 2023

smurph7894 marked this pull request as draft October 20, 2023 01:18

smurph7894 added 5 commits October 20, 2023 13:56

class validator package added

ba45981

yarn add class-validator

dto files updated

8fad7ec

validators added

remove ternary on projectIdeaId

f78a8b6

updating entity

852a8f7

implemented ProjectIdea from schema updated projectIdeaVotes property

Update ideations.service.ts

084f0b3

smurph7894 added 2 commits October 24, 2023 01:40

updating userId to body

7159233

adding userId to body when possible

Update ideations.service.ts

55e7d02

cherylli reviewed Oct 24, 2023

View reviewed changes

smurph7894 closed this Oct 24, 2023

smurph7894 reopened this Oct 24, 2023

remove vote count from Ideations Get Controller

caf4a5c

Update ideations.service.ts

46fa747

private added to helper methods create ideation also adds creators vote delete ideation also removed creators vote

cherylli reviewed Oct 25, 2023

View reviewed changes

prisma/schema.prisma Outdated Show resolved Hide resolved

smurph7894 added 3 commits October 24, 2023 18:59

update getIdeationsByTeam endpoint query results

38a22ba

remove voyageTeamMember information from Get query results

change ProjectIdeaVote onDelete to cascade

74c5102

Update create-ideation.dto.ts

75e120d

making description and vision required per Figma

cherylli previously approved these changes Oct 25, 2023

View reviewed changes

smurph7894 added 3 commits October 24, 2023 23:36

updated delete and createVote dto files

b171768

removed projectIdeaId requirement from create ideationVote added dto to deleteIdeation and deleteIdeationVote to move userId to body from parameter

Update ideations.service.ts

88903f1

updating for userId to be in body and add Dto files verify ids are uniform

Update ideations.controller.ts

c9fb932

update createIdeationVote endpoint parameters remove userId from endpoint and add to body for deleteIdeation and deleteIdeationVote

smurph7894 dismissed cherylli’s stale review via c9fb932 October 25, 2023 06:54

awlFCCamp assigned smurph7894 Oct 25, 2023

Dan-Y-Ko approved these changes Oct 25, 2023

View reviewed changes

jenny-alexander approved these changes Oct 25, 2023

View reviewed changes

Dan-Y-Ko merged commit f143101 into dev Oct 25, 2023
1 check passed

Dan-Y-Ko deleted the feature/ideation-endpoints-v2 branch October 25, 2023 16:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/ideation endpoints v2 #20

Feature/ideation endpoints v2 #20

awlFCCamp commented Oct 16, 2023 •

edited by curtwl

Loading

cherylli commented Oct 18, 2023

Dan-Y-Ko left a comment •

edited

Loading

cherylli left a comment

Dan-Y-Ko commented Oct 24, 2023 •

edited

Loading

Dan-Y-Ko commented Oct 24, 2023 •

edited

Loading

smurph7894 commented Oct 24, 2023

cherylli commented Oct 25, 2023

Dan-Y-Ko commented Oct 25, 2023

cherylli commented Oct 25, 2023

smurph7894 commented Oct 25, 2023 •

edited

Loading

cherylli left a comment

Dan-Y-Ko commented Oct 25, 2023

smurph7894 commented Oct 25, 2023

jenny-alexander left a comment

Feature/ideation endpoints v2 #20

Feature/ideation endpoints v2 #20

Conversation

awlFCCamp commented Oct 16, 2023 • edited by curtwl Loading

Description

Issue link

Type of change for the service layer of ideation

How Has This Been Tested?

Checklist:

cherylli commented Oct 18, 2023

Dan-Y-Ko left a comment • edited Loading

Choose a reason for hiding this comment

cherylli left a comment

Choose a reason for hiding this comment

Dan-Y-Ko commented Oct 24, 2023 • edited Loading

Dan-Y-Ko commented Oct 24, 2023 • edited Loading

smurph7894 commented Oct 24, 2023

cherylli commented Oct 25, 2023

Dan-Y-Ko commented Oct 25, 2023

cherylli commented Oct 25, 2023

smurph7894 commented Oct 25, 2023 • edited Loading

cherylli left a comment

Choose a reason for hiding this comment

Dan-Y-Ko commented Oct 25, 2023

smurph7894 commented Oct 25, 2023

jenny-alexander left a comment

Choose a reason for hiding this comment

awlFCCamp commented Oct 16, 2023 •

edited by curtwl

Loading

Dan-Y-Ko left a comment •

edited

Loading

Dan-Y-Ko commented Oct 24, 2023 •

edited

Loading

Dan-Y-Ko commented Oct 24, 2023 •

edited

Loading

smurph7894 commented Oct 25, 2023 •

edited

Loading