Workflows with XState

source/SIL.AppBuilder.Portal/common/databaseProxy/Products.ts

@@ -1,8 +1,79 @@
+import type { Prisma } from '@prisma/client';
 import prisma from '../prisma.js';
+import { RequirePrimitive } from './utility.js';
+
+export async function create(
+  productData: RequirePrimitive<Prisma.ProductsUncheckedCreateInput>
+): Promise<boolean | string> {
+  if (
+    !(await validateProductBase(
+      productData.ProjectId,
+      productData.ProductDefinitionId,
+      productData.StoreId,
+      productData.StoreLanguageId
+    ))
+  )
+    return false;
+
+  // No additional verification steps
+
+  try {
+    const res = await prisma.products.create({
+      data: productData
+    });
+    return res.Id;
+  } catch (e) {
+    return false;
+  }
+}
+
+export async function update(
+  id: string,
+  productData: RequirePrimitive<Prisma.ProductsUncheckedUpdateInput>
+): Promise<boolean> {
+  // There are cases where a db lookup is not necessary to verify that it will
+  // be a legal relation after the update, such as if none of the relevant
+  // columns are changed, but for simplicity we just lookup once anyway
+  const existing = await prisma.products.findUnique({
+    where: {
+      Id: id
+    }
+  });
+  const projectId = productData.ProjectId ?? existing!.ProjectId;
+  const productDefinitionId = productData.ProductDefinitionId ?? existing!.ProductDefinitionId;
+  const storeId = productData.StoreId ?? existing!.StoreId;
+  const storeLanguageId = productData.StoreLanguageId ?? existing!.StoreLanguageId;
+  if (!(await validateProductBase(
+    projectId,
+    productDefinitionId,
+    storeId,
+    storeLanguageId
+  ))) return false;
+
+  // No additional verification steps
+
+  try {
+    await prisma.products.update({
+      where: {
+        Id: id
+      },
+      data: productData
+    });
+    // TODO: Are there any other updates that need to be done?
+  } catch (e) {
+    return false;
+  }
+  return true;
+}
 
 function deleteProduct(productId: string) {
   // Delete all userTasks for this product, and delete the product
   return prisma.$transaction([
+    prisma.workflowInstances.delete({
+      where: {
+        ProductId: productId
+      }
+    }),
     prisma.userTasks.deleteMany({
       where: {
         ProductId: productId
@@ -14,5 +85,98 @@ function deleteProduct(productId: string) {
       }
     })
   ]);
+  // TODO: delete from BuildEngine
 }
 export { deleteProduct as delete };
+
+/** A product is valid if:
+ * 1. The store's type matches the Workflow's store type
+ * 2. The project has a WorkflowProjectUrl
+ * 3. The store is allowed by the organization
+ * 4. The language is allowed by the store
+ * 5. The product type is allowed by the organization
+ */
+async function validateProductBase(
+  projectId: number,
+  productDefinitionId: number,
+  storeId: number,
+  storeLanguageId?: number
+) {
+  const productDefinition = await prisma.productDefinitions.findUnique({
+    where: {
+      Id: productDefinitionId
+    },
+    select: {
+      Id: true,
+      // Store type must match Workflow store type
+      Workflow: {
+        select: {
+          StoreTypeId: true
+        }
+      }
+    }
+  });
+  const project = await prisma.projects.findUnique({
+    where: {
+      Id: projectId,
+      // Project must have a WorkflowProjectUrl
+      WorkflowProjectUrl: {
+        not: null
+      }
+    },
+    select: {
+      Organization: {
+        select: {
+          // Store must be allowed by Organization
+          OrganizationStores: {
+            where: {
+              StoreId: storeId
+            },
+            select: {
+              Store: {
+                select: {
+                  StoreType: {
+                    select: {
+                      // Store type must match Workflow store type
+                      Id: true,
+                      // StoreLanguage must be allowed by Store, if the StoreLanguage is defined
+                      StoreLanguages: storeLanguageId === undefined || storeLanguageId === null ? 
+                        undefined : {
+                        where: {
+                          Id: storeLanguageId
+                        },
+                        select: {
+                          Id: true
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          // Product type must be allowed by Organization
+          OrganizationProductDefinitions: {
+            where: {
+              ProductDefinitionId: productDefinition?.Id
+            }
+          }
+        }
+      }
+    }
+  });
+
+  // 3. The store is allowed by the organization
+  return (
+    project?.Organization.OrganizationStores.length > 0 &&
+    // 1. The store's type matches the Workflow's store type
+    productDefinition?.Workflow.StoreTypeId ===
+      project.Organization.OrganizationStores[0].Store.StoreType.Id &&
+    // 2. The project has a WorkflowProjectUrl
+    // handled by query
+    // 4. The language is allowed by the store
+    (storeLanguageId ?? project.Organization.OrganizationStores[0].Store.StoreType.StoreLanguages.length > 0) &&
+    // 5. The product type is allowed by the organization
+    project.Organization.OrganizationProductDefinitions.length > 0
+  );
+}

source/SIL.AppBuilder.Portal/common/databaseProxy/Projects.ts

@@ -18,8 +18,8 @@ import type { RequirePrimitive } from './utility.js';
 
 export async function create(
   projectData: RequirePrimitive<Prisma.ProjectsUncheckedCreateInput>
-): Promise<boolean> {
-  if (!validateProjectBase(projectData.OrganizationId, projectData.GroupId, projectData.OwnerId))
+): Promise<boolean | number> {
+  if (!(await validateProjectBase(projectData.OrganizationId, projectData.GroupId, projectData.OwnerId)))
     return false;
 
   // No additional verification steps
@@ -49,7 +49,7 @@ export async function update(
   const orgId = projectData.OrganizationId ?? existing!.OrganizationId;
   const groupId = projectData.GroupId ?? existing!.GroupId;
   const ownerId = projectData.OwnerId ?? existing!.OwnerId;
-  if (!validateProjectBase(orgId, groupId, ownerId)) return false;
+  if (!(await validateProjectBase(orgId, groupId, ownerId))) return false;
 
   // No additional verification steps
 
@@ -61,6 +61,7 @@ export async function update(
       data: projectData
     });
     // If the owner has changed, we need to reassign all the user tasks related to this project
+    // TODO: But we don't need to change *every* user task, just the tasks associated with the owner.
     if (ownerId && ownerId !== existing?.OwnerId) {
       scriptoriaQueue.add(ScriptoriaJobType.ReassignUserTasks, {
         type: ScriptoriaJobType.ReassignUserTasks,

source/SIL.AppBuilder.Portal/common/databaseProxy/UserRoles.ts

@@ -35,3 +35,44 @@ export async function setUserRolesForOrganization(
     })
   ]);
 }
+
+export async function allUsersByRole(projectId: number) {
+  const project = await prisma.projects.findUnique({
+    where: {
+      Id: projectId
+    },
+    select: {
+      Organization: {
+        select: {
+          UserRoles: {
+            where: {
+              RoleId: RoleId.OrgAdmin
+            },
+            select: {
+              UserId: true
+            }
+          }
+        }
+      },
+      OwnerId: true,
+      Authors: {
+        select: {
+          UserId: true
+        }
+      }
+    }
+  });
+
+  const map = new Map<RoleId, number[]>();
+
+  map.set(
+    RoleId.OrgAdmin,
+    project.Organization.UserRoles.map((u) => u.UserId)
+  );
+  map.set(RoleId.AppBuilder, [project.OwnerId]);
+  map.set(
+    RoleId.Author,
+    project.Authors.map((a) => a.UserId)
+  );
+  return map;
+}

source/SIL.AppBuilder.Portal/common/databaseProxy/utility.ts

@@ -1,7 +1,7 @@
 import prisma from '../prisma.js';
 
 export type RequirePrimitive<T> = {
-  [K in keyof T]: Extract<T[K], string | number | boolean>;
+  [K in keyof T]: Extract<T[K], string | number | boolean | Date>;
 };
 
 export async function getOrCreateUser(profile: {

source/SIL.AppBuilder.Portal/common/index.ts

@@ -2,4 +2,4 @@ export * as BullMQ from './BullJobTypes.js';
 export { scriptoriaQueue } from './bullmq.js';
 export { default as DatabaseWrites } from './databaseProxy/index.js';
 export { readonlyPrisma as prisma } from './prisma.js';
-
+export { Workflow } from './workflow/index.js';

source/SIL.AppBuilder.Portal/common/package.json

@@ -4,7 +4,8 @@
   "description": "",
   "exports": {
     ".": "./index.js",
-    "./prisma": "./public/prisma.js"
+    "./prisma": "./public/prisma.js",
+    "./workflow": "./public/workflow.js"
   },
   "author": "",
   "type": "module",
@@ -14,6 +15,7 @@
     "bullmq": "^5.12.2"
   },
   "devDependencies": {
-    "prisma": "^5.18.0"
+    "prisma": "^5.18.0",
+    "xstate": "^5.18.2"
   }
 }

source/SIL.AppBuilder.Portal/common/prisma/migrations/1_workflow_instances/migration.sql

@@ -0,0 +1,14 @@
+-- CreateTable
+CREATE TABLE "WorkflowInstances" (
+    "Id" SERIAL NOT NULL,
+    "Snapshot" TEXT NOT NULL,
+    "ProductId" UUID NOT NULL,
+
+    CONSTRAINT "PK_WorkflowInstances" PRIMARY KEY ("Id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "WorkflowInstances_ProductId_key" ON "WorkflowInstances"("ProductId");
+
+-- AddForeignKey
+ALTER TABLE "WorkflowInstances" ADD CONSTRAINT "FK_WorkflowInstances_Products_ProductId" FOREIGN KEY ("ProductId") REFERENCES "Products"("Id") ON DELETE NO ACTION ON UPDATE NO ACTION;

source/SIL.AppBuilder.Portal/common/prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "postgresql"

source/SIL.AppBuilder.Portal/common/prisma/schema.prisma

@@ -287,7 +287,7 @@ model Products {
   StoreLanguage       StoreLanguages?       @relation(fields: [StoreLanguageId], references: [Id], onDelete: Restrict, onUpdate: NoAction, map: "FK_Products_StoreLanguages_StoreLanguageId")
   Store               Stores?               @relation(fields: [StoreId], references: [Id], onDelete: Restrict, onUpdate: NoAction, map: "FK_Products_Stores_StoreId")
   UserTasks           UserTasks[]
-  WorkflowInstances   WorkflowInstances?
+  WorkflowInstance    WorkflowInstances?
 
   @@index([ProductDefinitionId], map: "IX_Products_ProductDefinitionId")
   @@index([ProjectId], map: "IX_Products_ProjectId")

source/SIL.AppBuilder.Portal/common/public/prisma.ts

@@ -12,3 +12,9 @@ export enum ProductTransitionType {
   CancelWorkflow,
   ProjectAccess
 }
+
+export enum WorkflowType {
+  Startup = 1,
+  Rebuild,
+  Republish
+}