4.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.30",
+  "version": "4.0.0",
   "private": false,
   "description": "do more with data",
   "main": "dist_ts/index.js",
@@ -21,26 +21,27 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^4.0.17",
-    "@pushrocks/smartlog": "^2.0.36",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartstring": "^3.0.18",
-    "@pushrocks/smartunique": "^3.0.3",
-    "@types/lodash": "^4.14.159",
-    "@types/mongodb": "^3.5.26",
-    "lodash": "^4.17.20",
-    "mongodb": "^3.6.0",
+    "@pushrocks/lik": "^4.0.20",
+    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartpromise": "^3.1.5",
+    "@pushrocks/smartstring": "^3.0.24",
+    "@tsclass/tsclass": "^3.0.33",
+    "@types/lodash": "^4.14.169",
+    "@types/mongodb": "^3.6.12",
+    "lodash": "^4.17.21",
+    "mongodb": "^3.6.6",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.44",
+    "@gitzone/tstest": "^1.0.54",
     "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/smartunique": "^3.0.3",
+    "@pushrocks/tapbundle": "^3.2.14",
     "@types/mongodb-memory-server": "^2.3.0",
-    "@types/node": "^14.6.0",
+    "@types/node": "^15.3.0",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^6.6.4",
+    "mongodb-memory-server": "^6.9.6",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

test/test.ts

@@ -3,33 +3,49 @@ import { Qenv } from '@pushrocks/qenv';
 
 const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
+console.log(process.memoryUsage());
+
 // the tested module
 import * as smartdata from '../ts/index';
-import { smartstring } from '../ts/smartdata.plugins';
-import * as smartunique from '@pushrocks/smartunique';
 
 import * as mongoPlugin from 'mongodb-memory-server';
+import { smartunique } from '../ts/smartdata.plugins';
 
 // =======================================
 // Connecting to the database server
 // =======================================
 
 let testDb: smartdata.SmartdataDb;
-let smartdataOptions: smartdata.ISmartdataOptions;
+let smartdataOptions: smartdata.IMongoDescriptor;
 let mongod: mongoPlugin.MongoMemoryServer;
 
