feat: add bazel-deps-query config to dynamically resolve additional paths #13
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,121 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // 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 {execSync} from 'child_process'; | ||
| import {Logger} from './logger'; | ||
|
|
||
| /** | ||
| * Parse the output of a bazel query command into a list of local package paths. | ||
| * | ||
| * Bazel query output contains lines like: | ||
| * //path/to/package:target_name | ||
| * @external_dep//path:target | ||
| * | ||
| * This function: | ||
| * 1. Filters out external dependencies (lines starting with `@`) | ||
| * 2. Extracts the package path from local targets (`//path/to/package:target` -> `path/to/package`) | ||
| * 3. Deduplicates paths | ||
| * 4. Optionally excludes a given path (e.g., the package's own path) | ||
| * | ||
| * @param output Raw stdout from a bazel query command | ||
| * @param excludePath Optional path to exclude from results (e.g., the package's own path) | ||
| * @returns Array of unique local package paths | ||
| */ | ||
| export function parseBazelQueryOutput( | ||
| output: string, | ||
| excludePath?: string | ||
| ): string[] { | ||
| const lines = output.split('\n').filter(line => line.trim().length > 0); | ||
|
|
||
| const paths = new Set<string>(); | ||
| for (const line of lines) { | ||
| const trimmed = line.trim(); | ||
|
|
||
| // Skip external dependencies (start with @) | ||
| if (trimmed.startsWith('@')) { | ||
| continue; | ||
| } | ||
|
|
||
| // Match local targets: //path/to/package:target or //path/to/package | ||
| const match = trimmed.match(/^\/\/([^:]*)/); | ||
| if (!match) { | ||
| continue; | ||
| } | ||
|
|
||
| const packagePath = match[1]; | ||
|
|
||
| // Skip empty paths (e.g., //:target refers to the root) | ||
| if (!packagePath) { | ||
| continue; | ||
| } | ||
|
|
||
| // Normalize: remove trailing slashes | ||
| const normalized = packagePath.replace(/\/+$/, ''); | ||
| if (!normalized) { | ||
| continue; | ||
| } | ||
|
|
||
| // Exclude the package's own path if specified | ||
| if (excludePath && normalized === excludePath.replace(/\/+$/, '')) { | ||
| continue; | ||
| } | ||
|
|
||
| paths.add(normalized); | ||
| } | ||
|
|
||
| return Array.from(paths).sort(); | ||
| } | ||
|
|
||
| /** | ||
| * Execute a bazel query command and return the parsed local package paths. | ||
| * | ||
| * @param query The bazel query string to execute (e.g., "bazel query 'deps(//combined-service)'") | ||
| * @param excludePath Optional path to exclude from results | ||
| * @param logger Optional logger instance | ||
| * @returns Array of unique local package paths | ||
| */ | ||
| export function runBazelQuery( | ||
| query: string, | ||
| excludePath?: string, | ||
| logger?: Logger | ||
| ): string[] { | ||
| logger?.info(`Running bazel deps query: ${query}`); | ||
|
|
||
| try { | ||
| const output = execSync(query, { | ||
|
||
| encoding: 'utf-8', | ||
| timeout: 120000, // 2 minute timeout | ||
| stdio: ['pipe', 'pipe', 'pipe'], | ||
| }); | ||
|
|
||
| const paths = parseBazelQueryOutput(output, excludePath); | ||
| logger?.info( | ||
| `Bazel deps query resolved ${ | ||
| paths.length | ||
| } additional paths: ${JSON.stringify(paths)}` | ||
| ); | ||
| return paths; | ||
| } catch (err) { | ||
| const error = err as Error & {stderr?: string}; | ||
| logger?.error( | ||
| `Failed to run bazel deps query "${query}": ${error.message}` | ||
| ); | ||
| if (error.stderr) { | ||
| logger?.error(`stderr: ${error.stderr}`); | ||
| } | ||
| throw new Error( | ||
| `Failed to execute bazel-deps-query "${query}": ${error.message}` | ||
| ); | ||
| } | ||
| } | ||
This file contains hidden or 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,8 @@ | ||
| { | ||
| "release-type": "simple", | ||
| "packages": { | ||
| "apps/my-app": { | ||
| "bazel-deps-query": "bazel query 'deps(//apps/my-app)'" | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There 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.
@devin you should be able to construct the query based on the package name
There 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.
Good call! I'll update it so the query is auto-constructed from the package path. I'll make
bazel-deps-queryaccept either:true(boolean) → auto-constructsbazel query 'deps(//package-path)'So the typical config becomes just:
{ "packages": { "apps/my-app": { "bazel-deps-query": true } } }