org.sonarsource.sonarlint.ls.progress.ProgressManager 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.progress;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ThreadLocalRandom;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import org.eclipse.lsp4j.WorkDoneProgressCancelParams;
import org.eclipse.lsp4j.WorkDoneProgressCreateParams;
import org.eclipse.lsp4j.jsonrpc.CancelChecker;
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.eclipse.lsp4j.services.LanguageClient;
import org.sonarsource.sonarlint.core.commons.progress.CanceledException;
import org.sonarsource.sonarlint.ls.log.LanguageClientLogOutput;

import static org.sonarsource.sonarlint.ls.util.Utils.interrupted;

public class ProgressManager {
  private final LanguageClient client;
  private final LanguageClientLogOutput globalLogOutput;
  private final Map, LSProgressMonitor> liveProgress = new ConcurrentHashMap<>();

  private boolean workDoneProgressSupportedByClient;

  public ProgressManager(LanguageClient client, LanguageClientLogOutput globalLogOutput) {
    this.client = client;
    this.globalLogOutput = globalLogOutput;
  }

  public void setWorkDoneProgressSupportedByClient(boolean supported) {
    this.workDoneProgressSupportedByClient = supported;
  }

  public void doWithProgress(String progressTitle, @Nullable Either workDoneToken, CancelChecker cancelToken, Consumer runnableWithProgress) {
    if (workDoneToken == null && !workDoneProgressSupportedByClient) {
      runnableWithProgress.accept(new NoOpProgressFacade());
    } else {
      Either progressToken = workDoneToken != null ? workDoneToken : Either.forLeft("SonarLint" + ThreadLocalRandom.current().nextInt());
      if (workDoneToken == null) {
        try {
          client.createProgress(new WorkDoneProgressCreateParams(progressToken)).get();
        } catch (InterruptedException e) {
          interrupted(e, globalLogOutput);
        } catch (ExecutionException e) {
          throw new IllegalStateException(e.getCause());
        }
      }
      var progress = new LSProgressMonitor(client, progressToken, cancelToken);
      liveProgress.put(progressToken, progress);
      progress.start(progressTitle);
      try {
        runnableWithProgress.accept(progress);
      } catch (CanceledException canceled) {
        endIfNotAlreadyEnded(progress, "Canceled");
      } catch (Exception e) {
        endIfNotAlreadyEnded(progress, e.getMessage());
        throw e;
      } finally {
        endIfNotAlreadyEnded(progress, null);
        liveProgress.remove(progressToken);
      }
    }
  }

  private static void endIfNotAlreadyEnded(LSProgressMonitor progress, @Nullable String msg) {
    if (!progress.ended()) {
      progress.end(msg);
    }
  }

  public void cancelProgress(WorkDoneProgressCancelParams params) {
    var progressFacade = liveProgress.get(params.getToken());
    if (progressFacade == null) {
      globalLogOutput.debug("Unable to cancel progress: " + params.getToken());
    } else {
      progressFacade.cancel();
    }
  }

}