Skip to content
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

Accept context via header X-Parse-Cloud-Context #7437

Merged
merged 16 commits into from
Jul 26, 2021
Merged

Accept context via header X-Parse-Cloud-Context #7437

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6e75987
failing testcase
cbaker6 Jun 20, 2021
0c23bfd
add header
cbaker6 Jun 20, 2021
9e24f48
switch to X-Parse-Cloud-Context header
cbaker6 Jun 20, 2021
119aee4
Merge remote-tracking branch 'upstream/master' into context
cbaker6 Jun 20, 2021
a1be895
add back blank line that lint removed
cbaker6 Jun 20, 2021
3158916
test replacing context header with body context. Add support for sett…
cbaker6 Jun 21, 2021
0fa1d3a
add back blank line
cbaker6 Jun 21, 2021
bb972b8
cover error when _context body is wrong
cbaker6 Jun 21, 2021
a551957
Update middlewares.js
cbaker6 Jun 21, 2021
8503ce6
revert accidental status change
cbaker6 Jun 21, 2021
3d4a4dd
make sure context always decodes to an object else throw error
cbaker6 Jun 21, 2021
33087a0
improve context object check
cbaker6 Jun 22, 2021
9aedefb
Merge branch 'master' into context
cbaker6 Jun 22, 2021
6808c05
Merge branch 'master' into context
cbaker6 Jul 23, 2021
8da1e4c
Merge branch 'master' into context
cbaker6 Jul 24, 2021
a3e6e66
Merge branch 'master' into context
davimacedo Jul 26, 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
126 changes: 126 additions & 0 deletions spec/CloudCode.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2519,6 +2519,38 @@ describe('afterFind hooks', () => {
});
});

it('should throw error if context header is malformed', async () => {
let calledBefore = false;
let calledAfter = false;
Parse.Cloud.beforeSave('TestObject', () => {
calledBefore = true;
});
Parse.Cloud.afterSave('TestObject', () => {
calledAfter = true;
});
const req = request({
method: 'POST',
url: 'http://localhost:8378/1/classes/TestObject',
headers: {
'X-Parse-Application-Id': 'test',
'X-Parse-REST-API-Key': 'rest',
'X-Parse-Cloud-Context': 'key',
},
body: {
foo: 'bar',
},
});
try {
await req;
fail('Should have thrown error');
} catch (e) {
expect(e).toBeDefined();
expect(e.data.code).toEqual(Parse.Error.INVALID_JSON);
}
expect(calledBefore).toBe(false);
expect(calledAfter).toBe(false);
});

