@things-factory/shell 10.1.188 → 10.1.206

package/tests/empty-membership.test.ts

@@ -0,0 +1,117 @@
+import 'reflect-metadata'
+import { Column, DataSource, Entity, PrimaryColumn, Repository } from 'typeorm'
+
+import { buildCondition } from '../server/utils/condition-builder.js'
+import { getQueryBuilderFromListParams } from '../server/utils/get-query-builder-from-list-params.js'
+import { ListParam } from '../server/service/common-types/list-param.js'
+
+/**
+ * A list membership filter with an empty list: `in []` matches nothing, `notin []` and `notin_with_null []`
+ * constrain nothing.
+ *
+ * The board list once sent `state in []`. Both builders wrote it as `IN ()`, which postgres refuses as a syntax
+ * error, so the whole list failed in production. sqlite accepts `IN ()`, so a sqlite run alone never sees it: the
+ * postgres SQL is checked from the dialect without a server, and run on a real one when SHELL_PG_URL names it:
+ *
+ *   docker run -d --name shell-pg -e POSTGRES_PASSWORD=shell -e POSTGRES_USER=shell -e POSTGRES_DB=shell \
+ *     -p 55434:5432 postgres:14-alpine
+ *   SHELL_PG_URL=postgres://shell:shell@localhost:55434/shell npx jest tests/empty-membership.test.ts
+ */
+
+@Entity()
+class Gadget {
+  @PrimaryColumn({ type: 'integer' })
+  id!: number
+
+  @Column({ type: 'text', nullable: true })
+  state!: string | null
+}
+
+const ROWS = [
+  { id: 1, state: 'draft' },
+  { id: 2, state: 'released' },
+  { id: 3, state: null }
+]
+
+const CASES: [operator: string, expected: number[]][] = [
+  ['in', []],
+  ['notin', [1, 2, 3]],
+  ['notin_with_null', [1, 2, 3]]
+]
+
+function listParamsQuery(repository: Repository<Gadget>, operator: string, value: any) {
+  const params = { filters: [{ name: 'state', operator, value }], pagination: { page: 1, limit: 10 } } as unknown as ListParam
+  return getQueryBuilderFromListParams({ repository, params })
+}
+
+function conditionQuery(repository: Repository<Gadget>, operator: string, value: any) {
+  const queryBuilder = repository.createQueryBuilder('gadget')
+  const { clause, parameters } = buildCondition('gadget', 'state', operator, value, false, 0) as any
+  return queryBuilder.andWhere(clause, parameters)
+}
+
+const BUILDERS = [
+  ['getQueryBuilderFromListParams', listParamsQuery],
+  ['buildCondition', conditionQuery]
+] as const
+
+async function idsOf(query: ReturnType<typeof conditionQuery>): Promise<number[]> {
+  return (await query.getMany()).map(row => row.id).sort((a, b) => a - b)
+}
+
+/** What each builder reads from the same rows on a database that runs the SQL. */
+function readsOn(describeOn: jest.Describe, title: string, options: () => any) {
+  describeOn(title, () => {
+    let dataSource: DataSource
+    let repository: Repository<Gadget>
+
+    beforeAll(async () => {
+      dataSource = new DataSource({ ...options(), synchronize: true, entities: [Gadget] })
+      await dataSource.initialize()
+      repository = dataSource.getRepository(Gadget)
+      await repository.save(ROWS)
+    })
+
+    afterAll(async () => {
+      await dataSource?.destroy()
+    })
+
+    describe.each(BUILDERS)('%s', (_, query) => {
+      it.each(CASES)('%s [] reads %j', async (operator, expected) => {
+        expect(await idsOf(query(repository, operator, []))).toEqual(expected)
+      })
+
+      it('a list with a choice still filters by it', async () => {
+        expect(await idsOf(query(repository, 'in', ['draft']))).toEqual([1])
+        expect(await idsOf(query(repository, 'notin', ['draft']))).toEqual([2])
+        expect(await idsOf(query(repository, 'notin_with_null', ['draft']))).toEqual([2, 3])
+      })
+    })
+  })
+}
+
+readsOn(describe, 'an empty membership list on sqlite', () => ({ type: 'better-sqlite3', database: ':memory:' }))
+
+describe('an empty membership list in postgres SQL, without a server', () => {
+  let repository: Repository<Gadget>
+
+  beforeAll(async () => {
+    const dataSource = new DataSource({ type: 'postgres', host: 'localhost', database: 'unused', entities: [Gadget] })
+    await (dataSource as any).buildMetadatas()
+    repository = dataSource.getRepository(Gadget)
+  })
+
+  describe.each(BUILDERS)('%s', (_, query) => {
+    it.each(CASES)('%s [] writes no empty IN list', operator => {
+      const [sql] = query(repository, operator, []).getQueryAndParameters()
+      expect(sql).not.toMatch(/IN \(\s*\)/)
+    })
+  })
+})
+
+const url = process.env.SHELL_PG_URL
+readsOn(url ? describe : describe.skip, 'an empty membership list on postgres', () => ({
+  type: 'postgres',
+  url,
+  dropSchema: true
+}))

