@things-factory/organization 10.1.167 → 10.1.168

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/organization",
-  "version": "10.1.167",
+  "version": "10.1.168",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -41,5 +41,5 @@
     "@things-factory/contact": "^10.1.167",
     "@things-factory/shell": "^10.1.165"
   },
-  "gitHead": "86283c5d35042880be6827f777067fc5e6417eed"
+  "gitHead": "fe067ff11d90effffc2523374453d9b8313b489f"
 }

package/tests/approval-line-edit.test.ts

@@ -0,0 +1,78 @@
+import {
+  lineAfterCopy,
+  lineFromRows,
+  participationChoice,
+  PARTICIPATION_CHOICES
+} from '../client/component/approval-line-edit'
+
+const ROLE = { id: 'role-1', name: '대표' }
+const PERSON = { id: 'employee-1', name: '홍길동' }
+
+describe('the line the editor hands on is read off the rows on screen', () => {
+  it('keeps type, approver, participation and notifyAfter, in row order', () => {
+    expect(
+      lineFromRows([
+        { type: 'Role', approver: ROLE, participation: '' },
+        { type: 'Employee', approver: PERSON, participation: 'reference', notifyAfter: '2' }
+      ])
+    ).toEqual([
+      { type: 'Role', approver: ROLE, participation: undefined, notifyAfter: undefined },
+      { type: 'Employee', approver: PERSON, participation: 'reference', notifyAfter: 2 }
+    ])
+  })
+
+  it('drops a row with no type - an added row nobody filled', () => {
+    expect(lineFromRows([{ type: 'Role', approver: ROLE }, { approver: PERSON }, {}])).toHaveLength(1)
+  })
+
+  it('reads the API spelling of a reference', () => {
+    expect(lineFromRows([{ type: 'Role', approver: ROLE, participation: 'Reference' }])[0].participation).toBe('reference')
+  })
+
+  it('no rows: an empty line', () => {
+    expect(lineFromRows(undefined)).toEqual([])
+  })
+})
+
+describe('copying a saved line', () => {
+  const current = [{ type: 'Role', approver: ROLE }] as any
+
+  it('nothing picked: the line being edited stays as it is', () => {
+    expect(lineAfterCopy(current, undefined)).toBe(current)
+  })
+
+  it('emptied on purpose: an empty line', () => {
+    expect(lineAfterCopy(current, null)).toEqual([])
+  })
+
+  it('a picked line comes over with its reference steps and their notify point', () => {
+    const picked = {
+      model: [
+        { type: 'Role', approver: ROLE },
+        { type: 'Employee', approver: PERSON, participation: 'Reference', notifyAfter: 1 }
+      ]
+    } as any
+
+    expect(lineAfterCopy(current, picked)).toEqual([
+      { type: 'Role', approver: ROLE, participation: undefined, notifyAfter: undefined },
+      { type: 'Employee', approver: PERSON, participation: 'reference', notifyAfter: 1 }
+    ])
+  })
+})
+
+describe('the participation cell names approval too', () => {
+  it('a step with nothing stored reads as approval', () => {
+    expect(participationChoice({}).key).toBe('label.participation-approval')
+    expect(participationChoice({ participation: undefined }).key).toBe('label.participation-approval')
+    expect(participationChoice({ participation: null }).key).toBe('label.participation-approval')
+  })
+
+  it('a reference reads as reference, in either spelling', () => {
+    expect(participationChoice({ participation: 'reference' }).key).toBe('label.participation-reference')
+    expect(participationChoice({ participation: 'Reference' }).key).toBe('label.participation-reference')
+  })
+
+  it('every choice the cell can draw is a choice the select offers', () => {
+    expect(PARTICIPATION_CHOICES.map(one => one.value)).toEqual(['', 'reference'])
+  })
+})

package/tests/approval-line-step-fields.test.ts

@@ -0,0 +1,108 @@
+import { readdirSync, readFileSync, statSync } from 'fs'
+import path from 'path'
+
+/**
+ * Every screen that reads an approval line step asks for every field the step carries.
+ *
+ * The approval line editor keeps `type`, `approver`, `participation` and `notifyAfter` of a step
+ * (approval-line-edit's lineFromRows; `value` is left to `approver` on purpose). Screens asked for
+ * some of them. A screen that reopens a line and saves it again
+ * writes back only what it read, so a missing `participation` turns a reference step into an
+ * approver and a missing `notifyAfter` wipes the notify point - with no error. Found so far: the
+ * worklist screens (notifyAfter, twelve selections), the copy-from selector and the two template
+ * pages here (both), and meta-ui's activity definition (both).
+ *
+ * A gql`` document is a template literal, so type checking cannot see a missing field. This reads the
+ * documents of every package's client: any `approvalLine { }` or `model { }` selection that asks for
+ * `approver` is a step selection.
+ */
+
+const packagesDir = path.resolve(__dirname, '../..')
+
+function sources(dir: string): string[] {
+  return readdirSync(dir).flatMap(name => {
+    if (name === 'node_modules' || name.startsWith('dist')) {
+      return []
+    }
+
+    const file = path.join(dir, name)
+
+    if (statSync(file).isDirectory()) {
+      return sources(file)
+    }
+
+    return file.endsWith('.ts') ? [file] : []
+  })
+}
+
+/** The top-level field names of each `approvalLine { }` / `model { }` selection in a source. */
+function selections(source: string): string[][] {
+  const found: string[][] = []
+
+  for (const match of source.matchAll(/\b(?:approvalLine|model)\s*\{/g)) {
+    const fields: string[] = []
+    let depth = 0
+    let word = ''
+
+    const take = () => {
+      if (depth === 1 && word) fields.push(word)
+      word = ''
+    }
+
+    for (let at = match.index! + match[0].length - 1; at < source.length; at++) {
+      const char = source[at]
+
+      if (char === '{') {
+        take()
+        depth++
+      } else if (char === '}') {
+        take()
+        if (!--depth) break
+      } else if (/\w/.test(char)) {
+        word += char
+      } else {
+        take()
+      }
+    }
+
+    found.push(fields)
+  }
+
+  return found
+}
+
+/** What the editor keeps of a step - read less and the next save loses the rest. */
+const STEP_FIELDS = ['type', 'participation', 'notifyAfter', 'approver']
+
+const clients = readdirSync(packagesDir)
+  .map(name => path.join(packagesDir, name, 'client'))
+  .filter(dir => statSync(path.dirname(dir)).isDirectory() && readdirSync(path.dirname(dir)).includes('client'))
+
+const screens = clients
+  .flatMap(sources)
+  .map(file => ({
+    file: path.relative(packagesDir, file),
+    steps: selections(readFileSync(file, 'utf-8')).filter(fields => fields.includes('approver'))
+  }))
+  .filter(one => one.steps.length)
+
+describe('every screen that reads an approval line step asks for all of its fields', () => {
+  it('the scan finds the screens', () => {
+    expect(screens.map(one => one.file)).toEqual(
+      expect.arrayContaining([
+        'organization/client/component/approval-line-selector.ts',
+        'organization/client/pages/approval-line/my-approval-line-templates-page.ts',
+        'worklist/client/pages/activity-catalog/activity-detail-page.ts'
+      ])
+    )
+  })
+
+  it.each(screens.map(one => [one.file, one.steps] as [string, string[][]]))('%s', (file, steps) => {
+    for (const fields of steps) {
+      expect({ asks: fields, missing: STEP_FIELDS.filter(field => !fields.includes(field)) }).toEqual({
+        asks: fields,
+        missing: []
+      })
+    }
+  })
+})