@things-factory/worklist 10.1.202 → 10.1.203

package/tests/pick-race.pg.test.ts

@@ -63,7 +63,7 @@ maybe('picking at once, on postgres', () => {
       name: `p${round}`,
       state: 'issued',
       activity,
-      assigneeRole: role,
+      assigneeRoles: [role],
       threadsMin: 1,
       threadsMax: 1
     })
@@ -111,7 +111,7 @@ maybe('picking at once, on postgres', () => {
         name: `two${round}`,
         state: 'issued',
         activity,
-        assigneeRole: role,
+        assigneeRoles: [role],
         threadsMin: 2,
         threadsMax: 2
       })

package/tests/published-shape.test.ts

@@ -54,9 +54,9 @@ beforeEach(() => (seen.length = 0))
 const handed = (name: string, on: string) => seen.find(one => one.name === name && one.on === on)?.entity
 
 it('a new instance carries its domain, its maker and the role it waits for', async () => {
-  await db.getRepository(ActivityInstance).save({ domain, name: 'i', creator: user, assigneeRole: role, state: 'issued' })
+  await db.getRepository(ActivityInstance).save({ domain, name: 'i', creator: user, assigneeRoles: [role], state: 'issued' })
 
-  expect(handed('ActivityInstance', 'insert')).toMatchObject({ domainId: domain.id, creatorId: user.id, assigneeRoleId: role.id })
+  expect(handed('ActivityInstance', 'insert')).toMatchObject({ domainId: domain.id, creatorId: user.id, assigneeRoleIds: [role.id] })
 })
 
 it('a new thread carries its domain and its assignee', async () => {

package/tests/role-pool-race.pg.test.ts

@@ -0,0 +1,182 @@
+import { join } from 'path'
+
+/**
+ * Putting a case in a role's pool at the same moment as something else, on postgres (ADR-0091 decision 9).
+ *
+ * Every way into a waiting case takes the case's row first and its threads after - pick, a pool assign,
+ * a member claiming the pool's waiting thread. sqlite holds one connection and cannot run two transactions
+ * side by side, so what it says about this is no evidence either way. Runs only when WORKLIST_PG_URL names a
+ * postgres server (see discard-versus-issue.pg.test.ts):
+ *
+ *   docker run -d --name wl-ux-pg -e POSTGRES_PASSWORD=wlux -e POSTGRES_USER=wlux -e POSTGRES_DB=wlux \
+ *     -p 55433:5432 postgres:14-alpine
+ *   WORKLIST_PG_URL=postgres://wlux:wlux@localhost:55433/wlux npx jest packages/worklist/tests/role-pool-race.pg.test.ts
+ *
+ * Each round must end one way or the other, and whoever lost is refused by name - a deadlock, two waiting
+ * threads, a pool wiped by a stale save, or someone outside the role holding the case is the defect.
+ */
+
+const url = process.env.WORKLIST_PG_URL
+const maybe = url ? describe : describe.skip
+
+/* Nobody here manages activity instances - the role is the only way in. */
+jest.mock('@things-factory/auth-base', () => {
+  const actual = jest.requireActual('@things-factory/auth-base')
+  return { ...actual, checkPermission: async () => false }
+})
+
+maybe('a role pool at the same moment as something else, on postgres', () => {
+  const { DataSource } = require('typeorm')
+  const { entityClosure } = require(join(__dirname, '..', '..', 'ops-master', 'test', 'support', 'database.cjs'))
+  const { NamingStrategy } = require('@things-factory/shell/dist-server/initializers/naming-strategy.js')
+  const DIST = join(__dirname, '..', 'dist-server')
+  const { Activity } = require(join(DIST, 'service', 'activity', 'activity.js'))
+  const { ActivityInstance } = require(join(DIST, 'service', 'activity-instance', 'activity-instance.js'))
+  const { ActivityThread } = require(join(DIST, 'service', 'activity-thread', 'activity-thread.js'))
+  const { ActivityApproval } = require(join(DIST, 'service', 'activity-approval', 'activity-approval.js'))
+  const { assign } = require(join(DIST, 'controllers', 'activity-instance', 'assign.js'))
+  const { pick } = require(join(DIST, 'controllers', 'activity-instance', 'pick.js'))
+  const { start } = require(join(DIST, 'controllers', 'activity-thread', 'start.js'))
+  const { Domain } = require('@things-factory/shell')
+  const { Role, User } = require('@things-factory/auth-base')
+
+  /* The refusals a loser may get - by name, never a deadlock or a constraint error. */
+  const NAMED = [
+    'error.activity-approval taken by someone else',
+    'error.activity-instance is addressed to another role',
+    'error.activity-instance should not be assigned',
+    'error.not authorized to handle this task'
+  ]
+
+  let db: any
+  let domain: any
+  let manager: any
+  let finance: any
+  let support: any
+  let inFinance: any
+  let inSupport: any
+  let outsider: any
+  let activity: any
+
+  beforeAll(async () => {
+    db = new DataSource({
+      type: 'postgres',
+      url,
+      synchronize: true,
+      dropSchema: true,
+      entities: entityClosure([Activity, ActivityInstance, ActivityThread, ActivityApproval]),
+      namingStrategy: new NamingStrategy()
+    })
+    await db.initialize()
+
+    domain = await db.getRepository(Domain).save({ name: 'd', subdomain: 'd' })
+    const person = (name: string) =>
+      db.getRepository(User).save({ name, email: `${name}@example.com`, password: 'x', status: 'activated', userType: 'user', domains: [domain] })
+    manager = await person('manager')
+    inFinance = await person('in-finance')
+    inSupport = await person('in-support')
+    outsider = await person('outsider')
+    finance = await db.getRepository(Role).save({ domain, name: 'finance', users: [inFinance] })
+    support = await db.getRepository(Role).save({ domain, name: 'support', users: [inSupport] })
+    activity = await db.getRepository(Activity).save({ domain, name: 'tax-invoice', activityType: 'standard', startingType: 'issue' })
+  }, 60000)
+
+  afterAll(async () => db?.destroy())
+
+  const as = (user: any) => (tx: any) => ({ state: { domain, user, tx }, t: (key: string) => key }) as any
+  const aCase = (name: string) => db.getRepository(ActivityInstance).save({ domain, name, state: 'issued', activity })
+  const threadsOf = (instance: any) => db.getRepository(ActivityThread).find({ where: { activityInstance: { id: instance.id } } })
+  const reread = (instance: any) => db.getRepository(ActivityInstance).findOne({ where: { id: instance.id }, relations: ['assigneeRoles'] })
+  const poolOf = (row: any) => (row?.assigneeRoles || []).map((role: any) => role.id).sort()
+  const toPool = (instance: any, role: any) => (tx: any) => assign({ id: instance.id, assigneeRoles: [role.id] }, as(manager)(tx))
+
+  /** Every loser was refused by one of the named refusals. */
+  const refusedByName = (results: PromiseSettledResult<any>[]) =>
+    results
+      .filter(one => one.status === 'rejected')
+      .forEach((one: any) => expect(NAMED).toContain(one.reason?.message))
+
+  it('two pool assigns at once: one waiting thread, in one of the two pools', async () => {
+    const endings: string[] = []
+
+    for (let round = 0; round < 20; round++) {
+      const instance = await aCase(`two-${round}`)
+
+      const results = await Promise.allSettled([db.transaction(toPool(instance, finance)), db.transaction(toPool(instance, support))])
+      refusedByName(results)
+
+      const threads = await threadsOf(instance)
+      const after = await reread(instance)
+      endings.push(`${results.filter(one => one.status === 'fulfilled').length} won`)
+
+      expect(threads.map((thread: any) => thread.state)).toEqual(['unassigned'])
+      expect([[finance.id], [support.id]]).toContainEqual(poolOf(after))
+      expect(after.threadsMin).toBe(1)
+    }
+
+    console.log('endings', [...new Set(endings)].join(' · '))
+  }, 120000)
+
+  it('a pool assign and a pick by someone outside the role at once: exactly one wins', async () => {
+    const endings: string[] = []
+
+    for (let round = 0; round < 20; round++) {
+      const instance = await aCase(`pick-${round}`)
+
+      const [assigned, picked] = await Promise.allSettled([
+        db.transaction(toPool(instance, finance)),
+        db.transaction((tx: any) => pick(instance.id, as(outsider)(tx)))
+      ])
+      refusedByName([assigned, picked])
+
+      const threads = await threadsOf(instance)
+      const after = await reread(instance)
+      endings.push(`assign ${assigned.status} · pick ${picked.status}`)
+
+      expect([assigned.status, picked.status].filter(status => status === 'fulfilled').length).toBe(1)
+
+      if (picked.status === 'fulfilled') {
+        expect(threads.map((thread: any) => [thread.state, thread.assigneeId])).toEqual([['assigned', outsider.id]])
+        expect(poolOf(after)).toEqual([])
+      } else {
+        expect(threads.map((thread: any) => thread.state)).toEqual(['unassigned'])
+        expect(poolOf(after)).toEqual([finance.id])
+      }
+    }
+
+    console.log('endings', [...new Set(endings)].join(' · '))
+  }, 120000)
+
+  it('moving a pool while a member of it claims the waiting thread: exactly one wins', async () => {
+    const endings: string[] = []
+
+    for (let round = 0; round < 20; round++) {
+      const instance = await aCase(`claim-${round}`)
+      await db.transaction(toPool(instance, finance))
+      const [waiting] = await threadsOf(instance)
+
+      const [moved, claimed] = await Promise.allSettled([
+        db.transaction(toPool(instance, support)),
+        db.transaction((tx: any) => start(waiting.id, {}, '', as(inFinance)(tx)))
+      ])
+      refusedByName([moved, claimed])
+
+      const threads = await threadsOf(instance)
+      const after = await reread(instance)
+      endings.push(`move ${moved.status} · claim ${claimed.status}`)
+
+      expect([moved.status, claimed.status].filter(status => status === 'fulfilled').length).toBe(1)
+      expect(threads.length).toBe(1)
+
+      if (claimed.status === 'fulfilled') {
+        expect([threads[0].state, threads[0].assigneeId]).toEqual(['started', inFinance.id])
+        expect(poolOf(after)).toEqual([finance.id])
+      } else {
+        expect([threads[0].state, threads[0].assigneeId || null]).toEqual(['unassigned', null])
+        expect(poolOf(after)).toEqual([support.id])
+      }
+    }
+
+    console.log('endings', [...new Set(endings)].join(' · '))
+  }, 120000)
+})

package/tests/work-door.test.ts

@@ -154,18 +154,18 @@ describe('work door standing', () => {
    * door reaches nobody. One shared sentence would leave the reader with the wrong action.
    */
   it('says an unassigned door reaches nobody, not that it passes through', () => {
-    const door = judgeDoor(assignment('작업 지시 배정', { installed: { assigneeRole: undefined } }))
+    const door = judgeDoor(assignment('작업 지시 배정', { installed: { assigneeRoles: [] } }))
 
     assert.equal(door.standing, 'off')
     assert.equal(door.reason, 'no-assignee')
   })
 
   it('reads a bound role as standing and names it', () => {
-    const door = judgeDoor(assignment('정비 배정', { installed: { assigneeRole: 'MAINTENANCE-LEAD' } }))
+    const door = judgeDoor(assignment('정비 배정', { installed: { assigneeRoles: ['MAINTENANCE-LEAD', 'SHIFT-LEAD'] } }))
 
     assert.equal(door.standing, 'on')
     assert.equal(door.reason, 'assignee-bound')
-    assert.equal(door.assigneeRole, 'MAINTENANCE-LEAD')
+    assert.deepEqual(door.assigneeRoles, ['MAINTENANCE-LEAD', 'SHIFT-LEAD'])
   })
 
   /** An approval line on an assignment door is not what fills it, and must not read as standing. */

package/translations/en.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "this task ({id}) has already been terminated with the {state} status.",
   "error.activity-instance approval line is set": "this task already has its approval line; it is set on the task's detail screen.",
   "error.activity-instance assignee not in this domain": "these are not people of this site: {emails}",
+  "error.activity-instance a role is not an assignee": "a role cannot be an assignee - it would go to one person of the role. to give it to anyone of the role, set the assignee role.",
+  "error.activity-instance assign people or a role, not both": "assign it to people or to a role, not both at once.",
+  "error.activity-instance role not in this domain": "this role is not of this site: {role}",
+  "error.activity-instance assignee role named twice": "the same role is named more than once: {role}. name each role once.",
+  "error.activity-instance role has no members": "nobody holds the role {role}, so nobody would see this task. add people to the role first.",
   "error.activity-instance draft is gone": "this draft went out or was thrown away in the meantime. please read the list again.",
   "error.activity-instance not found": "this task ({activityInstance}) cannot be found.",
   "error.activity-instance not a draft any more": "this draft has already gone out, so it cannot be thrown away.",

package/translations/es.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "esta tarea ({id}) ya finalizó con el estado {state}.",
   "error.activity-instance approval line is set": "esta tarea ya tiene su línea de aprobación; se configura en la pantalla de detalle de la tarea.",
   "error.activity-instance assignee not in this domain": "estas personas no pertenecen a este sitio: {emails}",
+  "error.activity-instance a role is not an assignee": "un rol no puede ser asignado: llegaría a una sola persona del rol. para dárselo a cualquiera del rol, indique el rol asignado.",
+  "error.activity-instance assign people or a role, not both": "asígnelo a personas o a un rol, no a ambos a la vez.",
+  "error.activity-instance role not in this domain": "este rol no pertenece a este sitio: {role}",
+  "error.activity-instance assignee role named twice": "el mismo rol aparece más de una vez: {role}. indique cada rol una sola vez.",
+  "error.activity-instance role has no members": "nadie tiene el rol {role}, así que nadie vería esta tarea. añada personas al rol primero.",
   "error.activity-instance draft is gone": "este borrador se envió o se descartó mientras tanto. vuelva a cargar la lista.",
   "error.activity-instance not found": "no se encuentra esta tarea ({activityInstance}).",
   "error.activity-instance not a draft any more": "este borrador ya se envió, así que no se puede descartar.",

package/translations/ja.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "このタスク({id})はすでに{state}状態で終了しています。",
   "error.activity-instance approval line is set": "この業務は決裁ラインが決まっています。決裁ラインは業務詳細で変更します。",
   "error.activity-instance assignee not in this domain": "このサイトの人ではありません: {emails}",
+  "error.activity-instance a role is not an assignee": "割当者に役割は指定できません。役割の一人にしか届きません。その役割の誰にでも任せるには割当役割を指定してください。",
+  "error.activity-instance assign people or a role, not both": "人か役割のどちらか一方に割り当ててください。",
+  "error.activity-instance role not in this domain": "このサイトの役割ではありません: {role}",
+  "error.activity-instance assignee role named twice": "同じ役割が複数回指定されています: {role}。役割はそれぞれ一度だけ指定してください。",
+  "error.activity-instance role has no members": "役割 {role} に人がいないため、誰もこの業務を見られません。先に役割に人を追加してください。",
   "error.activity-instance draft is gone": "この下書きはその間に発行されたか破棄されました。一覧を読み直してください。",
   "error.activity-instance not found": "このタスク({activityInstance})が見つかりません。",
   "error.activity-instance not a draft any more": "この下書きはすでに発行されたため、破棄できません。",

package/translations/ko.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "이 작업({id})는 이미 {state} 상태로 종료되었습니다.",
   "error.activity-instance approval line is set": "이 업무에는 결재선이 지정되어 있습니다. 업무 상세 화면에서 결재선을 변경해 주세요.",
   "error.activity-instance assignee not in this domain": "이 사업장 사람이 아닙니다: {emails}",
+  "error.activity-instance a role is not an assignee": "피할당자에는 역할을 넣을 수 없습니다. 역할 중 한 사람에게만 갑니다. 그 역할의 누구에게나 맡기려면 피할당 역할을 지정해 주세요.",
+  "error.activity-instance assign people or a role, not both": "사람과 역할 중 하나에만 할당할 수 있습니다.",
+  "error.activity-instance role not in this domain": "이 사업장의 역할이 아닙니다: {role}",
+  "error.activity-instance assignee role named twice": "같은 역할을 두 번 이상 넣었습니다: {role}. 역할마다 한 번씩만 넣어 주세요.",
+  "error.activity-instance role has no members": "{role} 역할에 사람이 없어 아무도 이 업무를 볼 수 없습니다. 먼저 역할에 사람을 넣어 주세요.",
   "error.activity-instance draft is gone": "이 초안은 그사이 발행되었거나 버려졌습니다. 목록을 새로 읽어 주십시오.",
   "error.activity-instance not found": "이 작업({activityInstance})을 찾을 수 없습니다.",
   "error.activity-instance not a draft any more": "이 초안은 이미 발행되어 버릴 수 없습니다.",

package/translations/ms.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "Tugas ini ({id}) telah tamat dengan status {state}.",
   "error.activity-instance approval line is set": "tugas ini sudah mempunyai laluan kelulusan; ia ditetapkan pada skrin butiran tugas.",
   "error.activity-instance assignee not in this domain": "ini bukan orang dalam domain ini: {emails}",
+  "error.activity-instance a role is not an assignee": "peranan tidak boleh menjadi penerima tugasan - ia akan pergi kepada seorang sahaja daripada peranan itu. untuk memberikannya kepada sesiapa dalam peranan itu, tetapkan peranan penerima.",
+  "error.activity-instance assign people or a role, not both": "tugaskan kepada orang atau kepada peranan, bukan kedua-duanya sekali.",
+  "error.activity-instance role not in this domain": "peranan ini bukan dari domain ini: {role}",
+  "error.activity-instance assignee role named twice": "peranan yang sama dinamakan lebih daripada sekali: {role}. namakan setiap peranan sekali sahaja.",
+  "error.activity-instance role has no members": "tiada sesiapa memegang peranan {role}, jadi tiada sesiapa akan melihat tugas ini. tambah orang ke peranan itu dahulu.",
   "error.activity-instance draft is gone": "draf ini telah dikeluarkan atau dibuang sementara itu. sila baca senarai semula.",
   "error.activity-instance not found": "Tugas ini ({activityInstance}) tidak dijumpai.",
   "error.activity-instance not a draft any more": "draf ini sudah dikeluarkan, jadi ia tidak boleh dibuang.",

package/translations/zh.json

@@ -38,6 +38,11 @@
   "error.activity-instance is already terminated": "此任务({id})已以{state}状态终止。",
   "error.activity-instance approval line is set": "此业务已设定审批线，请在业务详情中修改。",
   "error.activity-instance assignee not in this domain": "以下不是本站点的人员：{emails}",
+  "error.activity-instance a role is not an assignee": "角色不能作为被分配人——只会分给该角色中的一个人。要交给该角色的任何人，请指定被分配角色。",
+  "error.activity-instance assign people or a role, not both": "只能分配给人员或角色之一，不能同时分配。",
+  "error.activity-instance role not in this domain": "此角色不属于本站点：{role}",
+  "error.activity-instance assignee role named twice": "同一角色被指定了多次：{role}。每个角色只能指定一次。",
+  "error.activity-instance role has no members": "角色 {role} 中没有人员，没有人能看到此任务。请先为该角色添加人员。",
   "error.activity-instance draft is gone": "此草稿在此期间已发布或已丢弃，请重新读取列表。",
   "error.activity-instance not found": "未找到此任务({activityInstance})。",
   "error.activity-instance not a draft any more": "此草稿已发布，无法丢弃。",