Mrc 5295- Role create endpoint #62

absternator · 2024-04-30T09:33:27Z

This PR adds an endpoint for role creation. I have also moved some models into the dto folder thus looks like I touched lots of files but these are only import statements... For testing try hit the endpoint with a user with admin privileges (use super admn script to create this, and get bearer token via login)..

codecov · 2024-04-30T09:56:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.98%. Comparing base (c3538bb) to head (82800ef).
Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #62   +/-   ##
=======================================
  Coverage   93.98%   93.98%           
=======================================
  Files          67       67           
  Lines         532      532           
  Branches      131      131           
=======================================
  Hits          500      500           
  Misses         30       30           
  Partials        2        2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…/packit into mrc-5295-role-create

EmmaLRussell

I'm assuming you didn't mean to close this PR??

Looks good, but I think there's been some confusion re the model classes, so let's chat about that on Tuesday. You've still got e.g. "Role" as the database entity, which I thought we were going to change so that "Role" was the dto and RoleEntity the db class. We maybe got our wires crossed and I thought we had agreed on something that we hadn't.. I don't really think you need to put the dto classes in a sub-folder of model, since they're the primary objects, but don't mind as long as the db classes go into 'entitity'.

EmmaLRussell · 2024-05-06T08:09:33Z

api/app/build.gradle.kts

