fix(python-runtime): add compliance test for async context callbacks

Author: mrgrain

CONTRIBUTING.md

@@ -1,12 +1,15 @@
 # Contributing to jsii
+
 Thanks for your interest in contributing to AWS JSII! :heart:
 
 This document describes how to set up a development environment and submit your
 contributions. Please read it carefully and let us know if it's not up-to date
 (or even better, submit a pull request with your corrections! :wink:).
 
 ## Pre-requisites
+
 ### Setup Docker image
+
 Due to the polyglot nature of `jsii`, the toolchain requirements are somewhat
 more complicated than for most projects. In order to locally develop `jsii`, you
 will need a number of tools.
@@ -19,37 +22,38 @@ our own CI/CD: the ["superchain" image][superchain] from.
 The image can be built for local usage, too:
 
 ```console
-$ IMAGE=superchain
-$ docker build -t ${IMAGE} ./superchain
+IMAGE=superchain
+docker build -t ${IMAGE} ./superchain
 ```
 
 In order to get an interactive shell within a Docker container using the
 *superchain* image you just built:
 
 ```console
-$ cd jsii # go to the root of the jsii repo
-$ docker run --rm --net=host -it -v $PWD:$PWD -w $PWD ${IMAGE}
+cd jsii # go to the root of the jsii repo
+docker run --rm --net=host -it -v $PWD:$PWD -w $PWD ${IMAGE}
 ```
 
 In the shell that pops up, the `npm run` commands in the following sections must
 be executed.
 
 ### Alternative: Manually install the toolchain
