models

package
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 3, 2019 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package models contains the models and auto generated models for the app.

Index

Constants

View Source 
const (
	WorkspaceUpdated      = "WORKSPACE_UPDATED"
	ProjectUpdated        = "PROJECT_UPDATED"
	TaskUpdated           = "TASK_UPDATED"
	JobUpserted           = "JOB_UPSERTED"
	JobMetricsUpdated     = "JOB_METRICS_UPDATED"
	ProcessGroupUpserted  = "PROCESS_GROUP_UPSERTED"
	ProcessUpserted       = "PROCESS_UPSERTED"
	ProcessMetricsUpdated = "PROCESS_METRICS_UPDATED"
	LogEntryAdded         = "LOG_ENTRY_ADDED"
	LogMetricsUpdated     = "LOG_METRICS_UPDATED"
)

Message types.

View Source 
const DateFormat = "2006-01-02T15:04:05-0700"

DateFormat is the date format used throughout the app.

Variables

View Source 
var (
	ErrNotFound      = errors.New("not found")
	ErrType          = errors.New("wrong type")
	ErrFirstNegative = errors.New("first cannot be negative")
	ErrLastNegative  = errors.New("last cannot be negative")
	ErrNotRunning    = errors.New("project isn't running")
	ErrNotStopped    = errors.New("project isn't stopped")
)

Errors.

Functions

func CreateLineWriter 

func CreateLineWriter(
	write func(ownerID, message string, a ...interface{}) string,
	ownerID string,
	a ...interface{},
) io.WriteCloser

CreateLineWriter creates a writer with a line splitter. Remember to call close().

func WithModelContext added in v0.1.5 

func WithModelContext(ctx context.Context, mc *ModelContext) context.Context

WithModelContext adds a model context to a Go context.

Types

type Config 

type Config struct {
	Filename   string `json:"filename"`
	Workspaces []struct {
		Slug        string  `json:"slug"`
		Name        string  `json:"name"`
		Description string  `json:"description"`
		Notes       *string `json:"notes"`
		Projects    []struct {
			Slug        string  `json:"slug"`
			Repository  string  `json:"repository"`
			Branch      string  `json:"branch"`
			Description *string `json:"description"`
		} `json:"projects"`
		Tasks []struct {
			Name  string `json:"name"`
			Steps []struct {
				Projects []string `json:"projects"`
				Commands []string `json:"commands"`
			} `json:"tasks"`
		} `json:"tasks"`
	} `json:"workspaces"`
}

Config contains all the data in a YAML config file.

func LoadConfigYAML 

func LoadConfigYAML(filename string) (Config, error)

LoadConfigYAML loads a config from a YAML file.

func (Config) CreateNodes 

func (c Config) CreateNodes(nodes *NodeManager, userID string) error

CreateNodes creates nodes for the content of the config. The user node must already exists

type DateTime 

type DateTime time.Time

DateTime holds a date.

func (DateTime) MarshalGQL 

func (d DateTime) MarshalGQL(w io.Writer)

MarshalGQL implements the graphql.Marshaler interface.

func (*DateTime) UnmarshalGQL 

func (d *DateTime) UnmarshalGQL(v interface{}) error

UnmarshalGQL implements the graphql.Marshaler interface.

type Hash 

type Hash string

Hash holds a Git hash. TODO: change to bytes.

func (Hash) MarshalGQL 

func (h Hash) MarshalGQL(w io.Writer)

MarshalGQL implements the graphql.Marshaler interface.

func (*Hash) UnmarshalGQL 

func (h *Hash) UnmarshalGQL(v interface{}) error

UnmarshalGQL implements the graphql.Marshaler interface.

type Job 

type Job struct {
	ID        string      `json:"id"`
	Name      string      `json:"name"`
	CreatedAt DateTime    `json:"createdAt"`
	UpdatedAt DateTime    `json:"updatedAt"`
	Status    JobStatus   `json:"status"`
	Priority  JobPriority `json:"priority"`
	OwnerID   string      `json:"ownerId"`
}

Job represents a job in the app.

func (Job) IsNode 

func (Job) IsNode()

IsNode tells gqlgen that it implements Node.

func (Job) Owner 

func (j Job) Owner(ctx context.Context) Node

Owner returns the node associated with the job.

type JobManager 

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

JobManager manages creating and running jobs.

func NewJobManager 

func NewJobManager(concurrency int) *JobManager

NewJobManager creates a JobManager with given concurrency.

