@things-factory/worklist 10.1.221 → 10.1.222

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/worklist",
-  "version": "10.1.221",
+  "version": "10.1.222",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "exports": {
@@ -59,10 +59,11 @@
     "@things-factory/board-service": "^10.1.218",
     "@things-factory/context-ui": "^10.1.221",
     "@things-factory/i18n-base": "^10.1.218",
-    "@things-factory/organization": "^10.1.218",
+    "@things-factory/notification": "^10.1.222",
+    "@things-factory/organization": "^10.1.222",
     "@things-factory/personalization": "^10.1.218",
     "@things-factory/scheduler-client": "^10.1.218",
     "@things-factory/shell": "^10.1.208"
   },
-  "gitHead": "90e211d7a2c99216e017bd19a62e1703b20f2710"
+  "gitHead": "afdd6a9b1c8b440e39d4fec48bfbad1a0c02fccc"
 }

package/tests/approval-notice-db.test.ts

@@ -0,0 +1,180 @@
+import { join } from 'path'
+
+/**
+ * The approval notice through the real controllers on sqlite (ADR-0164).
+ *
+ * What the pure rules (test/approval-notice.test.ts) cannot show: the four controllers hand notification a notice
+ * for the right people once the transaction has committed - nothing before, and nothing when it rolls back. The
+ * channels themselves are notification's (packages/notification/tests/notice-delivery.test.ts); here the in-app
+ * `notify` of the request is a fake and the domain has no mail or Teams turned on.
+ *
+ * Reads dist-server - run the package's build:server first. The jest env has no translations, so the words are keys.
+ */
+
+const { createSqliteTestDataSource } = require(join(__dirname, '..', '..', 'ops-master', 'test', 'support', 'database.cjs'))
+const DIST = join(__dirname, '..', 'dist-server')
+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 { approve } = require(join(DIST, 'controllers', 'activity-approval', 'approve.js'))
+const { reject } = require(join(DIST, 'controllers', 'activity-approval', 'reject.js'))
+const { delegate } = require(join(DIST, 'controllers', 'activity-approval', 'delegate.js'))
+const { Activity } = require(join(DIST, 'service', 'activity', 'activity.js'))
+const { Domain } = require('@things-factory/shell')
+const { Role, User } = require('@things-factory/auth-base')
+const { Employee } = require('@things-factory/organization')
+
+let db: any
+let here: any
+let first: any
+let second: any
+let requester: any
+let holderA: any
+let holderB: any
+let asleep: any
+let reviewers: any
+let leave: any
+const seats: Record<string, any> = {}
+
+beforeAll(async () => {
+  db = createSqliteTestDataSource([ActivityInstance, ActivityThread, ActivityApproval, Activity, Employee])
+  await db.initialize()
+
+  here = await db.getRepository(Domain).save({ name: 'here', subdomain: 'here' })
+
+  const person = (name: string, status = 'activated') =>
+    db.getRepository(User).save({ name, email: `${name}@example.com`, password: 'x', status, userType: 'user', locale: 'ko-KR', domains: [here] })
+
+  first = await person('first')
+  second = await person('second')
+  requester = await person('requester')
+  holderA = await person('holderA')
+  holderB = await person('holderB')
+  asleep = await person('asleep', 'inactive')
+  reviewers = await db.getRepository(Role).save({ name: 'reviewers', domain: here, users: [holderA, holderB, asleep] })
+  leave = await db.getRepository(Activity).save({ domain: here, name: 'Leave' })
+
+  /* the approval line names people as employees of this domain, and a role by its id */
+  const employee = async (user: any, controlNo: string) =>
+    ({ type: 'Employee', value: (await db.getRepository(Employee).save({ domain: here, controlNo, name: user.name, user, active: true })).id })
+  seats.first = await employee(first, 'E1')
+  seats.second = await employee(second, 'E2')
+  seats.reviewers = { type: 'Role', value: reviewers.id }
+})
+
+afterAll(async () => db?.destroy())
+
+/** A submitted case whose line is the named seats, with `first`'s seat pending. */
+async function aCase(line = ['first', 'second']) {
+  const instance = await db.getRepository(ActivityInstance).save({
+    domain: here,
+    name: '휴가 신청 — requester',
+    state: 'started',
+    activity: leave,
+    issuer: requester,
+    approvalLine: line.map(name => seats[name])
+  })
+  const thread = await db.getRepository(ActivityThread).save({
+    domain: here,
+    name: 't',
+    round: 1,
+    state: 'submitted',
+    activityInstance: instance,
+    assignee: requester
+  })
+  const seat = await db.getRepository(ActivityApproval).save({
+    domain: here,
+    activityThread: thread,
+    approver: first,
+    order: 1,
+    round: 1,
+    judgment: '',
+    participation: 'approval'
+  })
+  return { instance, thread, seat }
+}
+
+/** Runs `work` as `user` in a transaction with an after-commit list, then the list - as the @transaction directive does. */
+async function asRequest(user: any, work: (context: any) => Promise<any>, { rollback = false } = {}) {
+  const told: any[] = []
+  const afterCommit: { name: string; run: () => unknown }[] = []
+  let toldBeforeCommit = -1
+
+  try {
+    await db.transaction(async (tx: any) => {
+      const context = { state: { domain: here, user, tx, afterCommit, notify: (payload: any) => void told.push(payload) }, t: (key: string) => key }
+      await work(context)
+      toldBeforeCommit = told.length
+      if (rollback) throw new Error('rolled back')
+    })
+  } catch (error) {
+    if (!rollback) throw error
+    return { told, toldBeforeCommit, afterCommit }
+  }
+
+  for (const step of afterCommit) await step.run()
+  /* sending does not hold the request - let it finish */
+  for (let i = 0; i < 20 && told.length === 0; i++) await new Promise(resolve => setTimeout(resolve, 5))
+  await new Promise(resolve => setTimeout(resolve, 20))
+
+  return { told, toldBeforeCommit, afterCommit }
+}
+
+const foreground = (told: any[]) => told.filter(one => one.mode === 'foreground')
+
+it('an approval with someone after it tells the next approver their turn, after the commit', async () => {
+  const { seat } = await aCase()
+
+  const { told, toldBeforeCommit } = await asRequest(first, context => approve({ id: seat.id, comment: 'ok' }, context))
+
+  expect(toldBeforeCommit).toBe(0)
+  expect(foreground(told)).toHaveLength(1)
+  expect(foreground(told)[0]).toMatchObject({ receivers: [second.id], type: 'approval', subject: 'info', title: 'approval-notice.request.subject' })
+  expect(foreground(told)[0].url).toMatch(/^activity-approval\/[0-9a-f-]+$/)
+  expect(told.filter(one => one.mode === 'background')).toHaveLength(1)
+})
+
+it('the last approval tells the requester it is approved', async () => {
+  const { seat, thread } = await aCase(['first'])
+
+  const { told } = await asRequest(first, context => approve({ id: seat.id, comment: 'ok' }, context))
+
+  expect(foreground(told)).toEqual([
+    expect.objectContaining({ receivers: [requester.id], title: 'approval-notice.approved.subject', url: `activity-thread-view/${thread.id}` })
+  ])
+})
+
+it('a rejection tells the requester, as a warning, and opens the thread to revise', async () => {
+  const { seat, thread } = await aCase()
+
+  const { told } = await asRequest(first, context => reject({ id: seat.id, comment: 'no' }, context))
+
+  expect(foreground(told)).toEqual([
+    expect.objectContaining({ receivers: [requester.id], subject: 'warn', title: 'approval-notice.rejected.subject', url: `activity-thread/${thread.id}` })
+  ])
+})
+
+it('a handed seat tells the person it was handed to', async () => {
+  const { seat } = await aCase()
+
+  const { told } = await asRequest(first, context => delegate({ id: seat.id, to: { id: second.id }, comment: 'away' }, context))
+
+  expect(foreground(told)).toEqual([expect.objectContaining({ receivers: [second.id], title: 'approval-notice.delegated.subject' })])
+})
+
+it('a seat held by a role tells every active holder, each alone', async () => {
+  const { seat } = await aCase(['first', 'reviewers'])
+
+  const { told } = await asRequest(first, context => approve({ id: seat.id, comment: 'ok' }, context))
+
+  expect(foreground(told).map(one => one.receivers).sort()).toEqual([[holderA.id], [holderB.id]].sort())
+})
+
+it('a rolled-back judgment tells nobody', async () => {
+  const { seat } = await aCase()
+
+  const { told, afterCommit } = await asRequest(first, context => reject({ id: seat.id, comment: 'no' }, context), { rollback: true })
+
+  expect(afterCommit.length).toBeGreaterThan(0)
+  expect(told).toEqual([])
+})

