if the server gzips the file, unzip it (#102)

Author: scottdallamura

api/FileContainerApi.ts

@@ -11,6 +11,7 @@
 // Licensed under the MIT license.  See LICENSE file in the project root for full license information.
 
 import stream = require("stream");
+import * as zlib from "zlib";
 import * as restm from 'typed-rest-client/RestClient';
 import * as httpm from 'typed-rest-client//HttpClient';
 import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
@@ -55,15 +56,14 @@ export class FileContainerApi extends FileContainerApiBase.FileContainerApiBase
 
             try {
                 let verData: vsom.ClientVersioningData = await this.vsoClient.getVersioningData(
-                    "3.2-preview.4",
+                    "4.0-preview.4",
                     "Container",
                     "e4f5c81e-e250-447b-9fef-bd48471bea5e",
                     routeValues,
                     queryValues);
 
                 let url: string = verData.requestUrl;
-                let options: restm.IRequestOptions = this.createRequestOptions('application/octet-stream', 
-                                                                                verData.apiVersion);
+                let options: restm.IRequestOptions = this.createRequestOptions('application/octet-stream', verData.apiVersion);
 
                 let res = await this.http.get(url);
 
@@ -99,7 +99,15 @@ export class FileContainerApi extends FileContainerApiBase.FileContainerApiBase
                     reject(new Error(msg));
                 }
                 else {
-                    rres.result = res.message;
+                    // if the response is gzipped, unzip it
+                    if (res.message.headers["content-encoding"] === "gzip") {
+                        let unzipStream = zlib.createGunzip();
+                        res.message.pipe(unzipStream);
+                        rres.result = unzipStream;
+                    }
+                    else {
+                        rres.result = res.message;
+                    }
                     resolve(rres);
                 }
             }
@@ -112,15 +120,15 @@ export class FileContainerApi extends FileContainerApiBase.FileContainerApiBase
     public createItem(contentStream: NodeJS.ReadableStream, uncompressedLength: number, containerId: number, itemPath: string, scope: string, options: any): Promise<FileContainerInterfaces.FileContainerItem> {
         return new Promise<FileContainerInterfaces.FileContainerItem>((resolve, reject) => {
             let chunkStream = new ChunkStream(this, uncompressedLength, containerId, itemPath, scope, options);
-            
+
             chunkStream.on('finish', () => {
                 resolve(chunkStream.getItem());
             });
-            
+
             contentStream.pipe(chunkStream);
         });
     }
