upload

type DirectUploadToken struct {
	// ID identifies the file location uploaded to this server directly.
	ID string `json:"id"`
}

type DirectWritableUploadFileStoreProvider interface {
	// Write writes file data from the given reader to the file identified by token.
	Write(token UploadToken, reader io.Reader) error

	// GetDestinationPath returns the absolute file system path for storing the uploaded file.
	GetDestinationPath(token UploadToken) (string, error)
}

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

type InPlaceUploadFileStoreProvider struct{}

type JSONLineUploadFileVerifier struct {
	MaxLineSizeInBytes int
}

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

type LocalFileUploadToken struct {
	// FilePath identifies the file location uploaded to this server locally.
	FilePath string `json:"filepath"`
}

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

type NopWaitUploadFileVerifier struct {
	// WaitTimeInMs is the time to wait before returning the veification result.
	WaitTimeInMs int
	// Error is the error returned from Verify function after waiting the WaitTimeInMs.
	Error error
}

type Store interface {
	GetUploadToken(id string, verifier UploadFileVerifier, fieldID string) UploadToken
	GetResult(token UploadToken, req map[string]any) (UploadResult, error)
	// GetCompletedResult waits for asynchronous verification to complete if the file has been uploaded,
	// or returns the current non-completed status immediately if upload transfer is still pending or in progress.
	GetCompletedResult(ctx context.Context, token UploadToken, req map[string]any) (UploadResult, error)
}

type UploadFileStore struct {
	StoreProvider UploadFileStoreProvider
	// contains filtered or unexported fields
}

type UploadFileStoreProvider interface {
	// GetUploadToken generates an UploadToken for the given ID.
	GetUploadToken(id string) UploadToken

	// Read returns the io.ReadCloser to read the file with the given token.
	// The caller MUST close the returned ReadCloser.
	Read(token UploadToken) (io.ReadCloser, error)
}

type UploadFileVerifier interface {
	// Verify checks the file. This returns an error if invalid.
	Verify(storeProvider UploadFileStoreProvider, token UploadToken) error
}

type UploadResult struct {
	// Token is an UploadToken associated with the file.
	Token UploadToken
	// StoreProvider provides the way of getting the uploaded file with the given token.
	StoreProvider UploadFileStoreProvider
	// Status is the current state of the upload.
	Status UploadStatus
	// UploadError contains any error that occurred during the upload process itself
	UploadError error
	// VerificationError contains any error returned by the UploadFileVerifier.
	VerificationError error
	// VerificationCount is the attempt count of the verification logic. This value is preventing the race condition in verification steps.
	VerificationCount int
}

type UploadStatus int

type UploadToken interface {
	// GetType returns the type of token specifying the methods to upload the file.
	GetType() string
	// GetID returns the unique identifier of upload files.
	GetID() string
	// GetHash returns a unique string calculated from all the field of the implementation.
	// This must be calculated from ALL the field because this is for checking if 2 instances are identical.
	GetHash() string
}