org.sonarsource.sonarlint.ls.log.LanguageClientLogger 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.log;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.time.Clock;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import javax.annotation.CheckForNull;
import org.eclipse.lsp4j.MessageParams;
import org.eclipse.lsp4j.MessageType;
import org.eclipse.lsp4j.services.LanguageClient;
import org.sonarsource.sonarlint.core.rpc.protocol.client.log.LogLevel;
import org.sonarsource.sonarlint.ls.settings.WorkspaceSettings;
import org.sonarsource.sonarlint.ls.settings.WorkspaceSettingsChangeListener;

import static java.time.temporal.ChronoField.HOUR_OF_DAY;
import static java.time.temporal.ChronoField.MILLI_OF_SECOND;
import static java.time.temporal.ChronoField.MINUTE_OF_HOUR;
import static java.time.temporal.ChronoField.SECOND_OF_MINUTE;

/**
 * Used by the language server
 */
public class LanguageClientLogger implements WorkspaceSettingsChangeListener {

  private static final DateTimeFormatter LOG_DATE_FORMAT = new DateTimeFormatterBuilder()
    .appendValue(HOUR_OF_DAY, 2)
    .appendLiteral(':')
    .appendValue(MINUTE_OF_HOUR, 2)
    .appendLiteral(':')
    .appendValue(SECOND_OF_MINUTE, 2)
    .appendLiteral('.')
    .appendValue(MILLI_OF_SECOND, 3)
    .toFormatter();

  private final LanguageClient client;
  private boolean showVerboseLogs;
  private final Clock clock;

  public LanguageClientLogger(LanguageClient client) {
    this(client, Clock.systemDefaultZone());
  }

  // Visible for testing
  LanguageClientLogger(LanguageClient client, Clock clock) {
    this.client = client;
    this.clock = clock;
  }

  public void initialize(boolean showVerboseLogs) {
    this.showVerboseLogs = showVerboseLogs;
  }

  public void log(String formattedMessage, LogLevel level) {
    log(getLogPrefix(level), formattedMessage, isDebugOrTrace(level));
  }

  private static boolean isDebugOrTrace(LogLevel level) {
    return level == LogLevel.DEBUG || level == LogLevel.TRACE;
  }

  private static String getLogPrefix(LogLevel level) {
    return switch (level) {
      case DEBUG -> "Debug";
      case TRACE -> "Trace";
      case INFO -> "Info";
      case WARN -> "Warn";
      case ERROR -> "Error";
    };
  }

  private void log(String prefix, String formattedMessage, boolean isDebugOrTrace) {
    if (showVerboseLogs || !isDebugOrTrace) {
      client.logMessage(new MessageParams(MessageType.Log, prefix(prefix, formattedMessage)));
    }
  }

  @Override
  public void onChange(@CheckForNull WorkspaceSettings oldValue, WorkspaceSettings newValue) {
    this.showVerboseLogs = newValue.showVerboseLogs();
  }

  private String prefix(String prefix, String formattedMessage) {
    return "[" + prefix + " - " + LocalTime.now(clock).format(LOG_DATE_FORMAT) + "] " + formattedMessage;
  }

  public void error(String formattedMessage) {
    log("Error", formattedMessage, false);
  }

  public void errorWithStackTrace(String formattedMessage, Throwable t) {
    var sStackTrace = getsStackTrace(t);
    error(formattedMessage + "\n" + sStackTrace);
  }

  private static String getsStackTrace(Throwable t) {
    var sw = new StringWriter();
    var pw = new PrintWriter(sw);
    t.printStackTrace(pw);
    return sw.toString();
  }

  public void warn(String formattedMessage) {
    log("Warn", formattedMessage, false);
  }

  public void warnWithStackTrace(String formattedMessage, Throwable t) {
    var sStackTrace = getsStackTrace(t);
    warn(formattedMessage + "\n" + sStackTrace);
  }

  public void info(String formattedMessage) {
    log("Info", formattedMessage, false);
  }

  public void debug(String formattedMessage) {
    log("Debug", formattedMessage, true);
  }

  public void debugWithStackTrace(String formattedMessage, Throwable t) {
    var sStackTrace = getsStackTrace(t);
    debug(formattedMessage + "\n" + sStackTrace);
  }

  public void trace(String formattedMessage) {
    log("Trace", formattedMessage, true);
  }

}