Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(kernel): cannot pass decorated structs to kernel as "any" #997

Merged
merged 5 commits into from
Nov 18, 2019
Merged

fix(kernel): cannot pass decorated structs to kernel as "any" #997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
684a368
fix(kernel): cannot pass decorated structs as "any"
Nov 18, 2019
ee79e7b
use fqn from struct decoration and delegate to struct deserializer
Nov 18, 2019
e8ae5f9
increase coverage for any ser/deser
Nov 18, 2019
bf3d568
update expectations
Nov 18, 2019
4bccda0
fix eslint issues
Nov 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions packages/jsii-calc/lib/compliance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2331,3 +2331,68 @@ export class ObjectWithPropertyProvider {

private constructor() { }
}

/**
* Make sure structs are un-decorated on the way in.
*
* @see https://github.com/aws/aws-cdk/issues/5066
*/
export class JsonFormatter {
public static stringify(value?: any): string | undefined {
return JSON.stringify(value, null, 2);
}

public static anyNull(): any {
return null;
}

public static anyUndefined(): any {
return undefined;
}

public static anyFunction(): any {
return () => 'boom';
}

public static anyDate(): any {
return new Date('2019-11-18T13:01:20.515Z');
}

public static anyNumber(): any {
return 123;
}

public static anyZero(): any {
return 0;
}

public static anyString(): any {
return 'foo';
}

public static anyEmptyString(): any {
return '';
}

public static anyBooleanTrue(): any {
return true;
}

public static anyBooleanFalse(): any {
return false;
}

public static anyArray(): any {
return [ 1, 2, 3, new Number(123), { foo: 'bar' } ];
}

public static anyHash(): any {
return { hello: 1234, world: new Number(122) };
}

public static anyRef(): any {
return new Number(444);
}

private constructor() { }
}
253 changes: 252 additions & 1 deletion packages/jsii-calc/test/assembly.jsii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6826,6 +6826,257 @@
}
]
},
"jsii-calc.JsonFormatter": {
"assembly": "jsii-calc",
"docs": {
"see": "https://github.com/aws/aws-cdk/issues/5066",
"stability": "experimental",
"summary": "Make sure structs are un-decorated on the way in."
},
"fqn": "jsii-calc.JsonFormatter",
"kind": "class",
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2340
},
"methods": [
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2385
},
"name": "anyArray",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2381
},
"name": "anyBooleanFalse",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2377
},
"name": "anyBooleanTrue",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2357
},
"name": "anyDate",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2373
},
"name": "anyEmptyString",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2353
},
"name": "anyFunction",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2389
},
"name": "anyHash",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2345
},
"name": "anyNull",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2361
},
"name": "anyNumber",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2393
},
"name": "anyRef",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2369
},
"name": "anyString",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2349
},
"name": "anyUndefined",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2365
},
"name": "anyZero",
"returns": {
"type": {
"primitive": "any"
}
},
"static": true
},
{
"docs": {
"stability": "experimental"
},
"locationInModule": {
"filename": "lib/compliance.ts",
"line": 2341
},
"name": "stringify",
"parameters": [
{
"name": "value",
"optional": true,
"type": {
"primitive": "any"
}
}
],
"returns": {
"optional": true,
"type": {
"primitive": "string"
}
},
"static": true
}
],
"name": "JsonFormatter"
},
"jsii-calc.LoadBalancedFargateServiceProps": {
"assembly": "jsii-calc",
"datatype": true,
Expand Down Expand Up @@ -11413,5 +11664,5 @@
}
},
"version": "0.20.6",
"fingerprint": "veHd1Q/376CoMR3O/DjjAiH9aVD/jcwnPEg88barg9I="
"fingerprint": "xRnF3HrD87xlfIYG262JFu5WEdrC0eQelRBEzyQyARo="
}
13 changes: 13 additions & 0 deletions ...ges/jsii-dotnet-runtime-test/test/Amazon.JSII.Runtime.IntegrationTests/ComplianceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1297,5 +1297,18 @@ public void CanUseInterfaceSetters()
obj.Property = "New Value";
Assert.True(obj.WasSet());
}

[Fact(DisplayName = Prefix + nameof(StructsAreUndecoratedOntheWayToKernel))]
public void StructsAreUndecoratedOntheWayToKernel()
{
var json = JsonFormatter.Stringify(new StructB {RequiredString = "Bazinga!", OptionalBoolean = false});
var actual = JObject.Parse(json);

var expected = new JObject();
expected.Add("RequiredString", "Bazinga!");
expected.Add("OptionalBoolean", false);

Assert.Equal(expected, actual);
}
}
}
4 changes: 2 additions & 2 deletions packages/jsii-dotnet-runtime/src/Amazon.JSII.Runtime/Deputy/JsiiByValueAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ public sealed class JsiiByValueAttribute : Attribute
{
public JsiiByValueAttribute(string fqn)
{
Fqn = fqn ?? throw new ArgumentNullException(nameof(fqn));
FullyQualifiedName = fqn ?? throw new ArgumentNullException(nameof(fqn));
}

public string Fqn { get; }
public string FullyQualifiedName { get; }
}
}
8 changes: 7 additions & 1 deletion ...ii-dotnet-runtime/src/Amazon.JSII.Runtime/Services/Converters/FrameworkToJsiiConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ protected override bool TryConvertClass(Type type, IReferenceMap referenceMap, o
}

var structInfo = new JObject();
structInfo.Add(new JProperty("fqn", byValueAttribute.Fqn));
structInfo.Add(new JProperty("fqn", byValueAttribute.FullyQualifiedName));
structInfo.Add(new JProperty("data", data));

var resultObject = new JObject();
Expand Down Expand Up @@ -353,6 +353,12 @@ TypeReference InferType(IReferenceMap referenceMap, Type type)
return new TypeReference(enumAttribute.FullyQualifiedName);
}

JsiiByValueAttribute structAttribute = type.GetCustomAttribute<JsiiByValueAttribute>();
if (structAttribute != null)
{
return new TypeReference(structAttribute.FullyQualifiedName);
}

if (typeof(string).IsAssignableFrom(type))
{
return new TypeReference(primitive: PrimitiveType.String);
Expand Down
Loading