feat: align file trigger syntax with class trigger; use the new synta…

…x `Parse.Cloud.beforeSave(Parse.File, (request) => {})`, the old syntax `Parse.Cloud.beforeSaveFile((request) => {})` has been deprecated (#7966)
parse-community · May 29, 2022 · c6dcad8 · c6dcad8
1 parent ac283d3
commit c6dcad8
Show file tree

Hide file tree

Showing 6 changed files with 123 additions and 91 deletions.
diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md
@@ -10,6 +10,7 @@ The following is a list of deprecations, according to the [Deprecation Policy](h
 | DEPPS4 | Remove convenience method for http request `Parse.Cloud.httpRequest` | [#7589](https://github.com/parse-community/parse-server/pull/7589)   | 5.0.0 (2022)                    | 6.0.0 (2023)                    | deprecated            | -     |
 | DEPPS5 | Config option `allowClientClassCreation` defaults to `false` | [#7925](https://github.com/parse-community/parse-server/pull/7925)   | 5.3.0 (2022)                    | 7.0.0 (2024)                    | deprecated            | -     |
 | DEPPS6 | Auth providers disabled by default | [#7953](https://github.com/parse-community/parse-server/pull/7953)   | 5.3.0 (2022)                    | 7.0.0 (2024)                    | deprecated            | -     |
+| DEPPS7 | Remove file trigger syntax `Parse.Cloud.beforeSaveFile((request) => {})` | [#7966](https://github.com/parse-community/parse-server/pull/7966)   | 5.3.0 (2022)                    | 7.0.0 (2024)                    | deprecated            | -     |
 
 [i_deprecation]: ## "The version and date of the deprecation."
 [i_removal]: ## "The version and date of the planned removal."

diff --git a/spec/CloudCode.Validator.spec.js b/spec/CloudCode.Validator.spec.js
@@ -737,7 +737,8 @@ describe('cloud validator', () => {
   });
 
   it('basic beforeSaveFile skipWithMasterKey', async done => {
-    Parse.Cloud.beforeSaveFile(
+    Parse.Cloud.beforeSave(
+      Parse.File,
       () => {
         throw 'beforeSaveFile should have resolved using master key.';
       },
@@ -1431,7 +1432,7 @@ describe('cloud validator', () => {
   });
 
   it('validate beforeSaveFile', async done => {
-    Parse.Cloud.beforeSaveFile(() => {}, validatorSuccess);
+    Parse.Cloud.beforeSave(Parse.File, () => {}, validatorSuccess);
 
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
     const result = await file.save({ useMasterKey: true });
@@ -1440,7 +1441,7 @@ describe('cloud validator', () => {
   });
 
   it('validate beforeSaveFile fail', async done => {
-    Parse.Cloud.beforeSaveFile(() => {}, validatorFail);
+    Parse.Cloud.beforeSave(Parse.File, () => {}, validatorFail);
     try {
       const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
       await file.save({ useMasterKey: true });
@@ -1452,7 +1453,7 @@ describe('cloud validator', () => {
   });
 
   it('validate afterSaveFile', async done => {
-    Parse.Cloud.afterSaveFile(() => {}, validatorSuccess);
+    Parse.Cloud.afterSave(Parse.File, () => {}, validatorSuccess);
 
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
     const result = await file.save({ useMasterKey: true });
@@ -1461,7 +1462,7 @@ describe('cloud validator', () => {
   });
 
   it('validate afterSaveFile fail', async done => {
-    Parse.Cloud.beforeSaveFile(() => {}, validatorFail);
+    Parse.Cloud.beforeSave(Parse.File, () => {}, validatorFail);
     try {
       const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
       await file.save({ useMasterKey: true });
@@ -1473,7 +1474,7 @@ describe('cloud validator', () => {
   });
 
   it('validate beforeDeleteFile', async done => {
-    Parse.Cloud.beforeDeleteFile(() => {}, validatorSuccess);
+    Parse.Cloud.beforeDelete(Parse.File, () => {}, validatorSuccess);
 
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
     await file.save();
@@ -1482,7 +1483,7 @@ describe('cloud validator', () => {
   });
 
   it('validate beforeDeleteFile fail', async done => {
-    Parse.Cloud.beforeDeleteFile(() => {}, validatorFail);
+    Parse.Cloud.beforeDelete(Parse.File, () => {}, validatorFail);
     try {
       const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
       await file.save();
@@ -1495,7 +1496,7 @@ describe('cloud validator', () => {
   });
 
   it('validate afterDeleteFile', async done => {
-    Parse.Cloud.afterDeleteFile(() => {}, validatorSuccess);
+    Parse.Cloud.afterDelete(Parse.File, () => {}, validatorSuccess);
 
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
     await file.save();
@@ -1504,7 +1505,7 @@ describe('cloud validator', () => {
   });
 
   it('validate afterDeleteFile fail', async done => {
-    Parse.Cloud.afterDeleteFile(() => {}, validatorFail);
+    Parse.Cloud.afterDelete(Parse.File, () => {}, validatorFail);
     try {
       const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
       await file.save();

diff --git a/spec/CloudCode.spec.js b/spec/CloudCode.spec.js
@@ -3405,7 +3405,7 @@ describe('saveFile hooks', () => {
   it('beforeSaveFile should return file that is already saved and not save anything to files adapter', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
-    Parse.Cloud.beforeSaveFile(() => {
+    Parse.Cloud.beforeSave(Parse.File, () => {
       const newFile = new Parse.File('some-file.txt');
       newFile._url = 'http://www.somewhere.com/parse/files/some-app-id/some-file.txt';
       return newFile;
@@ -3420,7 +3420,7 @@ describe('saveFile hooks', () => {
 
   it('beforeSaveFile should throw error', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeSaveFile(() => {
+    Parse.Cloud.beforeSave(Parse.File, () => {
       throw new Parse.Error(400, 'some-error-message');
     });
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3434,8 +3434,8 @@ describe('saveFile hooks', () => {
   it('beforeSaveFile should change values of uploaded file by editing fileObject directly', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
-    Parse.Cloud.beforeSaveFile(async req => {
-      expect(req.triggerName).toEqual('beforeSaveFile');
+    Parse.Cloud.beforeSave(Parse.File, async req => {
+      expect(req.triggerName).toEqual('beforeSave');
       expect(req.master).toBe(true);
       req.file.addMetadata('foo', 'bar');
       req.file.addTag('tagA', 'some-tag');
@@ -3463,8 +3463,8 @@ describe('saveFile hooks', () => {
   it('beforeSaveFile should change values by returning new fileObject', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
-    Parse.Cloud.beforeSaveFile(async req => {
-      expect(req.triggerName).toEqual('beforeSaveFile');
+    Parse.Cloud.beforeSave(Parse.File, async req => {
+      expect(req.triggerName).toEqual('beforeSave');
       expect(req.fileSize).toBe(3);
       const newFile = new Parse.File('donald_duck.pdf', [4, 5, 6], 'application/pdf');
       newFile.setMetadata({ foo: 'bar' });
@@ -3497,8 +3497,8 @@ describe('saveFile hooks', () => {
   it('beforeSaveFile should contain metadata and tags saved from client', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
-    Parse.Cloud.beforeSaveFile(async req => {
-      expect(req.triggerName).toEqual('beforeSaveFile');
+    Parse.Cloud.beforeSave(Parse.File, async req => {
+      expect(req.triggerName).toEqual('beforeSave');
       expect(req.fileSize).toBe(3);
       expect(req.file).toBeInstanceOf(Parse.File);
       expect(req.file.name()).toBe('popeye.txt');
@@ -3526,7 +3526,7 @@ describe('saveFile hooks', () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const config = Config.get('test');
     config.filesController.options.preserveFileName = true;
-    Parse.Cloud.beforeSaveFile(async ({ file }) => {
+    Parse.Cloud.beforeSave(Parse.File, async ({ file }) => {
       expect(file.name()).toBe('popeye.txt');
       const fileData = await file.getData();
       const newFile = new Parse.File('2020-04-01.txt', { base64: fileData });
@@ -3540,13 +3540,13 @@ describe('saveFile hooks', () => {
   it('afterSaveFile should set fileSize to null if beforeSave returns an already saved file', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
     const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
-    Parse.Cloud.beforeSaveFile(req => {
+    Parse.Cloud.beforeSave(Parse.File, req => {
       expect(req.fileSize).toBe(3);
       const newFile = new Parse.File('some-file.txt');
       newFile._url = 'http://www.somewhere.com/parse/files/some-app-id/some-file.txt';
       return newFile;
     });
-    Parse.Cloud.afterSaveFile(req => {
+    Parse.Cloud.afterSave(Parse.File, req => {
       expect(req.fileSize).toBe(null);
     });
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3559,7 +3559,7 @@ describe('saveFile hooks', () => {
 
   it('afterSaveFile should throw error', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.afterSaveFile(async () => {
+    Parse.Cloud.afterSave(Parse.File, async () => {
       throw new Parse.Error(400, 'some-error-message');
     });
     const filename = 'donald_duck.pdf';
@@ -3573,11 +3573,11 @@ describe('saveFile hooks', () => {
 
   it('afterSaveFile should call with fileObject', async done => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeSaveFile(async req => {
+    Parse.Cloud.beforeSave(Parse.File, async req => {
       req.file.setTags({ tagA: 'some-tag' });
       req.file.setMetadata({ foo: 'bar' });
     });
-    Parse.Cloud.afterSaveFile(async req => {
+    Parse.Cloud.afterSave(Parse.File, async req => {
       expect(req.master).toBe(true);
       expect(req.file._tags).toEqual({ tagA: 'some-tag' });
       expect(req.file._metadata).toEqual({ foo: 'bar' });
@@ -3589,13 +3589,13 @@ describe('saveFile hooks', () => {
 
   it('afterSaveFile should change fileSize when file data changes', async done => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeSaveFile(async req => {
+    Parse.Cloud.beforeSave(Parse.File, async req => {
       expect(req.fileSize).toBe(3);
       expect(req.master).toBe(true);
       const newFile = new Parse.File('donald_duck.pdf', [4, 5, 6, 7, 8, 9], 'application/pdf');
       return newFile;
     });
-    Parse.Cloud.afterSaveFile(async req => {
+    Parse.Cloud.afterSave(Parse.File, async req => {
       expect(req.fileSize).toBe(6);
       expect(req.master).toBe(true);
       done();
@@ -3606,7 +3606,7 @@ describe('saveFile hooks', () => {
 
   it('beforeDeleteFile should call with fileObject', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeDeleteFile(req => {
+    Parse.Cloud.beforeDelete(Parse.File, req => {
       expect(req.file).toBeInstanceOf(Parse.File);
       expect(req.file._name).toEqual('popeye.txt');
       expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
@@ -3618,7 +3618,7 @@ describe('saveFile hooks', () => {
 
   it('beforeDeleteFile should throw error', async done => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeDeleteFile(() => {
+    Parse.Cloud.beforeDelete(Parse.File, () => {
       throw new Error('some error message');
     });
     const file = new Parse.File('popeye.txt');
@@ -3632,12 +3632,12 @@ describe('saveFile hooks', () => {
 
   it('afterDeleteFile should call with fileObject', async done => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeDeleteFile(req => {
+    Parse.Cloud.beforeDelete(Parse.File, req => {
       expect(req.file).toBeInstanceOf(Parse.File);
       expect(req.file._name).toEqual('popeye.txt');
       expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
     });
-    Parse.Cloud.afterDeleteFile(req => {
+    Parse.Cloud.afterDelete(Parse.File, req => {
       expect(req.file).toBeInstanceOf(Parse.File);
       expect(req.file._name).toEqual('popeye.txt');
       expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
@@ -3649,7 +3649,7 @@ describe('saveFile hooks', () => {
 
   it('beforeSaveFile should not change file if nothing is returned', async () => {
     await reconfigureServer({ filesAdapter: mockAdapter });
-    Parse.Cloud.beforeSaveFile(() => {
+    Parse.Cloud.beforeSave(Parse.File, () => {
       return;
     });
     const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3658,7 +3658,7 @@ describe('saveFile hooks', () => {
   });
 
   it('throw custom error from beforeSaveFile', async done => {
-    Parse.Cloud.beforeSaveFile(() => {
+    Parse.Cloud.beforeSave(Parse.File, () => {
       throw new Parse.Error(Parse.Error.SCRIPT_FAILED, 'It should fail');
     });
     try {
@@ -3672,7 +3672,7 @@ describe('saveFile hooks', () => {
   });
 
   it('throw empty error from beforeSaveFile', async done => {
-    Parse.Cloud.beforeSaveFile(() => {
+    Parse.Cloud.beforeSave(Parse.File, () => {
       throw null;
     });
     try {
@@ -3684,6 +3684,55 @@ describe('saveFile hooks', () => {
       done();
     }
   });
+
+  it('legacy hooks', async () => {
+    await reconfigureServer({ filesAdapter: mockAdapter });
+    const logger = require('../lib/logger').logger;
+    const logSpy = spyOn(logger, 'warn').and.callFake(() => {});
+    const triggers = {
+      beforeSaveFile(req) {
+        req.file.setTags({ tagA: 'some-tag' });
+        req.file.setMetadata({ foo: 'bar' });
+        expect(req.triggerName).toEqual('beforeSave');
+        expect(req.master).toBe(true);
+      },
+      afterSaveFile(req) {
+        expect(req.master).toBe(true);
+        expect(req.file._tags).toEqual({ tagA: 'some-tag' });
+        expect(req.file._metadata).toEqual({ foo: 'bar' });
+      },
+      beforeDeleteFile(req) {
+        expect(req.file).toBeInstanceOf(Parse.File);
+        expect(req.file._name).toEqual('popeye.txt');
+        expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
+        expect(req.fileSize).toBe(null);
+      },
+      afterDeleteFile(req) {
+        expect(req.file).toBeInstanceOf(Parse.File);
+        expect(req.file._name).toEqual('popeye.txt');
+        expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
+      },
+    };
+
+    for (const key in triggers) {
+      spyOn(triggers, key).and.callThrough();
+      Parse.Cloud[key](triggers[key]);
+    }
+
+    const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
+    await file.save({ useMasterKey: true });
+    await new Parse.File('popeye.txt', [1, 2, 3], 'text/plain').destroy({ useMasterKey: true });
+    await new Promise(resolve => setTimeout(resolve, 100));
+    for (const key in triggers) {
+      expect(triggers[key]).toHaveBeenCalled();
+      expect(logSpy).toHaveBeenCalledWith(
+        `DeprecationWarning: Parse.Cloud.${key} is deprecated and will be removed in a future version. Use Parse.Cloud.${key.replace(
+          'File',
+          ''
+        )}(Parse.File, (request) => {})`
+      );
+    }
+  });
 });
 
 describe('sendEmail', () => {

diff --git a/src/Routers/FilesRouter.js b/src/Routers/FilesRouter.js
@@ -141,7 +141,7 @@ export class FilesRouter {
     try {
       // run beforeSaveFile trigger
       const triggerResult = await triggers.maybeRunFileTrigger(
-        triggers.Types.beforeSaveFile,
+        triggers.Types.beforeSave,
         fileObject,
         config,
         req.auth
@@ -194,12 +194,7 @@ export class FilesRouter {
         };
       }
       // run afterSaveFile trigger
-      await triggers.maybeRunFileTrigger(
-        triggers.Types.afterSaveFile,
-        fileObject,
-        config,
-        req.auth
-      );
+      await triggers.maybeRunFileTrigger(triggers.Types.afterSave, fileObject, config, req.auth);
       res.status(201);
       res.set('Location', saveResult.url);
       res.json(saveResult);
@@ -222,7 +217,7 @@ export class FilesRouter {
       file._url = filesController.adapter.getFileLocation(req.config, filename);
       const fileObject = { file, fileSize: null };
       await triggers.maybeRunFileTrigger(
-        triggers.Types.beforeDeleteFile,
+        triggers.Types.beforeDelete,
         fileObject,
         req.config,
         req.auth
@@ -231,7 +226,7 @@ export class FilesRouter {
       await filesController.deleteFile(req.config, filename);
       // run afterDeleteFile trigger
       await triggers.maybeRunFileTrigger(
-        triggers.Types.afterDeleteFile,
+        triggers.Types.afterDelete,
         fileObject,
         req.config,
         req.auth