@things-factory/shell 10.1.29 → 10.1.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/shell",
-  "version": "10.1.29",
+  "version": "10.1.31",
   "description": "Core module for framework",
   "bin": {
     "things-factory": "bin/things-factory",
@@ -126,5 +126,5 @@
     "pg": "^8.7.3",
     "sqlite3": "^5.0.8"
   },
-  "gitHead": "e6bf9dec003fe5e794746aaeb5852b3b50478232"
+  "gitHead": "5213e6f9913b40ea2618a2111d9884b792dbaa01"
 }

package/tests/md-sys-slot-owners.test.ts

@@ -12,11 +12,11 @@
  * compute time, so bundle order stops mattering, and a slot that is not opened cannot be reached.
  *
  * Three owners, one mechanism - no reliance on bundle order or specificity:
- *   --brand-<slot>   a product's accent (its own brand.css)                26 slots
+ *   --brand-<slot>   a product's accent (its own <product>-accent.css)     26 slots
  *   --suite-<slot>   the operato suite's shared greys (@things-factory/operato-suite)  17 slots
  *   closed           error x4, shadow, scrim - literal, nobody above the platform sets them  6 slots
  * A tenant's domain theme still wins over all of these: it writes --md-sys-color-* directly, later in
- * the bundle. Apps with neither brand.css nor the suite get the fallbacks, the shell values of before.
+ * the bundle. Apps with neither an accent file nor the suite get the fallbacks, the shell values of before.
  *
  * If md adds a slot the counts go red on purpose: someone has to decide whose it is.
  */

package/tests/refusal.test.ts

@@ -0,0 +1,63 @@
+/**
+ * A refusal keeps its name on the way out, and gets its sentence from the caller's language.
+ *
+ * ── Why these four ────────────────────────────────────────────────────────
+ * The code is the contract (ADR-0042): a client reads `extensions.refusal.code` and decides what to
+ * show. If Apollo's own `code` were left empty it would read `INTERNAL_SERVER_ERROR`, and a refusal
+ * would look like a crash. If `t` were called without params the locale would be lost and a Korean
+ * reader would get English with no error anywhere. If a module has not declared the key, the English
+ * sentence has to win over the key printed raw.
+ *
+ * Moved here from operato-plant when worklist became the third consumer (ADR-0069 decision 3).
+ */
+
+import { GraphQLError } from 'graphql'
+
+import { Refusal, refusalKey, rethrowSpoken, speakRefusal } from '../server/refusal/refusal.js'
+
+const refusal = () => new Refusal('approval-line-missing', { role: 'quality' }, 'no approval line stands for quality.')
+
+describe('a refusal on the way out', () => {
+  it('carries its own name, and says the server refused on purpose', () => {
+    const error = speakRefusal(refusal(), {})
+
+    expect(error).toBeInstanceOf(GraphQLError)
+    expect(error.extensions.code).toBe('BAD_USER_INPUT')
+    expect(error.extensions.refusal).toEqual({ code: 'approval-line-missing', params: { role: 'quality' } })
+  })
+
+  it('asks for error.<code> and hands the values over, never undefined', () => {
+    const asked: Array<{ key: string; options?: Record<string, unknown> }> = []
+    const t = (key: string, options?: Record<string, unknown>) => {
+      asked.push({ key, options })
+      return '품질 결재선이 비어 있습니다.'
+    }
+
+    const error = speakRefusal(refusal(), { t })
+
+    expect(asked).toHaveLength(1)
+    expect(asked[0].key).toBe(refusalKey('approval-line-missing'))
+    /* `t(key, undefined)` answers in English however the request came in, so the values always travel. */
+    expect(asked[0].options).toEqual({ role: 'quality', defaultValue: 'no approval line stands for quality.' })
+    expect(error.message).toBe('품질 결재선이 비어 있습니다.')
+  })
+
+  it('reads as English when the module has not declared the key', () => {
+    /* i18next answers with defaultValue when the key is missing; a missing key must not print itself. */
+    const t = (_key: string, options?: Record<string, unknown>) => String(options?.defaultValue ?? _key)
+
+    expect(speakRefusal(refusal(), { t }).message).toBe('no approval line stands for quality.')
+  })
+})
+
+describe('rethrowSpoken', () => {
+  it('speaks a refusal', () => {
+    expect(() => rethrowSpoken(refusal(), {})).toThrow(GraphQLError)
+  })
+
+  it('leaves anything else exactly as it was - a crash is not a refusal', () => {
+    const crash = new TypeError('cannot read properties of undefined')
+
+    expect(() => rethrowSpoken(crash, {})).toThrow(crash)
+  })
+})

