feat(#55): support standart input (#75)

Author: hedhyw

.golangci.json

@@ -7,8 +7,6 @@
       "bodyclose",
       "wsl",
       "funlen",
-      "maligned",
-      "exhaustivestruct",
       "gci",
       "wrapcheck",
       "varnamelen",
@@ -18,24 +16,16 @@
       "thelper",
       "paralleltest",
       "tagliatelle",
-      "scopelint",
-      "golint",
-      "interfacer",
       "nonamedreturns",
       "exhaustruct",
       "nolintlint",
-      "deadcode",
       "wastedassign",
-      "structcheck",
-      "varcheck",
-      "ifshort",
-      "nosnakecase",
       "rowserrcheck",
       "depguard",
       "ireturn",
       "gomoddirectives",
-      "tagalign",
-      "testifylint"
+      "execinquery",
+      "tagalign"
     ]
   },
   "linters-settings": {

Makefile

@@ -1,4 +1,4 @@
-GOLANG_CI_LINT_VER:=v1.55.2
+GOLANG_CI_LINT_VER:=v1.59.0
 OUT_BIN?=${PWD}/bin/jlv
 COVER_PACKAGES=./...
 VERSION?=${shell git describe --tags}
@@ -10,6 +10,11 @@ run:
 	go run ./cmd/jlv assets/example.log
 .PHONY: build
 
+run.stdin:
+	@echo "building ${VERSION}"
+	go run ./cmd/jlv < assets/example.log
+.PHONY: build
+
 build:
 	@echo "building ${VERSION}"
 	go build \

README.md

@@ -47,11 +47,34 @@ The application is designed to help in visualization, navigation, and analyzing
 
 ## Usage
 
-```sh
-jlv file.json
-jlv -config .jlv.jsonc file.json
+### Reading from file
+```shell
+jlv assets/example.log
+jlv -config example.jlv.jsonc assets/example.log
+```
+
+### Reading from Stdin
+
+```shell
+jlv < assets/example.log
+```
+
+Common applications:
+
+```shell
+curl https://raw.githubusercontent.com/hedhyw/json-log-viewer/main/assets/example.log | jlv
+
+jlv << EOF
+{"time":"1970-01-01T00:00:00.00","level":"INFO","message": "day 1"}
+{"time":"1970-01-02T00:00:00.00","level":"INFO","message": "day 2"}
+EOF
+
+kubectl logs pod/POD_NAME -f | jlv
+docker logs 000000000000 | jlv
 ```
 
+### Hotkeys
+
 | Key    | Action         |
 | ------ | -------------- |
 | Enter  | Open/Close log |

cmd/jlv/main.go

@@ -10,6 +10,9 @@ import (
 
 	"github.com/hedhyw/json-log-viewer/internal/app"
 	"github.com/hedhyw/json-log-viewer/internal/pkg/config"
+	"github.com/hedhyw/json-log-viewer/internal/pkg/source"
+	"github.com/hedhyw/json-log-viewer/internal/pkg/source/fileinput"
+	"github.com/hedhyw/json-log-viewer/internal/pkg/source/readerinput"
 )
 
 const configFileName = ".jlv.jsonc"
@@ -18,16 +21,23 @@ func main() {
 	configPath := flag.String("config", "", "Path to the config")
 	flag.Parse()
 
-	if flag.NArg() != 1 {
-		fatalf("Invalid arguments, usage: %s file.log\n", os.Args[0])
-	}
-
 	cfg, err := readConfig(*configPath)
 	if err != nil {
 		fatalf("Error reading config: %s\n", err)
 	}
 
-	appModel := app.NewModel(flag.Args()[0], cfg)
+	var sourceInput source.Input
+
+	switch flag.NArg() {
+	case 0:
+		sourceInput = readerinput.New(os.Stdin, cfg.StdinReadTimeout)
+	case 1:
+		sourceInput = fileinput.New(flag.Arg(0))
+	default:
+		fatalf("Invalid arguments, usage: %s file.log\n", os.Args[0])
+	}
+
+	appModel := app.NewModel(sourceInput, cfg)
 	program := tea.NewProgram(appModel, tea.WithAltScreen())
 
 	if _, err := program.Run(); err != nil {

example.jlv.jsonc

@@ -69,5 +69,7 @@
     "reloadThreshold": 1000000000,
     // The maximum size of the file in bytes.
     // The rest of the file will be ignored.
-    "maxFileSizeBytes": 1073741824
+    "maxFileSizeBytes": 1073741824,
+    // StdinReadTimeout is the timeout (in nanoseconds) of reading from the standart input.
+    "stdinReadTimeout": 1000000000
 }

internal/app/app.go

@@ -5,28 +5,29 @@ import (
 	"github.com/charmbracelet/lipgloss"
 
 	"github.com/hedhyw/json-log-viewer/internal/pkg/config"
+	"github.com/hedhyw/json-log-viewer/internal/pkg/source"
 )
 
 // Application global state.
 type Application struct {
-	Path   string
-	Config *config.Config
+	SourceInput source.Input
+	Config      *config.Config
 
 	BaseStyle   lipgloss.Style
 	FooterStyle lipgloss.Style
 
 	LastWindowSize tea.WindowSizeMsg
 }
 
-func newApplication(path string, config *config.Config) Application {
+func newApplication(sourceInput source.Input, config *config.Config) Application {
 	const (
 		initialWidth  = 70
 		initialHeight = 20
 	)
 
 	return Application{
-		Path:   path,
-		Config: config,
+		SourceInput: sourceInput,
+		Config:      config,
 
 		BaseStyle:   getBaseStyle(),
 		FooterStyle: getFooterStyle(),
@@ -40,6 +41,6 @@ func newApplication(path string, config *config.Config) Application {
 
 // NewModel initializes a new application model. It accept the path
 // to the file with logs.
-func NewModel(path string, config *config.Config) tea.Model {
-	return newStateInitial(newApplication(path, config))
+func NewModel(sourceInput source.Input, config *config.Config) tea.Model {
+	return newStateInitial(newApplication(sourceInput, config))
 }

internal/app/app_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/hedhyw/json-log-viewer/internal/app"
 	"github.com/hedhyw/json-log-viewer/internal/pkg/config"
+	"github.com/hedhyw/json-log-viewer/internal/pkg/source/fileinput"
 	"github.com/hedhyw/json-log-viewer/internal/pkg/tests"
 )
 
@@ -18,7 +19,7 @@ func newTestModel(tb testing.TB, content []byte) tea.Model {
 
 	testFile := tests.RequireCreateFile(tb, content)
 
-	model := app.NewModel(testFile, config.GetDefaultConfig())
+	model := app.NewModel(fileinput.New(testFile), config.GetDefaultConfig())
 	model = handleUpdate(model, model.Init()())
 
 	return model

internal/app/helper.go

@@ -1,6 +1,8 @@
 package app
 
 import (
+	"context"
+	"errors"
 	"fmt"
 	"runtime"
 	"strings"
@@ -20,11 +22,9 @@ type helper struct {
 	Application
 }
 
+// LoadEntries reads and parses entries from the input source.
 func (h helper) LoadEntries() tea.Msg {
-	logEntries, err := source.LoadLogsFromFile(
-		h.Path,
-		h.Config,
-	)
+	logEntries, err := h.loadEntriesFromSourceInput()
 	if err != nil {
 		return events.ErrorOccuredMsg{Err: err}
 	}
@@ -34,6 +34,27 @@ func (h helper) LoadEntries() tea.Msg {
 	return events.LogEntriesLoadedMsg(logEntries)
 }
 
+func (h helper) loadEntriesFromSourceInput() (logEntries source.LazyLogEntries, err error) {
+	ctx := context.Background()
+
+	readCloser, err := h.SourceInput.ReadCloser(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("readcloser: %w", err)
+	}
+
+	defer func() { err = errors.Join(err, readCloser.Close()) }()
+
+	logEntries, err = source.ParseLogEntriesFromReader(
+		readCloser,
+		h.Config,
+	)
+	if err != nil {
+		return nil, fmt.Errorf("reading logs: %w", err)
+	}
+
+	return logEntries, nil
+}
+
 func (h helper) getLogLevelStyle(
 	logEntries source.LazyLogEntries,
 	baseStyle lipgloss.Style,

internal/app/logstable.go

@@ -54,7 +54,7 @@ func newLogsTableModel(application Application, logEntries source.LazyLogEntries
 		minRenderedRows: application.Config.PrerenderRows,
 		allEntries:      logEntries,
 		lastCursor:      0,
-		renderedRows:    make([]table.Row, 0, application.Config.PrerenderRows*2),
+		renderedRows:    make([]table.Row, 0, application.Config.PrerenderRows),
 	}.withRenderedRows()
 
 	return logsTableModel{
@@ -90,12 +90,15 @@ func (m logsTableModel) Update(msg tea.Msg) (logsTableModel, tea.Cmd) {
 }
 
 func (m logsTableModel) handleWindowSizeMsg(msg tea.WindowSizeMsg) logsTableModel {
-	const heightOffset = 4
+	const (
+		heightOffset = 4
+		widthOffset  = -10
+	)
 
 	x, y := m.BaseStyle.GetFrameSize()
 	m.lazyTable.table.SetWidth(msg.Width - x*2)
 	m.lazyTable.table.SetHeight(msg.Height - y*2 - footerSize - heightOffset)
-	m.lazyTable.table.SetColumns(getColumns(m.lazyTable.table.Width()-10, m.Config))
+	m.lazyTable.table.SetColumns(getColumns(m.lazyTable.table.Width()+widthOffset, m.Config))
 	m.lastWindowSize = msg
 
 	return m

internal/app/statefiltering_test.go

@@ -136,7 +136,7 @@ func TestStateFilteringReset(t *testing.T) {
 		rendered := model.View()
 
 		index := strings.Index(rendered, "filtered 0 by:")
-		if assert.Greater(t, index, 0) {
+		if assert.Positive(t, index) {
 			rendered = rendered[:index]
 		}