mirrors/homebox
1
0
Fork 1
mirror of https://github.com/hay-kot/homebox.git synced 2024-12-26 16:56:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

bulk seed asset IDs

Browse source
This commit is contained in:
Hayden 2022-11-12 18:57:51 -09:00
parent ab406baf33
commit 567e12a1e9
No known key found for this signature in database
GPG key ID: 17CF79474E257545
13 changed files with 331 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
backend/app/api/handlers/v1/v1_ctrl_actions.go Normal file
View file

@ -0,0 +1,35 @@
package v1
import (
"net/http"
"github.com/hay-kot/homebox/backend/internal/core/services"
"github.com/hay-kot/homebox/backend/internal/sys/validate"
"github.com/hay-kot/homebox/backend/pkgs/server"
"github.com/rs/zerolog/log"
)
type EnsureAssetIDResult struct {
Completed int `json:"completed"`
}
// HandleGroupInvitationsCreate godoc
// @Summary Get the current user
// @Tags Group
// @Produce json
// @Success 200 {object} EnsureAssetIDResult
// @Router /v1/actions/ensure-asset-ids [Post]
// @Security Bearer
func (ctrl *V1Controller) HandleEnsureAssetID() server.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) error {
ctx := services.NewContext(r.Context())
totalCompleted, err := ctrl.svc.Items.EnsureAssetID(ctx, ctx.GID)
if err != nil {
log.Err(err).Msg("failed to ensure asset id")
return validate.NewRequestError(err, http.StatusInternalServerError)
}
return server.Respond(w, http.StatusOK, EnsureAssetIDResult{Completed: totalCompleted})
}
}

2
backend/app/api/routes.go
View file