it('should expose context in beforeSave/afterSave via header', async () => {
let calledBefore = false;
let calledAfter = false;
Expand Down Expand Up @@ -2551,6 +2583,39 @@ describe('afterFind hooks', () => {
expect(calledAfter).toBe(true);
});

it('should override header context with body context in beforeSave/afterSave', async () => {
let calledBefore = false;
let calledAfter = false;
Parse.Cloud.beforeSave('TestObject', req => {
expect(req.object.get('foo')).toEqual('bar');
expect(req.context.otherKey).toBe(10);
expect(req.context.key).toBe('hello');
calledBefore = true;
});
Parse.Cloud.afterSave('TestObject', req => {
expect(req.object.get('foo')).toEqual('bar');
expect(req.context.otherKey).toBe(10);
expect(req.context.key).toBe('hello');
calledAfter = true;
});
const req = request({
method: 'POST',
url: 'http://localhost:8378/1/classes/TestObject',
headers: {
'X-Parse-REST-API-Key': 'rest',
'X-Parse-Cloud-Context': '{"key":"value","otherKey":1}',
},
body: {
foo: 'bar',
_ApplicationId: 'test',
_context: '{"key":"hello","otherKey":10}',
},
});
await req;
expect(calledBefore).toBe(true);
expect(calledAfter).toBe(true);
});

it('should expose context in before and afterSave', async () => {
let calledBefore = false;
let calledAfter = false;
Expand Down Expand Up @@ -2836,6 +2901,67 @@ describe('afterLogin hook', () => {
done();
});

it('context options should override _context object property when saving a new object', async () => {
Parse.Cloud.beforeSave('TestObject', req => {
expect(req.context.a).toEqual('a');
expect(req.context.hello).not.toBeDefined();
expect(req._context).not.toBeDefined();
expect(req.object._context).not.toBeDefined();
expect(req.object.context).not.toBeDefined();
});
Parse.Cloud.afterSave('TestObject', req => {
expect(req.context.a).toEqual('a');
expect(req.context.hello).not.toBeDefined();
expect(req._context).not.toBeDefined();
expect(req.object._context).not.toBeDefined();
expect(req.object.context).not.toBeDefined();
});
const obj = new TestObject();
obj.set('_context', { hello: 'world' });
await obj.save(null, { context: { a: 'a' } });
});

xit('should throw error if _context option is malformed', async () => {
cbaker6 marked this conversation as resolved.
Show resolved Hide resolved
let calledBefore = false;
let calledAfter = false;
Parse.Cloud.beforeSave('TestObject', () => {
calledBefore = true;
});
Parse.Cloud.afterSave('TestObject', () => {
calledAfter = true;
});
const obj = new TestObject();
try {
await obj.save(null, { context: "{ a: 'a' }" });
fail('Should have thrown error');
} catch (e) {
expect(e).toBeDefined();
}
expect(calledBefore).toBe(false);
expect(calledAfter).toBe(false);
});

xit('should throw error if _context body is malformed', async () => {
cbaker6 marked this conversation as resolved.
Show resolved Hide resolved
let calledBefore = false;
let calledAfter = false;
Parse.Cloud.beforeSave('TestObject', () => {
calledBefore = true;
});
Parse.Cloud.afterSave('TestObject', () => {
calledAfter = true;
});
const obj = new TestObject();
try {
obj.set('_context', "{ a: 'a' }");
await obj.save();
fail('Should have thrown error');
} catch (e) {
expect(e).toBeDefined();
}
expect(calledBefore).toBe(false);
expect(calledAfter).toBe(false);
});

it('should have access to context when saving a new object', async () => {
Parse.Cloud.beforeSave('TestObject', req => {
expect(req.context.a).toEqual('a');
Expand Down
28 changes: 24 additions & 4 deletions src/middlewares.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,14 @@ const getMountForRequest = function (req) {
// req.auth - the Auth for this request
export function handleParseHeaders(req, res, next) {
var mount = getMountForRequest(req);

let context = {};
if (req.get('X-Parse-Cloud-Context') != null) {
try {
context = JSON.parse(req.get('X-Parse-Cloud-Context'));
} catch (e) {
return malformedContext(req, res);
}
}
var info = {
appId: req.get('X-Parse-Application-Id'),
sessionToken: req.get('X-Parse-Session-Token'),
Expand All @@ -35,7 +42,7 @@ export function handleParseHeaders(req, res, next) {
dotNetKey: req.get('X-Parse-Windows-Key'),
restAPIKey: req.get('X-Parse-REST-API-Key'),
clientVersion: req.get('X-Parse-Client-Version'),
context: req.get('X-Parse-Cloud-Context') == null ? {} : JSON.parse(req.get('X-Parse-Cloud-Context')),
context: context,
};

var basicAuth = httpAuth(req);
Expand Down Expand Up @@ -105,8 +112,16 @@ export function handleParseHeaders(req, res, next) {
info.masterKey = req.body._MasterKey;
delete req.body._MasterKey;
}
if (req.body._context && req.body._context instanceof Object) {
info.context = req.body._context;
if (req.body._context) {
if (req.body._context instanceof Object) {
info.context = req.body._context;
} else {
try {
info.context = JSON.parse(req.body._context);
mtrezza marked this conversation as resolved.
Show resolved Hide resolved
} catch (e) {
return malformedContext(req, res);
}
}
delete req.body._context;
}
if (req.body._ContentType) {
Expand Down Expand Up @@ -454,3 +469,8 @@ function invalidRequest(req, res) {
res.status(403);
res.end('{"error":"unauthorized"}');
}

function malformedContext(req, res) {
res.status(500);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This error is caused by a developer mistake, so it should be a 4xx response code.

I suggest 400 Bad Request:

The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switched to 400. I'm assuming you only meant the status change?

res.json({ code: Parse.Error.INVALID_JSON, error: 'Invalid object for context.' });
}