Change:

• added RenderRawMessage func
• added Write func for satisfying io.Writer interface

Reason:

For some functions, need to pass io.Writer. For example:

func DisplayJSONMessagesStream(in io.Reader, out io.Writer, terminalFd uintptr, isTerminal bool, auxCallback func(JSONMessage))

Changes

• ~Add new func NewSimpleRendererWithoutColor~
• Add new color schema NoColorSchema()
• Change FinishTypeFailed color from NeutralColor to FailureColor (if this intended, I will change this back)

Reason

Using current NewSimpleRenderer, if we pipe or log it to file it will print the ANSI color codes.

So for my use case, I want to use NewInteractiveRenderer in my development and use NewSimpleRenderer in the production but it will print ANSI color codes in the log.

~Here is the result if we use NewSimpleRendererWithoutColor.~ Now we can use it like this

import (
	"github.com/cirruslabs/echelon/renderers"
	"github.com/cirruslabs/echelon/terminal"
)

renderers.NewSimpleRenderer(os.Stdout, terminal.NoColorSchema())

Thank you

I have some unit tests on some code that uses echelon and it spit this out with -race.

Looks like the len(node.Children) at https://github.com/cirruslabs/echelon/blob/master/renderers/internal/node/echelone_node.go#L134 needs to be protected by mutex.

==================
WARNING: DATA RACE
Write at 0x00c0001386a8 by goroutine 10:
  github.com/cirruslabs/echelon/renderers/internal/node.(*EchelonNode).FindOrCreateChild()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/internal/node/echelone_node.go:194 +0x2bd
  github.com/cirruslabs/echelon/renderers.findScopedNode()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/interactive.go:43 +0xb0
  github.com/cirruslabs/echelon/renderers.(*InteractiveRenderer).RenderScopeStarted()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/interactive.go:49 +0x67
  github.com/cirruslabs/echelon.(*Logger).streamEntries()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/logger.go:46 +0x182

Previous read at 0x00c0001386a8 by goroutine 9:
  github.com/cirruslabs/echelon/renderers/internal/node.(*EchelonNode).fancyTitle()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/internal/node/echelone_node.go:134 +0x82
  github.com/cirruslabs/echelon/renderers/internal/node.(*EchelonNode).Render()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/internal/node/echelone_node.go:100 +0x6a
  github.com/cirruslabs/echelon/renderers.(*InteractiveRenderer).DrawFrame()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/interactive.go:94 +0x1aa
  github.com/cirruslabs/echelon/renderers.(*InteractiveRenderer).StartDrawing()
      /data/app/kochiku-worker/go/pkg/mod/github.com/cirruslabs/[email protected]/renderers/interactive.go:75 +0x74
=================

There is no logic in NewInteractiveRenderer() that depends on out being a file, but unfortunately this can't be changed without a 2.x release. Can an additional function be added to handle this case? I can submit the PR for it

func NewInteractiveRenderer2(out io.Writer, rendererConfig *config.InteractiveRendererConfig) *InteractiveRenderer

Seems there is an issue when terminal window doesn't have too many lines available. Reported from this Reddit comment:

Ah echelon tries to keep the job levels at the top of the currently-visible portion of the console, this is interesting. This only is an issue in case there are too many log lines. This makes the output very ugly though, apart from the last few lines. Just try the demo with passing false to all log.Finish calls.

Example for the issue:

🕒 Job 1 37s
🕒 Job 1 38s
   ❌ Job 4 8.0s
🕒 Job 1 39s
      Doing very important jobs! Completed 25/100...
🕒 Job 1 40s
🕒 Job 1 41s
🕒 Job 1 42s
🕒 Job 1 43s
      Doing very important jobs! Completed 87/100...
🕒 Job 1 44s
      
🕒 Job 1 45s
🕒 Job 1 46s
🕒 Job 1 47s
🕒 Job 1 48s
🕒 Job 1 49s
   ❌ Job 8 9.0s

Issue

Using current NewSimpleRenderer, if we pipe or log it to file it will print the ANSI color codes.

So for my use case, I want to use NewInteractiveRenderer in my development and use NewSimpleRenderer in the production but it will print ANSI color codes in the log.

Expected

Related PR #18.

Right now it's only possible to configure colors and progress indicator. Once there are more cases of echelon usage we need think of a generic way for customization of scope statuses. (replace ✅ and ❌ with something different)

See https://github.com/cirruslabs/cirrus-cli/issues/489.

The rest is implemented on the CLI's side: https://github.com/cirruslabs/cirrus-cli/pull/500.

Since it's not allowed to recursively use RWMutex let's make a contract that only public methods can acquire it and private methods can't use it.

Fixes race in #14

Otherwise the last few bytes might not get written. The last fix https://github.com/cirruslabs/echelon/pull/12 didn't always work because the buffer might not get flushed before exiting.