-
Notifications
You must be signed in to change notification settings - Fork 1
/
schemas.js
273 lines (257 loc) · 8.81 KB
/
schemas.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
const yup = require("yup");
const github = require("@actions/github");
const fs = require("fs");
const path = require("path");
// constants
const ALLOWED_COMPONENT_YAML_VERSIONS = ["0.9", "1.0", "1.1"];
const ALLOWED_TYPES = ["REST", "GraphQL", "GRPC", "TCP", "UDP", "WS"];
const ALLOWED_NETWORK_VISIBILITIES = ["Public", "Project", "Organization"];
const BASE_PATH_REQUIRED_TYPES = ["REST", "GraphQL", "WS"];
const COMPONENT_CONFIG_YAML_API_VERSION = ["core.choreo.dev/v1beta1"];
const COMPONENT_CONFIG_YAML_KIND = ["ComponentConfig"];
// custom validators
// checkEndpointNameUniqueness - Custom validation method to check if endpoint names are unique
yup.addMethod(yup.array, "checkEndpointNameUniqueness", function () {
return this.test({
name: "unique-endpoint-name",
test: (arr) => {
// the endpoints section is optional, hence return true if it is not present
if (!arr) {
return true;
}
const epSet = new Set();
const isUnique = arr.every((ep) => {
epName = ep.name;
if (epSet.has(epName)) {
return false;
}
epSet.add(epName);
return true;
});
return (
isUnique || new yup.ValidationError("Endpoint names must be unique")
);
},
});
});
// basePathRequired - Custom validation method to check base path is required for REST, GraphQL, and WS endpoints
yup.addMethod(yup.object, "basePathRequired", function () {
return this.test({
name: "base-path-required",
test: (value, testCtx) => {
const { type } = testCtx.parent;
if (BASE_PATH_REQUIRED_TYPES.includes(type) && !value?.basePath) {
return new yup.ValidationError(
"Base path is required for REST, GraphQL, and WS endpoints"
);
}
return true;
},
});
});
// contextRequired - Custom validation method to check context is required for REST, GraphQL, and WS endpoints
yup.addMethod(yup.string, "contextRequired", function () {
return this.test({
name: "context-required",
test: (value, testCtx) => {
const { type } = testCtx.parent;
if (BASE_PATH_REQUIRED_TYPES.includes(type) && !value) {
return new yup.ValidationError(
"Context is required for REST, GraphQL, and WS endpoints"
);
}
return true;
},
});
});
// SchemaFileExists - Custom validation method to check if the provided schema file exists
yup.addMethod(yup.string, "schemaFileExists", function (srcDir) {
return this.test({
name: "schema-file-exists",
test: (value) => {
// schema file path is optional, hence return true if it is not present
if (!value) {
return true;
}
schemaFilePath = path.join(srcDir, value);
try {
const hasFile = fs.existsSync(schemaFilePath);
return (
hasFile ||
new yup.ValidationError(
`Schema file does not exist at the given path ${value}.`
)
);
} catch (error) {
new yup.ValidationError(
"Failed to check if schema file exists:",
error.message
);
}
},
});
});
// validateServiceName - Custom validation method to validate service name
yup.addMethod(yup.string, "validateServiceName", function () {
return this.test({
name: "validate-service-name",
test: (value, testCtx) => {
const alphanumericRegex = "[a-zA-Z0-9_-]+";
const choreoSvcRefNameRegex = new RegExp(
`^choreo:\/\/\/${alphanumericRegex}\/${alphanumericRegex}\/${alphanumericRegex}\/${alphanumericRegex}\/v\\d+(\\.\\d+)?\/(PUBLIC|PROJECT|ORGANIZATION)$`
);
const thirdPartySvcRefNameRegex = new RegExp(
"^thirdparty:[a-zA-Z0-9._/-]+$"
);
const dbSvcRefNameRegex = new RegExp("^database:[a-zA-Z0-9_/-]+$");
if (value.startsWith("choreo:///")) {
return (
choreoSvcRefNameRegex.test(value) ||
new yup.ValidationError(
`${testCtx.path} must follow the format ` +
`choreo:///<org-handle>/<project-handle>/<component-handle>/<endpoint-identifier>/<major-version>/<network-visibility>`
)
);
}
if (value.startsWith("thirdparty:")) {
return (
thirdPartySvcRefNameRegex.test(value) ||
new yup.ValidationError(
`${testCtx.path} has an invalid service identifier, ` +
`only alphanumeric characters, periods (.), underscores (_), hyphens (-), and slashes (/) are allowed after thirdparty:`
)
);
}
if (value.startsWith("database:")) {
return (
dbSvcRefNameRegex.test(value) ||
new yup.ValidationError(
`${testCtx.path} has an invalid service identifier, ` +
`only alphanumeric characters, underscores (_), hyphens (-), and slashes (/) are allowed after database:`
)
);
}
return new yup.ValidationError(
`${testCtx.path} has an invalid service type. It can only contain choreo, thirdparty, or database types.`
);
},
});
});
// Schema definitions
// NOTE: specified schema versions are aligned with Rudder component schema versions
// serviceSchema - Schema for service definition
const serviceSchema = yup
.object()
.shape({
basePath: yup
.string()
.matches(
/^\/[a-zA-Z0-9\/\-_]*$/,
({ path }) =>
`${path} must start with a forward slash and can only contain alphanumeric characters, hyphens, underscores and forward slashes.`
),
port: yup.number().required().moreThan(1000).lessThan(65535),
})
.required()
.basePathRequired();
// endpointSchemaV0D1 - Schema for endpoint definition V0.1
const endpointSchemaV0D1 = (srcDir) =>
yup.array().of(
yup.object().shape({
name: yup.string().required(),
port: yup.number().required().moreThan(1000).lessThan(65535),
type: yup.string().required().oneOf(ALLOWED_TYPES),
networkVisibility: yup.string().oneOf(ALLOWED_NETWORK_VISIBILITIES),
context: yup
.string()
.contextRequired()
.matches(
/^\/[a-zA-Z0-9\/\-_]*$/,
({ path }) =>
`${path} must start with a forward slash and can only contain alphanumeric characters, hyphens, and forward slashes.`
),
schemaFilePath: yup.string().schemaFileExists(srcDir),
})
);
// endpointSchemaV0D2 - Schema for endpoint definition V0.2
const endpointSchemaV0D2 = (srcDir) =>
yup
.array()
.of(
yup.object().shape({
name: yup
.string()
.required()
.max(50)
.matches(
/^[a-z][a-z0-9_-]*$/,
({ path }) =>
`${path} must start with a lowercase letter and can only contain lowercase letters, numbers, underscores (_), and hyphens (-).`
),
displayName: yup.string().max(50),
service: serviceSchema,
type: yup.string().required().oneOf(ALLOWED_TYPES),
networkVisibilities: yup
.array()
.of(yup.string().oneOf(ALLOWED_NETWORK_VISIBILITIES)),
schemaFilePath: yup.string().schemaFileExists(srcDir),
})
)
.checkEndpointNameUniqueness();
// serviceReferencesSchema - Schema for service references
const serviceReferencesSchema = yup.array().of(
yup.object().shape({
name: yup.string().required().validateServiceName(),
connectionConfig: yup.string().uuid().required(),
env: yup
.array()
.of(
yup.object().shape({
from: yup.string().required(),
to: yup.string().required(),
})
)
.required(),
})
);
// dependencySchemaV0D1 - Schema for dependency definition V0.1
const dependencySchemaV0D1 = yup.object().shape({
serviceReferences: serviceReferencesSchema,
});
// specSchema - Schema for spec definition
const specSchema = (srcDir) =>
yup.object().shape({
inbound: endpointSchemaV0D1(srcDir).min(0),
outbound: dependencySchemaV0D1,
});
// componentYamlSchema - Schema for component.yaml
const componentYamlSchemaV1D0 = (srcDir) =>
yup.object().shape({
schemaVersion: yup
.string()
.required()
.oneOf(ALLOWED_COMPONENT_YAML_VERSIONS),
endpoints: endpointSchemaV0D2(srcDir),
dependencies: dependencySchemaV0D1,
});
// endpointYamlSchema - Schema for endpoints.yaml
const endpointYamlSchemaV0D1 = (srcDir) =>
yup.object().shape({
version: yup.string().required(),
endpoints: endpointSchemaV0D1(srcDir).required().min(0),
});
// componentConfigYamlSchemaV1D0 - Schema for component-config.yaml
const componentConfigYamlSchemaV1beta1 = (srcDir) =>
yup.object().shape({
apiVersion: yup
.string()
.required()
.oneOf(COMPONENT_CONFIG_YAML_API_VERSION),
kind: yup.string().required().equals(COMPONENT_CONFIG_YAML_KIND),
spec: specSchema(srcDir),
});
module.exports = {
componentYamlSchemaV1D0,
endpointYamlSchemaV0D1,
componentConfigYamlSchemaV1beta1,
};