+
 The following tools need to be installed to develop on JSII locally. We recommend
 using the docker image from the above section, but if you wish to, you can install
 in your development environment.
 
 - [Node `14.6.0`] or later
 - [Yarn `1.19.1`] or later
 - An OpenJDK-8 distribution (e.g: [Oracle's OpenJDK8], [Amazon Corretto 8])
-  + [`maven >= 3.0.5`](https://maven.apache.org)
+  - [`maven >= 3.0.5`](https://maven.apache.org)
 - [.NET Core `3.1`] or later
-  + *Recommended:* [`mono >= 5`](https://www.mono-project.com)
+  - *Recommended:* [`mono >= 5`](https://www.mono-project.com)
 - [Python `3.7.3`] or later
-  + [`pip`](https://pip.pypa.io/en/stable/installing/)
-  + [`setuptools >= 38.6.0`](https://pypi.org/project/setuptools/)
-  + [`wheel`](https://pypi.org/project/wheel/)
-  + *Recommended:* [`twine`](https://pypi.org/project/twine/)
+  - [`pip`](https://pip.pypa.io/en/stable/installing/)
+  - [`setuptools >= 38.6.0`](https://pypi.org/project/setuptools/)
+  - [`wheel`](https://pypi.org/project/wheel/)
+  - *Recommended:* [`twine`](https://pypi.org/project/twine/)
 - [Go] `1.18` or newer
 
 [Node `14.6.0`]: https://nodejs.org/download/release/v14.6.0/
@@ -61,14 +65,15 @@ in your development environment.
 [Go]: https://go.dev/dl/
 
 ## Getting Started
+
 ### Bootstrapping
 
 The project is managed as a [monorepo] using [lerna].
 
 [monorepo]: https://github.com/babel/babel/blob/main/doc/design/monorepo.md
 [lerna]: https://github.com/lerna/lerna
 
-1. Check out this respository and change directory to its root.
+1. Check out this repository and change directory to its root.
 2. Run `yarn install && yarn build` to install lerna, bootstrap the repository
    and perform an initial build and test cycle.
 
@@ -140,10 +145,10 @@ The runtime client library should be implemented as a module under
 
 The jsii runtime client library usually includes the following components:
 
-- Child process manager: responsible to start/stop the **@jsii/runtime** child
+- Child process manager: responsible to start/stop the __@jsii/runtime__ child
   process.
 - Protocol layer: implements the STDIN/STDOUT protocol that interacts with the
-  **@jsii/runtime**.
+  __@jsii/runtime__.
 - Proxy layer: includes base classes and serialization utilities to implement
   the generated proxy classes.
 
@@ -163,6 +168,7 @@ The [Python](./packages/jsii-pacmak/lib/targets/python.ts) target is a good
 example to work from.
 
 ## Releasing
+
 ### The `jsii/superchain` Docker image
 
 Upon merging new changes to the `main` branch, the `jsii/superchain:nightly`

packages/@jsii/python-runtime/tests/test_compliance.py

@@ -77,6 +77,8 @@
     AnonymousImplementationProvider,
     UpcasingReflectable,
     PromiseNothing,
+    IPromiseProducer,
+    ImplementationFromAsyncContext,
 )
 from jsii_calc.cdk16625 import Cdk16625
 from jsii_calc.cdk22369 import AcceptsPath
@@ -1361,5 +1363,19 @@ def test_void_returning_async():
     """Verifies it's okay to return a Promise<void>."""
 
     assert PromiseNothing().instance_promise_it() is None
-    ## TODO: This is currently broken as code-gen is incorrect for static async.
+    # TODO: This is currently broken as code-gen is incorrect for static async.
     # assert PromiseNothing.promise_it() is None
+
+
+def test_calling_implementation_from_async_context():
+    @jsii.implements(IPromiseProducer)
+    class ConcreteProducer:
+        def produce(self) -> str:
+            return "result"
+
+    producer = ConcreteProducer()
+
+    assert producer.produce() == "result"
+
+    worker = ImplementationFromAsyncContext(producer)
+    assert worker.do_async_work() == "result"

packages/jsii-calc/lib/compliance.ts

@@ -3141,3 +3141,28 @@ export class PromiseNothing {
     return PromiseNothing.promiseIt();
   }
 }
+
+/**
+ * Async Context operations
+ * Validates features work when run from within an async context
+ *
+ * @see https://github.com/aws/jsii/issues/3917
+ */
+export interface IPromiseProducer {
+  produce(): Promise<string>;
+}
+
+export class ImplementationFromAsyncContext {
+  public constructor(private readonly producer: IPromiseProducer) {}
+
+  public async doAsyncWork(): Promise<string> {
+    await this.sleep(200);
+    return this.producer.produce();
+  }
+
+  private async sleep(ms: number) {
+    return new Promise((resolve) => {
+      setTimeout(resolve, ms);
+    });
+  }
+}

packages/jsii-calc/test/assembly.jsii

@@ -7915,6 +7915,57 @@
       ],
       "symbolId": "lib/compliance:IPrivatelyImplemented"
     },
+    "jsii-calc.IPromiseProducer": {
+      "assembly": "jsii-calc",
+      "docs": {
+        "see": "https://github.com/aws/jsii/issues/3917",
+        "stability": "stable",
+        "summary": "Async Context operations Validates features work when run from within an async context."
+      },
+      "fqn": "jsii-calc.IPromiseProducer",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "lib/compliance.ts",
+        "line": 3151
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "async": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3153
+          },
+          "name": "later",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3152
+          },
+          "name": "now",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "IPromiseProducer",
+      "symbolId": "lib/compliance:IPromiseProducer"
+    },
     "jsii-calc.IPublicInterface": {
       "assembly": "jsii-calc",
       "docs": {
@@ -8275,6 +8326,70 @@
       ],
       "symbolId": "lib/compliance:Implementation"
     },
+    "jsii-calc.ImplementationFromAsyncContext": {
+      "assembly": "jsii-calc",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "jsii-calc.ImplementationFromAsyncContext",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "lib/compliance.ts",
+          "line": 3157
+        },
+        "parameters": [
+          {
+            "name": "producer",
+            "type": {
+              "fqn": "jsii-calc.IPromiseProducer"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/compliance.ts",
+        "line": 3156
+      },
+      "methods": [
+        {
+          "async": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3164
+          },
+          "name": "doAsyncStuff",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3159
+          },
+          "name": "doNormalStuff",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "ImplementationFromAsyncContext",
+      "symbolId": "lib/compliance:ImplementationFromAsyncContext"
+    },
     "jsii-calc.ImplementsInterfaceWithInternal": {
       "assembly": "jsii-calc",
       "docs": {
@@ -18843,5 +18958,5 @@
     }
   },
   "version": "3.20.120",
-  "fingerprint": "EH7xszNdCh9PCFUZ8Foi7g2CPhdrKeZm8CQaUCNv4GQ="
+  "fingerprint": "58WxrqNJMJE1Z4D13CRDxszUEaNF5LoQvvnv4eQBygg="
 }