Skip to content

Commit c6dcad8

Browse files
dblythydblythy
authored
feat: align file trigger syntax with class trigger; use the new syntax Parse.Cloud.beforeSave(Parse.File, (request) => {}), the old syntax Parse.Cloud.beforeSaveFile((request) => {}) has been deprecated (#7966)
1 parent ac283d3 commit c6dcad8

File tree

6 files changed

+123
-91
lines changed

6 files changed

+123
-91
lines changed

‎DEPRECATIONS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The following is a list of deprecations, according to the [Deprecation Policy](h
1010
| 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 | - |
1111
| 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 | - |
1212
| 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 | - |
13+
| 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 | - |
1314

1415
[i_deprecation]: ## "The version and date of the deprecation."
1516
[i_removal]: ## "The version and date of the planned removal."

‎spec/CloudCode.Validator.spec.js‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,8 @@ describe('cloud validator', () => {
737737
});
738738

739739
it('basic beforeSaveFile skipWithMasterKey', async done => {
740-
Parse.Cloud.beforeSaveFile(
740+
Parse.Cloud.beforeSave(
741+
Parse.File,
741742
() => {
742743
throw 'beforeSaveFile should have resolved using master key.';
743744
},
@@ -1431,7 +1432,7 @@ describe('cloud validator', () => {
14311432
});
14321433

14331434
it('validate beforeSaveFile', async done => {
1434-
Parse.Cloud.beforeSaveFile(() => {}, validatorSuccess);
1435+
Parse.Cloud.beforeSave(Parse.File, () => {}, validatorSuccess);
14351436

14361437
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14371438
const result = await file.save({ useMasterKey: true });
@@ -1440,7 +1441,7 @@ describe('cloud validator', () => {
14401441
});
14411442

14421443
it('validate beforeSaveFile fail', async done => {
1443-
Parse.Cloud.beforeSaveFile(() => {}, validatorFail);
1444+
Parse.Cloud.beforeSave(Parse.File, () => {}, validatorFail);
14441445
try {
14451446
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14461447
await file.save({ useMasterKey: true });
@@ -1452,7 +1453,7 @@ describe('cloud validator', () => {
14521453
});
14531454

14541455
it('validate afterSaveFile', async done => {
1455-
Parse.Cloud.afterSaveFile(() => {}, validatorSuccess);
1456+
Parse.Cloud.afterSave(Parse.File, () => {}, validatorSuccess);
14561457

14571458
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14581459
const result = await file.save({ useMasterKey: true });
@@ -1461,7 +1462,7 @@ describe('cloud validator', () => {
14611462
});
14621463

14631464
it('validate afterSaveFile fail', async done => {
1464-
Parse.Cloud.beforeSaveFile(() => {}, validatorFail);
1465+
Parse.Cloud.beforeSave(Parse.File, () => {}, validatorFail);
14651466
try {
14661467
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14671468
await file.save({ useMasterKey: true });
@@ -1473,7 +1474,7 @@ describe('cloud validator', () => {
14731474
});
14741475

14751476
it('validate beforeDeleteFile', async done => {
1476-
Parse.Cloud.beforeDeleteFile(() => {}, validatorSuccess);
1477+
Parse.Cloud.beforeDelete(Parse.File, () => {}, validatorSuccess);
14771478

14781479
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14791480
await file.save();
@@ -1482,7 +1483,7 @@ describe('cloud validator', () => {
14821483
});
14831484

14841485
it('validate beforeDeleteFile fail', async done => {
1485-
Parse.Cloud.beforeDeleteFile(() => {}, validatorFail);
1486+
Parse.Cloud.beforeDelete(Parse.File, () => {}, validatorFail);
14861487
try {
14871488
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
14881489
await file.save();
@@ -1495,7 +1496,7 @@ describe('cloud validator', () => {
14951496
});
14961497

14971498
it('validate afterDeleteFile', async done => {
1498-
Parse.Cloud.afterDeleteFile(() => {}, validatorSuccess);
1499+
Parse.Cloud.afterDelete(Parse.File, () => {}, validatorSuccess);
14991500

15001501
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
15011502
await file.save();
@@ -1504,7 +1505,7 @@ describe('cloud validator', () => {
15041505
});
15051506

15061507
it('validate afterDeleteFile fail', async done => {
1507-
Parse.Cloud.afterDeleteFile(() => {}, validatorFail);
1508+
Parse.Cloud.afterDelete(Parse.File, () => {}, validatorFail);
15081509
try {
15091510
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
15101511
await file.save();

‎spec/CloudCode.spec.js‎

Lines changed: 72 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3405,7 +3405,7 @@ describe('saveFile hooks', () => {
34053405
it('beforeSaveFile should return file that is already saved and not save anything to files adapter', async () => {
34063406
await reconfigureServer({ filesAdapter: mockAdapter });
34073407
const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
3408-
Parse.Cloud.beforeSaveFile(() => {
3408+
Parse.Cloud.beforeSave(Parse.File, () => {
34093409
const newFile = new Parse.File('some-file.txt');
34103410
newFile._url = 'http://www.somewhere.com/parse/files/some-app-id/some-file.txt';
34113411
return newFile;
@@ -3420,7 +3420,7 @@ describe('saveFile hooks', () => {
34203420

34213421
it('beforeSaveFile should throw error', async () => {
34223422
await reconfigureServer({ filesAdapter: mockAdapter });
3423-
Parse.Cloud.beforeSaveFile(() => {
3423+
Parse.Cloud.beforeSave(Parse.File, () => {
34243424
throw new Parse.Error(400, 'some-error-message');
34253425
});
34263426
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3434,8 +3434,8 @@ describe('saveFile hooks', () => {
34343434
it('beforeSaveFile should change values of uploaded file by editing fileObject directly', async () => {
34353435
await reconfigureServer({ filesAdapter: mockAdapter });
34363436
const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
3437-
Parse.Cloud.beforeSaveFile(async req => {
3438-
expect(req.triggerName).toEqual('beforeSaveFile');
3437+
Parse.Cloud.beforeSave(Parse.File, async req => {
3438+
expect(req.triggerName).toEqual('beforeSave');
34393439
expect(req.master).toBe(true);
34403440
req.file.addMetadata('foo', 'bar');
34413441
req.file.addTag('tagA', 'some-tag');
@@ -3463,8 +3463,8 @@ describe('saveFile hooks', () => {
34633463
it('beforeSaveFile should change values by returning new fileObject', async () => {
34643464
await reconfigureServer({ filesAdapter: mockAdapter });
34653465
const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
3466-
Parse.Cloud.beforeSaveFile(async req => {
3467-
expect(req.triggerName).toEqual('beforeSaveFile');
3466+
Parse.Cloud.beforeSave(Parse.File, async req => {
3467+
expect(req.triggerName).toEqual('beforeSave');
34683468
expect(req.fileSize).toBe(3);
34693469
const newFile = new Parse.File('donald_duck.pdf', [4, 5, 6], 'application/pdf');
34703470
newFile.setMetadata({ foo: 'bar' });
@@ -3497,8 +3497,8 @@ describe('saveFile hooks', () => {
34973497
it('beforeSaveFile should contain metadata and tags saved from client', async () => {
34983498
await reconfigureServer({ filesAdapter: mockAdapter });
34993499
const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
3500-
Parse.Cloud.beforeSaveFile(async req => {
3501-
expect(req.triggerName).toEqual('beforeSaveFile');
3500+
Parse.Cloud.beforeSave(Parse.File, async req => {
3501+
expect(req.triggerName).toEqual('beforeSave');
35023502
expect(req.fileSize).toBe(3);
35033503
expect(req.file).toBeInstanceOf(Parse.File);
35043504
expect(req.file.name()).toBe('popeye.txt');
@@ -3526,7 +3526,7 @@ describe('saveFile hooks', () => {
35263526
await reconfigureServer({ filesAdapter: mockAdapter });
35273527
const config = Config.get('test');
35283528
config.filesController.options.preserveFileName = true;
3529-
Parse.Cloud.beforeSaveFile(async ({ file }) => {
3529+
Parse.Cloud.beforeSave(Parse.File, async ({ file }) => {
35303530
expect(file.name()).toBe('popeye.txt');
35313531
const fileData = await file.getData();
35323532
const newFile = new Parse.File('2020-04-01.txt', { base64: fileData });
@@ -3540,13 +3540,13 @@ describe('saveFile hooks', () => {
35403540
it('afterSaveFile should set fileSize to null if beforeSave returns an already saved file', async () => {
35413541
await reconfigureServer({ filesAdapter: mockAdapter });
35423542
const createFileSpy = spyOn(mockAdapter, 'createFile').and.callThrough();
3543-
Parse.Cloud.beforeSaveFile(req => {
3543+
Parse.Cloud.beforeSave(Parse.File, req => {
35443544
expect(req.fileSize).toBe(3);
35453545
const newFile = new Parse.File('some-file.txt');
35463546
newFile._url = 'http://www.somewhere.com/parse/files/some-app-id/some-file.txt';
35473547
return newFile;
35483548
});
3549-
Parse.Cloud.afterSaveFile(req => {
3549+
Parse.Cloud.afterSave(Parse.File, req => {
35503550
expect(req.fileSize).toBe(null);
35513551
});
35523552
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3559,7 +3559,7 @@ describe('saveFile hooks', () => {
35593559

35603560
it('afterSaveFile should throw error', async () => {
35613561
await reconfigureServer({ filesAdapter: mockAdapter });
3562-
Parse.Cloud.afterSaveFile(async () => {
3562+
Parse.Cloud.afterSave(Parse.File, async () => {
35633563
throw new Parse.Error(400, 'some-error-message');
35643564
});
35653565
const filename = 'donald_duck.pdf';
@@ -3573,11 +3573,11 @@ describe('saveFile hooks', () => {
35733573

35743574
it('afterSaveFile should call with fileObject', async done => {
35753575
await reconfigureServer({ filesAdapter: mockAdapter });
3576-
Parse.Cloud.beforeSaveFile(async req => {
3576+
Parse.Cloud.beforeSave(Parse.File, async req => {
35773577
req.file.setTags({ tagA: 'some-tag' });
35783578
req.file.setMetadata({ foo: 'bar' });
35793579
});
3580-
Parse.Cloud.afterSaveFile(async req => {
3580+
Parse.Cloud.afterSave(Parse.File, async req => {
35813581
expect(req.master).toBe(true);
35823582
expect(req.file._tags).toEqual({ tagA: 'some-tag' });
35833583
expect(req.file._metadata).toEqual({ foo: 'bar' });
@@ -3589,13 +3589,13 @@ describe('saveFile hooks', () => {
35893589

35903590
it('afterSaveFile should change fileSize when file data changes', async done => {
35913591
await reconfigureServer({ filesAdapter: mockAdapter });
3592-
Parse.Cloud.beforeSaveFile(async req => {
3592+
Parse.Cloud.beforeSave(Parse.File, async req => {
35933593
expect(req.fileSize).toBe(3);
35943594
expect(req.master).toBe(true);
35953595
const newFile = new Parse.File('donald_duck.pdf', [4, 5, 6, 7, 8, 9], 'application/pdf');
35963596
return newFile;
35973597
});
3598-
Parse.Cloud.afterSaveFile(async req => {
3598+
Parse.Cloud.afterSave(Parse.File, async req => {
35993599
expect(req.fileSize).toBe(6);
36003600
expect(req.master).toBe(true);
36013601
done();
@@ -3606,7 +3606,7 @@ describe('saveFile hooks', () => {
36063606

36073607
it('beforeDeleteFile should call with fileObject', async () => {
36083608
await reconfigureServer({ filesAdapter: mockAdapter });
3609-
Parse.Cloud.beforeDeleteFile(req => {
3609+
Parse.Cloud.beforeDelete(Parse.File, req => {
36103610
expect(req.file).toBeInstanceOf(Parse.File);
36113611
expect(req.file._name).toEqual('popeye.txt');
36123612
expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
@@ -3618,7 +3618,7 @@ describe('saveFile hooks', () => {
36183618

36193619
it('beforeDeleteFile should throw error', async done => {
36203620
await reconfigureServer({ filesAdapter: mockAdapter });
3621-
Parse.Cloud.beforeDeleteFile(() => {
3621+
Parse.Cloud.beforeDelete(Parse.File, () => {
36223622
throw new Error('some error message');
36233623
});
36243624
const file = new Parse.File('popeye.txt');
@@ -3632,12 +3632,12 @@ describe('saveFile hooks', () => {
36323632

36333633
it('afterDeleteFile should call with fileObject', async done => {
36343634
await reconfigureServer({ filesAdapter: mockAdapter });
3635-
Parse.Cloud.beforeDeleteFile(req => {
3635+
Parse.Cloud.beforeDelete(Parse.File, req => {
36363636
expect(req.file).toBeInstanceOf(Parse.File);
36373637
expect(req.file._name).toEqual('popeye.txt');
36383638
expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
36393639
});
3640-
Parse.Cloud.afterDeleteFile(req => {
3640+
Parse.Cloud.afterDelete(Parse.File, req => {
36413641
expect(req.file).toBeInstanceOf(Parse.File);
36423642
expect(req.file._name).toEqual('popeye.txt');
36433643
expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
@@ -3649,7 +3649,7 @@ describe('saveFile hooks', () => {
36493649

36503650
it('beforeSaveFile should not change file if nothing is returned', async () => {
36513651
await reconfigureServer({ filesAdapter: mockAdapter });
3652-
Parse.Cloud.beforeSaveFile(() => {
3652+
Parse.Cloud.beforeSave(Parse.File, () => {
36533653
return;
36543654
});
36553655
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
@@ -3658,7 +3658,7 @@ describe('saveFile hooks', () => {
36583658
});
36593659

36603660
it('throw custom error from beforeSaveFile', async done => {
3661-
Parse.Cloud.beforeSaveFile(() => {
3661+
Parse.Cloud.beforeSave(Parse.File, () => {
36623662
throw new Parse.Error(Parse.Error.SCRIPT_FAILED, 'It should fail');
36633663
});
36643664
try {
@@ -3672,7 +3672,7 @@ describe('saveFile hooks', () => {
36723672
});
36733673

36743674
it('throw empty error from beforeSaveFile', async done => {
3675-
Parse.Cloud.beforeSaveFile(() => {
3675+
Parse.Cloud.beforeSave(Parse.File, () => {
36763676
throw null;
36773677
});
36783678
try {
@@ -3684,6 +3684,55 @@ describe('saveFile hooks', () => {
36843684
done();
36853685
}
36863686
});
3687+
3688+
it('legacy hooks', async () => {
3689+
await reconfigureServer({ filesAdapter: mockAdapter });
3690+
const logger = require('../lib/logger').logger;
3691+
const logSpy = spyOn(logger, 'warn').and.callFake(() => {});
3692+
const triggers = {
3693+
beforeSaveFile(req) {
3694+
req.file.setTags({ tagA: 'some-tag' });
3695+
req.file.setMetadata({ foo: 'bar' });
3696+
expect(req.triggerName).toEqual('beforeSave');
3697+
expect(req.master).toBe(true);
3698+
},
3699+
afterSaveFile(req) {
3700+
expect(req.master).toBe(true);
3701+
expect(req.file._tags).toEqual({ tagA: 'some-tag' });
3702+
expect(req.file._metadata).toEqual({ foo: 'bar' });
3703+
},
3704+
beforeDeleteFile(req) {
3705+
expect(req.file).toBeInstanceOf(Parse.File);
3706+
expect(req.file._name).toEqual('popeye.txt');
3707+
expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
3708+
expect(req.fileSize).toBe(null);
3709+
},
3710+
afterDeleteFile(req) {
3711+
expect(req.file).toBeInstanceOf(Parse.File);
3712+
expect(req.file._name).toEqual('popeye.txt');
3713+
expect(req.file._url).toEqual('http://www.somewhere.com/popeye.txt');
3714+
},
3715+
};
3716+
3717+
for (const key in triggers) {
3718+
spyOn(triggers, key).and.callThrough();
3719+
Parse.Cloud[key](triggers[key]);
3720+
}
3721+
3722+
const file = new Parse.File('popeye.txt', [1, 2, 3], 'text/plain');
3723+
await file.save({ useMasterKey: true });
3724+
await new Parse.File('popeye.txt', [1, 2, 3], 'text/plain').destroy({ useMasterKey: true });
3725+
await new Promise(resolve => setTimeout(resolve, 100));
3726+
for (const key in triggers) {
3727+
expect(triggers[key]).toHaveBeenCalled();
3728+
expect(logSpy).toHaveBeenCalledWith(
3729+
`DeprecationWarning: Parse.Cloud.${key} is deprecated and will be removed in a future version. Use Parse.Cloud.${key.replace(
3730+
'File',
3731+
''
3732+
)}(Parse.File, (request) => {})`
3733+
);
3734+
}
3735+
});
36873736
});
36883737

36893738
describe('sendEmail', () => {

‎src/Routers/FilesRouter.js‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export class FilesRouter {
141141
try {
142142
// run beforeSaveFile trigger
143143
const triggerResult = await triggers.maybeRunFileTrigger(
144-
triggers.Types.beforeSaveFile,
144+
triggers.Types.beforeSave,
145145
fileObject,
146146
config,
147147
req.auth
@@ -194,12 +194,7 @@ export class FilesRouter {
194194
};
195195
}
196196
// run afterSaveFile trigger
197-
await triggers.maybeRunFileTrigger(
198-
triggers.Types.afterSaveFile,
199-
fileObject,
200-
config,
201-
req.auth
202-
);
197+
await triggers.maybeRunFileTrigger(triggers.Types.afterSave, fileObject, config, req.auth);
203198
res.status(201);
204199
res.set('Location', saveResult.url);
205200
res.json(saveResult);
@@ -222,7 +217,7 @@ export class FilesRouter {
222217
file._url = filesController.adapter.getFileLocation(req.config, filename);
223218
const fileObject = { file, fileSize: null };
224219
await triggers.maybeRunFileTrigger(
225-
triggers.Types.beforeDeleteFile,
220+
triggers.Types.beforeDelete,
226221
fileObject,
227222
req.config,
228223
req.auth
@@ -231,7 +226,7 @@ export class FilesRouter {
231226
await filesController.deleteFile(req.config, filename);
232227
// run afterDeleteFile trigger
233228
await triggers.maybeRunFileTrigger(
234-
triggers.Types.afterDeleteFile,
229+
triggers.Types.afterDelete,
235230
fileObject,
236231
req.config,
237232
req.auth

0 commit comments

Comments
 (0)