This repository has been archived by the owner on Jun 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 544
/
protocol.js
201 lines (187 loc) · 6.67 KB
/
protocol.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
// Copyright (c) Microsoft Corporation
// All rights reserved.
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
// BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// module dependencies
const yaml = require('js-yaml');
const mustache = require('mustache');
const createError = require('@pai/utils/error');
const hived = require('@pai/middlewares/v2/hived');
const launcherConfig = require('@pai/config/launcher');
const protocolSchema = require('@pai/config/v2/protocol');
const mustacheWriter = new mustache.Writer();
const prerequisiteTypes = [
'script',
'output',
'data',
'dockerimage',
];
const prerequisiteFields = [
'script',
'output',
'data',
'dockerImage',
];
const render = (template, dict, tags=['<%', '%>']) => {
const tokens = mustacheWriter.parse(template, tags);
const context = new mustache.Context(dict);
let result = '';
for (let token of tokens) {
const symbol = token[0];
let tokenStr = token[1];
if (symbol === 'text') {
result += tokenStr;
} else if (symbol === 'name') {
tokenStr = tokenStr.replace(/\[(\d+)\]/g, '.$1');
const value = context.lookup(tokenStr);
if (value != null) {
result += value;
}
}
}
return result.trim();
};
const protocolValidate = (protocolYAML) => {
const protocolObj = yaml.safeLoad(protocolYAML);
if (!protocolSchema.validate(protocolObj)) {
throw createError('Bad Request', 'InvalidProtocolError', protocolSchema.validate.errors);
}
// convert prerequisites list to dict
const prerequisites = {};
for (let type of prerequisiteTypes) {
prerequisites[type] = {};
}
if ('prerequisites' in protocolObj) {
for (let item of protocolObj.prerequisites) {
if (prerequisites[item.type].hasOwnProperty(item.name)) {
throw createError(
'Bad Request',
'InvalidProtocolError',
`Duplicate ${item.type} prerequisites ${item.name}.`
);
} else {
prerequisites[item.type][item.name] = item;
}
}
}
protocolObj.prerequisites = prerequisites;
// convert deployments list to dict
const deployments = {};
if ('deployments' in protocolObj) {
for (let item of protocolObj.deployments) {
if (deployments.hasOwnProperty(item.name)) {
throw createError(
'Bad Request',
'InvalidProtocolError',
`Duplicate deployments ${item.name}.`
);
} else {
deployments[item.name] = item;
}
}
}
protocolObj.deployments = deployments;
// check prerequisites in taskRoles
for (let taskRole of Object.keys(protocolObj.taskRoles)) {
for (let field of prerequisiteFields) {
if (field in protocolObj.taskRoles[taskRole] &&
!(protocolObj.taskRoles[taskRole][field] in prerequisites[field.toLowerCase()])) {
throw createError(
'Bad Request',
'InvalidProtocolError',
`Prerequisite ${protocolObj.taskRoles[taskRole][field]} does not exist.`
);
}
}
}
// check deployment in defaults
if ('defaults' in protocolObj) {
if ('deployment' in protocolObj.defaults &&
!(protocolObj.defaults.deployment in deployments)) {
throw createError(
'Bad Request',
'InvalidProtocolError',
`Default deployment ${protocolObj.defaults.deployment} does not exist.`
);
}
}
return protocolObj;
};
const protocolRender = (protocolObj) => {
// render auth for Docker image
for (let name of Object.keys(protocolObj.prerequisites.dockerimage)) {
if ('auth' in protocolObj.prerequisites.dockerimage[name]) {
for (let prop of Object.keys(protocolObj.prerequisites.dockerimage[name].auth)) {
protocolObj.prerequisites.dockerimage[name].auth[prop] = render(
protocolObj.prerequisites.dockerimage[name].auth[prop],
{'$secrets': protocolObj.secrets},
);
}
}
}
// render commands
let deployment = null;
if ('defaults' in protocolObj && 'deployment' in protocolObj.defaults) {
deployment = protocolObj.deployments[protocolObj.defaults.deployment];
}
for (let taskRole of Object.keys(protocolObj.taskRoles)) {
let commands = protocolObj.taskRoles[taskRole].commands;
if (deployment != null && taskRole in deployment.taskRoles) {
if ('preCommands' in deployment.taskRoles[taskRole]) {
commands = deployment.taskRoles[taskRole].preCommands.concat(commands);
}
if ('postCommands' in deployment.taskRoles[taskRole]) {
commands = commands.concat(deployment.taskRoles[taskRole].postCommands);
}
}
commands = commands.map((command) => command.trim()).join(' && ');
const entrypoint = render(commands, {
'$parameters': protocolObj.parameters,
'$secrets': protocolObj.secrets,
'$script': protocolObj.prerequisites['script'][protocolObj.taskRoles[taskRole].script],
'$output': protocolObj.prerequisites['output'][protocolObj.taskRoles[taskRole].output],
'$data': protocolObj.prerequisites['data'][protocolObj.taskRoles[taskRole].data],
});
protocolObj.taskRoles[taskRole].entrypoint = entrypoint;
}
return protocolObj;
};
const protocolSubmitMiddleware = [
(req, res, next) => {
res.locals.protocol = req.body;
next();
},
(req, res, next) => {
res.locals.protocol = protocolValidate(res.locals.protocol);
next();
},
(req, res, next) => {
res.locals.protocol = protocolRender(res.locals.protocol);
next();
},
];
if (launcherConfig.enabledHived) {
protocolSubmitMiddleware.push(
(req, res, next) => {
res.locals.protocol = hived.validate(res.locals.protocol, req.user.username);
next();
});
}
// module exports
module.exports = {
validate: protocolValidate,
render: protocolRender,
submit: protocolSubmitMiddleware,
};