Merge pull request #150 from gregolsky/v4.0

unify object mapper usage, remove import cycle

Author: gregolsky

README.md

@@ -625,7 +625,7 @@ docsChanges.on("error", err => {
     await session.saveChanges();
 }
 
-...
+// ...
 // dispose changes instance once you're done
 changes.dispose();
 
@@ -635,8 +635,9 @@ changes.dispose();
 
 #### Stream documents with ID prefix
 ```javascript
-// stream() returns a Readable 
 const userStream = await session.advanced.stream("users/");
+// stream() method returns a Readable 
+
 userStream.on("data", user => {
     // User { name: 'Anna', id: 'users/1-A' }
 });
@@ -649,16 +650,17 @@ userStream.on("error", err => {
 ```javascript
 // create a query
 const query = session.query({ collection: "users" }).whereGreaterThan("age", 29);
-// can get query stats passing a stats callback to stream()
+
 let stats;
 // stream() returns a Readable 
+// get query stats passing a stats callback to stream() method
 const queryStream = await session.advanced.stream(query, _ => stats = _);
 
 queryStream.on("data", user => {
     // User { name: 'Anna', id: 'users/1-A' }
 });
 
-// or can get stats using an event listener
+// get stats using an event listener
 queryStream.once("stats", stats => {
 // { resultEtag: 7464021133404493000,
 //   isStale: false,
@@ -687,7 +689,7 @@ const user = {
 await session.store(user, "users/1");
 await session.saveChanges();
 
-// modify doc to create a new revision
+// modify the document to create a new revision
 user.name = "Roman";
 user.age = 40;
 await session.saveChanges();
@@ -708,18 +710,13 @@ const revisions = await session.advanced.revisions.getFor("users/1");
 
 ### Suggestions
 ```javascript
-// Having data:
+// users collection
 // [ User {
 //     name: 'John',
 //     age: 30,
 //     registeredAt: 2017-11-10T23:00:00.000Z,
 //     kids: [Array],
 //     id: 'users/1-A' },
-//   User {
-//     name: 'Stefanie',
-//     age: 25,
-//     registeredAt: 2015-07-29T22:00:00.000Z,
-//     id: 'users/2-A' } ]
 
 // and a static index like:
 class UsersIndex extends AbstractIndexCreationTask {
@@ -742,11 +739,7 @@ const suggestionQueryResult = await session.query({ collection: "users" })
 
 ## Using object literals for entities
 
-In order to comfortably use object literals as entities set function getting collection name based on the content of the object - `store.conventions.
-findCollectionNameForObjectLiteral()`. This needs to be done *before* a `initialize()` call on `DocumentStore` instance. If you fail to do so, your entites will land up in *@empty* collection having an *UUID* for an ID. 
-
-For example here's a function using *collection* field to set collection name:
-
+In order to comfortably use object literals as entities set function getting collection name based on the content of the object - `store.conventions.findCollectionNameForObjectLiteral()`. This needs to be done *before* an `initialize()` call on `DocumentStore` instance. If you fail to do so, your entites will land up in *@empty* collection having an *UUID* for an ID. E.g.
 ```javascript
 store.conventions.findCollectionNameForObjectLiteral = entity => entity["collection"];
 ```

src/Documents/Commands/FacetQueryCommand.ts

@@ -21,7 +21,7 @@ export class FacetQueryCommand extends QueryCommand {
 
         let body: string = null;
         this.result = await FacetQueryCommand.parseQueryResultResponseAsync(
-            bodyStream, this._conventions, fromCache, this._typedObjectMapper, b => body = b);
+            bodyStream, this._conventions, fromCache, b => body = b);
 
         return body;
     }
@@ -30,7 +30,6 @@ export class FacetQueryCommand extends QueryCommand {
         bodyStream: stream.Stream,
         conventions: DocumentConventions,
         fromCache: boolean,
-        mapper: TypesAwareObjectMapper,
         bodyCallback?: (body: string) => void): Promise<QueryResult> {
 
         const resultsPromise = RavenCommandResponsePipeline.create<object[]>()
@@ -48,7 +47,7 @@ export class FacetQueryCommand extends QueryCommand {
 
         const [results, includes, rest] = await Promise.all([resultsPromise, includesPromise, restPromise]);
         const rawResult = Object.assign({} as any, rest, { results, includes }) as QueryResult;
-        const queryResult = mapper.fromObjectLiteral<QueryResult>(rawResult, {
+        const queryResult = conventions.objectMapper.fromObjectLiteral<QueryResult>(rawResult, {
             typeName: QueryResult.name,
             nestedTypes: {
                 indexTimestamp: "date",

src/Documents/Commands/GetConflictsCommand.ts

@@ -3,14 +3,17 @@ import { RavenCommand } from "../../Http/RavenCommand";
 import { GetConflictsResult } from "./GetConflictsResult";
 import { ServerNode } from "../../Http/ServerNode";
 import * as stream from "readable-stream";
+import { DocumentConventions } from "../Conventions/DocumentConventions";
 
 export class GetConflictsCommand extends RavenCommand<GetConflictsResult> {
 
     private readonly _id: string;
+    private readonly _conventions: DocumentConventions;
 
-    public constructor(id: string) {
+    public constructor(id: string, conventions: DocumentConventions) {
         super();
         this._id = id;
+        this._conventions = conventions;
     }
 
     public get isReadRequest(): boolean {
@@ -34,7 +37,7 @@ export class GetConflictsCommand extends RavenCommand<GetConflictsResult> {
         let body: string = null;
         await this._defaultPipeline(_ => body = _).process(bodyStream)
             .then(results => {
-                this.result = this._typedObjectMapper.fromObjectLiteral(results, {
+                this.result = this._conventions.objectMapper.fromObjectLiteral(results, {
                     nestedTypes: {
                         "results[].lastModified": "Date"
                     }

src/Documents/Commands/QueryCommand.ts

@@ -91,7 +91,7 @@ export class QueryCommand extends RavenCommand<QueryResult> {
 
         let body: string = null;
         this.result = await QueryCommand.parseQueryResultResponseAsync(
-            bodyStream, this._conventions, fromCache, this._typedObjectMapper, b => body = b);
+            bodyStream, this._conventions, fromCache, b => body = b);
 
         return body;
     }
@@ -104,7 +104,6 @@ export class QueryCommand extends RavenCommand<QueryResult> {
         bodyStream: stream.Stream,
         conventions: DocumentConventions,
         fromCache: boolean,
-        mapper: TypesAwareObjectMapper,
         bodyCallback?: (body: string) => void): Promise<QueryResult> {
 
         const resultsPromise = parseDocumentResults(bodyStream, conventions, bodyCallback);
@@ -113,13 +112,14 @@ export class QueryCommand extends RavenCommand<QueryResult> {
 
         const [results, includes, rest] = await Promise.all([resultsPromise, includesPromise, restPromise]);
         const rawResult = Object.assign({} as any, rest, { results, includes }) as QueryResult;
-        const queryResult = mapper.fromObjectLiteral<QueryResult>(rawResult, {
-            typeName: QueryResult.name,
-            nestedTypes: {
-                indexTimestamp: "date",
-                lastQueryTime: "date"
-            }
-        }, new Map([[QueryResult.name, QueryResult]]));
+        const queryResult = conventions.objectMapper
+            .fromObjectLiteral<QueryResult>(rawResult, {
+                typeName: QueryResult.name,
+                nestedTypes: {
+                    indexTimestamp: "date",
+                    lastQueryTime: "date"
+                }
+            }, new Map([[QueryResult.name, QueryResult]]));
 
         if (fromCache) {
             queryResult.durationInMs = -1;

src/Documents/Conventions/DocumentConventions.ts

@@ -70,9 +70,8 @@ export class DocumentConventions {
     private _localEntityFieldNameConvention: CasingConvention;
     private _remoteEntityFieldNameConvention: CasingConvention;
 
-    private _entityObjectMapper: TypesAwareObjectMapper;
+    private _objectMapper: TypesAwareObjectMapper;
 
-    private _entityJsonSerializer: JsonSerializer;
     private _useCompression;
 
     public constructor() {
@@ -111,21 +110,20 @@ export class DocumentConventions {
         this._maxHttpCacheSize = 128 * 1024 * 1024;
 
         this._knownEntityTypes = new Map();
-        this._entityObjectMapper = new TypesAwareObjectMapper({
+        this._objectMapper = new TypesAwareObjectMapper({
             dateFormat: DateUtil.DEFAULT_DATE_FORMAT,
             documentConventions: this
         });
 
-        this._entityJsonSerializer = JsonSerializer.getDefaultForEntities();
         this._useCompression = null;
     }
 
-    public get entityObjectMapper(): TypesAwareObjectMapper {
-        return this._entityObjectMapper;
+    public get objectMapper(): TypesAwareObjectMapper {
+        return this._objectMapper;
     }
 
-    public set entityObjectMapper(value: TypesAwareObjectMapper) {
-        this._entityObjectMapper = value;
+    public set objectMapper(value: TypesAwareObjectMapper) {
+        this._objectMapper = value;
     }
 
     public get readBalanceBehavior(): ReadBalanceBehavior {
@@ -158,7 +156,7 @@ export class DocumentConventions {
     public deserializeEntityFromJson(documentType: ObjectTypeDescriptor, document: object): object {
         try {
             const typeName = documentType ? documentType.name : null;
-            return this.entityObjectMapper.fromObjectLiteral(document, { typeName });
+            return this.objectMapper.fromObjectLiteral(document, { typeName });
         } catch (err) {
             throwError("RavenException", "Cannot deserialize entity", err);
         }

src/Documents/DocumentStore.ts

@@ -103,7 +103,7 @@ export class DocumentStore extends DocumentStoreBase {
         disposeChain
             .then(() => {
                 if (this._multiDbHiLo) {
-                    return BluebirdPromise.resolve()
+                    return Promise.resolve()
                         .then(() => this._multiDbHiLo.returnUnusedRange())
                         .catch(err => this._log.warn("Error returning unused ID range.", err));
                 }
@@ -115,6 +115,7 @@ export class DocumentStore extends DocumentStoreBase {
                 return new BluebirdPromise((resolve, reject) => {
                     let listenersExecCallbacksCount = 0;
                     const listenersCount = this.listenerCount("afterDispose");
+                    
                     this.emit("afterDispose", () => {
                         if (listenersCount === ++listenersExecCallbacksCount) {
                             resolve();

src/Documents/Identity/Commands/NextHiloCommand.ts

@@ -5,6 +5,7 @@ import { RavenCommand } from "../../../Http/RavenCommand";
 import { throwError } from "../../../Exceptions";
 import { HttpRequestParameters } from "../../../Primitives/Http";
 import * as stream from "readable-stream";
+import { DocumentConventions } from "../../Conventions/DocumentConventions";
 
 export interface HiLoResult {
     prefix: string;
@@ -22,13 +23,15 @@ export class NextHiloCommand extends RavenCommand<HiLoResult> {
     private readonly _lastRangeAt: Date;
     private readonly _identityPartsSeparator: string;
     private readonly _lastRangeMax: number;
+    private readonly _conventions: DocumentConventions;
 
     public constructor(
         tag: string,
         lastBatchSize: number,
         lastRangeAt: Date,
         identityPartsSeparator: string,
-        lastRangeMax: number) {
+        lastRangeMax: number,
+        conventions: DocumentConventions) {
         super();
 
         if (!tag) {
@@ -44,6 +47,7 @@ export class NextHiloCommand extends RavenCommand<HiLoResult> {
         this._lastRangeAt = lastRangeAt;
         this._identityPartsSeparator = identityPartsSeparator;
         this._lastRangeMax = lastRangeMax;
+        this._conventions = conventions;
     }
 
     public createRequest(node: ServerNode): HttpRequestParameters {
@@ -67,11 +71,14 @@ export class NextHiloCommand extends RavenCommand<HiLoResult> {
         let body: string = null;
         await this._defaultPipeline(_ => body = _).process(bodyStream)
             .then(results => {
-                this.result = this._reviveResultTypes(results, {
-                    nestedTypes: {
-                        lastRangeAt: "date"
-                    }
-                });
+                this.result = this._reviveResultTypes(
+                    results, 
+                    this._conventions, 
+                    {
+                        nestedTypes: {
+                            lastRangeAt: "date"
+                        }
+                    });
             });
         return body;
     }

src/Documents/Identity/HiloIdGenerator.ts

@@ -89,7 +89,12 @@ export class HiloIdGenerator {
 
     protected _getNextRange(): Promise<void> {
         const hiloCmd = new NextHiloCommand(
-            this._tag, this._lastBatchSize, this._lastRangeAt, this._identityPartsSeparator, this._range.maxId);
+            this._tag, 
+            this._lastBatchSize, 
+            this._lastRangeAt, 
+            this._identityPartsSeparator, 
+            this._range.maxId,
+            this._store.conventions);
         return this._store.getRequestExecutor(this._dbName).execute(hiloCmd)
             .then(() => {
                 const result: HiLoResult = hiloCmd.result;

src/Documents/Identity/IHiloIdGenerator.ts

@@ -1,6 +1,8 @@
+import { DocumentConventions } from "../Conventions/DocumentConventions";
+
 export interface IHiloIdGenerator {
     //TODO ? nextId(...args: Array<object | string | string>): Promise<number>;
-    generateDocumentId(...args: Array<object | string>): Promise<string>;
+    generateDocumentId(...args: any[]): Promise<string>;
 
     returnUnusedRange(): Promise<void>;
 }

src/Documents/Operations/Indexes/GetIndexErrorsOperation.ts

@@ -17,7 +17,7 @@ export class GetIndexErrorsOperation implements IMaintenanceOperation<IndexError
     }
 
     public getCommand(conventions: DocumentConventions): RavenCommand<IndexErrors[]> {
-        return new GetIndexErrorsCommand(this._indexNames);
+        return new GetIndexErrorsCommand(this._indexNames, conventions);
     }
 
     public get resultType(): OperationResultType {
@@ -28,10 +28,12 @@ export class GetIndexErrorsOperation implements IMaintenanceOperation<IndexError
 
 export class GetIndexErrorsCommand extends RavenCommand<IndexErrors[]> {
     private readonly _indexNames: string[];
+    private readonly _conventions: DocumentConventions;
 
-    public constructor(indexNames: string[]) {
+    public constructor(indexNames: string[], conventions: DocumentConventions) {
         super();
         this._indexNames = indexNames;
+        this._conventions = conventions;
     }
 
     public createRequest(node: ServerNode): HttpRequestParameters {
@@ -62,7 +64,7 @@ export class GetIndexErrorsCommand extends RavenCommand<IndexErrors[]> {
         let body: string = null;
         await this._defaultPipeline(_ => body = _).process(bodyStream)
             .then(results => {
-                this.result = this._reviveResultTypes(results, typeInfo)["results"];
+                this.result = this._reviveResultTypes(results, this._conventions, typeInfo)["results"];
             });
         return body;
     }