sgload

type Agent struct {
	AgentSpec
	StatsdClient        g2s.Statter          // The statsd client instance to use to push stats to statdsd
	ExpVarStats         ExpVarStatsCollector // The expvar progress stats map for this agent
	CreateUserSemaphore *semaphore.Semaphore // Semaphore to ensure max # of concrrent createuser requests
	CreatedSGUser       bool                 // State to track whether SG user has already been created
}

type AgentSpec struct {
	FinishedWg *sync.WaitGroup // Allows interested party to block until agent is done
	UserCred
	ID                      int             // The numeric ID of the writer (ephemeral, only stored in memory)
	CreateDataStoreUser     bool            // Whether this writer must first create a user on the DataStore service, ot just assume it already exists
	DataStore               DataStore       // The target data store where docs will be written
	BatchSize               int             // bulk_get or bulk_docs batch size
	AttachSizeBytes         int             // If > 0, and BatchSize == 1, then it will add attachments of this size during doc creates/updates.
	ExpvarProgressEnabled   bool            // Whether to publish reader/writer/updater progress to expvars
	MaxConcurrentCreateUser int             // The maximum number of concurrent outstanding createuser requests.  0 means no maximum
	AllSGUsersCreated       *sync.WaitGroup // Wait Group to allow waiting until all SG users created before applying load
}

type AttachmentMeta struct {
	Follows     bool   `json:"follows"`
	ContentType string `json:"content_type"`
	Length      int    `json:"length"`
	Digest      string `json:"digest"`
}

type BulkDocs struct {
	NewEdits  bool       `json:"new_edits"`
	Documents []Document `json:"docs"`
}

type Change interface{} // TODO: spec this out further

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

type ChangesFeedType string

type DataStore interface {

	// Creates a new user in the data store (admin port)
	CreateUser(u UserCred, channelNames []string) error

	// Create a single document, possibly with attachment if attachSizeBytes > 0
	CreateDocument(doc Document, attachSizeBytes int, newEdits bool) (DocumentMetadata, error)

	// Bulk creates a set of documents in the data store
	BulkCreateDocuments(d []Document, newEdits bool) ([]DocumentMetadata, error)

	// Same as BulkCreateDocuments, but built-in retry for temporary errors
	BulkCreateDocumentsRetry(d []Document, newEdits bool) ([]DocumentMetadata, error)

	// Sets the user credentials to use for all subsequent requests
	SetUserCreds(u UserCred)

	// Get all the changes since the since value
	Changes(sinceVal Sincer, limit int, feedType ChangesFeedType) (changes sgreplicate.Changes, newSinceVal Sincer, err error)

	// Does a bulk get on docs in bulk get request, discards actual docs
	BulkGetDocuments(sgreplicate.BulkGetRequest) ([]sgreplicate.Document, error)
}

type DocUpdateStatus struct {
	NumUpdates       int
	DocumentMetadata DocumentMetadata
}

type Document map[string]interface{}

type DocumentMetadata struct {
	sgreplicate.DocumentRevisionPair
	Channels []string
}

type DocumentRevisionPair struct {
	Id       string `json:"id"`
	Revision string `json:"rev"`
	Error    string `json:"error,omitempty"`
	Reason   string `json:"reason,omitempty"`
}

type ExpVarStatsCollector interface {
	Set(key string, av expvar.Var)
	Add(key string, delta int64)
}

type GateLoadRunner struct {
	LoadRunner
	WriteLoadRunner
	ReadLoadRunner
	UpdateLoadRunner
	GateLoadSpec GateLoadSpec
	PushedDocs   chan []DocumentMetadata
}

type GateLoadSpec struct {
	LoadSpec
	WriteLoadSpec
	ReadLoadSpec
	UpdateLoadSpec
}

type LoadRunner struct {
	LoadSpec     LoadSpec
	StatsdClient g2s.Statter
}

type LoadSpec struct {
	SyncGatewayUrl        string    // The Sync Gateway public URL with port and DB, eg "http://localhost:4984/db"
	SyncGatewayAdminPort  int       // The Sync Gateway admin port, eg, 4985
	MockDataStore         bool      // If true, will use a MockDataStore instead of a real sync gateway
	StatsdEnabled         bool      // If true, will push stats to StatsdEndpoint
	StatsdEndpoint        string    // The endpoint of the statds server, eg localhost:8125
	StatsdPrefix          string    // The metrics prefix to use (for example, some hosted statsd services require a token)
	TestSessionID         string    // A unique identifier for this test session.  It's used for creating channel names and possibly more
	AttachSizeBytes       int       // If > 0, and BatchSize == 1, then it will add attachments of this size during doc creates/updates.
	BatchSize             int       // How many docs to read (bulk_get) or write (bulk_docs) in bulk
	NumChannels           int       // How many channels to create/use during this test
	DocSizeBytes          int       // Doc size in bytes to create during this test
	NumDocs               int       // Number of docs to read/write during this test
	CompressionEnabled    bool      // Whether requests and responses should be compressed (when supported)
	ExpvarProgressEnabled bool      // Whether to publish reader/writer/updater progress to expvars (disabled by default to not bloat expvar json)
	LogLevel              log15.Lvl // The log level.  Defaults to LvlWarn

}