package/translations/en.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "Putting up approvals",
   "task.worklist.submit-approvals.description": "Reads the kinds of work and puts a case up for approval. Opens only the cases one put up or stands on the line of.",
   "task.worklist.all-cases-reading.name": "Reading every approval case",
-  "task.worklist.all-cases-reading.description": "Reads every case and its input, whoever put it up."
+  "task.worklist.all-cases-reading.description": "Reads every case and its input, whoever put it up.",
+  "approval-notice.request.subject": "[Approval request] {name}",
+  "approval-notice.request.body": "It is your turn to approve \"{name}\", raised by {requester}. Step {step} of {steps} on the approval line.",
+  "approval-notice.delegated.subject": "[Approval handed to you] {name}",
+  "approval-notice.delegated.body": "{actor} handed you the approval of \"{name}\", raised by {requester}. Step {step} of {steps} on the approval line.",
+  "approval-notice.reference.subject": "[For reference] {name}",
+  "approval-notice.reference.body": "You were added as a reference to \"{name}\", raised by {requester}.",
+  "approval-notice.approved.subject": "[Approved] {name}",
+  "approval-notice.approved.body": "The approval of \"{name}\" is complete. {actor} gave the last approval.",
+  "approval-notice.rejected.subject": "[Rejected] {name}",
+  "approval-notice.rejected.body": "{actor} rejected \"{name}\". You can revise and raise it again, or abort it.",
+  "approval-notice.open-approval": "Open the approval",
+  "approval-notice.open-request": "Open the request",
+  "approval-notice.see-approval-box": "You can find it in your approval box.",
+  "approval-notice.see-request-box": "You can find it in your to-do list."
 }