package/translations/en.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "resume editing",
   "button.discard": "discard",
   "figure.label.motion": "Motion",
-  "figure.text.preview-needs-a-part": "add a part to see how it looks placed on a drawing."
+  "figure.text.preview-needs-a-part": "add a part to see how it looks placed on a drawing.",
+  "error.timezone-required": "The $t(term.domain) has no timezone. Set it in $t(term.domain) management."
 }

package/translations/es.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "reanudar edición",
   "button.discard": "descartar",
   "figure.label.motion": "Movimiento",
-  "figure.text.preview-needs-a-part": "añada una pieza para ver cómo se ve colocada en un plano."
+  "figure.text.preview-needs-a-part": "añada una pieza para ver cómo se ve colocada en un plano.",
+  "error.timezone-required": "El dominio no tiene zona horaria. Configúrela en la gestión de dominios."
 }

package/translations/ja.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "編集を続ける",
   "button.discard": "破棄",
   "figure.label.motion": "Motion",
-  "figure.text.preview-needs-a-part": "部品を追加すると、図面に置いたときの姿が表示されます。"
+  "figure.text.preview-needs-a-part": "部品を追加すると、図面に置いたときの姿が表示されます。",
+  "error.timezone-required": "事業所のタイムゾーンが設定されていません。事業所管理でタイムゾーンを設定してください。"
 }

package/translations/ko.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "이어서 편집",
   "button.discard": "버리기",
   "figure.label.motion": "움직임",
-  "figure.text.preview-needs-a-part": "부품을 추가하면 도면에 놓았을 때의 모습이 표시됩니다."
+  "figure.text.preview-needs-a-part": "부품을 추가하면 도면에 놓았을 때의 모습이 표시됩니다.",
+  "error.timezone-required": "$t(term.domain) 시간대가 정해지지 않았습니다. $t(term.domain) 관리에서 시간대를 정하세요."
 }

package/translations/ms.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "sambung menyunting",
   "button.discard": "buang",
   "figure.label.motion": "Motion",
-  "figure.text.preview-needs-a-part": "tambah bahagian untuk melihat rupanya apabila diletakkan pada lukisan."
+  "figure.text.preview-needs-a-part": "tambah bahagian untuk melihat rupanya apabila diletakkan pada lukisan.",
+  "error.timezone-required": "Domain tiada zon waktu. Tetapkannya dalam pengurusan domain."
 }

package/translations/zh.json

@@ -185,5 +185,6 @@
   "button.resume-editing": "继续编辑",
   "button.discard": "放弃",
   "figure.label.motion": "Motion",
-  "figure.text.preview-needs-a-part": "添加部件后会显示放置到图面上的效果。"
+  "figure.text.preview-needs-a-part": "添加部件后会显示放置到图面上的效果。",
+  "error.timezone-required": "尚未设置单位时区。请在单位管理中设置时区。"
 }