utils

Documentation

Index

• Variables
• func BuildRequestPayload(signature string, payload map[string]interface{}) *bytes.Buffer
• func CombineErrors(errors ...error) error
• func CombineErrorsWithPrefix(prefix string, errors ...error) error
• func DebugDumpJSON(msg string, d interface{})
• func DebugDumpViper()
• func DisplayProfileData()
• func EnsureDirectoryPermission(directoryPath string) error
• func FailOnError(err error)
• func FailOnErrorWithMessage(err error, message string)
• func FileHash(filePath string) (string, error)
• func FindProcess(targetPid int) (*psutils.Process, error)
• func GetMD5Hash(text string) string
• func HandleCancelError(err error) error
• func IsCancelledError(err error) bool
• func IsContextCancelled(ctx context.Context) bool
• func IsWSL() (bool, error)
• func LogTime(operation string)
• func PidExists(targetPid int) (bool, error)
• func Pluralize(base string, count int) string
• func PrefixError(err error, prefix string) error
• func RemoveDirectoryContents(removePath string) error
• func SendRequest(signature string, method string, sendRequestTo url.URL, payload *bytes.Buffer) (*http.Response, error)
• func ShowError(err error)
• func ShowErrorWithMessage(err error, message string)
• func ShowWarning(warning string)
• func StringHash(s string) uint32
• func ToStringPointer(s string) *string
• func TransformErrorToSteampipe(err error) error
• type ExitCode
• type FileWatcher
  • func NewWatcher(opts *WatcherOptions) (*FileWatcher, error)
  • func (w *FileWatcher) Close()
• type InteractiveExitStatus
• type LifecycleEvent
• type LifecycleTimer
  • func NewLifecycleTimer() *LifecycleTimer
  • func (r *LifecycleTimer) Add(event string)
  • func (r LifecycleTimer) GetDuration() time.Duration
• type WatcherOptions

Variables

var Timing []timeLog

Functions

func BuildRequestPayload

func BuildRequestPayload(signature string, payload map[string]interface{}) *bytes.Buffer

BuildRequestPayload :: merges the provided payload with the standard payload that needs to be sent

func CombineErrors

func CombineErrors(errors ...error) error

func CombineErrorsWithPrefix

func CombineErrorsWithPrefix(prefix string, errors ...error) error

func DebugDumpJSON

func DebugDumpJSON(msg string, d interface{})

functions specifically used for Debugging purposes.

func DebugDumpViper

func DebugDumpViper()

func DisplayProfileData

func DisplayProfileData()

func EnsureDirectoryPermission

func EnsureDirectoryPermission(directoryPath string) error

func FailOnError

func FailOnError(err error)

func FailOnErrorWithMessage

func FailOnErrorWithMessage(err error, message string)

func FileHash

func FileHash(filePath string) (string, error)

func FindProcess

func FindProcess(targetPid int) (*psutils.Process, error)

func GetMD5Hash

func GetMD5Hash(text string) string

func HandleCancelError

func HandleCancelError(err error) error

HandleCancelError modifies a context.Canceled error into a readable error that can be printed on the console

func IsCancelledError

func IsCancelledError(err error) bool

func IsContextCancelled

func IsContextCancelled(ctx context.Context) bool

func IsWSL

func IsWSL() (bool, error)

IsWSL :: detects whether app is running in WSL environment refer to: https://github.com/Microsoft/WSL/issues/423#issuecomment-679190758

func LogTime

func LogTime(operation string)

func PidExists

func PidExists(targetPid int) (bool, error)

PidExists scans through the list of PIDs in the system and checks for the `targetPID`.

PidExists uses iteration, instead of signalling, since we have observed that signalling does not always work reliably when the destination of the signal is a child of the source of the signal - which may be the case then starting implicit services

func Pluralize

func Pluralize(base string, count int) string

Pluralize :: pluralizes a word (if applicable) based on provided count

func PrefixError

func PrefixError(err error, prefix string) error

func RemoveDirectoryContents

func RemoveDirectoryContents(removePath string) error

func SendRequest

func SendRequest(signature string, method string, sendRequestTo url.URL, payload *bytes.Buffer) (*http.Response, error)

SendRequest ::

func ShowError

func ShowError(err error)

func ShowErrorWithMessage

func ShowErrorWithMessage(err error, message string)

ShowErrorWithMessage displays the given error nicely with the given message

func ShowWarning

func ShowWarning(warning string)

func StringHash

func StringHash(s string) uint32

func ToStringPointer

func ToStringPointer(s string) *string

ToStringPointer converts a string into its pointer

func TransformErrorToSteampipe

func TransformErrorToSteampipe(err error) error

TransformErrorToSteampipe removes the pq: and rpc error prefixes along with all the unnecessary information that comes from the drivers and libraries

Types

type ExitCode

type ExitCode int

ExitCode :: alias for exitcode

type FileWatcher

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

func NewWatcher

func NewWatcher(opts *WatcherOptions) (*FileWatcher, error)

func (*FileWatcher) Close

func (w *FileWatcher) Close()

type InteractiveExitStatus

type InteractiveExitStatus struct {
	// TODO remove altogether
	ExitCode int
}

InteractiveExitStatus :: exist status from the interative prompt

We exit go-prompt after every query (in order to manage the prompt history to only include complete queries) We therefore need to distinguish between:

a user requested exit (ctrl+D or .exit) - indicated by a non-nil exit code and restart=false and a value , go-prompt being terminated after a query completion and requiring restarting - indicated by restart=true

type LifecycleEvent

type LifecycleEvent struct {
	Event string
	Time  time.Time
}

type LifecycleTimer

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

LifecycleTimer records the time for lifecycle events

func NewLifecycleTimer

func NewLifecycleTimer() *LifecycleTimer

func (*LifecycleTimer) Add

func (r *LifecycleTimer) Add(event string)

func (LifecycleTimer) GetDuration

func (r LifecycleTimer) GetDuration() time.Duration

GetDuration returns the duration between two events - if both exist

type WatcherOptions

type WatcherOptions struct {
	Directories []string
	Include     []string
	Exclude     []string
	OnChange    func([]fsnotify.Event)
	OnError     func(error)
	ListFlag    filehelpers.ListFlag
}