Metadata tags (#1070)

* added console.log

* added _batchCount and _batchIndex properties

* test batch index and count

* added hint

* added hint to ParseQuery

* fixed failed tests

* removed _batchIndex and _batchCount

* added documentation and support for chaining

* added documentation and tests

* added support for metadata and tags

* added more docs

* removed validation for values

* added docs for beforeSaveFile and afterSaveFile

* updated docs

* added delete file route

* add getters

* clean up

* added decrement function to ParseObject

* udpated scope

* reverted package.json

* added metadata and tags to save request

* fixed lint fail

* remove unnecessary code

* fixed tests

* fixed linting errors

Co-authored-by: Diamond Lewis <[email protected]>

Author: stevestencil

src/ParseFile.js

@@ -418,39 +418,40 @@ const DefaultController = {
     if (source.format !== 'file') {
       throw new Error('saveFile can only be used with File-type sources.');
     }
-    // To directly upload a File, we use a REST-style AJAX request
-    const headers = {
-      'X-Parse-Application-ID': CoreManager.get('APPLICATION_ID'),
-      'Content-Type': source.type || (source.file ? source.file.type : null)
+    const base64Data = await new Promise((res, rej) => {
+      // eslint-disable-next-line no-undef
+      const reader = new FileReader();
+      reader.readAsDataURL(source.file);
+      reader.onload = () => res(reader.result);
+      reader.onerror = error => rej(error);
+    });
+    // we only want the data after the comma
+    // For example: "data:application/pdf;base64,JVBERi0xLjQKJ..." we would only want "JVBERi0xLjQKJ..."
+    const [first, second] = base64Data.split(',');
+    // in the event there is no 'data:application/pdf;base64,' at the beginning of the base64 string
+    // use the entire string instead
+    const data = second ? second : first;
+    const newSource = {
+      format: 'base64',
+      base64: data,
+      type: source.type || (source.file ? source.file.type : null),
     };
-    const jsKey = CoreManager.get('JAVASCRIPT_KEY');
-    if (jsKey) {
-      headers['X-Parse-JavaScript-Key'] = jsKey;
-    }
-    let sessionToken = options.sessionToken;
-    const userController = CoreManager.getUserController();
-    if (!sessionToken && userController) {
-      const currentUser = await userController.currentUserAsync();
-      sessionToken =  currentUser ? currentUser.getSessionToken() : undefined;
-    }
-    if (sessionToken) {
-      headers['X-Parse-Session-Token'] = sessionToken;
-    }
-    let url = CoreManager.get('SERVER_URL');
-    if (url[url.length - 1] !== '/') {
-      url += '/';
-    }
-    url += 'files/' + name;
-    return CoreManager.getRESTController().ajax('POST', url, source.file, headers, options).then(res=>res.response)
+    return await DefaultController.saveBase64(name, newSource, options);
   },
 
   saveBase64: function(name: string, source: FileSource, options?: FullOptions) {
     if (source.format !== 'base64') {
       throw new Error('saveBase64 can only be used with Base64-type sources.');
     }
-    const data: { base64: any; _ContentType?: any } = {
-      base64: source.base64
+    const data: { base64: any; _ContentType?: any, fileData: Object } = {
+      base64: source.base64,
+      fileData: {
+        metadata: { ...options.metadata },
+        tags: { ...options.tags },
+      },
     };
+    delete options.metadata;
+    delete options.tags;
     if (source.type) {
       data._ContentType = source.type;
     }

src/__tests__/ParseFile-test.js

@@ -373,13 +373,15 @@ describe('FileController', () => {
   });
 
   it('saves files via ajax', () => {
-    const file = new ParseFile('parse.txt', [61, 170, 236, 120]);
+    // eslint-disable-next-line no-undef
+    const blob = new Blob([61, 170, 236, 120]);
+    const file = new ParseFile('parse.txt', blob);
     file._source.format = 'file';
 
     return file.save().then(function(f) {
       expect(f).toBe(file);
-      expect(f.name()).toBe('/api.parse.com/1/files/parse.txt');
-      expect(f.url()).toBe('https://files.parsetfss.com/a//api.parse.com/1/files/parse.txt');
+      expect(f.name()).toBe('parse.txt');
+      expect(f.url()).toBe('https://files.parsetfss.com/a/parse.txt');
     });
   });
 
@@ -647,13 +649,15 @@ describe('FileController', () => {
       });
     };
     CoreManager.setRESTController({ request, ajax });
-    const file = new ParseFile('parse.txt', [61, 170, 236, 120]);
+    // eslint-disable-next-line no-undef
+    const blob = new Blob([61, 170, 236, 120]);
+    const file = new ParseFile('parse.txt', blob);
     file._source.format = 'file';
 
     return file.save({ sessionToken: 'testing_sessionToken' }).then(function(f) {
       expect(f).toBe(file);
-      expect(f.name()).toBe('/api.parse.com/1/files/parse.txt');
-      expect(f.url()).toBe('https://files.parsetfss.com/a//api.parse.com/1/files/parse.txt');
+      expect(f.name()).toBe('parse.txt');
+      expect(f.url()).toBe('https://files.parsetfss.com/a/parse.txt');
     });
   });
 
@@ -685,38 +689,97 @@ describe('FileController', () => {
       });
     };
     CoreManager.setRESTController({ request, ajax });
