Files
epolicy-dash-back/AGENTS.md

29 KiB
Raw Blame History

KRI Development Base Instructions

This document defines the shared working rules for KRI development repositories. Keep project-specific facts and commands in the project profile and project rules.

Instruction Resolution

Apply repository instructions in this order:

  1. Base rules
  2. Project-type rules
  3. Technology-stack rules
  4. Shared consumer contracts
  5. Project-specific rules
  6. The explicitly approved task scope

Later and more specific instructions may override earlier general instructions only within their stated scope.

  • Apply a shared consumer contract only when .agent/profile.yml declares it.
  • Do not silently resolve a material instruction conflict. Report the conflicting rules and request a decision before changing files.
  • Rules involving destructive actions, credentials, external systems, production, deployment, databases, or Git publication require explicit authorization even when a later rule is less restrictive.

Communication

  • Respond to the user in Korean unless the user requests another language.
  • Keep code identifiers, commands, paths, protocol names, and external API terms in their original form.
  • Follow the repository's existing language conventions for code comments and user-facing messages.
  • Lead with the result or decision, then provide only the detail needed to verify it.
  • Do not create or retain a full session transcript.

Work Authorization

  • The default workflow is discussion first and explicit execution approval second.
  • During discussion, perform only read-only investigation needed to understand the task and propose a concrete plan, unless the user prohibits inspection.
  • Read-only investigation may include file inspection, code search, encoding checks, git status, git diff, git log, and sanitized official-documentation lookup.
  • Before execution approval, do not edit files, install dependencies, run builds or tests, start services, connect to databases, or change local or external state.
  • Before requesting approval, describe the intended scope, affected areas, validation plan, and material risks.
  • Treat approval as limited to the presented scope. Pause and discuss again if the work materially expands.
  • If the user explicitly requests immediate execution without prior discussion, the discussion gate may be skipped for the stated scope.
  • Fast-track authorization does not implicitly authorize protected operations such as destructive commands, production changes, deployments, database mutations, Git publication, or external messages.

Local Development Environment

  • Primary OS: Windows 11.
  • Primary shell: PowerShell.
  • Use Git Bash only when the repository already depends on Bash or POSIX shell behavior.
  • Prefer repository-provided wrappers and scripts over globally installed commands.
  • Do not assume that GNU utilities, WSL, Docker, or a Unix-compatible shell are available unless the project profile confirms them.
  • Detect Java, Node.js, .NET, Python, package-manager, and database-tool versions from repository configuration.
  • Do not install or modify global toolchains as part of a project task.

Preferred human-facing tools:

  • Classic ASP: Visual Studio Code

  • Java and Spring Boot: IntelliJ IDEA

  • C# and .NET: JetBrains Rider

  • JavaScript, TypeScript, and Next.js: JetBrains WebStorm

  • Python: JetBrains PyCharm

  • Microsoft SQL Server: SQL Server Management Studio

  • Other databases: JetBrains DataGrip

  • These preferences do not authorize launching or controlling a GUI application.

  • Prefer IDE-independent commands that can also run in CI.

  • Do not modify global IDE settings.

  • Do not create or modify .idea, .vscode, workspace, or run-configuration files unless the approved task requires it.

  • Preserve existing shared IDE configuration when it is already tracked.

PowerShell and Path Safety

  • Quote paths containing spaces, brackets, parentheses, Korean characters, or PowerShell metacharacters.
  • Prefer -LiteralPath when operating on an exact filesystem path.
  • Use project-relative paths in committed configuration and documentation. Do not commit machine-specific paths such as D:\_____Dev\....
  • Do not pass filesystem targets between PowerShell, cmd.exe, and Bash for destructive or recursive operations.
  • Keep a filesystem operation within one shell from target resolution through execution.
  • Before a recursive delete or move, resolve and verify every absolute target.
  • Never use a drive root, workspace root, user profile, unresolved variable, wildcard, or broad glob as a recursive delete target.
  • Prefer recoverable operations when practical.

