A continuation of HomeBox the inventory and organization system built for the Home User
fix: conditionally filter parent locations (#133)
Hayden8e1947d9712e
diff --git a/backend/app/api/handlers/v1/query_params.go b/backend/app/api/handlers/v1/query_params.gonew file mode 100644index 00000000..0ac84d8e--- /dev/null+++ b/backend/app/api/handlers/v1/query_params.go@@ -0,0 +1,36 @@+package v1++import (+ "net/url"+ "strconv"++ "github.com/google/uuid"+)++func queryUUIDList(params url.Values, key string) []uuid.UUID {+ var ids []uuid.UUID+ for _, id := range params[key] {+ uid, err := uuid.Parse(id)+ if err != nil {+ continue+ }+ ids = append(ids, uid)+ }+ return ids+}++func queryIntOrNegativeOne(s string) int {+ i, err := strconv.Atoi(s)+ if err != nil {+ return -1+ }+ return i+}++func queryBool(s string) bool {+ b, err := strconv.ParseBool(s)+ if err != nil {+ return false+ }+ return b+}diff --git a/backend/app/api/handlers/v1/v1_ctrl_items.go b/backend/app/api/handlers/v1/v1_ctrl_items.goindex 732600f0..f4d43d34 100644--- a/backend/app/api/handlers/v1/v1_ctrl_items.go+++ b/backend/app/api/handlers/v1/v1_ctrl_items.go@@ -3,10 +3,7 @@ package v1import ("encoding/csv""net/http"- "net/url"- "strconv"- "github.com/google/uuid""github.com/hay-kot/homebox/backend/internal/core/services""github.com/hay-kot/homebox/backend/internal/data/repo""github.com/hay-kot/homebox/backend/internal/sys/validate"@@ -27,44 +24,17 @@ import (// @Router /v1/items [GET]// @Security Bearerfunc (ctrl *V1Controller) HandleItemsGetAll() server.HandlerFunc {- uuidList := func(params url.Values, key string) []uuid.UUID {- var ids []uuid.UUID- for _, id := range params[key] {- uid, err := uuid.Parse(id)- if err != nil {- continue- }- ids = append(ids, uid)- }- return ids- }-- intOrNegativeOne := func(s string) int {- i, err := strconv.Atoi(s)- if err != nil {- return -1- }- return i- }-- getBool := func(s string) bool {- b, err := strconv.ParseBool(s)- if err != nil {- return false- }- return b- }extractQuery := func(r *http.Request) repo.ItemQuery {params := r.URL.Query()return repo.ItemQuery{- Page: intOrNegativeOne(params.Get("page")),- PageSize: intOrNegativeOne(params.Get("perPage")),+ Page: queryIntOrNegativeOne(params.Get("page")),+ PageSize: queryIntOrNegativeOne(params.Get("perPage")),Search: params.Get("q"),- LocationIDs: uuidList(params, "locations"),- LabelIDs: uuidList(params, "labels"),- IncludeArchived: getBool(params.Get("includeArchived")),+ LocationIDs: queryUUIDList(params, "locations"),+ LabelIDs: queryUUIDList(params, "labels"),+ IncludeArchived: queryBool(params.Get("includeArchived")),}}diff --git a/backend/app/api/handlers/v1/v1_ctrl_locations.go b/backend/app/api/handlers/v1/v1_ctrl_locations.goindex 5e857667..12e3c29a 100644--- a/backend/app/api/handlers/v1/v1_ctrl_locations.go+++ b/backend/app/api/handlers/v1/v1_ctrl_locations.go@@ -15,13 +15,21 @@ import (// @Summary Get All Locations// @Tags Locations// @Produce json+// @Param filterChildren query bool false "Filter locations with parents"// @Success 200 {object} server.Results{items=[]repo.LocationOutCount}// @Router /v1/locations [GET]// @Security Bearerfunc (ctrl *V1Controller) HandleLocationGetAll() server.HandlerFunc {return func(w http.ResponseWriter, r *http.Request) error {user := services.UseUserCtx(r.Context())- locations, err := ctrl.repo.Locations.GetAll(r.Context(), user.GroupID)++ q := r.URL.Query()++ filter := repo.LocationQuery{+ FilterChildren: queryBool(q.Get("filterChildren")),+ }++ locations, err := ctrl.repo.Locations.GetAll(r.Context(), user.GroupID, filter)if err != nil {log.Err(err).Msg("failed to get locations")return validate.NewRequestError(err, http.StatusInternalServerError)diff --git a/backend/app/api/static/docs/docs.go b/backend/app/api/static/docs/docs.goindex a4105a14..f2c877ef 100644--- a/backend/app/api/static/docs/docs.go+++ b/backend/app/api/static/docs/docs.go@@ -756,6 +756,14 @@ const docTemplate = `{"Locations"],"summary": "Get All Locations",+ "parameters": [+ {+ "type": "boolean",+ "description": "Filter locations with parents",+ "name": "filterChildren",+ "in": "query"+ }+ ],"responses": {"200": {"description": "OK",diff --git a/backend/app/api/static/docs/swagger.json b/backend/app/api/static/docs/swagger.jsonindex 911f8f2a..7215faef 100644--- a/backend/app/api/static/docs/swagger.json+++ b/backend/app/api/static/docs/swagger.json@@ -748,6 +748,14 @@"Locations"],"summary": "Get All Locations",+ "parameters": [+ {+ "type": "boolean",+ "description": "Filter locations with parents",+ "name": "filterChildren",+ "in": "query"+ }+ ],"responses": {"200": {"description": "OK",diff --git a/backend/app/api/static/docs/swagger.yaml b/backend/app/api/static/docs/swagger.yamlindex b4f8c78d..e4795834 100644--- a/backend/app/api/static/docs/swagger.yaml+++ b/backend/app/api/static/docs/swagger.yaml@@ -960,6 +960,11 @@ paths:- Labels/v1/locations:get:+ parameters:+ - description: Filter locations with parents+ in: query+ name: filterChildren+ type: booleanproduces:- application/jsonresponses:diff --git a/backend/internal/core/services/service_items.go b/backend/internal/core/services/service_items.goindex 5c02724e..4af80c86 100644--- a/backend/internal/core/services/service_items.go+++ b/backend/internal/core/services/service_items.go@@ -23,7 +23,7 @@ type ItemService struct {at attachmentTokens}-func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]string) (int, error) {+func (svc *ItemService) CsvImport(ctx context.Context, GID uuid.UUID, data [][]string) (int, error) {loaded := []csvRow{}// Skip first row@@ -66,7 +66,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]s// Bootstrap the locations and labels so we can reuse the created IDs for the itemslocations := map[string]uuid.UUID{}- existingLocation, err := svc.repo.Locations.GetAll(ctx, gid)+ existingLocation, err := svc.repo.Locations.GetAll(ctx, GID, repo.LocationQuery{})if err != nil {return 0, err}@@ -75,7 +75,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]s}labels := map[string]uuid.UUID{}- existingLabels, err := svc.repo.Labels.GetAll(ctx, gid)+ existingLabels, err := svc.repo.Labels.GetAll(ctx, GID)if err != nil {return 0, err}@@ -87,7 +87,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]s// Locationsif _, exists := locations[row.Location]; !exists {- result, err := svc.repo.Locations.Create(ctx, gid, repo.LocationCreate{+ result, err := svc.repo.Locations.Create(ctx, GID, repo.LocationCreate{Name: row.Location,Description: "",})@@ -103,7 +103,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]sif _, exists := labels[label]; exists {continue}- result, err := svc.repo.Labels.Create(ctx, gid, repo.LabelCreate{+ result, err := svc.repo.Labels.Create(ctx, GID, repo.LabelCreate{Name: label,Description: "",})@@ -119,7 +119,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]sfor _, row := range loaded {// Check Import Refif row.Item.ImportRef != "" {- exists, err := svc.repo.Items.CheckRef(ctx, gid, row.Item.ImportRef)+ exists, err := svc.repo.Items.CheckRef(ctx, GID, row.Item.ImportRef)if exists {continue}@@ -139,7 +139,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]sStr("location", row.Location).Msgf("Creating Item: %s", row.Item.Name)- result, err := svc.repo.Items.Create(ctx, gid, repo.ItemCreate{+ result, err := svc.repo.Items.Create(ctx, GID, repo.ItemCreate{ImportRef: row.Item.ImportRef,Name: row.Item.Name,Description: row.Item.Description,@@ -152,7 +152,7 @@ func (svc *ItemService) CsvImport(ctx context.Context, gid uuid.UUID, data [][]s}// Update the item with the rest of the data- _, err = svc.repo.Items.UpdateByGroup(ctx, gid, repo.ItemUpdate{+ _, err = svc.repo.Items.UpdateByGroup(ctx, GID, repo.ItemUpdate{// EdgesLocationID: locationID,LabelIDs: labelIDs,diff --git a/backend/internal/core/services/service_items_test.go b/backend/internal/core/services/service_items_test.goindex 1daa0b7e..105c8422 100644--- a/backend/internal/core/services/service_items_test.go+++ b/backend/internal/core/services/service_items_test.go@@ -5,6 +5,7 @@ import ("testing""github.com/google/uuid"+ "github.com/hay-kot/homebox/backend/internal/data/repo""github.com/stretchr/testify/assert")@@ -38,7 +39,7 @@ func TestItemService_CsvImport(t *testing.T) {dataCsv = append(dataCsv, newCsvRow(item))}- allLocation, err := tRepos.Locations.GetAll(context.Background(), tGroup.ID)+ allLocation, err := tRepos.Locations.GetAll(context.Background(), tGroup.ID, repo.LocationQuery{})assert.NoError(t, err)locNames := []string{}for _, loc := range allLocation {diff --git a/backend/internal/data/repo/repo_locations.go b/backend/internal/data/repo/repo_locations.goindex f7d63eb7..641b3e37 100644--- a/backend/internal/data/repo/repo_locations.go+++ b/backend/internal/data/repo/repo_locations.go@@ -2,6 +2,7 @@ package repoimport ("context"+ "strings""time""github.com/google/uuid"@@ -90,8 +91,12 @@ func mapLocationOut(location *ent.Location) LocationOut {}}+type LocationQuery struct {+ FilterChildren bool `json:"filterChildren"`+}+// GetALlWithCount returns all locations with item count field populated-func (r *LocationRepository) GetAll(ctx context.Context, groupId uuid.UUID) ([]LocationOutCount, error) {+func (r *LocationRepository) GetAll(ctx context.Context, GID uuid.UUID, filter LocationQuery) ([]LocationOutCount, error) {query := `--sqlSELECTid,@@ -111,13 +116,18 @@ func (r *LocationRepository) GetAll(ctx context.Context, groupId uuid.UUID) ([]LFROMlocationsWHERE- locations.group_locations = ?- AND locations.location_children IS NULL+ locations.group_locations = ? {{ FILTER_CHILDREN }}ORDER BYlocations.name ASC`- rows, err := r.db.Sql().QueryContext(ctx, query, groupId)+ if filter.FilterChildren {+ query = strings.Replace(query, "{{ FILTER_CHILDREN }}", "AND locations.location_children IS NULL", 1)+ } else {+ query = strings.Replace(query, "{{ FILTER_CHILDREN }}", "", 1)+ }++ rows, err := r.db.Sql().QueryContext(ctx, query, GID)if err != nil {return nil, err}diff --git a/backend/internal/data/repo/repo_locations_test.go b/backend/internal/data/repo/repo_locations_test.goindex d48779d2..5085d3b5 100644--- a/backend/internal/data/repo/repo_locations_test.go+++ b/backend/internal/data/repo/repo_locations_test.go@@ -43,7 +43,7 @@ func TestLocationRepositoryGetAllWithCount(t *testing.T) {assert.NoError(t, err)- results, err := tRepos.Locations.GetAll(context.Background(), tGroup.ID)+ results, err := tRepos.Locations.GetAll(context.Background(), tGroup.ID, LocationQuery{})assert.NoError(t, err)for _, loc := range results {diff --git a/frontend/components/Item/CreateModal.vue b/frontend/components/Item/CreateModal.vueindex 42bb6b71..2a2aec30 100644--- a/frontend/components/Item/CreateModal.vue+++ b/frontend/components/Item/CreateModal.vue@@ -41,7 +41,7 @@const toast = useNotifier();const locationsStore = useLocationStore();- const locations = computed(() => locationsStore.locations);+ const locations = computed(() => locationsStore.allLocations);const labelStore = useLabelStore();const labels = computed(() => labelStore.labels);diff --git a/frontend/layouts/default.vue b/frontend/layouts/default.vueindex 5b6d488d..ab21150c 100644--- a/frontend/layouts/default.vue+++ b/frontend/layouts/default.vue@@ -32,7 +32,8 @@const rmLocationStoreObserver = defineObserver("locationStore", {handler: r => {if (r.status === 201 || r.url.match(reLocation)) {- locationStore.refresh();+ locationStore.refreshChildren();+ locationStore.refreshParents();}console.debug("locationStore handler called by observer");},@@ -43,7 +44,8 @@EventTypes.ClearStores,() => {labelStore.refresh();- locationStore.refresh();+ locationStore.refreshChildren();+ locationStore.refreshParents();},"stores");diff --git a/frontend/lib/api/classes/locations.ts b/frontend/lib/api/classes/locations.tsindex d456e91b..7559c624 100644--- a/frontend/lib/api/classes/locations.ts+++ b/frontend/lib/api/classes/locations.ts@@ -2,9 +2,13 @@ import { BaseAPI, route } from "../base";import { LocationOutCount, LocationCreate, LocationOut, LocationUpdate } from "../types/data-contracts";import { Results } from "../types/non-generated";+export type LocationsQuery = {+ filterChildren: boolean;+};+export class LocationsApi extends BaseAPI {- getAll() {- return this.http.get<Results<LocationOutCount>>({ url: route("/locations") });+ getAll(q: LocationsQuery = { filterChildren: false }) {+ return this.http.get<Results<LocationOutCount>>({ url: route("/locations", q) });}create(body: LocationCreate) {diff --git a/frontend/pages/home.vue b/frontend/pages/home.vueindex 1adc1787..0113a0bd 100644--- a/frontend/pages/home.vue+++ b/frontend/pages/home.vue@@ -16,7 +16,7 @@const auth = useAuthStore();const locationStore = useLocationStore();- const locations = computed(() => locationStore.locations);+ const locations = computed(() => locationStore.parentLocations);const labelsStore = useLabelStore();const labels = computed(() => labelsStore.labels);diff --git a/frontend/pages/item/[id]/edit.vue b/frontend/pages/item/[id]/edit.vueindex ede78b8a..a43abc69 100644--- a/frontend/pages/item/[id]/edit.vue+++ b/frontend/pages/item/[id]/edit.vue@@ -18,7 +18,7 @@const itemId = computed<string>(() => route.params.id as string);const locationStore = useLocationStore();- const locations = computed(() => locationStore.locations);+ const locations = computed(() => locationStore.allLocations);const labelStore = useLabelStore();const labels = computed(() => labelStore.labels);diff --git a/frontend/pages/items.vue b/frontend/pages/items.vueindex a1f21a2e..317a0f09 100644--- a/frontend/pages/items.vue+++ b/frontend/pages/items.vue@@ -82,7 +82,7 @@});const locationsStore = useLocationStore();- const locations = computed(() => locationsStore.locations);+ const locations = computed(() => locationsStore.allLocations);const labelStore = useLabelStore();const labels = computed(() => labelStore.labels);diff --git a/frontend/pages/location/[id].vue b/frontend/pages/location/[id].vueindex d915e0bc..d58a935c 100644--- a/frontend/pages/location/[id].vue+++ b/frontend/pages/location/[id].vue@@ -117,7 +117,7 @@}const locationStore = useLocationStore();- const locations = computed(() => locationStore.locations);+ const locations = computed(() => locationStore.allLocations);// eslint-disable-next-line @typescript-eslint/no-explicit-anyconst parent = ref<LocationSummary | any>({});diff --git a/frontend/stores/locations.ts b/frontend/stores/locations.tsindex e2b2680d..68295f6f 100644--- a/frontend/stores/locations.ts+++ b/frontend/stores/locations.ts@@ -3,7 +3,8 @@ import { LocationOutCount } from "~~/lib/api/types/data-contracts";export const useLocationStore = defineStore("locations", {state: () => ({- allLocations: null as LocationOutCount[] | null,+ parents: null as LocationOutCount[] | null,+ Locations: null as LocationOutCount[] | null,client: useUserApi(),}),getters: {@@ -12,21 +13,36 @@ export const useLocationStore = defineStore("locations", {* synched with the server by intercepting the API calls and updating on the* response*/- locations(state): LocationOutCount[] {- if (state.allLocations === null) {- Promise.resolve(this.refresh());+ parentLocations(state): LocationOutCount[] {+ if (state.parents === null) {+ Promise.resolve(this.refreshParents());}- return state.allLocations;+ return state.parents;+ },+ allLocations(state): LocationOutCount[] {+ if (state.Locations === null) {+ Promise.resolve(this.refreshChildren());+ }+ return state.Locations;},},actions: {- async refresh(): Promise<LocationOutCount[]> {- const result = await this.client.locations.getAll();+ async refreshParents(): Promise<LocationOutCount[]> {+ const result = await this.client.locations.getAll({ filterChildren: true });+ if (result.error) {+ return result;+ }++ this.parents = result.data.items;+ return result;+ },+ async refreshChildren(): Promise<LocationOutCount[]> {+ const result = await this.client.locations.getAll({ filterChildren: false });if (result.error) {return result;}- this.allLocations = result.data.items;+ this.Locations = result.data.items;return result;},},