-    const file = new ParseFile('parse.txt', [61, 170, 236, 120]);
+    // eslint-disable-next-line no-undef
+    const blob = new Blob([61, 170, 236, 120]);
+    const file = new ParseFile('parse.txt', blob);
     file._source.format = 'file';
 
     return file.save().then(function(f) {
       expect(f).toBe(file);
-      expect(f.name()).toBe('/api.parse.com/1/files/parse.txt');
-      expect(f.url()).toBe('https://files.parsetfss.com/a//api.parse.com/1/files/parse.txt');
+      expect(f.name()).toBe('parse.txt');
+      expect(f.url()).toBe('https://files.parsetfss.com/a/parse.txt');
     });
   });
 
-  it('saves files via object saveAll options', async () => {
-    const ajax = jest.fn().mockResolvedValueOnce({
-      response: {
-        name: 'parse.txt',
-        url: 'http://files.parsetfss.com/a/parse.txt'
+  it('should save file using saveFile with metadata and tags', async () => {
+    CoreManager.set('UserController', {
+      currentUserAsync() {
+        return Promise.resolve({
+          getSessionToken() {
+            return 'currentUserToken';
+          }
+        });
       }
     });
-    CoreManager.setRESTController({ ajax, request: () => {
+    const request = jest.fn((method, path) => {
+      const name = path.substr(path.indexOf('/') + 1);
+      return Promise.resolve({
+        name: name,
+        url: 'https://files.parsetfss.com/a/' + name
+      });
+    });
+    const ajax = function(method, path, data, headers, options) {
+      expect(options.sessionToken).toBe('currentUserToken')
+      const name = path.substr(path.indexOf('/') + 1);
+      return Promise.resolve({
+        response: {
+          name: name,
+          url: 'https://files.parsetfss.com/a/' + name
+        }
+      });
+    };
+    CoreManager.setRESTController({ request, ajax });
+    // eslint-disable-next-line no-undef
+    const blob = new Blob([61, 170, 236, 120]);
+    const file = new ParseFile('parse.txt', blob);
+    file._source.format = 'file';
+    file.addMetadata('foo', 'bar');
+    file.addTag('bar', 'foo');
+    const f = await file.save();
+    expect(f).toBe(file);
+    expect(f.name()).toBe('parse.txt');
+    expect(f.url()).toBe('https://files.parsetfss.com/a/parse.txt');
+    expect(request).toHaveBeenCalledWith(
+      'POST',
+      'files/parse.txt',
+      {
+        base64: 'NjExNzAyMzYxMjA=',
+        fileData: {
+          metadata: {
+            foo: 'bar',
+          },
+          tags: {
+            bar: 'foo',
+          },
+        },
+      },
+      { requestTask: expect.any(Function) },
+    );
+  });
+
+  it('saves files via object saveAll options', async () => {
+    const ajax = async () => {};
+    const request = jest.fn(async (method, path, data, options) => {
+      if (path.indexOf('files/') === 0) {
+        expect(options.sessionToken).toBe('testToken');
+        return {
+          name: 'parse.txt',
+          url: 'http://files.parsetfss.com/a/parse.txt'
+        };
+      }
       return [ { success: { objectId: 'child' } } ];
-    } });
+    });
+    CoreManager.setRESTController({ ajax, request });
     CoreManager.setLocalDatastore(mockLocalDatastore);
 
-    const file = new ParseFile('parse.txt', [61, 170, 236, 120]);
+    // eslint-disable-next-line no-undef
+    const blob = new Blob([61, 170, 236, 120]);
+    const file = new ParseFile('parse.txt', blob);
     file._source.format = 'file';
     const object = ParseObject.fromJSON({ className: 'TestObject' });
     object.set('file', file);
     await ParseObject.saveAll([object], { sessionToken: 'testToken' });
-
-    const request = ajax.mock.calls[0];
-    expect(request[1]).toBe('https://api.parse.com/1/files/parse.txt')
-    expect(request[3]['X-Parse-Session-Token']).toBe('testToken');
-    expect(request[4].sessionToken).toBe('testToken');
+    expect(request).toHaveBeenCalled();
   });
 
   it('should throw error if file deleted without name', async (done) => {