Function newModule

private/bufpkg/bufmodule/module.go:252–335

must set ModuleReadBucket after constructor via setModuleReadBucket

(
	ctx context.Context,
	// This function must already be filtered to include only module files and must be sync.OnceValues wrapped!
	syncOnceValuesGetBucketWithStorageMatcherApplied func() (storage.ReadBucket, error),
	bucketID string,
	description string,
	moduleFullName bufparse.FullName,
	commitID uuid.UUID,
	isTarget bool,
	isLocal bool,
	getV1BufYAMLObjectData func() (ObjectData, error),
	getV1BufLockObjectData func() (ObjectData, error),
	getDepModuleKeysB5 func() ([]ModuleKey, error),
	targetPaths []string,
	targetExcludePaths []string,
	protoFileTargetPath string,
	includePackageFiles bool,
)

// must set ModuleReadBucket after constructor via setModuleReadBucket
func newModule(
	ctx context.Context,
	// This function must already be filtered to include only module files and must be sync.OnceValues wrapped!
	syncOnceValuesGetBucketWithStorageMatcherApplied func() (storage.ReadBucket, error),
	bucketID string,
	description string,
	moduleFullName bufparse.FullName,
	commitID uuid.UUID,
	isTarget bool,
	isLocal bool,
	getV1BufYAMLObjectData func() (ObjectData, error),
	getV1BufLockObjectData func() (ObjectData, error),
	getDepModuleKeysB5 func() ([]ModuleKey, error),
	targetPaths []string,
	targetExcludePaths []string,
	protoFileTargetPath string,
	includePackageFiles bool,
) (*module, error) {
	// TODO FUTURE: get these validations into a common place
	if protoFileTargetPath != "" && (len(targetPaths) > 0 || len(targetExcludePaths) > 0) {
		return nil, syserror.Newf("cannot set both protoFileTargetPath %q and either targetPaths %v or targetExcludePaths %v", protoFileTargetPath, targetPaths, targetExcludePaths)
	}
	if protoFileTargetPath != "" && normalpath.Ext(protoFileTargetPath) != ".proto" {
		return nil, syserror.Newf("protoFileTargetPath %q is not a .proto file", protoFileTargetPath)
	}
	if bucketID == "" && moduleFullName == nil {
		return nil, syserror.New("bucketID was empty and moduleFullName was nil when constructing a Module, one of these must be set")
	}
	if !isLocal && moduleFullName == nil {
		return nil, syserror.New("moduleFullName not present when constructing a remote Module")
	}
	if moduleFullName == nil && commitID != uuid.Nil {
		return nil, syserror.New("moduleFullName not present and commitID present when constructing a remote Module")
	}

	normalizeAndValidateIfNotEmpty := func(path string) (string, error) {
		if path == "" {
			return path, nil
		}
		return normalpath.NormalizeAndValidate(path)
	}
	targetPaths, err := xslices.MapError(targetPaths, normalizeAndValidateIfNotEmpty)
	if err != nil {
		return nil, syserror.Wrap(err)
	}
	targetExcludePaths, err = xslices.MapError(targetExcludePaths, normalizeAndValidateIfNotEmpty)
	if err != nil {
		return nil, syserror.Wrap(err)
	}
	protoFileTargetPath, err = normalizeAndValidateIfNotEmpty(protoFileTargetPath)
	if err != nil {
		return nil, syserror.Wrap(err)
	}

	module := &module{
		ctx:                    ctx,
		getBucket:              syncOnceValuesGetBucketWithStorageMatcherApplied,
		bucketID:               bucketID,