type MockDataStore struct{}

type MockStatter struct{}

type NoOpExpvarStatsCollector struct{}

type ReadLoadRunner struct {
	LoadRunner
	ReadLoadSpec ReadLoadSpec
}

type ReadLoadSpec struct {
	LoadSpec
	CreateReaders             bool // Whether or not to create users for readers
	NumReaders                int
	NumChansPerReader         int
	NumRevGenerationsExpected int
	SkipWriteLoadSetup        bool            // By default the readload scenario runs the writeload scenario first.  If this is true, it will skip the writeload scenario.
	FeedType                  ChangesFeedType // "Normal" or "Longpoll"

}

type Reader struct {
	Agent
	SGChannels                []string // The Sync Gateway channels this reader is assigned to pull from
	NumDocsExpected           int      // The total number of docs this reader is expected to pull'
	NumRevGenerationsExpected int      // The expected generate that each doc is expected to reach
	BatchSize                 int      // The number of docs to pull in batch (_changes feed and bulk_get)
	// contains filtered or unexported fields
}

type RetrySleeper func(retryCount int) (shouldContinue bool, timeTosleepMs int)

type RetryWorker func() (shouldRetry bool, err error, value interface{})

type SGDataStore struct {
	SyncGatewayUrl       string
	SyncGatewayAdminPort int
	UserCreds            UserCred
	StatsdClient         g2s.Statter
	CompressionEnabled   bool
}

type Sincer interface {
	Empty() bool
	String() string
	Equals(other Sincer) bool
}

type StringSincer struct {
	Since string
}

type UpdateLoadRunner struct {
	LoadRunner
	UpdateLoadSpec UpdateLoadSpec
}

type UpdateLoadSpec struct {
	LoadSpec
	NumUpdatesPerDoc    int           // The total number of revisions to add per doc
	NumRevsPerUpdate    int           // The number of revisions to add per update
	NumUpdaters         int           // The number of updater goroutines
	DelayBetweenUpdates time.Duration // Delay between updates (subtracting out the time they are blocked during write)

}

type Updater struct {
	Agent
	UpdaterSpec

	DocsToUpdate <-chan []DocumentMetadata // This is a channel that this updater listens to for docs that are ready to be updated

	DocUpdateStatuses map[string]DocUpdateStatus // The number of updates and latest rev that have been done per doc id.  Key = doc id, value = number of updates and latest rev

}

type UpdaterSpec struct {
	NumUpdatesPerDocRequired int           // The number of updates this updater is supposed to do for each doc.
	NumUniqueDocsPerUpdater  int           // The number of unique docs this updater is tasked to update.
	BatchSize                int           // How many docs to update per bulk_docs request
	RevsPerUpdate            int           // How many revisions to include in each document update
	DocSizeBytes             int           // The doc size in bytes to use when generating update docs
	DelayBetweenUpdates      time.Duration // Delay between updates (subtracting out the time they are blocked during write)
}

type UserCred struct {
	Username string `json:"username"` // Username part of basicauth credentials for this writer to use
	Password string `json:"password"` // Password part of basicauth credentials for this writer to use
}

type WriteLoadRunner struct {
	LoadRunner
	WriteLoadSpec WriteLoadSpec
}

type WriteLoadSpec struct {
	LoadSpec

	CreateWriters bool // Whether or not to create users for writers
	NumWriters    int

	// How long writers should try to delay between writes
	// (subtracting out the time they are blocked during actual write)
	DelayBetweenWrites time.Duration
}

type Writer struct {
	Agent

	WriterSpec

	OutboundDocs chan []Document           // The Docfeeder pushes outbound docs to the writer
	PushedDocs   chan<- []DocumentMetadata // After docs are sent, push to this channel

}

type WriterSpec struct {

	// How long writers should try to delay between writes
	// (subtracting out the time they are blocked during actual write)
	DelayBetweenWrites time.Duration
}