-
Notifications
You must be signed in to change notification settings - Fork 302
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Currently, BlazeInfo will be computed 5 times during incremental sync, this commit introduces logic to cache it and re-use the computed value during incremental syncs. `BlazeInfoProvider` was introduced in order to avoid changing `BlazeInfoRunner` and keep its responsibility to solely execute the info command. Logic is guarded by `blaze.info.provider.enabled` which is disabled by default.
- Loading branch information
Showing
4 changed files
with
172 additions
and
10 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
136 changes: 136 additions & 0 deletions
136
base/src/com/google/idea/blaze/base/command/info/BlazeInfoProvider.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,136 @@ | ||
| /* | ||
| * Copyright 2023 The Bazel Authors. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.google.idea.blaze.base.command.info; | ||
|
|
||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.common.util.concurrent.Futures; | ||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import com.google.idea.blaze.base.async.executor.BlazeExecutor; | ||
| import com.google.idea.blaze.base.bazel.BuildSystem; | ||
| import com.google.idea.blaze.base.scope.BlazeContext; | ||
| import com.google.idea.blaze.base.settings.Blaze; | ||
| import com.google.idea.blaze.base.settings.BlazeImportSettings; | ||
| import com.google.idea.blaze.base.settings.BlazeImportSettingsManager; | ||
| import com.google.idea.blaze.base.sync.SyncListener; | ||
| import com.google.idea.blaze.base.sync.SyncMode; | ||
| import com.google.idea.blaze.base.sync.SyncResult; | ||
| import com.google.idea.common.experiments.BoolExperiment; | ||
| import com.intellij.openapi.diagnostic.Logger; | ||
| import com.intellij.openapi.project.Project; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| import java.util.List; | ||
| import java.util.concurrent.ExecutionException; | ||
|
|
||
| /** | ||
| * <p> Providing a {@link com.google.idea.blaze.base.command.info.BlazeInfo}, the result will be cached and invalidated on any sync failure. </p> | ||
| * | ||
| * @see BlazeInfoRunner | ||
| */ | ||
| public class BlazeInfoProvider { | ||
| private static final Logger logger = Logger.getInstance(BlazeInfoProvider.class); | ||
| private static final BoolExperiment enabled = | ||
| new BoolExperiment("blaze.info.provider.enabled", false); | ||
|
|
||
| private final Project project; | ||
| private volatile BlazeInfo blazeInfo; | ||
|
|
||
| public BlazeInfoProvider(Project project) { | ||
| this.project = project; | ||
| } | ||
|
|
||
| public static BlazeInfoProvider getInstance(Project project) { | ||
| return project.getService(BlazeInfoProvider.class); | ||
| } | ||
|
|
||
| public static Boolean isEnabled() { | ||
| return enabled.getValue(); | ||
| } | ||
|
|
||
| public ListenableFuture<String> getBlazeInfo( | ||
| BlazeContext context, | ||
| List<String> blazeFlags, | ||
| String key) { | ||
| ListenableFuture<BlazeInfo> future = getBlazeInfo(context, | ||
| blazeFlags); | ||
| return Futures.transform(future, | ||
| info -> info.get(key), | ||
| BlazeExecutor.getInstance().getExecutor() | ||
| ); | ||
| } | ||
|
|
||
| public ListenableFuture<BlazeInfo> getBlazeInfo( | ||
| BlazeContext context, | ||
| List<String> blazeFlags) { | ||
| return BlazeExecutor.getInstance().submit(() -> { | ||
| BlazeInfo info = getCachedBlazeInfo(context, | ||
| blazeFlags); | ||
| if (info == null) { | ||
| throw new BlazeInfoException("Unable to get blaze info"); | ||
| } | ||
| return info; | ||
| }); | ||
| } | ||
|
|
||
| private @Nullable BlazeInfo getCachedBlazeInfo( | ||
| BlazeContext context, | ||
| List<String> blazeFlags) { | ||
| if (blazeInfo != null) { | ||
| logger.debug("Returning cached BlazeInfo"); | ||
| return blazeInfo; | ||
| } | ||
| try { | ||
| BlazeImportSettings importSettings = BlazeImportSettingsManager.getInstance(project).getImportSettings(); | ||
| if (importSettings == null) { | ||
| return null; | ||
| } | ||
| BuildSystem.BuildInvoker buildInvoker = Blaze.getBuildSystemProvider(project) | ||
| .getBuildSystem() | ||
| .getDefaultInvoker(project, context); | ||
| logger.debug("Running bazel info"); | ||
| blazeInfo = BlazeInfoRunner.getInstance().runBlazeInfo( | ||
| project, | ||
| buildInvoker, | ||
| BlazeContext.create(), | ||
| importSettings.getBuildSystem(), | ||
| blazeFlags | ||
| ).get(); | ||
| return blazeInfo; | ||
| } catch (InterruptedException | ExecutionException e) { | ||
| logger.warn("Unable to run blaze info", e); | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| public void invalidate() { | ||
| logger.debug("invalidating"); | ||
| blazeInfo = null; | ||
| } | ||
|
|
||
| public static final class Invalidator implements SyncListener { | ||
| @Override | ||
| public void afterSync( | ||
| Project project, | ||
| BlazeContext context, | ||
| SyncMode syncMode, | ||
| SyncResult syncResult, | ||
| ImmutableSet<Integer> buildIds) { | ||
| if(!syncResult.successful()) { | ||
| BlazeInfoProvider.getInstance(project).invalidate(); | ||
| } | ||
| } | ||
| } | ||
| } |
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
3598ec6There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of open questions:
BlazeInfocache? maybe on.bazelversionWORKSPACEfile changes?SyncCacheand compute BlazeInfo once per sync?