org.sonar.plugins.javascript.analysis.PluginTelemetry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-javascript-plugin Show documentation

Code Analyzer for JavaScript/TypeScript/CSS

There is a newer version: 5.1.1.7506

Show newest version

/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2025 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the Sonar Source-Available License for more details.
 *
 * You should have received a copy of the Sonar Source-Available License
 * along with this program; if not, see https://sonarsource.com/license/ssal/
 */
package org.sonar.plugins.javascript.analysis;

import java.util.HashMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.api.utils.Version;
import org.sonar.plugins.javascript.bridge.BridgeServer;

public class PluginTelemetry {

  private static final Logger LOG = LoggerFactory.getLogger(PluginTelemetry.class);
  private static final String KEY_PREFIX = "javascript.";
  private static final String RUNTIME_PREFIX = KEY_PREFIX + "runtime.";

  private final BridgeServer server;
  private final SensorContext ctx;

  public PluginTelemetry(SensorContext ctx, BridgeServer server) {
    this.ctx = ctx;
    this.server = server;
  }

  void reportTelemetry() {
    var isTelemetrySupported = ctx
      .runtime()
      .getApiVersion()
      .isGreaterThanOrEqual(Version.create(10, 9));
    if (!isTelemetrySupported) {
      // addTelemetryProperty is added in 10.9:
      // https://github.com/SonarSource/sonar-plugin-api/releases/tag/10.9.0.2362
      return;
    }
    var telemetry = server.getTelemetry();
    if (telemetry.runtimeTelemetry() != null) {
      var keyMapToSave = new HashMap();
      keyMapToSave.put(
        RUNTIME_PREFIX + "node-executable-origin",
        telemetry.runtimeTelemetry().nodeExecutableOrigin()
      );
      keyMapToSave.put(
        RUNTIME_PREFIX + "version",
        telemetry.runtimeTelemetry().version().toString()
      );
      keyMapToSave.put(
        RUNTIME_PREFIX + "major-version",
        Integer.toString(telemetry.runtimeTelemetry().version().major())
      );
      keyMapToSave.forEach(ctx::addTelemetryProperty);
      LOG.debug("Telemetry saved: {}", keyMapToSave);
    }
  }
}