[PM-22263] [PM-29849] Initial PoC of seeder API (#6424)

We want to reduce the amount of business critical test data in the company. One way of doing that is to generate test data on demand prior to client side testing.

Clients will request a scene to be set up with a JSON body set of options, specific to a given scene. Successful seed requests will be responded to with a mangleMap which maps magic strings present in the request to the mangled, non-colliding versions inserted into the database. This way, the server is solely responsible for understanding uniqueness requirements in the database. scenes also are able to return custom data, depending on the scene. For example, user creation would benefit from a return value of the userId for further test setup on the client side.

Clients will indicate they are running tests by including a unique header, x-play-id which specifies a unique testing context. The server uses this PlayId as the seed for any mangling that occurs. This allows the client to decide it will reuse a given PlayId if the test context builds on top of previously executed tests. When a given context is no longer needed, the API user will delete all test data associated with the PlayId by calling a delete endpoint.

---------

Co-authored-by: Matt Gibson <mgibson@bitwarden.com>

src/Sql/dbo/Stored Procedures/PlayItem_Create.sql

@@ -0,0 +1,27 @@
+CREATE PROCEDURE [dbo].[PlayItem_Create]
+    @Id UNIQUEIDENTIFIER OUTPUT,
+    @PlayId NVARCHAR(256),
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER,
+    @CreationDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    INSERT INTO [dbo].[PlayItem]
+    (
+        [Id],
+        [PlayId],
+        [UserId],
+        [OrganizationId],
+        [CreationDate]
+    )
+    VALUES
+    (
+        @Id,
+        @PlayId,
+        @UserId,
+        @OrganizationId,
+        @CreationDate
+    )
+END

src/Sql/dbo/Stored Procedures/PlayItem_DeleteByPlayId.sql

@@ -0,0 +1,12 @@
+CREATE PROCEDURE [dbo].[PlayItem_DeleteByPlayId]
+    @PlayId NVARCHAR(256)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    DELETE
+    FROM
+        [dbo].[PlayItem]
+    WHERE
+        [PlayId] = @PlayId
+END

src/Sql/dbo/Stored Procedures/PlayItem_ReadByPlayId.sql

@@ -0,0 +1,17 @@
+CREATE PROCEDURE [dbo].[PlayItem_ReadByPlayId]
+    @PlayId NVARCHAR(256)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    SELECT
+        [Id],
+        [PlayId],
+        [UserId],
+        [OrganizationId],
+        [CreationDate]
+    FROM
+        [dbo].[PlayItem]
+    WHERE
+        [PlayId] = @PlayId
+END

src/Sql/dbo/Tables/PlayItem.sql

@@ -0,0 +1,23 @@
+CREATE TABLE [dbo].[PlayItem] (
+    [Id]             UNIQUEIDENTIFIER NOT NULL,
+    [PlayId]         NVARCHAR (256)    NOT NULL,
+    [UserId]         UNIQUEIDENTIFIER NULL,
+    [OrganizationId] UNIQUEIDENTIFIER NULL,
+    [CreationDate]   DATETIME2 (7)    NOT NULL,
+    CONSTRAINT [PK_PlayItem] PRIMARY KEY CLUSTERED ([Id] ASC),
+    CONSTRAINT [FK_PlayItem_User] FOREIGN KEY ([UserId]) REFERENCES [dbo].[User] ([Id]) ON DELETE CASCADE,
+    CONSTRAINT [FK_PlayItem_Organization] FOREIGN KEY ([OrganizationId]) REFERENCES [dbo].[Organization] ([Id]) ON DELETE CASCADE,
+    CONSTRAINT [CK_PlayItem_UserOrOrganization] CHECK (([UserId] IS NOT NULL AND [OrganizationId] IS NULL) OR ([UserId] IS NULL AND [OrganizationId] IS NOT NULL))
+);
+
+GO
+CREATE NONCLUSTERED INDEX [IX_PlayItem_PlayId]
+    ON [dbo].[PlayItem]([PlayId] ASC);
+
+GO
+CREATE NONCLUSTERED INDEX [IX_PlayItem_UserId]
+    ON [dbo].[PlayItem]([UserId] ASC);
+
+GO
+CREATE NONCLUSTERED INDEX [IX_PlayItem_OrganizationId]
+    ON [dbo].[PlayItem]([OrganizationId] ASC);