Skip to content

Commit 10ace49

Browse files
flovilmartflovilmart
authored
Adds jobs endpoint protected by masterKey (#2560)
* Adds jobs endpoint protected by masterKey * Adds connection timeout for 15 minutes in jobs * Refactors pushStatusHandler into StatusHandler * Adds reporting of _JobStatus * Only accept strings as messages * Adds test for masterKey basic auth * Adds CloudCodeRouter for cloud_code endpoint of job status, enable Jobs feature on dashboard * xit racing test
1 parent 4b2a780 commit 10ace49

File tree

12 files changed

+414
-56
lines changed

12 files changed

+414
-56
lines changed

‎spec/CloudCode.spec.js

Lines changed: 165 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ const Parse = require("parse/node");
33
const request = require('request');
44
const rp = require('request-promise');
55
const InMemoryCacheAdapter = require('../src/Adapters/Cache/InMemoryCacheAdapter').InMemoryCacheAdapter;
6+
const triggers = require('../src/triggers');
67

78
describe('Cloud Code', () => {
89
it('can load absolute cloud code file', done => {
@@ -211,7 +212,8 @@ describe('Cloud Code', () => {
211212
});
212213
});
213214

214-
it('test afterSave ignoring promise, object not found', function(done) {
215+
// TODO: Fails on CI randomly as racing
216+
xit('test afterSave ignoring promise, object not found', function(done) {
215217
Parse.Cloud.afterSave('AfterSaveTest2', function(req) {
216218
let obj = req.object;
217219
if(!obj.existed())
@@ -1005,4 +1007,166 @@ it('beforeSave should not affect fetched pointers', done => {
10051007
done();
10061008
})
10071009
});
1010+
1011+
describe('cloud jobs', () => {
1012+
it('should define a job', (done) => {
1013+
expect(() => {
1014+
Parse.Cloud.job('myJob', (req, res) => {
1015+
res.success();
1016+
});
1017+
}).not.toThrow();
1018+
1019+
rp.post({
1020+
url: 'http://localhost:8378/1/jobs/myJob',
1021+
headers: {
1022+
'X-Parse-Application-Id': Parse.applicationId,
1023+
'X-Parse-Master-Key': Parse.masterKey,
1024+
},
1025+
}).then((result) => {
1026+
done();
1027+
}, (err) =>  {
1028+
fail(err);
1029+
done();
1030+
});
1031+
});
1032+
1033+
it('should not run without master key', (done) => {
1034+
expect(() => {
1035+
Parse.Cloud.job('myJob', (req, res) => {
1036+
res.success();
1037+
});
1038+
}).not.toThrow();
1039+
1040+
rp.post({
1041+
url: 'http://localhost:8378/1/jobs/myJob',
1042+
headers: {
1043+
'X-Parse-Application-Id': Parse.applicationId,
1044+
'X-Parse-REST-API-Key': 'rest',
1045+
},
1046+
}).then((result) => {
1047+
fail('Expected to be unauthorized');
1048+
done();
1049+
}, (err) =>  {
1050+
expect(err.statusCode).toBe(403);
1051+
done();
1052+
});
1053+
});
1054+
1055+
it('should run with master key', (done) => {
1056+
expect(() => {
1057+
Parse.Cloud.job('myJob', (req, res) => {
1058+
expect(req.functionName).toBeUndefined();
1059+
expect(req.jobName).toBe('myJob');
1060+
expect(typeof req.jobId).toBe('string');
1061+
expect(typeof res.success).toBe('function');
1062+
expect(typeof res.error).toBe('function');
1063+
expect(typeof res.message).toBe('function');
1064+
res.success();
1065+
done();
1066+
});
1067+
}).not.toThrow();
1068+
1069+
rp.post({
1070+
url: 'http://localhost:8378/1/jobs/myJob',
1071+
headers: {
1072+
'X-Parse-Application-Id': Parse.applicationId,
1073+
'X-Parse-Master-Key': Parse.masterKey,
1074+
},
1075+
}).then((response) => {
1076+
}, (err) =>  {
1077+
fail(err);
1078+
done();
1079+
});
1080+
});
1081+
1082+
it('should run with master key basic auth', (done) => {
1083+
expect(() => {
1084+
Parse.Cloud.job('myJob', (req, res) => {
1085+
expect(req.functionName).toBeUndefined();
1086+
expect(req.jobName).toBe('myJob');
1087+
expect(typeof req.jobId).toBe('string');
1088+
expect(typeof res.success).toBe('function');
1089+
expect(typeof res.error).toBe('function');
1090+
expect(typeof res.message).toBe('function');
1091+
res.success();
1092+
done();
1093+
});
1094+
}).not.toThrow();
1095+
1096+
rp.post({
1097+
url: `http://${Parse.applicationId}:${Parse.masterKey}@localhost:8378/1/jobs/myJob`,
1098+
}).then((response) => {
1099+
}, (err) =>  {
1100+
fail(err);
1101+
done();
1102+
});
1103+
});
1104+
1105+
it('should set the message / success on the job', (done) => {
1106+
Parse.Cloud.job('myJob', (req, res) => {
1107+
res.message('hello');
1108+
res.message().then(() => {
1109+
return getJobStatus(req.jobId);
1110+
}).then((jobStatus) => {
1111+
expect(jobStatus.get('message')).toEqual('hello');
1112+
expect(jobStatus.get('status')).toEqual('running');
1113+
return res.success().then(() => {
1114+
return getJobStatus(req.jobId);
1115+
});
1116+
}).then((jobStatus) => {
1117+
expect(jobStatus.get('message')).toEqual('hello');
1118+
expect(jobStatus.get('status')).toEqual('succeeded');
1119+
done();
1120+
}).catch(err => {
1121+
console.error(err);
1122+
jfail(err);
1123+
done();
1124+
});
1125+
});
1126+
1127+
rp.post({
1128+
url: 'http://localhost:8378/1/jobs/myJob',
1129+
headers: {
1130+
'X-Parse-Application-Id': Parse.applicationId,
1131+
'X-Parse-Master-Key': Parse.masterKey,
1132+
},
1133+
}).then((response) => {
1134+
}, (err) =>  {
1135+
fail(err);
1136+
done();
1137+
});
1138+
});
1139+
1140+
it('should set the failure on the job', (done) => {
1141+
Parse.Cloud.job('myJob', (req, res) => {
1142+
res.error('Something went wrong').then(() => {
1143+
return getJobStatus(req.jobId);
1144+
}).then((jobStatus) => {
1145+
expect(jobStatus.get('message')).toEqual('Something went wrong');
1146+
expect(jobStatus.get('status')).toEqual('failed');
1147+
done();
1148+
}).catch(err => {
1149+
jfail(err);
1150+
done();
1151+
});
1152+
});
1153+
1154+
rp.post({
1155+
url: 'http://localhost:8378/1/jobs/myJob',
1156+
headers: {
1157+
'X-Parse-Application-Id': Parse.applicationId,
1158+
'X-Parse-Master-Key': Parse.masterKey,
1159+
},
1160+
}).then((response) => {
1161+
}, (err) =>  {
1162+
fail(err);
1163+
done();
1164+
});
1165+
});
1166+
1167+
function getJobStatus(jobId) {
1168+
let q = new Parse.Query('_JobStatus');
1169+
return q.get(jobId, {useMasterKey: true});
1170+
}
1171+
});
10081172
});

‎spec/PushController.spec.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"use strict";
22
var PushController = require('../src/Controllers/PushController').PushController;
3-
var pushStatusHandler = require('../src/pushStatusHandler');
3+
var StatusHandler = require('../src/StatusHandler');
44
var Config = require('../src/Config');
55

66
const successfulTransmissions = function(body, installations) {
@@ -439,7 +439,7 @@ describe('PushController', () => {
439439
});
440440

441441
it('should flatten', () => {
442-
var res = pushStatusHandler.flatten([1, [2], [[3, 4], 5], [[[6]]]])
442+
var res = StatusHandler.flatten([1, [2], [[3, 4], 5], [[[6]]]])
443443
expect(res).toEqual([1,2,3,4,5,6]);
444444
})
445445
});

‎src/Adapters/Storage/Postgres/PostgresStorageAdapter.js

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,7 @@ export class PostgresStorageAdapter {
534534
let joins = results.reduce((list, schema) => {
535535
return list.concat(joinTablesForSchema(schema.schema));
536536
}, []);
537-
const classes = ['_SCHEMA','_PushStatus','_Hooks','_GlobalConfig', ...results.map(result => result.className), ...joins];
537+
const classes = ['_SCHEMA','_PushStatus','_JobStatus','_Hooks','_GlobalConfig', ...results.map(result => result.className), ...joins];
538538
return this._client.tx(t=>t.batch(classes.map(className=>t.none('DROP TABLE IF EXISTS $<className:name>', { className }))));
539539
}, error => {
540540
if (error.code === PostgresRelationDoesNotExistError) {
@@ -783,7 +783,11 @@ export class PostgresStorageAdapter {
783783

784784
for (let fieldName in update) {
785785
let fieldValue = update[fieldName];
786-
if (fieldName == 'authData') {
786+
if (fieldValue === null) {
787+
updatePatterns.push(`$${index}:name = NULL`);
788+
values.push(fieldName);
789+
index += 1;
790+
} else if (fieldName == 'authData') {
787791
// This recursively sets the json_object
788792
// Only 1 level deep
789793
let generate = (jsonb, key, value) => {
@@ -848,6 +852,10 @@ export class PostgresStorageAdapter {
848852
updatePatterns.push(`$${index}:name = $${index + 1}`);
849853
values.push(fieldName, toPostgresValue(fieldValue));
850854
index += 2;
855+
} else if (fieldValue instanceof Date) {
856+
updatePatterns.push(`$${index}:name = $${index + 1}`);
857+
values.push(fieldName, fieldValue);
858+
index += 2;
851859
} else if (fieldValue.__type === 'File') {
852860
updatePatterns.push(`$${index}:name = $${index + 1}`);
853861
values.push(fieldName, toPostgresValue(fieldValue));

‎src/Controllers/PushController.js

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
import { Parse } from 'parse/node';
2-
import PromiseRouter from '../PromiseRouter';
3-
import rest from '../rest';
4-
import AdaptableController from './AdaptableController';
5-
import { PushAdapter } from '../Adapters/Push/PushAdapter';
6-
import deepcopy from 'deepcopy';
7-
import RestQuery from '../RestQuery';
8-
import RestWrite from '../RestWrite';
9-
import { master } from '../Auth';
10-
import pushStatusHandler from '../pushStatusHandler';
1+
import { Parse } from 'parse/node';
2+
import PromiseRouter from '../PromiseRouter';
3+
import rest from '../rest';
4+
import AdaptableController from './AdaptableController';
5+
import { PushAdapter } from '../Adapters/Push/PushAdapter';
6+
import deepcopy from 'deepcopy';
7+
import RestQuery from '../RestQuery';
8+
import RestWrite from '../RestWrite';
9+
import { master } from '../Auth';
10+
import { pushStatusHandler } from '../StatusHandler';
1111

1212
const FEATURE_NAME = 'push';
1313
const UNSUPPORTED_BADGE_KEY = "unsupported";
@@ -98,8 +98,9 @@ export class PushController extends AdaptableController {
9898
}).then((results) => {
9999
return pushStatus.complete(results);
100100
}).catch((err) => {
101-
pushStatus.fail(err);
102-
return Promise.reject(err);
101+
return pushStatus.fail(err).then(() => {
102+
throw err;
103+
});
103104
});
104105
}
105106

‎src/Controllers/SchemaController.js

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,14 @@ const defaultColumns = Object.freeze({
8787
"sentPerType": {type:'Object'},
8888
"failedPerType":{type:'Object'},
8989
},
90+
_JobStatus: {
91+
"jobName": {type: 'String'},
92+
"source": {type: 'String'},
93+
"status": {type: 'String'},
94+
"message": {type: 'String'},
95+
"params": {type: 'Object'}, // params received when calling the job
96+
"finishedAt": {type: 'Date'}
97+
},
9098
_Hooks: {
9199
"functionName": {type:'String'},
92100
"className": {type:'String'},
@@ -104,9 +112,9 @@ const requiredColumns = Object.freeze({
104112
_Role: ["name", "ACL"]
105113
});
106114

107-
const systemClasses = Object.freeze(['_User', '_Installation', '_Role', '_Session', '_Product', '_PushStatus']);
115+
const systemClasses = Object.freeze(['_User', '_Installation', '_Role', '_Session', '_Product', '_PushStatus', '_JobStatus']);
108116

109-
const volatileClasses = Object.freeze(['_PushStatus', '_Hooks', '_GlobalConfig']);
117+
const volatileClasses = Object.freeze(['_JobStatus', '_PushStatus', '_Hooks', '_GlobalConfig']);
110118

111119
// 10 alpha numberic chars + uppercase
112120
const userIdRegex = /^[a-zA-Z0-9]{10}$/;
@@ -275,7 +283,12 @@ const _PushStatusSchema = convertSchemaToAdapterSchema(injectDefaultSchema({
275283
fields: {},
276284
classLevelPermissions: {}
277285
}));
278-
const VolatileClassesSchemas = [_HooksSchema, _PushStatusSchema, _GlobalConfigSchema];
286+
const _JobStatusSchema = convertSchemaToAdapterSchema(injectDefaultSchema({
287+
className: "_JobStatus",
288+
fields: {},
289+
classLevelPermissions: {}
290+
}));
291+
const VolatileClassesSchemas = [_HooksSchema, _JobStatusSchema, _PushStatusSchema, _GlobalConfigSchema];
279292

280293
const dbTypeMatchesObjectType = (dbType, objectType) => {
281294
if (dbType.type !== objectType.type) return false;

‎src/ParseServer.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ import { ParseLiveQueryServer } from './LiveQuery/ParseLiveQueryServer';
4545
import { PublicAPIRouter } from './Routers/PublicAPIRouter';
4646
import { PushController } from './Controllers/PushController';
4747
import { PushRouter } from './Routers/PushRouter';
48+
import { CloudCodeRouter } from './Routers/CloudCodeRouter';
4849
import { randomString } from './cryptoUtils';
4950
import { RolesRouter } from './Routers/RolesRouter';
5051
import { SchemasRouter } from './Routers/SchemasRouter';
@@ -285,7 +286,8 @@ class ParseServer {
285286
new FeaturesRouter(),
286287
new GlobalConfigRouter(),
287288
new PurgeRouter(),
288-
new HooksRouter()
289+
new HooksRouter(),
290+
new CloudCodeRouter()
289291
];
290292

291293
let routes = routers.reduce((memo, router) => {

‎src/Routers/CloudCodeRouter.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import PromiseRouter from '../PromiseRouter';
2+
const triggers = require('../triggers');
3+
4+
export class CloudCodeRouter extends PromiseRouter {
5+
mountRoutes() {
6+
this.route('GET',`/cloud_code/jobs`, CloudCodeRouter.getJobs);
7+
}
8+
9+
static getJobs(req) {
10+
let config = req.config;
11+
let jobs = triggers.getJobs(config.applicationId) || {};
12+
return Promise.resolve({
13+
response: Object.keys(jobs).map((jobName) => {
14+
return {
15+
jobName,
16+
}
17+
})
18+
});
19+
}
20+
}

‎src/Routers/FeaturesRouter.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ export class FeaturesRouter extends PromiseRouter {
1818
update: false,
1919
delete: false,
2020
},
21+
cloudCode: {
22+
jobs: true,
23+
},
2124
logs: {
2225
level: true,
2326
size: true,

0 commit comments

Comments
 (0)