drone/store/database/util.go

75 lines
2.0 KiB
Go

// Copyright 2023 Harness, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package database
import (
"context"
"database/sql"
"fmt"
"github.com/harness/gitness/store"
"github.com/pkg/errors"
"github.com/rs/zerolog/log"
)
// default query range limit.
const defaultLimit = 100
// limit returns the page size to a sql limit.
func Limit(size int) uint64 {
if size == 0 {
size = defaultLimit
}
return uint64(size)
}
// offset converts the page to a sql offset.
func Offset(page, size int) uint64 {
if page == 0 {
page = 1
}
if size == 0 {
size = defaultLimit
}
page--
return uint64(page * size)
}
// Logs the error and message, returns either the provided message.
// Always logs the full message with error as warning.
//
//nolint:unparam // revisit error processing
func ProcessSQLErrorf(ctx context.Context, err error, format string, args ...interface{}) error {
// If it's a known error, return converted error instead.
translatedError := err
switch {
case errors.Is(err, sql.ErrNoRows):
translatedError = store.ErrResourceNotFound
case isSQLUniqueConstraintError(err):
translatedError = store.ErrDuplicate
case isSQLForeignKeyViolationError(err):
translatedError = store.ErrForeignKeyViolation
default:
}
//nolint:errorlint // we want to match exactly here.
if translatedError != err {
log.Ctx(ctx).Debug().Err(err).Msgf("translated sql error to: %s", translatedError)
}
return fmt.Errorf("%s: %w", fmt.Sprintf(format, args...), translatedError)
}