package/translations/es.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "Enviar aprobaciones",
   "task.worklist.submit-approvals.description": "Lee los tipos de trabajo y envía casos a aprobación. Solo abre los casos que uno envió o en cuya línea figura.",
   "task.worklist.all-cases-reading.name": "Leer todos los casos de aprobación",
-  "task.worklist.all-cases-reading.description": "Lee todos los casos y sus datos, sin importar quién los envió."
+  "task.worklist.all-cases-reading.description": "Lee todos los casos y sus datos, sin importar quién los envió.",
+  "approval-notice.request.subject": "[Solicitud de aprobación] {name}",
+  "approval-notice.request.body": "Le toca aprobar \"{name}\", enviado por {requester}. Paso {step} de {steps} de la línea de aprobación.",
+  "approval-notice.delegated.subject": "[Aprobación delegada] {name}",
+  "approval-notice.delegated.body": "{actor} le delegó la aprobación de \"{name}\", enviado por {requester}. Paso {step} de {steps} de la línea de aprobación.",
+  "approval-notice.reference.subject": "[Para referencia] {name}",
+  "approval-notice.reference.body": "Se le añadió como referencia en \"{name}\", enviado por {requester}.",
+  "approval-notice.approved.subject": "[Aprobado] {name}",
+  "approval-notice.approved.body": "La aprobación de \"{name}\" ha terminado. {actor} dio la última aprobación.",
+  "approval-notice.rejected.subject": "[Rechazado] {name}",
+  "approval-notice.rejected.body": "{actor} rechazó \"{name}\". Puede corregirlo y enviarlo de nuevo, o cancelarlo.",
+  "approval-notice.open-approval": "Abrir la aprobación",
+  "approval-notice.open-request": "Abrir la solicitud",
+  "approval-notice.see-approval-box": "Puede verlo en su bandeja de aprobaciones.",
+  "approval-notice.see-request-box": "Puede verlo en su lista de tareas."
 }