Change Discipline

  • Preserve all existing user changes, including uncommitted and untracked work.
  • Keep changes minimal but complete for the approved objective.
  • Avoid unrelated cleanup, formatting, renaming, dependency upgrades, and architectural refactoring.
  • Do not overwrite or revert unrelated changes.
  • Stop and report when the requested change overlaps existing work in a way that cannot be handled safely.
  • Prefer changing an authoritative source over editing generated output.
  • Treat files marked as generated as read-only unless regeneration is part of the approved plan.
  • Do not edit vendored dependencies, build outputs, caches, or generated clients unless explicitly required.
  • Do not regenerate a broad set of files for a narrow change without first explaining the expected output scope.

Text Encoding and Korean Content Safety

  • Treat the existing file encoding, BOM state, and line-ending style as part of the file's contract.
  • Preserve Korean comments, user-facing messages, error messages, identifiers, and documentation exactly unless the task explicitly requires changing them.
  • Do not assume that garbled terminal output means the file itself is corrupted. Verify bytes and encoding before modifying suspicious text.
  • Before editing an existing text file, determine its current encoding and BOM state when repository configuration does not already guarantee them.
  • Do not convert encoding, add or remove a BOM, or normalize line endings as a side effect of an unrelated change.
  • Avoid whole-file rewrites for small changes.
  • Do not rewrite source files through Get-Content | Set-Content, Out-File, shell redirection, or another method whose encoding behavior is implicit.
  • Do not use a patching or formatting tool on a non-UTF-8 file unless it is known to preserve that file's encoding.
  • Treat a console display problem and an on-disk encoding problem as separate issues.
  • After editing Korean text, inspect the diff for replacement characters (<EFBFBD>), mojibake, unexpected escapes, BOM changes, and unrelated line-ending changes.
  • Run .agent/tools/check-encoding.ps1 when it is available and the change touches Korean text or a non-default encoding.
  • If encoding cannot be identified confidently, stop before writing and report the affected file and evidence.
  • For a new text file, follow repository configuration. If no rule exists, use UTF-8 without BOM.

Git Safety

  • Use git status, git diff, and git log for read-only investigation.
  • Do not run commit, push, pull, fetch, merge, rebase, reset, checkout, switch, stash, clean, tag, or force operations unless that specific operation is explicitly approved.
  • Source-edit approval does not include commit or push approval.
  • Never amend an existing commit unless explicitly requested.
  • Before an approved commit, show the intended files, validation results, and proposed commit message.
  • Never push directly to a protected branch unless the user names the target branch and explicitly authorizes the push.

Dependencies and External Actions

  • Use the package manager, lockfile, and toolchain already selected by the repository.
  • Do not install global packages.
  • Do not add, remove, or upgrade a dependency unless it was included in the approved plan.
  • Pause for approval if an unplanned dependency becomes necessary.
  • Keep lockfiles synchronized with approved dependency changes.
  • Do not deploy, publish packages, create releases, send messages or email, call business APIs, or modify external services unless explicitly requested.
  • Never upload proprietary source code, internal documents, credentials, customer data, or database contents to an external service.
  • Remove secrets and unnecessary internal identifiers from external search queries.

Database Safety

  • Treat writing or reviewing SQL as source code separately from executing SQL against a database.
  • SQL files, migrations, schema proposals, and query drafts may be created within an approved source-change scope.
  • Do not connect to a shared, staging, or production database without explicit authorization for that environment.
  • Read-only queries against a non-local database also require authorization because results may contain sensitive data.
  • Do not execute DDL, DML, stored procedures, migrations, administrative commands, or data-correction scripts against a non-disposable database without separate authorization for the exact target and operation.
  • Source-change approval does not authorize migration execution.
  • Use a disposable local or test database for approved validation only after verifying its identity and disposable nature.
  • Never place credentials, connection strings, or sensitive query results in source files, logs, generated documents, or chat output.