func (*JobManager) Add 

func (j *JobManager) Add(
	modelCtx *ModelContext,
	name string,
	ownerID string,
	priority JobPriority,
	fn func(ctx context.Context) error,
) string

Add adds a job to the queue and returns the job's ID.

func (*JobManager) Stop 

func (j *JobManager) Stop(modelCtx *ModelContext, id string) error

Stop cancels a running job.

func (*JobManager) Work 

func (j *JobManager) Work(ctx context.Context) error

Work starts running jobs and blocks until the context is done.

type LogEntry 

type LogEntry struct {
	ID        string   `json:"id"`
	Level     LogLevel `json:"level"`
	CreatedAt DateTime `json:"createdAt"`
	Message   string   `json:"message"`
	OwnerID   string   `json:"ownerId"`
}

LogEntry represents a log entry in the app.

func (LogEntry) IsNode 

func (LogEntry) IsNode()

IsNode tells gqlgen that it implements Node.

func (LogEntry) Owner 

func (l LogEntry) Owner(ctx context.Context) Node

Owner returns the node associated with the LogEntry.

type Logger 

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

Logger logs messages.

func NewLogger 

func NewLogger(
	nodes *NodeManager,
	subs *pubsub.PubSub,
	cap int,
	level LogLevel,
	systemID string,
) *Logger

NewLogger creates a Logger with given capacity and level.

func (*Logger) Add 

func (l *Logger) Add(
	level LogLevel,
	ownerID string,
	message string,
) (string, error)

Add adds a log entry.

func (*Logger) Debug 

func (l *Logger) Debug(message string, a ...interface{}) string

Debug adds a debug entry.

func (*Logger) DebugWithOwner 

func (l *Logger) DebugWithOwner(ownerID string, message string, a ...interface{}) string

DebugWithOwner adds a debug entry with an owner.

func (*Logger) Error 

func (l *Logger) Error(message string, a ...interface{}) string

Error adds an error entry.

func (*Logger) ErrorWithOwner 

func (l *Logger) ErrorWithOwner(ownerID string, message string, a ...interface{}) string

ErrorWithOwner adds an error entry with an owner.

func (*Logger) Info 

func (l *Logger) Info(message string, a ...interface{}) string

Info adds an info entry.

func (*Logger) InfoWithOwner 

func (l *Logger) InfoWithOwner(ownerID string, message string, a ...interface{}) string

InfoWithOwner adds an info entry with an owner.

func (*Logger) Warning 

func (l *Logger) Warning(message string, a ...interface{}) string

Warning adds a warning entry.

func (*Logger) WarningWithOwner 

func (l *Logger) WarningWithOwner(ownerID string, message string, a ...interface{}) string

WarningWithOwner adds a warning entry with an owner.

type ModelContext added in v0.1.5 

type ModelContext struct {
	Nodes               *NodeManager
	Log                 *Logger
	Jobs                *JobManager
	PM                  *ProcessManager
	Subs                *pubsub.PubSub
	GetProjectPath      ProjectPathGetter
	GetProjectCachePath ProjectCachePathGetter
	ViewerID            string
	SystemID            string
}

ModelContext contains variables that are passed to model functions.

func GetModelContext added in v0.1.5 

func GetModelContext(ctx context.Context) *ModelContext

GetModelContext retrieves the model context from a Go context.

type NodeManager 

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

NodeManager helps manage nodes with global IDs.

func (*NodeManager) Load 

func (n *NodeManager) Load(id string) (Node, bool)

Load loads a node.

func (*NodeManager) Lock 

func (n *NodeManager) Lock(ids ...string)

Lock locks the given IDs.

func (*NodeManager) MustLoad 

func (n *NodeManager) MustLoad(id string) Node

MustLoad loads a node or panics if it doesn't exist.

func (*NodeManager) RLock 

func (n *NodeManager) RLock(ids ...string)

RLock read-locks the given IDs.

func (*NodeManager) RUnlock 

func (n *NodeManager) RUnlock(ids ...string)

RUnlock read-unlocks the given IDs.

func (*NodeManager) Unlock 

func (n *NodeManager) Unlock(ids ...string)

Unlock unlocks the given IDs.

type Process 

type Process struct {
	ID             string        `json:"id"`
	Command        string        `json:"command"`
	ProcessGroupID string        `json:"processGroupId"`
	ProjectID      string        `json:"projectId"`
	Status         ProcessStatus `json:"status"`
}

