feat: add questions API with tests by satyam73 · Pull Request #1711 · RealDevSquad/website-backend

satyam73 · 2023-11-22T18:17:26Z

Date: 25-12-2023

Developer Name: Satyam Bajpai

Issue Ticket Number:-

[Live-Site] Create API for questions and answers #1805

Description:

This PR contains questions API which will be needed for word cloud feature. The get request is server sent event API that's why you wil see the code little different from normal API.

Usage

This API will be used in live-site question answers where host can ask question to connected peers in realtime and connected peers and answer the question in realtime and the approved responses will be used to form word cloud in realtime in every clients screen.

Sequence diagram - https://lucid.app/lucidspark/02e146bd-6d0f-4d4e-a425-f811c9289e49/edit?viewport_loc=-5030%2C-192%2C3515%2C2201%2C0_0&invitationId=inv_4a2f8f42-57df-473f-86a1-caea4c57d619
API contracts - RealDevSquad/website-api-contracts#166
The test for SSE API is not written in this PR I will handle this in the ticket mentioned below,

[Live-Site] Figure out tests for SSE APIs #1811

Is Under Feature Flag

Yes
No

Database changes

Yes
No

Breaking changes (If your feature is breaking/missing something please mention pending tickets)

Yes
No

Is Development Tested?

Yes
No

Tested in staging?

Yes
No

Add relevant Screenshot below ( e.g test coverage etc. )

questions models test coverage

questions controllers test

Get API /questions initial null data response

Post API /questions without max_characters

Post API /questions with max_characters

Question pushed when post request /questions done

Note: Feature flag is added on frontend and this API is newly created so that's why haven't added on backend.

routes/questions.js

…ackend into feat/questions-answers-api

routes/questions.ts

