Compare commits

..

16 Commits

Author SHA1 Message Date
55d96fa68d 4.0.2 2021-06-09 12:40:55 +02:00
54ec6accdf fix(core): update 2021-06-09 12:40:55 +02:00
fc5d092b25 4.0.1 2021-06-06 17:54:48 +02:00
dfba057562 fix(core): update 2021-06-06 17:54:47 +02:00
1ad05943b5 4.0.0 2021-06-06 17:48:37 +02:00
302e51a77f BREAKING CHANGE(filter design): filters now are congruent with their data types. Static extensions of doc base class now are fully typed with automatic reference to their child classes. 2021-06-06 17:48:37 +02:00
1330d03af2 3.1.56 2021-05-16 23:26:05 +00:00
a298e9d190 fix(core): update 2021-05-16 23:26:05 +00:00
e571ef347b 3.1.55 2021-02-05 21:16:46 +00:00
39a4c7ef3f fix(core): update 2021-02-05 21:16:45 +00:00
0d3518d990 3.1.54 2020-10-19 16:44:28 +00:00
fbdde2268c fix(core): update 2020-10-19 16:44:28 +00:00
8b6c26f45a 3.1.53 2020-10-19 16:37:45 +00:00
97e82ed75a fix(core): update 2020-10-19 16:37:44 +00:00
03baffd9fd 3.1.52 2020-09-25 21:05:22 +00:00
f29ae67580 fix(core): update 2020-09-25 21:05:21 +00:00
8 changed files with 18439 additions and 3391 deletions

21633
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

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

View File