package/translations/ja.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "決裁の上申",
   "task.worklist.submit-approvals.description": "業務の種類を見て決裁を上申する。自分が上申したか決裁線に入っている決裁だけを開く。",
   "task.worklist.all-cases-reading.name": "全決裁の閲覧",
-  "task.worklist.all-cases-reading.description": "誰が上申したかに関係なく、すべての決裁とその入力値を読む。"
+  "task.worklist.all-cases-reading.description": "誰が上申したかに関係なく、すべての決裁とその入力値を読む。",
+  "approval-notice.request.subject": "[承認依頼] {name}",
+  "approval-notice.request.body": "{requester}さんが申請した「{name}」の承認順になりました。承認ライン {steps} 段階中 {step} 段階目です。",
+  "approval-notice.delegated.subject": "[承認の委任] {name}",
+  "approval-notice.delegated.body": "{actor}さんが「{name}」の承認を委任しました。申請者は{requester}さん、承認ライン {steps} 段階中 {step} 段階目です。",
+  "approval-notice.reference.subject": "[参照] {name}",
+  "approval-notice.reference.body": "{requester}さんが申請した「{name}」の参照者に指定されました。",
+  "approval-notice.approved.subject": "[承認完了] {name}",
+  "approval-notice.approved.body": "「{name}」の承認が完了しました。最終承認は{actor}さんです。",
+  "approval-notice.rejected.subject": "[差し戻し] {name}",
+  "approval-notice.rejected.body": "{actor}さんが「{name}」を差し戻しました。修正して再申請するか、中止できます。",
+  "approval-notice.open-approval": "承認画面を開く",
+  "approval-notice.open-request": "申請を開く",
+  "approval-notice.see-approval-box": "承認ボックスで確認できます。",
+  "approval-notice.see-request-box": "やることリストで確認できます。"
 }

package/translations/ko.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "결재 올리기",
   "task.worklist.submit-approvals.description": "업무 종류를 보고 결재를 올린다. 자기가 올렸거나 결재선에 든 결재만 연다.",
   "task.worklist.all-cases-reading.name": "모든 결재 열람",
-  "task.worklist.all-cases-reading.description": "누가 올렸든 모든 결재 사례와 그 입력값을 읽는다."
+  "task.worklist.all-cases-reading.description": "누가 올렸든 모든 결재 사례와 그 입력값을 읽는다.",
+  "approval-notice.request.subject": "[결재 요청] {name}",
+  "approval-notice.request.body": "{requester}님이 올린 「{name}」을(를) 결재할 차례입니다. 결재선 {steps}단계 중 {step}단계입니다.",
+  "approval-notice.delegated.subject": "[결재 위임] {name}",
+  "approval-notice.delegated.body": "{actor}님이 「{name}」 결재를 넘겼습니다. 상신자는 {requester}님이고, 결재선 {steps}단계 중 {step}단계입니다.",
+  "approval-notice.reference.subject": "[참조] {name}",
+  "approval-notice.reference.body": "{requester}님이 올린 「{name}」에 참조로 지정되었습니다.",
+  "approval-notice.approved.subject": "[승인 완료] {name}",
+  "approval-notice.approved.body": "「{name}」의 결재가 끝났습니다. 마지막 승인은 {actor}님입니다.",
+  "approval-notice.rejected.subject": "[반려] {name}",
+  "approval-notice.rejected.body": "{actor}님이 「{name}」을(를) 반려했습니다. 고쳐서 다시 올리거나 중단할 수 있습니다.",
+  "approval-notice.open-approval": "결재 화면 열기",
+  "approval-notice.open-request": "요청 열기",
+  "approval-notice.see-approval-box": "내 결재함에서 확인할 수 있습니다.",
+  "approval-notice.see-request-box": "할 일에서 확인할 수 있습니다."
 }

