fix: CommonDao BM/DBM now extends BaseDBEntity

BaseDBEntity now has non-optional id (and optional created/updated). This is another step in (hopefully) simplifying DB model constraints
NaturalCycles · Jan 21, 2024 · d8dc9c2 · d8dc9c2
1 parent 59e40bd
commit d8dc9c2
Show file tree

Hide file tree

Showing 24 changed files with 234 additions and 243 deletions.
diff --git a/src/adapter/cachedb/cache.db.model.ts b/src/adapter/cachedb/cache.db.model.ts
@@ -1,4 +1,4 @@
-import { CommonLogger, PartialObjectWithId } from '@naturalcycles/js-lib'
+import { CommonLogger, ObjectWithId } from '@naturalcycles/js-lib'
 import { CommonDB } from '../../common.db'
 import {
   CommonDBCreateOptions,
@@ -62,7 +62,7 @@ export interface CacheDBOptions extends CommonDBOptions {
   onlyCache?: boolean
 }
 
-export interface CacheDBSaveOptions<ROW extends PartialObjectWithId>
+export interface CacheDBSaveOptions<ROW extends ObjectWithId>
   extends CacheDBOptions,
     CommonDBSaveOptions<ROW> {}
 

diff --git a/src/adapter/cachedb/cache.db.ts b/src/adapter/cachedb/cache.db.ts
@@ -3,8 +3,7 @@ import {
   _isTruthy,
   JsonSchemaObject,
   JsonSchemaRootObject,
-  PartialObjectWithId,
-  Saved,
+  ObjectWithId,
   StringMap,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
@@ -59,13 +58,13 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return await this.cfg.downstreamDB.getTables()
   }
 
-  override async getTableSchema<ROW extends PartialObjectWithId>(
+  override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
   ): Promise<JsonSchemaRootObject<ROW>> {
     return await this.cfg.downstreamDB.getTableSchema<ROW>(table)
   }
 
-  override async createTable<ROW extends PartialObjectWithId>(
+  override async createTable<ROW extends ObjectWithId>(
     table: string,
     schema: JsonSchemaObject<ROW>,
     opt: CacheDBCreateOptions = {},
@@ -79,12 +78,12 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async getByIds<ROW extends PartialObjectWithId>(
+  override async getByIds<ROW extends ObjectWithId>(
     table: string,
     ids: string[],
     opt: CacheDBSaveOptions<ROW> = {},
-  ): Promise<Saved<ROW>[]> {
-    const resultMap: StringMap<Saved<ROW>> = {}
+  ): Promise<ROW[]> {
+    const resultMap: StringMap<ROW> = {}
     const missingIds: string[] = []
 
     if (!opt.skipCache && !this.cfg.skipCache) {
@@ -125,7 +124,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return ids.map(id => resultMap[id]).filter(_isTruthy)
   }
 
-  override async saveBatch<ROW extends PartialObjectWithId>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt: CacheDBSaveOptions<ROW> = {},
@@ -154,10 +153,10 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async runQuery<ROW extends PartialObjectWithId>(
+  override async runQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     opt: CacheDBSaveOptions<ROW> = {},
-  ): Promise<RunQueryResult<Saved<ROW>>> {
+  ): Promise<RunQueryResult<ROW>> {
     if (!opt.onlyCache && !this.cfg.onlyCache) {
       const { rows, ...queryResult } = await this.cfg.downstreamDB.runQuery(q, opt)
 
@@ -184,7 +183,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return { rows, ...queryResult }
   }
 
-  override async runQueryCount<ROW extends PartialObjectWithId>(
+  override async runQueryCount<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     opt: CacheDBOptions = {},
   ): Promise<number> {
@@ -201,10 +200,10 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return count
   }
 
-  override streamQuery<ROW extends PartialObjectWithId>(
+  override streamQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     opt: CacheDBStreamOptions = {},
-  ): ReadableTyped<Saved<ROW>> {
+  ): ReadableTyped<ROW> {
     if (!opt.onlyCache && !this.cfg.onlyCache) {
       const stream = this.cfg.downstreamDB.streamQuery<ROW>(q, opt)
 
@@ -240,7 +239,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return stream
   }
 
-  override async deleteByQuery<ROW extends PartialObjectWithId>(
+  override async deleteByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     opt: CacheDBOptions = {},
   ): Promise<number> {
@@ -272,7 +271,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return deletedIds
   }
 
-  override async updateByQuery<ROW extends PartialObjectWithId>(
+  override async updateByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     patch: DBPatch<ROW>,
     opt: CacheDBOptions = {},

diff --git a/src/adapter/file/file.db.model.ts b/src/adapter/file/file.db.model.ts
@@ -1,11 +1,11 @@
-import { CommonLogger, PartialObjectWithId, Saved } from '@naturalcycles/js-lib'
+import { CommonLogger, ObjectWithId } from '@naturalcycles/js-lib'
 import { DBSaveBatchOperation } from '../../db.model'
 import type { DBQueryOrder } from '../../query/dbQuery'
 
 export interface FileDBPersistencePlugin {
   ping: () => Promise<void>
   getTables: () => Promise<string[]>
-  loadFile: <ROW extends PartialObjectWithId>(table: string) => Promise<Saved<ROW>[]>
+  loadFile: <ROW extends ObjectWithId>(table: string) => Promise<ROW[]>
   saveFiles: (ops: DBSaveBatchOperation<any>[]) => Promise<void>
 }
 
@@ -15,7 +15,7 @@ export interface FileDBCfg {
   /**
    * @default undefined, which means "insertion order"
    */
-  sortOnSave?: DBQueryOrder
+  sortOnSave?: DBQueryOrder<any>
 
   /**
    * @default true

diff --git a/src/adapter/file/file.db.ts b/src/adapter/file/file.db.ts
@@ -9,8 +9,7 @@ import {
   JsonSchemaRootObject,
   _filterUndefinedValues,
   _assert,
-  Saved,
-  PartialObjectWithId,
+  ObjectWithId,
 } from '@naturalcycles/js-lib'
 import { readableCreate, ReadableTyped, dimGrey } from '@naturalcycles/nodejs-lib'
 import {
@@ -74,24 +73,24 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     return tables
   }
 
-  override async getByIds<ROW extends PartialObjectWithId>(
+  override async getByIds<ROW extends ObjectWithId>(
     table: string,
     ids: string[],
     _opt?: CommonDBOptions,
-  ): Promise<Saved<ROW>[]> {
+  ): Promise<ROW[]> {
     const byId = _by(await this.loadFile<ROW>(table), r => r.id)
     return ids.map(id => byId[id]!).filter(Boolean)
   }
 
-  override async saveBatch<ROW extends PartialObjectWithId>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     _opt?: CommonDBSaveOptions<ROW>,
   ): Promise<void> {
     if (!rows.length) return // save some api calls
 
     // 1. Load the whole file
-    const byId = _by(await this.loadFile<Saved<ROW>>(table), r => r.id)
+    const byId = _by(await this.loadFile<ROW>(table), r => r.id)
 
     // 2. Merge with new data (using ids)
     let saved = 0
@@ -111,23 +110,23 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async runQuery<ROW extends PartialObjectWithId>(
+  override async runQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
-  ): Promise<RunQueryResult<Saved<ROW>>> {
+  ): Promise<RunQueryResult<ROW>> {
     return {
       rows: queryInMemory(q, await this.loadFile<ROW>(q.table)),
     }
   }
 
-  override async runQueryCount<ROW extends PartialObjectWithId>(
+  override async runQueryCount<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
     return (await this.loadFile(q.table)).length
   }
 
-  override streamQuery<ROW extends PartialObjectWithId>(
+  override streamQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     opt?: CommonDBStreamOptions,
   ): ReadableTyped<ROW> {
@@ -141,7 +140,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     return readable
   }
 
-  override async deleteByQuery<ROW extends PartialObjectWithId>(
+  override async deleteByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -181,7 +180,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     return deleted
   }
 
-  override async getTableSchema<ROW extends PartialObjectWithId>(
+  override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
   ): Promise<JsonSchemaRootObject<ROW>> {
     const rows = await this.loadFile(table)
@@ -192,15 +191,15 @@ export class FileDB extends BaseCommonDB implements CommonDB {
   }
 
   // wrapper, to handle logging
-  async loadFile<ROW extends PartialObjectWithId>(table: string): Promise<Saved<ROW>[]> {
+  async loadFile<ROW extends ObjectWithId>(table: string): Promise<ROW[]> {
     const started = this.logStarted(`loadFile(${table})`)
     const rows = await this.cfg.plugin.loadFile<ROW>(table)
     this.logFinished(started, `loadFile(${table}) ${rows.length} row(s)`)
     return rows
   }
 
   // wrapper, to handle logging, sorting rows before saving
-  async saveFile<ROW extends PartialObjectWithId>(table: string, _rows: ROW[]): Promise<void> {
+  async saveFile<ROW extends ObjectWithId>(table: string, _rows: ROW[]): Promise<void> {
     // if (!_rows.length) return // NO, it should be able to save file with 0 rows!
 
     // Sort the rows, if needed
@@ -212,9 +211,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     this.logFinished(started, op)
   }
 
-  async saveFiles<ROW extends PartialObjectWithId>(
-    ops: DBSaveBatchOperation<ROW>[],
-  ): Promise<void> {
+  async saveFiles<ROW extends ObjectWithId>(ops: DBSaveBatchOperation<ROW>[]): Promise<void> {
     if (!ops.length) return
     const op =
       `saveFiles ${ops.length} op(s):\n` + ops.map(o => `${o.table} (${o.rows.length})`).join('\n')
@@ -227,7 +224,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
   //   return new FileDBTransaction(this)
   // }
 
-  sortRows<ROW extends PartialObjectWithId>(rows: ROW[]): ROW[] {
+  sortRows<ROW extends ObjectWithId>(rows: ROW[]): ROW[] {
     rows = rows.map(r => _filterUndefinedValues(r))
 
     if (this.cfg.sortOnSave) {

diff --git a/src/adapter/file/inMemory.persistence.plugin.ts b/src/adapter/file/inMemory.persistence.plugin.ts
@@ -18,7 +18,7 @@ export class InMemoryPersistencePlugin implements FileDBPersistencePlugin {
     return Object.values(this.data[table] || ({} as any))
   }
 
-  async saveFiles(ops: DBSaveBatchOperation[]): Promise<void> {
+  async saveFiles(ops: DBSaveBatchOperation<any>[]): Promise<void> {
     ops.forEach(op => {
       this.data[op.table] = _by(op.rows, r => r.id)
     })

diff --git a/src/adapter/file/localFile.persistence.plugin.ts b/src/adapter/file/localFile.persistence.plugin.ts
@@ -2,7 +2,7 @@ import fs from 'node:fs'
 import fsp from 'node:fs/promises'
 import { Readable } from 'node:stream'
 import { createGzip, createUnzip } from 'node:zlib'
-import { pMap, PartialObjectWithId, Saved } from '@naturalcycles/js-lib'
+import { ObjectWithId, pMap } from '@naturalcycles/js-lib'
 import {
   transformJsonParse,
   transformSplit,
@@ -48,7 +48,7 @@ export class LocalFilePersistencePlugin implements FileDBPersistencePlugin {
       .map(f => f.split('.ndjson')[0]!)
   }
 
-  async loadFile<ROW extends PartialObjectWithId>(table: string): Promise<Saved<ROW>[]> {
+  async loadFile<ROW extends ObjectWithId>(table: string): Promise<ROW[]> {
     await fs2.ensureDirAsync(this.cfg.storagePath)
     const ext = `ndjson${this.cfg.gzip ? '.gz' : ''}`
     const filePath = `${this.cfg.storagePath}/${table}.${ext}`
@@ -57,7 +57,7 @@ export class LocalFilePersistencePlugin implements FileDBPersistencePlugin {
 
     const transformUnzip = this.cfg.gzip ? [createUnzip()] : []
 
-    const rows: Saved<ROW>[] = []
+    const rows: ROW[] = []
 
     await _pipeline([
       fs.createReadStream(filePath),
@@ -70,11 +70,11 @@ export class LocalFilePersistencePlugin implements FileDBPersistencePlugin {
     return rows
   }
 
-  async saveFiles(ops: DBSaveBatchOperation[]): Promise<void> {
+  async saveFiles(ops: DBSaveBatchOperation<any>[]): Promise<void> {
     await pMap(ops, async op => await this.saveFile(op.table, op.rows), { concurrency: 16 })
   }
 
-  async saveFile<ROW extends PartialObjectWithId>(table: string, rows: ROW[]): Promise<void> {
+  async saveFile<ROW extends ObjectWithId>(table: string, rows: ROW[]): Promise<void> {
     await fs2.ensureDirAsync(this.cfg.storagePath)
     const ext = `ndjson${this.cfg.gzip ? '.gz' : ''}`
     const filePath = `${this.cfg.storagePath}/${table}.${ext}`

diff --git a/src/adapter/file/noop.persistence.plugin.ts b/src/adapter/file/noop.persistence.plugin.ts
@@ -1,4 +1,4 @@
-import { PartialObjectWithId, Saved } from '@naturalcycles/js-lib'
+import { ObjectWithId } from '@naturalcycles/js-lib'
 import { DBSaveBatchOperation } from '../../db.model'
 import { FileDBPersistencePlugin } from './file.db.model'
 
@@ -9,9 +9,9 @@ export class NoopPersistencePlugin implements FileDBPersistencePlugin {
     return []
   }
 
-  async loadFile<ROW extends PartialObjectWithId>(_table: string): Promise<Saved<ROW>[]> {
+  async loadFile<ROW extends ObjectWithId>(_table: string): Promise<ROW[]> {
     return []
   }
 
-  async saveFiles(_ops: DBSaveBatchOperation[]): Promise<void> {}
+  async saveFiles(_ops: DBSaveBatchOperation<any>[]): Promise<void> {}
 }