@things-factory/figure-service 10.1.6 → 10.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/figure-service",
-  "version": "10.1.6",
+  "version": "10.1.7",
   "publishConfig": {
     "access": "public",
     "@things-factory:registry": "https://registry.npmjs.org"
@@ -25,12 +25,12 @@
   "dependencies": {
     "@hatiolab/figure-model": "^0.1.15",
     "@operato/typeorm-history": "^10.0.0",
-    "@things-factory/ai-client-base": "^10.1.6",
-    "@things-factory/auth-base": "^10.1.6",
+    "@things-factory/ai-client-base": "^10.1.7",
+    "@things-factory/auth-base": "^10.1.7",
     "@things-factory/env": "^10.1.3",
-    "@things-factory/shell": "^10.1.4",
+    "@things-factory/shell": "^10.1.7",
     "graphql-upload": "^15.0.2",
     "koa-router": "^7.4.0"
   },
-  "gitHead": "963aeb9ac470be5aea05bb5842a0a92afcab6036"
+  "gitHead": "9a036f83f5751f9e4af9180e9a0018f716a4ba27"
 }

package/server/service/figure/catalog-db.test.ts

@@ -0,0 +1,162 @@
+/**
+ * 분류와 태그가 **정말 써지는가** — sqlite 를 실제로 들고 확인한다.
+ *
+ * ── 왜 순수 시험으로는 부족한가 ─────────────────────────────────────────────
+ * 이 저장 경로는 읽어 온 엔티티를 펼쳐 `save` 한다(`{ ...figure, ...patch }`). 그 모양은 칸이
+ * **조용히 안 써지는** 자리로 알려져 있다 — `save` 는 정상 반환하고 로그도 성공이라고 말한다.
+ * 다른 레인이 도메인 시각대를 그렇게 잃었고, `select` 를 해 보기 전에는 못 찾았다.
+ *
+ * 그래서 여기서는 반환값을 믿지 않고 **저장소에서 다시 읽는다.**
+ *
+ * ── 이 하네스로 볼 수 없는 것 ───────────────────────────────────────────────
+ * sqlite 다. 동시성·격리·컬럼 타입 방언은 여기서 초록이어도 근거가 아니다. `simple-json` 이
+ * 드라이버마다 어떻게 저장되는지도 postgres 에서 따로 봐야 한다 — 여기서 보는 것은 **왕복**이다.
+ */
+import type { DataSource } from 'typeorm'
+
+const { DataSource: TypeOrmDataSource } = require('typeorm')
+const shell = require('@things-factory/shell')
+/* Figure 가 creator·updater 로 User 를 가리킨다 — 그 엔티티가 없으면 메타데이터가 안 선다. */
+const authBase = require('@things-factory/auth-base')
+
+let dataSource: DataSource | null = null
+let Figure: any
+
+/*
+  엔티티는 컴파일된 산출물에서 든다.
+
+  `@Field({ nullable: true })` 처럼 명시 타입이 없는 type-graphql 데코레이터는
+  `emitDecoratorMetadata` 가 있어야 읽히는데 jest 의 변환기는 babel 이라 그것을 못 낸다.
+  소스에서 들면 import 시점에 죽는다. auth-base 가 같은 이유로 같은 길을 간다(tests/compiled.ts).
+*/
+function loadCompiled(modulePath: string): any {
+  const { existsSync } = require('fs')
+  const { join } = require('path')
+  const resolved = join(__dirname, '..', '..', '..', 'dist-server', `${modulePath}.js`)
+
+  if (!existsSync(resolved)) {
+    throw new Error(
+      `figure-service 산출물이 없다: ${resolved}\n` +
+        `이 시험은 tsc 산출물을 든다. 먼저 빌드할 것:\n` +
+        `  yarn workspace @things-factory/figure-service build:server`
+    )
+  }
+
+  return require(resolved)
+}
+
+beforeAll(async () => {
+  Figure = loadCompiled('service/figure/figure').Figure
+
+  dataSource = new TypeOrmDataSource({
+    type: 'sqlite',
+    database: ':memory:',
+    synchronize: true,
+    dropSchema: true,
+    namingStrategy: new shell.NamingStrategy(),
+    entities: [...shell.entities, ...authBase.entities, Figure],
+    logging: false
+  })
+
+  await dataSource.initialize()
+  shell.addDataSource('default', dataSource)
+  shell.addDataSource('tx', dataSource)
+})
+
+beforeEach(async () => {
+  await dataSource!.synchronize(true)
+})
+
+afterAll(async () => {
+  if (!dataSource) return
+  shell.removeDataSource('default')
+  shell.removeDataSource('tx')
+  await dataSource.destroy()
+  dataSource = null
+})
+
+/** 저장소에서 **다시 읽은** 것. 반환값이 아니라 이것이 근거다. */
+async function readBack(id: string) {
+  return await dataSource!.getRepository(Figure).findOne({ where: { id } })
+}
+
+async function seed(over: Record<string, unknown> = {}) {
+  const repository = dataSource!.getRepository(Figure)
+  return await repository.save({
+    type: 'CONVEYOR',
+    name: '컨베이어',
+    source: '{}',
+    state: 'draft',
+    ...over
+  })
+}
+
+describe('태그가 정말 써진다', () => {
+  it('여럿 붙고, 다시 읽어도 그대로다', async () => {
+    const saved = await seed({ tags: ['반출', '자동'] })
+    const read = await readBack(saved.id)
+
+    expect(read!.tags).toEqual(['반출', '자동'])
+  })
+
+  /*
+    이 저장 경로의 모양이다 — 읽어 온 것을 펼쳐 새 값을 얹는다. 여기서 칸이 조용히 빠지는 것이
+    기억에 남은 그 함정이다.
+  */
+  it('읽어 온 것을 펼쳐 얹어도 써진다 — save 가 그 칸을 흘리지 않는다', async () => {
+    const saved = await seed({ tags: ['반출'] })
+    const before = await readBack(saved.id)
+
+    await dataSource!.getRepository(Figure).save({ ...before, tags: ['반출', '2층'] })
+
+    expect((await readBack(saved.id))!.tags).toEqual(['반출', '2층'])
+  })
+
+  it('빈 배열은 전부 지운다 — 지울 방법이 있어야 한다', async () => {
+    const saved = await seed({ tags: ['반출'] })
+    const before = await readBack(saved.id)
+
+    await dataSource!.getRepository(Figure).save({ ...before, tags: [] })
+
+    expect((await readBack(saved.id))!.tags).toEqual([])
+  })
+
+  it('안 준 도형은 태그가 없다 — 빈 배열로 갈음하지 않는다', async () => {
+    const saved = await seed()
+
+    expect((await readBack(saved.id))!.tags).toBeNull()
+  })
+})
+
+describe('분류는 하나다', () => {
+  it('써지고 다시 읽힌다', async () => {
+    const saved = await seed({ category: '컨베이어' })
+
+    expect((await readBack(saved.id))!.category).toBe('컨베이어')
+  })
+
+  it('분류와 태그는 서로 손대지 않는다', async () => {
+    const saved = await seed({ category: '컨베이어', tags: ['반출'] })
+    const before = await readBack(saved.id)
+
+    await dataSource!.getRepository(Figure).save({ ...before, tags: ['반출', '자동'] })
+    const read = await readBack(saved.id)
+
+    expect(read!.category).toBe('컨베이어')
+    expect(read!.tags).toEqual(['반출', '자동'])
+  })
+})
+
+describe('★ 이 시험이 실제로 DB 를 읽고 있다', () => {
+  it('없는 것을 물으면 없다고 한다 — 늘 초록이 아니다', async () => {
+    expect(await readBack('없는-id')).toBeNull()
+  })
+
+  it('표가 실제로 서 있다', async () => {
+    const saved = await seed()
+    const rows = await dataSource!.query('select count(*) as n from figures')
+
+    expect(Number(rows[0].n)).toBe(1)
+    expect(saved.id).toBeTruthy()
+  })
+})

