Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions backend/common/core/pagination.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@

ModelT = TypeVar('ModelT', bound=SQLModel)

DEFAULT_PAGE_SIZE = 20
MAX_PAGE_SIZE = 500


def normalize_page_args(page: int, size: int) -> tuple[int, int]:
"""Clamp pagination inputs that arrive without bounds.

Page and size come from path parameters that carry no validation, so
``page=0`` used to build a negative OFFSET and ``size=0`` divided by zero
while computing ``total_pages``. Both turned a list request into a 500
instead of returning the first page, and an oversized ``size`` let one
request return an arbitrarily large result set.
"""
safe_page = page if isinstance(page, int) and page >= 1 else 1
if not isinstance(size, int) or size < 1:
safe_size = DEFAULT_PAGE_SIZE
else:
safe_size = min(size, MAX_PAGE_SIZE)
return safe_page, safe_size


class Paginator:
def __init__(self, session: Session):
self.session = session
Expand All @@ -32,6 +53,7 @@ async def paginate(
desc: bool = False,
**filters
) -> tuple[Sequence[Any], int]:
page, size = normalize_page_args(page, size)
offset = (page - 1) * size
single_model: bool = False
if isinstance(stmt, type) and issubclass(stmt, SQLModel):
Expand Down Expand Up @@ -66,6 +88,10 @@ async def paginate(
total_result = self.session.exec(count_stmt)
total: int = total_result.first()

# Skip out-of-range pages before binding an arbitrarily large OFFSET.
if offset >= total:
return [], total

# 应用分页
stmt = stmt.offset(offset).limit(size)

Expand All @@ -83,21 +109,22 @@ async def get_paginated_response(
pagination: PaginationParams,
**filters
) -> PaginatedResponse[Any]:
page, size = normalize_page_args(pagination.page, pagination.size)
items, total = await self.paginate(
stmt=stmt,
page=pagination.page,
size=pagination.size,
page=page,
size=size,
order_by=pagination.order_by,
desc=pagination.desc,
**filters
)

total_pages = (total + pagination.size - 1) // pagination.size
total_pages = (total + size - 1) // size

return PaginatedResponse[Any](
items=items,
total=total,
page=pagination.page,
size=pagination.size,
page=page,
size=size,
total_pages=total_pages
)
160 changes: 160 additions & 0 deletions backend/tests/test_pagination_arguments.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
"""Guard: out-of-range page/size must not turn a list request into a 500.

``/pager/{pageNum}/{pageSize}`` style routes hand raw path integers to
``PaginationParams``, so ``size=0`` divided by zero while computing
``total_pages`` and ``page=0`` produced a negative OFFSET for the database.
The checks below cover the normalization directly and through
``Paginator.get_paginated_response`` with a stubbed session.
"""

import asyncio

import pytest
from sqlalchemy import event
from sqlmodel import Field, Session, SQLModel, create_engine, select

from common.core.pagination import (
DEFAULT_PAGE_SIZE,
MAX_PAGE_SIZE,
Paginator,
normalize_page_args,
)
from common.core.schemas import PaginationParams


class PagedRow(SQLModel, table=True):
__tablename__ = "pagination_guard_row"

id: int | None = Field(default=None, primary_key=True)


class _Result:
def __init__(self, first_value=None):
self._first = first_value

def first(self):
return self._first

def all(self):
return []

def __iter__(self):
return iter(())


class _Session:
def __init__(self, total: int):
self.total = total
self.statements = []

def exec(self, stmt):
self.statements.append(stmt)
if "count" in str(stmt).lower():
return _Result(self.total)
return _Result()


def _paginate(pagination: PaginationParams, total: int = 42):
paginator = Paginator(_Session(total))
return asyncio.run(paginator.get_paginated_response(PagedRow, pagination))


def test_normalize_keeps_valid_arguments():
assert normalize_page_args(3, 40) == (3, 40)


def test_normalize_replaces_out_of_range_arguments():
assert normalize_page_args(0, 0) == (1, DEFAULT_PAGE_SIZE)
assert normalize_page_args(-1, -20) == (1, DEFAULT_PAGE_SIZE)
assert normalize_page_args(1, MAX_PAGE_SIZE + 1) == (1, MAX_PAGE_SIZE)


def test_zero_page_size_does_not_divide_by_zero():
response = _paginate(PaginationParams(page=1, size=0), total=42)
assert response.size == DEFAULT_PAGE_SIZE
assert response.total_pages == 3


def test_negative_page_returns_first_page():
response = _paginate(PaginationParams(page=0, size=20), total=42)
assert response.page == 1
assert response.size == 20
assert response.total_pages == 3


def test_oversized_page_size_is_bounded():
response = _paginate(PaginationParams(page=1, size=100000), total=42)
assert response.size == MAX_PAGE_SIZE
assert response.total_pages == 1


@pytest.mark.parametrize(
"page,size,expected_page,expected_size,count",
[
(1, 20, 1, 20, 20),
(2, 20, 2, 20, 20),
(1, 0, 1, 20, 20),
(0, 20, 1, 20, 20),
(-1, -20, 1, 20, 20),
(1, 500, 1, 500, 500),
(1, 501, 1, 500, 500),
(1, 1000000, 1, 500, 500),
(2, 500, 2, 500, 43),
(3, 500, 3, 500, 0),
(10**30, 20, 10**30, 20, 0),
],
)
def test_real_database_boundaries(page, size, expected_page, expected_size, count):
engine = create_engine("sqlite://")
SQLModel.metadata.create_all(engine, tables=[PagedRow.__table__])
statements = []
with Session(engine) as session:
session.add_all(PagedRow(id=i) for i in range(1, 544))
session.commit()
event.listen(
engine,
"before_cursor_execute",
lambda conn, cursor, statement, parameters, context, many: (
statements.append((statement, parameters))
),
)
response = asyncio.run(
Paginator(session).get_paginated_response(
select(PagedRow).order_by(PagedRow.id),
PaginationParams(page=page, size=size),
)
)
assert (response.page, response.size, response.total) == (
expected_page,
expected_size,
543,
)
assert response.total_pages == (543 + expected_size - 1) // expected_size
assert len(response.items) == count
if count:
assert response.items[0]["id"] == (expected_page - 1) * expected_size + 1
assert statements[-1][1] == (
expected_size,
(expected_page - 1) * expected_size,
)
else:
assert len(statements) == 1
engine.dispose()


def test_direct_paginate_and_empty_database():
engine = create_engine("sqlite://")
SQLModel.metadata.create_all(engine, tables=[PagedRow.__table__])
with Session(engine) as session:
paginator = Paginator(session)
assert asyncio.run(paginator.paginate(PagedRow, page=10**30, size=0)) == ([], 0)
response = asyncio.run(
paginator.get_paginated_response(PagedRow, PaginationParams())
)
assert (response.items, response.page, response.size, response.total_pages) == (
[],
1,
20,
0,
)
engine.dispose()
4 changes: 4 additions & 0 deletions docs/agents/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,7 @@ PYTHONPATH=. "$SQLBOT_TEST_PYTHON" -m pytest -q "$SQLBOT_XPACK_REPO/tests/test_a
默认使用合成 SQLite 用户及真实 FastAPI 路由、认证中间件、SQLModel 和事务,仅替换许可证有效性和第三方身份响应。OAuth2/CAS 适配器另有 HTTP 客户端边界回归。显式设置 `SQLBOT_BINDING_TEST_PG=1` 并安全提供 `SQLBOT_TEST_DATABASE_URL` 后,每个用例使用独立随机 PostgreSQL schema,补测迁移、重复历史映射预检、一级回滚和并发确认;不会访问业务 schema。默认 SQLite 不声称覆盖 PostgreSQL 行锁。

前端运行 `npm --prefix tests/browser test -- --config=account-binding.config.mjs`,本机夹具监听 `127.0.0.1:4236`,加载真实绑定组件和 API 封装,隔离当前用户、HTTP 及平台扫码 SDK。覆盖新窗口认证、通知与自动关闭、opener 缺失后的轮询、显式确认、取消、错误密码及企微/钉钉/飞书扫码;版本能力回归覆盖开源版基本信息、商业版绑定管理、许可证失效后的历史绑定与解绑,以及其他用户关联不影响本人的能力判断。它不替代真实平台应用配置、回调白名单、扫码和授权验收。

## 共享分页回归

`backend/tests/test_pagination_arguments.py` 覆盖共享分页器的参数归一化、SQLite 小数据分页、实际 LIMIT/OFFSET 绑定及响应元数据。超出总页数(包括极大页码)只执行 count,不向数据库绑定超大 OFFSET。该测试不覆盖 PostgreSQL 驱动、完整认证/授权路由链或独立知识分页实现。工作空间授权弹窗的浏览器回归见 `tests/browser/README.md` 的分页容量章节。
20 changes: 19 additions & 1 deletion frontend/src/api/workspace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,25 @@ import { request } from '@/utils/request'
export const workspaceUserList = (params: any, pageNum: number, pageSize: number) =>
request.get(`/system/workspace/uws/pager/${pageNum}/${pageSize}`, { params })

export const workspaceOptionUserList = (params: any, pageNum: number, pageSize: number) =>
export interface WorkspaceUserOption {
id: string | number
name: string
account: string
}

export interface WorkspaceUserOptionPage {
items: WorkspaceUserOption[]
page: number
size: number
total: number
total_pages: number
}

export const workspaceOptionUserList = (
params: { oid: string | number; keyword?: string },
pageNum: number,
pageSize: number
): Promise<WorkspaceUserOptionPage> =>
request.get(`/system/workspace/uws/option/pager/${pageNum}/${pageSize}`, { params })

export const workspaceUwsCreate = (data: any) => request.post('/system/workspace/uws', data)
Expand Down
24 changes: 18 additions & 6 deletions frontend/src/views/system/workspace/AuthorizedWorkspaceDialog.vue
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ import { workspaceOptionUserList, workspaceUwsCreate } from '@/api/workspace'
import avatar_personal from '@/assets/svg/avatar_personal.svg'
import Close from '@/assets/svg/icon_close_outlined_w.svg'
import Search from '@/assets/svg/icon_search-outline_outlined.svg'
import type { WorkspaceUserOption } from '@/api/workspace'
import type { CheckboxValueType } from 'element-plus-secondary'
const checkAll = ref(false)
const isIndeterminate = ref(false)
Expand Down Expand Up @@ -223,12 +224,23 @@ const open = async (id: any) => {
checkTableList.value = []
checkAll.value = false
isIndeterminate.value = false
const systemWorkspaceList = await workspaceOptionUserList({ oid }, 1, 1000000)
workspace.value = JSON.parse(
JSON.stringify(systemWorkspaceList.items.filter((ele: any) => +ele.id !== 1) as any)
)
loading.value = false
centerDialogVisible.value = true
workspace.value = []
try {
const candidates: WorkspaceUserOption[] = []
let page = 1
let totalPages = 1
do {
const result = await workspaceOptionUserList({ oid }, page, 500)
candidates.push(...result.items)
totalPages = result.total_pages
if (!result.items.length) break
page += 1
} while (page <= totalPages)
workspace.value = candidates.filter((user) => +user.id !== 1)
centerDialogVisible.value = true
} finally {
loading.value = false
}
}
const emits = defineEmits(['refresh'])
const handleConfirm = () => {
Expand Down
8 changes: 8 additions & 0 deletions tests/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,11 @@ npm --prefix tests/browser test -- --config=account-binding.config.mjs
```

夹具仅监听 `127.0.0.1:4236`。使用当前 checkout 的真实绑定页面、回调页、扫码组件和 API 封装,替换当前用户、HTTP 边界和外部扫码 SDK;不连接业务数据库或第三方认证平台。覆盖新窗口回调及关闭、轮询兜底、手动确认、解绑、密码错误、取消、窗口拦截和扫码刷新;二维码加载失败可刷新、验证中禁止重复刷新、按后端期限超时、停止轮询及忽略迟到响应。前端不自行推定平台二维码有效期。覆盖本地管理员绑定入口及非本地账号仅显示基本信息、不请求绑定接口;开源版不展示绑定标签或请求平台列表、许可证失效后仅可管理历史关联,解绑最后一项后回到基本信息。真实平台的回调地址、嵌入策略和授权权限需单独联调;飞书扫码授权不能在内嵌页完成时提供新窗口继续授权入口。

## 分页容量与成员候选列表回归

```sh
npm --prefix tests/browser test -- --config=pagination.config.mjs
```

夹具仅监听 `127.0.0.1:4247`,加载真实工作空间授权弹窗、产品样式和 API 封装,使用合成 HTTP 响应隔离后端。覆盖 543 名候选用户按每页 500 条加载、搜索并保存末页成员、空列表,以及后续页失败时不展示不完整候选列表。它不替代真实登录、权限链或数据库验收。
13 changes: 13 additions & 0 deletions tests/browser/fixtures/pagination/bridge.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Isolate HTTP transport while retaining the product API wrappers and component.
const call = async (method, url, data) => {
const response = await fetch('/api' + url, {
method, headers: { 'Content-Type': 'application/json' },
body: method === 'GET' ? undefined : JSON.stringify(data),
});
if (!response.ok) throw new Error('fixture request failed');
return response.json();
};
export const request = {
get: (url, config) => call('GET', url + '?' + new URLSearchParams(config?.params)),
post: (url, data) => call('POST', url, data),
};
1 change: 1 addition & 0 deletions tests/browser/fixtures/pagination/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<html><body><div id="app"></div><script type="module" src="/main.js"></script></body></html>
24 changes: 24 additions & 0 deletions tests/browser/fixtures/pagination/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { createApp, ref, h } from 'vue';
import { createI18n } from 'vue-i18n';
import ElementPlus from 'element-plus-secondary';
import 'element-plus-secondary/dist/index.css';
import '@/style.less';
import Dialog from '@/views/system/workspace/AuthorizedWorkspaceDialog.vue';
import zh from '@/i18n/zh-CN.json';
createApp({
components: { Dialog },
setup() {
const dialog = ref();
const error = ref('');
const open = async () => {
error.value = '';
try { await dialog.value.open('99'); } catch { error.value = 'load failed'; }
};
return () => h('div', [
h('button', { onClick: open }, 'Open members'),
h('p', { role: 'status' }, error.value),
h(Dialog, { ref: dialog }),
]);
},
}).use(createI18n({ legacy: false, locale: 'zh-CN', messages: { 'zh-CN': zh } }))
.use(ElementPlus).mount('#app');
Loading
Loading