fix(pacmak): invokeBinScript fails when using symlinked cache

gh-pages/content/overview/runtime-architecture.md

@@ -1,4 +1,5 @@
 # Runtime Architecture
+
 ## Generated Libraries
 
 When using `jsii-pacmak` to generate libraries in different programming
@@ -149,7 +150,7 @@ The initialization workflow can be described as:
     the child's `STDERR` stream, and forwards the decoded data to it's host
     process' `STDERR` and `STDOUT` as needed.
 4. The *runtime client library* automatically loads the **Javascript** modules
-    bundled within the *generated bindings* (and their depedencies, bundled in
+    bundled within the *generated bindings* (and their dependencies, bundled in
     other *generated bindings*) into the `node` process when needed.
 5. Calls into the *Generated bindings* are encoded into JSON requests and sent
     to the child `node` process, which will execute the corresponding

packages/@jsii/kernel/src/kernel.ts

@@ -1372,11 +1372,6 @@ export class Kernel {
       // Make sure the current NODE_OPTIONS are honored if we shell out to node
       const nodeOptions = [...process.execArgv];
 
-      // When we are using the symlinked version of the cache, we need to preserve both symlink settings for binaries
-      if (nodeOptions.includes('--preserve-symlinks')) {
-        nodeOptions.push('--preserve-symlinks-main');
-      }
-
       return {
         command: path.join(packageDir, scriptPath),
         args: req.args ?? [],

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

@@ -35,12 +35,21 @@ def silence_node_deprecation_warnings():
         environ[var] = store[var]
 
 
+@pytest.fixture()
+def disable_jsii_runtime_package_cache():
+    """Disable the jsii runtime cache because it is problematic with InvokeBinScript."""
+
+    environ["JSII_RUNTIME_PACKAGE_CACHE"] = "disabled"
+
+
 class TestInvokeBinScript:
     @pytest.mark.skipif(
         platform.system() == "Windows",
         reason="jsii-pacmak does not generate windows scripts",
     )
-    def test_invoke_script(self, silence_node_deprecation_warnings) -> None:
+    def test_invoke_script(
+        self, silence_node_deprecation_warnings, disable_jsii_runtime_package_cache
+    ) -> None:
         script_path = f".env/bin/calc"
         result = subprocess.run([script_path], capture_output=True)
 
@@ -51,7 +60,9 @@ def test_invoke_script(self, silence_node_deprecation_warnings) -> None:
         platform.system() == "Windows",
         reason="jsii-pacmak does not generate windows scripts",
     )
-    def test_invoke_script_with_args(self, silence_node_deprecation_warnings) -> None:
+    def test_invoke_script_with_args(
+        self, silence_node_deprecation_warnings, disable_jsii_runtime_package_cache
+    ) -> None:
         script_path = f".env/bin/calc"
         result = subprocess.run([script_path, "arg1", "arg2"], capture_output=True)
 
@@ -63,7 +74,7 @@ def test_invoke_script_with_args(self, silence_node_deprecation_warnings) -> Non
         reason="jsii-pacmak does not generate windows scripts",
     )
     def test_invoke_script_with_failure(
-        self, silence_node_deprecation_warnings
+        self, silence_node_deprecation_warnings, disable_jsii_runtime_package_cache
     ) -> None:
         script_path = f".env/bin/calc"
         result = subprocess.run([script_path, "arg1", "fail"], capture_output=True)
@@ -77,7 +88,7 @@ def test_invoke_script_with_failure(
         reason="jsii-pacmak does not generate windows scripts",
     )
     def test_invoke_script_with_line_flush(
-        self, silence_node_deprecation_warnings
+        self, silence_node_deprecation_warnings, disable_jsii_runtime_package_cache
     ) -> None:
         """Make sure lines are flushed immediately as they are generated, rather than
         buffered to the end

packages/jsii-pacmak/lib/targets/python.ts

@@ -1833,6 +1833,11 @@ class PythonModule implements PythonType {
           code.line();
           code.line('import jsii');
           code.line('import sys');
+          code.line('import os');
+          code.line();
+          code.openBlock('if "JSII_RUNTIME_PACKAGE_CACHE" not in os.environ');
+          code.line('os.environ["JSII_RUNTIME_PACKAGE_CACHE"] = "disabled"');
+          code.closeBlock();
           code.line();
           emitList(
             code,