Secrets and Sensitive Data

  • Never add credentials, tokens, passwords, private keys, connection strings, session identifiers, or production data to source control.
  • Read sensitive files only when the approved task requires it and no safer source exists.
  • Prefer inspecting configuration keys and schemas without displaying secret values.
  • Never echo secrets into terminal output, chat responses, logs, diffs, generated documents, test fixtures, or screenshots.
  • Redact sensitive values when reporting errors or command output.
  • If a possible secret is discovered, do not repeat it. Report only its location, type, and recommended containment action.
  • Do not rotate, revoke, copy, or otherwise modify credentials unless that exact action is explicitly authorized.

Validation

  • Discover supported build, test, lint, type-check, and formatting commands from repository files and project instructions. Do not invent commands.
  • Include intended validation in the discussion-phase plan.
  • After approved changes, run the narrowest relevant validation first, then broader checks when appropriate.
  • Limit formatting to files within the approved scope.
  • Do not run tests that require a shared database, production service, paid external API, or sensitive data unless separately authorized.
  • Do not claim that a check passed unless it was executed successfully.
  • If a check cannot be run, state the exact reason.
  • Distinguish a current-change failure from a pre-existing failure or an undetermined failure.
  • Do not fix unrelated failures without expanding the approved scope.
  • Inspect the worktree after validation for unexpected generated files, formatting churn, encoding changes, or lockfile changes.

Artifacts and Session Records

  • Do not create full-session transcripts, automatic HTML copies, analysis reports, or extra documentation unless explicitly requested.
  • Store durable information in the repository's existing documentation structure.
  • Do not place generated reports or temporary analysis files in the repository root.
  • Remove task-specific temporary files created by the current task after validation when removal is safe.

Completion Report

When implementation is complete, report in Korean:

  • what changed and why;

  • the main affected files or components;

  • validation commands actually executed and their results;

  • checks not executed and the reason;

  • remaining risks, assumptions, or follow-up work;

  • database, deployment, dependency, encoding, and compatibility impact when applicable.

  • Do not report completion while required validation is failing or known encoding corruption is unresolved.

  • Keep the report concise and do not include a full session transcript.

Requested Project Rules

  • Treat the approved requirements, acceptance criteria, and recorded decisions as the primary scope boundary.
  • Do not infer a requirement solely from a file name, folder date, or apparently newer document.
  • When requirements conflict, report the exact sources and request a decision.
  • Preserve original customer, partner, and planning documents as read-only evidence unless document editing is explicitly approved.
  • Summarize durable implementation requirements inside the repository rather than relying only on files outside the repository.
  • Do not expand the deliverable with speculative features, infrastructure, or architectural changes.
  • Record material assumptions and unresolved decisions in the project-specific rules or existing project documentation.
  • Define observable acceptance criteria before implementation.
  • Treat separately managed Frontend and Backend repositories as independent deliverables with a coordinated contract.
  • Protect customer, partner, survey, and field data as sensitive information.
  • Keep handoff, operation, configuration, and validation instructions usable by the requesting team.
  • Report deviations from the requested scope and obtain approval before proceeding.

Java and Spring Boot

  • Treat the configured JDK, Spring Boot, Gradle, plugin, dependency, and package versions as authoritative.
  • Use the repository's Gradle Wrapper. Do not substitute a machine-global Gradle installation.
  • Preserve the established package layout and controller, application/service, domain, and persistence boundaries.
  • Keep controllers thin, place business rules in the established service/domain layer, and prefer constructor injection.
  • Apply request and configuration validation at boundaries and preserve the project's exception and response conventions.
  • Make transaction boundaries explicit and narrow; do not add broad transactions to hide lifecycle or query problems.
  • Preserve authentication, authorization, auditing, logging, and secret-management conventions.
  • Do not edit generated QueryDSL or other generated sources. Change their source definitions and regenerate only when the repository workflow requires it.
  • Use the approved KriCommon contract when the project profile includes it; do not duplicate shared backend behavior locally.
  • Run the narrowest relevant Gradle compile, test, static-analysis, and build tasks.

