internal/modpkgload: Make Package keep its set of files

Loading a package requires reading files and discovering which files are
in that package. The Package type already provides access to a package's
files' directories via the Locations method, but it does not hang on to
the actual files themselves. This is unfortunate as re-reading the files
may cause additional IO and may create race conditions.

Add a files field and Files getter method to Package, and populate with
the files that are included in a Package.

Signed-off-by: Matthew Sackman <[email protected]>
Change-Id: I94c8ae1e6d6b900f989d4408031ef05877ce0b00
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1218034
Unity-Result: CUE porcuepine <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>
Reviewed-by: Roger Peppe <[email protected]>

Author: cuematthew

internal/mod/modpkgload/pkgload.go

@@ -109,8 +109,9 @@ type Package struct {
 	flags atomicLoadPkgFlags
 
 	// Populated by [loader.load].
-	mod          module.Version     // module providing package
-	modRoot      module.SourceLoc   // root location of module
+	mod          module.Version   // module providing package
+	modRoot      module.SourceLoc // root location of module
+	files        []modimports.ModuleFile
 	locs         []module.SourceLoc // location of source code directories
 	err          error              // error loading package
 	imports      []*Package         // packages imported by this one
@@ -133,6 +134,10 @@ func (pkg *Package) Locations() []module.SourceLoc {
 	return pkg.locs
 }
 
+func (pkg *Package) Files() []modimports.ModuleFile {
+	return pkg.files
+}
+
 func (pkg *Package) Error() error {
 	return pkg.err
 }
@@ -295,6 +300,7 @@ func (pkgs *Packages) load(ctx context.Context, pkg *Package) {
 	importsMap := make(map[string]bool)
 	foundPackageFile := false
 	excludedPackageFiles := 0
+	var files []modimports.ModuleFile
 	for _, loc := range pkg.locs {
 		// Layer an iterator whose yield function keeps track of whether we have seen
 		// a single valid CUE file in the package directory.
@@ -311,6 +317,7 @@ func (pkgs *Packages) load(ctx context.Context, pkg *Package) {
 					return true
 				}
 				foundPackageFile = true
+				files = append(files, mf)
 				return yield(mf, err)
 			})
 		}
@@ -331,6 +338,7 @@ func (pkgs *Packages) load(ctx context.Context, pkg *Package) {
 		}
 		return
 	}
+	pkg.files = files
 	// Make the algorithm deterministic for tests.
 	imports := slices.Sorted(maps.Keys(importsMap))
 

internal/mod/modpkgload/pkgload_test.go

@@ -84,6 +84,9 @@ func TestLoadPackages(t *testing.T) {
 						for _, loc := range pkg.Locations() {
 							printf("\tlocation: %v\n", loc.Dir)
 						}
+						for _, file := range pkg.Files() {
+							printf("\tfile: %v: %v\n", file.FilePath, file.Syntax.PackageName())
+						}
 						if imps := pkg.Imports(); len(imps) > 0 {
 							printf("\timports:\n")
 							for _, imp := range imps {

internal/mod/modpkgload/testdata/localpackage.txtar

@@ -9,13 +9,15 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		other.com/blah
 other.com/blah
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: local
 	external: true
 	location: cue.mod/gen/other.com/blah
+	file: cue.mod/gen/other.com/blah/x.cue: blah
 -- main.cue --
 package main
 import "other.com/blah"

internal/mod/modpkgload/testdata/localpackageambiguous.txtar

@@ -17,13 +17,15 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah
 example.com/blah
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: local
 	external: true
 	location: cue.mod/gen/example.com/blah
+	file: cue.mod/gen/example.com/blah/x.cue: blah
 -- test1/initial-requirements --
 main.test@v0
 [email protected]
@@ -36,6 +38,7 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah
 example.com/blah

internal/mod/modpkgload/testdata/localpackagemultipledirs.txtar

@@ -9,6 +9,7 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		other.com/blah
 other.com/blah
@@ -18,6 +19,9 @@ other.com/blah
 	location: cue.mod/gen/other.com/blah
 	location: cue.mod/usr/other.com/blah
 	location: cue.mod/pkg/other.com/blah
+	file: cue.mod/gen/other.com/blah/x.cue: blah
+	file: cue.mod/usr/other.com/blah/x.cue: blah
+	file: cue.mod/pkg/other.com/blah/x.cue: blah
 -- main.cue --
 package main
 import "other.com/blah"

internal/mod/modpkgload/testdata/multidir.txtar

@@ -10,13 +10,16 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: [email protected]
 	external: true
 	location: _registry/example.com_v0.0.1/blah
+	file: _registry/example.com_v0.0.1/blah/blah.cue: blah
+	file: _registry/example.com_v0.0.1/x.cue: blah
 	imports:
 		foo.com/bar/hello/goodbye@v0
 foo.com/bar/hello/goodbye@v0

internal/mod/modpkgload/testdata/nocuefiles.txtar

@@ -10,6 +10,7 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0

internal/mod/modpkgload/testdata/packagegranularity.txtar

@@ -12,6 +12,7 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0
@@ -31,20 +32,23 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: [email protected]
 	external: true
 	location: _registry/example.com_v0.0.1/blah
+	file: _registry/example.com_v0.0.1/blah/blah.cue: blah
 	imports:
 		foo.com/bar/hello/goodbye@v0
 foo.com/bar/hello/goodbye@v0
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: foo.com/[email protected]
 	external: true
 	location: _registry/foo.com_bar_v0.0.1/hello/goodbye
+	file: _registry/foo.com_bar_v0.0.1/hello/goodbye/hello.cue: goodbye
 -- main.cue --
 package main
 import "example.com/blah@v0"

internal/mod/modpkgload/testdata/simple.txtar

@@ -9,6 +9,7 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0
@@ -27,13 +28,15 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah@v0
 example.com/blah@v0
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: [email protected]
 	external: true
 	location: _registry/example.com_v0.0.1/blah
+	file: _registry/example.com_v0.0.1/blah/blah.cue: blah
 	imports:
 		foo.com/bar/hello/goodbye@v0
 foo.com/bar/hello/goodbye@v0

internal/mod/modpkgload/testdata/withdefaultmajorversions.txtar

@@ -11,13 +11,15 @@ main.test@v0:main
 	mod: main.test@v0
 	external: false
 	location: .
+	file: main.cue: main
 	imports:
 		example.com/blah
 example.com/blah
 	flags: inAll,isRoot,fromRoot,importsLoaded
 	mod: [email protected]
 	external: true
 	location: _registry/example.com_v0.0.1/blah
+	file: _registry/example.com_v0.0.1/blah/blah.cue: blah
 	imports:
 		foo.com/bar/hello/goodbye@v0
 foo.com/bar/hello/goodbye@v0