fix(jsii): do not mark "any" or "unknown" as optional (unless "?")

We accidentally marked every "any" and "unknown" types as optional, regardless if the declaration had a question mark or not. Fixes #284
aws · Nov 7, 2018 · 9f9b015 · 9f9b015
1 parent b7b91db
commit 9f9b015
Show file tree

Hide file tree

Showing 21 changed files with 262 additions and 92 deletions.
diff --git a/packages/jsii-calc-base/test/assembly.jsii b/packages/jsii-calc-base/test/assembly.jsii
@@ -73,7 +73,6 @@
           },
           "name": "typeName",
           "returns": {
-            "optional": true,
             "primitive": "any"
           }
         }
@@ -103,5 +102,5 @@
     }
   },
   "version": "0.7.8",
-  "fingerprint": "K1rAUs6WiQ5lF08T46B8v/5UL8T8Ot59e0Nc8rh2jiQ="
+  "fingerprint": "FbKHAP60R40tOOnvhCeDrZDrNlgzIypOfAdWPed+Jog="
 }
diff --git a/packages/jsii-calc/lib/compliance.ts b/packages/jsii-calc/lib/compliance.ts
@@ -939,3 +939,12 @@ export interface IInterfaceWithMethods {
 export interface IInterfaceThatShouldNotBeADataType extends IInterfaceWithMethods {
     readonly otherValue: string;
 }
+
+/**
+ * jsii#284: do not recognize "any" as an optional argument
+ */
+export class DoNotRecognizeAnyAsOptional {
+    public method(_requiredAny: any, _optionalAny?: any, _optionalString?: string) {
+
+    }
+}
diff --git a/packages/jsii-calc/test/assembly.jsii b/packages/jsii-calc/test/assembly.jsii
@@ -382,7 +382,6 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -394,13 +393,18 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
+        {
+          "name": "anyProperty",
+          "type": {
+            "primitive": "any"
+          }
+        },
         {
           "name": "arrayProperty",
           "type": {
@@ -528,7 +532,6 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -540,17 +543,15 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
         {
-          "name": "anyProperty",
+          "name": "unknownProperty",
           "type": {
-            "optional": true,
             "primitive": "any"
           }
         },
@@ -560,13 +561,6 @@
             "fqn": "jsii-calc.StringEnum",
             "optional": true
           }
-        },
-        {
-          "name": "unknownProperty",
-          "type": {
-            "optional": true,
-            "primitive": "any"
-          }
         }
       ]
     },
@@ -1301,6 +1295,45 @@
       ],
       "name": "DoNotOverridePrivates"
     },
+    "jsii-calc.DoNotRecognizeAnyAsOptional": {
+      "assembly": "jsii-calc",
+      "docs": {
+        "comment": "jsii#284: do not recognize \"any\" as an optional argument"
+      },
+      "fqn": "jsii-calc.DoNotRecognizeAnyAsOptional",
+      "initializer": {
+        "initializer": true
+      },
+      "kind": "class",
+      "methods": [
+        {
+          "name": "method",
+          "parameters": [
+            {
+              "name": "_requiredAny",
+              "type": {
+                "primitive": "any"
+              }
+            },
+            {
+              "name": "_optionalAny",
+              "type": {
+                "optional": true,
+                "primitive": "any"
+              }
+            },
+            {
+              "name": "_optionalString",
+              "type": {
+                "optional": true,
+                "primitive": "string"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "DoNotRecognizeAnyAsOptional"
+    },
     "jsii-calc.DoubleTrouble": {
       "assembly": "jsii-calc",
       "fqn": "jsii-calc.DoubleTrouble",
@@ -3062,7 +3095,6 @@
         {
           "name": "value",
           "returns": {
-            "optional": true,
             "primitive": "any"
           }
         }
@@ -3412,5 +3444,5 @@
     }
   },
   "version": "0.7.8",
-  "fingerprint": "Xn7Rk17rqR3AaMx3+ssxT0GR1sCWwz0OGC+C8QuLI3A="
+  "fingerprint": "2BaszImarh4WChl9DFUcygfTpEfXU17fHQT2wgEptfM="
 }
diff --git a/packages/jsii-java-runtime-test/project/.gitignore b/packages/jsii-java-runtime-test/project/.gitignore
@@ -1,3 +1,5 @@
+bin/
+
 !index.js
 .idea
 pom.xml

diff --git a/packages/jsii-java-runtime/project/.gitignore b/packages/jsii-java-runtime/project/.gitignore
@@ -1,3 +1,5 @@
+bin/
+
 !index.js
 .idea
 pom.xml

diff --git a/packages/jsii-pacmak/test/.gitignore b/packages/jsii-pacmak/test/.gitignore
@@ -1,2 +1,4 @@
+**/java/bin/
+
 !*.tgz
 
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
@@ -73,7 +73,6 @@
           },
           "name": "typeName",
           "returns": {
-            "optional": true,
             "primitive": "any"
           }
         }
@@ -103,5 +102,5 @@
     }
   },
   "version": "0.7.8",
