Refactor/project structure (#3)

* feat: removed duplicate log and log broadcasts

* feat: updated readmes

* refactor: renamed backend and web client to gmus-backend and gmus-web

* feat: always set GO_ENV=development in make dev commands

* fix: test directories

* fix: formatting

* fix: header size

Makefile

@@ -8,10 +8,11 @@ build:
 	make build.frontend
 
 test.backend:
-	cd music-player && make test
-test.frontend:
-	cd gmus && yarn test
+	cd gmus-backend && make test
+
+test.frontend.web:
+	cd gmus-web && yarn test
 
 test:
 	make test.backend
-	make test.frontend
+	make test.frontend.web

README.md

@@ -1,2 +1,37 @@
-# go-music-player
+# go-music-player (gmus)
 
+## Backend
+
+This manages the music library database, serves requests and handles client connections.
+
+For more info, see the [readme](./gmus-backend/README.md).
+
+## Frontend clients
+
+Each frontend implements the APIs provided by the backend. Their job is to play music, or control the master client. The following clients are implemented:
+
+- [gmus-web](./gmus-web/README.md) - web client
+
+## Architecture
+
+### Database
+
+This is PostgreSQL. It is responsible for storing the music files and their metadata.
+
+### PubSub
+
+This is implemented in Go using Redis. It is responsible for coordinating state between clients. Note that the only state which is stored on the backend is the list of clients currently connected.
+
+### API
+
+This is an HTTP API written in Go. It is responsible for implementing the PubSub, as well as serving data to the clients. The API may be running in multiple redundant containers.
+
+### Scanner
+
+This keeps the database up-to-date, based on a directory containing music files.
+
+### Clients
+
+Each client connects to the API. One client is "master", while all others are "slave". Master is responsible for playing the music, and keeping other clients up-to-date through the socket.
+
+There is no authentication - all clients are trusted equally. Clients may take over master status whenever they want. Master must obey this instruction. Clients are responsible for providing unique names when connecting.

music-player/Makefile → gmus-backend/Makefile

@@ -14,7 +14,7 @@ clean:
 	mkdir -p bin && rm -rf ./bin/*
 
 fmt:
-	go fmt github.com/felamaslen/go-music-player/...
+	go fmt github.com/felamaslen/gmus-backend/...
 
 test:
 	GO_ENV=test ginkgo ./...
@@ -25,6 +25,6 @@ migrate.make:
 	migrate create -ext sql -dir migrations -seq $(NAME)
 
 run.scan:
-	go run ./cmd/scan
+	GO_ENV=development go run ./cmd/scan
 run.server:
-	go run ./cmd/server
+	GO_ENV=development go run ./cmd/server

music-player/README.md → gmus-backend/README.md

@@ -1,4 +1,4 @@
-# music-scanner
+# gmus-backend
 
 This is the backend part of the music player, written in Golang.
 
@@ -36,6 +36,38 @@ After getting the [migrate CLI tool](https://github.com/golang-migrate/migrate/t
 
 This is intended to be run as a scheduled job. It will scan a directory and add relevant metadata to a PostgreSQL database.
 
-**Usage**
+**Development usage**
 
-`bin/scan`
+`make run.scan`
+
+### REST/WebSocket API
+
+**Development usage**
+
+`make run.server`
+
+This is an HTTP server running the following endpoints:
+
+#### `GET /stream?songid=<id>`
+
+Streams an audio file based on the `songid` value in the query string.
+
+####  `GET /pubsub`
+
+Handles long-running client connections, initiating a websocket.
+
+#### `GET /artists`
+
+Fetches all artists, and outputs them in JSON format.
+
+#### `GET /albums?artist=<artist>`
+
+Fetches albums for a particular artist, and outputs them in JSON format.
+
+#### `GET /songs?artist=<artist>`
+
+Fetches songs for a particular artist, and outputs them in JSON format.
+
+#### `GET /song-info?id=<id>`
+
+Fetches info for a particular song, based on its ID, and outputs it in JSON format.

music-player/cmd/migrate/main.go → gmus-backend/cmd/migrate/main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/felamaslen/go-music-player/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/database"
 )
 
 func main() {

music-player/cmd/scan/main.go → gmus-backend/cmd/scan/main.go

@@ -1,9 +1,9 @@
 package main
 
 import (
-	"github.com/felamaslen/go-music-player/pkg/config"
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/services"
+	"github.com/felamaslen/gmus-backend/pkg/config"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/services"
 )
 
 func main() {

music-player/cmd/server/main.go → gmus-backend/cmd/server/main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/felamaslen/go-music-player/pkg/server"
+	"github.com/felamaslen/gmus-backend/pkg/server"
 )
 
 func main() {

music-player/go.mod → gmus-backend/go.mod

@@ -1,4 +1,4 @@
-module github.com/felamaslen/go-music-player
+module github.com/felamaslen/gmus-backend
 
 go 1.15
 

music-player/pkg/config/config.go → gmus-backend/pkg/config/config.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/joho/godotenv"
 
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 )
 
 var envLoaded = false

music-player/pkg/database/main.go → gmus-backend/pkg/database/main.go

@@ -10,7 +10,7 @@ import (
 	_ "github.com/golang-migrate/migrate/v4/database/postgres"
 	_ "github.com/golang-migrate/migrate/v4/source/file"
 
-	config "github.com/felamaslen/go-music-player/pkg/config"
+	config "github.com/felamaslen/gmus-backend/pkg/config"
 
 	_ "github.com/jackc/pgx/stdlib"
 	"github.com/jmoiron/sqlx"

music-player/pkg/read/audio.go → gmus-backend/pkg/read/audio.go

@@ -5,7 +5,7 @@ import (
 	"path/filepath"
 
 	tag "github.com/dhowden/tag"
-	duration "github.com/felamaslen/go-music-player/pkg/read/duration"
+	duration "github.com/felamaslen/gmus-backend/pkg/read/duration"
 )
 
 func ReadFile(basePath string, scannedFile *File) (song *Song, err error) {

music-player/pkg/read/audio_test.go → gmus-backend/pkg/read/audio_test.go

@@ -7,8 +7,8 @@ import (
 	"os"
 	"path"
 
-	"github.com/felamaslen/go-music-player/pkg/read"
-	_ "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	_ "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("reading audio files", func() {

music-player/pkg/read/duration/vorbis_test.go → gmus-backend/pkg/read/duration/vorbis_test.go

@@ -6,8 +6,8 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	"github.com/felamaslen/go-music-player/pkg/read/duration"
-	_ "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/read/duration"
+	_ "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("Reading ogg vorbis duration", func() {

music-player/pkg/read/files.go → gmus-backend/pkg/read/files.go

@@ -4,9 +4,9 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	config "github.com/felamaslen/go-music-player/pkg/config"
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	config "github.com/felamaslen/gmus-backend/pkg/config"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/jmoiron/sqlx"
 	"github.com/lib/pq"
 )

music-player/pkg/read/files_test.go → gmus-backend/pkg/read/files_test.go

@@ -7,9 +7,9 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/read"
-	setup "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	setup "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("reading files", func() {

music-player/pkg/repository/songs.go → gmus-backend/pkg/repository/songs.go

@@ -3,7 +3,7 @@ package repository
 import (
 	"errors"
 
-	"github.com/felamaslen/go-music-player/pkg/read"
+	"github.com/felamaslen/gmus-backend/pkg/read"
 	"github.com/jmoiron/sqlx"
 	"github.com/lib/pq"
 )

music-player/pkg/repository/songs_test.go → gmus-backend/pkg/repository/songs_test.go

@@ -4,10 +4,10 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/read"
-	"github.com/felamaslen/go-music-player/pkg/repository"
-	setup "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	"github.com/felamaslen/gmus-backend/pkg/repository"
+	setup "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("songs repository", func() {

music-player/pkg/server/actions.go → gmus-backend/pkg/server/actions.go

@@ -3,6 +3,7 @@ package server
 import (
 	"encoding/json"
 
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/go-redis/redis/v7"
 )
 
@@ -19,10 +20,11 @@ type Action struct {
 	Payload    interface{} `json:"payload"`
 }
 
-func broadcastAction(thisPodClients *map[string]*Client, action *Action) []error {
+func broadcastAction(l *logger.Logger, thisPodClients *map[string]*Client, action *Action) []error {
 	var errors []error
 
 	for _, client := range *thisPodClients {
+		l.Debug("[->Client] %s (%s)\n", action.Type, client.name)
 		if err := client.send(action); err != nil {
 			errors = append(errors, err)
 		}

music-player/pkg/server/clients.go → gmus-backend/pkg/server/clients.go

@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/go-redis/redis/v7"
 )
 
@@ -97,8 +97,6 @@ func (c *Client) subscribeToMe(l *logger.Logger, rdb *redis.Client) {
 			})
 			c.exposeToNetwork(l, rdb)
 		} else {
-			l.Debug("[->Client] %s (%s)\n", actionFromClient.Type, c.name)
-
 			actionFromClient.FromClient = &c.name
 
 			if err := publishAction(rdb, &actionFromClient); err != nil {

music-player/pkg/server/fetch.go → gmus-backend/pkg/server/fetch.go

@@ -5,10 +5,10 @@ import (
 	"net/http"
 	"strconv"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/logger"
-	"github.com/felamaslen/go-music-player/pkg/read"
-	"github.com/felamaslen/go-music-player/pkg/repository"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	"github.com/felamaslen/gmus-backend/pkg/repository"
 	"github.com/go-redis/redis/v7"
 )
 

music-player/pkg/server/handler.go → gmus-backend/pkg/server/handler.go

@@ -3,7 +3,7 @@ package server
 import (
 	"net/http"
 
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/go-redis/redis/v7"
 )
 

music-player/pkg/server/pubsub.go → gmus-backend/pkg/server/pubsub.go

@@ -6,7 +6,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/go-redis/redis/v7"
 	"github.com/gorilla/mux"
 	"github.com/gorilla/websocket"
@@ -94,7 +94,7 @@ func subscribeToBroadcast(
 					l.Debug("[<-Client] %s (%s)\n", actionFromPubsub.Type, *actionFromPubsub.FromClient)
 				}
 
-				errors := broadcastAction(thisPodClients, &actionFromPubsub)
+				errors := broadcastAction(l, thisPodClients, &actionFromPubsub)
 
 				if len(errors) > 0 {
 					l.Warn("Error broadcasting: %v\n", errors)

music-player/pkg/server/server.go → gmus-backend/pkg/server/server.go

@@ -5,8 +5,8 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/felamaslen/go-music-player/pkg/config"
-	"github.com/felamaslen/go-music-player/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/config"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
 	"github.com/go-redis/redis/v7"
 	"github.com/gorilla/mux"
 	"github.com/rs/cors"

music-player/pkg/server/stream.go → gmus-backend/pkg/server/stream.go

@@ -7,9 +7,9 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/logger"
-	"github.com/felamaslen/go-music-player/pkg/repository"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/repository"
 	"github.com/go-redis/redis/v7"
 )
 

music-player/pkg/services/fetch.go → gmus-backend/pkg/services/fetch.go

@@ -1,8 +1,8 @@
 package services
 
 import (
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/repository"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/repository"
 )
 
 func GetArtists(limit int, page int) (artists *[]string, more bool) {

music-player/pkg/services/fetch_test.go → gmus-backend/pkg/services/fetch_test.go

@@ -7,9 +7,9 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/services"
-	setup "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/services"
+	setup "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("Fetching data", func() {

music-player/pkg/services/scanner.go → gmus-backend/pkg/services/scanner.go

@@ -1,11 +1,11 @@
 package services
 
 import (
-	"github.com/felamaslen/go-music-player/pkg/config"
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/logger"
-	"github.com/felamaslen/go-music-player/pkg/read"
-	"github.com/felamaslen/go-music-player/pkg/repository"
+	"github.com/felamaslen/gmus-backend/pkg/config"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/logger"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	"github.com/felamaslen/gmus-backend/pkg/repository"
 )
 
 const LOG_EVERY = 100

music-player/pkg/services/scanner_test.go → gmus-backend/pkg/services/scanner_test.go

@@ -4,10 +4,10 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
-	"github.com/felamaslen/go-music-player/pkg/read"
-	"github.com/felamaslen/go-music-player/pkg/services"
-	setup "github.com/felamaslen/go-music-player/pkg/testing"
+	"github.com/felamaslen/gmus-backend/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/read"
+	"github.com/felamaslen/gmus-backend/pkg/services"
+	setup "github.com/felamaslen/gmus-backend/pkg/testing"
 )
 
 var _ = Describe("Music scanner service", func() {

music-player/pkg/testing/testing.go → gmus-backend/pkg/testing/testing.go

@@ -5,7 +5,7 @@ import (
 	"path"
 	"runtime"
 
-	"github.com/felamaslen/go-music-player/pkg/database"
+	"github.com/felamaslen/gmus-backend/pkg/database"
 )
 
 func ChangeToRootDir() {

gmus-web/README.md

@@ -0,0 +1,43 @@
+# gmus-web
+
+This is a frontend web app for use with the [gmus backend](../gmus-backend/README.md).
+
+## Scripts
+
+### `yarn start`
+
+Runs the app in the development mode.
+
+### `yarn test`
+
+Runs tests
+
+### `yarn build`
+
+Builds app
+
+## Architecture
+
+### Global app
+
+This is the main part of the app. It is responsible for handling:
+
+- Global state such as which song is playing, and the current time
+- Connections to the API, through a websocket
+- Sharing state with other clients, and responding to updates from the API
+- Playing music, through an HTML <audio> element
+
+### UI
+
+This is the part of the app which implements user interaction. It is responsible for handling:
+
+- User input, to decide which actions to take
+- Display, to let the user know the state of things
+
+UIs follow a common model and are built into separate bundles, then [lazily loaded](./src/components/ui/index.ts).
+
+The following UIs are implemented:
+
+#### cmus
+
+This is based heavily on the cmus ncurses-based music player, and is essentially a web-based client with vim-like bindings for navigation.