fix: address code review findings from story #01
- Makefile: -include .env (soft) so fresh clone doesn't hard-fail
- main.go: replace log.Fatalf-in-goroutine with error channel; startup
failures now reach main goroutine so defer pool.Close() always runs
- main.go: context.WithTimeout(30s) on database.Connect to fail fast
instead of hanging indefinitely on unreachable Postgres
- router.go: store pool on Echo context via middleware so future story
handlers can retrieve it with c.Get("pool")
- config.go: require DATABASE_URL explicitly (log.Fatal if missing)
instead of falling back to hardcoded credentials
- HelloWorld.test.ts: URL-aware fetch stub + afterEach restoreAllMocks;
add flushPromises test verifying backend status renders
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -1,4 +1,5 @@
|
|||||||
include .env
|
# -include: silently skip if .env doesn't exist (e.g. fresh clone before 'cp .env.example .env')
|
||||||
|
-include .env
|
||||||
export
|
export
|
||||||
|
|
||||||
.PHONY: dev-db migrate-up migrate-down run-backend run-frontend test fmt
|
.PHONY: dev-db migrate-up migrate-down run-backend run-frontend test fmt
|
||||||
|
|||||||
@@ -40,9 +40,12 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func serve(cfg *config.Config) {
|
func serve(cfg *config.Config) {
|
||||||
ctx := context.Background()
|
// Use a timeout context for the initial DB connection so a slow/unreachable
|
||||||
|
// Postgres doesn't block server startup indefinitely.
|
||||||
|
connectCtx, connectCancel := context.WithTimeout(context.Background(), 30*time.Second)
|
||||||
|
defer connectCancel()
|
||||||
|
|
||||||
pool, err := database.Connect(ctx, cfg.DatabaseURL)
|
pool, err := database.Connect(connectCtx, cfg.DatabaseURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("database connect: %v", err)
|
log.Fatalf("database connect: %v", err)
|
||||||
}
|
}
|
||||||
@@ -51,19 +54,27 @@ func serve(cfg *config.Config) {
|
|||||||
|
|
||||||
e := New(pool)
|
e := New(pool)
|
||||||
|
|
||||||
// Start server
|
// Start server; signal failures via a channel so the main goroutine can
|
||||||
|
// handle them without calling os.Exit from a goroutine (which would skip
|
||||||
|
// all deferred cleanup, including pool.Close).
|
||||||
|
startErr := make(chan error, 1)
|
||||||
go func() {
|
go func() {
|
||||||
addr := fmt.Sprintf(":%s", cfg.Port)
|
addr := fmt.Sprintf(":%s", cfg.Port)
|
||||||
log.Printf("server: listening on %s", addr)
|
log.Printf("server: listening on %s", addr)
|
||||||
if err := e.Start(addr); err != nil && err != http.ErrServerClosed {
|
if err := e.Start(addr); err != nil && err != http.ErrServerClosed {
|
||||||
log.Fatalf("server: %v", err)
|
startErr <- err
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
// Graceful shutdown on SIGINT / SIGTERM
|
// Graceful shutdown on SIGINT / SIGTERM or fatal startup error.
|
||||||
quit := make(chan os.Signal, 1)
|
quit := make(chan os.Signal, 1)
|
||||||
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
|
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
|
||||||
<-quit
|
|
||||||
|
select {
|
||||||
|
case err := <-startErr:
|
||||||
|
log.Fatalf("server: %v", err)
|
||||||
|
case <-quit:
|
||||||
|
}
|
||||||
|
|
||||||
log.Println("server: shutting down")
|
log.Println("server: shutting down")
|
||||||
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
|||||||
@@ -9,6 +9,10 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// New creates and configures the Echo instance with all routes registered.
|
// New creates and configures the Echo instance with all routes registered.
|
||||||
|
// pool is stored on Echo's context so all handlers added by future stories
|
||||||
|
// (#2 fruits, #4 publications, #7 thumbnails, #8 auth) can retrieve it via
|
||||||
|
// c.Get("pool").(*pgxpool.Pool).
|
||||||
|
//
|
||||||
// Extension point: story #2, #4, #7, #8 route groups are added here.
|
// Extension point: story #2, #4, #7, #8 route groups are added here.
|
||||||
func New(pool *pgxpool.Pool) *echo.Echo {
|
func New(pool *pgxpool.Pool) *echo.Echo {
|
||||||
e := echo.New()
|
e := echo.New()
|
||||||
@@ -18,6 +22,14 @@ func New(pool *pgxpool.Pool) *echo.Echo {
|
|||||||
e.Use(middleware.Logger())
|
e.Use(middleware.Logger())
|
||||||
e.Use(middleware.Recover())
|
e.Use(middleware.Recover())
|
||||||
|
|
||||||
|
// Make pool available to all handlers via Echo context.
|
||||||
|
e.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||||
|
return func(c echo.Context) error {
|
||||||
|
c.Set("pool", pool)
|
||||||
|
return next(c)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
health := handler.NewHealthHandler()
|
health := handler.NewHealthHandler()
|
||||||
|
|
||||||
// Root health — used by docker healthcheck + ops tooling
|
// Root health — used by docker healthcheck + ops tooling
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package config
|
package config
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"log"
|
||||||
"os"
|
"os"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -11,11 +12,13 @@ type Config struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Load reads configuration from environment variables.
|
// Load reads configuration from environment variables.
|
||||||
// DATABASE_URL is required; PORT defaults to "3000".
|
// DATABASE_URL is required (no silent default — fails fast if missing).
|
||||||
|
// PORT defaults to "3000".
|
||||||
func Load() *Config {
|
func Load() *Config {
|
||||||
dbURL := os.Getenv("DATABASE_URL")
|
dbURL := os.Getenv("DATABASE_URL")
|
||||||
if dbURL == "" {
|
if dbURL == "" {
|
||||||
dbURL = "postgres://osdb:osdb@localhost:5432/osdb?sslmode=disable"
|
log.Fatal("DATABASE_URL environment variable is required but not set. " +
|
||||||
|
"Copy .env.example to .env and set the correct value.")
|
||||||
}
|
}
|
||||||
|
|
||||||
port := os.Getenv("PORT")
|
port := os.Getenv("PORT")
|
||||||
|
|||||||
@@ -1,23 +1,37 @@
|
|||||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||||||
import { mount } from '@vue/test-utils'
|
import { mount, flushPromises } from '@vue/test-utils'
|
||||||
import { createPinia } from 'pinia'
|
import { createPinia } from 'pinia'
|
||||||
import HelloWorld from './HelloWorld.vue'
|
import HelloWorld from './HelloWorld.vue'
|
||||||
|
|
||||||
// Stub fetch so the component's onMounted health call doesn't hit the network.
|
// Stub fetch; URL-aware so future tests can extend without cross-contamination.
|
||||||
|
const fetchMock = vi.fn((url: string) => {
|
||||||
|
if (url === '/api/v1/health') {
|
||||||
|
return Promise.resolve({ ok: true, json: async () => ({ status: 'ok' }) })
|
||||||
|
}
|
||||||
|
return Promise.reject(new Error(`Unexpected fetch: ${url}`))
|
||||||
|
})
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
vi.stubGlobal('fetch', vi.fn().mockResolvedValue({
|
vi.stubGlobal('fetch', fetchMock)
|
||||||
ok: true,
|
})
|
||||||
json: async () => ({ status: 'ok' }),
|
|
||||||
}))
|
afterEach(() => {
|
||||||
|
vi.restoreAllMocks()
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('HelloWorld', () => {
|
describe('HelloWorld', () => {
|
||||||
it('renders the OSDB greeting', async () => {
|
it('renders the OSDB greeting', async () => {
|
||||||
const wrapper = mount(HelloWorld, {
|
const wrapper = mount(HelloWorld, {
|
||||||
global: {
|
global: { plugins: [createPinia()] },
|
||||||
plugins: [createPinia()],
|
|
||||||
},
|
|
||||||
})
|
})
|
||||||
expect(wrapper.text()).toContain('Hello, OSDB!')
|
expect(wrapper.text()).toContain('Hello, OSDB!')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('displays backend status after health check resolves', async () => {
|
||||||
|
const wrapper = mount(HelloWorld, {
|
||||||
|
global: { plugins: [createPinia()] },
|
||||||
|
})
|
||||||
|
await flushPromises()
|
||||||
|
expect(wrapper.text()).toContain('ok')
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in New Issue
Block a user