From d07f27f274aea524c0a32e1c3e3e077e81d746eb Mon Sep 17 00:00:00 2001 From: Chad Scharf <3904944+cscharf@users.noreply.github.com> Date: Wed, 1 Apr 2020 16:39:27 -0400 Subject: [PATCH] [Soft-Delete] Simplify the data-tier, removed extra sprocs and reuse update --- src/Core/Repositories/ICipherRepository.cs | 2 - .../SqlServer/CipherRepository.cs | 22 ---- .../Services/Implementations/CipherService.cs | 22 +++- src/Sql/Sql.sqlproj | 2 - .../CipherDetails_Create.sql | 8 +- .../CipherDetails_CreateWithCollections.sql | 2 +- .../CipherDetails_Update.sql | 5 +- .../dbo/Stored Procedures/Cipher_Create.sql | 8 +- .../Cipher_CreateWithCollections.sql | 2 +- .../Stored Procedures/Cipher_RestoreById.sql | 34 ------ .../Cipher_SoftDeleteById.sql | 35 ------ .../dbo/Stored Procedures/Cipher_Update.sql | 5 +- .../Cipher_UpdateWithCollections.sql | 6 +- .../2020-04-01_00_CipherSoftDelete.sql | 112 ++++-------------- 14 files changed, 65 insertions(+), 200 deletions(-) delete mode 100644 src/Sql/dbo/Stored Procedures/Cipher_RestoreById.sql delete mode 100644 src/Sql/dbo/Stored Procedures/Cipher_SoftDeleteById.sql diff --git a/src/Core/Repositories/ICipherRepository.cs b/src/Core/Repositories/ICipherRepository.cs index 2a8f3d467e..6f004118fb 100644 --- a/src/Core/Repositories/ICipherRepository.cs +++ b/src/Core/Repositories/ICipherRepository.cs @@ -32,9 +32,7 @@ namespace Bit.Core.Repositories Task CreateAsync(IEnumerable ciphers, IEnumerable folders); Task CreateAsync(IEnumerable ciphers, IEnumerable collections, IEnumerable collectionCiphers); - Task SoftDeleteAsync(Cipher obj); Task SoftDeleteAsync(IEnumerable ids, Guid userId); - Task RestoreAsync(Cipher obj); Task RestoreAsync(IEnumerable ids, Guid userId); } } diff --git a/src/Core/Repositories/SqlServer/CipherRepository.cs b/src/Core/Repositories/SqlServer/CipherRepository.cs index 9cc07ba909..781b6efb04 100644 --- a/src/Core/Repositories/SqlServer/CipherRepository.cs +++ b/src/Core/Repositories/SqlServer/CipherRepository.cs @@ -577,17 +577,6 @@ namespace Bit.Core.Repositories.SqlServer } } - public async Task SoftDeleteAsync(Cipher obj) - { - using (var connection = new SqlConnection(ConnectionString)) - { - var results = await connection.ExecuteAsync( - $"[{Schema}].[Cipher_SoftDeleteById]", - new { obj.Id }, - commandType: CommandType.StoredProcedure); - } - } - public async Task SoftDeleteAsync(IEnumerable ids, Guid userId) { using (var connection = new SqlConnection(ConnectionString)) @@ -599,17 +588,6 @@ namespace Bit.Core.Repositories.SqlServer } } - public async Task RestoreAsync(Cipher obj) - { - using (var connection = new SqlConnection(ConnectionString)) - { - var results = await connection.ExecuteAsync( - $"[{Schema}].[Cipher_RestoreById]", - new { obj.Id }, - commandType: CommandType.StoredProcedure); - } - } - public async Task RestoreAsync(IEnumerable ids, Guid userId) { using (var connection = new SqlConnection(ConnectionString)) diff --git a/src/Core/Services/Implementations/CipherService.cs b/src/Core/Services/Implementations/CipherService.cs index 0a955b1d0e..87a64040f2 100644 --- a/src/Core/Services/Implementations/CipherService.cs +++ b/src/Core/Services/Implementations/CipherService.cs @@ -671,7 +671,16 @@ namespace Bit.Core.Services throw new BadRequestException("You do not have permissions to soft delete this."); } - await _cipherRepository.SoftDeleteAsync(cipher); + if (cipher.DeletedDate.HasValue) + { + // Already soft-deleted, we can safely ignore this + return; + } + + cipher.DeletedDate = DateTime.UtcNow; + cipher.RevisionDate = DateTime.UtcNow; + + await _cipherRepository.UpsertAsync(cipher); await _eventService.LogCipherEventAsync(cipher, EventType.Cipher_SoftDeleted); // push @@ -704,7 +713,16 @@ namespace Bit.Core.Services throw new BadRequestException("You do not have permissions to delete this."); } - await _cipherRepository.RestoreAsync(cipher); + if (!cipher.DeletedDate.HasValue) + { + // Already restored, we can safely ignore this + return; + } + + cipher.DeletedDate = null; + cipher.RevisionDate = DateTime.UtcNow; + + await _cipherRepository.UpsertAsync(cipher); await _eventService.LogCipherEventAsync(cipher, EventType.Cipher_Restored); // push diff --git a/src/Sql/Sql.sqlproj b/src/Sql/Sql.sqlproj index aa35c11596..05084eadc0 100644 --- a/src/Sql/Sql.sqlproj +++ b/src/Sql/Sql.sqlproj @@ -262,8 +262,6 @@ - - \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/CipherDetails_Create.sql b/src/Sql/dbo/Stored Procedures/CipherDetails_Create.sql index b0c8cfcd27..4c7f82d6d6 100644 --- a/src/Sql/dbo/Stored Procedures/CipherDetails_Create.sql +++ b/src/Sql/dbo/Stored Procedures/CipherDetails_Create.sql @@ -13,7 +13,7 @@ @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -31,7 +31,8 @@ BEGIN [Favorites], [Folders], [CreationDate], - [RevisionDate] + [RevisionDate], + [DeletedDate] ) VALUES ( @@ -43,7 +44,8 @@ BEGIN CASE WHEN @Favorite = 1 THEN CONCAT('{', @UserIdKey, ':true}') ELSE NULL END, CASE WHEN @FolderId IS NOT NULL THEN CONCAT('{', @UserIdKey, ':"', @FolderId, '"', '}') ELSE NULL END, @CreationDate, - @RevisionDate + @RevisionDate, + @DeletedDate ) IF @OrganizationId IS NOT NULL diff --git a/src/Sql/dbo/Stored Procedures/CipherDetails_CreateWithCollections.sql b/src/Sql/dbo/Stored Procedures/CipherDetails_CreateWithCollections.sql index 92bc88079d..3d8bdc6ca8 100644 --- a/src/Sql/dbo/Stored Procedures/CipherDetails_CreateWithCollections.sql +++ b/src/Sql/dbo/Stored Procedures/CipherDetails_CreateWithCollections.sql @@ -13,7 +13,7 @@ @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN diff --git a/src/Sql/dbo/Stored Procedures/CipherDetails_Update.sql b/src/Sql/dbo/Stored Procedures/CipherDetails_Update.sql index fc34416bc7..35830c363e 100644 --- a/src/Sql/dbo/Stored Procedures/CipherDetails_Update.sql +++ b/src/Sql/dbo/Stored Procedures/CipherDetails_Update.sql @@ -13,7 +13,7 @@ @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(2) -- not used + @DeletedDate DATETIME2(2) AS BEGIN SET NOCOUNT ON @@ -47,7 +47,8 @@ BEGIN JSON_MODIFY([Favorites], @UserIdPath, NULL) END, [CreationDate] = @CreationDate, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate WHERE [Id] = @Id diff --git a/src/Sql/dbo/Stored Procedures/Cipher_Create.sql b/src/Sql/dbo/Stored Procedures/Cipher_Create.sql index e047e33c64..b81e61e5e8 100644 --- a/src/Sql/dbo/Stored Procedures/Cipher_Create.sql +++ b/src/Sql/dbo/Stored Procedures/Cipher_Create.sql @@ -9,7 +9,7 @@ @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -25,7 +25,8 @@ BEGIN [Folders], [Attachments], [CreationDate], - [RevisionDate] + [RevisionDate], + [DeletedDate] ) VALUES ( @@ -38,7 +39,8 @@ BEGIN @Folders, @Attachments, @CreationDate, - @RevisionDate + @RevisionDate, + @DeletedDate ) IF @OrganizationId IS NOT NULL diff --git a/src/Sql/dbo/Stored Procedures/Cipher_CreateWithCollections.sql b/src/Sql/dbo/Stored Procedures/Cipher_CreateWithCollections.sql index b02a07c7cb..5d9cef2f38 100644 --- a/src/Sql/dbo/Stored Procedures/Cipher_CreateWithCollections.sql +++ b/src/Sql/dbo/Stored Procedures/Cipher_CreateWithCollections.sql @@ -9,7 +9,7 @@ @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN diff --git a/src/Sql/dbo/Stored Procedures/Cipher_RestoreById.sql b/src/Sql/dbo/Stored Procedures/Cipher_RestoreById.sql deleted file mode 100644 index 72604f9138..0000000000 --- a/src/Sql/dbo/Stored Procedures/Cipher_RestoreById.sql +++ /dev/null @@ -1,34 +0,0 @@ -CREATE PROCEDURE [dbo].[Cipher_RestoreById] - @Id UNIQUEIDENTIFIER -AS -BEGIN - SET NOCOUNT ON - - DECLARE @UserId UNIQUEIDENTIFIER - DECLARE @OrganizationId UNIQUEIDENTIFIER - - SELECT TOP 1 - @UserId = [UserId], - @OrganizationId = [OrganizationId] - FROM - [dbo].[Cipher] - WHERE - [Id] = @Id - - UPDATE - [dbo].[Cipher] - SET - [DeletedDate] = NULL, - [RevisionDate] = GETUTCDATE() - WHERE - [Id] = @Id - - IF @OrganizationId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDateByCipherId] @Id, @OrganizationId - END - ELSE IF @UserId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDate] @UserId - END -END \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/Cipher_SoftDeleteById.sql b/src/Sql/dbo/Stored Procedures/Cipher_SoftDeleteById.sql deleted file mode 100644 index bc90027929..0000000000 --- a/src/Sql/dbo/Stored Procedures/Cipher_SoftDeleteById.sql +++ /dev/null @@ -1,35 +0,0 @@ -CREATE PROCEDURE [dbo].[Cipher_SoftDeleteById] - @Id UNIQUEIDENTIFIER -WITH RECOMPILE -AS -BEGIN - SET NOCOUNT ON - - DECLARE @UserId UNIQUEIDENTIFIER - DECLARE @OrganizationId UNIQUEIDENTIFIER - - SELECT TOP 1 - @UserId = [UserId], - @OrganizationId = [OrganizationId] - FROM - [dbo].[Cipher] - WHERE - [Id] = @Id - - UPDATE - [dbo].[Cipher] - SET - [DeletedDate] = SYSUTCDATETIME(), - [RevisionDate] = GETUTCDATE() - WHERE - [Id] = @Id - - IF @OrganizationId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDateByCipherId] @Id, @OrganizationId - END - ELSE IF @UserId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDate] @UserId - END -END \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/Cipher_Update.sql b/src/Sql/dbo/Stored Procedures/Cipher_Update.sql index df35f97278..0a9fcc8198 100644 --- a/src/Sql/dbo/Stored Procedures/Cipher_Update.sql +++ b/src/Sql/dbo/Stored Procedures/Cipher_Update.sql @@ -9,7 +9,7 @@ @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -25,7 +25,8 @@ BEGIN [Folders] = @Folders, [Attachments] = @Attachments, [CreationDate] = @CreationDate, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate WHERE [Id] = @Id diff --git a/src/Sql/dbo/Stored Procedures/Cipher_UpdateWithCollections.sql b/src/Sql/dbo/Stored Procedures/Cipher_UpdateWithCollections.sql index 5ce797a839..5408366796 100644 --- a/src/Sql/dbo/Stored Procedures/Cipher_UpdateWithCollections.sql +++ b/src/Sql/dbo/Stored Procedures/Cipher_UpdateWithCollections.sql @@ -9,7 +9,7 @@ @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN @@ -34,9 +34,9 @@ BEGIN [OrganizationId] = @OrganizationId, [Data] = @Data, [Attachments] = @Attachments, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate -- No need to update CreationDate, Favorites, Folders, or Type since that data will not change - -- Do not update DeletedDate because that is a separate atomic action WHERE [Id] = @Id diff --git a/util/Migrator/DbScripts/2020-04-01_00_CipherSoftDelete.sql b/util/Migrator/DbScripts/2020-04-01_00_CipherSoftDelete.sql index 031276ec31..d9a3e74f3f 100644 --- a/util/Migrator/DbScripts/2020-04-01_00_CipherSoftDelete.sql +++ b/util/Migrator/DbScripts/2020-04-01_00_CipherSoftDelete.sql @@ -2,8 +2,9 @@ * Revert [Cipher] deletes/gets to original versions * - No longer needs to have the deleted flag on reads (always read all) * - No longer needs to have the permanent flag on deletes (they just are) - * + Added ability to restore a soft-deleted cipher - * + Added DeletedDate value to updates/create sprocs + * + Added ability to bulk soft-delete a cipher + * + Added ability to bulk restore a soft-deleted cipher + * + Added DeletedDate value to updates/create sprocs (individual records) */ IF OBJECT_ID('[dbo].[Cipher_Restore]') IS NOT NULL BEGIN @@ -75,41 +76,6 @@ BEGIN DROP PROCEDURE [dbo].[Cipher_RestoreById]; END GO -CREATE PROCEDURE [dbo].[Cipher_RestoreById] - @Id UNIQUEIDENTIFIER -AS -BEGIN - SET NOCOUNT ON - - DECLARE @UserId UNIQUEIDENTIFIER - DECLARE @OrganizationId UNIQUEIDENTIFIER - - SELECT TOP 1 - @UserId = [UserId], - @OrganizationId = [OrganizationId] - FROM - [dbo].[Cipher] - WHERE - [Id] = @Id - - UPDATE - [dbo].[Cipher] - SET - [DeletedDate] = NULL, - [RevisionDate] = GETUTCDATE() - WHERE - [Id] = @Id - - IF @OrganizationId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDateByCipherId] @Id, @OrganizationId - END - ELSE IF @UserId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDate] @UserId - END -END -GO IF OBJECT_ID('[dbo].[CipherDetails_ReadByUserId]') IS NOT NULL BEGIN @@ -398,42 +364,6 @@ BEGIN DROP PROCEDURE [dbo].[Cipher_SoftDeleteById]; END GO -CREATE PROCEDURE [dbo].[Cipher_SoftDeleteById] - @Id UNIQUEIDENTIFIER -WITH RECOMPILE -AS -BEGIN - SET NOCOUNT ON - - DECLARE @UserId UNIQUEIDENTIFIER - DECLARE @OrganizationId UNIQUEIDENTIFIER - - SELECT TOP 1 - @UserId = [UserId], - @OrganizationId = [OrganizationId] - FROM - [dbo].[Cipher] - WHERE - [Id] = @Id - - UPDATE - [dbo].[Cipher] - SET - [DeletedDate] = SYSUTCDATETIME(), - [RevisionDate] = GETUTCDATE() - WHERE - [Id] = @Id - - IF @OrganizationId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDateByCipherId] @Id, @OrganizationId - END - ELSE IF @UserId IS NOT NULL - BEGIN - EXEC [dbo].[User_BumpAccountRevisionDate] @UserId - END -END -GO IF OBJECT_ID('[dbo].[Cipher_Create]') IS NOT NULL BEGIN @@ -451,7 +381,7 @@ CREATE PROCEDURE [dbo].[Cipher_Create] @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -467,7 +397,8 @@ BEGIN [Folders], [Attachments], [CreationDate], - [RevisionDate] + [RevisionDate], + [DeletedDate] ) VALUES ( @@ -480,7 +411,8 @@ BEGIN @Folders, @Attachments, @CreationDate, - @RevisionDate + @RevisionDate, + @DeletedDate ) IF @OrganizationId IS NOT NULL @@ -514,7 +446,7 @@ CREATE PROCEDURE [dbo].[CipherDetails_Create] @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -532,7 +464,8 @@ BEGIN [Favorites], [Folders], [CreationDate], - [RevisionDate] + [RevisionDate], + [DeletedDate] ) VALUES ( @@ -544,7 +477,8 @@ BEGIN CASE WHEN @Favorite = 1 THEN CONCAT('{', @UserIdKey, ':true}') ELSE NULL END, CASE WHEN @FolderId IS NOT NULL THEN CONCAT('{', @UserIdKey, ':"', @FolderId, '"', '}') ELSE NULL END, @CreationDate, - @RevisionDate + @RevisionDate, + @DeletedDate ) IF @OrganizationId IS NOT NULL @@ -574,7 +508,7 @@ CREATE PROCEDURE [dbo].[Cipher_CreateWithCollections] @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN @@ -608,7 +542,7 @@ CREATE PROCEDURE [dbo].[CipherDetails_CreateWithCollections] @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN @@ -638,7 +572,7 @@ CREATE PROCEDURE [dbo].[Cipher_Update] @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7) -- not used + @DeletedDate DATETIME2(7) AS BEGIN SET NOCOUNT ON @@ -654,7 +588,8 @@ BEGIN [Folders] = @Folders, [Attachments] = @Attachments, [CreationDate] = @CreationDate, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate WHERE [Id] = @Id @@ -685,7 +620,7 @@ CREATE PROCEDURE [dbo].[Cipher_UpdateWithCollections] @Attachments NVARCHAR(MAX), @CreationDate DATETIME2(7), @RevisionDate DATETIME2(7), - @DeletedDate DATETIME2(7), -- not used + @DeletedDate DATETIME2(7), @CollectionIds AS [dbo].[GuidIdArray] READONLY AS BEGIN @@ -710,9 +645,9 @@ BEGIN [OrganizationId] = @OrganizationId, [Data] = @Data, [Attachments] = @Attachments, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate -- No need to update CreationDate, Favorites, Folders, or Type since that data will not change - -- Do not update DeletedDate because that is a separate atomic action WHERE [Id] = @Id @@ -750,7 +685,7 @@ CREATE PROCEDURE [dbo].[CipherDetails_Update] @Favorite BIT, @Edit BIT, -- not used @OrganizationUseTotp BIT, -- not used - @DeletedDate DATETIME2(2) -- not used + @DeletedDate DATETIME2(2) AS BEGIN SET NOCOUNT ON @@ -784,7 +719,8 @@ BEGIN JSON_MODIFY([Favorites], @UserIdPath, NULL) END, [CreationDate] = @CreationDate, - [RevisionDate] = @RevisionDate + [RevisionDate] = @RevisionDate, + [DeletedDate] = @DeletedDate WHERE [Id] = @Id