-tap.test('should create a testinstance as database', async () => {
-  mongod = new mongoPlugin.MongoMemoryServer();
+const totalCars = 2000;
+
+tap.skip.test('should create a testinstance as database', async () => {
+  mongod = new mongoPlugin.MongoMemoryServer({});
+  console.log('created mongod instance');
+  await mongod._startUpInstance().catch((err) => {
+    console.log(err);
+  });
+  console.log('mongod started');
   smartdataOptions = {
     mongoDbName: await mongod.getDbName(),
     mongoDbPass: '',
-    mongoDbUrl: await mongod.getConnectionString(),
+    mongoDbUrl: await mongod.getUri(),
   };
   console.log(smartdataOptions);
   testDb = new smartdata.SmartdataDb(smartdataOptions);
 });
 
-tap.test('should establish a connection to the rethink Db cluster', async () => {
+tap.test('should connect to atlas', async (tools) => {
+  const databaseName = `test-smartdata-${smartunique.shortId()}`;
+  testDb = new smartdata.SmartdataDb({
+    mongoDbUrl: testQenv.getEnvVarOnDemand('MONGO_URL'),
+    mongoDbName: databaseName,
+  });
+});
+
+tap.test('should establish a connection to mongod', async () => {
   await testDb.init();
 });
 
@@ -54,6 +70,11 @@ class Car extends smartdata.SmartDataDbDoc<Car, Car> {
   @smartdata.svDb()
   public brand: string;
 
+  @smartdata.svDb()
+  deepData = {
+    sodeep: 'yes',
+  };
+
   constructor(colorArg: string, brandArg: string) {
     super();
     this.color = colorArg;
@@ -68,15 +89,65 @@ tap.test('should save the car to the db', async () => {
   const myCar2 = new Car('red', 'Volvo');
   await myCar2.save();
 
-  const myCar3 = new Car('red', 'Renault');
-  await myCar3.save();
+  let counter = 0;
+  process.memoryUsage();
+  do {
+    const myCar3 = new Car('red', 'Renault');
+    await myCar3.save();
+    counter++;
+    if (counter % 100 === 0) {
+      console.log(
+        `Filled database with ${counter} of ${totalCars} Cars and memory usage ${
+          process.memoryUsage().rss / 1e6
+        } MB`
+      );
+    }
+  } while (counter < totalCars);
+  console.log(process.memoryUsage());
 });
 
-tap.test('expect to get instance of Car', async () => {
-  const myCars = await Car.getInstances<Car>({
-    brand: 'Volvo',
-  });
-  expect(myCars[0].color).to.equal('red');
+tap.test('expect to get instance of Car with shallow match', async () => {
+  const totalQueryCycles = totalCars / 4;
+  let counter = 0;
+  do {
+    const timeStart = Date.now();
+    const myCars = await Car.getInstances({
+      brand: 'Renault',
+    });
+    if (counter % 10 === 0) {
+      console.log(
+        `performed ${counter} of ${totalQueryCycles} total query cycles: took ${
+          Date.now() - timeStart
+        }ms to query a set of 2000 with memory footprint ${process.memoryUsage().rss / 1e6} MB`
+      );
+    }
+    expect(myCars[0].deepData.sodeep).to.equal('yes');
+    expect(myCars[0].brand).to.equal('Renault');
+    counter++;
+  } while (counter < totalQueryCycles);
+});
+
+tap.test('expect to get instance of Car with deep match', async () => {
+  const totalQueryCycles = totalCars / 4;
+  let counter = 0;
+  do {
+    const timeStart = Date.now();
+    const myCars2 = await Car.getInstances({
+      deepData: {
+        sodeep: 'yes'
+      },
+    });
+    if (counter % 10 === 0) {
+      console.log(
+        `performed ${counter} of ${totalQueryCycles} total query cycles: took ${
+          Date.now() - timeStart
+        }ms to deep query a set of 2000 with memory footprint ${process.memoryUsage().rss / 1e6} MB`
+      );
+    }
+    expect(myCars2[0].deepData.sodeep).to.equal('yes');
+    expect(myCars2[0].brand).to.equal('Volvo');
+    counter++;
+  } while (counter < totalQueryCycles);
 });
 
 tap.test('expect to get instance of Car and update it', async () => {
@@ -89,11 +160,15 @@ tap.test('expect to get instance of Car and update it', async () => {
 });
 
 tap.test('should be able to delete an instance of car', async () => {
-  const myCar = await Car.getInstance<Car>({
+  const myCars = await Car.getInstances({
     brand: 'Volvo',
+    color: 'blue',
   });
-  expect(myCar.color).to.equal('blue');
-  await myCar.delete();
+  console.log(myCars);
+  expect(myCars[0].color).to.equal('blue');
+  for (const myCar of myCars) {
+    await myCar.delete();
+  }
 
   const myCar2 = await Car.getInstance<Car>({
     brand: 'Volvo',
@@ -125,19 +200,23 @@ class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
 tap.test('should store a new Truck', async () => {
   const truck = new Truck('blue', 'MAN');
   await truck.save();
-  const myTruck = await Truck.getInstance<Truck>({ color: 'blue' });
+  const myTruck = await Truck.getInstance({ color: 'blue' });
   myTruck.id = 'foo';
   await myTruck.save();
-  const myTruck2 = await Truck.getInstance<Truck>({ color: 'blue' });
+  const myTruck2 = await Truck.getInstance({ color: 'blue' });
   console.log(myTruck2);
 });
 
+tap.test('should ', async () => {})
+
 // =======================================
 // close the database connection
 // =======================================
 tap.test('should close the database connection', async (tools) => {
   await testDb.close();
-  await mongod.stop();
+  try {
+    await mongod.stop();
+  } catch (e) {}
 });
 
 tap.start({ throwOnError: true });

ts/interfaces/mongodescriptor.ts

@@ -1,5 +1,22 @@
 export interface IMongoDescriptor {
-  mongoDbName: string;
+  /**
+   * the URL to connect to
+   */
   mongoDbUrl: string;
-  mongoDbPass: string;
+
+  /**
+   * the db to use for the project
+   */
+  mongoDbName?: string;
+
+  /**
+   * a username to use to connect to the database
+   */
+
+  mongoDbUser?: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
 }

ts/smartdata.classes.collection.ts

@@ -1,6 +1,7 @@
 import * as plugins from './smartdata.plugins';
 import { SmartdataDb } from './smartdata.classes.db';
 import { SmartDataDbDoc } from './smartdata.classes.doc';
+import { CollectionFactory } from './smartdata.classes.collectionfactory';
 
 export interface IFindOptions {
   limit?: number;
@@ -15,23 +16,26 @@ export interface IDocValidationFunc<T> {
 
 export type TDelayedDbCreation = () => SmartdataDb;
 
+const collectionFactory = new CollectionFactory();
+
 /**
  * This is a decorator that will tell the decorated class what dbTable to use
  * @param dbArg
  */
 export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
-  return function (constructor) {
-    if (dbArg instanceof SmartdataDb) {
-      // tslint:disable-next-line: no-string-literal
-      constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg);
-    } else {
-      constructor['smartdataDelayedCollection'] = () => {
-        return new SmartdataCollection(constructor, dbArg());
-      };
-    }
+  return function classDecorator<T extends { new (...args: any[]): {} }>(constructor: T) {
+    return class extends constructor {
+      public static get collection() {
+        return collectionFactory.getCollection(constructor.name, dbArg);
+      }
+      public get collection() {
+        return collectionFactory.getCollection(constructor.name, dbArg);
+      }
+    };
   };
 }
 
+// tslint:disable-next-line: max-classes-per-file
 export class SmartdataCollection<T> {
   /**
    * the collection that is used
@@ -42,13 +46,13 @@ export class SmartdataCollection<T> {
   public smartdataDb: SmartdataDb;
   public uniqueIndexes: string[] = [];
 
-  constructor(collectedClassArg: T & SmartDataDbDoc<T, unknown>, smartDataDbArg: SmartdataDb) {
+  constructor(classNameArg: string, smartDataDbArg: SmartdataDb) {
     // tell the collection where it belongs
-    this.collectionName = collectedClassArg.name;
+    this.collectionName = classNameArg;
     this.smartdataDb = smartDataDbArg;
 
     // tell the db class about it (important since Db uses different systems under the hood)
-    this.smartdataDb.addTable(this);
+    this.smartdataDb.addCollection(this);
   }
 
   /**
@@ -63,9 +67,9 @@ export class SmartdataCollection<T> {
       });
       if (!wantedCollection) {
         await this.smartdataDb.mongoDb.createCollection(this.collectionName);
+        console.log(`Successfully initiated Collection ${this.collectionName}`);
       }
-      this.mongoDbCollection = await this.smartdataDb.mongoDb.collection(this.collectionName);
-      // console.log(`Successfully initiated Collection ${this.collectionName}`);
+      this.mongoDbCollection = this.smartdataDb.mongoDb.collection(this.collectionName);
     }
   }
 
@@ -127,11 +131,12 @@ export class SmartdataCollection<T> {
       }
       updateableObject[key] = saveableObject[key];
     }
-    this.mongoDbCollection.updateOne(
+    const result = await this.mongoDbCollection.updateOne(
       identifiableObject,
       { $set: updateableObject },
       { upsert: true }
     );
+    return result;
   }
 
   public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {

ts/smartdata.classes.collectionfactory.ts

@@ -0,0 +1,25 @@
+import * as plugins from './smartdata.plugins';
+import { SmartdataCollection } from './smartdata.classes.collection';
+import { SmartdataDb } from './smartdata.classes.db';
+
+export class CollectionFactory {
+  public collections: { [key: string]: SmartdataCollection<any> } = {};
+
+  public getCollection = (
+    nameArg: string,
+    dbArg: SmartdataDb | (() => SmartdataDb)
+  ): SmartdataCollection<any> => {
+    if (!this.collections[nameArg]) {
+      this.collections[nameArg] = (() => {
+        if (dbArg instanceof SmartdataDb) {
+          // tslint:disable-next-line: no-string-literal
+          return new SmartdataCollection(nameArg, dbArg);
+        } else {
+          dbArg = dbArg();
+          return new SmartdataCollection(nameArg, dbArg);
+        }
+      })();
+    }
+    return this.collections[nameArg];
+  };
+}

ts/smartdata.classes.db.ts

@@ -4,43 +4,21 @@ import { ObjectMap } from '@pushrocks/lik';
 import { SmartdataCollection } from './smartdata.classes.collection';
 
 import { logger } from './smartdata.logging';
+import { IMongoDescriptor } from './interfaces';
 
 /**
  * interface - indicates the connection status of the db
  */
 export type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
 
-export interface ISmartdataOptions {
-  /**
-   * the URL to connect to
-   */
-  mongoDbUrl: string;
-
-  /**
-   * the db to use for the project
-   */
-  mongoDbName?: string;
-
-  /**
-   * a username to use to connect to the database
-   */
-
-  mongoDbUser?: string;
-
-  /**
-   * an optional password that will be replace <PASSWORD> in the connection string
-   */
-  mongoDbPass?: string;
-}
-
 export class SmartdataDb {
-  smartdataOptions: ISmartdataOptions;
+  smartdataOptions: IMongoDescriptor;
   mongoDbClient: plugins.mongodb.MongoClient;
   mongoDb: plugins.mongodb.Db;
   status: TConnectionStatus;
   smartdataCollectionMap = new ObjectMap<SmartdataCollection<any>>();
 
-  constructor(smartdataOptions: ISmartdataOptions) {
+  constructor(smartdataOptions: IMongoDescriptor) {
     this.smartdataOptions = smartdataOptions;
     this.status = 'initial';
   }
@@ -54,6 +32,8 @@ export class SmartdataDb {
     const finalConnectionUrl = this.smartdataOptions.mongoDbUrl
       .replace('<USERNAME>', this.smartdataOptions.mongoDbUser)
       .replace('<username>', this.smartdataOptions.mongoDbUser)
+      .replace('<USER>', this.smartdataOptions.mongoDbUser)
+      .replace('<user>', this.smartdataOptions.mongoDbUser)
       .replace('<PASSWORD>', this.smartdataOptions.mongoDbPass)
       .replace('<password>', this.smartdataOptions.mongoDbPass)
       .replace('<DBNAME>', this.smartdataOptions.mongoDbName)
@@ -62,6 +42,8 @@ export class SmartdataDb {
     this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
       useNewUrlParser: true,
       useUnifiedTopology: true,
+      maxPoolSize: 100,
+      maxIdleTimeMS: 10,
     });
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';
@@ -79,7 +61,7 @@ export class SmartdataDb {
 
   // handle table to class distribution
 
-  public addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
+  public addCollection(SmartdataCollectionArg: SmartdataCollection<any>) {
     this.smartdataCollectionMap.add(SmartdataCollectionArg);
   }
 

ts/smartdata.classes.doc.ts

@@ -12,7 +12,7 @@ export type TDocCreation = 'db' | 'new' | 'mixed';
  */
 export function svDb() {
   return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
-    console.log(`called svDb() on ${key}`);
+    console.log(`called svDb() on >${target.constructor.name}.${key}<`);
     if (!target.saveableProperties) {
       target.saveableProperties = [];
     }
@@ -25,7 +25,7 @@ export function svDb() {
  */
 export function unI() {
   return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
-    console.log('called unI');
+    console.log(`called unI on >>${target.constructor.name}.${key}<<`);
 
     // mark the index as unique
     if (!target.uniqueIndexes) {
@@ -41,11 +41,12 @@ export function unI() {
   };
 }
 
-export class SmartDataDbDoc<T, TImplements> {
+export class SmartDataDbDoc<T extends TImplements, TImplements> {
   /**
    * the collection object an Doc belongs to
    */
-  public collection: SmartdataCollection<T>;
+  public static collection: SmartdataCollection<any>;
+  public collection: SmartdataCollection<any>;
 
   /**
    * how the Doc in memory was created, may prove useful later.
@@ -75,34 +76,38 @@ export class SmartDataDbDoc<T, TImplements> {
   /**
    * class constructor
    */
-  constructor() {
-    this.name = this.constructor['name'];
-    if (this.constructor['smartdataCollection']) {
-      // tslint:disable-next-line: no-string-literal
-      this.collection = this.constructor['smartdataCollection'];
-      // tslint:disable-next-line: no-string-literal
-    } else if (typeof this.constructor['smartdataDelayedCollection'] === 'function') {
-      // tslint:disable-next-line: no-string-literal
-      this.collection = this.constructor['smartdataDelayedCollection']();
-    } else {
-      console.error('Could not determine collection for DbDoc');
-    }
-  }
+  constructor() {}
 
-  public static async getInstances<T>(filterArg: Partial<T>): Promise<T[]> {
-    const self: any = this; // fool typesystem
-    let referenceMongoDBCollection: SmartdataCollection<T>;
-
-    if (self.smartdataCollection) {
-      referenceMongoDBCollection = self.smartdataCollection;
-    } else if (self.smartdataDelayedCollection) {
-      referenceMongoDBCollection = self.smartdataDelayedCollection();
+  public static async getInstances<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>
+  ): Promise<T[]> {
+    const convertedFilter: any = {};
+    const convertFilterArgument = (keyPathArg: string, filterArg2: any) => {
+      if (typeof filterArg2 === 'object') {
+        for (const key of Object.keys(filterArg2)) {
+          if (key.startsWith('$')) {
+            convertedFilter[keyPathArg] = filterArg2;
+            return;
+          } else if (key.includes('.')) {
+            throw new Error('keys cannot contain dots');
+          }
+        }
+        for (const key of Object.keys(filterArg2)) {
+          convertFilterArgument(`${keyPathArg}.${key}`, filterArg2[key]);
+        } 
+      } else {
+        convertedFilter[keyPathArg] = filterArg2
+      }
     }
-    const foundDocs = await referenceMongoDBCollection.find(filterArg);
+    for (const key of Object.keys(filterArg)) {
+      convertFilterArgument(key, filterArg[key]);
+    }
+    const foundDocs = await (this as any).collection.find(convertedFilter);
     const returnArray = [];
     for (const item of foundDocs) {
       const newInstance = new this();
-      newInstance.creationStatus = 'db';
+      (newInstance as any).creationStatus = 'db';
       for (const key of Object.keys(item)) {
         newInstance[key] = item[key];
       }
@@ -111,8 +116,11 @@ export class SmartDataDbDoc<T, TImplements> {
     return returnArray;
   }
 
-  public static async getInstance<T>(filterArg: Partial<T>): Promise<T> {
-    const result = await this.getInstances<T>(filterArg);
+  public static async getInstance<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>
+  ): Promise<T> {
+    const result = await (this as any).getInstances(filterArg);
     if (result && result.length > 0) {
       return result[0];
     }
@@ -125,25 +133,26 @@ export class SmartDataDbDoc<T, TImplements> {
   public async save() {
     // tslint:disable-next-line: no-this-assignment
     const self: any = this;
+    let dbResult: any;
     switch (this.creationStatus) {
       case 'db':
-        await this.collection.update(self);
+        dbResult = await this.collection.update(self);
         break;
       case 'new':
-        const writeResult = await this.collection.insert(self);
+        dbResult = await this.collection.insert(self);
         this.creationStatus = 'db';
         break;
       default:
         console.error('neither new nor in db?');
     }
+    return dbResult;
   }
 
   /**
    * deletes a document from the database
    */
   public async delete() {
-    const self: any = this;
-    await this.collection.delete(self);
+    await this.collection.delete(this);
   }
 
   /**

ts/smartdata.plugins.ts

@@ -1,4 +1,9 @@
-import * as assert from 'assert';
+// tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export { tsclass };
+
+// @pushrocks scope
 import * as smartlog from '@pushrocks/smartlog';
 import * as lodash from 'lodash';
 import * as mongodb from 'mongodb';
@@ -6,4 +11,4 @@ import * as smartq from '@pushrocks/smartpromise';
 import * as smartstring from '@pushrocks/smartstring';
 import * as smartunique from '@pushrocks/smartunique';
 
-export { assert, smartlog, lodash, smartq, mongodb, smartstring, smartunique };
+export { smartlog, lodash, smartq, mongodb, smartstring, smartunique };