org.sonarsource.sonarlint.ls.ScmIgnoredCache 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-2023 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;

import java.net.URI;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import org.sonarsource.sonarlint.core.commons.log.ClientLogOutput;
import org.sonarsource.sonarlint.ls.log.LanguageClientLogOutput;
import org.sonarsource.sonarlint.ls.util.Utils;

import static java.lang.String.format;
import static java.util.Optional.ofNullable;

public class ScmIgnoredCache {
  private final SonarLintExtendedLanguageClient client;
  private final LanguageClientLogOutput logOutput;
  public final Map> filesIgnoredByUri = new ConcurrentHashMap<>();

  public ScmIgnoredCache(SonarLintExtendedLanguageClient client, LanguageClientLogOutput logOutput) {
    this.client = client;
    this.logOutput = logOutput;
  }

  public void didClose(URI fileUri) {
    filesIgnoredByUri.remove(fileUri);
  }

  public Optional isIgnored(URI fileUri) {
    Optional isIgnored;
    try {
      isIgnored = getOrFetchAsync(fileUri).get(1, TimeUnit.MINUTES);
    } catch (InterruptedException e) {
      Utils.interrupted(e, logOutput);
      isIgnored = Optional.empty();
    } catch (Exception e) {
      logOutput.log(format("Unable to get SCM ignore status %s", e), ClientLogOutput.Level.WARN);
      isIgnored = Optional.empty();
    }
    return isIgnored;
  }

  private CompletableFuture> getOrFetchAsync(URI fileUri) {
    if (filesIgnoredByUri.containsKey(fileUri)) {
      return CompletableFuture.completedFuture(filesIgnoredByUri.get(fileUri));
    }
    return client.isIgnoredByScm(fileUri.toString())
      .handle((r, t) -> {
        if (t != null) {
          logOutput.log(format("Unable to check if file %s is SCM ignored %s", fileUri, t), ClientLogOutput.Level.ERROR);
        }
        return r;
      })
      .thenApply(ignored -> {
        var ignoredOpt = ofNullable(ignored);
        filesIgnoredByUri.put(fileUri, ignoredOpt);
        logOutput.log(format("Cached SCM ignore status for file \"%s\": %s", fileUri,
          ignoredOpt.map(b -> Boolean.TRUE.equals(b) ? "Ignored" : "Not ignored").orElse("Unknown")),
          ClientLogOutput.Level.DEBUG);
        return ignoredOpt;
      });
  }

}