Get Data from File (#780)

Author: dplewis

integration/test/ParseFileTest.js

@@ -38,4 +38,47 @@ describe('Parse.File', () => {
     result = await query.get(object.id);
     assert.equal(file2.url(), result.get('file2').url());
   });
+
+  it('can not get data from unsaved file', async () => {
+    const file = new Parse.File('parse-server-logo', [61, 170, 236, 120]);
+    file._data = null;
+    try {
+      await file.getData();
+    } catch (e) {
+      assert.equal(e.message, 'Cannot retrieve data for unsaved ParseFile.');
+    }
+  });
+
+  it('can get file data from byte array', async () => {
+    const file = new Parse.File('parse-server-logo', [61, 170, 236, 120]);
+    let data = await file.getData();
+    assert.equal(data, 'ParseA==');
+    file._data = null;
+    await file.save();
+    assert.equal(file._data, null)
+    data = await file.getData();
+    assert.equal(data, 'ParseA==');
+  });
+
+  it('can get file data from base64', async () => {
+    const file = new Parse.File('parse-server-logo', { base64: 'ParseA==' });
+    let data = await file.getData();
+    assert.equal(data, 'ParseA==');
+    file._data = null;
+    await file.save();
+    assert.equal(file._data, null)
+    data = await file.getData();
+    assert.equal(data, 'ParseA==');
+  });
+
+  it('can get file data from full base64', async () => {
+    const file = new Parse.File('parse-server-logo', { base64: 'data:image/jpeg;base64,ParseA==' });
+    let data = await file.getData();
+    assert.equal(data, 'ParseA==');
+    file._data = null;
+    await file.save();
+    assert.equal(file._data, null)
+    data = await file.getData();
+    assert.equal(data, 'ParseA==');
+  });
 });

src/ParseFile.js

