@things-factory/kpi 10.1.39 → 10.1.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/kpi",
-  "version": "10.1.39",
+  "version": "10.1.40",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -41,9 +41,9 @@
     "@operato/shell": "^10.0.0",
     "@operato/styles": "^10.0.0",
     "@operato/utils": "^10.0.0",
-    "@things-factory/auth-base": "^10.1.39",
-    "@things-factory/dataset": "^10.1.39",
-    "@things-factory/shell": "^10.1.39"
+    "@things-factory/auth-base": "^10.1.40",
+    "@things-factory/dataset": "^10.1.40",
+    "@things-factory/shell": "^10.1.40"
   },
-  "gitHead": "fe5257ad8995fe7e79275e287f36e95b5fd32d1c"
+  "gitHead": "51c5d804c14ad8fcc6d4707e6ef80c9deede2766"
 }

package/tests/entities-sqlite.test.ts

@@ -0,0 +1,92 @@
+/**
+ * kpi's tables build on sqlite - the development default.
+ *
+ * KpiMetric.collectType was declared type 'enum', a name only postgres and mysql know. The sqlite driver
+ * refused it when the DataSource opened (DataTypeNotSupportedError), so no app with kpi could start on
+ * sqlite, and list-search-db could only run on postgres. It is 'simple-enum' now: postgres and mysql turn
+ * it into the same native enum as before (an existing postgres table sees no schema change), sqlite a
+ * varchar with a CHECK.
+ *
+ * Needs kpi's dist-server, for the same reason list-search-db does:
+ *
+ *   yarn workspace @things-factory/kpi build:server
+ *   yarn _test packages/kpi/tests
+ */
+
+import type { DataSource } from 'typeorm'
+import { existsSync } from 'fs'
+import { join } from 'path'
+
+/* Entities pick their column types from ormconfig.type when they load, so the driver is named first. */
+require('@things-factory/env').config.set('ormconfig', { type: 'sqlite' })
+
+const { DataSource: TypeOrmDataSource } = require('typeorm')
+const shell = require('@things-factory/shell')
+const authBase = require('@things-factory/auth-base')
+/* The same closed entity graph list-search-db builds: KpiMetric -> DataSet -> Scenario, worklist. */
+const integration = require('@things-factory/integration-base')
+const worklist = require('@things-factory/worklist')
+const dataset = require('@things-factory/dataset')
+const attachment = require('@things-factory/attachment-base')
+
+const DIST = join(__dirname, '..', 'dist-server')
+if (!existsSync(join(DIST, 'service', 'index.js'))) {
+  throw new Error(`kpi's dist-server is missing - run "yarn workspace @things-factory/kpi build:server" first`)
+}
+const kpi = require(join(DIST, 'service', 'index.js'))
+
+let dataSource: DataSource
+let domain: any
+
+describe('kpi entities on sqlite', () => {
+  beforeAll(async () => {
+    dataSource = new TypeOrmDataSource({
+      type: 'sqlite',
+      database: ':memory:',
+      synchronize: true,
+      dropSchema: true,
+      namingStrategy: new shell.NamingStrategy(),
+      entities: [
+        ...shell.entities,
+        ...authBase.entities,
+        ...attachment.entities,
+        ...integration.entities,
+        ...worklist.entities,
+        ...dataset.entities,
+        ...kpi.entities
+      ],
+      logging: false
+    })
+    await dataSource.initialize()
+    domain = await dataSource.getRepository(shell.Domain).save({ name: 'Plant A', subdomain: 'plant-a' })
+  })
+
+  afterAll(async () => {
+    if (dataSource?.isInitialized) await dataSource.destroy()
+  })
+
+  it('builds every kpi table', async () => {
+    const tables = (await dataSource.query(`SELECT name FROM sqlite_master WHERE type = 'table'`)).map(
+      (row: any) => row.name
+    )
+    for (const entity of kpi.entities) {
+      expect(tables).toContain(dataSource.getMetadata(entity).tableName)
+    }
+  })
+
+  it('a metric takes AUTO when no collect type is given, and keeps the one it is given', async () => {
+    const repo = dataSource.getRepository(kpi.KpiMetric)
+    const auto = await repo.save({ domain, name: 'Downtime minutes' })
+    const manual = await repo.save({ domain, name: 'Good units', collectType: kpi.KpiMetricCollectType.MANUAL })
+    expect((await repo.findOneBy({ id: auto.id })).collectType).toBe('AUTO')
+    expect((await repo.findOneBy({ id: manual.id })).collectType).toBe('MANUAL')
+  })
+
+  it('refuses a collect type outside the enum - the column still holds only its values', async () => {
+    const table = dataSource.getMetadata(kpi.KpiMetric).tableName
+    await dataSource.getRepository(kpi.KpiMetric).save({ domain, name: 'Scrap count' })
+    await expect(
+      dataSource.query(`UPDATE "${table}" SET "collect_type" = 'SOMETHING_ELSE'`)
+    ).rejects.toThrow(/CHECK constraint failed/)
+  })
+})

package/tests/list-search-db.test.ts

@@ -13,9 +13,9 @@
  *   docker run -d --rm --name kpi-pg -e POSTGRES_PASSWORD=x -p 55433:5432 postgres:14-alpine
  *   TEST_POSTGRES_URL=postgres://postgres:x@localhost:55433/postgres yarn _test packages/kpi/tests
  *
- * Not sqlite, for two reasons: sqlite lowers a uuid without complaint, so it cannot show the defect;
- * and it cannot build these tables at all - KpiMetric.collectType is declared type 'enum', which the
- * sqlite driver rejects. Without the variable the suite is skipped, and says so.
+ * Not sqlite: sqlite lowers a uuid without complaint, so it cannot show the defect. (It builds these
+ * tables since KpiMetric.collectType became 'simple-enum' - entities-sqlite.test.ts keeps that so.)
+ * Without the variable the suite is skipped, and says so.
  */
 
 import type { DataSource } from 'typeorm'