@ -82,6 +82,8 @@ func (a *app) mountRoutes(repos *repo.AllRepos) {
a.server.Get(v1Base("/groups"), v1Ctrl.HandleGroupGet(), a.mwAuthToken)
a.server.Put(v1Base("/groups"), v1Ctrl.HandleGroupUpdate(), a.mwAuthToken)
a.server.Post(v1Base("/actions/ensure-asset-ids"), v1Ctrl.HandleEnsureAssetID(), a.mwAuthToken)
a.server.Get(v1Base("/locations"), v1Ctrl.HandleLocationGetAll(), a.mwAuthToken)
a.server.Post(v1Base("/locations"), v1Ctrl.HandleLocationCreate(), a.mwAuthToken)
a.server.Get(v1Base("/locations/{id}"), v1Ctrl.HandleLocationGet(), a.mwAuthToken)

39
backend/app/api/static/docs/docs.go
View file

@ -21,6 +21,30 @@ const docTemplate = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/v1/actions/ensure-asset-ids": {
"post": {
"security": [
{
"Bearer": []
}
],
"produces": [
"application/json"
],
"tags": [
"Group"
],
"summary": "Get the current user",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.EnsureAssetIDResult"
}
}
}
}
},
"/v1/groups": {
"get": {
"security": [
@ -1326,6 +1350,10 @@ const docTemplate = `{
"archived": {
"type": "boolean"
},
"assetId": {
"type": "string",
"example": "0"
},
"attachments": {
"type": "array",
"items": {
@ -1479,6 +1507,9 @@ const docTemplate = `{
"archived": {
"type": "boolean"
},
"assetId": {
"type": "string"
},
"description": {
"type": "string"
},
@ -1891,6 +1922,14 @@ const docTemplate = `{
}
}
},
"v1.EnsureAssetIDResult": {
"type": "object",
"properties": {
"completed": {
"type": "integer"
}
}
},
"v1.GroupInvitation": {
"type": "object",
"properties": {

39
backend/app/api/static/docs/swagger.json
View file

@ -13,6 +13,30 @@
},
"basePath": "/api",
"paths": {
"/v1/actions/ensure-asset-ids": {
"post": {
"security": [
{
"Bearer": []
}
],
"produces": [
"application/json"
],
"tags": [
"Group"
],
"summary": "Get the current user",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/v1.EnsureAssetIDResult"
}
}
}
}
},
"/v1/groups": {
"get": {
"security": [
@ -1318,6 +1342,10 @@
"archived": {
"type": "boolean"
},
"assetId": {
"type": "string",
"example": "0"
},
"attachments": {
"type": "array",
"items": {
@ -1471,6 +1499,9 @@
"archived": {
"type": "boolean"
},
"assetId": {
"type": "string"
},
"description": {
"type": "string"
},
@ -1883,6 +1914,14 @@
}
}
},
"v1.EnsureAssetIDResult": {
"type": "object",
"properties": {
"completed": {
"type": "integer"
}
}
},
"v1.GroupInvitation": {
"type": "object",
"properties": {

24
backend/app/api/static/docs/swagger.yaml
View file

@ -98,6 +98,9 @@ definitions:
properties:
archived:
type: boolean
assetId:
example: "0"
type: string
attachments:
items:
$ref: '#/definitions/repo.ItemAttachment'
@ -204,6 +207,8 @@ definitions:
properties:
archived:
type: boolean
assetId:
type: string
description:
type: string
fields:
@ -477,6 +482,11 @@ definitions:
new:
type: string
type: object
v1.EnsureAssetIDResult:
properties:
completed:
type: integer
type: object
v1.GroupInvitation:
properties:
expiresAt:
@ -516,6 +526,20 @@ info:
title: Go API Templates
version: "1.0"
paths:
/v1/actions/ensure-asset-ids:
post:
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/v1.EnsureAssetIDResult'
security:
- Bearer: []
summary: Get the current user
tags:
- Group
/v1/groups:
get:
produces:

26
backend/internal/core/services/service_items.go
View file

@ -23,6 +23,32 @@ type ItemService struct {
at attachmentTokens
}
func (svc *ItemService) EnsureAssetID(ctx context.Context, GID uuid.UUID) (int, error) {
items, err := svc.repo.Items.GetAllZeroAssetID(ctx, GID)
if err != nil {
return 0, err
}
highest, err := svc.repo.Items.GetHighestAssetID(ctx, GID)
if err != nil {
return 0, err
}
finished := 0
for _, item := range items {
highest++
err = svc.repo.Items.SetAssetID(ctx, GID, item.ID, repo.AssetID(highest))
if err != nil {
return 0, err
}
finished++
}
return finished, nil
}
func (svc *ItemService) CsvImport(ctx context.Context, GID uuid.UUID, data [][]string) (int, error) {
loaded := []csvRow{}

69
backend/internal/data/repo/repo_items.go
View file

@ -2,6 +2,9 @@ package repo
import (
"context"
"fmt"
"strconv"
"strings"
"time"
"github.com/google/uuid"
@ -18,6 +21,30 @@ type ItemsRepository struct {
db *ent.Client
}
type AssetID int
func (aid AssetID) MarshalJSON() ([]byte, error) {
str := fmt.Sprintf("%d", aid)
for len(str) < 6 {
str = "0" + str
}
return []byte(fmt.Sprintf(`"%s"`, str)), nil
}
func (aid *AssetID) UnmarshalJSON(data []byte) error {
str := string(strings.Replace(string(data), `"`, "", -1))
aidInt, err := strconv.Atoi(str)
if err != nil {
return err
}
*aid = AssetID(aidInt)
return nil
}
type (
ItemQuery struct {
Page int
@ -52,6 +79,7 @@ type (
ItemUpdate struct {
ParentID uuid.UUID `json:"parentId" extensions:"x-nullable,x-omitempty"`
ID uuid.UUID `json:"id"`
AssetID AssetID `json:"assetId"`
Name string `json:"name"`
Description string `json:"description"`
Quantity int `json:"quantity"`
@ -107,6 +135,7 @@ type (
ItemOut struct {
Parent *ItemSummary `json:"parent,omitempty" extensions:"x-nullable,x-omitempty"`
ItemSummary
AssetID AssetID `json:"assetId,string"`
SerialNumber string `json:"serialNumber"`
ModelNumber string `json:"modelNumber"`
@ -215,6 +244,7 @@ func mapItemOut(item *ent.Item) ItemOut {
return ItemOut{
Parent: parent,
AssetID: AssetID(item.AssetID),
ItemSummary: mapItemSummary(item),
LifetimeWarranty: item.LifetimeWarranty,
WarrantyExpires: item.WarrantyExpires,
@ -359,6 +389,42 @@ func (e *ItemsRepository) GetAll(ctx context.Context, gid uuid.UUID) ([]ItemSumm
All(ctx))
}
func (e *ItemsRepository) GetAllZeroAssetID(ctx context.Context, GID uuid.UUID) ([]ItemSummary, error) {
q := e.db.Item.Query().Where(
item.HasGroupWith(group.ID(GID)),
item.AssetID(0),
).Order(
ent.Asc(item.FieldCreatedAt),
)
return mapItemsSummaryErr(q.All(ctx))
}
func (e *ItemsRepository) GetHighestAssetID(ctx context.Context, GID uuid.UUID) (AssetID, error) {
q := e.db.Item.Query().Where(
item.HasGroupWith(group.ID(GID)),
).Order(
ent.Desc(item.FieldAssetID),
).Limit(1)
result, err := q.First(ctx)
if err != nil {
return 0, err
}
return AssetID(result.AssetID), nil
}
func (e *ItemsRepository) SetAssetID(ctx context.Context, GID uuid.UUID, ID uuid.UUID, assetID AssetID) error {
q := e.db.Item.Update().Where(
item.HasGroupWith(group.ID(GID)),
item.ID(ID),
)
_, err := q.SetAssetID(int(assetID)).Save(ctx)
return err
}
func (e *ItemsRepository) Create(ctx context.Context, gid uuid.UUID, data ItemCreate) (ItemOut, error) {
q := e.db.Item.Create().
SetImportRef(data.ImportRef).
@ -414,7 +480,8 @@ func (e *ItemsRepository) UpdateByGroup(ctx context.Context, gid uuid.UUID, data
SetInsured(data.Insured).
SetWarrantyExpires(data.WarrantyExpires).
SetWarrantyDetails(data.WarrantyDetails).
SetQuantity(data.Quantity)
SetQuantity(data.Quantity).
SetAssetID(int(data.AssetID))
currentLabels, err := e.db.Item.Query().Where(item.ID(data.ID)).QueryLabel().All(ctx)
if err != nil {

28
backend/internal/data/repo/repo_items_test.go
View file

@ -2,6 +2,7 @@ package repo
import (
"context"
"encoding/json"
"testing"
"time"
@ -9,6 +10,33 @@ import (
"github.com/stretchr/testify/assert"
)
func TestAssetID_UnmarshalJSON(t *testing.T) {
rawjson := `{"aid":"000123"}`
st := struct {
AID AssetID `json:"aid"`
}{
AID: AssetID(0),
}
err := json.Unmarshal([]byte(rawjson), &st)
assert.NoError(t, err)
assert.Equal(t, AssetID(123), st.AID)
}
func TestAssetID_MarshalJSON(t *testing.T) {
st := struct {
AID AssetID `json:"aid"`
}{
AID: AssetID(123),
}
b, err := json.Marshal(st)
assert.NoError(t, err)
assert.JSONEq(t, `{"aid":"000123"}`, string(b))
}
func itemFactory() ItemCreate {
return ItemCreate{
Name: fk.Str(10),

10
frontend/lib/api/classes/actions.ts Normal file
View file

@ -0,0 +1,10 @@
import { BaseAPI, route } from "../base";
import { EnsureAssetIDResult } from "../types/data-contracts";
export class ActionsAPI extends BaseAPI {
ensureAssetIDs() {
return this.http.post<void, EnsureAssetIDResult>({
url: route("/actions/ensure-asset-ids"),
});
}
}

8
frontend/lib/api/types/data-contracts.ts
View file

@ -71,6 +71,9 @@ export interface ItemField {
export interface ItemOut {
archived: boolean;
/** @example 0 */
assetId: string;
attachments: ItemAttachment[];
children: ItemSummary[];
createdAt: Date;
@ -131,6 +134,7 @@ export interface ItemSummary {
export interface ItemUpdate {
archived: boolean;
assetId: string;
description: string;
fields: ItemField[];
id: string;
@ -300,6 +304,10 @@ export interface ChangePassword {
new: string;
}
export interface EnsureAssetIDResult {
completed: number;
}
export interface GroupInvitation {
expiresAt: Date;
token: string;

3
frontend/lib/api/user.ts
View file

@ -4,6 +4,7 @@ import { LabelsApi } from "./classes/labels";
import { LocationsApi } from "./classes/locations";
import { GroupApi } from "./classes/group";
import { UserApi } from "./classes/users";
import { ActionsAPI } from "./classes/actions";
import { Requests } from "~~/lib/requests";
export class UserClient extends BaseAPI {
@ -12,6 +13,7 @@ export class UserClient extends BaseAPI {
items: ItemsApi;
group: GroupApi;
user: UserApi;
actions: ActionsAPI;
constructor(requests: Requests) {
super(requests);
@ -21,6 +23,7 @@ export class UserClient extends BaseAPI {
this.items = new ItemsApi(requests);
this.group = new GroupApi(requests);
this.user = new UserApi(requests);
this.actions = new ActionsAPI(requests);
Object.freeze(this);
}

4
frontend/pages/item/[id]/index.vue
View file

@ -100,6 +100,10 @@
name: "Notes",
text: item.value?.notes,
},
{
name: "Asset ID",
text: item.value?.assetId,
},
...item.value.fields.map(field => {
/**
* Support Special URL Syntax

45
frontend/pages/profile.vue
View file

@ -163,6 +163,25 @@
passwordChange.current = "";
passwordChange.loading = false;
}
async function ensureAssetIDs() {
const { isCanceled } = await confirm.open(
"Are you sure you want to ensure all assets have an ID? This will take a while and cannot be undone."
);
if (isCanceled) {
return;
}
const result = await api.actions.ensureAssetIDs();
if (result.error) {
notify.error("Failed to ensure asset IDs.");
return;
}
notify.success(`${result.data.completed} assets have been updated.`);
}
</script>
<template>
@ -286,6 +305,32 @@
</div>
</BaseCard>
<BaseCard>
<template #title>
<BaseSectionHeader>
<Icon name="mdi-warning" class="mr-2 -mt-1 text-base-600" />
<span class="text-base-600"> Actions </span>
<template #description>
Apply Actions to your inventory in bulk. These are irreversible actions. Be careful.
</template>
</BaseSectionHeader>
<div class="py-4 border-t-2 border-gray-300">
<div class="grid grid-cols-1 md:grid-cols-4 gap-10">
<div class="col-span-3">
<h4>Manage Asset IDs</h4>
<p class="text-sm">
Ensures that all items in your inventory have a valid asset_id field. This is done by finding the
highest current asset_id field in the database and applying the next value to each item that has an
unset asset_id field. This is done in order of the created_at field.
</p>
</div>
<BaseButton class="btn-primary mt-auto" @click="ensureAssetIDs"> Ensure Asset IDs </BaseButton>
</div>
</div>
</template>
</BaseCard>
<BaseCard>
<template #title>
<BaseSectionHeader>