-
-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(workspace-tree): Add BazelQuerier for workspace tree
Separate and abstract the tree view specific bazel queries in prepare for adding test cases. Also pull out the configuration getter since I found it simpler to use (auto complete and check by tsc, and maybe customizing the defaults based on more complicated logic).
- Loading branch information
Showing
8 changed files
with
164 additions
and
38 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
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
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
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 |
|---|---|---|
|
|
@@ -13,3 +13,4 @@ | |
| // limitations under the License. | ||
|
|
||
| export * from "./bazel_workspace_tree_provider"; | ||
| export * from "./querier"; | ||
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,108 @@ | ||
| // Copyright 2024 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. | ||
|
|
||
| import * as vscode from "vscode"; | ||
| import { | ||
| BazelQuery, | ||
| BazelWorkspaceInfo, | ||
| labelFromQueriedToAbsolute, | ||
| } from "../bazel"; | ||
| import { | ||
| getDefaultBazelExecutablePath, | ||
| getDefaultQueryExpression, | ||
| } from "../extension/configuration"; | ||
| import { blaze_query } from "../protos"; | ||
| import { BazelInfo } from "../bazel/bazel_info"; | ||
|
|
||
| /** | ||
| * Bazel querier for workspace tree. | ||
| * | ||
| * The interface defined here is to specifying the operation required for a | ||
| * workspace tree instead of all bazel query syntax and options supported. | ||
| * | ||
| * The function named with queryXxx are all for querying bazel informations. | ||
| */ | ||
| export interface IBazelQuerier { | ||
| /** | ||
| * Queries bazel workspace path by given vscode workspace folder. | ||
| * | ||
| * @param workspaceInfo the Bazel workspace info. | ||
| * @returns package name queries in absolute apparent paths. | ||
| */ | ||
| queryWorkspace( | ||
| workspaceFolder: vscode.WorkspaceFolder, | ||
| ): Thenable<BazelWorkspaceInfo | undefined>; | ||
|
|
||
| /** | ||
| * Queries all Bazel packages in a workspace folder. | ||
| * | ||
| * @param workspaceInfo the Bazel workspace info. | ||
| * @returns package name queries in absolute apparent paths. | ||
| */ | ||
| queryPackages(workspaceInfo: BazelWorkspaceInfo): Thenable<string[]>; | ||
|
|
||
| /** | ||
| * Queries all children targets of a Bazel package. | ||
| * | ||
| * @param workspaceInfo the Bazel workspace info. | ||
| * @param packagePath the Bazel package path. Could be either in absolute label or | ||
| * relative to the opening vscode workspace in `workspaceInfo`. | ||
| */ | ||
| queryChildrenTargets( | ||
| workspaceInfo: BazelWorkspaceInfo, | ||
| packagePath: string, | ||
| ): Thenable<blaze_query.IQueryResult>; | ||
| } | ||
|
|
||
| /** | ||
| * Calling Bazel process for the queries. | ||
| */ | ||
| export class ProcessBazelQuerier implements IBazelQuerier { | ||
| async queryWorkspace( | ||
| workspaceFolder: vscode.WorkspaceFolder, | ||
| ): Promise<BazelWorkspaceInfo | undefined> { | ||
| try { | ||
| const bazelWorkspacePath = await new BazelInfo( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceFolder.uri.fsPath, | ||
| ).getOne("workspace"); | ||
| return new BazelWorkspaceInfo(bazelWorkspacePath, workspaceFolder); | ||
| } catch { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| async queryPackages(workspaceInfo: BazelWorkspaceInfo): Promise<string[]> { | ||
| const packages = await new BazelQuery( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceInfo.workspaceFolder.uri.fsPath, | ||
| ).queryPackages(getDefaultQueryExpression()); | ||
| return packages.map(labelFromQueriedToAbsolute); | ||
| } | ||
|
|
||
| queryChildrenTargets( | ||
| workspaceInfo: BazelWorkspaceInfo, | ||
| packagePath: string, | ||
| ): Promise<blaze_query.IQueryResult> { | ||
| // Getting all rules without files, thus using :all instead of :*. | ||
| const query = `${packagePath}:all`; | ||
| return new BazelQuery( | ||
| getDefaultBazelExecutablePath(), | ||
| workspaceInfo.workspaceFolder.uri.fsPath, | ||
| ).queryTargets(query, { | ||
| ignoresErrors: true, | ||
| sortByRuleName: true, | ||
| }); | ||
| } | ||
| } |