Cache extracted runtime

.cirrus.yml

@@ -48,7 +48,7 @@
     image: base-windows-jdk17-v*
     platform: windows
     region: eu-central-1
-    type: c6id.2xlarge
+    type: c6i.4xlarge
     subnet_id: ${CIRRUS_AWS_SUBNET}
     preemptible: false
     use_ssd: true
@@ -68,7 +68,6 @@
     CIRRUS_CLONE_DEPTH: 10
     SONARSOURCE_QA: true
   <<: *MAVEN_CACHE
-  <<: *RUNTIME_CACHE
   node_version_script:
     - node -v
   qa_script:
@@ -115,6 +114,8 @@
   build_script:
     - source cirrus-env CI
     - npm config set registry "${ARTIFACTORY_URL}/api/npm/npm"
+    #  TODO should be as close to build_task as possible, ie. remove incompatible bash scripts
+    - npm run build && npm run test
     - mvn test
   cleanup_before_cache_script: cleanup_maven_repository
 
@@ -174,7 +175,6 @@
       - TEST: '!CoverageTest,!TypeScriptAnalysisTest,!EslintBasedRulesTest,!SonarLintTest'
       - TEST: 'CoverageTest,TypeScriptAnalysisTest,EslintBasedRulesTest,SonarLintTest'
   <<: *MAVEN_CACHE
-  <<: *RUNTIME_CACHE
   qa_script:
     - source /c/buildTools-docker/bin/cirrus-env QA
     - source /c/buildTools-docker/bin/set_maven_build_version $BUILD_NUMBER
@@ -200,7 +200,6 @@
       - RULING: TypeScriptRulingTest
       - RULING: CssRulingTest
   <<: *MAVEN_CACHE
-  <<: *RUNTIME_CACHE
   submodules_script:
     - git submodule update --init
   ruling_script:
@@ -213,7 +212,7 @@
     diff_artifacts:
       path: '**/target/actual/**/*'
 
 promote_task:
   depends_on:
     - ws_scan
     - build_win
@@ -234,6 +233,5 @@
     #artifacts that will have downloadable links in burgr
     ARTIFACTS: org.sonarsource.javascript:sonar-javascript-plugin:jar
   <<: *MAVEN_CACHE
-  <<: *RUNTIME_CACHE
   script: cirrus_promote_maven
   cleanup_before_cache_script: cleanup_maven_repository

package.json

@@ -7,7 +7,7 @@
     "clear": "rimraf lib/*",
     "check-format": "prettier --list-different .",
     "test": "jest",
-    "test-with-coverage": "jest --coverage",
+    "test-with-coverage": "jest --maxWorkers=75% --coverage",
     "format": "prettier --write .",
     "compile": "tsc -b packages/tsconfig.app.json packages/tsconfig.test.json profiling",
     "check-distribution": "bash tools/check-distribution-filepath-length.sh",

sonar-plugin/sonar-javascript-plugin/pom.xml

@@ -164,6 +164,10 @@
                   <resource>win-x64/node.exe.xz</resource>
                   <file>${project.build.directory}/node/win-x64/node.exe.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>win-x64/version.txt</resource>
+                  <file>${project.build.directory}/node/win-x64/version.txt</file>
+                </transformer>
               </transformers>
             </configuration>
           </execution>
@@ -188,6 +192,10 @@
                   <resource>linux-x64/node.xz</resource>
                   <file>${project.build.directory}/node/linux-x64/node.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>linux-x64/version.txt</resource>
+                  <file>${project.build.directory}/node/linux-x64/version.txt</file>
+                </transformer>
               </transformers>
             </configuration>
           </execution>
@@ -212,6 +220,10 @@
                   <resource>darwin-arm64/node.xz</resource>
                   <file>${project.build.directory}/node/darwin-arm64/node.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>darwin-arm64/version.txt</resource>
+                  <file>${project.build.directory}/node/darwin-arm64/version.txt</file>
+                </transformer>
               </transformers>
             </configuration>
           </execution>
@@ -236,14 +248,26 @@
                   <resource>win-x64/node.exe.xz</resource>
                   <file>${project.build.directory}/node/win-x64/node.exe.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>win-x64/version.txt</resource>
+                  <file>${project.build.directory}/node/win-x64/version.txt</file>
+                </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
                   <resource>linux-x64/node.xz</resource>
                   <file>${project.build.directory}/node/linux-x64/node.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>linux-x64/version.txt</resource>
+                  <file>${project.build.directory}/node/linux-x64/version.txt</file>
+                </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
                   <resource>darwin-arm64/node.xz</resource>
                   <file>${project.build.directory}/node/darwin-arm64/node.xz</file>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer">
+                  <resource>darwin-arm64/version.txt</resource>
+                  <file>${project.build.directory}/node/darwin-arm64/version.txt</file>
+                </transformer>
               </transformers>
             </configuration>
           </execution>