-    
+
     // used by ChunkStream
     public _createItem(
         customHeaders: VsoBaseInterfaces.IHeaders,
@@ -144,7 +152,7 @@ export class FileContainerApi extends FileContainerApiBase.FileContainerApiBase
         customHeaders["Content-Type"] = "";
 
 
-        this.vsoClient.getVersioningData("3.2-preview.4", "Container", "e4f5c81e-e250-447b-9fef-bd48471bea5e", routeValues, queryValues)
+        this.vsoClient.getVersioningData("4.0-preview.4", "Container", "e4f5c81e-e250-447b-9fef-bd48471bea5e", routeValues, queryValues)
             .then((versioningData: vsom.ClientVersioningData) => {
                 var url: string = versioningData.requestUrl;
                 var serializationData = {  responseTypeMetadata: FileContainerInterfaces.TypeInfo.FileContainerItem, responseIsCollection: false };
@@ -170,24 +178,24 @@ export class FileContainerApi extends FileContainerApiBase.FileContainerApiBase
 
 class ChunkStream extends stream.Writable {
     private static ChunkSize: number = (16 * 1024 * 1024);
-    
+
     private _options: any;
     private _api: FileContainerApi;
     private _buffer: Buffer = new Buffer(ChunkStream.ChunkSize);
-    
+
     private _length: number = 0;
     private _startRange: number = 0;
     private _bytesToSend: number = 0;
     private _totalReceived: number = 0;
-    
+
     private _uncompressedLength: number;
-    
+
     private _containerId: number;
     private _itemPath: string;
     private _scope: string;
-    
+
     private _item: FileContainerInterfaces.FileContainerItem;
-    
+
     constructor(api: FileContainerApi, uncompressedLength: number, containerId: number, itemPath: string, scope: string, options: any) {
         super();
         this._api = api;
@@ -196,10 +204,10 @@ class ChunkStream extends stream.Writable {
         this._containerId = containerId;
         this._itemPath = itemPath;
         this._scope = scope;
-        
+
         this._bytesToSend = this._options.isGzipped ? this._options.compressedLength : uncompressedLength;
     }
-    
+
     _write(data: Buffer | string, encoding: string, callback: Function): void {
         let chunk: Buffer = <Buffer>data;
         if (!chunk) {
@@ -212,7 +220,7 @@ class ChunkStream extends stream.Writable {
             }
             return;
         }
-        
+
         let newBuffer: Buffer = null;
         if (this._length + chunk.length > ChunkStream.ChunkSize) {
             // overflow
@@ -234,22 +242,22 @@ class ChunkStream extends stream.Writable {
             callback();
         }
     }
-    
+
     private _sendChunk(callback: Function, newBuffer?: Buffer) {
         let endRange = this._startRange + this._length;
         let headers = {
             "Content-Range": "bytes " + this._startRange + "-" + (endRange - 1) + "/" + this._bytesToSend,
             "Content-Length": this._length
         };
-        
+
         if (this._options.isGzipped) {
             headers["Accept-Encoding"] = "gzip";
             headers["Content-Encoding"] = "gzip";
             headers["x-tfs-filelength"] = this._uncompressedLength;
         }
-        
+
         this._startRange = endRange;
-        
+
         this._api._createItem(headers, new BufferStream(this._buffer, this._length), this._containerId, this._itemPath, this._scope, (err: any, statusCode: number, item: FileContainerInterfaces.FileContainerItem) => {
             if (newBuffer) {
                 this._length = newBuffer.length;
@@ -258,13 +266,13 @@ class ChunkStream extends stream.Writable {
             else {
                 this._length = 0;
             }
-            
+
             this._item = item;
 
             callback(err);
         });
     }
-    
+
     public getItem(): FileContainerInterfaces.FileContainerItem {
         return this._item;
     }
@@ -274,19 +282,19 @@ class BufferStream extends stream.Readable {
     private _buffer: Buffer;
     private _position: number = 0;
     private _length: number = 0;
-    
+
     constructor(buffer: Buffer, length: number) {
         super();
         this._buffer = buffer;
         this._length = length;
     }
-    
+
     _read(size: number): void {
         if (this._position >= this._length) {
             this.push(null);
             return;
         }
-        
+
         let end: number = Math.min(this._position + size, this._length);
         this.push(this._buffer.slice(this._position, end));
         this._position = end;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vso-node-api",
   "description": "Node client for Visual Studio Online/TFS REST APIs",
-  "version": "6.2.3-preview",
+  "version": "6.2.4-preview",
   "main": "./WebApi.js",
   "typings": "./WebApi.d.ts",
   "scripts": {

samples/filecontainer.ts

@@ -18,8 +18,9 @@ export async function run() {
         if (containers.length > 0) {
             let container = containers[0];
             console.log("found container " + container.name);
+            let containerId = container.id;
 
-            let items = await fileContainerApi.getItems(container.id, null, null, null, null, null, null, false);
+            let items = await fileContainerApi.getItems(containerId, null, null, null, null, null, null, false);
             console.log("found " + items.length + " items");
 
             let item = items.filter((item) => {
@@ -28,7 +29,7 @@ export async function run() {
 
             if (item) {
                 console.log("downloading " + item.path);
-                let restResponse = await fileContainerApi.getItem(container.id, null, item.path, item.path.substring(item.path.lastIndexOf('/') + 1));
+                let restResponse = await fileContainerApi.getItem(containerId, null, item.path, item.path.substring(item.path.lastIndexOf('/') + 1));
 
                 let output = "";
                 await new Promise((resolve, reject) => {
@@ -42,7 +43,6 @@ export async function run() {
                 console.log("downloaded " + item.path);
                 console.log(output);
             }
-
         }
     }
     catch (err) {