archsketch

type Dependency struct {
	Kind string `json:"kind"`
	// Name is the worker name, the FEEL expression of a runtime worker, the job type,
	// the called process id, or the decision id.
	Name string `json:"name"`
	// WorkerType is a worker's Worker Type ("rest", "mail", …) as the model's task
	// type states it.
	WorkerType string `json:"workerType,omitempty"`
	// TargetApplicationID and TargetApplication name the application that held the
	// called process on the recording installation when the snapshot was taken. Empty
	// when nothing there held it — which says the call had no target there, not that
	// it has none anywhere.
	TargetApplicationID string `json:"targetApplicationId,omitempty"`
	TargetApplication   string `json:"targetApplication,omitempty"`
	UsedBy              []Use  `json:"usedBy"`
}

type Endpoint struct {
	Scheme string `json:"scheme,omitempty"`
	Host   string `json:"host,omitempty"`
	// Port is the port the configured value named. Empty when it named none, which
	// means the scheme's or the Worker Type's default — the snapshot does not guess
	// which.
	Port string `json:"port,omitempty"`
	// Unparseable is set when the configured value could not be read as an address.
	// The value itself is not kept: what cannot be parsed cannot be cleaned either.
	Unparseable bool `json:"unparseable,omitempty"`
	// Withheld is set on a read for a reader who may not see it. Never stored.
	Withheld bool `json:"withheld,omitempty"`
}

type EntryPoint struct {
	Kind string `json:"kind"`
	Name string `json:"name"`
	// Starts is set when at least one element receiving this message starts an
	// instance; otherwise every receipt continues one that is already running.
	Starts bool  `json:"starts,omitempty"`
	UsedBy []Use `json:"usedBy"`
}

type JobTypeSite struct {
	JobType string `json:"jobType"`
	Observers
}

type Meta struct {
	ApplicationID string
	Application   string
	ReleaseID     string
	Version       int32
}

type Observers struct {
	ObservedBy        []string `json:"observedBy,omitempty"`
	Observed          int      `json:"observed"`
	ObserversWithheld bool     `json:"observersWithheld,omitempty"`
}

type Physical struct {
	// Node and Environment are the recording installation's operator-given name and
	// environment (ADR-0189 §6). Empty where nobody named them.
	Node        string `json:"node,omitempty"`
	Environment string `json:"environment,omitempty"`
	// ExternalURL is the origin the installation was configured to be reached under.
	// Nil when none was configured: the listen address is not the reachable address,
	// so it is not offered in its place.
	ExternalURL *Endpoint `json:"externalUrl,omitempty"`
	// PublicStartLinks counts the public start links each process had here. The links
	// themselves are their own authorization and are never recorded.
	PublicStartLinks []StartLinks  `json:"publicStartLinks"`
	Workers          []WorkerSite  `json:"workers"`
	JobTypes         []JobTypeSite `json:"jobTypes"`
}

type Process struct {
	ProcessID string `json:"processId"`
	Name      string `json:"name,omitempty"`
	Version   int32  `json:"version"`
	// Unread is set when the definition was recorded as a member but its compiled
	// form was not there to read. Its entry points and dependencies are then missing
	// from the snapshot, and the snapshot says so rather than drawing a process that
	// offers and needs nothing.
	Unread bool `json:"unread,omitempty"`
}

type Snapshot struct {
	FormatVersion  int `json:"formatVersion"`
	MappingVersion int `json:"mappingVersion"`
	// TakenAt is when the snapshot was taken, by the server's clock, in Unix seconds.
	TakenAt int64 `json:"takenAt"`
	// Processes are the release's process members, as they were deployed.
	Processes []Process `json:"processes"`
	// EntryPoints are where the environment reaches into the application.
	EntryPoints []EntryPoint `json:"entryPoints"`
	// Dependencies are what the application reaches out to.
	Dependencies []Dependency `json:"dependencies"`
	// Physical is the recording installation's half, absent on a snapshot taken
	// before format version 2.
	Physical *Physical `json:"physical,omitempty"`
}

type StartLinks struct {
	ProcessID string `json:"processId"`
	Links     int    `json:"links"`
}

type Use struct {
	ProcessID string `json:"processId"`
	ElementID string `json:"elementId,omitempty"`
}

type WorkerSite struct {
	Name       string `json:"name"`
	WorkerType string `json:"workerType,omitempty"`
	Placement  string `json:"placement"`
	// ConfiguredID is the configured worker the installation held under this name, and
	// empty when it held none — the case of a worker that keeps its own configuration
	// (ADR-0168). Kept so a read can ask who may see its endpoint.
	ConfiguredID    string    `json:"configuredId,omitempty"`
	Endpoint        *Endpoint `json:"endpoint,omitempty"`
	MailboxEndpoint *Endpoint `json:"mailboxEndpoint,omitempty"`
	// EndpointReported is set when Endpoint is not the installation's configuration
	// but what the worker instances serving the name reported (format version 3).
	// It is then information about those instances, and a read treats it as such.
	EndpointReported bool `json:"endpointReported,omitempty"`
	// EndpointsDiffer is set when the instances serving the name reported different
	// endpoints. None of them is recorded then: picking one would draw a single
	// system where the installation reaches several.
	EndpointsDiffer bool `json:"endpointsDiffer,omitempty"`
	Observers
}