Merge pull request #168 from gregolsky/v4.0

fix passing includes via session.load()

Author: gregolsky

src/Documents/Session/DocumentSession.ts

@@ -139,11 +139,7 @@ export class DocumentSession extends InMemoryDocumentSessionOperations
         options = options || {};
 
         this.conventions.tryRegisterEntityType(options.documentType);
-        const objType = this.conventions.findEntityType(options.documentType);
-
-        const loadOperation = new LoadOperation(this);
-        const loadInternalPromise = this._loadInternal<TEntity>(ids, loadOperation, null)
-            .then(() => loadOperation.getDocuments<TEntity>(objType))
+        const loadInternalPromise = this.loadInternal(ids, options.includes, options.documentType)
             .then((docs: EntitiesCollectionObject<TEntity> | TEntity) => {
                 if (isLoadingSingle) {
                     return docs[Object.keys(docs)[0]];
@@ -157,13 +153,11 @@ export class DocumentSession extends InMemoryDocumentSessionOperations
         return loadInternalPromise;
     }
 
-    private async _loadInternal<T>( //TODO: unused!
-        ids: string[],
-        operation: LoadOperation): Promise<void>;
-    private async _loadInternal<T>(
+    private async _loadInternal(
         ids: string[],
-        operation: LoadOperation, writable: stream.Writable): Promise<void>;
-    private async _loadInternal<T>(
+        operation: LoadOperation, 
+        writable: stream.Writable): Promise<void>;
+    private async _loadInternal(
         ids: string[],
         operation: LoadOperation, writable?: stream.Writable)
         : Promise<void> {
@@ -361,7 +355,9 @@ export class DocumentSession extends InMemoryDocumentSessionOperations
     }
 
     public async loadInternal<TResult extends object>(
-        ids: string[], includes: string[], documentType: DocumentType<TResult>):
+        ids: string[], 
+        includes: string[], 
+        documentType: DocumentType<TResult>):
         Promise<EntitiesCollectionObject<TResult>> {
         if (!ids) {
             throwError("InvalidArgumentException", "Ids cannot be null");

test/Documents/ReadmeSamples.ts

@@ -12,6 +12,7 @@ import {
     QueryStatistics,
     StreamQueryStatistics,
     AbstractIndexCreationTask,
+    LoadOptions,
 } from "../../src";
 import { TypeUtil } from "../../src/Utility/TypeUtil";
 
@@ -98,6 +99,27 @@ describe("Readme query samples", function () {
             assert.strictEqual(session.advanced.numberOfRequests, 1);
         });
 
+        it("loading data with passing includes", async () => {
+            // tslint:disable-next-line:no-shadowed-variable
+            const session = store.openSession();
+            // users/1
+            // {
+            //      "name": "John",
+            //      "kids": ["users/2", "users/3"]
+            // }
+
+            const user1 = await session
+                .load("users/1", { includes: [ "kids" ] } as LoadOptions<any>);
+
+            const user2 = await session.load("users/2"); // this won't call server again
+            // Document users/1 is going to be pulled along 
+            // with docs referenced in "kids" field within a single request
+
+            assert.ok(user1);
+            assert.ok(user2);
+            assert.strictEqual(session.advanced.numberOfRequests, 1);
+        });
+
     });
 
     describe("attachments", () => {