@@ -292,6 +316,28 @@
         </executions>
       </plugin>
 
+      <!-- copy runtimes so they are accessible by unit tests -->
+      <plugin>
+        <artifactId>maven-resources-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>copy-resources</id>
+            <phase>generate-test-resources</phase>
+            <goals>
+              <goal>copy-resources</goal>
+            </goals>
+            <configuration>
+              <outputDirectory>${basedir}/target/test-classes</outputDirectory>
+              <resources>
+                <resource>
+                  <directory>${project.build.directory}/node</directory>
+                </resource>
+              </resources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
     </plugins>
   </build>
 

sonar-plugin/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/JavaScriptPlugin.java

@@ -38,7 +38,7 @@
 import org.sonar.plugins.javascript.bridge.BridgeServerImpl;
 import org.sonar.plugins.javascript.bridge.BundleImpl;
 import org.sonar.plugins.javascript.bridge.CssRuleSensor;
-import org.sonar.plugins.javascript.bridge.EmbeddedNode;
+import org.sonar.plugins.javascript.bridge.EnvironmentImpl;
 import org.sonar.plugins.javascript.bridge.HtmlSensor;
 import org.sonar.plugins.javascript.bridge.JsTsChecks;
 import org.sonar.plugins.javascript.bridge.JsTsSensor;
@@ -152,7 +152,7 @@ public void define(Context context) {
       AnalysisProcessor.class,
       YamlSensor.class,
       HtmlSensor.class,
-      EmbeddedNode.class
+      EnvironmentImpl.class
     );
 
     context.addExtensions(

sonar-plugin/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/bridge/BridgeServerImpl.java

@@ -32,6 +32,7 @@
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse.BodyHandlers;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.time.Duration;
 import java.util.HashMap;
@@ -48,7 +49,6 @@
 import javax.annotation.Nullable;
 import org.sonar.api.SonarProduct;
 import org.sonar.api.batch.sensor.SensorContext;
-import org.sonar.api.utils.TempFolder;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
 import org.sonar.api.utils.log.Profiler;
@@ -75,7 +75,7 @@ private enum Status {
     "SONARJS_EXISTING_NODE_PROCESS_PORT";
   private static final Gson GSON = new Gson();
 
-  private static final String DEPLOY_LOCATION = "bridge-bundle";
+  private static final Path DEPLOY_LOCATION = Path.of(".sonar", "js", "bridge-bundle");
 
   private final HttpClient client;
   private final NodeCommandBuilder nodeCommandBuilder;
@@ -100,19 +100,17 @@ public BridgeServerImpl(
     Bundle bundle,
     RulesBundles rulesBundles,
     NodeDeprecationWarning deprecationWarning,
-    TempFolder tempFolder,
     Monitoring monitoring,
-    EmbeddedNode embeddedNode
+    Environment environment
   ) {
     this(
       nodeCommandBuilder,
       DEFAULT_TIMEOUT_SECONDS,
       bundle,
       rulesBundles,
       deprecationWarning,
-      tempFolder,
       monitoring,
-      embeddedNode
+      environment
     );
   }
 
@@ -122,9 +120,8 @@ public BridgeServerImpl(
     Bundle bundle,
     RulesBundles rulesBundles,
     NodeDeprecationWarning deprecationWarning,
-    TempFolder tempFolder,
     Monitoring monitoring,
-    EmbeddedNode embeddedNode
+    Environment environment
   ) {
     this.nodeCommandBuilder = nodeCommandBuilder;
     this.timeoutSeconds = timeoutSeconds;
@@ -134,10 +131,17 @@ public BridgeServerImpl(
     this.rulesBundles = rulesBundles;
     this.deprecationWarning = deprecationWarning;
     this.hostAddress = InetAddress.getLoopbackAddress().getHostAddress();
-    this.deployLocation = tempFolder.newDir(DEPLOY_LOCATION).toPath();
+    this.deployLocation = getPluginCache(environment.getUserHome());
     this.monitoring = monitoring;
     this.heartbeatService = Executors.newSingleThreadScheduledExecutor();
-    this.embeddedNode = embeddedNode;
+    this.embeddedNode = new EmbeddedNode(environment);
+  }
+
+  /**
+   * @return a path to `DEPLOY_LOCATION` from the given `baseDir`
+   */
+  private static Path getPluginCache(String baseDir) {
+    return Path.of(baseDir).resolve(DEPLOY_LOCATION);
   }
 
   void heartbeat() {
@@ -163,7 +167,13 @@ int getTimeoutSeconds() {
     return timeoutSeconds;
   }
 
+  /**
+   * Extracts the bridge files and node.js runtime (if included)
+   *
+   * @throws IOException
+   */
   void deploy() throws IOException {
+    Files.createDirectories(deployLocation);
     bundle.deploy(deployLocation);
     embeddedNode.deployNode(deployLocation);
   }