@@ -65,6 +65,7 @@ class ParseFile {
   _url: ?string;
   _source: FileSource;
   _previousSave: ?Promise;
+  _data: string;
 
   /**
    * @param name {String} The file's name. This will be prefixed by a unique
@@ -101,9 +102,10 @@ class ParseFile {
 
     if (data !== undefined) {
       if (Array.isArray(data)) {
+        this._data = ParseFile.encodeBase64(data);
         this._source = {
           format: 'base64',
-          base64: ParseFile.encodeBase64(data),
+          base64: this._data,
           type: specifiedType
         };
       } else if (typeof File !== 'undefined' && data instanceof File) {
@@ -125,12 +127,14 @@ class ParseFile {
         if (commaIndex !== -1) {
           const matches = dataUriRegexp.exec(base64.slice(0, commaIndex + 1));
           // if data URI with type and charset, there will be 4 matches.
+          this._data = base64.slice(commaIndex + 1);
           this._source = {
             format: 'base64',
-            base64: base64.slice(commaIndex + 1),
+            base64: this._data,
             type: matches[1]
           };
         } else {
+          this._data = base64;
           this._source = {
             format: 'base64',
             base64: base64,
@@ -143,6 +147,25 @@ class ParseFile {
     }
   }
 
+  /**
+   * Return the data for the file, downloading it if not already present.
+   * Data is present if initialized with Byte Array, Base64 or Saved with Uri.
+   * Data is cleared if saved with File object selected with a file upload control
+   *
+   * @return {Promise} Promise that is resolve with base64 data
+   */
+  async getData(): Promise<String> {
+    if (this._data) {
+      return this._data;
+    }
+    if (!this._url) {
+      throw new Error('Cannot retrieve data for unsaved ParseFile.');
+    }
+    const controller = CoreManager.getFileController();
+    const result = await controller.download(this._url);
+    this._data = result.base64;
+    return this._data;
+  }
   /**
    * Gets the name of the file. Before save is called, this is the filename
    * given by the user. After save is called, that name gets prefixed with a
@@ -189,10 +212,19 @@ class ParseFile {
         this._previousSave = controller.saveFile(this._name, this._source, options).then((res) => {
           this._name = res.name;
           this._url = res.url;
+          this._data = null;
           return this;
         });
       } else if (this._source.format === 'uri') {
-        this._previousSave = controller.saveUri(this._name, this._source, options).then((res) => {
+        this._previousSave = controller.download(this._source.uri).then((result) => {
+          const newSource = {
+            format: 'base64',
+            base64: result.base64,
+            type: result.contentType,
+          };
+          this._data = result.base64;
+          return controller.saveBase64(this._name, newSource, options);
+        }).then((res) => {
           this._name = res.name;
           this._url = res.url;
           return this;
@@ -299,20 +331,6 @@ const DefaultController = {
     return CoreManager.getRESTController().request('POST', path, data, options);
   },
 
-  saveUri: function(name: string, source: FileSource, options?: FullOptions) {
-    if (source.format !== 'uri') {
-      throw new Error('saveUri can only be used with Uri-type sources.');
-    }
-    return this.download(source.uri).then((result) => {
-      const newSource = {
-        format: 'base64',
-        base64: result.base64,
-        type: result.contentType,
-      };
-      return this.saveBase64(name, newSource, options);
-    });
-  },
-
   download: function(uri) {
     if (XHR) {
       return this.downloadAjax(uri);

src/__tests__/ParseFile-test.js

@@ -37,7 +37,10 @@ describe('ParseFile', () => {
     CoreManager.setFileController({
       saveFile: generateSaveMock('http://files.parsetfss.com/a/'),
       saveBase64: generateSaveMock('http://files.parsetfss.com/a/'),
-      saveUri: generateSaveMock('http://files.parsetfss.com/a/'),
+      download: () => Promise.resolve({
+        base64: 'ParseA==',
+        contentType: 'image/png',
+      }),
     });
   });
 
@@ -274,17 +277,9 @@ describe('FileController', () => {
     });
   });
 
-  it('saveUri without uri type', () => {
-    try {
-      defaultController.saveUri('name', { format: 'unknown' });
-    } catch (error) {
-      expect(error.message).toBe('saveUri can only be used with Uri-type sources.');
-    }
-  });
-
   it('saveUri with uri type', async () => {
-    const source = { format: 'uri', uri: 'https://example.com/image.png' };
-    jest.spyOn(
+    const file = new ParseFile('parse.png', { uri: 'https://example.com/image.png' });
+    const spy = jest.spyOn(
       defaultController,
       'download'
     )
@@ -296,14 +291,15 @@ describe('FileController', () => {
       });
 
     jest.spyOn(defaultController, 'saveBase64');
-    await defaultController.saveUri('fileName', source, {});
+    await file.save();
     expect(defaultController.download).toHaveBeenCalledTimes(1);
     expect(defaultController.saveBase64).toHaveBeenCalledTimes(1);
     expect(defaultController.saveBase64.mock.calls[0]).toEqual([
-      'fileName',
+      'parse.png',
       { format: 'base64', base64: 'ParseA==', type: 'image/png' },
       {}
     ]);
+    spy.mockRestore();
   });
 
   it('download with base64 http', async () => {
@@ -408,4 +404,41 @@ describe('FileController', () => {
       expect(e).toBe('Cannot make a request: No definition of XMLHttpRequest was found.');
     }
   });
+
+  it('getData', async () => {
+    const file = new ParseFile('parse.png', [61, 170, 236, 120]);
+    const data = await file.getData();
+    expect(data).toBe('ParseA==');
+  });
+
+  it('getData unsaved file', async () => {
+    const file = new ParseFile('parse.png');
+    try {
+      await file.getData();
+    } catch (e) {
+      expect(e.message).toBe('Cannot retrieve data for unsaved ParseFile.');
+    }
+  });
+
+  it('getData via download', async () => {
+    const file = new ParseFile('parse.txt', { base64: 'ParseA==' });
+    file._data = null;
+    const result = await file.save();
+
+    const spy = jest.spyOn(
+      defaultController,
+      'download'
+    )
+      .mockImplementationOnce(() => {
+        return Promise.resolve({
+          base64: 'ParseA==',
+          contentType: 'image/png',
+        });
+      });
+
+    const data = await result.getData();
+    expect(defaultController.download).toHaveBeenCalledTimes(1);
+    expect(data).toBe('ParseA==');
+    spy.mockRestore();
+  });
 });