@@ -54,6 +54,7 @@ dependencies {
    implementation("com.auth0:java-jwt:4.4.0")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.flywaydb:flyway-core")
+    testImplementation("org.testng:testng:7.1.0")


What was this for? I don't see any references to testng anywhere else in the PR.

oh may dead end when testing. have removed

EmmaLRussell · 2024-05-06T08:28:11Z

api/app/src/main/kotlin/packit/controllers/RoleController.kt

+    {
+        roleService.createRole(createRole)
+
+        return ResponseEntity.ok(mapOf("message" to "Role created"))


I'm not sure how useful {"message": "Role created"} is really. It might be nice to actually just return the new Role, since the front end is probably going to want to display it immediately. Or else just return an empty 200 and let the front end decide what message it wants to show.

yup agree.. have created dtos needed for this in user endpoints so for now have created ticket https://mrc-ide.myjetbrains.com/youtrack/issue/mrc-5324/Create-endpoints-to-return-Dtos... this will get done after endpoints tickets

EmmaLRussell · 2024-05-06T08:33:15Z

api/app/src/main/kotlin/packit/model/Packet.kt

@@ -25,8 +25,7 @@ class Packet(
        inverseJoinColumns = [JoinColumn(name = "tag_id")]
    )
    var tags: MutableList<Tag> = mutableListOf(),
-
-    @OneToMany(mappedBy = "packet")
+    @OneToMany(mappedBy = "packet", cascade = [CascadeType.ALL])


I'm not sure rolePermissions actually belongs on Packet anyway - it's not really of interest relating to the packet itself, just something we need to take account of when determing user access to packet, and for admin users managing access -but they'll be coming from the user/role side and won't be interested in the full packet data at that point.

But even so, I guess it's useful to include it here so that we get the cascade functionality on delete?

yeah it needs to be there because there a FK from the role_permissions table to the packet table...

EmmaLRussell · 2024-05-06T08:40:45Z

api/app/src/main/kotlin/packit/model/dto/CreateRole.kt

+data class CreateRole(
+    @field:NotNull
+    val name: String,
+    val permissions: List<String> = listOf()


Are these permission names or permission ids? Might be best to update this field to be clear i,e, permissionNames?

Though we're just dealing with global permissions here of course, so this is going to evolve.

I think it would also be acceptable to make the create function just take a role name and create an empty role initially, since you're going to need to made an add permissions endpoint anyway. But this is fine too!

have renamed to permissionNames... but yeah added this cos they may want to add global permissions at start.. but they don't have to provide permissionNames

EmmaLRussell · 2024-05-06T08:48:05Z

api/app/src/main/kotlin/packit/service/PermissionService.kt

@@ -0,0 +1,29 @@
+package packit.service


I think there's an inconsistency in module naming creeping in here, as you've got PacketService interface and BasePacketService class declared in BasePacketService module, but here you've named the module after the interface, PermissionsService. I actually prefer this way, so would suggest renaming BasePacketService module to PacketService.

oh yeah didnt even notice that for packet one must've been old... but yup il update this

EmmaLRussell · 2024-05-06T08:52:27Z

api/app/src/main/kotlin/packit/service/PermissionService.kt

+    private val permissionRepository: PermissionRepository
+) : PermissionService
+{
+    override fun checkMatchingPermissions(permissionsToCheck: List<String>): List<Permission>


So this method is literally just checking that the basic permissions themselves exist in the database? We're not checking that a user has sufficient permissions to do anything? So we can rely on the result count since we know that permission names are enforced as unique?

yup yup exactly

EmmaLRussell · 2024-05-06T09:02:59Z

api/app/src/main/kotlin/packit/service/RoleService.kt

    {
        if (roleRepository.existsByName(roleName))
        {
            throw PackitException("roleAlreadyExists")
        }
        val role = Role(name = roleName)
+        role.rolePermissions = permissions.map { RolePermission(permission = it, role = role) }
+            .toMutableList()


Could be toList(), this doesn't need to be mutable. Oh, except it's defined as mutable on the entity type.. maybe it's doesn't need to be mutable there either, seems a bit odd..? Depends on how you're going to do updates I guess.

yeah i wish but cant because its a mutable list.. needs to be mutable because we will be updating the list (adding/ removing)...

EmmaLRussell · 2024-05-06T09:12:14Z

api/app/src/main/kotlin/packit/service/PermissionService.kt

+{
+    override fun checkMatchingPermissions(permissionsToCheck: List<String>): List<Permission>
+    {
+        val matchedPermissions = permissionRepository.findByNameIn(permissionsToCheck)


Is this case sensitive?

yup will be

EmmaLRussell

Also.. no controller unit tests?

absternator · 2024-05-07T07:43:31Z

I'm assuming you didn't mean to close this PR??

Looks good, but I think there's been some confusion re the model classes, so let's chat about that on Tuesday. You've still got e.g. "Role" as the database entity, which I thought we were going to change so that "Role" was the dto and RoleEntity the db class. We maybe got our wires crossed and I thought we had agreed on something that we hadn't.. I don't really think you need to put the dto classes in a sub-folder of model, since they're the primary objects, but don't mind as long as the db classes go into 'entitity'.

Oh haha yeah weird not sure how it closed... But yup in the previous PR I made a ticket for this and will do all renaming for models and folder sorting in separate ticket as agreed 😄. Will do that ticket asap after these endpoint tickets have been merged in https://mrc-ide.myjetbrains.com/youtrack/issue/mrc-5310/Model-folder-structure-Naming

absternator · 2024-05-07T08:19:03Z

Also.. no controller unit tests?

yeah I didn't put any for all the PRs..... because they legit just call out to service and return whats returned... These are covered in integration tests (as I wrote integration tests for controllers)

absternator added 5 commits April 29, 2024 14:22

feat: get working version

66c123a

Add test implementation for TestNG and update authentication method

82d3a52

Fix role controller and permission service

2d15547

chore: move models to dto folder

409d6c9

chore: move to dto modelss

c9ac5ae

absternator requested a review from EmmaLRussell April 30, 2024 09:33

absternator added 6 commits May 1, 2024 14:08

Merge branch 'mrc-5280-new-auth-schema' of https://github.com/mrc-ide…

cd043ec

…/packit into mrc-5295-role-create

Refactor RoleController and RoleControllerTest***

b0c7348

Merge branch 'mrc-5280-new-auth-schema' of https://github.com/mrc-ide…

f67fbe4

…/packit into mrc-5295-role-create

Merge branch 'mrc-5280-new-auth-schema' of https://github.com/mrc-ide…

d4918d4

…/packit into mrc-5295-role-create

Refactor Role class to add rolePermissions property

c0cda7f

Merge branch 'mrc-5280-new-auth-schema' of https://github.com/mrc-ide…

cfac8b5

…/packit into mrc-5295-role-create

absternator deleted the branch main May 5, 2024 07:56

absternator closed this May 5, 2024

EmmaLRussell reviewed May 6, 2024

View reviewed changes

absternator reopened this May 7, 2024

absternator changed the base branch from mrc-5280-new-auth-schema to main May 7, 2024 06:48

Refactor role permissions variable names

74afb92

Add PacketService interface and BasePacketService implementation

82800ef

absternator requested a review from EmmaLRussell May 7, 2024 08:28

EmmaLRussell approved these changes May 13, 2024

View reviewed changes

absternator merged commit e30288d into main May 13, 2024
5 checks passed

absternator deleted the mrc-5295-role-create branch May 13, 2024 13:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mrc 5295- Role create endpoint #62

Mrc 5295- Role create endpoint #62

absternator commented Apr 30, 2024 •

edited

codecov bot commented Apr 30, 2024 •

edited

EmmaLRussell left a comment

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell May 6, 2024

absternator May 7, 2024 •

edited

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell May 6, 2024

absternator May 7, 2024 •

edited

EmmaLRussell May 6, 2024

absternator May 7, 2024

EmmaLRussell left a comment

absternator commented May 7, 2024 •

edited

absternator commented May 7, 2024

Mrc 5295- Role create endpoint #62

Mrc 5295- Role create endpoint #62

Conversation

absternator commented Apr 30, 2024 • edited

codecov bot commented Apr 30, 2024 • edited

Codecov Report

EmmaLRussell 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

absternator May 7, 2024 • edited

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

absternator May 7, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EmmaLRussell left a comment

Choose a reason for hiding this comment

absternator commented May 7, 2024 • edited

absternator commented May 7, 2024

absternator commented Apr 30, 2024 •

edited

codecov bot commented Apr 30, 2024 •

edited

absternator May 7, 2024 •

edited

absternator May 7, 2024 •

edited

absternator commented May 7, 2024 •

edited