org.sonarsource.sonarlint.ls.telemetry.SonarLintTelemetry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-language-server Show documentation
SonarLint Language Server
There is a newer version: 3.12.0.75621
Show newest version
/*
 * SonarLint Language Server
 * Copyright (C) 2009-2024 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 GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * 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 GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarsource.sonarlint.ls.telemetry;

import java.util.function.Consumer;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonarsource.sonarlint.core.commons.api.SonarLanguage;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.telemetry.TelemetryRpcService;
import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.AddQuickFixAppliedForRuleParams;
import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.AnalysisDoneOnSingleLanguageParams;
import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.DevNotificationsClickedParams;
import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.FixSuggestionResolvedParams;
import org.sonarsource.sonarlint.core.rpc.protocol.client.telemetry.HelpAndFeedbackClickedParams;
import org.sonarsource.sonarlint.core.rpc.protocol.common.Language;
import org.sonarsource.sonarlint.ls.backend.BackendServiceFacade;
import org.sonarsource.sonarlint.ls.log.LanguageClientLogger;
import org.sonarsource.sonarlint.ls.settings.WorkspaceSettings;
import org.sonarsource.sonarlint.ls.settings.WorkspaceSettingsChangeListener;

public class SonarLintTelemetry implements WorkspaceSettingsChangeListener {
  public static final String DISABLE_PROPERTY_KEY = "sonarlint.telemetry.disabled";
  private final BackendServiceFacade backendServiceFacade;
  private final LanguageClientLogger logOutput;

  public SonarLintTelemetry(BackendServiceFacade backendServiceFacade, LanguageClientLogger logOutput) {
    this.backendServiceFacade = backendServiceFacade;
    this.logOutput = logOutput;
  }

  private void optOut(boolean optOut) {
    backendServiceFacade.getBackendService().getTelemetryStatus()
      .thenAccept(status -> {
        if (optOut) {
          if (status.isEnabled()) {
            logOutput.debug("Disabling telemetry");
            backendServiceFacade.getBackendService().disableTelemetry();
          }
        } else {
          if (!status.isEnabled()) {
            logOutput.debug("Enabling telemetry");
            backendServiceFacade.getBackendService().enableTelemetry();
          }
        }
      });
  }

  public boolean enabled() {
    var telemetrySystemPropertyOverride = System.getProperty(DISABLE_PROPERTY_KEY);
    var telemetryDisabledBySystemProperty = "true".equals(telemetrySystemPropertyOverride);
    if (telemetryDisabledBySystemProperty) {
      logOutput.debug("Telemetry is disabled by system property");
    }
    return !telemetryDisabledBySystemProperty;
  }

  public void analysisDoneOnMultipleFiles() {
    actIfEnabled(TelemetryRpcService::analysisDoneOnMultipleFiles);
  }

  public void analysisDoneOnSingleLanguage(@Nullable SonarLanguage language, int analysisTimeMs) {
    if (language == null) return;
    actIfEnabled(telemetryService -> telemetryService.analysisDoneOnSingleLanguage(new AnalysisDoneOnSingleLanguageParams(Language.valueOf(language.name()), analysisTimeMs)));
  }

  public void devNotificationsClicked(String eventType) {
    actIfEnabled(telemetryRpcService -> telemetryRpcService.devNotificationsClicked(new DevNotificationsClickedParams(eventType)));
  }

  public void taintVulnerabilitiesInvestigatedLocally() {
    actIfEnabled(TelemetryRpcService::taintVulnerabilitiesInvestigatedLocally);
  }

  public void taintVulnerabilitiesInvestigatedRemotely() {
    actIfEnabled(TelemetryRpcService::taintVulnerabilitiesInvestigatedRemotely);
  }

  public void addQuickFixAppliedForRule(String ruleKey) {
    actIfEnabled(telemetryRpcService -> telemetryRpcService.addQuickFixAppliedForRule(new AddQuickFixAppliedForRuleParams(ruleKey)));
  }

  public void helpAndFeedbackLinkClicked(String itemId) {
    actIfEnabled(telemetryRpcService -> telemetryRpcService.helpAndFeedbackLinkClicked(new HelpAndFeedbackClickedParams(itemId)));
  }

  public void addedAutomaticBindings() {
    actIfEnabled(TelemetryRpcService::addedAutomaticBindings);
  }

  public void addedImportedBindings() {
    actIfEnabled(TelemetryRpcService::addedImportedBindings);
  }

  public void addedManualBindings() {
    actIfEnabled(TelemetryRpcService::addedManualBindings);
  }

  public void fixSuggestionResolved(FixSuggestionResolvedParams params) {
    actIfEnabled(telemetryRpcService -> telemetryRpcService.fixSuggestionResolved(params));
  }

  private void actIfEnabled(Consumer action) {
    if (enabled()) {
      action.accept(backendServiceFacade.getBackendService().getTelemetryService());
    }
  }

  @Override
  public void onChange(@CheckForNull WorkspaceSettings oldValue, WorkspaceSettings newValue) {
    optOut(newValue.isDisableTelemetry());
  }
}