TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-02-15 20:33:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace hardcoded number by a config value

Browse Source
This commit is contained in:
Eike Kettner 2020-06-14 00:48:19 +02:00
parent 479a341b13
commit e15e2c9313
5 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
modules/restserver/src/main/resources/reference.conf
View File

@ -17,6 +17,13 @@ docspell.server {
port = 7880
}
# This is a hard limit to restrict the size of a batch that is
# returned when searching for items. The user can set this limit
# within the client config, but it is restricted by the server to
# the number defined here. An admin might choose a lower number
# depending on the available resources.
max-item-page-size = 500
# Authentication.
auth {

3
modules/restserver/src/main/scala/docspell/restserver/Config.scala
View File

@ -12,7 +12,8 @@ case class Config(
bind: Config.Bind,
backend: BackendConfig,
auth: Login.Config,
integrationEndpoint: Config.IntegrationEndpoint
integrationEndpoint: Config.IntegrationEndpoint,
maxItemPageSize: Int
)
object Config {

2
modules/restserver/src/main/scala/docspell/restserver/RestServer.scala
View File

@ -69,7 +69,7 @@ object RestServer {
"user" -> UserRoutes(restApp.backend, token),
"collective" -> CollectiveRoutes(restApp.backend, token),
"queue" -> JobQueueRoutes(restApp.backend, token),
"item" -> ItemRoutes(restApp.backend, token),
"item" -> ItemRoutes(cfg, restApp.backend, token),
"attachment" -> AttachmentRoutes(restApp.backend, token),
"upload" -> UploadRoutes.secured(restApp.backend, cfg, token),
"checkfile" -> CheckFileRoutes.secured(restApp.backend, token),

11
modules/restserver/src/main/scala/docspell/restserver/routes/ItemRoutes.scala
View File

@ -13,12 +13,17 @@ import org.http4s.circe.CirceEntityDecoder._
import docspell.restapi.model._
import docspell.common.syntax.all._
import docspell.restserver.conv.Conversions
import docspell.restserver.Config
import org.log4s._
object ItemRoutes {
private[this] val logger = getLogger
def apply[F[_]: Effect](backend: BackendApp[F], user: AuthToken): HttpRoutes[F] = {
def apply[F[_]: Effect](
cfg: Config,
backend: BackendApp[F],
user: AuthToken
): HttpRoutes[F] = {
val dsl = new Http4sDsl[F] {}
import dsl._
@ -31,7 +36,7 @@ object ItemRoutes {
_ <- logger.ftrace(s"Running query: $query")
items <- backend.item.findItems(
query,
Batch(mask.offset, mask.limit).restrictLimitTo(500)
Batch(mask.offset, mask.limit).restrictLimitTo(cfg.maxItemPageSize)
)
resp <- Ok(Conversions.mkItemList(items))
} yield resp
@ -44,7 +49,7 @@ object ItemRoutes {
_ <- logger.ftrace(s"Running query: $query")
items <- backend.item.findItemsWithTags(
query,
Batch(mask.offset, mask.limit).restrictLimitTo(500)
Batch(mask.offset, mask.limit).restrictLimitTo(cfg.maxItemPageSize)
)
resp <- Ok(Conversions.mkItemListWithTags(items))
} yield resp

13
nix/module-server.nix
View File

@ -13,6 +13,7 @@ let
app-name = "Docspell";
app-id = "rest1";
base-url = "http://localhost:7880";
max-item-page-size = 500;
bind = {
address = "localhost";
port = 7880;
@ -100,6 +101,18 @@ in {
'';
};
max-item-page-size = mkOption {
type = types.int;
default = defaults.max-item-page-size;
description = ''
This is a hard limit to restrict the size of a batch that is
returned when searching for items. The user can set this limit
within the client config, but it is restricted by the server to
the number defined here. An admin might choose a lower number
depending on the available resources.
'';
};
bind = mkOption {
type = types.submodule({
options = {