Documentation
¶
Overview ¶
Package application implements VersionGate's Application domain concept: a single distributable mobile app, scoped to exactly one Project, that Releases and Versions are evaluated against (specs/domain/application.md). Like internal/project, this package has no dependency on any specific storage technology.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrDisplayNameRequired = errors.New("application: display name is required")
ErrDisplayNameRequired is returned by Create when displayName is empty.
var ErrIdentifierAmbiguous = errors.New("application: identifier is not unique across projects")
ErrIdentifierAmbiguous is returned by GetByIdentifier if more than one Application shares identifier across Projects. Identifiers are only guaranteed unique *within* a Project (specs/domain/application.md's Relationship with Project) — two Projects legitimately reusing the same identifier is an accepted scenario for Project-scoped access, but the unauthenticated update-check lookup (specs/protocols/update-check.md) has no Project context to disambiguate with. This is treated as an operator data issue (an internal error), not a client error: a well-behaved deployment should never actually hit it.
var ErrIdentifierRequired = errors.New("application: identifier is required")
ErrIdentifierRequired is returned by Create when identifier is empty.
var ErrIdentifierTaken = errors.New("application: identifier already in use for this project")
ErrIdentifierTaken is returned by Create when identifier is already in use by another Application under the same Project — identifiers only need to be unique within their owning Project (specs/domain/application.md's Relationship with Project).
var ErrInvalidPlatform = errors.New("application: platform must be ios or android")
ErrInvalidPlatform is returned by Create when platform is not one of the known Platform values.
var ErrNotFound = errors.New("application: not found")
ErrNotFound is returned by a Repository when no Application matches the requested (Project, ID) pair — including when the ID exists but belongs to a different Project, so a cross-Project lookup is indistinguishable from a genuinely missing Application (specs/protocols/http.md).
var ErrProjectNotFound = errors.New("application: project not found")
ErrProjectNotFound is returned by Create when projectID does not reference an existing Project. An Application cannot exist without an owning Project (specs/domain/application.md's Constraints).
Functions ¶
This section is empty.
Types ¶
type Application ¶
type Application struct {
ID ID
ProjectID project.ID
Identifier string
DisplayName string
Platform Platform
Active bool
CreatedAt time.Time
UpdatedAt time.Time
}
Application represents a single distributable mobile app under a Project. Platform is fixed at creation — this package exposes no way to change it afterward, by design (specs/domain/application.md's Platform considerations: "Platform is fixed at creation and does not change").
func Create ¶
func Create(ctx context.Context, repo Repository, projectID project.ID, identifier, displayName string, platform Platform) (Application, error)
Create validates identifier, displayName, and platform, then persists a new, active Application under projectID via repo. This is the one place those invariants are enforced, so every caller (HTTP handlers, future CLI commands) gets them for free.
func Deactivate ¶
func Deactivate(ctx context.Context, repo Repository, projectID project.ID, id ID) (Application, error)
Deactivate stops an Application from serving policy evaluations without deleting its history of Releases (specs/domain/application.md's Lifecycle). Deactivating an already-inactive Application is not an error — it is idempotent.
type ID ¶
type ID string
ID identifies an Application. Like project.ID, it is assigned by a Repository at creation time.
type Platform ¶
type Platform string
Platform is the closed set of platforms an Application can target. This is a deliberate enumeration, not a free-form string (specs/domain/application.md's Constraints) — adding a platform is a domain change, not configuration.
type Repository ¶
type Repository interface {
Create(ctx context.Context, projectID project.ID, identifier, displayName string, platform Platform) (Application, error)
Get(ctx context.Context, projectID project.ID, id ID) (Application, error)
Deactivate(ctx context.Context, projectID project.ID, id ID) (Application, error)
// GetByIdentifier looks up an Application by its public identifier
// alone, with no Project scope — used only by the unauthenticated
// update-check path (specs/protocols/update-check.md), where a
// client has no token and thus no Project context. Every other
// caller should use Get, which is Project-scoped.
GetByIdentifier(ctx context.Context, identifier string) (Application, error)
}
Repository persists and retrieves Applications, scoped to a Project. Infrastructure provides the implementation; this package only declares what it needs from it.
Source Files