Documentation
¶
Index ¶
- Constants
- func GetDistBucketID(projectID string) string
- func NewDistBucketConfig(projectID string) (*bucket.Config, error)
- func ParsePluginHostObjectKey(key string) (*hash.Hash, error)
- func PluginHostObjectKey(meta *DistMeta) (string, error)
- type DistMeta
- func (m *DistMeta) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *DistMeta) CloneVT() *DistMeta
- func (this *DistMeta) EqualMessageVT(thatMsg any) bool
- func (this *DistMeta) EqualVT(that *DistMeta) bool
- func (x *DistMeta) GetChannelKey() string
- func (x *DistMeta) GetDistObjectKey() string
- func (x *DistMeta) GetDistWorldRef() *bucket.ObjectRef
- func (x *DistMeta) GetEntrypointRole() string
- func (x *DistMeta) GetManifestId() string
- func (x *DistMeta) GetManifestRev() uint64
- func (x *DistMeta) GetPlatformId() string
- func (x *DistMeta) GetProjectId() string
- func (x *DistMeta) GetStartupPlugins() []string
- func (x *DistMeta) GetUpdateGuardPluginIds() []string
- func (m *DistMeta) MarshalB58() string
- func (x *DistMeta) MarshalJSON() ([]byte, error)
- func (x *DistMeta) MarshalProtoJSON(s *json.MarshalState)
- func (x *DistMeta) MarshalProtoText() string
- func (m *DistMeta) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *DistMeta) MarshalToVT(dAtA []byte) (int, error)
- func (m *DistMeta) MarshalVT() (dAtA []byte, err error)
- func (*DistMeta) ProtoMessage()
- func (x *DistMeta) Reset()
- func (m *DistMeta) SizeVT() (n int)
- func (x *DistMeta) String() string
- func (x *DistMeta) UnmarshalJSON(b []byte) error
- func (x *DistMeta) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *DistMeta) UnmarshalVT(dAtA []byte) error
- func (m *DistMeta) Validate() error
Constants ¶
const ( // EntrypointRoleDesktop identifies the native desktop UI entrypoint. EntrypointRoleDesktop = "desktop" // EntrypointRoleBrowser identifies the browser/CDN entrypoint. EntrypointRoleBrowser = "browser" // EntrypointRoleCLI identifies the managed CLI entrypoint. EntrypointRoleCLI = "cli" )
const DistWorldEngineID = "dist"
DistWorldEngineID is the world engine id on the bus for the dist bundle.
const StaticBlockStoreID = "entrypoint"
StaticBlockStoreID is the BlockStoreId for the StaticBlockStore.
Variables ¶
This section is empty.
Functions ¶
func GetDistBucketID ¶
GetDistBucketID returns the bucket id for a project id dist.
func NewDistBucketConfig ¶
NewDistBucketConfig returns the bucket config for a project id dist.
func ParsePluginHostObjectKey ¶
ParsePluginHostObjectKey reads the distribution identity from a plugin cache key.
func PluginHostObjectKey ¶
PluginHostObjectKey scopes cached plugin selections to the distribution's embedded manifest World, platform and channel. Artifact revision counters are local to a producer and cannot establish compatibility across installations.
Types ¶
type DistMeta ¶
type DistMeta struct {
// ProjectId is the project identifier.
// Must be a valid-dns-label.
// Used to construct the application storage and dist bundle filenames.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"projectId,omitempty"`
// PlatformId is the destination platform ID.
PlatformId string `protobuf:"bytes,2,opt,name=platform_id,json=platformId,proto3" json:"platformId,omitempty"`
// StartupPlugins is the list of plugins to run on startup.
StartupPlugins []string `protobuf:"bytes,3,rep,name=startup_plugins,json=startupPlugins,proto3" json:"startupPlugins,omitempty"`
// DistWorldRef is the root object ref to the static assets kvfile block-backed world.
// Contains the transform configuration.
DistWorldRef *bucket.ObjectRef `protobuf:"bytes,4,opt,name=dist_world_ref,json=distWorldRef,proto3" json:"distWorldRef,omitempty"`
// DistObjectKey is the root object key to search for manifests in the dist world.
DistObjectKey string `protobuf:"bytes,5,opt,name=dist_object_key,json=distObjectKey,proto3" json:"distObjectKey,omitempty"`
// EntrypointRole is the release role for this entrypoint.
// Expected values are "desktop", "browser", and "cli".
EntrypointRole string `protobuf:"bytes,6,opt,name=entrypoint_role,json=entrypointRole,proto3" json:"entrypointRole,omitempty"`
// ChannelKey is the release channel this entrypoint was built for.
ChannelKey string `protobuf:"bytes,7,opt,name=channel_key,json=channelKey,proto3" json:"channelKey,omitempty"`
// ManifestId is the Bldr Manifest id for this entrypoint binary.
ManifestId string `protobuf:"bytes,8,opt,name=manifest_id,json=manifestId,proto3" json:"manifestId,omitempty"`
// ManifestRev is the Bldr Manifest revision for this entrypoint binary.
ManifestRev uint64 `protobuf:"varint,9,opt,name=manifest_rev,json=manifestRev,proto3" json:"manifestRev,omitempty"`
// UpdateGuardPluginIds name plugins that quiesce owned work before replacement.
UpdateGuardPluginIds []string `protobuf:"bytes,10,rep,name=update_guard_plugin_ids,json=updateGuardPluginIds,proto3" json:"updateGuardPluginIds,omitempty"`
// contains filtered or unexported fields
}
DistMeta is metadata embedded in a distribution entrypoint.
func NewDistEntrypointMeta ¶ added in v0.52.0
func NewDistEntrypointMeta( projectID string, platformID string, startupPlugins []string, distWorldRef *bucket.ObjectRef, distObjKey string, entrypointRole string, channelKey string, manifestID string, manifestRev uint64, ) *DistMeta
NewDistEntrypointMeta constructs a new DistMeta with entrypoint identity.
func NewDistMeta ¶
func NewDistMeta(projectID, platformID string, startupPlugins []string, distWorldRef *bucket.ObjectRef, distObjKey string) *DistMeta
NewDistMeta constructs a new DistMeta.
func UnmarshalDistMetaB58 ¶
UnmarshalDistMetaB58 unmarshals a b58 dist meta. Note: we compress with s2 compression.
func (*DistMeta) CloneMessageVT ¶
func (m *DistMeta) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*DistMeta) EqualMessageVT ¶
func (*DistMeta) GetChannelKey ¶ added in v0.52.0
func (*DistMeta) GetDistObjectKey ¶
func (*DistMeta) GetDistWorldRef ¶
func (*DistMeta) GetEntrypointRole ¶ added in v0.52.0
func (*DistMeta) GetManifestId ¶ added in v0.52.0
func (*DistMeta) GetManifestRev ¶ added in v0.52.0
func (*DistMeta) GetPlatformId ¶
func (*DistMeta) GetProjectId ¶
func (*DistMeta) GetStartupPlugins ¶
func (*DistMeta) GetUpdateGuardPluginIds ¶
func (*DistMeta) MarshalB58 ¶
MarshalB58 marshals the conf to a b58 string. note: we compress with s2 compression.
func (*DistMeta) MarshalJSON ¶
MarshalJSON marshals the DistMeta to JSON.
func (*DistMeta) MarshalProtoJSON ¶
func (x *DistMeta) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the DistMeta message to JSON.
func (*DistMeta) MarshalProtoText ¶
func (*DistMeta) MarshalToSizedBufferVT ¶
func (*DistMeta) ProtoMessage ¶
func (*DistMeta) ProtoMessage()
func (*DistMeta) UnmarshalJSON ¶
UnmarshalJSON unmarshals the DistMeta from JSON.
func (*DistMeta) UnmarshalProtoJSON ¶
func (x *DistMeta) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the DistMeta message from JSON.