-  "fingerprint": "K1rAUs6WiQ5lF08T46B8v/5UL8T8Ot59e0Nc8rh2jiQ="
+  "fingerprint": "FbKHAP60R40tOOnvhCeDrZDrNlgzIypOfAdWPed+Jog="
 }
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\",\"optional\":true}", "[]")]
+        [JsiiMethod("typeName", "{\"primitive\":\"any\"}", "[]")]
         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,7 +13,6 @@ 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 or ``undefined``
+      :rtype: any
 
 
 BaseProps (interface)

diff --git a/packages/jsii-pacmak/test/expected.jsii-calc-lib/sphinx/_scope_jsii-calc-lib.rst b/packages/jsii-pacmak/test/expected.jsii-calc-lib/sphinx/_scope_jsii-calc-lib.rst
@@ -349,7 +349,7 @@ Number
       *Inherited from* :py:meth:`@scope/jsii-calc-base.Base <@scope/jsii-calc-base.Base.typeName>`
 
       :return: the name of the class (to verify native type names are created for derived classes).
-      :rtype: any or ``undefined``
+      :rtype: any
 
 
    .. py:method:: toString() -> string
@@ -411,7 +411,7 @@ Operation
       *Inherited from* :py:meth:`@scope/jsii-calc-base.Base <@scope/jsii-calc-base.Base.typeName>`
 
       :return: the name of the class (to verify native type names are created for derived classes).
-      :rtype: any or ``undefined``
+      :rtype: any
 
 
    .. py:attribute:: value
@@ -528,6 +528,6 @@ Value
       *Inherited from* :py:meth:`@scope/jsii-calc-base.Base <@scope/jsii-calc-base.Base.typeName>`
 
       :return: the name of the class (to verify native type names are created for derived classes).
-      :rtype: any or ``undefined``
+      :rtype: any
 
 
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
@@ -382,7 +382,6 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -394,13 +393,18 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
+        {
+          "name": "anyProperty",
+          "type": {
+            "primitive": "any"
+          }
+        },
         {
           "name": "arrayProperty",
           "type": {
@@ -528,7 +532,6 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "array"
@@ -540,17 +543,15 @@
           "type": {
             "collection": {
               "elementtype": {
-                "optional": true,
                 "primitive": "any"
               },
               "kind": "map"
             }
           }
         },
         {
-          "name": "anyProperty",
+          "name": "unknownProperty",
           "type": {
-            "optional": true,
             "primitive": "any"
           }
         },
@@ -560,13 +561,6 @@
             "fqn": "jsii-calc.StringEnum",
             "optional": true
           }
-        },
-        {
-          "name": "unknownProperty",
-          "type": {
-            "optional": true,
-            "primitive": "any"
-          }
         }
       ]
     },
@@ -1301,6 +1295,45 @@
       ],
       "name": "DoNotOverridePrivates"
     },
+    "jsii-calc.DoNotRecognizeAnyAsOptional": {
+      "assembly": "jsii-calc",
+      "docs": {
+        "comment": "jsii#284: do not recognize \"any\" as an optional argument"
+      },
+      "fqn": "jsii-calc.DoNotRecognizeAnyAsOptional",
+      "initializer": {
+        "initializer": true
+      },
+      "kind": "class",
+      "methods": [
+        {
+          "name": "method",
+          "parameters": [
+            {
+              "name": "_requiredAny",
+              "type": {
+                "primitive": "any"
+              }
+            },
+            {
+              "name": "_optionalAny",
+              "type": {
+                "optional": true,
+                "primitive": "any"
+              }
+            },
+            {
+              "name": "_optionalString",
+              "type": {
+                "optional": true,
+                "primitive": "string"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "DoNotRecognizeAnyAsOptional"
+    },
     "jsii-calc.DoubleTrouble": {
       "assembly": "jsii-calc",
       "fqn": "jsii-calc.DoubleTrouble",
@@ -3062,7 +3095,6 @@
         {
           "name": "value",
           "returns": {
-            "optional": true,
             "primitive": "any"
           }
         }
@@ -3412,5 +3444,5 @@
     }
   },
   "version": "0.7.8",
-  "fingerprint": "Xn7Rk17rqR3AaMx3+ssxT0GR1sCWwz0OGC+C8QuLI3A="
+  "fingerprint": "2BaszImarh4WChl9DFUcygfTpEfXU17fHQT2wgEptfM="
 }