+
+router.post(
+  "/",
+  authenticate,


…ackend into feat/questions-answers-api

constants/constants.ts

test/unit/models/questions.test.ts

Ajeyakrishna-k · 2023-12-27T10:02:42Z

Can you please add a description regarding how these APIs are going to be used?
Could you provide a sequence diagram, or a link to a design doc?

satyam73 · 2023-12-28T07:40:59Z

Can you please add a description regarding how these APIs are going to be used?

Could you provide a sequence diagram, or a link to a design doc?

Updated the description

sahsisunny · 2023-12-28T12:12:11Z

Can you mention the PR for data models and api contracts?

controllers/questions.ts

models/questions.ts

Approve by mistake

sahsisunny · 2023-12-28T12:19:28Z

All Typescript codes are written in strict mode?

test/integration/questions.test.ts

satyam73 · 2023-12-28T13:16:17Z

ll Typescript codes are written in strict mode?

didn't get this one

…ackend into feat/questions-answers-api

…Dev-Squad/website-backend into feat/questions-answers-api

Ajeyakrishna-k

Can you please help me understand how will this work for the following cases:

When there are more than one event happening simultaneously.
If we have deployed more than one instances of our server.

controllers/questions.ts

satyam73 · 2023-12-30T08:44:10Z

Can you please help me understand how will this work for the following cases:

When there are more than one event happening simultaneously.

If we have deployed more than one instances of our server.

Currently as per requirements there will be only event that will happen at a time so it's build like that.

Ajeyakrishna-k · 2024-01-01T09:46:21Z

Can you please help me understand how will this work for the following cases:

When there are more than one event happening simultaneously.

If we have deployed more than one instances of our server.

Currently as per requirements there will be only event that will happen at a time so it's build like that.

Can you add a comments with link to detailed ticket explaining these limitations

satyam73 · 2024-01-02T12:42:20Z

Can you please help me understand how will this work for the following cases:

When there are more than one event happening simultaneously.

If we have deployed more than one instances of our server.

Currently as per requirements there will be only event that will happen at a time so it's build like that.

Can you add a comments with link to detailed ticket explaining these limitations

Created a wiki page for the overall feature and added the limitations in it here - https://github.com/Real-Dev-Squad/website-www/wiki/%5BFeature%5D-%E2%80%90-Realtime-Word-Cloud-Questions-Answers-Feature

Ajeyakrishna-k · 2024-01-02T14:27:23Z

Can you please help me understand how will this work for the following cases:

When there are more than one event happening simultaneously.

If we have deployed more than one instances of our server.

Currently as per requirements there will be only event that will happen at a time so it's build like that.

Can you add a comments with link to detailed ticket explaining these limitations

Created a wiki page for the overall feature and added the limitations in it here - https://github.com/Real-Dev-Squad/website-www/wiki/%5BFeature%5D-%E2%80%90-Realtime-Word-Cloud-Questions-Answers-Feature

Please add this link in comments on clients array and questions api routes.

feat: add post api of questions with tests

511bc7f

github-advanced-security bot found potential problems Nov 22, 2023

View reviewed changes

routes/questions.js Fixed Show fixed Hide fixed

satyam73 added 5 commits November 25, 2023 14:30

feat: add get api of questions with unit tests

29669e8

tests: fix createQuestion return message

7961c67

chore: remove unnecessary code part

bb88952

Merge branch 'develop' of https://github.com/Real-Dev-Squad/website-b…

8952181

…ackend into feat/questions-answers-api

chore: changed questions route file from js to ts

db2e2ef

github-advanced-security bot found potential problems Dec 22, 2023

View reviewed changes

satyam73 added 8 commits December 22, 2023 14:49

feat: define types for questions

f361348

chore: add types in questions controller file

a2c6977

chore: add types in questions models file

8556d82

chore: change question middleware from js to ts

83eabcd

chore: change questions tests from js to ts

9be7c27

Merge branch 'develop' into feat/questions-answers-api

5076f32

chore: remove only in tests

d9888d9

Merge branch 'develop' of https://github.com/Real-Dev-Squad/website-b…

c8813d8

…ackend into feat/questions-answers-api

satyam73 marked this pull request as ready for review December 25, 2023 08:56

satyam73 changed the title ~~feat: add post api of questions with tests~~ feat: add questions API with tests Dec 25, 2023

satyam73 requested review from Ajeyakrishna-k and sahsisunny December 25, 2023 15:18

Merge branch 'develop' into feat/questions-answers-api

a5ddff8

ajoykumardas12 reviewed Dec 26, 2023

View reviewed changes

constants/constants.ts Show resolved Hide resolved

test/unit/models/questions.test.ts Outdated Show resolved Hide resolved

satyam73 added 3 commits December 27, 2023 12:22

chore: add comment for sse headers constant

9feb2ea

refactor: remove unnecessary import statement

a0995da

Merge branch 'develop' into feat/questions-answers-api

aeed60d

ajoykumardas12 previously approved these changes Dec 27, 2023

View reviewed changes

sahsisunny reviewed Dec 28, 2023

View reviewed changes

controllers/questions.ts Show resolved Hide resolved

sahsisunny previously approved these changes Dec 28, 2023

View reviewed changes

models/questions.ts Outdated Show resolved Hide resolved

sahsisunny reviewed Dec 28, 2023

View reviewed changes

test/integration/questions.test.ts Show resolved Hide resolved

satyam73 dismissed ajoykumardas12’s stale review via f3faefc December 28, 2023 12:46

chore: remove unnecessary comment

f3faefc

sahsisunny previously approved these changes Dec 29, 2023

View reviewed changes

satyam73 added 3 commits December 29, 2023 18:01

Merge branch 'develop' of https://github.com/Real-Dev-Squad/website-b…

0276f27

…ackend into feat/questions-answers-api

chore: add questions to routes

4e1c736

Merge branch 'feat/questions-answers-api' of https://github.com/Real-…

b625648

…Dev-Squad/website-backend into feat/questions-answers-api

satyam73 dismissed sahsisunny’s stale review via b625648 December 29, 2023 12:52

Ajeyakrishna-k suggested changes Dec 29, 2023

View reviewed changes

controllers/questions.ts Outdated Show resolved Hide resolved

satyam73 added 2 commits December 30, 2023 14:27

chore: add type to clients array

5bae105

Merge branch 'develop' into feat/questions-answers-api

f49c19d

Merge branch 'develop' into feat/questions-answers-api

d0d206d

chore: add comment for questions clients array

145987b

Ajeyakrishna-k approved these changes Jan 3, 2024

View reviewed changes

sahsisunny approved these changes Jan 3, 2024

View reviewed changes

ajoykumardas12 approved these changes Jan 3, 2024

View reviewed changes

Merge branch 'develop' into feat/questions-answers-api

ee13a62

iamitprakash merged commit b7ea59d into develop Jan 4, 2024

iamitprakash deleted the feat/questions-answers-api branch January 4, 2024 07:46

satyam73 self-assigned this Jan 5, 2024

Conversation

satyam73 commented Nov 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Ticket Number:-

Description:

Usage

Add relevant Screenshot below ( e.g test coverage etc. )

Uh oh!

Uh oh!

Check failure

Uh oh!

Uh oh!

Ajeyakrishna-k commented Dec 27, 2023

Uh oh!

satyam73 commented Dec 28, 2023

Uh oh!

sahsisunny commented Dec 28, 2023

Uh oh!

Uh oh!

Uh oh!

sahsisunny commented Dec 28, 2023

Uh oh!

Uh oh!

satyam73 commented Dec 28, 2023

Uh oh!

Ajeyakrishna-k left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

satyam73 commented Dec 30, 2023

Uh oh!

Ajeyakrishna-k commented Jan 1, 2024

Uh oh!

satyam73 commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ajeyakrishna-k commented Jan 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

satyam73 commented Nov 22, 2023 •

edited

Loading

satyam73 commented Jan 2, 2024 •

edited

Loading