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

* fix(jsii): Optional `any` represented as required Optional parameters and properties typed `any` would be represented as required, despite the code unambiguously suggests the opposite. This is due to the fact that `any` implicitly covers `null` and `undefined`. This change fixes this by adding a specific provision for the question mark token in the declarations of those, and adds compliance test coverage for the same. Fixes #230 * Mark all `any` types as `optional`.
aws · Sep 19, 2018 · 91074f3 · 91074f3
1 parent 578bf9c
commit 91074f3
Show file tree

Hide file tree

Showing 20 changed files with 215 additions and 64 deletions.
diff --git a/packages/jsii-calc-base/test/assembly.jsii b/packages/jsii-calc-base/test/assembly.jsii
@@ -72,6 +72,7 @@
           },
           "name": "typeName",
           "returns": {
+            "optional": true,
             "primitive": "any"
           }
         }
@@ -101,5 +102,5 @@
     }
   },
   "version": "0.7.5",
-  "fingerprint": "Kzm7bNzxYO6frB7BwjqVBKhzTiCRwVG5aqgQrz7MOnE="
+  "fingerprint": "kazFxdH9DydCwjHvToTbXzqqXE0CytJ5qNmGO1NlGAM="
 }
diff --git a/packages/jsii-calc/lib/compliance.ts b/packages/jsii-calc/lib/compliance.ts
@@ -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 {
@@ -479,6 +483,7 @@ export interface DerivedStruct extends MyFirstStruct {
     bool: boolean
     anotherRequired: Date
     optionalArray?: string[]
+    optionalAny?: any
     /**
      * This is optional.
      */

diff --git a/packages/jsii-calc/test/assembly.jsii b/packages/jsii-calc/test/assembly.jsii
@@ -377,6 +377,7 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -388,18 +389,13 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
-        {
-          "name": "anyProperty",
-          "type": {
-            "primitive": "any"
-          }
-        },
         {
           "name": "arrayProperty",
           "type": {
@@ -521,6 +517,7 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -532,15 +529,17 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
         {
-          "name": "unknownProperty",
+          "name": "anyProperty",
           "type": {
+            "optional": true,
             "primitive": "any"
           }
         },
@@ -550,6 +549,13 @@
             "fqn": "jsii-calc.StringEnum",
             "optional": true
           }
+        },
+        {
+          "name": "unknownProperty",
+          "type": {
+            "optional": true,
+            "primitive": "any"
+          }
         }
       ]
     },
@@ -1152,6 +1158,14 @@
             "optional": true
           }
         },
+        {
+          "abstract": true,
+          "name": "optionalAny",
+          "type": {
+            "optional": true,
+            "primitive": "any"
+          }
+        },
         {
           "abstract": true,
           "name": "optionalArray",
@@ -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."
@@ -2854,6 +2880,7 @@
         {
           "name": "value",
           "returns": {
+            "optional": true,
             "primitive": "any"
           }
         }
@@ -3203,5 +3230,5 @@
     }
   },
   "version": "0.7.5",
-  "fingerprint": "PrLv57d+5ukv/bps1DvjB9DpM5DS6TpCEld13gQUTe8="
+  "fingerprint": "Zt3ElcP9k7ABYhwmP1xNZBni1sFj9iw0FZwWOe8n+L8="
 }
diff --git a/.../expected.jsii-calc-base/dotnet/Amazon.JSII.Tests.CalculatorPackageId.BasePackageId/.jsii b/.../expected.jsii-calc-base/dotnet/Amazon.JSII.Tests.CalculatorPackageId.BasePackageId/.jsii
@@ -72,6 +72,7 @@
           },
           "name": "typeName",
           "returns": {
+            "optional": true,
             "primitive": "any"
           }
         }
@@ -101,5 +102,5 @@
     }
   },
   "version": "0.7.5",
-  "fingerprint": "Kzm7bNzxYO6frB7BwjqVBKhzTiCRwVG5aqgQrz7MOnE="
+  "fingerprint": "kazFxdH9DydCwjHvToTbXzqqXE0CytJ5qNmGO1NlGAM="
 }
diff --git a/...ulatorPackageId.BasePackageId/Amazon/JSII/Tests/CalculatorNamespace/BaseNamespace/Base.cs b/...ulatorPackageId.BasePackageId/Amazon/JSII/Tests/CalculatorNamespace/BaseNamespace/Base.cs
@@ -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[]{});

diff --git a/...ed.jsii-calc-base/java/src/main/java/software/amazon/jsii/tests/calculator/base/Base.java b/...ed.jsii-calc-base/java/src/main/java/software/amazon/jsii/tests/calculator/base/Base.java
@@ -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);
     }

diff --git a/packages/jsii-pacmak/test/expected.jsii-calc-base/sphinx/_scope_jsii-calc-base.rst b/packages/jsii-pacmak/test/expected.jsii-calc-base/sphinx/_scope_jsii-calc-base.rst
@@ -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)

diff --git a/...es/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii b/...es/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii
@@ -377,6 +377,7 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -388,18 +389,13 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
-        {
-          "name": "anyProperty",
-          "type": {
-            "primitive": "any"
-          }
-        },
         {
           "name": "arrayProperty",
           "type": {
@@ -521,6 +517,7 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -532,15 +529,17 @@
           "type": {
             "collection": {
               "elementtype": {
+                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
         {
-          "name": "unknownProperty",
+          "name": "anyProperty",
           "type": {
+            "optional": true,
             "primitive": "any"
           }
         },
@@ -550,6 +549,13 @@
             "fqn": "jsii-calc.StringEnum",
             "optional": true
           }
+        },
+        {
+          "name": "unknownProperty",
+          "type": {
+            "optional": true,
+            "primitive": "any"
+          }
         }
       ]
     },
@@ -1152,6 +1158,14 @@
             "optional": true
           }
         },
+        {
+          "abstract": true,
+          "name": "optionalAny",
+          "type": {
+            "optional": true,
+            "primitive": "any"
+          }
+        },
         {
           "abstract": true,
           "name": "optionalArray",
@@ -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."
@@ -2854,6 +2880,7 @@
         {
           "name": "value",
           "returns": {
+            "optional": true,
             "primitive": "any"
           }
         }
@@ -3203,5 +3230,5 @@
     }
   },
   "version": "0.7.5",
-  "fingerprint": "PrLv57d+5ukv/bps1DvjB9DpM5DS6TpCEld13gQUTe8="
+  "fingerprint": "Zt3ElcP9k7ABYhwmP1xNZBni1sFj9iw0FZwWOe8n+L8="
 }
diff --git a/...t/Amazon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/AllTypes.cs b/...t/Amazon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/AllTypes.cs
@@ -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
         {
@@ -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);
@@ -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)
         {

diff --git a/...zon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/DerivedStruct.cs b/...zon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/DerivedStruct.cs
@@ -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
         {