Process represents a process in the app.

func (Process) IsNode 

func (Process) IsNode()

IsNode tells gqlgen that it implements Node.

func (Process) ProcessGroup 

func (p Process) ProcessGroup(ctx context.Context) ProcessGroup

ProcessGroup returns the ProcessGroup associated with the Process.

func (Process) Project 

func (p Process) Project(ctx context.Context) Project

Project returns the Project associated with the Process.

type ProcessGroup 

type ProcessGroup struct {
	ID         string   `json:"id"`
	CreatedAt  DateTime `json:"createdAt"`
	TaskID     string   `json:"taskId"`
	ProcessIDs []string `json:"processIds"`
}

ProcessGroup represents a ProcessGroup in the app.

func (ProcessGroup) IsNode 

func (ProcessGroup) IsNode()

IsNode tells gqlgen that it implements Node.

func (ProcessGroup) Processes 

func (p ProcessGroup) Processes(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (ProcessConnection, error)

Processes returns the ProcessGroup's processes.

func (ProcessGroup) Status 

func (p ProcessGroup) Status(ctx context.Context) ProcessStatus

Status returns the status of the ProcessGroup.

func (ProcessGroup) Task 

func (p ProcessGroup) Task(ctx context.Context) Task

Task returns the Task associated with the ProcessGroup.

type ProcessManager 

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

ProcessManager manages creating and running jobs.

func NewProcessManager 

func NewProcessManager() *ProcessManager

NewProcessManager creates a ProcessManager.

func (*ProcessManager) Clean 

func (p *ProcessManager) Clean(ctx context.Context)

Clean terminates all running processes.

func (*ProcessManager) CreateGroup 

func (p *ProcessManager) CreateGroup(ctx context.Context, taskID string) string

CreateGroup creates a new ProcessGroup and returns its ID.

func (*ProcessManager) Run 

func (p *ProcessManager) Run(
	ctx context.Context,
	command string,
	processGroupID string,
	projectID string,
) string

Run launches a new Process and adds it to a ProcessGroup.

func (*ProcessManager) Start 

func (p *ProcessManager) Start(ctx context.Context, processID string) error

Start starts a process that was stopped.

func (*ProcessManager) Stop 

func (p *ProcessManager) Stop(ctx context.Context, processID string) error

Stop stops a running process.

type Project 

type Project struct {
	ID               string   `json:"id"`
	Slug             string   `json:"slug"`
	Repository       string   `json:"repository"`
	Branch           string   `json:"branch"`
	Description      *string  `json:"description"`
	WorkspaceID      string   `json:"workspaceId"`
	CommitIDs        []string `json:"commitIds"`
	Tasks            []Task   `json:"projects"`
	IsLoadingCommits bool     `json:"isLoadingCommits"`
	IsCloning        bool     `json:"isCloning"`
	IsPulling        bool     `json:"isPulling"`
	IsBehind         bool     `json:"isBehind"`
	IsAhead          bool     `json:"isAhead"`
}

Project represents a project in the app.

func (Project) Commits 

func (p Project) Commits(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (CommitConnection, error)

Commits returns paginated commits.

func (Project) IsCloned 

func (p Project) IsCloned(ctx context.Context) bool

IsCloned checks if the project is cloned.

func (Project) IsNode 

func (Project) IsNode()

IsNode tells gqlgen that it implements Node.

func (Project) Workspace 

func (p Project) Workspace(ctx context.Context) Workspace

Workspace returns the workspace associated with the project.

type ProjectCachePathGetter added in v0.1.5 

type ProjectCachePathGetter func(workspaceSlug, repo, branch string) string

ProjectCachePathGetter is a function that returns the path to a project's cache.

type ProjectPathGetter 

type ProjectPathGetter func(workspaceSlug, repo, branch string) string

ProjectPathGetter is a function that returns the path to a project.

type Step 

type Step struct {
	ID         string   `json:"id"`
	ProjectIDs []string `json:"projectIds"`
	CommandIDs []string `json:"commandIds"`
	TaskID     string   `json:"taskId"`
}

Step represents a task step in the app.

func (Step) Commands 

func (s Step) Commands(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (CommandConnection, error)

Commands returns the step's commands.

func (Step) IsNode 

func (Step) IsNode()

IsNode tells gqlgen that it implements Node.

func (Step) Projects 

func (s Step) Projects(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (ProjectConnection, error)

Projects returns the step's projects.

func (Step) Task 

func (s Step) Task(ctx context.Context) Task

Task returns the step's taks.

type System 

type System struct {
	ID               string   `json:"id"`
	JobIDs           []string `json:"jobsIds"`
	JobMetricsID     string   `json:"jobMetricsId"`
	ProcessGroupIDs  []string `json:"processGroupIds"`
	ProcessMetricsID string   `json:"processMetricsId"`
	LogEntryIDs      []string `json:"logEntryIds"`
	LogMetricsID     string   `json:"logMetricsId"`
}

System contains information about the running app.

func (System) IsNode 

func (System) IsNode()

IsNode tells gqlgen that it implements Node.

func (System) JobMetrics 

func (s System) JobMetrics(ctx context.Context) JobMetrics

JobMetrics returns the JobMetrics node.

func (System) Jobs 

func (s System) Jobs(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
	status []JobStatus,
) (JobConnection, error)

Jobs returns paginated jobs.

func (System) LogEntries 

func (s System) LogEntries(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
	level []LogLevel,
	ownerID *string,
) (LogEntryConnection, error)

LogEntries returns paginated log entries.

func (System) LogMetrics 

func (s System) LogMetrics(ctx context.Context) LogMetrics

LogMetrics returns the LogMetrics node.

func (System) ProcessGroups 

func (s System) ProcessGroups(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
	status []ProcessStatus,
) (ProcessGroupConnection, error)

ProcessGroups returns paginated process groups.

func (System) ProcessMetrics 

func (s System) ProcessMetrics(ctx context.Context) ProcessMetrics

ProcessMetrics returns the ProcessMetrics node.

type Task 

type Task struct {
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	StepIDs     []string `json:"stepIds"`
	WorkspaceID string   `json:"workspace"`
	IsRunning   bool     `json:"isRunning"`
}

Task represents a workspace task in the app.

func (Task) IsNode 

func (Task) IsNode()

IsNode tells gqlgen that it implements Node.

func (Task) Steps 

func (t Task) Steps(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (StepConnection, error)

Steps returns the task's steps.

func (Task) Workspace 

func (t Task) Workspace(ctx context.Context) Workspace

Workspace returns the task's workspace.

type User 

type User struct {
	ID           string   `json:"id"`
	WorkspaceIDs []string `json:"workspaceIds"`
}

User contains all the data of the person using the app.

func (User) IsNode 

func (User) IsNode()

IsNode tells gqlgen that it implements Node.

func (User) Projects 

func (u User) Projects(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (ProjectConnection, error)

Projects returns the user's projects.

func (User) Workspace 

func (u User) Workspace(ctx context.Context, slug string) *Workspace

Workspace finds a workspace.

func (User) Workspaces 

func (u User) Workspaces(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (WorkspaceConnection, error)

Workspaces returns the user's workspaces.

type Workspace 

type Workspace struct {
	ID          string   `json:"id"`
	Slug        string   `json:"slug"`
	Name        string   `json:"name"`
	ProjectIDs  []string `json:"projectIds"`
	TaskIDs     []string `json:"taskIds"`
	Description string   `json:"description"`
	Notes       *string  `json:"notes"`
}

Workspace represents a workspace in the app.

func (Workspace) IsAhead 

func (w Workspace) IsAhead(ctx context.Context) bool

IsAhead returns true if any of the projects is ahead origin.

func (Workspace) IsBehind 

func (w Workspace) IsBehind(ctx context.Context) bool

IsBehind returns true if any of the projects is behind origin.

func (Workspace) IsCloned 

func (w Workspace) IsCloned(ctx context.Context) bool

IsCloned returns true if all the projects are cloned.

func (Workspace) IsCloning 

func (w Workspace) IsCloning(ctx context.Context) bool

IsCloning returns true if any of the projects is cloning.

func (Workspace) IsNode 

func (Workspace) IsNode()

IsNode tells gqlgen that it implements Node.

func (Workspace) IsPulling 

func (w Workspace) IsPulling(ctx context.Context) bool

IsPulling returns true if any of the projects is pulling.

func (Workspace) Projects 

func (w Workspace) Projects(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (ProjectConnection, error)

Projects returns the workspace's projects.

func (Workspace) Tasks 

func (w Workspace) Tasks(
	ctx context.Context,
	after *string,
	before *string,
	first *int,
	last *int,
) (TaskConnection, error)

Tasks returns the workspace's tasks.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.