feat: JSII_AGENT

Language runtimes now set JSII_AGENT to include the runtime version
such as "DotNet/1.2.3.4" or "Java/1.8.44".

Fixes #324

packages/jsii-calc/lib/compliance.ts

@@ -1196,3 +1196,15 @@ export interface LoadBalancedFargateServiceProps {
  */
  publicTasks?: boolean;
 }
+
+/**
+ * Host runtime version should be set via JSII_AGENT
+ */
+export class JsiiAgent {
+ /**
+ * Returns the value of the JSII_AGENT environment variable.
+ */
+ public static get jsiiAgent(): string | undefined {
+ return process.env.JSII_AGENT;
+ }
+};

packages/jsii-calc/test/assembly.jsii

@@ -2057,6 +2057,32 @@
  }
  ]
  },
+ "jsii-calc.JsiiAgent": {
+ "assembly": "jsii-calc",
+ "docs": {
+ "comment": "Host runtime version should be set via JSII_AGENT"
+ },
+ "fqn": "jsii-calc.JsiiAgent",
+ "initializer": {
+ "initializer": true
+ },
+ "kind": "class",
+ "name": "JsiiAgent",
+ "properties": [
+ {
+ "docs": {
+ "comment": "Returns the value of the JSII_AGENT environment variable."
+ },
+ "immutable": true,
+ "name": "jsiiAgent",
+ "static": true,
+ "type": {
+ "optional": true,
+ "primitive": "string"
+ }
+ }
+ ]
+ },
  "jsii-calc.LoadBalancedFargateServiceProps": {
  "assembly": "jsii-calc",
  "datatype": true,
@@ -3671,5 +3697,5 @@
  }
  },
  "version": "0.7.11",
- "fingerprint": "2o7FtEirv0LpuaJ1G+wAxoHTW7FHr4U1taZ5GcVYt2o="
+ "fingerprint": "Wd0MWG0v1qaBoROkgYUltcLONrS4+yQU9Y+lwHTb5NA="
 }

packages/jsii-dotnet-runtime-test/test/Amazon.JSII.Runtime.IntegrationTests/ComplianceTests.cs

@@ -861,6 +861,12 @@ public void NullShouldBeTreatedAsUndefined()
  obj.ChangeMeToUndefined = null;
  obj.VerifyPropertyIsUndefined();
  }
+
+ [Fact(DisplayName = Prefix + nameof(JsiiAgent))]
+ public void JsiiAgent()
+ {
+ Assert.Equal("DotNet/" + Environment.Version.ToString(), JsiiAgent_.JsiiAgent);
+ }
 
  class NumberReturner : DeputyBase, IIReturnsNumber
  {

packages/jsii-dotnet-runtime/src/Amazon.JSII.Runtime/Services/NodeProcess.cs

@@ -26,6 +26,8 @@ public NodeProcess(IJsiiRuntimeProvider jsiiRuntimeProvider, ILoggerFactory logg
  }
  };
 
+ _process.StartInfo.EnvironmentVariables.Add("JSII_AGENT", "DotNet/" + Environment.Version.ToString());
+
  _logger.LogDebug("Starting jsii runtime...");
  _logger.LogDebug($"{_process.StartInfo.FileName} {_process.StartInfo.Arguments}");
 

packages/jsii-java-runtime-test/project/src/test/java/software/amazon/jsii/testing/ComplianceTest.java

@@ -37,6 +37,7 @@
 import software.amazon.jsii.tests.calculator.SyncVirtualMethods;
 import software.amazon.jsii.tests.calculator.UnionProperties;
 import software.amazon.jsii.tests.calculator.UsesInterfaceWithProperties;
+import software.amazon.jsii.tests.calculator.JsiiAgent;
 import software.amazon.jsii.tests.calculator.composition.CompositeOperation;
 import software.amazon.jsii.tests.calculator.lib.EnumFromScopedModule;
 import software.amazon.jsii.tests.calculator.lib.IFriendly;
@@ -952,6 +953,11 @@ public void nullShouldBeTreatedAsUndefined() {
  obj.setChangeMeToUndefined(null);
  obj.verifyPropertyIsUndefined();
  }
+
+ @Test
+ public void testJsiiAgent() {
+ assertEquals("Java/" + System.getProperty("java.version"), JsiiAgent.getJsiiAgent());
+ }
 
  static class MulTen extends Multiply {
  public MulTen(final int value) {

packages/jsii-java-runtime/project/src/main/java/software/amazon/jsii/JsiiRuntime.java

@@ -222,6 +222,8 @@ private void startRuntimeIfNeeded() {
  if (traceEnabled) {
  pb.environment().put("JSII_DEBUG", "1");
  }
+
+ pb.environment().put("JSII_AGENT", "Java/" + System.getProperty("java.version"));
 
  try {
  this.childProcess = pb.start();

packages/jsii-kernel/test/test.kernel.ts

@@ -959,6 +959,10 @@ defineTest('nulls are converted to undefined - properties', async (_test, sandbo
  sandbox.invoke({ objref, method: 'verifyPropertyIsUndefined' });
 });
 
+defineTest('JSII_AGENT is undefined in node.js', async (test, sandbox) => {
+ test.equal(sandbox.sget({ fqn: 'jsii-calc.JsiiAgent', property: 'jsiiAgent' }).value, undefined);
+});
+
 // =================================================================================================
 
 const testNames: { [name: string]: boolean } = { };

packages/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii

@@ -2057,6 +2057,32 @@
  }
  ]
  },
+ "jsii-calc.JsiiAgent": {
+ "assembly": "jsii-calc",
+ "docs": {
+ "comment": "Host runtime version should be set via JSII_AGENT"
+ },
+ "fqn": "jsii-calc.JsiiAgent",
+ "initializer": {
+ "initializer": true
+ },
+ "kind": "class",
+ "name": "JsiiAgent",
+ "properties": [
+ {
+ "docs": {
+ "comment": "Returns the value of the JSII_AGENT environment variable."
+ },
+ "immutable": true,
+ "name": "jsiiAgent",
+ "static": true,
+ "type": {
+ "optional": true,
+ "primitive": "string"
+ }
+ }
+ ]
+ },
  "jsii-calc.LoadBalancedFargateServiceProps": {
  "assembly": "jsii-calc",
  "datatype": true,
@@ -3671,5 +3697,5 @@
  }
  },
  "version": "0.7.11",
