chore: code cleanup

feat(Database): Only navigation properties in query now valid

src/exception/database.ts

@@ -6,9 +6,6 @@ export const NonExistentTable =
 export const UnmodifiableTable =
   () => new ReactiveDBException(`Method: defineSchema cannot be invoked since schema is existed or database is connected`)
 
-export const InvalidQuery =
-  () => new ReactiveDBException('Only navigation properties were included in query.')
-
 export const AliasConflict =
   (column: string, tableName: string) => new ReactiveDBException(`Definition conflict, Column: \`${column}\` on table: ${tableName}.`)
 

src/interface/index.ts

@@ -130,10 +130,7 @@ export type SchemaDisposeFunction<T> =
 
 export interface ShapeMatcher {
   mainTable: lf.schema.Table
-  pk: {
-    name: string,
-    queried: boolean
-  }
+  pk: string
   definition: Object
 }
 

src/storage/Database.ts

@@ -173,7 +173,7 @@ export class Database {
     }
 
     return this.database$
-      .concatMap<any, any>(db => {
+      .concatMap(db => {
         const entity = clone(raw)
         const [ table ] = Database.getTables(db, tableName)
         const columnMapper = schema!.mapper
@@ -290,7 +290,7 @@ export class Database {
       }
 
       const queries: lf.query.Builder[] = []
-      const removedIds: any = []
+      const removedIds: string[] = []
       queries.push(predicatableQuery(db, table, predicate!, StatementType.Delete))
 
       const prefetch = predicatableQuery(db, table, predicate!, StatementType.Select)
@@ -433,7 +433,6 @@ export class Database {
       const containFields = !!clause.fields
       let predicate: Predicate<T>
 
-      const containKey = containFields ? contains(pk, clause.fields!) : true
       const [ additionJoinInfo, err ] = !clause.where ? [ null, null ] :
         tryCatch(() => {
           predicate = parsePredicate(clause.where!)
@@ -444,24 +443,30 @@ export class Database {
         warn('Build addition join info from predicate failed', err.message)
       }
 
-      const fields = containFields ? clause.fields : Array.from(schema.columns.keys())
+      let fields: Field[]
+      if (containFields) {
+        fields = [ schema.pk, ...clause.fields! ]
+      } else {
+        fields = Array.from(schema.columns.keys())
+      }
 
       if (containFields && additionJoinInfo) {
-        mergeFields(fields!, additionJoinInfo)
+        mergeFields(fields, additionJoinInfo)
       }
 
-      const fieldsSet: Set<Field> = new Set(fields)
+      const fieldsSet = new Set(fields)
+
       const tablesStruct: TablesStruct = Object.create(null)
 
       const { table, columns, joinInfo, definition, contextName } =
-        this.traverseQueryFields(db, tableName, fieldsSet, containKey, !containFields, [], {}, tablesStruct, mode)
+        this.traverseQueryFields(db, tableName, fieldsSet, !containFields, [], {}, tablesStruct, mode)
       const query =
         predicatableQuery(db, table!, null, StatementType.Select, ...columns)
 
       joinInfo.forEach((info: JoinInfo) => {
-        const pred = info.predicate
-        if (pred) {
-          query.leftOuterJoin(info.table, pred)
+        const joinPredicate = info.predicate
+        if (joinPredicate) {
+          query.leftOuterJoin(info.table, joinPredicate)
         }
       })
 
@@ -475,10 +480,7 @@ export class Database {
       })
 
       const matcher = {
-        pk: {
-          name: pk,
-          queried: containKey
-        },
+        pk,
         definition,
         mainTable: table!
       }
@@ -533,7 +535,6 @@ export class Database {
     db: lf.Database,
     tableName: string,
     fieldsValue: Set<Field>,
-    hasKey: boolean,
     glob: boolean,
     path: string[] = [],
     context: Record = {},
@@ -560,17 +561,6 @@ export class Database {
       navigators.push(nav)
     })
 
-    const onlyNavigator = Array.from(fieldsValue.keys())
-      .every(key => contains(key, navigators))
-    assert(!onlyNavigator, Exception.InvalidQuery())
-
-    if (!hasKey) {
-      // 保证主键一定比关联字段更早的被遍历到
-      const fields = Array.from(fieldsValue)
-      fields.unshift(schema.pk)
-      fieldsValue = new Set(fields)
-    }
-
     const suffix = (context[tableName] || 0) + 1
     context[tableName] = suffix
     const contextName = contextTableName(tableName, suffix)
@@ -648,9 +638,9 @@ export class Database {
           handleAdvanced({ columns: [column], advanced: true }, ctx.key, columnDef)
           break
         case LeafType.navigator:
-          const { containKey, fields, assocaiation } = ctx.leaf as NavigatorLeaf
+          const { fields, assocaiation } = ctx.leaf as NavigatorLeaf
           const ret =
-            this.traverseQueryFields(db, assocaiation.name, new Set(fields), containKey, glob, path.slice(0), context, tablesStruct, mode)
+            this.traverseQueryFields(db, assocaiation.name, new Set(fields), glob, path.slice(0), context, tablesStruct, mode)
           handleAdvanced(ret, ctx.key, assocaiation)
           ctx.skip()
           break

src/storage/modules/Selector.ts

@@ -126,7 +126,7 @@ export class Selector <T> {
     }
     const { pk, mainTable } = this.shape
 
-    const column = mainTable[pk.name]
+    const column = mainTable[pk]
     const rangeQuery = predicatableQuery(this.db, mainTable, predicate, StatementType.Select, column)
 
     if (this.orderDescriptions && this.orderDescriptions.length) {
@@ -187,7 +187,7 @@ export class Selector <T> {
   values(): Observable<T[]> | never {
     if (typeof this.limit !== 'undefined' || typeof this.skip !== 'undefined') {
       const p = this.rangeQuery.exec()
-        .then(r => r.map(v => v[this.shape.pk.name]))
+        .then(r => r.map(v => v[this.shape.pk]))
         .then(pks => this.getValue(this.getQuery(this.inPKs(pks))))
       return this.mapFn(Observable.fromPromise(p))
     } else {
@@ -229,15 +229,15 @@ export class Selector <T> {
 
   private inPKs(pks: (string | number)[]): lf.Predicate {
     const { pk, mainTable } = this.shape
-    return mainTable[pk.name].in(pks)
+    return mainTable[pk].in(pks)
   }
 
   private getValue(query: lf.query.Select) {
     return query.exec()
       .then((rows: any[]) => {
         const result = graph<T>(rows, this.shape.definition)
-        const col = this.shape.pk.name
-        return !this.shape.pk.queried ? this.removeKey(result, col) : result
+        const col = this.shape.pk
+        return !this.shape.pk ? this.removeKey(result, col) : result
       })
   }
 
@@ -276,7 +276,7 @@ export class Selector <T> {
       const listener = () => {
         return rangeQuery.exec()
           .then((r) => {
-            observer.next(r.map(v => v[this.shape.pk.name]))
+            observer.next(r.map(v => v[this.shape.pk]))
           })
           .catch(e => observer.error(e))
       }

test/specs/storage/Database.public.spec.ts

@@ -11,7 +11,7 @@ import { TestFixture2 } from '../../schemas/Test'
 import { scenarioGen, programGen, postGen, taskGen, subtaskGen } from '../../utils/generators'
 import { RDBType, DataStoreType, Database, clone, forEach, JoinMode, Logger } from '../../index'
 import { TaskSchema, ProjectSchema, PostSchema, ModuleSchema, ProgramSchema, SubtaskSchema, OrganizationSchema, TasklistSchema } from '../../index'
-import { InvalidQuery, NonExistentTable, InvalidType, PrimaryKeyNotProvided, NotConnected, Selector, AssociatedFieldsPostionError } from '../../index'
+import { NonExistentTable, InvalidType, PrimaryKeyNotProvided, NotConnected, Selector, AssociatedFieldsPostionError } from '../../index'
 
 use(SinonChai)
 
@@ -543,7 +543,7 @@ export default describe('Database Testcase: ', () => {
         expect(result).to.deep.equal(innerTarget)
       })
 
-      it('should get value by deep nested Association query without association fields', function* () {
+      it('should get value by deep nested Association query without association fields #1', function* () {
         const fields = ['_id', 'content']
         const queryToken = database.get<TaskSchema>('Task', {
           fields,
@@ -557,7 +557,7 @@ export default describe('Database Testcase: ', () => {
         expect(result.project.organization._id).to.equal(innerTarget.project._organizationId)
       })
 
-      it('should get value by deep nested Association query without association fields', function* () {
+      it('should get value by deep nested Association query without association fields #2', function* () {
         const fields = ['_id', 'content']
         const queryToken = database.get<TaskSchema>('Task', {
           fields,
@@ -695,21 +695,6 @@ export default describe('Database Testcase: ', () => {
           })
       })
 
-      it('should throw if only navigator was included in query', function* () {
-
-        try {
-          yield database.get('Task', {
-            fields: [ 'project', 'subtasks' ],
-            where: { _id: innerTarget._id }
-          }).values()
-
-          throw new Error('error path reached')
-        } catch (err) {
-          const standardErr = InvalidQuery()
-          expect(err.message).to.equal(standardErr.message)
-        }
-      })
-
       it('should throw if failed to build where-clause, and treat it as an empty where-clause', function* () {
         let result: any[]
 

test/specs/storage/modules/Selector.spec.ts

@@ -78,10 +78,7 @@ export default describe('Selector test', () => {
 
     tableShape = {
       mainTable: table,
-      pk: {
-        queried: true,
-        name: '_id'
-      },
+      pk: '_id',
       definition: {
         _id: {
           column: '_id',