Method ToModule

private/bufpkg/bufmodule/added_module.go:101–274

ToModule converts the addedModule to a Module. If the addedModule is a local Module, this is just returned. If the addedModule is a remote Module, the ModuleDataProvider and CommitProvider are queried to get the Module.

(
	ctx context.Context,
	moduleDataProvider ModuleDataProvider,
	commitProvider CommitProvider,
)

// If the addedModule is a local Module, this is just returned.
// If the addedModule is a remote Module, the ModuleDataProvider and CommitProvider are queried to get the Module.
func (a *addedModule) ToModule(
	ctx context.Context,
	moduleDataProvider ModuleDataProvider,
	commitProvider CommitProvider,
) (Module, error) {
	// If the addedModule is a local Module, just return it.
	if a.localModule != nil {
		return a.localModule, nil
	}
	// Else, get the remote Module.
	getModuleData := sync.OnceValues(
		func() (ModuleData, error) {
			moduleDatas, err := moduleDataProvider.GetModuleDatasForModuleKeys(
				ctx,
				[]ModuleKey{a.remoteModuleKey},
			)
			if err != nil {
				return nil, fmt.Errorf("could not get module data for remote module %q: %w", a.remoteModuleKey.FullName().String(), err)
			}
			if len(moduleDatas) != 1 {
				return nil, syserror.Newf("expected 1 ModuleData, got %d", len(moduleDatas))
			}
			moduleData := moduleDatas[0]
			if moduleData.ModuleKey().FullName() == nil {
				return nil, syserror.New("got nil FullName for a ModuleKey returned from a ModuleDataProvider")
			}
			if a.remoteModuleKey.FullName().String() != moduleData.ModuleKey().FullName().String() {
				return nil, syserror.Newf(
					"mismatched FullName from ModuleDataProvider: input %q, output %q",
					a.remoteModuleKey.FullName().String(),
					moduleData.ModuleKey().FullName().String(),
				)
			}
			return moduleData, nil
		},
	)
	getBucket := sync.OnceValues(
		func() (storage.ReadBucket, error) {
			moduleData, err := getModuleData()
			if err != nil {
				return nil, err
			}
			// ModuleData.Bucket has sync.OnceValues and getStorageMatchers applied since it can
			// only be constructed via NewModuleData.
			//
			// TODO FUTURE: This is a bit shady.
			return moduleData.Bucket()
		},
	)
	getV1BufYAMLObjectData := func() (ObjectData, error) {
		moduleData, err := getModuleData()
		if err != nil {
			return nil, err
		}
		return moduleData.V1Beta1OrV1BufYAMLObjectData()
	}
	getV1BufLockObjectData := func() (ObjectData, error) {
		moduleData, err := getModuleData()