Skip to content

Commit

Permalink
Pass main repository mapping into Package
Browse files Browse the repository at this point in the history
  • Loading branch information
fmeum committed Oct 19, 2022
1 parent 09845db commit d93a9b2
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -192,48 +192,34 @@ public String getUnambiguousCanonicalForm() {
* string is as simple as possible while referencing the current package when parsed in the
* context of the main repository.
*
* @param mainOrOtherRepoMapping the {@link RepositoryMapping} of the main repository or, if that
* is not available to the caller, the {@link RepositoryMapping} of
* the current package. The former will yield more readable output.
* @return <ul><li>if the main repository's mapping is provided:</li>
* <dl>
* <dt><code>//some/pkg</code></dt>
* @param mainRepositoryMapping the {@link RepositoryMapping} of the main repository
* @return <dl><dt><code>//some/pkg</code></dt>
* <dd>if this package lives in the main repository</dd>
* <dt><code>@protobuf//some/pkg</code></dt>
* <dd>if this package lives in a repository with "protobuf" as <code>name</code> of a repository
* in WORKSPACE or as local name of a Bzlmod dependency of the main module</dd>
* <dt><code>@@protobuf~3.19.2//some/pkg</code></dt>
* <dd>only with Bzlmod if the current package belongs to a repository that is not visible from
* the main module</dd>
*
* <li>if another repository's mapping is provided:</li>
* <dl>
* <dt><pre>//some/pkg</pre></dt>
* <dd>if this package lives in the main repository</dd>
* <dt><pre>@protobuf//some/pkg</pre></dt>
* <dd>if this package lives in a repository with "protobuf" as <code>name</code> of a repository
* in WORKSPACE</dd>
* <dt><pre>@@protobuf~3.19.2//some/pkg</pre></dt>
* <dd>if this package lives in a repository managed by Bzlmod</dd>
*/
public String getDisplayForm(RepositoryMapping mainOrOtherRepoMapping) {
public String getDisplayForm(RepositoryMapping mainRepositoryMapping) {
Preconditions.checkArgument(
mainRepositoryMapping.ownerRepo() == null || mainRepositoryMapping.ownerRepo().isMain());
if (repository.isMain()) {
// Packages in the main repository can always use repo-relative form.
return "//" + getPackageFragment();
}
if (mainOrOtherRepoMapping.ownerRepo() == null) {
// Not using strict visibility, meaning that canonical and local names can be used
// interchangeably.
if (mainRepositoryMapping.ownerRepo() == null) {
// If the main repository mapping is not using strict visibility, then Bzlmod is certainly
// disabled, which means that canonical and local names can be used interchangeably from the
// context of the main repository.
return repository.getNameWithAt() + "//" + getPackageFragment();
}
// If possible, represent the repository with a non-canonical label using the local name the
// main repository has for it, otherwise fall back to a canonical label.
Optional<String> maybeLocalName = Optional.empty();
if (mainOrOtherRepoMapping.ownerRepo().isMain()) {
maybeLocalName = mainOrOtherRepoMapping.getInverse(repository)
.map(localName -> "@" + localName + "//" + getPackageFragment());
}
return maybeLocalName.orElseGet(this::getUnambiguousCanonicalForm);
return mainRepositoryMapping.getInverse(repository)
.map(localName -> "@" + localName + "//" + getPackageFragment())
.orElseGet(this::getUnambiguousCanonicalForm);
}

/**
Expand Down
23 changes: 19 additions & 4 deletions src/main/java/com/google/devtools/build/lib/packages/Package.java
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,13 @@ public enum ConfigSettingVisibilityPolicy {
*/
private RepositoryMapping repositoryMapping;

/**
* The repository mapping of the main repository. This is only used internally to obtain
* user-friendly apparent names from canonical repository names in error message arising from this
* package.
*/
private RepositoryMapping mainRepositoryMapping;

private Set<Label> defaultCompatibleWith = ImmutableSet.of();
private Set<Label> defaultRestrictedTo = ImmutableSet.of();

Expand Down Expand Up @@ -478,6 +485,7 @@ private void finishInit(Builder builder) {
this.registeredExecutionPlatforms = ImmutableList.copyOf(builder.registeredExecutionPlatforms);
this.registeredToolchains = ImmutableList.copyOf(builder.registeredToolchains);
this.repositoryMapping = Preconditions.checkNotNull(builder.repositoryMapping);
this.mainRepositoryMapping = Preconditions.checkNotNull(builder.mainRepositoryMapping);
ImmutableMap.Builder<RepositoryName, ImmutableMap<String, RepositoryName>>
repositoryMappingsBuilder = ImmutableMap.builder();
if (!builder.externalPackageRepositoryMappings.isEmpty() && !builder.isRepoRulePackage()) {
Expand Down Expand Up @@ -731,9 +739,7 @@ private String getAlternateTargetSuggestion(String targetName) {
String blazeQuerySuggestion =
String.format(
"Tip: use `query %s:*` to see all the targets in that package",
// TODO: Make the resulting package label more readable by passing in the main
// repository's mapping.
packageIdentifier.getDisplayForm(repositoryMapping));
packageIdentifier.getDisplayForm(mainRepositoryMapping));
return String.format(
" (%s)", Joiner.on(" ").skipNulls().join(targetSuggestion, blazeQuerySuggestion));
}
Expand Down Expand Up @@ -882,6 +888,7 @@ public static Builder newExternalPackageBuilder(
LabelConstants.EXTERNAL_PACKAGE_IDENTIFIER,
workspaceName,
starlarkSemantics.getBool(BuildLanguageOptions.INCOMPATIBLE_NO_IMPLICIT_FILE_EXPORT),
mainRepoMapping,
mainRepoMapping)
.setFilename(workspacePath);
}
Expand All @@ -896,6 +903,7 @@ public static Builder newExternalPackageBuilderForBzlmod(
basePackageId,
DUMMY_WORKSPACE_NAME_FOR_BZLMOD_PACKAGES,
starlarkSemantics.getBool(BuildLanguageOptions.INCOMPATIBLE_NO_IMPLICIT_FILE_EXPORT),
repoMapping,
repoMapping)
.setFilename(moduleFilePath);
}
Expand Down Expand Up @@ -976,6 +984,11 @@ public boolean recordLoadedModules() {
* workspace.
*/
private final RepositoryMapping repositoryMapping;
/**
* The repository mapping of the main repository. This is only used to resolve user-friendly
* apparent names from canonical repository names in error message arising from this package.
*/
private final RepositoryMapping mainRepositoryMapping;
/** Converts label literals to Label objects within this package. */
private final LabelConverter labelConverter;

Expand Down Expand Up @@ -1100,10 +1113,12 @@ public T intern(T sample) {
PackageIdentifier id,
String workspaceName,
boolean noImplicitFileExport,
RepositoryMapping repositoryMapping) {
RepositoryMapping repositoryMapping,
RepositoryMapping mainRepositoryMapping) {
this.pkg = new Package(id, workspaceName, packageSettings.succinctTargetNotFoundErrors());
this.noImplicitFileExport = noImplicitFileExport;
this.repositoryMapping = repositoryMapping;
this.mainRepositoryMapping = mainRepositoryMapping;
this.labelConverter = new LabelConverter(id, repositoryMapping);
if (pkg.getName().startsWith("javatests/")) {
setDefaultTestonly(true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -465,13 +465,15 @@ public Package.Builder newPackageBuilder(
PackageIdentifier packageId,
String workspaceName,
StarlarkSemantics starlarkSemantics,
RepositoryMapping repositoryMapping) {
RepositoryMapping repositoryMapping,
RepositoryMapping mainRepositoryMapping) {
return new Package.Builder(
packageSettings,
packageId,
workspaceName,
starlarkSemantics.getBool(BuildLanguageOptions.INCOMPATIBLE_NO_IMPLICIT_FILE_EXPORT),
repositoryMapping);
repositoryMapping,
mainRepositoryMapping);
}

/** Returns a new {@link NonSkyframeGlobber}. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.cmdline.RepositoryMapping;
import com.google.devtools.build.lib.cmdline.RepositoryName;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.ExtendedEventHandler.Postable;
Expand Down Expand Up @@ -1215,6 +1216,9 @@ private LoadedPackage loadPackage(
RepositoryMappingValue repositoryMappingValue =
(RepositoryMappingValue)
env.getValue(RepositoryMappingValue.key(packageId.getRepository()));
RepositoryMappingValue mainRepositoryMappingValue = (RepositoryMappingValue) env.getValue(
RepositoryMappingValue.key(
RepositoryName.MAIN));
RootedPath buildFileRootedPath = packageLookupValue.getRootedPath(packageId);
FileValue buildFileValue = getBuildFileValue(env, buildFileRootedPath);
RuleVisibility defaultVisibility = PrecomputedValue.DEFAULT_VISIBILITY.get(env);
Expand Down Expand Up @@ -1346,7 +1350,8 @@ private LoadedPackage loadPackage(
packageId,
workspaceName,
starlarkBuiltinsValue.starlarkSemantics,
repositoryMapping)
repositoryMapping,
mainRepositoryMappingValue.getRepositoryMapping())
.setFilename(buildFileRootedPath)
.setDefaultVisibility(defaultVisibility)
// "defaultVisibility" comes from the command line.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,24 +97,19 @@ public void testRunfilesDir() throws Exception {

@Test
public void testDisplayFormInMainRepository() throws Exception {
RepositoryName repo = RepositoryName.MAIN;
PathFragment pkgFragment = PathFragment.create("some/pkg");
PackageIdentifier pkg = PackageIdentifier.create(repo, pkgFragment);
PackageIdentifier pkg = PackageIdentifier.create(RepositoryName.MAIN,
PathFragment.create("some/pkg"));

assertThat(pkg.getDisplayForm(RepositoryMapping.ALWAYS_FALLBACK)).isEqualTo("//some/pkg");
assertThat(pkg.getDisplayForm(
RepositoryMapping.create(Map.of("foo", RepositoryName.create("bar")),
RepositoryName.MAIN))).isEqualTo("//some/pkg");
assertThat(pkg.getDisplayForm(
RepositoryMapping.create(Map.of("foo", RepositoryName.create("bar")),
RepositoryName.create("not_main")))).isEqualTo("//some/pkg");
}

@Test
public void testDisplayFormInExternalRepository() throws Exception {
PathFragment pkgFragment = PathFragment.create("some/pkg");
RepositoryName repo = RepositoryName.create("canonical");
PackageIdentifier pkg = PackageIdentifier.create(repo, pkgFragment);
PackageIdentifier pkg = PackageIdentifier.create(repo, PathFragment.create("some/pkg"));

assertThat(pkg.getDisplayForm(RepositoryMapping.ALWAYS_FALLBACK)).isEqualTo(
"@canonical//some/pkg");
Expand All @@ -124,8 +119,5 @@ public void testDisplayFormInExternalRepository() throws Exception {
assertThat(pkg.getDisplayForm(
RepositoryMapping.create(Map.of("local", RepositoryName.create("other_repo")),
RepositoryName.MAIN))).isEqualTo("@@canonical//some/pkg");
assertThat(pkg.getDisplayForm(
RepositoryMapping.create(Map.of("local", repo),
RepositoryName.create("not_main")))).isEqualTo("@@canonical//some/pkg");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ private Package.Builder pkgBuilder(String name) {
PackageIdentifier.createInMainRepo(name),
"workspace",
/*noImplicitFileExport=*/ true,
RepositoryMapping.ALWAYS_FALLBACK,
RepositoryMapping.ALWAYS_FALLBACK);
result.setFilename(
RootedPath.toRootedPath(
Expand Down

0 comments on commit d93a9b2

Please sign in to comment.