MySQL

  • Use MySQL syntax and behavior only for data sources whose declared engine is mysql.
  • Preserve the configured version, schema, character set, collation, time zone, naming, migration, and access conventions.
  • Parameterize values. Do not build SQL by concatenating untrusted input.
  • Consider indexes and execution plans for changed filters, joins, ordering, grouping, and pagination without guessing from small data sets.
  • Preserve transaction, locking, null, date/time, decimal, and generated-key semantics.
  • Do not introduce MSSQL or other dialect syntax into MySQL paths.
  • A source-code change approval authorizes SQL analysis and migration drafting only. Execute DDL, DML, procedures, or migrations only with separate explicit approval and the declared data-source access level.

KriCommon Consumer Contract

Dependency and API Boundary

  • Consume KriCommon as com.kri.common:starter:<approved-version> using the consumer repository's established Gradle dependency and version-management conventions.
  • Import service-facing APIs from com.kri.common.feature.*. Treat com.kri.common.runtime.* as internal and do not bind application code to it unless no public API exists and the exception is explicitly documented.
  • Include the matching Spring starter for any optional Web, Security, JPA, Redis, AOP, or Swagger integration the service enables; KriCommon intentionally declares many integrations as compile-only.
  • Prefer the shared feature or an approved extension point over duplicating authentication, HTTP, error, enum, Excel, Redis, JSON, date/time, JPA, or utility behavior locally.

Configuration and Overrides

  • KriCommon configuration uses only kri.*. Established groups include kri.auth.jwt, kri.auth.apikey, kri.security, kri.swagger, kri.web, kri.web.mdc, kri.http.bypass, kri.redis, kri.scheduling, and kri.error.expose.
  • Read the version-matched README and configuration-property classes before setting a property; do not infer a property name or default from an older service.
  • Supply production JWT secrets, API keys, credentials, allowlists, and service URLs through the consumer's approved secret and configuration system. Never rely on library example or default secrets in production.
  • Preserve consumer override points. KriCommon's default security chain is created only when the consumer does not provide one, and overridable beans should remain explicit.
  • Adding a path to API-key allowed paths scopes where API-key authentication is attempted; it does not make the path public or grant authorization.

Major Optional Capabilities

  • JWT and API-key authentication integrate with Spring Security. API-key JPA preload requires Spring Data JPA; a consumer-provided claims provider can be used without JPA.
  • Common Web may register error handling, tracing/MDC, request-user resolution, enum conversion, and CORS behavior. Check for overlap before defining consumer-local equivalents.
  • Swagger support requires springdoc and defines the shared Bearer/API-key schemes and grouped paths.
  • Redis and scheduling are opt-in through their kri.*.enabled settings and matching runtime dependencies.
  • HTTP bypass targets are server-configured. Never accept an arbitrary full target URL from a frontend; retain allowed-path checks and do not forward hop-by-hop headers.
  • The external API client returns response bodies as documented, while bypass responses preserve raw bytes and target Content-Type.
  • ExternalApiClient multipart requests generate their own boundary and ignore a caller-supplied Content-Type. Multipart headers and formField values use UTF-8, while file bodies preserve the supplied bytes.
  • Multipart filenames, including non-ASCII names, are sent unchanged in the quoted filename parameter as raw UTF-8. No ASCII fallback or filename* parameter is added; CR/LF rejection and quote/backslash escaping still apply.
  • JsonUtil requires the consumer's explicit ObjectMapper; shared date/time helpers define KST as Asia/Seoul and also expose UTC semantics.

Upgrade and Verification

  • Review KriCommon release notes, README changes, configuration defaults, auto-configuration conditions, and affected public APIs before upgrading.
  • Commit dependency-lock or resolved-version changes according to the consumer repository's policy.
  • Run the consumer's focused compile and tests after an upgrade, including application-context startup tests when auto-configuration or security behavior is affected.
  • Do not modify KriCommon or another consumer repository unless it is explicitly included in the approved task scope.

