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

fix(jsii): Optional any represented as required #237

Merged
merged 2 commits into from
Sep 19, 2018
Merged

fix(jsii): Optional any represented as required #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74770c7
fix(jsii): Optional `any` represented as required
RomainMuller Sep 18, 2018
6490d96
Mark all `any` types as `optional`.
RomainMuller Sep 18, 2018
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
3 changes: 2 additions & 1 deletion packages/jsii-calc-base/test/assembly.jsii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
},
"name": "typeName",
"returns": {
"optional": true,
"primitive": "any"
}
}
Expand Down Expand Up @@ -101,5 +102,5 @@
}
},
"version": "0.7.5",
"fingerprint": "Kzm7bNzxYO6frB7BwjqVBKhzTiCRwVG5aqgQrz7MOnE="
"fingerprint": "kazFxdH9DydCwjHvToTbXzqqXE0CytJ5qNmGO1NlGAM="
}
5 changes: 5 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 @@ -244,6 +244,10 @@ export class RuntimeTypeChecking {
public methodWithDefaultedArguments(arg1: number = 2, arg2: string, arg3: Date = new Date()) {
arg1; arg2; arg3;
}

public methodWithOptionalAnyArgument(arg?: any) {
arg;
}
}

export class OptionalConstructorArgument {
Expand Down Expand Up @@ -479,6 +483,7 @@ export interface DerivedStruct extends MyFirstStruct {
bool: boolean
anotherRequired: Date
optionalArray?: string[]
optionalAny?: any
/**
* This is optional.
*/
Expand Down
43 changes: 35 additions & 8 deletions packages/jsii-calc/test/assembly.jsii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "array"
Expand All @@ -388,18 +389,13 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "map"
}
}
},
{
"name": "anyProperty",
"type": {
"primitive": "any"
}
},
{
"name": "arrayProperty",
"type": {
Expand Down Expand Up @@ -521,6 +517,7 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "array"
Expand All @@ -532,15 +529,17 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "map"
}
}
},
{
"name": "unknownProperty",
"name": "anyProperty",
"type": {
"optional": true,
"primitive": "any"
}
},
Expand All @@ -550,6 +549,13 @@
"fqn": "jsii-calc.StringEnum",
"optional": true
}
},
{
"name": "unknownProperty",
"type": {
"optional": true,
"primitive": "any"
}
}
]
},
Expand Down Expand Up @@ -1152,6 +1158,14 @@
"optional": true
}
},
{
"abstract": true,
"name": "optionalAny",
"type": {
"optional": true,
"primitive": "any"
}
},
{
"abstract": true,
"name": "optionalArray",
Expand Down Expand Up @@ -2403,6 +2417,18 @@
}
]
},
{
"name": "methodWithOptionalAnyArgument",
"parameters": [
{
"name": "arg",
"type": {
"optional": true,
"primitive": "any"
}
}
]
},
{
"docs": {
"comment": "Used to verify verification of number of method arguments."
Expand Down Expand Up @@ -2854,6 +2880,7 @@
{
"name": "value",
"returns": {
"optional": true,
"primitive": "any"
}
}
Expand Down Expand Up @@ -3203,5 +3230,5 @@
}
},
"version": "0.7.5",
"fingerprint": "PrLv57d+5ukv/bps1DvjB9DpM5DS6TpCEld13gQUTe8="
"fingerprint": "Zt3ElcP9k7ABYhwmP1xNZBni1sFj9iw0FZwWOe8n+L8="
}
3 changes: 2 additions & 1 deletion .../expected.jsii-calc-base/dotnet/Amazon.JSII.Tests.CalculatorPackageId.BasePackageId/.jsii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
},
"name": "typeName",
"returns": {
"optional": true,
"primitive": "any"
}
}
Expand Down Expand Up @@ -101,5 +102,5 @@
}
},
"version": "0.7.5",
"fingerprint": "Kzm7bNzxYO6frB7BwjqVBKhzTiCRwVG5aqgQrz7MOnE="
"fingerprint": "kazFxdH9DydCwjHvToTbXzqqXE0CytJ5qNmGO1NlGAM="
}
2 changes: 1 addition & 1 deletion ...ulatorPackageId.BasePackageId/Amazon/JSII/Tests/CalculatorNamespace/BaseNamespace/Base.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ protected Base(DeputyProps props): base(props)
}

