-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[7.2.0] Add a new
include() directive to MODULE.bazel files (#22204)
This new directive allows the root module to divide its `MODULE.bazel` into multiple segments. This directive can only be used by root modules; only files in the main repo may be included; variable bindings are only visible in the file they occur in, not in any included or including files. See the docs for `include()` (in `ModuleFileGlobals.java`) for more details. RELNOTES: Added a new `include()` directive to `MODULE.bazel` files, which allows the root module file to be divided into multiple segments. PiperOrigin-RevId: 627034184 Change-Id: Ifc2f616cf0791445daeeac9ca5ec4478e83382aa
- Loading branch information
Showing
13 changed files
with
967 additions
and
98 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
170 changes: 170 additions & 0 deletions
170
src/main/java/com/google/devtools/build/lib/bazel/bzlmod/CompiledModuleFile.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,170 @@ | ||
| // 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. | ||
| // | ||
| package com.google.devtools.build.lib.bazel.bzlmod; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.devtools.build.lib.events.Event; | ||
| import com.google.devtools.build.lib.events.ExtendedEventHandler; | ||
| import com.google.devtools.build.lib.packages.BazelStarlarkEnvironment; | ||
| import com.google.devtools.build.lib.packages.DotBazelFileSyntaxChecker; | ||
| import com.google.devtools.build.lib.server.FailureDetails.ExternalDeps.Code; | ||
| import net.starlark.java.eval.EvalException; | ||
| import net.starlark.java.eval.Module; | ||
| import net.starlark.java.eval.Starlark; | ||
| import net.starlark.java.eval.StarlarkSemantics; | ||
| import net.starlark.java.eval.StarlarkThread; | ||
| import net.starlark.java.syntax.Argument; | ||
| import net.starlark.java.syntax.AssignmentStatement; | ||
| import net.starlark.java.syntax.CallExpression; | ||
| import net.starlark.java.syntax.DotExpression; | ||
| import net.starlark.java.syntax.ExpressionStatement; | ||
| import net.starlark.java.syntax.Identifier; | ||
| import net.starlark.java.syntax.Location; | ||
| import net.starlark.java.syntax.ParserInput; | ||
| import net.starlark.java.syntax.Program; | ||
| import net.starlark.java.syntax.StarlarkFile; | ||
| import net.starlark.java.syntax.StringLiteral; | ||
| import net.starlark.java.syntax.SyntaxError; | ||
|
|
||
| /** | ||
| * Represents a compiled MODULE.bazel file, ready to be executed on a {@link StarlarkThread}. It's | ||
| * been successfully checked for syntax errors. | ||
| * | ||
| * <p>Use the {@link #parseAndCompile} factory method instead of directly instantiating this record. | ||
| */ | ||
| public record CompiledModuleFile( | ||
| ModuleFile moduleFile, | ||
| Program program, | ||
| Module predeclaredEnv, | ||
| ImmutableList<IncludeStatement> includeStatements) { | ||
| public static final String INCLUDE_IDENTIFIER = "include"; | ||
|
|
||
| record IncludeStatement(String includeLabel, Location location) {} | ||
|
|
||
| /** Parses and compiles a given module file, checking it for syntax errors. */ | ||
| public static CompiledModuleFile parseAndCompile( | ||
| ModuleFile moduleFile, | ||
| ModuleKey moduleKey, | ||
| StarlarkSemantics starlarkSemantics, | ||
| BazelStarlarkEnvironment starlarkEnv, | ||
| ExtendedEventHandler eventHandler) | ||
| throws ExternalDepsException { | ||
| StarlarkFile starlarkFile = | ||
| StarlarkFile.parse(ParserInput.fromUTF8(moduleFile.getContent(), moduleFile.getLocation())); | ||
| if (!starlarkFile.ok()) { | ||
| Event.replayEventsOn(eventHandler, starlarkFile.errors()); | ||
| throw ExternalDepsException.withMessage( | ||
| Code.BAD_MODULE, "error parsing MODULE.bazel file for %s", moduleKey); | ||
| } | ||
| try { | ||
| ImmutableList<IncludeStatement> includeStatements = checkModuleFileSyntax(starlarkFile); | ||
| Module predeclaredEnv = | ||
| Module.withPredeclared(starlarkSemantics, starlarkEnv.getModuleBazelEnv()); | ||
| Program program = Program.compileFile(starlarkFile, predeclaredEnv); | ||
| return new CompiledModuleFile(moduleFile, program, predeclaredEnv, includeStatements); | ||
| } catch (SyntaxError.Exception e) { | ||
| Event.replayEventsOn(eventHandler, e.errors()); | ||
| throw ExternalDepsException.withMessage( | ||
| Code.BAD_MODULE, "syntax error in MODULE.bazel file for %s", moduleKey); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Checks the given `starlarkFile` for module file syntax, and returns the list of `include` | ||
| * statements it contains. This is a somewhat crude sweep over the AST; we loudly complain about | ||
| * any usage of `include` that is not in a top-level function call statement with one single | ||
| * string literal positional argument, *except* that we don't do this check once `include` is | ||
| * assigned to, due to backwards compatibility concerns. | ||
| */ | ||
| @VisibleForTesting | ||
| static ImmutableList<IncludeStatement> checkModuleFileSyntax(StarlarkFile starlarkFile) | ||
| throws SyntaxError.Exception { | ||
| var includeStatements = ImmutableList.<IncludeStatement>builder(); | ||
| new DotBazelFileSyntaxChecker("MODULE.bazel files", /* canLoadBzl= */ false) { | ||
| // Once `include` the identifier is assigned to, we no longer care about its appearance | ||
| // anywhere. This allows `include` to be used as a module extension proxy (and technically | ||
| // any other variable binding). | ||
| private boolean includeWasAssigned = false; | ||
|
|
||
| @Override | ||
| public void visit(ExpressionStatement node) { | ||
| // We can assume this statement isn't nested in any block, since we don't allow | ||
| // `if`/`def`/`for` in MODULE.bazel. | ||
| if (!includeWasAssigned | ||
| && node.getExpression() instanceof CallExpression call | ||
| && call.getFunction() instanceof Identifier id | ||
| && id.getName().equals(INCLUDE_IDENTIFIER)) { | ||
| // Found a top-level call to `include`! | ||
| if (call.getArguments().size() == 1 | ||
| && call.getArguments().getFirst() instanceof Argument.Positional pos | ||
| && pos.getValue() instanceof StringLiteral str) { | ||
| includeStatements.add(new IncludeStatement(str.getValue(), call.getStartLocation())); | ||
| // Nothing else to check, we can stop visiting sub-nodes now. | ||
| return; | ||
| } | ||
| error( | ||
| node.getStartLocation(), | ||
| "the `include` directive MUST be called with exactly one positional argument that " | ||
| + "is a string literal"); | ||
| return; | ||
| } | ||
| super.visit(node); | ||
| } | ||
|
|
||
| @Override | ||
| public void visit(AssignmentStatement node) { | ||
| visit(node.getRHS()); | ||
| if (!includeWasAssigned | ||
| && node.getLHS() instanceof Identifier id | ||
| && id.getName().equals(INCLUDE_IDENTIFIER)) { | ||
| includeWasAssigned = true; | ||
| // Technically someone could do something like | ||
| // (include, myvar) = (print, 3) | ||
| // and work around our check, but at that point IDGAF. | ||
| } else { | ||
| visit(node.getLHS()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void visit(DotExpression node) { | ||
| visit(node.getObject()); | ||
| if (!node.getField().getName().equals(INCLUDE_IDENTIFIER)) { | ||
| // This is fine: `whatever.include` | ||
| // (so `include` can be used as a tag class name) | ||
| visit(node.getField()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void visit(Identifier node) { | ||
| if (!includeWasAssigned && node.getName().equals(INCLUDE_IDENTIFIER)) { | ||
| // If we somehow reach the `include` identifier but NOT as the other allowed cases above, | ||
| // cry foul. | ||
| error( | ||
| node.getStartLocation(), | ||
| "the `include` directive MUST be called directly at the top-level"); | ||
| } | ||
| super.visit(node); | ||
| } | ||
| }.check(starlarkFile); | ||
| return includeStatements.build(); | ||
| } | ||
|
|
||
| public void runOnThread(StarlarkThread thread) throws EvalException, InterruptedException { | ||
| Starlark.execFileProgram(program, predeclaredEnv, thread); | ||
| } | ||
| } |
Oops, something went wrong.