packages

Documentation

Overview

Package packages contains utilities and manager to sync Viam packages defined in the RDK config from the Viam app to the local robot.

Index

• Constants
• Variables
• type Manager
• type ManagerSyncer
  • func NewCloudManager(client pb.PackageServiceClient, packagesDir string, logger golog.Logger) (ManagerSyncer, error)
  • func NewNoopManager() ManagerSyncer
• type PackageID
• type PackageName
• type PackagePathVisitor
  • func NewPackagePathVisitor(packageManager Manager, packagePaths map[string]string) *PackagePathVisitor
  • func (v *PackagePathVisitor) Visit(data interface{}) (interface{}, error)
  • func (v *PackagePathVisitor) VisitAndReplaceString(s string) (string, error)
• type PackageVersion
• type PlaceholderRef

Constants

const SubtypeName = "packagemanager"

SubtypeName is a constant that identifies the internal package manager resource subtype string.

Variables

var API = resource.APINamespaceRDKInternal.WithServiceType(SubtypeName)

API is the fully qualified API for the internal package manager service.

var ErrInvalidPackageRef = errors.New("invalid package reference")

ErrInvalidPackageRef is an error when a invalid package reference syntax.

var ErrPackageMissing = errors.New("package missing")

ErrPackageMissing is an error when a package cannot be found.

var InternalServiceName = resource.NewName(API, "builtin")

InternalServiceName is used to refer to/depend on this service internally.

Types

type Manager

type Manager interface {
	resource.Resource

	// PackagePath returns the package if it exists and is already downloaded. If it does not exist it returns a ErrPackageMissing error.
	PackagePath(name PackageName) (string, error)

	// Placeholder path returns a valid package placeholder from the entire string or errors if there is none
	PlaceholderPath(path string) (*PlaceholderRef, error)
}

Manager provides a managed interface for looking up package paths. This is separated from ManagerSyncer to avoid passing the full sync interface to all components.

type ManagerSyncer

type ManagerSyncer interface {
	Manager

	// Sync will download and create the symbolic logic links to all the given PackageConfig. Sync will not remove any unused
	// data packages. You must call Cleanup() to remove leftovers. Sync will block until all packages are loaded to the file system.
	// Sync should only be used by one goroutine at once.
	// If errors occur during sync the manager should continue trying to download all packages and then return any errors that occurred.
	// If the context is canceled the manager will stop syncing and return an interrupted error.
	Sync(ctx context.Context, packages []config.PackageConfig) error

	// Cleanup removes any unused packages known to the Manager that are no longer used. It removes the packages from the file system.
	// Returns any errors during the cleanup process.
	Cleanup(ctx context.Context) error
}

ManagerSyncer provides a managed interface for both reading package paths and syncing packages from the RDK config.

func NewCloudManager

func NewCloudManager(client pb.PackageServiceClient, packagesDir string, logger golog.Logger) (ManagerSyncer, error)

NewCloudManager creates a new manager with the given package service client and directory to sync to.

func NewNoopManager

func NewNoopManager() ManagerSyncer

NewNoopManager returns a noop package manager that does nothing. On path requests it returns the name of the package.

type PackageID

type PackageID string

PackageID is a gobally unique package id.

type PackageName

type PackageName string

PackageName is the logical name of the package on the local rdk. Can point to ID/Version of an actual package.

type PackagePathVisitor

type PackagePathVisitor struct {
	// contains filtered or unexported fields
}

PackagePathVisitor is a visitor that replaces strings containing references to package names with the path containing the package files on the robot.

func NewPackagePathVisitor

func NewPackagePathVisitor(packageManager Manager, packagePaths map[string]string) *PackagePathVisitor

NewPackagePathVisitor creates a new PackagePathVisitor.

func (*PackagePathVisitor) Visit

func (v *PackagePathVisitor) Visit(data interface{}) (interface{}, error)

Visit implements config.Visitor.

func (*PackagePathVisitor) VisitAndReplaceString

func (v *PackagePathVisitor) VisitAndReplaceString(s string) (string, error)

VisitAndReplaceString replaces a string with a package path if its a valid package placeholder.

type PackageVersion

type PackageVersion string

PackageVersion is an immutable package version for a given package id.

type PlaceholderRef

type PlaceholderRef struct {
	// contains filtered or unexported fields
}

PlaceholderRef stores the destructured info about the matched placeholder if the Placeholder is ${packges.ml_model.hello} -> { matchedPlaceholder: ${packges.ml_model.hello}, nestedPath: packges.ml_model.hello type: ml_model, name: hello}.