Generated Spring Boot Repository Rules

  • This backend application was generated by @kri/create-spring-app with Java 17 and Spring Boot 3.5.7.
  • Consume KriCommon through com.kri.common:starter:beta.1.6.4; do not change that approved version or duplicate shared behavior without explicit approval.
  • The selected primary database is mysql. Preserve its configured dialect, driver, transaction, schema, and migration conventions.
  • Keep controllers thin and preserve the generated service, DTO, persistence, configuration, QueryDSL, JDBC, and optional MyBatis boundaries.
  • AGENTS.md and CLAUDE.md are central-harness generated outputs. Never edit them directly; update .agent/profile.yml or .agent/project.md and recompose.
  • After every .agent/project.md change, run cd "D:\_____Dev\_________AgentHarnessBase", then .\scripts\agent-harness.ps1 compose --project epolicy-dash-back and .\scripts\agent-harness.ps1 verify --project epolicy-dash-back to keep the generated agent documents current and verified.
  • Use the repository Gradle Wrapper and run .\gradlew.bat compileJava followed by focused tests for relevant changes.

Project Data Management Premises

  • Do not implement a frontend administration page at this stage. Do not add create, update, or delete features for individual information records unless a future approved requirement explicitly expands the scope.
  • Supply and maintain the data required by this project through Excel-based bulk upload instead of individual administration features.
  • Keep user and file data outside the Excel bulk-import scope. Import the remaining project data from one Excel workbook containing multiple sheets.
  • The Excel workbook contract uses nine required sheets named after their tables: t_wave, t_wave_info, t_survey, t_survey_item, t_part, t_part_item, t_part_item_sub, t_part_item_base, and t_part_item_data. Headers normally use database column names; append the complete allowed-value list in parentheses for constrained columns, such as is_open (1, 0), chart_type (bar), and is_chart_visible (1, 0). The workbook must contain all logical parent rows referenced by its child rows.
  • Treat every database column whose name ends with _idx as an auto-increment identity. Do not include these columns in Excel import or template sheets, and preserve an existing identity by matching the row's logical key during repeat imports.
  • For identity-backed Excel tables, use these import logical keys: (wave_cd, wave_info_order) for t_wave_info, (wave_cd, survey_cd, survey_item_order) for t_survey_item, (wave_cd, part_cd, part_item_cd, survey_cd, part_item_sub_cd) for t_part_item_base, and that same result-series key plus part_item_data_order for t_part_item_data.
  • Define the Excel import/export schema once with KriCommon ExcelColumn DTOs. Use KriCommon ExcelMapper for workbook mapping and keep only project-specific type, value, and cross-sheet relationship rules in a consumer-local validator; do not duplicate a general-purpose Excel parser.
  • Use POST /api/v1/excel/import for workbook import and GET /api/v1/excel/template for downloading an empty XLSX template. The exported template must contain the same nine required sheets in dependency order and the exact headers accepted by the importer.
  • Apply a valid workbook atomically using upsert semantics: insert new primary/logical keys, update matching keys, and retain existing database rows that are absent from the workbook. Do not use a bulk import to delete omitted rows unless a future approved requirement explicitly changes this policy.
  • A reference-file upload writes both the physical file and its t_file metadata. Accept fileTitle and fileOrder as multipart request fields, derive file_type from the lowercase filename extension, and keep the original filename as file_name.
  • For reference-file uploads, accept waveCd as a path variable and store the file under {kri.file.base-dir}/References/{waveCd} using the original filename. Treat (wave_cd, file_name) as the upload logical key: uploading the same filename again preserves file_idx, replaces the physical file, and updates file_title, file_order, and file_type.
  • Reject a reference-file upload when its waveCd does not exist. Coordinate the database transaction and filesystem replacement so a database rollback restores the previous file or removes a newly created file.

