[Backend] Implement Feature: Pin Notes #546

mrfamouskk7 · 2022-10-06T07:50:07Z

Summary

Pin notes so that they will be added to priority spot, at the top for easy access, similar to Google Keep. Closes: #541

Description for the changelog

API Endpoint:

PUT /note/<NOTE_ID>/pin
Content-Type: application/json
Authorization: Bearer <TOKEN>

{
  "isPinned": true
}

Response

When note gets pinned/unpinned successfully
Response Code: 200

{
  "status": "SUCCESS",
  "message": "Note is pinned/unpinned successfully",
  "noteId": <NOTE ID>
}

When note note exist in system
Response Code: 404

{
  "status": "NOT_FOUND",
  "message": "Note not exist with ID '$noteId'"
}

When unauthorized user tries to update note pin
Response Code: 401

{
  "status": "UNAUTHORIZED",
  "message": "Access denied"
}

A picture or screenshot regarding change

NotyKT.1.mp4

Checklist

Build and linting is passing.
This change is not breaking existing flow of a system.
I have written test case for this change.
This change is tested from all aspects.
Implemented any new third-party library (Which not existed before this change).

Bumps `exposedVersion` from 0.39.2 to 0.40.1. Updates `exposed-core` from 0.39.2 to 0.40.1 - [Release notes](https://github.com/JetBrains/Exposed/releases) - [Changelog](https://github.com/JetBrains/Exposed/blob/master/docs/ChangeLog.md) - [Commits](JetBrains/Exposed@0.39.2...0.40.1) Updates `exposed-dao` from 0.39.2 to 0.40.1 - [Release notes](https://github.com/JetBrains/Exposed/releases) - [Changelog](https://github.com/JetBrains/Exposed/blob/master/docs/ChangeLog.md) - [Commits](JetBrains/Exposed@0.39.2...0.40.1) Updates `exposed-jdbc` from 0.39.2 to 0.40.1 - [Release notes](https://github.com/JetBrains/Exposed/releases) - [Changelog](https://github.com/JetBrains/Exposed/blob/master/docs/ChangeLog.md) - [Commits](JetBrains/Exposed@0.39.2...0.40.1) Updates `exposed-jodatime` from 0.39.2 to 0.40.1 - [Release notes](https://github.com/JetBrains/Exposed/releases) - [Changelog](https://github.com/JetBrains/Exposed/blob/master/docs/ChangeLog.md) - [Commits](JetBrains/Exposed@0.39.2...0.40.1) --- updated-dependencies: - dependency-name: org.jetbrains.exposed:exposed-core dependency-type: direct:production update-type: version-update:semver-minor - dependency-name: org.jetbrains.exposed:exposed-dao dependency-type: direct:production update-type: version-update:semver-minor - dependency-name: org.jetbrains.exposed:exposed-jdbc dependency-type: direct:production update-type: version-update:semver-minor - dependency-name: org.jetbrains.exposed:exposed-jodatime dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

…le/noty-api/exposedVersion-0.40.1 [API]: Bump exposedVersion from 0.39.2 to 0.40.1 in /noty-api

PatilShreyas · 2022-10-06T14:27:19Z

Thanks, @mrfamouskk7 for raising this PR. Will review it shortly. Thanks for adding sample screenshots as well. It becomes really easy to review the API surface as well. Good work 👍🏻.

mrfamouskk7 · 2022-10-06T14:34:14Z

Thanks, @mrfamouskk7 for raising this PR. Will review it shortly. Thanks for adding sample screenshots as well. It becomes really easy to review the API surface as well. Good work 👍🏻.

Thanks @PatilShreyas 😄

PatilShreyas

Did the first round of review and the change look pretty neat and clean 😃.
Just here are a few comments

PatilShreyas · 2022-10-06T14:32:52Z

noty-api/application/src/dev/shreyaspatil/noty/api/controller/NotesController.kt

@@ -97,6 +98,21 @@ class NotesController @Inject constructor(private val noteDao: NoteDao) {
        }
    }

