Files
Gnuboard7/app/Search/Contracts/SearchIndexMaintainer.php
HeuJung b10e89bef0 fix(core,board,ecommerce,page,gdpr,ckeditor5,kginicis,admin_basic,basic): 목록 조회·검증 계층 정비 및 감사 지적 전건 처리
목록 조회 성능 축(깊은 OFFSET·정렬·색인)과 그 검증 계층에서 계획서 전수검수와 3회에 걸친
감사가 지적한 항목을 처리했다. 세부 경위는 의 각 회차 문서에 있다.

검증 계층 — 컨트롤러가 base Request 를 직접 주입받던 확장 13곳을 전용 FormRequest 로 옮겼다.
옮기면서 기존 동작 계약은 그대로 두었다: 상한 초과 limit 을 거부하지 않고 상한까지 반환하던
공개 API, per_page 를 범위로 조정하던 관리자 목록, 미지원 period 를 year 로 해석하던 인기글
목록 모두 종전과 같은 응답을 낸다. 상한/폴백을 rules 로 승격시키면 200 이던 응답이 422 가
되어 기존 링크가 깨지므로, 규칙은 타입만 닫고 클램프·폴백은 접근자가 맡는다. period 는
접근자가 닫힌 집합만 반환해 캐시 키 공간도 함께 닫힌다.

ckeditor5 이미지 업로드만 ResponseHelper 봉투를 쓰지 않는다. 응답을 파싱하는 주체가 CDN 으로
로드되는 상위 CKEditor5 43.3.1 의 SimpleUploadAdapter 라 규약을 바꿀 수 없어, 각 응답 지점에
사유를 명시한 면제를 부착하고 근거를 API 문서에 남겼다.

하네스 — 룰 5개의 대상 경로 패턴이 매처와 맞지 않아 번들 확장 컨트롤러가 검사 대상에서
통째로 빠져 있었다. 패턴을 고치자 확장 위반 17건이 드러나 전건 처리했다. severity 오타가
요약 집계 양쪽에 안 잡혀 "0 error" 로 보고되던 문제도 런너 사전 검증으로 막았다.

정렬 게이트 대조 하네스는 관계 정렬 변형만 쓰는 저장소를 탐지하지 못한 채 통과시키고 있었다.
탐지·제외·인자 파싱을 함께 고치고 단위 테스트를 신설했다.
2026-08-02 15:29:29 +09:00

79 lines
2.9 KiB
PHP

<?php
namespace App\Search\Contracts;
use App\Search\DTO\SearchIndexHealth;
/**
* 검색 인덱스 점검·재생성 계약
*
* Scout 엔진마다 "인덱스" 의 실체가 다릅니다 — MySQL FULLTEXT 는 테이블에 붙은 인덱스,
* Meilisearch/Elasticsearch 는 외부 서버의 인덱스입니다. 그래서 코어는 **무엇을 어떻게
* 점검·재생성할지 모르는 채** 이 계약만 호출하고, 판정 방법은 각 엔진 제공자가 정합니다.
*
* 확장(모듈/플러그인)이 자체 검색 엔진을 등록할 때 이 계약의 구현을 함께 등록하면
* 관리자 화면·커맨드·업데이트 절차가 코어 수정 없이 그 엔진을 다룹니다.
* 등록은 `core.search.index_maintainers` 필터 훅에 `드라이버명 => 구현 클래스` 로 합니다.
*
* ```php
* HookManager::addFilter('core.search.index_maintainers', function (array $maintainers) {
* $maintainers['meilisearch'] = MeilisearchIndexMaintainer::class;
*
* return $maintainers;
* });
* ```
*
* 구현하지 않은 엔진은 점검 대상에서 제외될 뿐 검색 자체는 정상 동작합니다.
*/
interface SearchIndexMaintainer
{
/**
* 이 유지보수기가 담당하는 Scout 드라이버명을 반환합니다.
*
* `config('scout.driver')` 값과 대조해 활성 엔진의 유지보수기를 고릅니다.
*
* @return string 드라이버명 (예: mysql-fulltext)
*/
public function driver(): string;
/**
* 현재 환경에서 점검을 수행할 수 있는지 반환합니다.
*
* 예) FULLTEXT 미지원 DBMS, 외부 검색 서버 미연결 등에서 false.
*
* @return bool 점검 가능 여부
*/
public function isAvailable(): bool;
/**
* 점검 불가 사유를 반환합니다.
*
* `isAvailable()` 이 false 일 때 운영자에게 보여 줄 문장입니다.
* 사유를 남기지 않으면 "점검 대상 0" 과 "점검할 수 없었음" 이 구분되지 않습니다.
*
* @return string|null 사유 (사용 가능하면 null)
*/
public function unavailableReason(): ?string;
/**
* 관리 중인 인덱스의 건강도를 판정합니다.
*
* @param array<string, mixed> $filters 엔진별 필터 (예: ['table' => 'pages'])
* @return array<int, SearchIndexHealth> 인덱스별 판정 결과
*/
public function inspect(array $filters = []): array;
/**
* 재생성이 필요하다고 판정된 인덱스를 재생성합니다.
*
* 재생성은 비용이 크고 서비스에 영향을 줄 수 있으므로, 호출자는 반드시
* 운영자의 명시적 선택을 받은 뒤에만 호출합니다.
*
* @param SearchIndexHealth $health 재생성 대상 판정 결과
* @return void
*
* @throws \Throwable 재생성 실패 시
*/
public function rebuild(SearchIndexHealth $health): void;
}