artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 15:12:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

sg: shorten prefix for commands name (#37437)

Browse Source
This commit is contained in:
Jean-Hadrien Chabran 2022-06-20 19:57:54 +02:00 committed by GitHub
parent 6ab63777c6
commit 942e52f623
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 146 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
dev/sg/internal/run/logger.go
View File

@ -3,6 +3,7 @@ package run
import (
"context"
"hash/fnv"
"strconv"
"github.com/sourcegraph/sourcegraph/lib/output"
"github.com/sourcegraph/sourcegraph/lib/process"
@ -15,20 +16,39 @@ func nameToColor(s string) output.Style {
return output.Fg256Color(int(h.Sum32()) % 220)
}
var (
// NOTE: This always adds a newline, which is not always what we want. When
// we flush partial lines, we don't want to add a newline character. What
// we need to do: extend the `*output.Output` type to have a
// `WritefNoNewline` (yes, bad name) method.
//
// Some rare commands will have names larger than 'maxNameLength' chars, but
// that's fine, we'll truncate the names. How to quickly check commands names:
//
// cue eval --out=json sg.config.yaml | jq '.commands | keys'
//
maxNameLength = 15
lineFormat = "%s%s[%+" + strconv.Itoa(maxNameLength) + "s]%s %s"
)
// newCmdLogger returns a new process.Logger with a unique color based on the name of the cmd.
func newCmdLogger(ctx context.Context, name string, out *output.Output) *process.Logger {
name = compactName(name)
color := nameToColor(name)
sink := func(data string) {
// NOTE: This always adds a newline, which is not always what we want. When
// we flush partial lines, we don't want to add a newline character. What
// we need to do: extend the `*output.Output` type to have a
// `WritefNoNewline` (yes, bad name) method.
//
// About the 30 chars text justify, the longest command is 29 chars.
// How to quickly check that: cue eval --out=json sg.config.yaml | jq '.commands | keys'
out.Writef("%s%s[%+30s]%s %s", output.StyleBold, color, name, output.StyleReset, data)
out.Writef(lineFormat, output.StyleBold, color, name, output.StyleReset, data)
}
return process.NewLogger(ctx, sink)
}
func compactName(name string) string {
length := len(name)
if length > maxNameLength {
// Use the first part of the name and the very last character to hint at what's
// up, useful for long command names with index suffices (e.g. service-1, service-2)
name = name[:maxNameLength-4] + "..." + string(name[length-1])
}
return name
}

16
dev/sg/internal/run/logger_test.go Normal file
View File

@ -0,0 +1,16 @@
package run
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestCompactName(t *testing.T) {
compact := compactName("1234567890123456")
assert.Equal(t, len(compact), 15)
assert.Equal(t, "12345678901...6", compact)
unchanged := compactName("1234")
assert.Equal(t, "1234", unchanged)
}

4
dev/sg/sg_start_test.go
View File

@ -45,8 +45,8 @@ func TestStartCommandSet(t *testing.T) {
"✅ Everything installed! Booting up the system!",
"",
"Running test-cmd-1...",
"[ test-cmd-1] horsegraph booted up. mount your horse.",
"[ test-cmd-1] quitting. not horsing around anymore.",
"[ test-cmd-1] horsegraph booted up. mount your horse.",
"[ test-cmd-1] quitting. not horsing around anymore.",
"test-cmd-1 exited without error",
})
}

22
doc/dev/background-information/sg/reference.md
View File

