-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
resource-decider.ts
379 lines (339 loc) · 12.7 KB
/
resource-decider.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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
import { Deprecation, Property, Resource, RichProperty, TagVariant } from '@aws-cdk/service-spec-types';
import { $E, $T, Expression, PropertySpec, Type, expr } from '@cdklabs/typewriter';
import { CDK_CORE } from './cdk';
import { PropertyMapping } from './cloudformation-mapping';
import { NON_RESOLVABLE_PROPERTY_NAMES, TaggabilityStyle, resourceTaggabilityStyle } from './tagging';
import { TypeConverter } from './type-converter';
import { attributePropertyName, cloudFormationDocLink, propertyNameFromCloudFormation } from '../naming';
import { splitDocumentation } from '../util';
// Depends on https://github.com/aws/aws-cdk/pull/25610
export const HAS_25610 = false;
// This convenience typewriter builder is used all over the place
const $this = $E(expr.this_());
/**
* Decide how properties get mapped between model types, Typescript types, and CloudFormation
*/
export class ResourceDecider {
public static taggabilityInterfaces(resource: Resource) {
const taggability = resourceTaggabilityStyle(resource);
return taggability?.style === 'legacy'
? [CDK_CORE.ITaggable]
: taggability?.style === 'modern' && HAS_25610
? [CDK_CORE.ITaggableV2]
: [];
}
private readonly taggability?: TaggabilityStyle;
public readonly propsProperties = new Array<PropsProperty>();
public readonly classProperties = new Array<ClassProperty>();
public readonly classAttributeProperties = new Array<ClassAttributeProperty>();
constructor(private readonly resource: Resource, private readonly converter: TypeConverter) {
this.taggability = resourceTaggabilityStyle(this.resource);
this.convertProperties();
this.convertAttributes();
this.propsProperties.sort((p1, p2) => p1.propertySpec.name.localeCompare(p2.propertySpec.name));
this.classProperties.sort((p1, p2) => p1.propertySpec.name.localeCompare(p2.propertySpec.name));
this.classAttributeProperties.sort((p1, p2) => p1.propertySpec.name.localeCompare(p2.propertySpec.name));
}
private convertProperties() {
for (const [name, prop] of Object.entries(this.resource.properties)) {
if (name === this.taggability?.tagPropertyName) {
switch (this.taggability?.style) {
case 'legacy':
this.handleTagPropertyLegacy(name, prop, this.taggability.variant);
continue;
case 'modern':
if (HAS_25610) {
this.handleTagPropertyModern(name, prop, this.taggability.variant);
continue;
}
}
} else {
this.handleTypeHistoryTypes(prop);
}
this.handlePropertyDefault(name, prop);
}
}
/**
* Default mapping for a property
*/
private handlePropertyDefault(cfnName: string, prop: Property) {
const name = propertyNameFromCloudFormation(cfnName);
const { type, baseType } = this.legacyCompatiblePropType(cfnName, prop);
const optional = !prop.required;
this.propsProperties.push({
propertySpec: {
name,
type,
optional,
docs: this.defaultPropDocs(cfnName, prop),
},
validateRequiredInConstructor: !!prop.required,
cfnMapping: {
cfnName,
propName: name,
baseType,
optional,
},
});
this.classProperties.push({
propertySpec: {
name,
type,
optional,
immutable: false,
docs: this.defaultClassPropDocs(cfnName, prop),
},
initializer: (props: Expression) => expr.get(props, name),
cfnValueToRender: { [name]: $this[name] },
});
}
/**
* Emit unused types from type history
*
* We currently render all types into the spec and need to keep doing that for backwards compatibility.
*/
private handleTypeHistoryTypes(prop: Property) {
this.converter
.typeHistoryFromProperty(prop)
.slice(1)
.map((t) => this.converter.typeFromSpecType(t));
}
/**
* Emit legacy taggability
*
* This entails:
*
* - A props property named after the tags-holding property that is
* standardized: either a built-in CDK Tag type array, or a string map
* - A class property named 'tags' that holds a TagManager and is initialized
* from the tags-holding property.
*
* We also add a mutable L1 property called '<tagsProperty>Raw' which can be used
* to add tags apart from the TagManager.
*/
private handleTagPropertyLegacy(cfnName: string, prop: Property, variant: TagVariant) {
const originalName = propertyNameFromCloudFormation(cfnName);
const rawTagsPropName = `${originalName}Raw`;
const { type, baseType } = this.legacyCompatiblePropType(cfnName, prop);
this.propsProperties.push({
propertySpec: {
name: originalName,
type,
optional: true, // Tags are never required
docs: this.defaultPropDocs(cfnName, prop),
},
validateRequiredInConstructor: false, // Tags are never required
cfnMapping: {
cfnName,
propName: originalName,
baseType,
optional: true,
},
});
this.classProperties.push(
{
propertySpec: {
// Must be called 'tags' to count as ITaggable
name: 'tags',
type: CDK_CORE.TagManager,
immutable: true,
docs: {
summary: 'Tag Manager which manages the tags for this resource',
},
},
initializer: (props: Expression) =>
new CDK_CORE.TagManager(
this.tagManagerVariant(variant),
expr.lit(this.resource.cloudFormationType),
HAS_25610 ? expr.UNDEFINED : $E(props)[originalName],
expr.object({ tagPropertyName: expr.lit(originalName) }),
),
cfnValueToRender: {
[originalName]: $this.tags.renderTags(...(HAS_25610 ? [$this[rawTagsPropName]] : [])),
},
},
{
propertySpec: {
name: rawTagsPropName,
type,
optional: true, // Tags are never required
docs: this.defaultClassPropDocs(cfnName, prop),
},
initializer: (props: Expression) => $E(props)[originalName],
cfnValueToRender: {}, // Gets rendered as part of the TagManager above
},
);
}
private handleTagPropertyModern(cfnName: string, prop: Property, variant: TagVariant) {
const originalName = propertyNameFromCloudFormation(cfnName);
const originalType = this.converter.makeTypeResolvable(this.converter.typeFromProperty(prop));
this.propsProperties.push({
propertySpec: {
name: originalName,
type: originalType,
optional: true, // Tags are never required
docs: this.defaultPropDocs(cfnName, prop),
},
validateRequiredInConstructor: false, // Tags are never required
cfnMapping: {
cfnName,
propName: originalName,
baseType: originalType,
optional: true,
},
});
this.classProperties.push(
{
propertySpec: {
// Must be called 'cdkTagManager' to count as ITaggableV2
name: 'cdkTagManager',
type: CDK_CORE.TagManager,
immutable: true,
docs: {
summary: 'Tag Manager which manages the tags for this resource',
},
},
initializer: (props: Expression) =>
new CDK_CORE.TagManager(
this.tagManagerVariant(variant),
expr.lit(this.resource.cloudFormationType),
HAS_25610 ? expr.UNDEFINED : $E(props)[originalName],
expr.object({ tagPropertyName: expr.lit(originalName) }),
),
cfnValueToRender: {
[originalName]: $this.tags.renderTags(...(HAS_25610 ? [$this[originalName]] : [])),
},
},
{
propertySpec: {
name: originalName,
type: originalType,
optional: true, // Tags are never required
docs: this.defaultClassPropDocs(cfnName, prop),
},
initializer: (props: Expression) => $E(props)[originalName],
cfnValueToRender: {}, // Gets rendered as part of the TagManager above
},
);
}
/**
* Return the resolvable and base types for a given property
*
* Does type deducation compatibly with the old cfn2ts code base.
*
* - Returns the special Tag type if this property had the intrinstic 'Tag' type
* in the old spec, otherwise resolves the type as normal.
* - Skips making the type resolvable if the property has one of the predefined tag
* property names.
*/
private legacyCompatiblePropType(cfnName: string, prop: Property) {
const baseType = this.converter.typeFromProperty(prop);
// Whether or not a property is made `IResolvable` originally depended on
// the name of the property. These conditions were probably expected to coincide
// with it being a taggable type or not, but they don't always coincide.
const type = cfnName in NON_RESOLVABLE_PROPERTY_NAMES ? baseType : this.converter.makeTypeResolvable(baseType);
return { type, baseType };
}
private convertAttributes() {
const $ResolutionTypeHint = $T(CDK_CORE.ResolutionTypeHint);
for (const [attrName, attr] of Object.entries(this.resource.attributes)) {
// Just use the oldest type for now
const specType = new RichProperty(attr).types()[0];
let type: Type;
let initializer: Expression;
if (specType.type === 'string') {
type = Type.STRING;
initializer = CDK_CORE.tokenAsString($this.getAtt(expr.lit(attrName), $ResolutionTypeHint.STRING));
} else if (specType.type === 'integer') {
type = Type.NUMBER;
initializer = CDK_CORE.tokenAsNumber($this.getAtt(expr.lit(attrName), $ResolutionTypeHint.NUMBER));
} else if (specType.type === 'number') {
// COMPAT: Although numbers/doubles could be represented as numbers, historically in cfn2ts they were represented as IResolvable.
type = CDK_CORE.IResolvable;
initializer = $this.getAtt(expr.lit(attrName), $ResolutionTypeHint.NUMBER);
} else if (specType.type === 'array' && specType.element.type === 'string') {
type = Type.arrayOf(Type.STRING);
initializer = CDK_CORE.tokenAsList($this.getAtt(expr.lit(attrName), $ResolutionTypeHint.STRING_LIST));
} else {
// This may reference a type we need to generate, so call this function because of its side effect
this.converter.typeFromSpecType(specType);
type = CDK_CORE.IResolvable;
initializer = $this.getAtt(expr.lit(attrName));
}
this.classAttributeProperties.push({
propertySpec: {
name: attributePropertyName(attrName),
type,
immutable: true,
docs: {
summary: attr.documentation,
remarks: [`@cloudformationAttribute ${attrName}`].join('\n'),
},
},
initializer,
});
}
}
private defaultPropDocs(cfnName: string, prop: Property) {
return {
...splitDocumentation(prop.documentation),
default: prop.defaultValue ?? undefined,
see: cloudFormationDocLink({
resourceType: this.resource.cloudFormationType,
propName: cfnName,
}),
deprecated: deprecationMessage(prop),
};
}
private defaultClassPropDocs(cfnName: string, prop: Property) {
void cfnName;
return {
summary: splitDocumentation(prop.documentation).summary,
deprecated: deprecationMessage(prop),
};
}
/**
* Translates a TagVariant to the core.TagType enum
*/
private tagManagerVariant(variant: TagVariant) {
switch (variant) {
case 'standard':
return CDK_CORE.TagType.STANDARD;
case 'asg':
return CDK_CORE.TagType.AUTOSCALING_GROUP;
case 'map':
return CDK_CORE.TagType.MAP;
}
throw new Error(`Unknown variant: ${this.resource.tagInformation?.variant}`);
}
}
export interface PropsProperty {
readonly propertySpec: PropertySpec;
readonly validateRequiredInConstructor: boolean;
readonly cfnMapping: PropertyMapping;
}
export interface ClassProperty {
readonly propertySpec: PropertySpec;
/** Given the name of the props value, produce the member value */
readonly initializer: (props: Expression) => Expression;
/**
* Lowercase property name(s) and expression(s) to render to get this property into CFN
*
* We will do a separate conversion of the casing of the props object, so don't do that here.
*/
readonly cfnValueToRender: Record<string, Expression>;
}
export interface ClassAttributeProperty {
readonly propertySpec: PropertySpec;
/** Produce the initializer value for the member */
readonly initializer: Expression;
}
export function deprecationMessage(property: Property): string | undefined {
switch (property.deprecated) {
case Deprecation.WARN:
return 'this property has been deprecated';
case Deprecation.IGNORE:
return 'this property will be ignored';
}
return undefined;
}