package/tests/theme-file-names.test.ts

@@ -0,0 +1,90 @@
+/**
+ * A theme file carries its owner's name - `themes/` is one namespace shared by every module.
+ *
+ * The builder's ThemeOverridePlugin collects `client/themes/*.css` from every module and keeps the
+ * FIRST file it meets for each file name, application first (webpack-plugins/theme-override-plugin.js).
+ * It never looks inside. So a module that ships `light.css` replaces the shell's `light.css` whole -
+ * including the 49 slots the shell opens as `var(--brand-*)` / `var(--suite-*)`, and including any
+ * fix made there later. A file with one declaration in it does that just as completely as a full
+ * palette.
+ *
+ * Hence the rule (ADR-0060 decision 2-1): inside things-factory only the shell carries the names of
+ * the shell's theme files. A product that means to replace one of them wholesale may still do it -
+ * that is what an application's own light.css was - but then it owns all 49 slots and stops
+ * receiving anything the platform decides.
+ *
+ * The exceptions below are named, with what has to happen for each to go. When one is dealt with
+ * this test goes red and the line gets deleted - that is the point of listing them rather than
+ * filtering them out.
+ */
+
+import { readdirSync, existsSync } from 'fs'
+import path from 'path'
+
+const PACKAGES = path.resolve(__dirname, '..', '..')
+const SHELL_THEMES = path.resolve(__dirname, '..', 'client', 'themes')
+
+/**
+ * Files that carry a shell theme file's name today.
+ *
+ * - The generator templates are copied into a new application, so a new product is born replacing
+ *   the shell theme - operato-warehouse was born that way. They are fixed once the four operato
+ *   products have moved.
+ */
+const KNOWN: string[] = [
+  'generator/templates/app/client/themes/dark.css',
+  'generator/templates/app/client/themes/light.css',
+  'generator/templates/brand/client/themes/dark.css',
+  'generator/templates/brand/client/themes/light.css'
+]
+
+/** Every `client/themes/*.css` under packages, as a path relative to packages. */
+function themeFiles(): string[] {
+  const found: string[] = []
+
+  const walk = (dir: string) => {
+    for (const entry of readdirSync(dir, { withFileTypes: true })) {
+      if (entry.name === 'node_modules' || entry.name.startsWith('.') || entry.name.startsWith('dist')) {
+        continue
+      }
+
+      const full = path.join(dir, entry.name)
+
+      if (entry.isDirectory()) {
+        walk(full)
+      } else if (entry.name.endsWith('.css') && path.basename(path.dirname(full)) === 'themes') {
+        if (path.basename(path.dirname(path.dirname(full))) === 'client') {
+          found.push(path.relative(PACKAGES, full))
+        }
+      }
+    }
+  }
+
+  walk(PACKAGES)
+
+  return found.sort()
+}
+
+describe('theme file names', () => {
+  it('finds the theme files at all - an empty scan would pass everything below', () => {
+    const files = themeFiles()
+
+    expect(files.length).toBeGreaterThan(20)
+    expect(files).toContain(path.join('shell', 'client', 'themes', 'light.css'))
+  })
+
+  it('only the shell carries the names of the shell theme files', () => {
+    const shellNames = new Set(readdirSync(SHELL_THEMES))
+    const collisions = themeFiles().filter(
+      file => !file.startsWith(`shell${path.sep}`) && shellNames.has(path.basename(file))
+    )
+
+    expect(collisions).toEqual(KNOWN.map(file => file.split('/').join(path.sep)))
+  })
+
+  it('every exception still exists - a stale line hides the next collision', () => {
+    for (const file of KNOWN) {
+      expect(existsSync(path.join(PACKAGES, file.split('/').join(path.sep)))).toBe(true)
+    }
+  })
+})