package/server/service/figure/figure-query.ts

@@ -31,7 +31,14 @@ export class FigureQuery {
       params,
       domain,
       alias: 'figure',
-      searchables: ['type', 'name', 'description', 'category']
+      /*
+        `tags` 도 찾을 수 있어야 한다 — 태그의 값은 붙이는 데 있지 않고 **찾는 데** 있다.
+
+        `simple-json` 이라 칸에는 `["반출","자동"]` 이 통째로 들어 있고, LIKE 는 그 글자를
+        본다. 「반출」로 찾으면 걸린다. 정확히 그 태그만 걸리는 것은 아니지만(이름에 「반출」이
+        든 도형도 걸린다) 찾기로는 그것이 오히려 낫다.
+      */
+      searchables: ['type', 'name', 'description', 'category', 'tags']
     })
 
     const [items, total] = await queryBuilder.getManyAndCount()

package/server/service/figure/figure-type.ts

@@ -22,6 +22,9 @@ export class NewFigure {
   @Field({ nullable: true, description: 'Classification code used to group figures in the palette.' })
   category?: string
 
+  @Field(type => [String], { nullable: true, description: 'Free-form tags. A figure may carry several.' })
+  tags?: string[]
+
   @Field({ description: 'The canonical FigureSource JSON.' })
   source: string
 
@@ -52,6 +55,13 @@ export class FigurePatch {
   @Field({ nullable: true, description: 'The new classification code.' })
   category?: string
 
+  /*
+    빈 배열과 안 준 것을 가른다. `undefined` 는 「건드리지 않는다」, `[]` 는 「전부 지운다」다.
+    둘을 뭉개면 태그를 다 지우려는 저작자가 지울 방법을 잃는다.
+  */
+  @Field(type => [String], { nullable: true, description: 'The new tags. An empty list clears them; omitting the field leaves them.' })
+  tags?: string[]
+
   @Field({ nullable: true, description: 'The new FigureSource JSON.' })
   source?: string
 

package/server/service/figure/figure.ts

@@ -89,11 +89,31 @@ export class Figure {
   @Field({ nullable: true, description: 'A detailed description for the figure.' })
   description?: string
 
-  /** 분류 코드. 팔레트에서 묶어 보이는 기준. */
+  /**
+   * 분류 하나. **팔레트에서 묶어 보이는 기준이다.**
+   *
+   * 도형 하나에 하나뿐이다 — 팔레트는 목록을 한 벌로 나눠 보여 주므로, 한 도형이 두 묶음에
+   * 동시에 있으면 저작자가 같은 것을 두 번 만난다.
+   */
   @Column({ nullable: true })
-  @Field({ nullable: true, description: 'Classification code used to group figures in the palette.' })
+  @Field({ nullable: true, description: 'Classification code used to group figures in the palette. One per figure.' })
   category?: string
 
+  /**
+   * 태그. **여럿 붙는다.**
+   *
+   * 분류와 다른 일을 한다. 분류는 「이것이 무엇인가」를 한 번 정하는 것이고, 태그는 「어디에
+   * 걸리는가」를 여러 갈래로 적는 것이다 — 컨베이어이면서 반출 구역의 것일 수 있다. 그래서
+   * 분류로는 못 하는 찾기가 된다.
+   *
+   * `simple-json` 으로 담는다. 사내 선례가 그것이고(`ops-master` · `organization` ·
+   * `personalization`), 드라이버마다 배열 타입이 다른 것을 피한다.
+   */
+  /* `simple-json` 과 `default: null` 은 사내 선례 그대로다 — board-template · attachment 가 같은 모양이다. */
+  @Column('simple-json', { nullable: true, default: null })
+  @Field(type => [String], { nullable: true, description: 'Free-form tags. A figure may carry several.' })
+  tags?: string[]
+
   @Column({ nullable: true, default: 'draft' })
   @Field({ nullable: true, description: "Lifecycle state — 'draft' figures do not appear in the board palette." })
   state?: 'draft' | 'released'