Workflows with XState

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

@@ -1,4 +1,70 @@
+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 (
+    !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 (!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
@@ -16,3 +82,91 @@ function deleteProduct(productId: string) {
   ]);
 }
 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
+                      StoreLanguages: {
+                        where: {
+                          Id: storeLanguageId
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          // 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
+    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/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",

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/workflow.ts

@@ -0,0 +1,138 @@
+import type { RoleId } from './prisma.js';
+
+export enum ActionType {
+  /** Automated Action */
+  Auto = 0,
+  /** User-initiated Action */
+  User
+}
+
+/**
+ * The administrative requirements of the workflow.
+ * Examples:
+ *  - If the flow has `WorkflowAdminLevel.High` it will include extra state to represent the organizational approval process
+ *  - If the flow has `WorkflowAdminLevel.Low` it will not include those states, but there are still some states that require action from an OrgAdmin to complete certain actions
+ *  - If the flow has `WorkflowAdminLevel.None` none of the states or actions for the workflow instance will require an OrgAdmin.
+ * 
+ * Any state or transition can have a list of specified `WorkflowAdminLevel`s. What this means is that those states and transitions will be included in a workflow instance ONLY when the instance's `WorkflowAdminLevel` is in the state's or transition's list.
+ * 
+ * If a state or transition does not specify any `WorkflowAdminLevel` it will be included (provided it passes other conditions not dependent on `WorkflowAdminLevel`).
+*/
+export enum WorkflowAdminLevel {
+  /** NoAdmin/OwnerAdmin */
+  None = 0,
+  /** LowAdmin */
+  Low,
+  /** Approval required */
+  High
+}
+
+export enum ProductType {
+  Android_GooglePlay = 0,
+  Android_S3,
+  AssetPackage,
+  Web
+}
+
+export type StateName =
+  | 'Readiness Check'
+  | 'Approval'
+  | 'Approval Pending'
+  | 'Terminated'
+  | 'App Builder Configuration'
+  | 'Author Configuration'
+  | 'Synchronize Data'
+  | 'Author Download'
+  | 'Author Upload'
+  | 'Product Build'
+  | 'App Store Preview'
+  | 'Create App Store Entry'
+  | 'Verify and Publish'
+  | 'Product Publish'
+  | 'Make It Live'
+  | 'Published'
+  | 'Product Creation';
+
+export type WorkflowContext = {
+  instructions:
+    | 'asset_package_verify_and_publish'
+    | 'app_configuration'
+    | 'create_app_entry'
+    | 'authors_download'
+    | 'googleplay_configuration'
+    | 'googleplay_verify_and_publish'
+    | 'make_it_live'
+    | 'approval_pending'
+    | 'readiness_check'
+    | 'synchronize_data'
+    | 'authors_upload'
+    | 'verify_and_publish'
+    | 'waiting'
+    | 'web_verify'
+    | null;
+  includeFields: (
+    | 'ownerName'
+    | 'ownerEmail'
+    | 'storeDescription'
+    | 'listingLanguageCode'
+    | 'projectURL'
+    | 'productDescription'
+    | 'appType'
+    | 'projectLanguageCode'
+  )[];
+  includeReviewers: boolean;
+  includeArtifacts: 'apk' | 'aab' | boolean;
+  start?: StateName;
+  adminLevel: WorkflowAdminLevel;
+  environment: BuildEnv;
+  productType: ProductType;
+};
+
+// These are all specific to the Google Play workflows
+// Not sure how these are used, but will figure out when integrating into backend
+export type BuildEnv = {
+  googlePlayDraft?: boolean;
+  googlePlayExisting?: boolean;
+  googlePlayUploaded?: boolean;
+};
+
+export type WorkflowInput = {
+  adminLevel: WorkflowAdminLevel;
+  productType: ProductType;
+};
+
+/** Used for filtering based on AdminLevel and/or ProductType */
+export type MetaFilter = {
+  level?: WorkflowAdminLevel[];
+  product?: ProductType[];
+};
+
+export type WorkflowStateMeta = MetaFilter;
+
+export type WorkflowTransitionMeta = MetaFilter & {
+  type: ActionType;
+  user?: RoleId;
+};
+
+export type WorkflowEvent = {
+  type: any;
+  comment?: string;
+  target?: StateName;
+  userId: number | null;
+};
+
+export type StateNode = {
+  id: number;
+  label: string;
+  connections: { id: number; target: string; label: string }[];
+  inCount: number;
+  start?: boolean;
+  final?: boolean;
+  action?: boolean;
+};
+
+export type Snapshot = {
+  value: string;
+  context: WorkflowContext;
+  input: WorkflowInput;
+};