- "fingerprint": "2o7FtEirv0LpuaJ1G+wAxoHTW7FHr4U1taZ5GcVYt2o="
+ "fingerprint": "Wd0MWG0v1qaBoROkgYUltcLONrS4+yQU9Y+lwHTb5NA="
 }

packages/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/JsiiAgent_.cs

@@ -0,0 +1,28 @@
+using Amazon.JSII.Runtime.Deputy;
+
+namespace Amazon.JSII.Tests.CalculatorNamespace
+{
+ /// <summary>Host runtime version should be set via JSII_AGENT</summary>
+ [JsiiClass(typeof(JsiiAgent_), "jsii-calc.JsiiAgent", "[]")]
+ public class JsiiAgent_ : DeputyBase
+ {
+ public JsiiAgent_(): base(new DeputyProps(new object[]{}))
+ {
+ }
+
+ protected JsiiAgent_(ByRefValue reference): base(reference)
+ {
+ }
+
+ protected JsiiAgent_(DeputyProps props): base(props)
+ {
+ }
+
+ /// <summary>Returns the value of the JSII_AGENT environment variable.</summary>
+ [JsiiProperty("jsiiAgent", "{\"primitive\":\"string\",\"optional\":true}")]
+ public static string JsiiAgent
+ {
+ get => GetStaticProperty<string>(typeof(JsiiAgent_));
+ }
+ }
+}

packages/jsii-pacmak/test/expected.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/$Module.java

@@ -59,6 +59,7 @@ protected Class<?> resolveClass(final String fqn) throws ClassNotFoundException
  case "jsii-calc.JSObjectLiteralToNative": return software.amazon.jsii.tests.calculator.JSObjectLiteralToNative.class;
  case "jsii-calc.JSObjectLiteralToNativeClass": return software.amazon.jsii.tests.calculator.JSObjectLiteralToNativeClass.class;
  case "jsii-calc.JavaReservedWords": return software.amazon.jsii.tests.calculator.JavaReservedWords.class;
+ case "jsii-calc.JsiiAgent": return software.amazon.jsii.tests.calculator.JsiiAgent.class;
  case "jsii-calc.LoadBalancedFargateServiceProps": return software.amazon.jsii.tests.calculator.LoadBalancedFargateServiceProps.class;
  case "jsii-calc.Multiply": return software.amazon.jsii.tests.calculator.Multiply.class;
  case "jsii-calc.MutableObjectLiteral": return software.amazon.jsii.tests.calculator.MutableObjectLiteral.class;

packages/jsii-pacmak/test/expected.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/JsiiAgent.java

@@ -0,0 +1,24 @@
+package software.amazon.jsii.tests.calculator;
+
+/**
+ * Host runtime version should be set via JSII_AGENT
+ */
+@javax.annotation.Generated(value = "jsii-pacmak")
+@software.amazon.jsii.Jsii(module = software.amazon.jsii.tests.calculator.$Module.class, fqn = "jsii-calc.JsiiAgent")
+public class JsiiAgent extends software.amazon.jsii.JsiiObject {
+ protected JsiiAgent(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
+ super(mode);
+ }
+ public JsiiAgent() {
+ super(software.amazon.jsii.JsiiObject.InitializationMode.Jsii);
+ software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
+ }
+
+ /**
+ * Returns the value of the JSII_AGENT environment variable.
+ */
+ @javax.annotation.Nullable
+ public static java.lang.String getJsiiAgent() {
+ return software.amazon.jsii.JsiiObject.jsiiStaticGet(software.amazon.jsii.tests.calculator.JsiiAgent.class, "jsiiAgent", java.lang.String.class);
+ }
+}

packages/jsii-pacmak/test/expected.jsii-calc/sphinx/jsii-calc.rst

@@ -2596,6 +2596,47 @@ JavaReservedWords
  :type: string
 
 
+JsiiAgent
+^^^^^^^^^
+
+.. py:class:: JsiiAgent()
+
+ **Language-specific names:**
+
+ .. tabs::
+
+ .. code-tab:: c#
+
+ using Amazon.JSII.Tests.CalculatorNamespace;
+
+ .. code-tab:: java
+
+ import software.amazon.jsii.tests.calculator.JsiiAgent;
+
+ .. code-tab:: javascript
+
+ const { JsiiAgent } = require('jsii-calc');
+
+ .. code-tab:: typescript
+
+ import { JsiiAgent } from 'jsii-calc';
+
+
+
+ Host runtime version should be set via JSII_AGENT
+
+
+
+
+ .. py:attribute:: jsiiAgent
+
+ Returns the value of the JSII_AGENT environment variable.
+
+
+
+ :type: string *(optional)* *(readonly)* *(static)*
+
+
 LoadBalancedFargateServiceProps (interface)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^