+    fun pinNote(user: User, noteId: String, pinRequest: PinRequest): NoteResponse {


@mrfamouskk7 Can we rename it to updateNotePin()? Because pinNote sounds like we are only pinning it and not un-pinning.

Yeah, makes sense... renamed it as per suggestion.

PatilShreyas · 2022-10-06T14:33:26Z

noty-api/application/src/dev/shreyaspatil/noty/api/controller/NotesController.kt

+        return try {
+            checkNoteExistsOrThrowException(noteId)
+            checkOwnerOrThrowException(user.id, noteId)
+            val id = noteDao.pinById(noteId, pinRequest.isPinned)


Also, DAO method can be renamed. Like, updateNotePinById or something like this.

Renamed it as per suggestion.

PatilShreyas · 2022-10-06T14:35:25Z

noty-api/application/test/dev/shreyaspatil/noty/api/ApplicationTest.kt

+            response.notes shouldHaveSize 1
+            response.notes[0].let {
+                it.id shouldBe newNoteResponse.noteId
+                it.title shouldBe "Hey update"


Thanks for adding tests 😃. Looks really nice 👍🏻

Thanks 😄

PatilShreyas · 2022-10-06T14:36:09Z

noty-api/build.gradle

@@ -21,7 +21,7 @@ buildscript {
        ktlintVersion = "10.3.0"
        coroutinesVersion = "1.6.4"
        ktorVersion = "1.6.8"
-        exposedVersion = "0.39.2"
+        exposedVersion = "0.40.1"


Thanks for updating it.

It was done by dependabot but sure I will take the credit 😅

PatilShreyas · 2022-10-06T14:36:28Z

noty-api/data/src/dev/shreyaspatil/noty/data/dao/NoteDao.kt

@@ -33,6 +34,7 @@ interface NoteDao {
    fun deleteById(id: String): Boolean
    fun isNoteOwnedByUser(id: String, userId: String): Boolean
    fun exists(id: String): Boolean
+    fun pinById(id: String, isPinned: Boolean): String


As discussed above, please update its name

Renamed it as per suggestion.

sandeshbodake · 2022-10-06T16:16:13Z

Good work @mrfamouskk7 🚀

mrfamouskk7 · 2022-10-06T17:06:24Z

Good work @mrfamouskk7 rocket
Thanks @sandeshbodake 😃

PatilShreyas

Change looks good to me @mrfamouskk7 😃. Thanks for contribution and feel free to contribute again! 🙇🏻‍♂️

mrfamouskk7 · 2022-10-07T12:25:37Z

Change looks good to me @mrfamouskk7 smiley. Thanks for contribution and feel free to contribute again! 🙇🏻‍♂️

Thanks @PatilShreyas for this opportunity 🙇‍♂️ ... I would definitely like to contribute again towards the backend side of the things as I am not much aware about Android 😃

dependabot bot and others added 6 commits October 6, 2022 02:05

Merge pull request PatilShreyas#545 from PatilShreyas/dependabot/grad…

6512d8c

…le/noty-api/exposedVersion-0.40.1 [API]: Bump exposedVersion from 0.39.2 to 0.40.1 in /noty-api

build: API to pin and unpin notes

1efcb90

chore: Add test cases to pin and unpin notes

2427c23

Fix CRLF

8098bdc

feat: Add updated field to Notes table to keep latest pinned note on top

e873cd9

mrfamouskk7 marked this pull request as ready for review October 6, 2022 13:53

mrfamouskk7 requested a review from PatilShreyas as a code owner October 6, 2022 13:53

PatilShreyas added the hacktoberfest-accepted label Oct 6, 2022

PatilShreyas changed the base branch from master to feature/pin-note October 6, 2022 14:27

fix: Change pin request from PUT to PATCH

11d7fc5

PatilShreyas reviewed Oct 6, 2022

View reviewed changes

refactor: Method names in notesController, notesRouter and noteDao

adc2407

mrfamouskk7 requested a review from PatilShreyas October 6, 2022 17:13

PatilShreyas approved these changes Oct 7, 2022

View reviewed changes

PatilShreyas merged commit 0e5a39e into PatilShreyas:feature/pin-note Oct 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Backend] Implement Feature: Pin Notes #546

[Backend] Implement Feature: Pin Notes #546

mrfamouskk7 commented Oct 6, 2022 •

edited

Loading

PatilShreyas commented Oct 6, 2022 •

edited

Loading

mrfamouskk7 commented Oct 6, 2022

PatilShreyas left a comment

PatilShreyas Oct 6, 2022

mrfamouskk7 Oct 6, 2022

PatilShreyas Oct 6, 2022

mrfamouskk7 Oct 6, 2022

PatilShreyas Oct 6, 2022

mrfamouskk7 Oct 6, 2022

PatilShreyas Oct 6, 2022

mrfamouskk7 Oct 6, 2022

PatilShreyas Oct 6, 2022

mrfamouskk7 Oct 6, 2022

sandeshbodake commented Oct 6, 2022

mrfamouskk7 commented Oct 6, 2022

PatilShreyas left a comment

mrfamouskk7 commented Oct 7, 2022

[Backend] Implement Feature: Pin Notes #546

[Backend] Implement Feature: Pin Notes #546

Conversation

mrfamouskk7 commented Oct 6, 2022 • edited Loading

Summary

Description for the changelog

A picture or screenshot regarding change

Checklist

PatilShreyas commented Oct 6, 2022 • edited Loading

mrfamouskk7 commented Oct 6, 2022

PatilShreyas 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sandeshbodake commented Oct 6, 2022

mrfamouskk7 commented Oct 6, 2022

PatilShreyas left a comment

Choose a reason for hiding this comment

mrfamouskk7 commented Oct 7, 2022

mrfamouskk7 commented Oct 6, 2022 •

edited

Loading

PatilShreyas commented Oct 6, 2022 •

edited

Loading