feat: support progressed output in blob push and blob get

cmd/oras/internal/display/console/console.go

@@ -0,0 +1,90 @@
+/*
+Copyright The ORAS Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package console
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/containerd/console"
+	"github.com/morikuni/aec"
+)
+
+// MinialWidth is the minimal width of supported console.
+const MinialWidth = 80
+
+// MinialHeight is the minimal height of supported console.
+const MinialHeight = 10
+
+// Console is a wrapper around containerd's console.Console and ANSI escape
+// codes.
+type Console struct {
+	console.Console
+}
+
+// Size returns the width and height of the console.
+// If the console size cannot be determined, returns a default value of 80x10.
+func (c *Console) Size() (width, height int) {
+	width = MinialWidth
+	height = MinialHeight
+	size, err := c.Console.Size()
+	if err == nil && size.Height > MinialHeight && size.Width > MinialWidth {
+		width = int(size.Width)
+		height = int(size.Height)
+	}
+	return
+}
+
+// GetConsole returns a Console from a file.
+func GetConsole(f *os.File) (*Console, error) {
+	c, err := console.ConsoleFromFile(f)
+	if err != nil {
+		return nil, err
+	}
+	return &Console{c}, nil
+}
+
+// Save saves the current cursor position.
+func (c *Console) Save() {
+	fmt.Fprint(c, aec.Hide)
+	// cannot use aec.Save since DEC has better compatilibity than SCO
+	fmt.Fprint(c, "\0337")
+}
+
+// NewRow allocates a horizontal space to the output area with scroll if needed.
+func (c *Console) NewRow() {
+	// cannot use aec.Restore since DEC has better compatilibity than SCO
+	fmt.Fprint(c, "\0338")
+	fmt.Fprint(c, "\n")
+	fmt.Fprint(c, "\0337")
+}
+
+// OutputTo outputs a string to a specific line.
+func (c *Console) OutputTo(upCnt uint, str string) {
+	fmt.Fprint(c, "\0338")
+	fmt.Fprint(c, aec.PreviousLine(upCnt))
+	fmt.Fprint(c, str+" ")
+	fmt.Fprint(c, aec.EraseLine(aec.EraseModes.Tail))
+}
+
+// Restore restores the saved cursor position.
+func (c *Console) Restore() {
+	// cannot use aec.Restore since DEC has better compatilibity than SCO
+	fmt.Fprint(c, "\0338")
+	fmt.Fprint(c, aec.Column(0))
+	fmt.Fprint(c, aec.EraseLine(aec.EraseModes.All))
+	fmt.Fprint(c, aec.Show)
+}

cmd/oras/internal/display/console/console_test.go

@@ -0,0 +1,61 @@
+/*
+Copyright The ORAS Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package console
+
+import (
+	"testing"
+
+	"github.com/containerd/console"
+)
+
+func validateSize(t *testing.T, gotWidth, gotHeight, wantWidth, wantHeight int) {
+	t.Helper()
+	if gotWidth != wantWidth {
+		t.Errorf("Console.Size() gotWidth = %v, want %v", gotWidth, wantWidth)
+	}
+	if gotHeight != wantHeight {
+		t.Errorf("Console.Size() gotHeight = %v, want %v", gotHeight, wantHeight)
+	}
+}
+
+func TestConsole_Size(t *testing.T) {
+	pty, _, err := console.NewPty()
+	if err != nil {
+		t.Fatal(err)
+	}
+	c := &Console{
+		Console: pty,
+	}
+
+	// minimal width and height
+	gotWidth, gotHeight := c.Size()
+	validateSize(t, gotWidth, gotHeight, MinialWidth, MinialHeight)
+
+	// zero width
+	_ = pty.Resize(console.WinSize{Width: 0, Height: MinialHeight})
+	gotWidth, gotHeight = c.Size()
+	validateSize(t, gotWidth, gotHeight, MinialWidth, MinialHeight)
+
+	// zero height
+	_ = pty.Resize(console.WinSize{Width: MinialWidth, Height: 0})
+	gotWidth, gotHeight = c.Size()
+	validateSize(t, gotWidth, gotHeight, MinialWidth, MinialHeight)
+
+	// valid zero and height
+	_ = pty.Resize(console.WinSize{Width: 200, Height: 100})
+	gotWidth, gotHeight = c.Size()
+	validateSize(t, gotWidth, gotHeight, 200, 100)
+}

cmd/oras/internal/display/progress/manager.go

@@ -0,0 +1,149 @@
+/*
+Copyright The ORAS Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package progress
+
+import (
+	"os"
+	"sync"
+	"time"
+
+	"oras.land/oras/cmd/oras/internal/display/console"
+)
+
+const BUFFER_SIZE = 20
+
+// Status is print message channel
+type Status chan<- *status
+
+// Manager is progress view master
+type Manager interface {
+	Add() Status
+	StopAndWait()
+}
+
+const (
+	bufFlushDuration = 100 * time.Millisecond
+)
+
+type manager struct {
+	statuses   []*status
+	rwLock     sync.RWMutex
+	renderTick *time.Ticker
+	c          *console.Console
+	updating   sync.WaitGroup
+	mu         sync.Mutex
+	close      sync.Once
+	// done used to stop render routine
+	// doneDone used to mark render routine stopped
+	done     chan struct{}
+	doneDone chan struct{}
+}
+
+// NewManager initialized a new progress manager.
+func NewManager(f *os.File) (Manager, error) {
+	var m manager
+	var err error
+
+	m.c, err = console.GetConsole(f)
+	if err != nil {
+		return nil, err
+	}
+	m.done = make(chan struct{})
+	m.doneDone = make(chan struct{})
+	m.renderTick = time.NewTicker(bufFlushDuration)
+	m.start()
+	return &m, nil
+}
+
+func (m *manager) start() {
+	m.renderTick.Reset(bufFlushDuration)
+	m.c.Save()
+	go func() {
+		for {
+			m.render()
+			select {
+			case <-m.done:
+				close(m.doneDone)
+				return
+			case <-m.renderTick.C:
+			}
+		}
+	}()
+}
+
+func (m *manager) render() {
+	m.mu.Lock()
+	defer m.mu.Unlock()
+	// todo: update size in another routine
+	width, height := m.c.Size()
+	len := len(m.statuses) * 2
+	offset := 0
+	if len > height {
+		// skip statuses that cannot be rendered
+		offset = len - height
+	}
+
+	for ; offset < len; offset += 2 {
+		m.rwLock.RLock()
+		status, progress := m.statuses[offset/2].String(width)
+		m.rwLock.RUnlock()
+		m.c.OutputTo(uint(len-offset), status)
+		m.c.OutputTo(uint(len-offset-1), progress)
+	}
+}
+
+// Add appends a new status with 2-line space for rendering.
+func (m *manager) Add() Status {
+	m.mu.Lock()
+	defer m.mu.Unlock()
+	id := len(m.statuses)
+	m.statuses = append(m.statuses, nil)
+	defer m.c.NewRow()
+	defer m.c.NewRow()
+	return m.newStatus(id)
+}
+
+func (m *manager) newStatus(id int) Status {
+	ch := make(chan *status, BUFFER_SIZE)
+	m.updating.Add(1)
+	go m.update(ch, id)
+	return ch
+}
+
+func (m *manager) update(ch chan *status, id int) {
+	defer m.updating.Done()
+	for s := range ch {
+		m.rwLock.Lock()
+		m.statuses[id] = m.statuses[id].Update(s)
+		m.rwLock.Unlock()
+	}
+}
+
+// StopAndWait stops all status and waits for updating and rendering.
+func (m *manager) StopAndWait() {
+	// 1. stop periodic render
+	m.renderTick.Stop()
+	close(m.done)
+	defer m.close.Do(func() {
+		// 4. restore cursor, mark done
+		m.c.Restore()
+	})
+	// 2. wait for all model update done
+	m.updating.Wait()
+	// 3. render last model
+	<-m.doneDone
+	m.render()
+}

cmd/oras/internal/display/progress/mark.go

@@ -0,0 +1,31 @@
+/*
+Copyright The ORAS Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package progress
+
+var (
+	spinner    = []rune("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏")
+	spinnerLen = len(spinner)
+	spinnerPos = 0
+)
+
+// GetMark returns the rune of status mark.
+func GetMark(s *status) rune {
+	if s.done {
+		return '√'
+	}
+	spinnerPos = (spinnerPos + 1) % spinnerLen
+	return spinner[spinnerPos/2]
+}