Pierre-Olivier Mercier
da1eb33faf
Thread a dropInvalid bool through every TidyUpUseCase method and expose it as a drop_invalid query parameter on POST /tidy (default true). When set, Tidy deletes records that fail to decode — e.g. legacy executions and evaluations whose CheckState.Status was stored as a string before the SDK switched it to int — instead of leaving them stuck in the store to log on every iteration. Also reset KVIterator.err on exhaustion so a prior decode failure does not surface as a spurious iteration error.
68 lines
2.3 KiB
Go
68 lines
2.3 KiB
Go
// This file is part of the happyDomain (R) project.
|
|
// Copyright (c) 2020-2024 happyDomain
|
|
// Authors: Pierre-Olivier Mercier, et al.
|
|
//
|
|
// This program is offered under a commercial and under the AGPL license.
|
|
// For commercial licensing, contact us at <contact@happydomain.org>.
|
|
//
|
|
// For AGPL licensing:
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package controller
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
|
|
"git.happydns.org/happyDomain/model"
|
|
)
|
|
|
|
type TidyController struct {
|
|
tidyUpService happydns.TidyUpUseCase
|
|
}
|
|
|
|
func NewTidyController(tidyUpService happydns.TidyUpUseCase) *TidyController {
|
|
return &TidyController{
|
|
tidyUpService: tidyUpService,
|
|
}
|
|
}
|
|
|
|
// tidyDB performs database cleanup and maintenance operations.
|
|
//
|
|
// @Summary Tidy up the database
|
|
// @Schemes
|
|
// @Description Performs cleanup and maintenance operations on the database, removing orphaned records and optimizing storage. When drop_invalid is true (default), records that fail to decode (e.g. after a schema change) are deleted; set it to false to only log them.
|
|
// @Tags admin
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param drop_invalid query bool false "Delete records that fail to decode instead of only logging (default true)"
|
|
// @Security securitydefinitions.basic
|
|
// @Success 200 {boolean} bool
|
|
// @Failure 500 {object} happydns.ErrorResponse "Internal server error"
|
|
// @Router /tidy [post]
|
|
func (tc *TidyController) TidyDB(c *gin.Context) {
|
|
dropInvalid := true
|
|
if v := c.Query("drop_invalid"); v != "" {
|
|
parsed, err := strconv.ParseBool(v)
|
|
if err != nil {
|
|
happydns.ApiResponse(c, nil, fmt.Errorf("drop_invalid must be a boolean: %w", err))
|
|
return
|
|
}
|
|
dropInvalid = parsed
|
|
}
|
|
|
|
happydns.ApiResponse(c, true, tc.tidyUpService.TidyAll(dropInvalid))
|
|
}
|