@ -49,6 +49,7 @@ How RethinkDB's terms map to the ones of smartdata:
represents a Database. Naturally it has .connect() etc. methods on it. represents a Database. Naturally it has .connect() etc. methods on it.
```typescript ```typescript
// Assuming toplevel await
import * as smartdata from 'smartdata'; import * as smartdata from 'smartdata';
const smartdataDb = new smartdata.SmartdataDb({ const smartdataDb = new smartdata.SmartdataDb({
@ -57,7 +58,7 @@ const smartdataDb = new smartdata.SmartdataDb({
mongoDbPass: 'mypassword', mongoDbPass: 'mypassword',
}); });
smartdataDb.connect(); await smartdataDb.connect();
``` ```
### class DbCollection ### class DbCollection
@ -68,10 +69,11 @@ A collection is defined by the object class (that is extending smartdata.dbdoc)
So to get to get access to a specific collection you document So to get to get access to a specific collection you document
```typescript ```typescript
// Assuming toplevel await
// continues from the block before... // continues from the block before...
@smartdata.Collection(smartdataDb) @smartdata.Collection(smartdataDb)
class MyObject extends smartdata.DbDoc<MyObject> { class MyObject extends smartdata.DbDoc<MyObject /* ,[an optional interface to implement] */> {
// read the next block about DbDoc // read the next block about DbDoc
@smartdata.svDb() @smartdata.svDb()
property1: string; // @smartdata.svDb() marks the property for db save property1: string; // @smartdata.svDb() marks the property for db save
@ -87,14 +89,22 @@ class MyObject extends smartdata.DbDoc<MyObject> {
const localObject = new MyObject({ const localObject = new MyObject({
property1: 'hi', property1: 'hi',
property2: 2, property2: {
deep: 3
},
}); });
localObject.save(); // saves the object to the database await localObject.save(); // saves the object to the database
// start retrieving instances // start retrieving instances
MyObject.getInstance<MyObject>({ // .getInstance is staticly inheritied, yet fully typed static function to get instances with fully typed filters
property: 'hi', const myInstance = await MyObject.getInstance({
property1: 'hi',
property2: {
deep: {
$gt: 2
} as any
}
}); // outputs a new instance of MyObject with the values from db assigned }); // outputs a new instance of MyObject with the values from db assigned
``` ```

View File

@ -3,6 +3,8 @@ import { Qenv } from '@pushrocks/qenv';
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/'); const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
console.log(process.memoryUsage());
// the tested module // the tested module
import * as smartdata from '../ts/index'; import * as smartdata from '../ts/index';
@ -17,6 +19,8 @@ let testDb: smartdata.SmartdataDb;
let smartdataOptions: smartdata.IMongoDescriptor; let smartdataOptions: smartdata.IMongoDescriptor;
let mongod: mongoPlugin.MongoMemoryServer; let mongod: mongoPlugin.MongoMemoryServer;
const totalCars = 2000;
tap.skip.test('should create a testinstance as database', async () => { tap.skip.test('should create a testinstance as database', async () => {
mongod = new mongoPlugin.MongoMemoryServer({}); mongod = new mongoPlugin.MongoMemoryServer({});
console.log('created mongod instance'); console.log('created mongod instance');
@ -27,7 +31,7 @@ tap.skip.test('should create a testinstance as database', async () => {
smartdataOptions = { smartdataOptions = {
mongoDbName: await mongod.getDbName(), mongoDbName: await mongod.getDbName(),
mongoDbPass: '', mongoDbPass: '',
mongoDbUrl: await mongod.getConnectionString(), mongoDbUrl: await mongod.getUri(),
}; };
console.log(smartdataOptions); console.log(smartdataOptions);
testDb = new smartdata.SmartdataDb(smartdataOptions); testDb = new smartdata.SmartdataDb(smartdataOptions);
@ -68,7 +72,7 @@ class Car extends smartdata.SmartDataDbDoc<Car, Car> {
@smartdata.svDb() @smartdata.svDb()
deepData = { deepData = {
sodeep: 'yes' sodeep: 'yes',
}; };
constructor(colorArg: string, brandArg: string) { constructor(colorArg: string, brandArg: string) {
@ -85,42 +89,65 @@ tap.test('should save the car to the db', async () => {
const myCar2 = new Car('red', 'Volvo'); const myCar2 = new Car('red', 'Volvo');
await myCar2.save(); await myCar2.save();
let counter = 0; let counter = 0;
process.memoryUsage();
do { do {
const myCar3 = new Car('red', 'Renault'); const myCar3 = new Car('red', 'Renault');
await myCar3.save(); await myCar3.save();
counter++; counter++;
} while (counter < 2000); 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 with shallow match', async () => { tap.test('expect to get instance of Car with shallow match', async () => {
const totalQueryCycles = totalCars / 4;
let counter = 0; let counter = 0;
do { do {
const timeStart = Date.now(); const timeStart = Date.now();
const myCars = await Car.getInstances<Car>({ const myCars = await Car.getInstances({
brand: 'Renault', brand: 'Renault',
}); });
console.log(`took ${Date.now() - timeStart}`); 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].deepData.sodeep).to.equal('yes');
expect(myCars[0].brand).to.equal('Renault'); expect(myCars[0].brand).to.equal('Renault');
counter++; counter++;
} while (counter < 30); } while (counter < totalQueryCycles);
}); });
tap.test('expect to get instance of Car with deep match', async () => { tap.test('expect to get instance of Car with deep match', async () => {
const totalQueryCycles = totalCars / 4;
let counter = 0; let counter = 0;
do { do {
const timeStart = Date.now(); const timeStart = Date.now();
const myCars2 = await Car.getInstances<Car>({ const myCars2 = await Car.getInstances({
'deepData.sodeep': 'yes', deepData: {
} as any); sodeep: 'yes'
console.log(`took ${Date.now() - timeStart}`); },
});
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].deepData.sodeep).to.equal('yes');
expect(myCars2[0].brand).to.equal('Volvo'); expect(myCars2[0].brand).to.equal('Volvo');
counter++; counter++;
} while (counter < 30); } while (counter < totalQueryCycles);
}); });
tap.test('expect to get instance of Car and update it', async () => { tap.test('expect to get instance of Car and update it', async () => {
@ -133,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 () => { 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', brand: 'Volvo',
color: 'blue',
}); });
expect(myCar.color).to.equal('blue'); console.log(myCars);
expect(myCars[0].color).to.equal('blue');
for (const myCar of myCars) {
await myCar.delete(); await myCar.delete();
}
const myCar2 = await Car.getInstance<Car>({ const myCar2 = await Car.getInstance<Car>({
brand: 'Volvo', brand: 'Volvo',
@ -169,13 +200,15 @@ class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
tap.test('should store a new Truck', async () => { tap.test('should store a new Truck', async () => {
const truck = new Truck('blue', 'MAN'); const truck = new Truck('blue', 'MAN');
await truck.save(); await truck.save();
const myTruck = await Truck.getInstance<Truck>({ color: 'blue' }); const myTruck = await Truck.getInstance({ color: 'blue' });
myTruck.id = 'foo'; myTruck.id = 'foo';
await myTruck.save(); await myTruck.save();
const myTruck2 = await Truck.getInstance<Truck>({ color: 'blue' }); const myTruck2 = await Truck.getInstance({ color: 'blue' });
console.log(myTruck2); console.log(myTruck2);
}); });
tap.test('should ', async () => {})
// ======================================= // =======================================
// close the database connection // close the database connection
// ======================================= // =======================================

View File

@ -14,7 +14,7 @@ export interface IDocValidationFunc<T> {
(doc: T): boolean; (doc: T): boolean;
} }
export type TDelayedDbCreation = () => SmartdataDb; export type TDelayed<TDelayedArg> = () => TDelayedArg;
const collectionFactory = new CollectionFactory(); const collectionFactory = new CollectionFactory();
@ -22,7 +22,7 @@ const collectionFactory = new CollectionFactory();
* This is a decorator that will tell the decorated class what dbTable to use * This is a decorator that will tell the decorated class what dbTable to use
* @param dbArg * @param dbArg
*/ */
export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) { export function Collection<TManager>(dbArg: SmartdataDb | TDelayed<SmartdataDb>, managerArg?: TDelayed<TManager>) {
return function classDecorator<T extends { new (...args: any[]): {} }>(constructor: T) { return function classDecorator<T extends { new (...args: any[]): {} }>(constructor: T) {
return class extends constructor { return class extends constructor {
public static get collection() { public static get collection() {
@ -31,6 +31,11 @@ export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
public get collection() { public get collection() {
return collectionFactory.getCollection(constructor.name, dbArg); return collectionFactory.getCollection(constructor.name, dbArg);
} }
public get manager() {
if (managerArg) {
return managerArg();
}
}
}; };
}; };
} }
@ -131,11 +136,12 @@ export class SmartdataCollection<T> {
} }
updateableObject[key] = saveableObject[key]; updateableObject[key] = saveableObject[key];
} }
this.mongoDbCollection.updateOne( const result = await this.mongoDbCollection.updateOne(
identifiableObject, identifiableObject,
{ $set: updateableObject }, { $set: updateableObject },
{ upsert: true } { upsert: true }
); );
return result;
} }
public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> { public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {

View File

@ -5,7 +5,10 @@ import { SmartdataDb } from './smartdata.classes.db';
export class CollectionFactory { export class CollectionFactory {
public collections: { [key: string]: SmartdataCollection<any> } = {}; public collections: { [key: string]: SmartdataCollection<any> } = {};
public getCollection = (nameArg: string, dbArg: SmartdataDb | (() => SmartdataDb)): SmartdataCollection<any> => { public getCollection = (
nameArg: string,
dbArg: SmartdataDb | (() => SmartdataDb)
): SmartdataCollection<any> => {
if (!this.collections[nameArg]) { if (!this.collections[nameArg]) {
this.collections[nameArg] = (() => { this.collections[nameArg] = (() => {
if (dbArg instanceof SmartdataDb) { if (dbArg instanceof SmartdataDb) {
@ -18,5 +21,5 @@ export class CollectionFactory {
})(); })();
} }
return this.collections[nameArg]; return this.collections[nameArg];
} };
} }

View File

@ -43,7 +43,7 @@ export class SmartdataDb {
useNewUrlParser: true, useNewUrlParser: true,
useUnifiedTopology: true, useUnifiedTopology: true,
maxPoolSize: 100, maxPoolSize: 100,
maxIdleTimeMS: 10 maxIdleTimeMS: 10,
}); });
this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName); this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
this.status = 'connected'; this.status = 'connected';

View File

@ -41,7 +41,7 @@ export function unI() {
}; };
} }
export class SmartDataDbDoc<T, TImplements> { export class SmartDataDbDoc<T extends TImplements, TImplements> {
/** /**
* the collection object an Doc belongs to * the collection object an Doc belongs to
*/ */
@ -79,13 +79,35 @@ export class SmartDataDbDoc<T, TImplements> {
constructor() {} constructor() {}
public static async getInstances<T>( public static async getInstances<T>(
this: plugins.tsclass.typeFest.Class<T>,
filterArg: plugins.tsclass.typeFest.PartialDeep<T> filterArg: plugins.tsclass.typeFest.PartialDeep<T>
): Promise<T[]> { ): Promise<T[]> {
const foundDocs = await this.collection.find(filterArg); 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
}
}
for (const key of Object.keys(filterArg)) {
convertFilterArgument(key, filterArg[key]);
}
const foundDocs = await (this as any).collection.find(convertedFilter);
const returnArray = []; const returnArray = [];
for (const item of foundDocs) { for (const item of foundDocs) {
const newInstance = new this(); const newInstance = new this();
newInstance.creationStatus = 'db'; (newInstance as any).creationStatus = 'db';
for (const key of Object.keys(item)) { for (const key of Object.keys(item)) {
newInstance[key] = item[key]; newInstance[key] = item[key];
} }
@ -95,9 +117,10 @@ export class SmartDataDbDoc<T, TImplements> {
} }
public static async getInstance<T>( public static async getInstance<T>(
this: plugins.tsclass.typeFest.Class<T>,
filterArg: plugins.tsclass.typeFest.PartialDeep<T> filterArg: plugins.tsclass.typeFest.PartialDeep<T>
): Promise<T> { ): Promise<T> {
const result = await this.getInstances<T>(filterArg); const result = await (this as any).getInstances(filterArg);
if (result && result.length > 0) { if (result && result.length > 0) {
return result[0]; return result[0];
} }
@ -110,17 +133,19 @@ export class SmartDataDbDoc<T, TImplements> {
public async save() { public async save() {
// tslint:disable-next-line: no-this-assignment // tslint:disable-next-line: no-this-assignment
const self: any = this; const self: any = this;
let dbResult: any;
switch (this.creationStatus) { switch (this.creationStatus) {
case 'db': case 'db':
await this.collection.update(self); dbResult = await this.collection.update(self);
break; break;
case 'new': case 'new':
const writeResult = await this.collection.insert(self); dbResult = await this.collection.insert(self);
this.creationStatus = 'db'; this.creationStatus = 'db';
break; break;
default: default:
console.error('neither new nor in db?'); console.error('neither new nor in db?');
} }
return dbResult;
} }
/** /**