Skip to content

Add useMasterKey option to Parse.File.destroy() #1285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 11, 2021
Merged

Add useMasterKey option to Parse.File.destroy() #1285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6adbeba
Add useMasterKey option to Parse.File.destroy()
dplewis Jan 11, 2021
dc74073
improve coverage
dplewis Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/ParseFile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,14 +323,23 @@ class ParseFile {
* Deletes the file from the Parse cloud.
* In Cloud Code and Node only with Master Key.
*
* @param {object} options
* * Valid options are:<ul>
* <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
* be used for this request.
* <pre>
* @returns {Promise} Promise that is resolved when the delete finishes.
*/
destroy() {
destroy(options?: FullOptions = {}) {
if (!this._name) {
throw new ParseError(ParseError.FILE_DELETE_UNNAMED_ERROR, 'Cannot delete an unnamed file.');
}
const destroyOptions = { useMasterKey: true };
if (options.hasOwnProperty('useMasterKey')) {
destroyOptions.useMasterKey = options.useMasterKey;
}
const controller = CoreManager.getFileController();
return controller.deleteFile(this._name).then(() => {
return controller.deleteFile(this._name, destroyOptions).then(() => {
this._data = null;
this._requestTask = null;
return this;
Expand Down Expand Up @@ -540,11 +549,13 @@ const DefaultController = {
});
},

deleteFile: function (name) {
deleteFile: function (name: string, options?: FullOptions) {
const headers = {
'X-Parse-Application-ID': CoreManager.get('APPLICATION_ID'),
'X-Parse-Master-Key': CoreManager.get('MASTER_KEY'),
};
if (options.useMasterKey) {
headers['X-Parse-Master-Key'] = CoreManager.get('MASTER_KEY');
}
let url = CoreManager.get('SERVER_URL');
if (url[url.length - 1] !== '/') {
url += '/';
Expand Down
19 changes: 17 additions & 2 deletions src/__tests__/ParseFile-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,16 +821,31 @@ describe('FileController', () => {
}
});

it('should delete file with masterKey', async () => {
const file = new ParseFile('filename', [1, 2, 3]);
const ajax = jest.fn().mockResolvedValueOnce({ foo: 'bar' });
CoreManager.setRESTController({ ajax, request: () => {} });
CoreManager.set('MASTER_KEY', 'masterKey');
const result = await file.destroy({ useMasterKey: true });
expect(result).toEqual(file);
expect(ajax).toHaveBeenCalledWith('DELETE', 'https://api.parse.com/1/files/filename', '', {
'X-Parse-Application-ID': null,
'X-Parse-Master-Key': 'masterKey',
});
CoreManager.set('MASTER_KEY', null);
});

it('should delete file', async () => {
const file = new ParseFile('filename', [1, 2, 3]);
const ajax = jest.fn().mockResolvedValueOnce({ foo: 'bar' });
CoreManager.setRESTController({ ajax, request: () => {} });
const result = await file.destroy();
CoreManager.set('MASTER_KEY', 'masterKey');
const result = await file.destroy({ useMasterKey: false });
expect(result).toEqual(file);
expect(ajax).toHaveBeenCalledWith('DELETE', 'https://api.parse.com/1/files/filename', '', {
'X-Parse-Application-ID': null,
'X-Parse-Master-Key': null,
});
CoreManager.set('MASTER_KEY', null);
});

it('should handle delete file error', async () => {
Expand Down