package/translations/ms.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "Menghantar kelulusan",
   "task.worklist.submit-approvals.description": "Membaca jenis kerja dan menghantar kes untuk kelulusan. Hanya membuka kes yang dihantar sendiri atau yang ada dalam laluannya.",
   "task.worklist.all-cases-reading.name": "Membaca semua kes kelulusan",
-  "task.worklist.all-cases-reading.description": "Membaca semua kes dan inputnya, tidak kira siapa yang menghantarnya."
+  "task.worklist.all-cases-reading.description": "Membaca semua kes dan inputnya, tidak kira siapa yang menghantarnya.",
+  "approval-notice.request.subject": "[Permintaan kelulusan] {name}",
+  "approval-notice.request.body": "Giliran anda untuk meluluskan \"{name}\" yang dihantar oleh {requester}. Langkah {step} daripada {steps} dalam laluan kelulusan.",
+  "approval-notice.delegated.subject": "[Kelulusan diserahkan] {name}",
+  "approval-notice.delegated.body": "{actor} menyerahkan kelulusan \"{name}\" kepada anda. Pemohon {requester}, langkah {step} daripada {steps} dalam laluan kelulusan.",
+  "approval-notice.reference.subject": "[Untuk rujukan] {name}",
+  "approval-notice.reference.body": "Anda ditambah sebagai rujukan untuk \"{name}\" yang dihantar oleh {requester}.",
+  "approval-notice.approved.subject": "[Diluluskan] {name}",
+  "approval-notice.approved.body": "Kelulusan \"{name}\" telah selesai. Kelulusan terakhir oleh {actor}.",
+  "approval-notice.rejected.subject": "[Ditolak] {name}",
+  "approval-notice.rejected.body": "{actor} menolak \"{name}\". Anda boleh membetulkan dan menghantarnya semula, atau membatalkannya.",
+  "approval-notice.open-approval": "Buka kelulusan",
+  "approval-notice.open-request": "Buka permintaan",
+  "approval-notice.see-approval-box": "Anda boleh melihatnya dalam kotak kelulusan anda.",
+  "approval-notice.see-request-box": "Anda boleh melihatnya dalam senarai tugasan anda."
 }

package/translations/zh.json

@@ -380,5 +380,19 @@
   "task.worklist.submit-approvals.name": "提交审批",
   "task.worklist.submit-approvals.description": "查看工作类型并提交审批。只打开自己提交或在审批线上的案件。",
   "task.worklist.all-cases-reading.name": "查看全部审批",
-  "task.worklist.all-cases-reading.description": "无论由谁提交，读取所有审批案件及其输入。"
+  "task.worklist.all-cases-reading.description": "无论由谁提交，读取所有审批案件及其输入。",
+  "approval-notice.request.subject": "[审批请求] {name}",
+  "approval-notice.request.body": "轮到您审批 {requester} 提交的“{name}”。审批流程共 {steps} 步，这是第 {step} 步。",
+  "approval-notice.delegated.subject": "[审批转交] {name}",
+  "approval-notice.delegated.body": "{actor} 将“{name}”的审批转交给您。提交人 {requester}，审批流程共 {steps} 步，这是第 {step} 步。",
+  "approval-notice.reference.subject": "[抄送] {name}",
+  "approval-notice.reference.body": "您被设为 {requester} 提交的“{name}”的抄送人。",
+  "approval-notice.approved.subject": "[已批准] {name}",
+  "approval-notice.approved.body": "“{name}”的审批已完成。最后批准人是 {actor}。",
+  "approval-notice.rejected.subject": "[已驳回] {name}",
+  "approval-notice.rejected.body": "{actor} 驳回了“{name}”。您可以修改后重新提交，或终止。",
+  "approval-notice.open-approval": "打开审批页面",
+  "approval-notice.open-request": "打开申请",
+  "approval-notice.see-approval-box": "可在我的审批箱中查看。",
+  "approval-notice.see-request-box": "可在待办事项中查看。"
 }