/// <returns>the name of the class (to verify native type names are created for derived classes).</returns>
[JsiiMethod("typeName", "{\"primitive\":\"any\"}", "[]")]
[JsiiMethod("typeName", "{\"primitive\":\"any\",\"optional\":true}", "[]")]
public virtual object TypeName()
{
return InvokeInstanceMethod<object>(new object[]{});
Expand Down
1 change: 1 addition & 0 deletions ...ed.jsii-calc-base/java/src/main/java/software/amazon/jsii/tests/calculator/base/Base.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ protected Base(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
/**
* @return the name of the class (to verify native type names are created for derived classes).
*/
@javax.annotation.Nullable
public java.lang.Object typeName() {
return this.jsiiCall("typeName", java.lang.Object.class);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/jsii-pacmak/test/expected.jsii-calc-base/sphinx/_scope_jsii-calc-base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Base
.. py:method:: typeName() -> any
:return: the name of the class (to verify native type names are created for derived classes).
:rtype: any
:rtype: any or undefined


BaseProps (interface)
Expand Down
43 changes: 35 additions & 8 deletions ...es/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "array"
Expand All @@ -388,18 +389,13 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "map"
}
}
},
{
"name": "anyProperty",
"type": {
"primitive": "any"
}
},
{
"name": "arrayProperty",
"type": {
Expand Down Expand Up @@ -521,6 +517,7 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "array"
Expand All @@ -532,15 +529,17 @@
"type": {
"collection": {
"elementtype": {
"optional": true,
"primitive": "any"
},
"kind": "map"
}
}
},
{
"name": "unknownProperty",
"name": "anyProperty",
"type": {
"optional": true,
"primitive": "any"
}
},
Expand All @@ -550,6 +549,13 @@
"fqn": "jsii-calc.StringEnum",
"optional": true
}
},
{
"name": "unknownProperty",
"type": {
"optional": true,
"primitive": "any"
}
}
]
},
Expand Down Expand Up @@ -1152,6 +1158,14 @@
"optional": true
}
},
{
"abstract": true,
"name": "optionalAny",
"type": {
"optional": true,
"primitive": "any"
}
},
{
"abstract": true,
"name": "optionalArray",
Expand Down Expand Up @@ -2403,6 +2417,18 @@
}
]
},
{
"name": "methodWithOptionalAnyArgument",
"parameters": [
{
"name": "arg",
"type": {
"optional": true,
"primitive": "any"
}
}
]
},
{
"docs": {
"comment": "Used to verify verification of number of method arguments."
Expand Down Expand Up @@ -2854,6 +2880,7 @@
{
"name": "value",
"returns": {
"optional": true,
"primitive": "any"
}
}
Expand Down Expand Up @@ -3203,5 +3230,5 @@
}
},
"version": "0.7.5",
"fingerprint": "PrLv57d+5ukv/bps1DvjB9DpM5DS6TpCEld13gQUTe8="
"fingerprint": "Zt3ElcP9k7ABYhwmP1xNZBni1sFj9iw0FZwWOe8n+L8="
}
26 changes: 13 additions & 13 deletions ...t/Amazon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/AllTypes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,27 +31,20 @@ public virtual double EnumPropertyValue
get => GetInstanceProperty<double>();
}

[JsiiProperty("anyArrayProperty", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"any\"}}}")]
[JsiiProperty("anyArrayProperty", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"any\",\"optional\":true}}}")]
public virtual object[] AnyArrayProperty
{
get => GetInstanceProperty<object[]>();
set => SetInstanceProperty(value);
}

[JsiiProperty("anyMapProperty", "{\"collection\":{\"kind\":\"map\",\"elementtype\":{\"primitive\":\"any\"}}}")]
[JsiiProperty("anyMapProperty", "{\"collection\":{\"kind\":\"map\",\"elementtype\":{\"primitive\":\"any\",\"optional\":true}}}")]
public virtual IDictionary<string, object> AnyMapProperty
{
get => GetInstanceProperty<IDictionary<string, object>>();
set => SetInstanceProperty(value);
}

[JsiiProperty("anyProperty", "{\"primitive\":\"any\"}")]
public virtual object AnyProperty
{
get => GetInstanceProperty<object>();
set => SetInstanceProperty(value);
}

[JsiiProperty("arrayProperty", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"string\"}}}")]
public virtual string[] ArrayProperty
{
Expand Down Expand Up @@ -129,22 +122,22 @@ public virtual object UnionProperty
set => SetInstanceProperty(value);
}

[JsiiProperty("unknownArrayProperty", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"any\"}}}")]
[JsiiProperty("unknownArrayProperty", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"any\",\"optional\":true}}}")]
public virtual object[] UnknownArrayProperty
{
get => GetInstanceProperty<object[]>();
set => SetInstanceProperty(value);
}

[JsiiProperty("unknownMapProperty", "{\"collection\":{\"kind\":\"map\",\"elementtype\":{\"primitive\":\"any\"}}}")]
[JsiiProperty("unknownMapProperty", "{\"collection\":{\"kind\":\"map\",\"elementtype\":{\"primitive\":\"any\",\"optional\":true}}}")]
public virtual IDictionary<string, object> UnknownMapProperty
{
get => GetInstanceProperty<IDictionary<string, object>>();
set => SetInstanceProperty(value);
}

[JsiiProperty("unknownProperty", "{\"primitive\":\"any\"}")]
public virtual object UnknownProperty
[JsiiProperty("anyProperty", "{\"primitive\":\"any\",\"optional\":true}")]
public virtual object AnyProperty
{
get => GetInstanceProperty<object>();
set => SetInstanceProperty(value);
Expand All @@ -157,6 +150,13 @@ public virtual StringEnum OptionalEnumValue
set => SetInstanceProperty(value);
}

[JsiiProperty("unknownProperty", "{\"primitive\":\"any\",\"optional\":true}")]
public virtual object UnknownProperty
{
get => GetInstanceProperty<object>();
set => SetInstanceProperty(value);
}

[JsiiMethod("enumMethod", "{\"fqn\":\"jsii-calc.StringEnum\"}", "[{\"name\":\"value\",\"type\":{\"fqn\":\"jsii-calc.StringEnum\"}}]")]
public virtual StringEnum EnumMethod(StringEnum value)
{
Expand Down
7 changes: 7 additions & 0 deletions ...zon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/DerivedStruct.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ public IDictionary<string, Value_> AnotherOptional
set;
}

[JsiiProperty("optionalAny", "{\"primitive\":\"any\",\"optional\":true}", true)]
public object OptionalAny
{
get;
set;
}

[JsiiProperty("optionalArray", "{\"collection\":{\"kind\":\"array\",\"elementtype\":{\"primitive\":\"string\"}},\"optional\":true}", true)]
public string[] OptionalArray
{
Expand Down
Loading