/
Subscription.ts
312 lines (269 loc) · 8.17 KB
/
Subscription.ts
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
import { uniq } from 'lodash';
import { PubSub } from 'graphql-subscriptions';
import { passOrThrow, isArray, isFunction, mapOverProperties } from '../util';
import { Entity } from '../entity/Entity';
export const pubsub = new PubSub();
export const SUBSCRIPTION_TYPE_CREATE = 'onCreate';
export const SUBSCRIPTION_TYPE_UPDATE = 'onUpdate';
export const SUBSCRIPTION_TYPE_DELETE = 'onDelete';
export const subscriptionTypes = [
SUBSCRIPTION_TYPE_CREATE,
SUBSCRIPTION_TYPE_UPDATE,
SUBSCRIPTION_TYPE_DELETE,
];
export const defaultEntitySubscription = [
{
name: 'onCreate',
type: SUBSCRIPTION_TYPE_CREATE,
description: (typeName: string) =>
`Watch a new **\`${typeName}\`** creation`,
hasAttributes: true,
},
{
name: 'onUpdate',
type: SUBSCRIPTION_TYPE_UPDATE,
description: (typeName: string) =>
`Watch a single **\`${typeName}\`** update using its node ID and a data patch`,
hasAttributes: true,
},
{
name: 'onDelete',
description: (typeName: string) =>
`Watch a single **\`${typeName}\`** deletion using its node ID`,
type: SUBSCRIPTION_TYPE_DELETE,
},
];
export type SubscriptionSetup = {
name?: string;
type?: string;
description?: string;
attributes?: string[];
delimiter?: string;
wildCard?: string;
pattern?: string;
preProcessor?: (
entity?: Entity,
id?: string | number,
source?: any,
input?: any,
typeName?: string,
entitySubscription?: Subscription,
context?: any,
info?: any,
) => Promise<string | null> | string | null;
postProcessor?: (
entity?: Entity,
// id,
source?: any,
input?: any,
typeName?: string,
entitySubscription?: Subscription,
context?: any,
info?: any,
) => Promise<object | null> | object | null;
};
export class Subscription {
name: string;
type: string;
description: string;
attributes: string[];
delimiter?: string;
wildCard?: string;
pattern?: string;
preProcessor: Function;
postProcessor: Function;
isTypeCreate?: boolean;
isTypeDelete?: boolean;
needsInstance?: boolean;
ignoreRequired?: boolean;
isTypeUpdate?: boolean;
constructor(setup: SubscriptionSetup = {} as SubscriptionSetup) {
const {
name,
type,
description,
attributes,
preProcessor,
postProcessor,
} = setup;
passOrThrow(name, () => 'Missing subscription name');
passOrThrow(type, () => `Missing type for subscription '${name}'`);
passOrThrow(
subscriptionTypes.indexOf(type) >= 0,
() =>
`Unknown subscription type '${type}' used, try one of these: '${subscriptionTypes.join(
', ',
)}'`,
);
passOrThrow(
description,
() => `Missing description for subscription '${name}'`,
);
this.name = name;
this.type = type;
this.description = description;
if (
this.type === SUBSCRIPTION_TYPE_CREATE ||
this.type === SUBSCRIPTION_TYPE_UPDATE
) {
this.attributes = attributes;
}
if (this.type === SUBSCRIPTION_TYPE_CREATE) {
this.isTypeCreate = true;
}
if (this.type === SUBSCRIPTION_TYPE_UPDATE) {
this.needsInstance = true;
this.ignoreRequired = true;
this.isTypeUpdate = true;
}
if (this.type === SUBSCRIPTION_TYPE_DELETE) {
this.needsInstance = true;
this.isTypeDelete = true;
}
if (preProcessor) {
passOrThrow(
isFunction(preProcessor),
() =>
`preProcessor of subscription '${name}' needs to be a valid function`,
);
this.preProcessor = preProcessor;
}
if (postProcessor) {
passOrThrow(
isFunction(postProcessor),
() =>
`postProcessor of subscription '${name}' needs to be a valid function`,
);
this.postProcessor = postProcessor;
}
}
toString() {
return this.name;
}
}
export const isSubscription = (obj: any) => {
return obj instanceof Subscription;
};
export const processEntitySubscriptions = (
entity: Entity,
subscriptions: Subscription[],
) => {
passOrThrow(
isArray(subscriptions),
() =>
`Entity '${entity.name}' subscriptions definition needs to be an array of subscriptions`,
);
subscriptions.map((subscription, idx) => {
passOrThrow(
isSubscription(subscription),
() =>
`Invalid subscription definition for entity '${entity.name}' at position '${idx}'`,
);
});
const entityAttributes = entity.getAttributes();
// const entityStates = entity.getStates();
const requiredAttributeNames = [];
mapOverProperties(entityAttributes, (attribute, attributeName) => {
if (!attribute.isSystemAttribute) {
if (attribute.required && !attribute.defaultValue) {
requiredAttributeNames.push(attributeName);
}
}
});
const subscriptionNames = [];
subscriptions.map(subscription => {
passOrThrow(
!subscriptionNames.includes(subscription.name),
() =>
`Duplicate subscription name '${subscription.name}' found in '${entity.name}'`,
);
subscriptionNames.push(subscription.name);
if (subscription.attributes) {
passOrThrow(
(isArray(subscription.attributes, true) &&
subscription.type === SUBSCRIPTION_TYPE_CREATE) ||
isArray(subscription.attributes, false),
() =>
`Subscription '${entity.name}.${subscription.name}' needs to have a list of attributes`,
);
subscription.attributes.map(attribute => {
passOrThrow(
typeof attribute === 'string',
() =>
`Subscription '${entity.name}.${subscription.name}' needs to have a list of attribute names`,
);
});
passOrThrow(
subscription.attributes.length === uniq(subscription.attributes).length,
() =>
`Subscription '${entity.name}.${subscription.name}' needs to have a list of unique attribute names`,
);
subscription.attributes.map(attributeName => {
passOrThrow(
entityAttributes[attributeName],
() =>
`Cannot use attribute '${entity.name}.${attributeName}' in subscription '${entity.name}.${subscription.name}' as it does not exist`,
);
});
if (subscription.type === SUBSCRIPTION_TYPE_CREATE) {
// todo : remove this check ?
const missingAttributeNames = requiredAttributeNames.filter(
requiredAttributeName => {
return !subscription.attributes.includes(requiredAttributeName);
},
);
passOrThrow(
missingAttributeNames.length === 0,
() =>
`Missing required attributes in subscription '${entity.name}.${
subscription.name
}' need to have a defaultValue() function: [ ${missingAttributeNames.join(
', ',
)} ]`,
);
}
} else if (
subscription.type === SUBSCRIPTION_TYPE_CREATE ||
subscription.type === SUBSCRIPTION_TYPE_UPDATE
) {
const nonSystemAttributeNames = [];
mapOverProperties(entityAttributes, (attribute, attributeName) => {
if (!attribute.isSystemAttribute) {
nonSystemAttributeNames.push(attributeName);
}
});
subscription.attributes = nonSystemAttributeNames;
}
if (subscription.delimiter) {
passOrThrow(
typeof subscription.delimiter === 'string',
() =>
`Subscription '${entity.name}.${subscription.name}' delimiter should be a string`,
);
} else {
subscription.delimiter = '/';
}
if (subscription.wildCard) {
// todo make a list of valid wildCards (#, +, *)
passOrThrow(
typeof subscription.wildCard === 'string',
() =>
`Subscription '${entity.name}.${subscription.name}' wildCard should be a string`,
);
}
if (subscription.pattern) {
// todo validate pattern based on entityAttributes
passOrThrow(
typeof subscription.pattern === 'string',
() =>
`Subscription '${entity.name}.${subscription.name}' pattern should be a string`,
);
}
// else {
// subscription.pattern = Object.keys(entityAttributes).join(
// subscription.delimiter,
// );
// }
});
return subscriptions;
};