A continuation of HomeBox the inventory and organization system built for the Home User
feat: debug-endpoints (#110)
Haydend151d4208198
diff --git a/.vscode/settings.json b/.vscode/settings.jsonindex 85f49ba2..b3305332 100644--- a/.vscode/settings.json+++ b/.vscode/settings.json@@ -10,5 +10,8 @@"package.json": "package-lock.json, yarn.lock, .eslintrc.js, tsconfig.json, .prettierrc, .editorconfig, pnpm-lock.yaml, postcss.config.js, tailwind.config.js","docker-compose.yml": "Dockerfile, .dockerignore, docker-compose.dev.yml, docker-compose.yml","README.md": "LICENSE, SECURITY.md"- }+ },+ "cSpell.words": [+ "debughandlers"+ ]}diff --git a/Taskfile.yml b/Taskfile.ymlindex a3dbd817..44622654 100644--- a/Taskfile.yml+++ b/Taskfile.yml@@ -17,13 +17,13 @@ tasks:deps:- db:generatecmds:- - cd backend/app/api/ && swag fmt- - cd backend/app/api/ && swag init --dir=./,../../internal,../../pkgs+ - cd backend/app/api/static && swag fmt --dir=../+ - cd backend/app/api/static && swag init --dir=../,../../../internal,../../../pkgs- |npx swagger-typescript-api \--no-client \--modular \- --path ./backend/app/api/docs/swagger.json \+ --path ./backend/app/api/static/docs/swagger.json \--output ./frontend/lib/api/types- python3 ./scripts/process-types.py ./frontend/lib/api/types/data-contracts.tssources:@@ -34,8 +34,8 @@ tasks:generates:- "./frontend/lib/api/types/data-contracts.ts"- "./backend/ent/schema"- - "./backend/app/api/docs/swagger.json"- - "./backend/app/api/docs/swagger.yaml"+ - "./backend/app/api/static/docs/swagger.json"+ - "./backend/app/api/static/docs/swagger.yaml"api:desc: Starts the backend api server (depends on generate task)diff --git a/backend/app/api/handlers/debughandlers/debug.go b/backend/app/api/handlers/debughandlers/debug.gonew file mode 100644index 00000000..ffba624e--- /dev/null+++ b/backend/app/api/handlers/debughandlers/debug.go@@ -0,0 +1,16 @@+package debughandlers++import (+ "expvar"+ "net/http"+ "net/http/pprof"+)++func New(mux *http.ServeMux) {+ mux.HandleFunc("/debug/pprof", pprof.Index)+ mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)+ mux.HandleFunc("/debug/pprof/profile", pprof.Profile)+ mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)+ mux.HandleFunc("/debug/pprof/trace", pprof.Trace)+ mux.Handle("/debug/vars", expvar.Handler())+}diff --git a/backend/app/api/v1/controller.go b/backend/app/api/handlers/v1/controller.gosimilarity index 100%rename from backend/app/api/v1/controller.gorename to backend/app/api/handlers/v1/controller.godiff --git a/backend/app/api/v1/partials.go b/backend/app/api/handlers/v1/partials.gosimilarity index 100%rename from backend/app/api/v1/partials.gorename to backend/app/api/handlers/v1/partials.godiff --git a/backend/app/api/v1/v1_ctrl_auth.go b/backend/app/api/handlers/v1/v1_ctrl_auth.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_auth.gorename to backend/app/api/handlers/v1/v1_ctrl_auth.godiff --git a/backend/app/api/v1/v1_ctrl_group.go b/backend/app/api/handlers/v1/v1_ctrl_group.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_group.gorename to backend/app/api/handlers/v1/v1_ctrl_group.godiff --git a/backend/app/api/v1/v1_ctrl_items.go b/backend/app/api/handlers/v1/v1_ctrl_items.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_items.gorename to backend/app/api/handlers/v1/v1_ctrl_items.godiff --git a/backend/app/api/v1/v1_ctrl_items_attachments.go b/backend/app/api/handlers/v1/v1_ctrl_items_attachments.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_items_attachments.gorename to backend/app/api/handlers/v1/v1_ctrl_items_attachments.godiff --git a/backend/app/api/v1/v1_ctrl_labels.go b/backend/app/api/handlers/v1/v1_ctrl_labels.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_labels.gorename to backend/app/api/handlers/v1/v1_ctrl_labels.godiff --git a/backend/app/api/v1/v1_ctrl_locations.go b/backend/app/api/handlers/v1/v1_ctrl_locations.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_locations.gorename to backend/app/api/handlers/v1/v1_ctrl_locations.godiff --git a/backend/app/api/v1/v1_ctrl_user.go b/backend/app/api/handlers/v1/v1_ctrl_user.gosimilarity index 100%rename from backend/app/api/v1/v1_ctrl_user.gorename to backend/app/api/handlers/v1/v1_ctrl_user.godiff --git a/backend/app/api/main.go b/backend/app/api/main.goindex 4340f20c..9cbff982 100644--- a/backend/app/api/main.go+++ b/backend/app/api/main.go@@ -2,13 +2,14 @@ package mainimport ("context"+ "net/http""os""path/filepath""time"atlas "ariga.io/atlas/sql/migrate""entgo.io/ent/dialect/sql/schema"- "github.com/hay-kot/homebox/backend/app/api/docs"+ "github.com/hay-kot/homebox/backend/app/api/static/docs""github.com/hay-kot/homebox/backend/ent""github.com/hay-kot/homebox/backend/internal/config""github.com/hay-kot/homebox/backend/internal/migrations"@@ -153,5 +154,14 @@ func run(cfg *config.Config) error {app.SetupDemo()}+ if cfg.Debug.Enabled {+ debugrouter := app.debugRouter()+ go func() {+ if err := http.ListenAndServe(":"+cfg.Debug.Port, debugrouter); err != nil {+ log.Fatal().Err(err).Msg("failed to start debug server")+ }+ }()+ }+return app.server.Start(routes)}diff --git a/backend/app/api/routes.go b/backend/app/api/routes.goindex b0a1f1ce..67882eda 100644--- a/backend/app/api/routes.go+++ b/backend/app/api/routes.go@@ -11,8 +11,9 @@ import ("path/filepath""github.com/go-chi/chi/v5"- _ "github.com/hay-kot/homebox/backend/app/api/docs"- v1 "github.com/hay-kot/homebox/backend/app/api/v1"+ "github.com/hay-kot/homebox/backend/app/api/handlers/debughandlers"+ v1 "github.com/hay-kot/homebox/backend/app/api/handlers/v1"+ _ "github.com/hay-kot/homebox/backend/app/api/static/docs""github.com/hay-kot/homebox/backend/internal/repo""github.com/rs/zerolog/log"httpSwagger "github.com/swaggo/http-swagger" // http-swagger middleware@@ -23,10 +24,17 @@ const prefix = "/api"var (ErrDir = errors.New("path is dir")- //go:embed all:public/*+ //go:embed all:static/public/*public embed.FS)+func (a *app) debugRouter() *http.ServeMux {+ dbg := http.NewServeMux()+ debughandlers.New(dbg)++ return dbg+}+// registerRoutes registers all the routes for the APIfunc (a *app) newRouter(repos *repo.AllRepos) *chi.Mux {registerMimes()diff --git a/backend/app/api/docs/docs.go b/backend/app/api/static/docs/docs.gosimilarity index 100%rename from backend/app/api/docs/docs.gorename to backend/app/api/static/docs/docs.godiff --git a/backend/app/api/docs/swagger.json b/backend/app/api/static/docs/swagger.jsonsimilarity index 100%rename from backend/app/api/docs/swagger.jsonrename to backend/app/api/static/docs/swagger.jsondiff --git a/backend/app/api/docs/swagger.yaml b/backend/app/api/static/docs/swagger.yamlsimilarity index 100%rename from backend/app/api/docs/swagger.yamlrename to backend/app/api/static/docs/swagger.yamldiff --git a/backend/app/api/public/.gitkeep b/backend/app/api/static/public/.gitkeepsimilarity index 100%rename from backend/app/api/public/.gitkeeprename to backend/app/api/static/public/.gitkeepdiff --git a/backend/internal/config/conf.go b/backend/internal/config/conf.goindex f45e19c1..8e557563 100644--- a/backend/internal/config/conf.go+++ b/backend/internal/config/conf.go@@ -24,6 +24,12 @@ type Config struct {Swagger SwaggerConf `yaml:"swagger"`Demo bool `yaml:"demo"`AllowRegistration bool `yaml:"disable_registration" conf:"default:true"`+ Debug DebugConf `yaml:"debug"`+}++type DebugConf struct {+ Enabled bool `yaml:"enabled" conf:"default:false"`+ Port string `yaml:"port" conf:"default:4000"`}type SwaggerConf struct {diff --git a/frontend/pages/location/[id].vue b/frontend/pages/location/[id].vueindex 092ace3f..d915e0bc 100644--- a/frontend/pages/location/[id].vue+++ b/frontend/pages/location/[id].vue@@ -124,7 +124,7 @@</script><template>- <BaseContainer>+ <div><BaseModal v-model="updateModal"><template #title> Update Location </template><form v-if="location" @submit.prevent="update">@@ -136,59 +136,60 @@</div></form></BaseModal>-- <BaseCard class="mb-16">- <template #title>- <BaseSectionHeader>- <Icon name="mdi-map-marker" class="mr-2 -mt-1 text-base-content" />- <span class="text-base-content">- {{ location ? location.name : "" }}- </span>- <div v-if="location && location.parent" class="text-sm breadcrumbs pb-0">- <ul class="text-base-content/70">- <li>- <NuxtLink :to="`/location/${location.parent.id}`"> {{ location.parent.name }}</NuxtLink>- </li>- <li>{{ location.name }}</li>- </ul>- </div>- </BaseSectionHeader>- </template>-- <template #title-actions>- <div class="flex mt-2 gap-2">- <div class="form-control max-w-[160px]">- <label class="label cursor-pointer">- <input v-model="preferences.showDetails" type="checkbox" class="toggle toggle-primary" />- <span class="label-text ml-2"> Detailed View </span>- </label>+ <BaseContainer class="space-y-10 mb-16">+ <BaseCard>+ <template #title>+ <BaseSectionHeader>+ <Icon name="mdi-map-marker" class="mr-2 -mt-1 text-base-content" />+ <span class="text-base-content">+ {{ location ? location.name : "" }}+ </span>+ <div v-if="location && location.parent" class="text-sm breadcrumbs pb-0">+ <ul class="text-base-content/70">+ <li>+ <NuxtLink :to="`/location/${location.parent.id}`"> {{ location.parent.name }}</NuxtLink>+ </li>+ <li>{{ location.name }}</li>+ </ul>+ </div>+ </BaseSectionHeader>+ </template>++ <template #title-actions>+ <div class="flex mt-2 gap-2">+ <div class="form-control max-w-[160px]">+ <label class="label cursor-pointer">+ <input v-model="preferences.showDetails" type="checkbox" class="toggle toggle-primary" />+ <span class="label-text ml-2"> Detailed View </span>+ </label>+ </div>+ <BaseButton class="ml-auto" size="sm" @click="openUpdate">+ <Icon class="mr-1" name="mdi-pencil" />+ Edit+ </BaseButton>+ <BaseButton size="sm" @click="confirmDelete">+ <Icon class="mr-1" name="mdi-delete" />+ Delete+ </BaseButton></div>- <BaseButton class="ml-auto" size="sm" @click="openUpdate">- <Icon class="mr-1" name="mdi-pencil" />- Edit- </BaseButton>- <BaseButton size="sm" @click="confirmDelete">- <Icon class="mr-1" name="mdi-delete" />- Delete- </BaseButton>+ </template>++ <DetailsSection :details="details" />+ </BaseCard>++ <section v-if="location && location.items.length > 0">+ <BaseSectionHeader class="mb-5"> Items </BaseSectionHeader>+ <div class="grid gap-2 grid-cols-1 sm:grid-cols-2">+ <ItemCard v-for="item in location.items" :key="item.id" :item="item" />+ </div>+ </section>++ <section v-if="location && location.children.length > 0">+ <BaseSectionHeader class="mb-5"> Child Locations </BaseSectionHeader>+ <div class="grid gap-2 grid-cols-1 sm:grid-cols-3">+ <LocationCard v-for="item in location.children" :key="item.id" :location="item" /></div>- </template>-- <DetailsSection :details="details" />- </BaseCard>-- <section v-if="location && location.items.length > 0">- <BaseSectionHeader class="mb-5"> Items </BaseSectionHeader>- <div class="grid gap-2 grid-cols-1 sm:grid-cols-2">- <ItemCard v-for="item in location.items" :key="item.id" :item="item" />- </div>- </section>-- <section v-if="location && location.children.length > 0">- <BaseSectionHeader class="mb-5"> Child Locations </BaseSectionHeader>- <div class="grid gap-2 grid-cols-1 sm:grid-cols-3">- <LocationCard v-for="item in location.children" :key="item.id" :location="item" />- </div>- </section>- </BaseContainer>+ </section>+ </BaseContainer>+ </div></template>