Dashboard Data Model Contract

  • Treat t_wave as the root of the dashboard hierarchy. Most child data is logically scoped by wave_cd.
  • Preserve this logical hierarchy: t_wave owns wave information, surveys, file metadata, and parts; a survey owns survey items; a part owns part items; and a part item owns optional sub-items, base counts, and result data.
  • Do not add physical database foreign keys. The backend must validate all logical parent-child relationships during Excel import and any future data mutation.
  • Treat (wave_cd, part_cd, part_item_cd) as the logical item key. Add survey_cd to identify a survey-specific result set and add part_item_sub_cd when a sub-item exists.
  • t_part_item_sub has no physical primary key in the planned schema. Treat (wave_cd, part_cd, part_item_cd, part_item_sub_cd) as its logical identifier and lookup key.
  • A normal item has no t_part_item_sub rows, and both base and data rows must use part_item_sub_cd = NULL. Never use 0 as a substitute for this NULL value.
  • An item with sub-items has one or more t_part_item_sub rows. Every non-null part_item_sub_cd in its base and data rows must reference a sub-item belonging to the same (wave_cd, part_cd, part_item_cd).
  • Every survey code used by t_part_item_base or t_part_item_data must belong to the same Wave. Survey items must likewise belong to an existing (wave_cd, survey_cd).
  • Treat t_survey.survey_color as a required VARCHAR(8) value. Include it as the survey_color column in the Excel template/import contract and persist it with each survey.
  • Use t_part_item_base as the preferred source for determining which survey audiences apply to an item. Display the single matching survey_alias when only one audience applies; display 공통 when all defined audiences apply.
  • Store an optional display string in t_part_item_base.base_text (VARCHAR(128)). Do not reconstruct it from base_count, and do not retain the removed base_pre_text or base_post_text fields in entities, Excel contracts, or query assembly.
  • Use the corresponding *_order column for API and screen ordering: wave_info_order, survey_order, survey_item_order, file_order, part_order, part_item_order, and part_item_data_order. Use part_item_sub_cd as the default sub-item order because the schema has no separate sub-item order column.
  • Use the same t_part_item_data rows for both chart and statistical-table views. is_chart_visible is a required Boolean column with database default 1; statistical tables use every row, while charts omit categories and matching values whose flag is false. Do not introduce a separate table-data source that could diverge from chart values.
  • Avoid N+1 query patterns when assembling a Wave dashboard. Fetch the required Part, Item, Sub, Base, and Data ranges in batches and assemble the response hierarchy in the backend.

Frontend API Contract

  • Provide screen-oriented APIs rather than exposing table-shaped CRUD endpoints. Use GET /api/v1/waves for the header Wave list, GET /api/v1/waves/{waveCd} for the Wave overview/navigation/download model, and GET /api/v1/waves/{waveCd}/parts/{partCd} for all items and result data in one Part.
  • Return every Wave in the header list and include both isOpen and a backend-computed accessible value. A user with userRole < 2010 may access open and closed Waves; a user with userRole >= 2010, or with no role, may access only Waves whose is_open is true.
  • Revalidate Wave access on both Wave-detail and Part-detail requests. Throw a KriCommon BusinessException with forbidden status when a restricted user requests a closed Wave; frontend visibility is not an authorization boundary.
  • Assemble normal and sub-item results through one resultGroups response shape. A normal item has one group with subItem = null; an item with sub-items has one group per Sub in part_item_sub_cd order.
  • Return categories as objects containing order, label, and chartVisible, alongside complete survey value series. The frontend uses all category/value indexes for statistical tables and filters matching indexes only for chart rendering. Reject Excel imports when category labels, display orders, or chart-visibility flags differ between survey series in the same Item/Sub result group.
  • Expose each survey's stored color as color in both Wave-detail survey objects and Part-detail series objects so the frontend uses one server-managed color mapping.
  • Return the stored nullable t_part_item_base.base_text value unchanged as Part-detail series[].baseText; baseCount remains a separate numeric field.
  • When importing part_item_data_value, round to scale 10 with RoundingMode.HALF_UP before validating and storing it as DECIMAL(14,10). Reject only values that still exceed precision 14 after rounding.
  • When part_item_comment is blank in Excel, store an empty string rather than NULL because the database column is required. Preserve the existing NULL semantics of other optional Excel fields.
  • Manage chart types as code enums. The initial supported type is BAR; Excel accepts its label bar case-insensitively, the database stores code BAR, and frontend responses return code BAR. Reject unsupported labels during Excel validation.
  • Build file download URLs in the backend from the configured file resource path and the stored file metadata. Do not require the frontend to construct filesystem paths.