@ -83,13 +83,9 @@ Available commands in `sg.config.yaml`:
* bext
* caddy
* codeintel-executor
* codeintel-worker
* debug-env
* docsite
* enterprise-frontend
* enterprise-repo-updater
* enterprise-symbols
* enterprise-web
* enterprise-worker
* executor-template
* frontend
* github-proxy
@ -99,8 +95,12 @@ Available commands in `sg.config.yaml`:
* loki
* minio
* monitoring-generator
* oss-frontend
* oss-repo-updater
* oss-symbols
* oss-web
* oss-worker
* postgres_exporter
* precise-code-intel-worker
* prometheus
* redis-postgres
* repo-updater
@ -112,12 +112,12 @@ Available commands in `sg.config.yaml`:
* web-standalone-http
* web-standalone-http-prod
* worker
* zoekt-indexserver-0
* zoekt-indexserver-1
* zoekt-index-0
* zoekt-index-1
* zoekt-indexserver-template
* zoekt-webserver-0
* zoekt-webserver-1
* zoekt-webserver-template
* zoekt-web-0
* zoekt-web-1
* zoekt-web-template
```sh
# Run specific commands:

178
sg.config.yaml
View File

@ -43,22 +43,22 @@ env:
SRC_PROF_HTTP: ''
SRC_PROF_SERVICES: |
[
{ "Name": "oss-frontend", "Host": "127.0.0.1:6063" },
{ "Name": "frontend", "Host": "127.0.0.1:6063" },
{ "Name": "enterprise-frontend", "Host": "127.0.0.1:6063" },
{ "Name": "gitserver", "Host": "127.0.0.1:6068" },
{ "Name": "searcher", "Host": "127.0.0.1:6069" },
{ "Name": "symbols", "Host": "127.0.0.1:6071" },
{ "Name": "oss-repo-updater", "Host": "127.0.0.1:6074" },
{ "Name": "repo-updater", "Host": "127.0.0.1:6074" },
{ "Name": "enterprise-repo-updater", "Host": "127.0.0.1:6074" },
{ "Name": "precise-code-intel-worker", "Host": "127.0.0.1:6088" },
{ "Name": "codeintel-worker", "Host": "127.0.0.1:6088" },
{ "Name": "oss-worker", "Host": "127.0.0.1:6089" },
{ "Name": "worker", "Host": "127.0.0.1:6089" },
{ "Name": "enterprise-worker", "Host": "127.0.0.1:6089" },
{ "Name": "executor-codeintel", "Host": "127.0.0.1:6092" },
{ "Name": "executor-batches", "Host": "127.0.0.1:6093" },
{ "Name": "zoekt-indexserver-0", "Host": "127.0.0.1:6072" },
{ "Name": "zoekt-indexserver-1", "Host": "127.0.0.1:6073" },
{ "Name": "zoekt-webserver-0", "Host": "127.0.0.1:3070", "DefaultPath": "/debug/requests/" },
{ "Name": "zoekt-webserver-1", "Host": "127.0.0.1:3071", "DefaultPath": "/debug/requests/" }
{ "Name": "zoekt-index-0", "Host": "127.0.0.1:6072" },
{ "Name": "zoekt-index-1", "Host": "127.0.0.1:6073" },
{ "Name": "zoekt-web-0", "Host": "127.0.0.1:3070", "DefaultPath": "/debug/requests/" },
{ "Name": "zoekt-web-1", "Host": "127.0.0.1:3071", "DefaultPath": "/debug/requests/" }
]
OVERRIDE_AUTH_SECRET: sSsNGlI8fBDftBz0LDQNXEnP6lrWdt9g0fK6hoFvGQ
# Settings/config
@ -112,13 +112,13 @@ env:
ENABLE_STREAMING_REPOS_SYNCER: true
commands:
frontend:
cmd: .bin/frontend
oss-frontend:
cmd: .bin/oss-frontend
install: |
if [ -n "$DELVE" ]; then
export GCFLAGS='all=-N -l'
fi
go build -gcflags="$GCFLAGS" -o .bin/frontend github.com/sourcegraph/sourcegraph/cmd/frontend
go build -gcflags="$GCFLAGS" -o .bin/oss-frontend github.com/sourcegraph/sourcegraph/cmd/frontend
checkBinary: .bin/frontend
env:
CONFIGURATION_MODE: server
@ -130,7 +130,7 @@ commands:
- internal
- cmd/frontend
enterprise-frontend:
frontend:
cmd: |
# TODO: This should be fixed
export SOURCEGRAPH_LICENSE_GENERATION_KEY=$(cat ../dev-private/enterprise/dev/test-license-generation-key.pem)
@ -187,19 +187,19 @@ commands:
- internal
- cmd/github-proxy
worker:
cmd: .bin/worker
oss-worker:
cmd: .bin/oss-worker
install: |
if [ -n "$DELVE" ]; then
export GCFLAGS='all=-N -l'
fi
go build -gcflags="$GCFLAGS" -o .bin/worker github.com/sourcegraph/sourcegraph/cmd/worker
go build -gcflags="$GCFLAGS" -o .bin/oss-worker github.com/sourcegraph/sourcegraph/cmd/worker
watch:
- lib
- internal
- cmd/worker
enterprise-worker:
worker:
cmd: |
export SOURCEGRAPH_LICENSE_GENERATION_KEY=$(cat ../dev-private/enterprise/dev/test-license-generation-key.pem)
.bin/worker
@ -215,20 +215,20 @@ commands:
- cmd/worker
- enterprise/cmd/worker
repo-updater:
cmd: .bin/repo-updater
oss-repo-updater:
cmd: .bin/oss-repo-updater
install: |
if [ -n "$DELVE" ]; then
export GCFLAGS='all=-N -l'
fi
go build -gcflags="$GCFLAGS" -o .bin/repo-updater github.com/sourcegraph/sourcegraph/cmd/repo-updater
checkBinary: .bin/repo-updater
go build -gcflags="$GCFLAGS" -o .bin/oss-repo-updater github.com/sourcegraph/sourcegraph/cmd/repo-updater
checkBinary: .bin/oss-repo-updater
watch:
- lib
- internal
- cmd/repo-updater
enterprise-repo-updater:
repo-updater:
cmd: .bin/enterprise-repo-updater
install: |
if [ -n "$DELVE" ]; then
@ -246,15 +246,15 @@ commands:
- enterprise/internal
- enterprise/cmd/repo-updater
symbols:
cmd: .bin/symbols
oss-symbols:
cmd: .bin/oss-symbols
install: |
if [ -n "$DELVE" ]; then
export GCFLAGS='all=-N -l'
fi
./cmd/symbols/build-ctags.sh &&
go build -gcflags="$GCFLAGS" -o .bin/symbols github.com/sourcegraph/sourcegraph/cmd/symbols
go build -gcflags="$GCFLAGS" -o .bin/oss-symbols github.com/sourcegraph/sourcegraph/cmd/symbols
checkBinary: .bin/symbols
env:
CTAGS_COMMAND: cmd/symbols/universal-ctags-dev
@ -264,7 +264,7 @@ commands:
- internal
- cmd/symbols
enterprise-symbols:
symbols:
cmd: .bin/enterprise-symbols
install: |
if [ -n "$DELVE" ]; then
@ -306,11 +306,11 @@ commands:
env:
CADDY_VERSION: 2.4.5
web:
oss-web:
cmd: ./node_modules/.bin/gulp --color dev
install: yarn --no-progress
enterprise-web:
web:
cmd: ./node_modules/.bin/gulp --color dev
install: yarn --no-progress
env:
@ -374,7 +374,7 @@ commands:
GOGC: 50
CTAGS_COMMAND: cmd/symbols/universal-ctags-dev
zoekt-indexserver-0:
zoekt-index-0:
<<: *zoekt_indexserver_template
env:
<<: *zoektenv
@ -382,7 +382,7 @@ commands:
ZOEKT_HOSTNAME_PORT: 3070
ZOEKT_LISTEN_PORT: 6072
zoekt-indexserver-1:
zoekt-index-1:
<<: *zoekt_indexserver_template
env:
<<: *zoektenv
@ -390,7 +390,7 @@ commands:
ZOEKT_HOSTNAME_PORT: 3071
ZOEKT_LISTEN_PORT: 6073
zoekt-webserver-template: &zoekt_webserver_template
zoekt-web-template: &zoekt_webserver_template
install: |
mkdir -p .bin
env GOBIN="${PWD}/.bin" go install github.com/google/zoekt/cmd/zoekt-webserver
@ -399,15 +399,15 @@ commands:
JAEGER_DISABLED: false
GOGC: 50
zoekt-webserver-0:
zoekt-web-0:
<<: *zoekt_webserver_template
cmd: env PATH="${PWD}/.bin:$PATH" .bin/zoekt-webserver -index "$HOME/.sourcegraph/zoekt/index-0" -pprof -rpc -listen "127.0.0.1:3070"
zoekt-webserver-1:
zoekt-web-1:
<<: *zoekt_webserver_template
cmd: env PATH="${PWD}/.bin:$PATH" .bin/zoekt-webserver -index "$HOME/.sourcegraph/zoekt/index-1" -pprof -rpc -listen "127.0.0.1:3071"
precise-code-intel-worker:
codeintel-worker:
cmd: .bin/precise-code-intel-worker
install: |
if [ -n "$DELVE" ]; then
@ -673,21 +673,21 @@ commandsets:
- postgres
- git
commands:
- frontend
- worker
- repo-updater
- oss-frontend
- oss-worker
- oss-repo-updater
- oss-symbols
- gitserver
- searcher
- symbols
- web
- caddy
- docsite
- syntax-highlighter
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
enterprise: &enterprise_set
requiresDevPrivate: true
@ -697,21 +697,21 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-worker
- enterprise-repo-updater
- enterprise-web
- frontend
- worker
- repo-updater
- web
- gitserver
- searcher
- enterprise-symbols
- symbols
- caddy
- docsite
- syntax-highlighter
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
enterprise-e2e:
<<: *enterprise_set
@ -733,23 +733,23 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-worker
- enterprise-repo-updater
- enterprise-web
- frontend
- worker
- repo-updater
- web
- gitserver
- searcher
- enterprise-symbols
- symbols
- caddy
- docsite
- syntax-highlighter
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
- minio
- precise-code-intel-worker
- codeintel-worker
- codeintel-executor
- jaeger
- grafana
@ -766,10 +766,10 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-worker
- enterprise-repo-updater
- enterprise-web
- frontend
- worker
- repo-updater
- web
- gitserver
- searcher
- symbols
@ -777,10 +777,10 @@ commandsets:
- docsite
- syntax-highlighter
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
env:
DISABLE_CODE_INSIGHTS_HISTORICAL: false
DISABLE_CODE_INSIGHTS: false
@ -793,17 +793,17 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-worker
- enterprise-repo-updater
- frontend
- worker
- repo-updater
- gitserver
- searcher
- symbols
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
batches:
requiresDevPrivate: true
@ -813,21 +813,21 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-worker
- enterprise-repo-updater
- enterprise-web
- frontend
- worker
- repo-updater
- web
- gitserver
- searcher
- enterprise-symbols
- symbols
- caddy
- docsite
- syntax-highlighter
- github-proxy
- zoekt-indexserver-0
- zoekt-indexserver-1
- zoekt-webserver-0
- zoekt-webserver-1
- zoekt-index-0
- zoekt-index-1
- zoekt-web-0
- zoekt-web-1
- batches-executor
iam:
@ -838,9 +838,9 @@ commandsets:
- postgres
- git
commands:
- enterprise-frontend
- enterprise-repo-updater
- enterprise-web
- frontend
- repo-updater
- web
- gitserver
- caddy
- github-proxy
@ -866,8 +866,8 @@ commandsets:
# For generated alerts docs
- docsite
# For the alerting integration with frontend
- enterprise-frontend
- enterprise-web
- frontend
- web
- caddy
web-standalone: