microsoft / microsoft/BuildXL

FR: Allow for EACCES when enforceSourceReadsUnderPackageRoots is used

Open
#1,345 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
1k
Forks
167
PR merge metrics
No merged PRs in 30d

Description

A common pattern is to have tools walk up the directory hierarchy and collapse parent configurations. Example packages which do this: eslint, cosmiconfig. However, when enforceSourceReadsUnderPackageRoots is used in BuildXL, this is a bit annoying - it requires that the developer find each package's method to stop traversals (eg, root: true in eslint's config).

These tools generally[^1] handle EACCES errors well, and use that as a signal to stop traversals. Could BuildXL add support for preventing read access, rather than failing the build?

This is related to an open feature request in the esbuild project: https://github.com/evanw/esbuild/issues/4036 - this tool doesn't provide any way to stop the directory traversal, and instead relies on EACCES errors being thrown.

[^1]: I have not conducted a thorough audit of the ecosystem; this is just based on my experience and a light skimming of the source code of several packages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the enforceSourceReadsUnderPackageRoots entry point and the existing handling for EACCES in BuildXL. Review how filesystem reads are currently denied and how sandbox failures are reported. Done means eligible parent-directory reads produce EACCES so traversal-based tools can stop without failing the build, with tests covering the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, javascript
Domain
operating-systems, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.