-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
In order to be able to re-use the logic of the "Open in IDE" feature for "Open fix suggestion" a small refactoring was required.
- Loading branch information
Showing
5 changed files
with
307 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
216 changes: 216 additions & 0 deletions
216
...arlint.eclipse.ui/src/org/sonarlint/eclipse/ui/internal/job/AbstractOpenInEclipseJob.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| /* | ||
| * SonarLint for Eclipse | ||
| * Copyright (C) 2015-2024 SonarSource SA | ||
| * sonarlint@sonarsource.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.sonarlint.eclipse.ui.internal.job; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import org.eclipse.core.runtime.CoreException; | ||
| import org.eclipse.core.runtime.IProgressMonitor; | ||
| import org.eclipse.core.runtime.IStatus; | ||
| import org.eclipse.core.runtime.Status; | ||
| import org.eclipse.core.runtime.jobs.Job; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.swt.widgets.Display; | ||
| import org.eclipse.ui.PlatformUI; | ||
| import org.sonarlint.eclipse.core.SonarLintLogger; | ||
| import org.sonarlint.eclipse.core.documentation.SonarLintDocumentation; | ||
| import org.sonarlint.eclipse.core.internal.backend.ConfigScopeSynchronizer; | ||
| import org.sonarlint.eclipse.core.internal.backend.SonarLintBackendService; | ||
| import org.sonarlint.eclipse.core.internal.jobs.AnalysisReadyStatusCache; | ||
| import org.sonarlint.eclipse.core.internal.vcs.VcsService; | ||
| import org.sonarlint.eclipse.core.resource.ISonarLintFile; | ||
| import org.sonarlint.eclipse.core.resource.ISonarLintProject; | ||
| import org.sonarlint.eclipse.ui.internal.SonarLintUiPlugin; | ||
| import org.sonarlint.eclipse.ui.internal.dialog.AwaitProjectConnectionReadyDialog; | ||
| import org.sonarlint.eclipse.ui.internal.util.BrowserUtils; | ||
| import org.sonarlint.eclipse.ui.internal.util.MessageDialogUtils; | ||
|
|
||
| /** | ||
| * Every feature that opens something in the Eclipse IDE (e.g. issues, fix suggestions, ...) does it via a background | ||
| * job and this is its base class with shared logic. As much as possible should be shared, but the branch check is not | ||
| * necessary for every project anymore! | ||
| */ | ||
| public abstract class AbstractOpenInEclipseJob extends Job { | ||
| @Nullable | ||
| protected ISonarLintFile file; | ||
|
|
||
| protected final ISonarLintProject project; | ||
| private final boolean skipBranchCheck; | ||
|
|
||
| protected AbstractOpenInEclipseJob(String name, ISonarLintProject project, boolean skipBranchCheck) { | ||
| super(name); | ||
|
|
||
| this.project = project; | ||
| this.skipBranchCheck = skipBranchCheck; | ||
| } | ||
|
|
||
| @Override | ||
| protected IStatus run(IProgressMonitor monitor) { | ||
| // 1) We have to await the analysis getting ready for this project. When also setting up the connection / binding | ||
| // with this Open in IDE request it isn't the case. We want to display a nice dialog informing the user that they | ||
| // have to wait for a few more moments. | ||
| if (!AnalysisReadyStatusCache.getAnalysisReadiness(ConfigScopeSynchronizer.getConfigScopeId(project))) { | ||
| // Show the console so the user will see the progress! | ||
| SonarLintUiPlugin.getDefault().getSonarConsole().bringConsoleToFront(); | ||
|
|
||
| // We have to run the dialog in the UI thread, therefore we have to work with references here and synchronized | ||
| // threads for the job to proceed correctly later. | ||
| var statusRef = new AtomicReference<IStatus>(); | ||
| var cancelledByJob = new AtomicBoolean(); | ||
| statusRef.set(Status.OK_STATUS); | ||
| cancelledByJob.set(false); | ||
| Display.getDefault().syncExec(() -> { | ||
| var dialog = new AwaitProjectConnectionReadyDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()); | ||
| new AwaitProjectConnectionReadyJob(project, dialog, 0) | ||
| .schedule(AwaitProjectConnectionReadyJob.SCHEDULE_TIMER_MS); | ||
| dialog.open(); | ||
| if (dialog.cancelledByJob() || dialog.cancelledByUser()) { | ||
| SonarLintLogger.get().debug("Requested action after setting up Connected Mode cancelled by " | ||
| + (dialog.cancelledByUser() ? "the user." : "timeout of the background job.")); | ||
| statusRef.set(Status.CANCEL_STATUS); | ||
| } | ||
| cancelledByJob.set(dialog.cancelledByJob()); | ||
| }); | ||
|
|
||
| // We only want to show a new dialog when the connection was not yet ready in time and not when the user manually | ||
| // cancelled it (e.g. because their priority changed, it took too long for them or whatever) | ||
| var status = statusRef.get(); | ||
| if (Status.CANCEL_STATUS == status) { | ||
| if (cancelledByJob.get()) { | ||
| MessageDialogUtils.openInIdeError("The previous dialog was closed either manually by you or the connection was not ready in " | ||
| + "time. The reason for the latter could be a slow network connection."); | ||
| } | ||
| return status; | ||
| } | ||
| } | ||
|
|
||
| // 2) Check if matching between remote and local path does work / branches match | ||
| // INFO: When we re-run this job we don't have to do all the checks again! | ||
| if (file == null) { | ||
| var fileOpt = tryGetLocalFile(); | ||
| if (fileOpt.isEmpty()) { | ||
| return Status.CANCEL_STATUS; | ||
| } | ||
| file = fileOpt.get(); | ||
|
|
||
| /** | ||
| * Due to the Git logic moving slowly to SLCORE to be IDE-independant, this check might already been done on | ||
| * their side based on the feature using this logic. On the long run this is going to be removed as the branch | ||
| * check will be done completely on SLCORE side for every feature. | ||
| */ | ||
| if (!skipBranchCheck && !tryMatchBranches()) { | ||
| return Status.CANCEL_STATUS; | ||
| } | ||
| } | ||
|
|
||
| try { | ||
| // 3) Based on the implementation, actually run it and handle its failure accordingly | ||
| actualRun(); | ||
| } catch (CoreException e) { | ||
| var message = "An error occured while trying to run the requested action."; | ||
| MessageDialogUtils.openInIdeError(message + " Please see the console for the full error log!"); | ||
| SonarLintLogger.get().error(message, e); | ||
| } | ||
|
|
||
| return Status.CANCEL_STATUS; | ||
| } | ||
|
|
||
| /** | ||
| * File check: We try to convert the server path to IDE path in order to find the correct file | ||
| * | ||
| * This is implementation-specific as third-parties can implement "ISonarLintProject" it for their own plug-in, e.g. | ||
| * for COBOL-IDEs where the local file is not really in the FS! Just FYI as this is a well-known point to break on | ||
| * all the >> Open in Eclipse IDE << feature -.- | ||
| */ | ||
| private Optional<ISonarLintFile> tryGetLocalFile() { | ||
| // Check if file exists in project based on the server to IDE path matching | ||
| var fileOpt = project.find(getIdeFilePath()); | ||
| if (fileOpt.isEmpty()) { | ||
| MessageDialogUtils.openInIdeError("The required file cannot be found in the project '" | ||
| + project.getName() + "'. Maybe it was already changed locally!"); | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| return fileOpt; | ||
| } | ||
|
|
||
| /** | ||
| * Branch check: Local and remote information should match (if no local branch found, at least try your best). | ||
| * | ||
| * As mentioned above, this might not be needed by every feature building on-top of this class and will eventually | ||
| * be removed. That is also the reason for the constructor flag! | ||
| */ | ||
| private boolean tryMatchBranches() { | ||
| var branch = getBranch(); | ||
| if (branch == null) { | ||
| return false; | ||
| } | ||
|
|
||
| // In case SLCORE is not yet ready for the SonarProjectBranchService, we also check the "legacy" and Eclipse- | ||
| // specific integration with EGit. If no EGit is installed, this will of course will not work, but as it is only | ||
| // used in case of the Open in IDE with automatic Connected Mode setup. | ||
| Optional<String> localBranch = Optional.empty(); | ||
| try { | ||
| var response = SonarLintBackendService.get().getMatchedSonarProjectBranch(project); | ||
| localBranch = Optional.ofNullable(response.getMatchedSonarProjectBranch()); | ||
| } catch (InterruptedException | ExecutionException err) { | ||
| SonarLintLogger.get().debug("Cannot get matched branch from backend, trying local VCS service", err); | ||
| } | ||
| if (localBranch.isEmpty()) { | ||
| localBranch = VcsService.getCachedSonarProjectBranch(project); | ||
| } | ||
|
|
||
| if (localBranch.isEmpty()) { | ||
| // This error message may be misleading to COBOL / ABAP developers but that is okay for now :> | ||
| MessageDialogUtils.openInIdeInformation("The local branch of the project '" + project.getName() | ||
| + "' could not be determined. SonarLint now can only try to find the matching local issue!"); | ||
| } else if (!branch.equals(localBranch.get())) { | ||
| MessageDialogUtils.openInIdeError("The local branch '" + localBranch.get() + "' of the project '" | ||
| + project.getName() + "' does not match the remote branch '" + branch + "'. " | ||
| + "Please checkout the correct branch and invoke the requested action once again!"); | ||
| BrowserUtils.openExternalBrowser(SonarLintDocumentation.BRANCH_AWARENESS, Display.getDefault()); | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * The actual feature specific logic after everything is set up accordingly and the base checks are done. | ||
| * | ||
| * Contract applies that "file" (ISonarLintFile) is not set to "null" when this method is invoked! So no check for | ||
| * "null" is necessary anymore in here! | ||
| */ | ||
| abstract IStatus actualRun() throws CoreException; | ||
|
|
||
| /** As we work per "ISonarLintFile" we want to get the IDE (project relative) path from a file on the server */ | ||
| abstract String getIdeFilePath(); | ||
|
|
||
| /** | ||
| * This is needed to get the branch from the specific feature information, shouldn't be overwritten by sub-classes | ||
| * that have "skipBranchCheck" set to "true"! | ||
| */ | ||
| @Nullable | ||
| protected String getBranch() { | ||
| return null; | ||
| } | ||
| } |
55 changes: 55 additions & 0 deletions
55
...t.eclipse.ui/src/org/sonarlint/eclipse/ui/internal/job/OpenFixSuggestionInEclipseJob.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * SonarLint for Eclipse | ||
| * Copyright (C) 2015-2024 SonarSource SA | ||
| * sonarlint@sonarsource.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.sonarlint.eclipse.ui.internal.job; | ||
|
|
||
| import org.eclipse.core.runtime.CoreException; | ||
| import org.eclipse.core.runtime.IStatus; | ||
| import org.eclipse.core.runtime.Status; | ||
| import org.sonarlint.eclipse.core.SonarLintLogger; | ||
| import org.sonarlint.eclipse.core.resource.ISonarLintProject; | ||
| import org.sonarsource.sonarlint.core.rpc.protocol.client.fix.FixSuggestionDto; | ||
|
|
||
| /** | ||
| * "Open fix suggestion": For a specific file there are "one-to-many" suggestions coming to be displayed to the user | ||
| * one after another. The behavior before the actual logic is similar to the one implemented | ||
| * for the "Open in IDE" feature. | ||
| */ | ||
| public class OpenFixSuggestionInEclipseJob extends AbstractOpenInEclipseJob { | ||
| private final FixSuggestionDto fixSuggestion; | ||
|
|
||
| public OpenFixSuggestionInEclipseJob(FixSuggestionDto fixSuggestion, ISonarLintProject project) { | ||
| super("Open fix suggestion in IDE", project, true); | ||
|
|
||
| this.fixSuggestion = fixSuggestion; | ||
| } | ||
|
|
||
| @Override | ||
| IStatus actualRun() throws CoreException { | ||
| // To be implemented later as this is currently only the skeleton! | ||
| SonarLintLogger.get().info("Open fix suggestion: " + fixSuggestion.suggestionId()); | ||
|
|
||
| return Status.OK_STATUS; | ||
| } | ||
|
|
||
| @Override | ||
| String getIdeFilePath() { | ||
| return fixSuggestion.fileEdit().idePath().toString(); | ||
| } | ||
| } |
Oops, something went wrong.