Allow for bulk updating AuthRequest database objects
#4053
+263
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
addisonbeck
force-pushed
the
ac/addison/ac-2301/service-bulk-device-approval-endpoint-api
branch
from
bb61771
to
c6974aa
Compare
addisonbeck
force-pushed
the
ac/addison/ac-2301/service-bulk-device-approval-endpoint-api
branch
15 times, most recently
from
afe11b7
to
d16f587
Compare
To facilitate a new bulk device login request approval workflow in the admin console we need to update `IAuthRequestRepisitory` (owned by Auth team) to include an`UpdateManyAsync()` method. It should accept a list of `AuthRequest` table objects, and implementations will do a very simple 1:1 update of the passed in data. This commit adds an `UpdateManyAsync()` method to the `AuthRequestRepository` interface.
This commit stubs out implementations of `IAuthRequestRepository.UpdateManyAsync()` so the method signature can be called in unit tests. At this stage the methods are not implemented.
To facilitate a bulk update operation for auth requests a new user defined type will need to be written that can be used as a table input to the stored procedure. This will follow a similar pattern to how the `OragnizationSponsorshipType` works and is used by the stored procedure `OrganizationSponsorship_UpdateMany`.
To facilitate the bulk updating of auth request table objects this commit adds a new stored procedure to update a collection of entities on `AuthRequest` table by their primary key. It updates all properties, for convention, but the endpoint created later will only change the `Approved`, `ResponseDate`, `Key`, `MasterPasswordHash`, and `AuthenticationDate` properties.
This commit simply applies a migration script containing the new user defined type and stored procedure comitted previously.
The current pattern in place for bulk update stored procedures is to pass a `DataTable` through Dapper as an input for the update stored procedure being run. In order to facilitate the new bulk update procedure for the`AuthRequest` type we need a function added that can convert an `IEnumerable<AuthRequest>` to a `DataTable`. This is commit follows the convention of having a static class with a conversion method in a `Helpers` folder: `AuthRequestHelpers.ToDataTable()`.
This commit implements `AuthRequestRepository.UpdateMany()` for the Dapper implementation of `AuthRequestRepository`. It connects the stored procedure, `DataTable` converter, and Dapper-focused unit test commits written previously into one exposed method that can be referenced by service callers.
This commit implements the new `IAuthRequestRepository.UpdateManyAsync()`method in the Entity Framework skew of the repository layer. It checks to make sure the passed in list has auth requests, converts them all to an Entity Framework entity, and then uses `UpdateRange` to apply the whole thing over in the database context.
addisonbeck
force-pushed
the
ac/addison/ac-2301/service-bulk-device-approval-endpoint-api
branch
from
d16f587
to
9d5b27e
Compare
|
New Issues
Fixed Issues
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4053 +/- ##
==========================================
- Coverage 38.44% 38.42% -0.03%
==========================================
Files 1209 1209
Lines 58545 58577 +32
Branches 5585 5589 +4
==========================================
Hits 22509 22509
- Misses 34991 35023 +32
Partials 1045 1045 ☔ View full report in Codecov by Sentry. |
rkac-bw
reviewed
May 7, 2024
| is_user_defined = 1 | ||
| ) | ||
| BEGIN | ||
| CREATE TYPE [dbo].[AuthRequestType] AS TABLE( |
There was a problem hiding this comment.
In discussions with @withinfocus, we would like to move away from creating type objects in sql server and use something a little more generic like json for bulk inserts
ike-kottlowski
requested changes
May 7, 2024
| @@ -69,4 +69,29 @@ public async Task<ICollection<OrganizationAdminAuthRequest>> GetManyPendingByOrg | |||
| return orgUserAuthRequests; | |||
| } | |||
| } | |||
|
|
|||
| public async Task UpdateManyAsync(IEnumerable<Core.Auth.Entities.AuthRequest> authRequests) | |||
There was a problem hiding this comment.
⛏️ : Since this is doing more than updating the name might make more sense to be SavingManyAsync.
| @@ -0,0 +1,30 @@ | |||
| CREATE PROCEDURE [dbo].[AuthRequest_UpdateMany] | |||
There was a problem hiding this comment.
❓ : I don't think this accomplishes the same "add or update" methodology of the EF implementation. This method only updates the Auth Requests, it doesn't also add them if they don't exist. Should Auth Requests even be approved if they don't exist?
addisonbeck
force-pushed
the
ac/addison/ac-2301/service-bulk-device-approval-endpoint-api
branch
5 times, most recently
from
5d2c926
to
fab5fde
Compare
addisonbeck
force-pushed
the
ac/addison/ac-2301/service-bulk-device-approval-endpoint-api
branch
from
fab5fde
to
cea0589
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Objective
To facilitate a new bulk device login request approval workflow in the admin
console we need to update
IAuthRequestRepisitoryto include anUpdateManyAsync()method. It should accept a list ofAuthRequesttableobjects, and implementations will do a very simple 1:1 update of the passed
in data.
This pull request implements this behavior in the repository and database
layers of the bitwarden server.
Code changes
See the commits tab
References
to the more general and high level functions written in this PR for the repository layer.