1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
|
package fs
// The Yarn package manager (https://yarnpkg.com/) has a custom installation
// strategy called "Plug'n'Play" where they install packages as zip files
// instead of directory trees, and then modify node to treat zip files like
// directories. This reduces package installation time because Yarn now only
// has to copy a single file per package instead of a whole directory tree.
// However, it introduces overhead at run-time because the virtual file system
// is written in JavaScript.
//
// This file contains esbuild's implementation of the behavior that treats zip
// files like directories. It implements the "FS" interface and wraps an inner
// "FS" interface that treats zip files like files. That way it can run both on
// a real file system and a mock file system.
//
// This file also implements another Yarn-specific behavior where certain paths
// containing the special path segments "__virtual__" or "$$virtual" have some
// unusual behavior. See the code below for details.
import (
"archive/zip"
"io/ioutil"
"strconv"
"strings"
"sync"
"syscall"
)
type zipFS struct {
inner FS
zipFilesMutex sync.Mutex
zipFiles map[string]*zipFile
}
type zipFile struct {
reader *zip.ReadCloser
err error
dirs map[string]*compressedDir
files map[string]*compressedFile
wait sync.WaitGroup
}
type compressedDir struct {
entries map[string]EntryKind
path string
// Compatible entries are decoded lazily
mutex sync.Mutex
dirEntries DirEntries
}
type compressedFile struct {
compressed *zip.File
// The file is decompressed lazily
mutex sync.Mutex
contents string
err error
wasRead bool
}
func (fs *zipFS) checkForZip(path string, kind EntryKind) (*zipFile, string) {
var zipPath string
var pathTail string
// Do a quick check for a ".zip" in the path at all
path = strings.ReplaceAll(path, "\\", "/")
if i := strings.Index(path, ".zip/"); i != -1 {
zipPath = path[:i+len(".zip")]
pathTail = path[i+len(".zip/"):]
} else if kind == DirEntry && strings.HasSuffix(path, ".zip") {
zipPath = path
} else {
return nil, ""
}
// If there is one, then check whether it's a file on the file system or not
fs.zipFilesMutex.Lock()
archive := fs.zipFiles[zipPath]
if archive != nil {
fs.zipFilesMutex.Unlock()
archive.wait.Wait()
} else {
archive = &zipFile{}
archive.wait.Add(1)
fs.zipFiles[zipPath] = archive
fs.zipFilesMutex.Unlock()
defer archive.wait.Done()
// Try reading the zip archive if it's not in the cache
tryToReadZipArchive(zipPath, archive)
}
if archive.err != nil {
return nil, ""
}
return archive, pathTail
}
func tryToReadZipArchive(zipPath string, archive *zipFile) {
reader, err := zip.OpenReader(zipPath)
if err != nil {
archive.err = err
return
}
dirs := make(map[string]*compressedDir)
files := make(map[string]*compressedFile)
seeds := []string{}
// Build an index of all files in the archive
for _, file := range reader.File {
baseName := strings.TrimSuffix(file.Name, "/")
dirPath := ""
if slash := strings.LastIndexByte(baseName, '/'); slash != -1 {
dirPath = baseName[:slash]
baseName = baseName[slash+1:]
}
if file.FileInfo().IsDir() {
// Handle a directory
lowerDir := strings.ToLower(dirPath)
if _, ok := dirs[lowerDir]; !ok {
dir := &compressedDir{
path: dirPath,
entries: make(map[string]EntryKind),
}
// List the same directory both with and without the slash
dirs[lowerDir] = dir
dirs[lowerDir+"/"] = dir
seeds = append(seeds, lowerDir)
}
} else {
// Handle a file
files[strings.ToLower(file.Name)] = &compressedFile{compressed: file}
lowerDir := strings.ToLower(dirPath)
dir, ok := dirs[lowerDir]
if !ok {
dir = &compressedDir{
path: dirPath,
entries: make(map[string]EntryKind),
}
// List the same directory both with and without the slash
dirs[lowerDir] = dir
dirs[lowerDir+"/"] = dir
seeds = append(seeds, lowerDir)
}
dir.entries[baseName] = FileEntry
}
}
// Populate child directories
for _, baseName := range seeds {
for baseName != "" {
dirPath := ""
if slash := strings.LastIndexByte(baseName, '/'); slash != -1 {
dirPath = baseName[:slash]
baseName = baseName[slash+1:]
}
lowerDir := strings.ToLower(dirPath)
dir, ok := dirs[lowerDir]
if !ok {
dir = &compressedDir{
path: dirPath,
entries: make(map[string]EntryKind),
}
// List the same directory both with and without the slash
dirs[lowerDir] = dir
dirs[lowerDir+"/"] = dir
}
dir.entries[baseName] = DirEntry
baseName = dirPath
}
}
archive.dirs = dirs
archive.files = files
archive.reader = reader
}
func (fs *zipFS) ReadDirectory(path string) (entries DirEntries, canonicalError error, originalError error) {
path = mangleYarnPnPVirtualPath(path)
entries, canonicalError, originalError = fs.inner.ReadDirectory(path)
// Only continue if reading this path as a directory caused an error that's
// consistent with trying to read a zip file as a directory. Note that EINVAL
// is produced by the file system in Go's WebAssembly implementation.
if canonicalError != syscall.ENOENT && canonicalError != syscall.ENOTDIR && canonicalError != syscall.EINVAL {
return
}
// If the directory doesn't exist, try reading from an enclosing zip archive
zip, pathTail := fs.checkForZip(path, DirEntry)
if zip == nil {
return
}
// Does the zip archive have this directory?
dir, ok := zip.dirs[strings.ToLower(pathTail)]
if !ok {
return DirEntries{}, syscall.ENOENT, syscall.ENOENT
}
// Check whether it has already been converted
dir.mutex.Lock()
defer dir.mutex.Unlock()
if dir.dirEntries.data != nil {
return dir.dirEntries, nil, nil
}
// Otherwise, fill in the entries
dir.dirEntries = DirEntries{dir: path, data: make(map[string]*Entry, len(dir.entries))}
for name, kind := range dir.entries {
dir.dirEntries.data[strings.ToLower(name)] = &Entry{
dir: path,
base: name,
kind: kind,
}
}
return dir.dirEntries, nil, nil
}
func (fs *zipFS) ReadFile(path string) (contents string, canonicalError error, originalError error) {
path = mangleYarnPnPVirtualPath(path)
contents, canonicalError, originalError = fs.inner.ReadFile(path)
if canonicalError != syscall.ENOENT {
return
}
// If the file doesn't exist, try reading from an enclosing zip archive
zip, pathTail := fs.checkForZip(path, FileEntry)
if zip == nil {
return
}
// Does the zip archive have this file?
file, ok := zip.files[strings.ToLower(pathTail)]
if !ok {
return "", syscall.ENOENT, syscall.ENOENT
}
// Check whether it has already been read
file.mutex.Lock()
defer file.mutex.Unlock()
if file.wasRead {
return file.contents, file.err, file.err
}
file.wasRead = true
// If not, try to open it
reader, err := file.compressed.Open()
if err != nil {
file.err = err
return "", err, err
}
defer reader.Close()
// Then try to read it
bytes, err := ioutil.ReadAll(reader)
if err != nil {
file.err = err
return "", err, err
}
file.contents = string(bytes)
return file.contents, nil, nil
}
func (fs *zipFS) OpenFile(path string) (result OpenedFile, canonicalError error, originalError error) {
path = mangleYarnPnPVirtualPath(path)
result, canonicalError, originalError = fs.inner.OpenFile(path)
return
}
func (fs *zipFS) ModKey(path string) (modKey ModKey, err error) {
path = mangleYarnPnPVirtualPath(path)
modKey, err = fs.inner.ModKey(path)
return
}
func (fs *zipFS) IsAbs(path string) bool {
return fs.inner.IsAbs(path)
}
func (fs *zipFS) Abs(path string) (string, bool) {
return fs.inner.Abs(path)
}
func (fs *zipFS) Dir(path string) string {
if prefix, suffix, ok := ParseYarnPnPVirtualPath(path); ok && suffix == "" {
return prefix
}
return fs.inner.Dir(path)
}
func (fs *zipFS) Base(path string) string {
return fs.inner.Base(path)
}
func (fs *zipFS) Ext(path string) string {
return fs.inner.Ext(path)
}
func (fs *zipFS) Join(parts ...string) string {
return fs.inner.Join(parts...)
}
func (fs *zipFS) Cwd() string {
return fs.inner.Cwd()
}
func (fs *zipFS) Rel(base string, target string) (string, bool) {
return fs.inner.Rel(base, target)
}
func (fs *zipFS) EvalSymlinks(path string) (string, bool) {
return fs.inner.EvalSymlinks(path)
}
func (fs *zipFS) kind(dir string, base string) (symlink string, kind EntryKind) {
return fs.inner.kind(dir, base)
}
func (fs *zipFS) WatchData() WatchData {
return fs.inner.WatchData()
}
func ParseYarnPnPVirtualPath(path string) (string, string, bool) {
i := 0
for {
start := i
slash := strings.IndexAny(path[i:], "/\\")
if slash == -1 {
break
}
i += slash + 1
// Replace the segments "__virtual__/<segment>/<n>" with N times the ".."
// operation. Note: The "__virtual__" folder name appeared with Yarn 3.0.
// Earlier releases used "$$virtual", but it was changed after discovering
// that this pattern triggered bugs in software where paths were used as
// either regexps or replacement. For example, "$$" found in the second
// parameter of "String.prototype.replace" silently turned into "$".
if segment := path[start : i-1]; segment == "__virtual__" || segment == "$$virtual" {
if slash := strings.IndexAny(path[i:], "/\\"); slash != -1 {
var count string
var suffix string
j := i + slash + 1
// Find the range of the count
if slash := strings.IndexAny(path[j:], "/\\"); slash != -1 {
count = path[j : j+slash]
suffix = path[j+slash:]
} else {
count = path[j:]
}
// Parse the count
if n, err := strconv.ParseInt(count, 10, 64); err == nil {
prefix := path[:start]
// Apply N times the ".." operator
for n > 0 && (strings.HasSuffix(prefix, "/") || strings.HasSuffix(prefix, "\\")) {
slash := strings.LastIndexAny(prefix[:len(prefix)-1], "/\\")
if slash == -1 {
break
}
prefix = prefix[:slash+1]
n--
}
// Make sure the prefix and suffix work well when joined together
if suffix == "" && strings.IndexAny(prefix, "/\\") != strings.LastIndexAny(prefix, "/\\") {
prefix = prefix[:len(prefix)-1]
} else if prefix == "" {
prefix = "."
} else if strings.HasPrefix(suffix, "/") || strings.HasPrefix(suffix, "\\") {
suffix = suffix[1:]
}
return prefix, suffix, true
}
}
}
}
return "", "", false
}
func mangleYarnPnPVirtualPath(path string) string {
if prefix, suffix, ok := ParseYarnPnPVirtualPath(path); ok {
return prefix + suffix
}
return path
}
|