feat: bootstrap OSDB full-stack skeleton (story #01) #1

Merged
julia merged 3 commits from feature/01-bootstrap-the-project into main 2026-06-17 12:45:14 +00:00
5 changed files with 60 additions and 19 deletions
Showing only changes of commit 4d28916c7b - Show all commits
+2 -1
View File
@@ -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
.PHONY: dev-db migrate-up migrate-down run-backend run-frontend test fmt
+17 -6
View File
@@ -40,9 +40,12 @@ func main() {
}
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 {
log.Fatalf("database connect: %v", err)
}
@@ -51,19 +54,27 @@ func serve(cfg *config.Config) {
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() {
addr := fmt.Sprintf(":%s", cfg.Port)
log.Printf("server: listening on %s", addr)
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)
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
<-quit
select {
case err := <-startErr:
log.Fatalf("server: %v", err)
case <-quit:
}
log.Println("server: shutting down")
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+12
View File
@@ -9,6 +9,10 @@ import (
)
// 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.
func New(pool *pgxpool.Pool) *echo.Echo {
e := echo.New()
@@ -18,6 +22,14 @@ func New(pool *pgxpool.Pool) *echo.Echo {
e.Use(middleware.Logger())
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()
// Root health — used by docker healthcheck + ops tooling
+5 -2
View File
@@ -1,6 +1,7 @@
package config
import (
"log"
"os"
)
@@ -11,11 +12,13 @@ type Config struct {
}
// 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 {
dbURL := os.Getenv("DATABASE_URL")
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")
+24 -10
View File
@@ -1,23 +1,37 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import { mount } from '@vue/test-utils'
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { mount, flushPromises } from '@vue/test-utils'
import { createPinia } from 'pinia'
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(() => {
vi.stubGlobal('fetch', vi.fn().mockResolvedValue({
ok: true,
json: async () => ({ status: 'ok' }),
}))
vi.stubGlobal('fetch', fetchMock)
})
afterEach(() => {
vi.restoreAllMocks()
})
describe('HelloWorld', () => {
it('renders the OSDB greeting', async () => {
const wrapper = mount(HelloWorld, {
global: {
plugins: [createPinia()],
},
global: { plugins: [createPinia()] },
})
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')
})
})