mirror of
https://github.com/penpot/penpot.git
synced 2026-11-19 16:40:38 +00:00
Compare commits
No commits in common. "develop" and "2.18.5-RC1" have entirely different histories.
develop
...
2.18.5-RC1
@ -337,32 +337,28 @@ small. To delegate without switching models, delegate to `general`.
|
|||||||
report with your intent: "investigate this and find the possible cause",
|
report with your intent: "investigate this and find the possible cause",
|
||||||
"investigate and tell me where this points", or "does this still apply?".
|
"investigate and tell me where this points", or "does this still apply?".
|
||||||
Explore until you and the agent roughly agree on the problem.
|
Explore until you and the agent roughly agree on the problem.
|
||||||
2. **Write the plan.** Invoke `@make-a-plan`. Skills use the current agent;
|
2. **Write the plan.** Run `/make-a-plan` — it executes in Build mode.
|
||||||
select Build mode first when the skill needs to write files. Use Plan mode
|
If you need to step in and answer something yourself, press TAB to
|
||||||
only when you want a hard guarantee that the agent modifies no file under
|
leave Build mode. Use Plan mode only when you want a hard guarantee
|
||||||
any circumstance. If you
|
that the agent modifies no file under any circumstance. If you
|
||||||
explored with a weaker model but want a stronger one to write the
|
explored with a weaker model but want a stronger one to write the
|
||||||
plan, switch models first or delegate:
|
plan, switch models first or delegate:
|
||||||
`@make-a-plan delegate to @engineer-glm`.
|
`/make-a-plan delegate to @engineer-glm`.
|
||||||
3. **Iterate on the plan.** The plan is saved to `.agents/plans/`, so you
|
3. **Iterate on the plan.** The plan is saved to `.agents/plans/`, so you
|
||||||
never depend on LLM memory: read the file directly, or invoke `@review-plan`
|
never depend on LLM memory: read the file directly, or run `/review-plan`
|
||||||
for a second opinion (delegation works here too). It applies clear plan
|
for a second opinion (delegation works here too). Complex plans deserve a
|
||||||
improvements and discusses consequential decisions one by one before
|
review; simple ones can skip it.
|
||||||
applying them. Complex plans deserve a review; simple ones can skip it.
|
4. **Execute.** Run `/implement-plan`. It first prints the full picture —
|
||||||
4. **Execute.** Invoke `@implement-plan`. It first prints the full picture —
|
|
||||||
whether it will create an issue and a branch, the execution style, and a
|
whether it will create an issue and a branch, the execution style, and a
|
||||||
task checklist — and waits for your go-ahead. Say "step by step" to stop
|
task checklist — and waits for your go-ahead. Say "step by step" to stop
|
||||||
after each task (one commit per task) so you can verify as it goes;
|
after each task (one commit per task) so you can verify as it goes;
|
||||||
the default runs all tasks with one final commit. For a plan based on a
|
the default runs all tasks with one final commit.
|
||||||
code review, it then asks whether to have the original reviewer verify the
|
5. **Land the work.** When it finishes, either push yourself and run
|
||||||
corrections. If that session is unavailable, it tells you and uses a new
|
`/create-pr`, or loop `/review-code` → `/make-a-plan` →
|
||||||
reviewer with the review and implementation context.
|
`/implement-plan` until the findings are addressed, then push and
|
||||||
5. **Land the work.** When it finishes, either push yourself and invoke
|
`/create-pr`. Nothing pushes for you — you always push from your shell.
|
||||||
`@create-pr`, or loop `@review-code` → `@make-a-plan` →
|
|
||||||
`@implement-plan` until the findings are addressed, then push and invoke
|
|
||||||
`@create-pr`. Nothing pushes for you — you always push from your shell.
|
|
||||||
|
|
||||||
> Note: `@implement-plan` checks the current branch. On a base branch
|
> Note: `/implement-plan` checks the current branch. On a base branch
|
||||||
> (`main`, `develop`, `staging`) it creates a GitHub issue and a branch
|
> (`main`, `develop`, `staging`) it creates a GitHub issue and a branch
|
||||||
> `issue-NNNN`; on an existing feature branch it continues there and
|
> `issue-NNNN`; on an existing feature branch it continues there and
|
||||||
> creates nothing. The pre-run summary tells you which applies. Read the
|
> creates nothing. The pre-run summary tells you which applies. Read the
|
||||||
@ -371,14 +367,14 @@ small. To delegate without switching models, delegate to `general`.
|
|||||||
|
|
||||||
### Big feature with multiple plans
|
### Big feature with multiple plans
|
||||||
|
|
||||||
When the work is too large for a single plan, tell `@make-a-plan`
|
When the work is too large for a single plan, tell `/make-a-plan`
|
||||||
up front: produce a high-level roadmap where each task will get its
|
up front: produce a high-level roadmap where each task will get its
|
||||||
own execution plan, and the roadmap doubles as the progress tracker.
|
own execution plan, and the roadmap doubles as the progress tracker.
|
||||||
|
|
||||||
From there the flow mirrors the issue flow above, one level down:
|
From there the flow mirrors the issue flow above, one level down:
|
||||||
take each roadmap task in turn, write its own plan (`@make-a-plan`,
|
take each roadmap task in turn, write its own plan (`/make-a-plan`,
|
||||||
delegating when it helps), review it when the task is complex
|
delegating when it helps), review it when the task is complex
|
||||||
(`@review-plan`), implement it (`@implement-plan`), and mark progress
|
(`/review-plan`), implement it (`/implement-plan`), and mark progress
|
||||||
on the roadmap as you land each piece.
|
on the roadmap as you land each piece.
|
||||||
|
|
||||||
### Plan file naming (base + derivatives)
|
### Plan file naming (base + derivatives)
|
||||||
@ -396,7 +392,7 @@ keeps everything adjacent in `ls`:
|
|||||||
`2026-09-20-upload-pipeline-roadmap--task-01-chunk-upload.md`
|
`2026-09-20-upload-pipeline-roadmap--task-01-chunk-upload.md`
|
||||||
- Chained: `...--task-02-gc--review-01.md`
|
- Chained: `...--task-02-gc--review-01.md`
|
||||||
|
|
||||||
While a plan is still unimplemented, `@make-a-plan` revises it in
|
While a plan is still unimplemented, `/make-a-plan` revises it in
|
||||||
place. Once implemented and reviewed, it writes a new followup file.
|
place. Once implemented and reviewed, it writes a new followup file.
|
||||||
Full rules live in the `planner` skill.
|
Full rules live in the `planner` skill.
|
||||||
|
|
||||||
@ -405,10 +401,11 @@ Full rules live in the `planner` skill.
|
|||||||
Every plan carries `Status: draft | reviewed | done` plus an
|
Every plan carries `Status: draft | reviewed | done` plus an
|
||||||
append-only `Review Log` (UTC ISO 8601, one line per entry):
|
append-only `Review Log` (UTC ISO 8601, one line per entry):
|
||||||
|
|
||||||
- `draft` — fresh from `@make-a-plan`.
|
- `draft` — fresh from `/make-a-plan`.
|
||||||
- `reviewed` — review feedback incorporated. `@review-plan` applies clear
|
- `reviewed` — review feedback incorporated. `/review-plan` stays
|
||||||
improvements and agreed decisions, then updates the status and log.
|
read-only; only your explicit "apply" makes `/make-a-plan` apply
|
||||||
- `done` — `@implement-plan` closes it on completion, logging the
|
the changes, flip the status, and log one line.
|
||||||
|
- `done` — `/implement-plan` closes it on completion, logging the
|
||||||
issue URL when one exists (never commit hashes).
|
issue URL when one exists (never commit hashes).
|
||||||
|
|
||||||
A plan approved with no changes goes `draft` → `done` directly.
|
A plan approved with no changes goes `draft` → `done` directly.
|
||||||
@ -508,6 +505,7 @@ JSON, REPL access, and so on.
|
|||||||
| [`ripgrep`](skills/ripgrep/SKILL.md) | Fast content search with regular expressions. |
|
| [`ripgrep`](skills/ripgrep/SKILL.md) | Fast content search with regular expressions. |
|
||||||
| [`jq-json-processor`](skills/jq-json-processor/SKILL.md) | Slice, filter, and reshape JSON output. |
|
| [`jq-json-processor`](skills/jq-json-processor/SKILL.md) | Slice, filter, and reshape JSON output. |
|
||||||
| [`nrepl-eval`](skills/nrepl-eval/SKILL.md) | Run Clojure or ClojureScript code in the live REPL sessions (backend and frontend). |
|
| [`nrepl-eval`](skills/nrepl-eval/SKILL.md) | Run Clojure or ClojureScript code in the live REPL sessions (backend and frontend). |
|
||||||
|
| [`taiga`](skills/taiga/SKILL.md) | Look up Penpot issues, user stories, and tasks in Taiga. |
|
||||||
| [`testing`](skills/testing/SKILL.md) | The repo's testing rules and TDD workflow, loaded before writing tests. |
|
| [`testing`](skills/testing/SKILL.md) | The repo's testing rules and TDD workflow, loaded before writing tests. |
|
||||||
| [`local-ci`](skills/local-ci/SKILL.md) | Run CI-style lint, test, and format checks for the modules you touched with `scripts/ci`, and read the logs when they fail. |
|
| [`local-ci`](skills/local-ci/SKILL.md) | Run CI-style lint, test, and format checks for the modules you touched with `scripts/ci`, and read the logs when they fail. |
|
||||||
| [`security-and-hardening`](skills/security-and-hardening/SKILL.md) | Security checks for code that handles user input, auth, or external services. |
|
| [`security-and-hardening`](skills/security-and-hardening/SKILL.md) | Security checks for code that handles user input, auth, or external services. |
|
||||||
@ -518,11 +516,11 @@ JSON, REPL access, and so on.
|
|||||||
|
|
||||||
### A typical round
|
### A typical round
|
||||||
|
|
||||||
1. `@make-a-plan` — you get a plan and a saved file in `.agents/plans/`.
|
1. `/make-a-plan` — you get a plan and a saved file in `.agents/plans/`.
|
||||||
2. `@review-plan` — a second opinion; approve or request changes.
|
2. `/review-plan` — a second opinion; approve or request changes.
|
||||||
3. `@implement-plan` — the code gets written and committed. Starting from a base branch, it also opens the GitHub issue and the `issue-NNNN` branch; the plans that follow continue on that same branch.
|
3. `/implement-plan` — the code gets written and committed. Starting from a base branch, it also opens the GitHub issue and the `issue-NNNN` branch; the plans that follow continue on that same branch.
|
||||||
4. `@review-code` — a reviewer checks the commit.
|
4. `/review-code` — a reviewer checks the commit.
|
||||||
5. `@create-pr` — the branch goes up as a pull request.
|
5. `/create-pr` — the branch goes up as a pull request.
|
||||||
|
|
||||||
Every step also works on its own, and you can always say what you want
|
Every step also works on its own, and you can always say what you want
|
||||||
in plain words — the agents pick the right skill from what you say.
|
in plain words — the agents pick the right skill from what you say.
|
||||||
|
|||||||
@ -1,95 +1,246 @@
|
|||||||
---
|
---
|
||||||
name: code-review-criteria
|
name: code-review-criteria
|
||||||
description: Code review criteria for correctness, clarity, architecture, security and performance. Loaded by the review-code subagent.
|
description: Code review criteria — the five review axes, core principles, severity format, and verdict for reviewing code changes. Loaded by the reviewer subagent of the review-code flow. Not a user-facing flow — to review code, use the review-code flow.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Code Review Criteria
|
# Code Review Criteria and Quality
|
||||||
|
|
||||||
Assess whether the change improves the codebase and is safe to merge. Review
|
## Overview
|
||||||
the diff in context, its intent and relevant tests. Follow project conventions
|
|
||||||
and module memories. Do not block on personal preferences or invent problems.
|
|
||||||
Apply each axis in proportion to the change and its risks.
|
|
||||||
|
|
||||||
Follow `review-code` for delegation and its read-only contract. Never run tests,
|
Multi-dimensional code review with quality gates. Every change gets reviewed before merge — no exceptions. Review covers five axes: correctness, readability, architecture, security, and performance.
|
||||||
builds, linters or other state-changing checks during a review or follow-up.
|
|
||||||
Inspect prior test results or CI evidence when available. Identify their source
|
|
||||||
and scope; if evidence is missing, stale or inaccessible, say what is
|
|
||||||
unverified. Never claim a suite passed without evidence.
|
|
||||||
|
|
||||||
## Review axes
|
**The approval standard:** Approve a change when it definitely improves overall code health, even if it isn't perfect. Perfect code doesn't exist — the goal is continuous improvement. Don't block a change because it isn't exactly how you would have written it. If it improves the codebase and follows the project's conventions, approve it.
|
||||||
|
|
||||||
### Correctness and tests
|
## When to Use
|
||||||
|
|
||||||
Check requirements, relevant boundaries, error paths, concurrency and state.
|
- The reviewer subagent of the `review-code` flow loads this skill to perform
|
||||||
Use the module's contracts to decide where validation belongs; do not demand
|
the review of a code change.
|
||||||
redundant guards inside functions with established preconditions. Check that
|
- To review code, always go through the `review-code` flow — never load this
|
||||||
new functionality has tests covering its behavior and important failure
|
skill directly for that. This is the criteria reference, not the flow.
|
||||||
cases, using the appropriate layer and project testing guidance. Missing
|
|
||||||
required tests are findings; documentation-only changes need not add tests.
|
|
||||||
Do not infer that a test failed before a fix without evidence.
|
|
||||||
|
|
||||||
### Readability and simplicity
|
## Core Principles
|
||||||
|
|
||||||
Check names, control flow and maintainability against existing conventions.
|
These principles underpin every axis. When in doubt, default to them.
|
||||||
Flag duplication when it creates a concrete risk of drift or maintenance
|
|
||||||
cost, not merely because code appears more than once. In tests, prefer
|
|
||||||
self-contained, readable cases even when they repeat setup. Suggest the
|
|
||||||
simplest remedy that preserves behavior.
|
|
||||||
|
|
||||||
### Architecture and compatibility
|
- **DRY (Don't Repeat Yourself):** Every piece of knowledge has one authoritative representation. If the same logic appears in two places, extract it into a shared helper, model, or type. Reviewers: flag duplicated logic as a required change — it's not "just similar," it's drift that will diverge.
|
||||||
|
- **KISS (Keep It Simple, Stupid):** The simplest solution that works is the best solution. Complexity must earn its place. Reviewers: if you need more than one sentence to explain what a piece of code does, it's too complex — push for simplification before merge.
|
||||||
|
- **YAGNI (You Aren't Gonna Need It):** Don't add abstractions, hooks, or generalizations for hypothetical future use cases. Generalize on the third occurrence, not the first. Reviewers: delete speculative generality.
|
||||||
|
- **Don't invent problems:** Do not manufacture issues to produce more feedback. Every finding must be a real risk, a real readability barrier, or a real architectural concern — not a hypothetical or a stylistic preference disguised as a problem.
|
||||||
|
|
||||||
Check module boundaries, existing abstractions, contracts and unnecessary
|
## The Five-Axis Review
|
||||||
complexity. Review surrounding code when needed to understand the change.
|
|
||||||
Do not label a compatibility shim dead code without checking its purpose.
|
|
||||||
For file formats or data model changes, consult the relevant compatibility,
|
|
||||||
migration and feature memories; for Clojure, logging and translations, read
|
|
||||||
the corresponding guidance when relevant.
|
|
||||||
|
|
||||||
### Security
|
Every review evaluates code across these dimensions.
|
||||||
|
|
||||||
Evaluate relevant input boundaries, authorization, secrets, data handling and
|
### 1. Correctness
|
||||||
external integrations. Consult project security guidance for the affected
|
|
||||||
technology; do not assume a generic framework or tool applies to this module.
|
|
||||||
|
|
||||||
### Performance
|
Does the code do what it claims to do?
|
||||||
|
|
||||||
Assess relevant hot paths, resource bounds, data access and scaling. Explain
|
- Does it match the spec or task requirements?
|
||||||
the workload or conditions in which a problem matters; do not flag speculative
|
- Are edge cases handled (null, empty, boundary values)?
|
||||||
optimizations without a concrete risk.
|
- Are error paths handled (not just the happy path)?
|
||||||
|
- Does it pass all tests? Are the tests actually testing the right things?
|
||||||
|
- Are there off-by-one errors, race conditions, or state inconsistencies?
|
||||||
|
|
||||||
## Scope and dependencies
|
### 2. Readability & Simplicity
|
||||||
|
|
||||||
Review relevant generated files or lockfile changes when they affect the
|
Can another engineer (or agent) understand this code without the author explaining it?
|
||||||
contract, dependencies or security; do not skip a lockfile-only dependency
|
|
||||||
change. Check dependency changes against available changelogs, project tools
|
|
||||||
and relevant lockfile diffs. Treat size as a signal to assess reviewability,
|
|
||||||
not an automatic finding. Identify unrelated work in the target diff when it
|
|
||||||
materially impedes review; do not review unrelated working-tree changes.
|
|
||||||
|
|
||||||
## Findings and verdict
|
- Are names descriptive and consistent with project conventions? (No `temp`, `data`, `result` without context)
|
||||||
|
- Is the control flow straightforward (avoid nested ternaries, deep callbacks)?
|
||||||
|
- Are there any "clever" tricks that should be simplified?
|
||||||
|
- **KISS check:** Is this the simplest approach that solves the problem? A 20-line straightforward function beats a 5-line clever one that requires a comment to explain.
|
||||||
|
- Could this be done in fewer lines? (1000 lines where 100 suffice is a failure)
|
||||||
|
- Are abstractions earning their complexity? (Don't generalize until the third use case)
|
||||||
|
- Is a new conditional bolted onto an unrelated flow? Push the logic into its own helper, state, or policy.
|
||||||
|
- Do repeated conditionals on the same shape appear? They signal a missing model or dispatcher.
|
||||||
|
- Are there dead code artifacts: no-op variables, backwards-compat shims, or `// removed` comments?
|
||||||
|
|
||||||
Assign each finding a stable ID (`F1`, `F2`, …), independent of severity.
|
### 3. Architecture
|
||||||
Never renumber it within the review or follow-up; severity may change as
|
|
||||||
evidence changes. New findings receive unused IDs.
|
|
||||||
|
|
||||||
For each finding state severity, file and location, concrete circumstances,
|
Does the change fit the system's design?
|
||||||
impact, remedy and the tests needed to verify it; explain when no new test is
|
|
||||||
needed. If a consequential decision requires user input, give the real options,
|
|
||||||
consequences and recommendation within that finding, without pausing to ask.
|
|
||||||
|
|
||||||
- **Critical:** security incident, data loss or comparably severe breakage;
|
- Does it follow existing patterns or introduce a new one? If new, is it justified?
|
||||||
blocks merge.
|
- Does it maintain clean module boundaries?
|
||||||
- **High:** a significant defect or missing required test; must be addressed.
|
- **DRY check:** Is there existing code that does the same thing? Reuse the canonical helper instead of writing a near-duplicate. If two branches do nearly the same thing, collapse them.
|
||||||
- **Medium:** a substantive issue worth fixing but not a merge blocker.
|
- Are dependencies flowing in the right direction (no circular dependencies)?
|
||||||
- **Low / Suggestion:** an optional improvement with a concrete benefit.
|
- Is the abstraction level appropriate (not over-engineered, not too coupled)?
|
||||||
|
- Does this refactor reduce complexity or just relocate it? Count the concepts a reader must hold. Prefer the restructuring that makes whole branches disappear over one that re-centralizes the same logic. Prefer deleting an abstraction to polishing it.
|
||||||
|
- Is feature-specific logic leaking into a shared or general-purpose module?
|
||||||
|
- Are type boundaries explicit? Question gratuitous `any`/`unknown`/optional/casts and silent fallbacks.
|
||||||
|
- **Structural remedies:** When you flag a problem, propose the move — not just the problem. Replace conditionals with dispatchers, collapse duplicate branches, separate orchestration from business logic, extract helpers, split large files. Prefer the remedy that removes moving pieces over one that spreads the same complexity around.
|
||||||
|
|
||||||
Base severity on impact and project requirements. Missing tests required for
|
### 4. Security
|
||||||
new functionality must be addressed; do not invent a test requirement for
|
|
||||||
changes where none applies.
|
|
||||||
|
|
||||||
Return a short summary, findings ordered by impact and a verdict with the
|
For detailed security guidance, see `security-and-hardening`.
|
||||||
relevant IDs: **Approve**, **Approve with minor changes**, or **Request
|
|
||||||
changes**. State verification evidence and limitations. Do not duplicate
|
- Is user input validated and sanitized?
|
||||||
remedies or tests in separate sections. If no findings exist, say so. In
|
- Are secrets kept out of code, logs, and version control?
|
||||||
follow-up, retain original IDs and
|
- Is authentication/authorization checked where needed?
|
||||||
report resolved, pending and not-addressed findings as `review-code` requires.
|
- Are SQL queries parameterized (no string concatenation)?
|
||||||
|
- Are outputs encoded to prevent XSS?
|
||||||
|
- Are dependencies from trusted sources with no known vulnerabilities?
|
||||||
|
- Is data from external sources (APIs, logs, user content, config files) treated as untrusted?
|
||||||
|
|
||||||
|
### 5. Performance
|
||||||
|
|
||||||
|
- Any N+1 query patterns?
|
||||||
|
- Any unbounded loops or unconstrained data fetching?
|
||||||
|
- Any synchronous operations that should be async?
|
||||||
|
- Any unnecessary re-renders in UI components?
|
||||||
|
- Any missing pagination on list endpoints?
|
||||||
|
- Any large objects created in hot paths?
|
||||||
|
|
||||||
|
## Review Process
|
||||||
|
|
||||||
|
1. **Understand the intent** — What is this change trying to accomplish? What spec or task does it implement?
|
||||||
|
2. **Review tests first** — Tests reveal intent and coverage. Do they test behavior, not implementation details? Are edge cases covered?
|
||||||
|
3. **Review the implementation** — Walk through each file with the five axes in mind.
|
||||||
|
4. **Categorize findings** — Label every comment with its severity:
|
||||||
|
|
||||||
|
| Prefix | Meaning | Author Action |
|
||||||
|
|--------|---------|---------------|
|
||||||
|
| **Critical:** | Blocks merge | Security vulnerability, data loss, broken functionality |
|
||||||
|
| **High:** | Required change | Must address before merge |
|
||||||
|
| **Medium:** | Should fix | Strongly recommended, not a blocker |
|
||||||
|
| **Low:** | Minor, optional | Author may ignore — formatting, style preferences |
|
||||||
|
| **Suggestion:** | Worth considering | Not required, but improves the code |
|
||||||
|
|
||||||
|
**Unique finding IDs.** Assign every finding a stable identifier: `F1`, `F2`, `F3`, … numbered in order of severity (Critical first, then High, Medium, Low, Suggestion). Use the ID everywhere the finding is mentioned — in section headers, in the verdict, in follow-up discussion. Never renumber within a review. Example: `**F3 (High)** — `app/validate.cljs:42` — duplicate branch logic…`.
|
||||||
|
|
||||||
|
For each finding, describe the circumstances under which it could fail: specific inputs, load conditions, timing, or user actions that trigger the problem. "This crashes when input is null" is actionable; "this might crash" is not.
|
||||||
|
|
||||||
|
Lead with what matters: correctness and security first, then structural issues, then everything else. A few high-conviction comments beat a long list.
|
||||||
|
|
||||||
|
5. **Verify the verification** — What tests were run? Did the build pass? Was the change tested manually? Screenshots for UI changes?
|
||||||
|
|
||||||
|
## Review Output
|
||||||
|
|
||||||
|
Structure every review using this format:
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
|
||||||
|
Briefly explain what the code does and give an overall assessment.
|
||||||
|
|
||||||
|
### Critical and High-Priority Issues
|
||||||
|
|
||||||
|
List problems that could cause security incidents, data loss, crashes, incorrect behavior, or major performance degradation. Each finding gets its unique ID (`F1`, `F2`, …). For each: state the severity, identify the file/function/code section, explain why it's a problem, describe failure circumstances, and provide a concrete improvement with corrected code when useful.
|
||||||
|
|
||||||
|
### Other Findings
|
||||||
|
|
||||||
|
List medium- and low-priority issues, including maintainability and design concerns. Continue the ID sequence started above (`F3`, `F4`, …).
|
||||||
|
|
||||||
|
### Suggested Refactoring
|
||||||
|
|
||||||
|
Provide focused code changes or revised snippets. Preserve existing behavior unless a behavior change is explicitly justified.
|
||||||
|
|
||||||
|
### Testing Recommendations
|
||||||
|
|
||||||
|
Identify missing tests and describe specific test cases, including edge cases and failure scenarios.
|
||||||
|
|
||||||
|
### Positive Observations
|
||||||
|
|
||||||
|
Mention implementation choices that are clear, safe, efficient, or well designed. This is not fluff — it reinforces good patterns and tells the author what to keep doing.
|
||||||
|
|
||||||
|
### Final Verdict
|
||||||
|
|
||||||
|
Choose one:
|
||||||
|
|
||||||
|
- **Approve** — Ready to merge
|
||||||
|
- **Approve with minor changes** — Good to merge after addressing low/medium issues
|
||||||
|
- **Request changes** — Critical or high issues must be resolved before merge
|
||||||
|
|
||||||
|
List the finding IDs the verdict depends on (e.g. "Request changes: F1, F4").
|
||||||
|
|
||||||
|
## Change Sizing
|
||||||
|
|
||||||
|
Small, focused changes are easier to review, faster to merge, and safer to deploy.
|
||||||
|
|
||||||
|
```
|
||||||
|
~100 lines changed → Good. Reviewable in one sitting.
|
||||||
|
~300 lines changed → Acceptable if it's a single logical change.
|
||||||
|
~1000 lines changed → Too large. Split it.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Watch file size, not just diff size.** Around 1000 *total* lines in a single file is a common inspection signal. When a change materially grows an already-large file, decompose first.
|
||||||
|
|
||||||
|
**Splitting strategies:**
|
||||||
|
|
||||||
|
| Strategy | How | When |
|
||||||
|
|----------|-----|------|
|
||||||
|
| **Stack** | Submit a small change, start the next one based on it | Sequential dependencies |
|
||||||
|
| **By file group** | Separate changes for groups needing different reviewers | Cross-cutting concerns |
|
||||||
|
| **Horizontal** | Create shared code/stubs first, then consumers | Layered architecture |
|
||||||
|
| **Vertical** | Break into smaller full-stack slices of the feature | Feature work |
|
||||||
|
|
||||||
|
**Separate refactoring from feature work.** A change that refactors and adds new behavior is two changes — submit them separately.
|
||||||
|
|
||||||
|
## Change Descriptions
|
||||||
|
|
||||||
|
- **First line:** Short, imperative, standalone. "Delete the FizzBuzz RPC" not "Deleting the FizzBuzz RPC."
|
||||||
|
- **Body:** What is changing and why. Include context and reasoning not visible in the code itself.
|
||||||
|
- **Anti-patterns:** "Fix bug," "Fix build," "Add patch," "Phase 1."
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
Before adding any dependency:
|
||||||
|
|
||||||
|
1. Does the existing stack solve this? (Often it does.)
|
||||||
|
2. How large is the dependency? (Check bundle impact.)
|
||||||
|
3. Is it actively maintained? (Check last commit, open issues.)
|
||||||
|
4. Does it have known vulnerabilities? (`npm audit`)
|
||||||
|
5. What's the license? (Must be compatible with the project.)
|
||||||
|
|
||||||
|
**Rule:** Prefer standard library and existing utilities over new dependencies. Every dependency is a liability.
|
||||||
|
|
||||||
|
**Upgrading dependencies:**
|
||||||
|
|
||||||
|
- Read the changelog, not just the version number. Semver is a promise the maintainer may not have kept.
|
||||||
|
- One dependency per change. When a bulk bump breaks the build, you've lost which package did it.
|
||||||
|
- Let the tests decide — a green suite before *and* after, not just "it installed."
|
||||||
|
- Review the lockfile diff, not just `package.json`. Commit it and never hand-edit it.
|
||||||
|
|
||||||
|
For supply-chain risk triage, follow the `security-and-hardening` skill.
|
||||||
|
|
||||||
|
## Common Rationalizations
|
||||||
|
|
||||||
|
| Rationalization | Reality |
|
||||||
|
|---|---|
|
||||||
|
| "It works, that's good enough" | Working code that's unreadable, insecure, or architecturally wrong creates debt that compounds. |
|
||||||
|
| "I wrote it, so I know it's correct" | Authors are blind to their own assumptions. Every change benefits from another set of eyes. |
|
||||||
|
| "We'll clean it up later" | Later never comes. The review is the quality gate — use it. |
|
||||||
|
| "AI-generated code is probably fine" | AI code needs more scrutiny, not less. It's confident and plausible, even when wrong. |
|
||||||
|
| "The tests pass, so it's good" | Tests are necessary but not sufficient. They don't catch architecture, security, or readability problems. |
|
||||||
|
| "The refactor makes it cleaner" | Relocating complexity isn't reducing it. If the reader still holds the same number of concepts, the structure didn't improve. |
|
||||||
|
| "It's only a small addition to this file" | Small diffs still push files past healthy size and bolt branches onto unrelated flows. |
|
||||||
|
| "It's just a version bump" | A bump is a behavior change you didn't write. Read the changelog. |
|
||||||
|
| "I'll upgrade everything in one PR" | A bulk bump hides which package broke the build. One per change. |
|
||||||
|
| "It's duplicated but it's only two places" | Two becomes three becomes five. Extract now, before the copies diverge. |
|
||||||
|
| "The abstraction is future-proof" | YAGNI. Delete speculative generality — generalize on the third occurrence, not the first. |
|
||||||
|
| "It's clever but efficient" | Cleverness is a readability tax. If it needs a comment to understand, simplify it. |
|
||||||
|
|
||||||
|
## Red Flags
|
||||||
|
|
||||||
|
- PRs merged without any review
|
||||||
|
- Review that only checks if tests pass (ignoring other axes)
|
||||||
|
- "LGTM" without evidence of actual review
|
||||||
|
- Security-sensitive changes without security-focused review
|
||||||
|
- Large PRs that are "too big to review properly" (split them)
|
||||||
|
- No regression tests with bug fix PRs
|
||||||
|
- Accepting "I'll fix it later" — it never happens
|
||||||
|
- A refactor that moves code around without reducing the number of concepts a reader must hold
|
||||||
|
- New conditionals scattered into unrelated code paths (a missing abstraction)
|
||||||
|
- A bespoke helper that duplicates an existing canonical one
|
||||||
|
- A bulk "bump dependencies" PR with no changelog review
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
Before emitting the verdict, verify the change as it stands. This is the reviewer's own due diligence — it covers the state of the code at review time, not the later resolution of findings (fixing findings is the author's job; confirming them is a new review):
|
||||||
|
|
||||||
|
- [ ] Tests pass — run them yourself, don't trust the claim
|
||||||
|
- [ ] Build succeeds
|
||||||
|
- [ ] The verification story is documented (what changed, how it was verified)
|
||||||
|
- [ ] Dependency upgrades reviewed against changelog, isolated per package, verified by green suite
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- For detailed security review guidance, see `security-and-hardening`
|
||||||
|
|||||||
@ -1,13 +1,12 @@
|
|||||||
---
|
---
|
||||||
name: create-commit
|
name: create-commit
|
||||||
description: Stage, review, and commit files following Penpot commit conventions.
|
description: Stage, review, and commit files following Penpot commit conventions.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Skill: create-commit
|
# Skill: create-commit
|
||||||
|
|
||||||
Produce a git commit that follows Penpot's commit message conventions. This
|
Produce a git commit that follows Penpot's commit message conventions. This
|
||||||
skill handles staging review and safety checks — it does not
|
skill owns the commit format, staging review, and safety checks — it does not
|
||||||
implement features or push.
|
implement features or push.
|
||||||
|
|
||||||
## When to Use
|
## When to Use
|
||||||
@ -23,9 +22,14 @@ subject/body limits, and the `AI-assisted-by` trailer. Follow it exactly.
|
|||||||
|
|
||||||
## Iron Rules (non-negotiable)
|
## Iron Rules (non-negotiable)
|
||||||
|
|
||||||
Follow the message rules and exceptions in `mem:workflow/creating-commits`.
|
1. **Wrap every body line at 76 characters or fewer.** Count characters, do
|
||||||
**Run `./scripts/check-commit` and require exit code 0.** A non-zero exit is a
|
not eyeball. Exceptions: `Signed-off-by:` / `AI-assisted-by:` trailers and
|
||||||
hard blocker: fix the message and re-check it before reporting success.
|
lines carrying a URL. This is the rule agents skip most often.
|
||||||
|
2. **Subject ≤70 chars**, imperative, capitalized, no trailing period.
|
||||||
|
3. **Blank line between subject and body.**
|
||||||
|
4. **Run `./scripts/check-commit` and require exit code 0.** It mechanically
|
||||||
|
checks rules 1–3. A non-zero exit is a hard blocker: fix the message and
|
||||||
|
re-commit. Never report the commit as done with a failing checker.
|
||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
@ -36,7 +40,7 @@ hard blocker: fix the message and re-check it before reporting success.
|
|||||||
that does not match the stated intent, **STOP** and tell the user before
|
that does not match the stated intent, **STOP** and tell the user before
|
||||||
committing.
|
committing.
|
||||||
3. Draft the message following the format in the memory doc, wrapping the body
|
3. Draft the message following the format in the memory doc, wrapping the body
|
||||||
at 80 characters per line, and run:
|
at 76 characters per line, and run:
|
||||||
```bash
|
```bash
|
||||||
git commit -m "<subject>" -m "<body>"
|
git commit -m "<subject>" -m "<body>"
|
||||||
```
|
```
|
||||||
@ -57,8 +61,6 @@ hard blocker: fix the message and re-check it before reporting success.
|
|||||||
- Do not pass `--author`. Author identity comes from the local git config.
|
- Do not pass `--author`. Author identity comes from the local git config.
|
||||||
- Do not amend a commit you did not create in this session, unless explicitly asked.
|
- Do not amend a commit you did not create in this session, unless explicitly asked.
|
||||||
- Do not bypass pre-commit hooks (`--no-verify`) unless explicitly asked.
|
- Do not bypass pre-commit hooks (`--no-verify`) unless explicitly asked.
|
||||||
- Add `Co-authored-by:` only for a human co-author. AI providers, agents and
|
- Never add a `Co-authored-by:` trailer. It is forbidden and fails `./scripts/check-commit`.
|
||||||
bots are rejected by `./scripts/check-commit`; for AI participation use the
|
|
||||||
`AI-assisted-by:` trailer.
|
|
||||||
- Do not add untracked files that were not created in this session.
|
- Do not add untracked files that were not created in this session.
|
||||||
- Do not skip the `scripts/check-commit` verification step.
|
- Do not skip the `scripts/check-commit` verification step (Iron Rule 4).
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: create-issue
|
name: create-issue
|
||||||
description: Create or update GitHub issues (from PR, from draft body, retitle existing). Routes to the canonical flow in `mem:workflow/creating-issues`.
|
description: Create or update GitHub issues (from PR, from draft body, retitle existing). Routes to the canonical flow in `mem:workflow/creating-issues`.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Skill: create-issue
|
# Skill: create-issue
|
||||||
|
|||||||
@ -18,7 +18,7 @@ push — the user pushes from their own shell.
|
|||||||
|
|
||||||
- The user asks to open or create a NEW PR for the current task branch, in
|
- The user asks to open or create a NEW PR for the current task branch, in
|
||||||
any phrasing ("open a PR", "create the pull request", "put this up for
|
any phrasing ("open a PR", "create the pull request", "put this up for
|
||||||
review") — or invokes `@create-pr`. → **Open mode**.
|
review") — or runs `/create-pr`. → **Open mode**.
|
||||||
- The user asks to fix or update an EXISTING PR's title or description to
|
- The user asks to fix or update an EXISTING PR's title or description to
|
||||||
match conventions. → **Update mode**.
|
match conventions. → **Update mode**.
|
||||||
|
|
||||||
@ -59,7 +59,7 @@ Run all checks before reporting, then report every failure together:
|
|||||||
5. **Branch not pushed.** The remote-tracking ref `origin/<branch>` is
|
5. **Branch not pushed.** The remote-tracking ref `origin/<branch>` is
|
||||||
missing, or `git rev-parse origin/<branch>` differs from HEAD — the
|
missing, or `git rev-parse origin/<branch>` differs from HEAD — the
|
||||||
branch was never pushed, or has commits the remote does not have. Never
|
branch was never pushed, or has commits the remote does not have. Never
|
||||||
push yourself; ask the user to push and to invoke `@create-pr` again
|
push yourself; ask the user to push and to run `/create-pr` again
|
||||||
afterwards, then stop.
|
afterwards, then stop.
|
||||||
|
|
||||||
### 3. Already-open PR
|
### 3. Already-open PR
|
||||||
@ -93,8 +93,8 @@ gh pr create --repo penpot/penpot --base "<BASE>" --title "<TITLE>" \
|
|||||||
repository default, which is wrong for a branch cut from `staging`. `--project
|
repository default, which is wrong for a branch cut from `staging`. `--project
|
||||||
"Main"` is required by `mem:workflow/creating-prs`.
|
"Main"` is required by `mem:workflow/creating-prs`.
|
||||||
|
|
||||||
If an issue is present, run the explicit assignment command from
|
If an issue is present, run the explicit assignment and verification command
|
||||||
`mem:workflow/creating-prs` before reporting success:
|
from `mem:workflow/creating-prs` before reporting success:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 scripts/gh.py link-issue <ISSUE_NUMBER> <PR_NUMBER>
|
python3 scripts/gh.py link-issue <ISSUE_NUMBER> <PR_NUMBER>
|
||||||
@ -117,7 +117,8 @@ gh pr view <NUMBER> --repo penpot/penpot --json title,body
|
|||||||
```
|
```
|
||||||
|
|
||||||
If the updated body contains `Closes #NNNN`, run the explicit assignment
|
If the updated body contains `Closes #NNNN`, run the explicit assignment
|
||||||
command from `mem:workflow/creating-prs`:
|
command from `mem:workflow/creating-prs` and require its verification to
|
||||||
|
succeed:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 scripts/gh.py link-issue <ISSUE_NUMBER> <PR_NUMBER>
|
python3 scripts/gh.py link-issue <ISSUE_NUMBER> <PR_NUMBER>
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: implement-plan
|
name: implement-plan
|
||||||
description: Implementation flow — execute a ready plan from the session context
|
description: Implementation flow — execute a ready plan from the session context: read the plan, detect the flow, then present the full picture (issue and branch to create or the branch to continue on, execution style, task checklist) and wait for confirmation. Default is every task with one final commit; on request ("step by step"), one task and one commit at a time with a pause after each; on request ("direct"), no issue and no branch — the commit lands on the current branch. Use it when the user asks to implement or execute a plan, in any phrasing.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Implement Plan
|
# Implement Plan
|
||||||
@ -14,29 +13,16 @@ By default it ends with exactly one commit. When the user asks for it
|
|||||||
("step by step"), it commits once per task instead and waits for the
|
("step by step"), it commits once per task instead and waits for the
|
||||||
user's confirmation after each one (see *Execution modes*).
|
user's confirmation after each one (see *Execution modes*).
|
||||||
|
|
||||||
## Plan file handling
|
|
||||||
|
|
||||||
Plan files are local workflow artifacts. They must never be staged or
|
|
||||||
committed, even when `.gitignore` already excludes them. Never use
|
|
||||||
`git add -f`, change ignore rules, or otherwise force a plan file into a
|
|
||||||
commit. Close and update the plan when this flow requires it, but leave it
|
|
||||||
in the local working tree.
|
|
||||||
|
|
||||||
## When to use
|
## When to use
|
||||||
|
|
||||||
- The user asks to implement or execute a plan, in any phrasing:
|
- The user asks to implement or execute a plan, in any phrasing:
|
||||||
"implement the plan", "execute it", "go build it" — or runs
|
"implement the plan", "execute it", "go build it" — or runs
|
||||||
`@implement-plan`.
|
`/implement-plan`.
|
||||||
- A ready, reviewed plan is in the session context or a plan file path
|
- A ready, reviewed plan is in the session context or a plan file path
|
||||||
was given (typically after `@make-a-plan` or `@review-plan`).
|
was given (typically after `/make-a-plan` or `/review-plan`).
|
||||||
|
|
||||||
Do not use it to produce plans — that is the `make-a-plan` flow.
|
Do not use it to produce plans — that is the `make-a-plan` flow.
|
||||||
|
|
||||||
For a plan derived from a code review, retain its review target, reviewer
|
|
||||||
session ID, original findings and decisions. Record the starting revision and
|
|
||||||
the exact commits or diff produced by this implementation, plus test evidence,
|
|
||||||
in session context for follow-up. Do not put commit hashes in the plan file.
|
|
||||||
|
|
||||||
## 1. Read the plan first
|
## 1. Read the plan first
|
||||||
|
|
||||||
Identify the plan to execute — from the file path the user gave, the
|
Identify the plan to execute — from the file path the user gave, the
|
||||||
@ -116,19 +102,20 @@ Implement every task in one go. Work methodically, keeping changes
|
|||||||
focused on what the issue requires. Respect the plan's proposed
|
focused on what the issue requires. Respect the plan's proposed
|
||||||
parallelization when it applies.
|
parallelization when it applies.
|
||||||
|
|
||||||
When the implementation is complete, load the **`create-commit`** skill and
|
When the implementation is complete, close the plan file first: flip its
|
||||||
follow its workflow to commit
|
`Status` to `done` and append one UTC ISO 8601 line to its `Review Log`
|
||||||
only the implementation, tests, memory, and documentation changes. Before
|
with the issue URL when one exists (standalone mode, e.g.
|
||||||
committing, verify that the staged file list does not contain the plan
|
`https://github.com/penpot/penpot/issues/NNNN`); in continue/direct
|
||||||
file. Provide a brief summary of what was implemented and why, the issue
|
mode with no issue, just `done` with no invented identifier. Never
|
||||||
reference (`issue-NNNN`) when there is one, and the model name you are
|
record commit hashes.
|
||||||
running as so the `AI-assisted-by` trailer is set correctly.
|
|
||||||
|
|
||||||
Only after the commit exists and passes its checks, close the plan: flip
|
**The plan file is never staged or committed.** It is session
|
||||||
`Status` to `done` and append one UTC ISO 8601 line to `Review Log` with the
|
bookkeeping, not part of the change: the commit carries the code and
|
||||||
issue URL when one exists; otherwise record `done` without inventing an
|
the tests. Then load the **`create-commit`** skill and follow its
|
||||||
identifier. Never record commit hashes. Leave the plan local and uncommitted.
|
workflow to commit them. Provide a brief summary of what was
|
||||||
If the commit or its checks fail, do not close the plan.
|
implemented and why, the issue reference (`issue-NNNN`) when there is
|
||||||
|
one, and the model name you are running as so the `AI-assisted-by`
|
||||||
|
trailer is set correctly.
|
||||||
|
|
||||||
### Step-by-step mode (on request)
|
### Step-by-step mode (on request)
|
||||||
|
|
||||||
@ -139,9 +126,9 @@ per task" — loop one task at a time:
|
|||||||
- Commit it now: load the **`create-commit`** skill and follow it —
|
- Commit it now: load the **`create-commit`** skill and follow it —
|
||||||
one commit per task, never two tasks in one commit. Same inputs as
|
one commit per task, never two tasks in one commit. Same inputs as
|
||||||
always: what and why, the issue reference, your model name.
|
always: what and why, the issue reference, your model name.
|
||||||
- After the final task commit, close the plan file (`Status: done`, one
|
- After the final task, close the plan file (`Status: done`, one
|
||||||
`Review Log` line with the issue URL when one exists). Leave it local
|
`Review Log` line with the issue URL when one exists). It is never
|
||||||
and uncommitted; never amend the task commit to include it.
|
staged: session bookkeeping does not go into the commit.
|
||||||
- Show the user the result (what changed, files touched, how it was
|
- Show the user the result (what changed, files touched, how it was
|
||||||
verified).
|
verified).
|
||||||
- WAIT for the user's confirmation before starting the next task.
|
- WAIT for the user's confirmation before starting the next task.
|
||||||
@ -152,24 +139,18 @@ stop and ask the user before splitting it.
|
|||||||
|
|
||||||
## When you are done
|
## When you are done
|
||||||
|
|
||||||
After the entire plan is implemented and verified, including the final task in
|
|
||||||
step-by-step mode, if it addresses code review findings, ask whether the user
|
|
||||||
wants the original reviewer to verify the corrections. Use the `question` tool
|
|
||||||
if available; otherwise ask in chat. Wait for the answer. Do not start the
|
|
||||||
follow-up without consent, and do not ask after each intermediate task.
|
|
||||||
|
|
||||||
If the user accepts, follow `@review-code`'s follow-up procedure with the
|
|
||||||
review context, decisions, exact correction range or diff and test evidence.
|
|
||||||
If the original reviewer cannot be resumed, say so and use a new reviewer with
|
|
||||||
the same context. If the user declines, stop without starting a review. The
|
|
||||||
follow-up is read-only; further fixes require the user's direction.
|
|
||||||
|
|
||||||
End by suggesting the next steps (suggestions, not a required pipeline — any
|
End by suggesting the next steps (suggestions, not a required pipeline — any
|
||||||
instruction from me overrides them):
|
instruction from me overrides them):
|
||||||
|
|
||||||
- `@review-code` — for a new independent review of the changes.
|
- `/review-code` — to review the changes just committed; it routes to
|
||||||
- `@create-pr` — when the task is done and the branch is ready to merge.
|
`/make-a-plan` by itself if the findings need one.
|
||||||
|
- `/create-pr` — when the task is done and the branch is ready to merge.
|
||||||
|
|
||||||
## User input, overrides and additional context
|
## User context
|
||||||
|
|
||||||
$ARGUMENTS
|
Extra context in the user's invocation (the message that triggered this
|
||||||
|
skill) plays the role command arguments play elsewhere: `standalone`,
|
||||||
|
`continue`, `direct` (`no branch` / `direct commit`), `no issue` /
|
||||||
|
`without issue`, an explicit base such as `from origin/develop`, or
|
||||||
|
`step by step` / `one commit per task` for the step-by-step execution
|
||||||
|
mode. Modes combine freely, for example "standalone step by step".
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: local-ci
|
name: local-ci
|
||||||
description: Run local CI-style checks with ./scripts/ci (lint, tests, format, and on request production builds) per monorepo module. Use when verifying changes before declaring work done, running lint or tests locally, fixing formatting, repairing Clojure delimiter errors, or checking that a module still compiles.
|
description: Run local CI-style checks with ./scripts/ci (lint, tests, format) per monorepo module. Use when verifying changes before declaring work done, running lint or tests locally, fixing formatting, or repairing Clojure delimiter errors.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Local CI
|
# Local CI
|
||||||
@ -29,12 +29,10 @@ Run from the repo root:
|
|||||||
```
|
```
|
||||||
|
|
||||||
Modules: `frontend` `backend` `common` `render-wasm` `exporter` `mcp`
|
Modules: `frontend` `backend` `common` `render-wasm` `exporter` `mcp`
|
||||||
`plugins` `library` `media-processor`, or `--all` for every module.
|
`plugins` `library`, or `--all` for every module.
|
||||||
|
|
||||||
With no task flags it runs three tasks per module, in order: **lint**,
|
With no task flags it runs three tasks per module, in order: **lint**,
|
||||||
**test**, **fmt** (format check; `--fix` formats files instead). **build**
|
**test**, **fmt** (format check; `--fix` formats files instead).
|
||||||
is opt-in: it compiles the module the way production does and is the slow
|
|
||||||
one, so it never runs unless you ask for it.
|
|
||||||
|
|
||||||
| Flag | Effect |
|
| Flag | Effect |
|
||||||
|------|--------|
|
|------|--------|
|
||||||
@ -43,7 +41,6 @@ one, so it never runs unless you ask for it.
|
|||||||
| `--lint` / `--no-lint` | Run only lint / drop lint |
|
| `--lint` / `--no-lint` | Run only lint / drop lint |
|
||||||
| `--test` / `--no-test` | Run only tests / drop tests |
|
| `--test` / `--no-test` | Run only tests / drop tests |
|
||||||
| `--fmt` / `--no-fmt` | Run only format check / drop it |
|
| `--fmt` / `--no-fmt` | Run only format check / drop it |
|
||||||
| `--build` / `--no-build` | Run only the production build / drop it |
|
|
||||||
| `--fix` | Format files instead of checking (other tasks unaffected) |
|
| `--fix` | Format files instead of checking (other tasks unaffected) |
|
||||||
| `--paren-repair` | Fix delimiter errors in Clojure/CLJS files |
|
| `--paren-repair` | Fix delimiter errors in Clojure/CLJS files |
|
||||||
| `--fail-fast` | Stop at the first failure |
|
| `--fail-fast` | Stop at the first failure |
|
||||||
@ -75,18 +72,12 @@ log path.
|
|||||||
# Format the module without running the test suite
|
# Format the module without running the test suite
|
||||||
./scripts/ci --fix --no-test frontend
|
./scripts/ci --fix --no-test frontend
|
||||||
|
|
||||||
# Check that the module still compiles (slow: minutes)
|
|
||||||
./scripts/ci --build frontend
|
|
||||||
|
|
||||||
# Compile every module (8 builds, ~4 min with warm caches)
|
|
||||||
./scripts/ci --build --all
|
|
||||||
|
|
||||||
# Broke delimiters in Clojure/CLJS files: repair first, then lint
|
# Broke delimiters in Clojure/CLJS files: repair first, then lint
|
||||||
./scripts/ci --paren-repair frontend
|
./scripts/ci --paren-repair frontend
|
||||||
./scripts/ci --lint frontend
|
./scripts/ci --lint frontend
|
||||||
|
|
||||||
# Changed common/ — validate its consumers too
|
# Changed common/ — validate its consumers too
|
||||||
./scripts/ci common frontend backend exporter
|
./scripts/ci frontend backend exporter
|
||||||
|
|
||||||
# Preview what would run, without running it
|
# Preview what would run, without running it
|
||||||
./scripts/ci --dry-run --all
|
./scripts/ci --dry-run --all
|
||||||
@ -98,12 +89,7 @@ log path.
|
|||||||
- Test tasks are long-running (backend runs `clojure -M:dev:test`); give
|
- Test tasks are long-running (backend runs `clojure -M:dev:test`); give
|
||||||
the bash call a generous timeout (10–20 minutes) instead of letting it
|
the bash call a generous timeout (10–20 minutes) instead of letting it
|
||||||
time out mid-run.
|
time out mid-run.
|
||||||
- `mcp` and `media-processor` have no lint task — they show as skipped,
|
- `mcp` has no lint task — it shows as skipped, not failed.
|
||||||
not failed. `common` has no build task for the same reason.
|
|
||||||
- Build runs are the slow ones (frontend ~2 min even with warm caches;
|
|
||||||
cold caches roughly double it). Give the shell a generous timeout and
|
|
||||||
do not run two builds at once in the same checkout: `render-wasm` takes
|
|
||||||
a build lock.
|
|
||||||
- `--paren-repair` only fixes delimiters; run lint afterwards to catch
|
- `--paren-repair` only fixes delimiters; run lint afterwards to catch
|
||||||
what remains. See `mem:scripts/paren-repair`.
|
what remains. See `mem:scripts/paren-repair`.
|
||||||
- What to run and how to read test results: `mem:testing`.
|
- What to run and how to read test results: `mem:testing`.
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: make-a-plan
|
name: make-a-plan
|
||||||
description: Planning flow — research the subject of this session, produce an implementation plan with the planner skill, resolve open questions with the user in plain language, and save the final plan to .agents/plans/.
|
description: Planning flow — research the subject of this session, produce an implementation plan with the planner skill, resolve open questions with the user in plain language, and save the final plan to .agents/plans/. Use it when the user asks to plan, design, or break down a task, in any phrasing.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Make a Plan
|
# Make a Plan
|
||||||
@ -16,18 +15,19 @@ stop — this skill needs the build agent to save the plan.
|
|||||||
|
|
||||||
- The user asks to plan, design, or break down a task, in any phrasing:
|
- The user asks to plan, design, or break down a task, in any phrasing:
|
||||||
"make a plan", "how would we build X", "design an approach for Y" —
|
"make a plan", "how would we build X", "design an approach for Y" —
|
||||||
or invokes `@make-a-plan`.
|
or runs `/make-a-plan`.
|
||||||
- The user asks to rework or extend an existing plan. While the plan is
|
- The user asks to rework or extend an existing plan. While the plan is
|
||||||
still unimplemented (pre-`implement-plan` iteration, e.g. after
|
still unimplemented (pre-`implement-plan` iteration, e.g. after
|
||||||
`@review-plan` findings or user feedback), revise the saved plan file
|
`/review-plan` findings or user feedback), revise the saved plan file
|
||||||
in place. Once the plan has been implemented and reviewed (post
|
in place. Once the plan has been implemented and reviewed (post
|
||||||
`@review-code` findings on committed work), write a new derived plan
|
`/review-code` findings on committed work), write a new derived plan
|
||||||
file instead — never rewrite the executed plan. The `planner` skill
|
file instead — never rewrite the executed plan. The `planner` skill
|
||||||
defines the derived naming (`--review-NN`, `--task-NN`).
|
defines the derived naming (`--review-NN`, `--task-NN`).
|
||||||
- The user says to apply additional review feedback to a still-unimplemented
|
- The user says to apply `review-plan` findings to a still-unimplemented
|
||||||
plan: apply the agreed changes, flip `Status` to `reviewed`, and append one
|
plan: apply the agreed changes, flip `Status` to `reviewed`, and
|
||||||
UTC ISO 8601 line to `Review Log`. `review-plan` can also update the plan
|
append one UTC ISO 8601 line to `Review Log` describing what changed.
|
||||||
and its metadata as part of its own review flow.
|
This apply step is the only pre-implementation write to those fields —
|
||||||
|
`review-plan` itself stays read-only and never writes.
|
||||||
|
|
||||||
Do not use it to execute a plan — that is the `implement-plan` flow.
|
Do not use it to execute a plan — that is the `implement-plan` flow.
|
||||||
|
|
||||||
@ -38,11 +38,6 @@ Do not use it to execute a plan — that is the `implement-plan` flow.
|
|||||||
example, `delegated` in the user context), delegate to the `general` subagent
|
example, `delegated` in the user context), delegate to the `general` subagent
|
||||||
instead — the delegate must also follow the `planner` skill and receive all
|
instead — the delegate must also follow the `planner` skill and receive all
|
||||||
the relevant session context (a review, user feedback, and so on).
|
the relevant session context (a review, user feedback, and so on).
|
||||||
When the plan addresses a code review, preserve the review target, reviewer
|
|
||||||
session ID if available, original findings and IDs, and decisions including
|
|
||||||
deferred or rejected findings and their reasons in the local plan. Map
|
|
||||||
accepted findings to tasks. If context is unavailable, mark it unknown; do
|
|
||||||
not invent it. Pass this context to a delegated planner too.
|
|
||||||
2. Before asking me to decide anything, explain the plan and every open question in
|
2. Before asking me to decide anything, explain the plan and every open question in
|
||||||
plain language. Assume I know only the high-level project goal, not the codebase,
|
plain language. Assume I know only the high-level project goal, not the codebase,
|
||||||
architecture, implementation terms, or the problem this task solves.
|
architecture, implementation terms, or the problem this task solves.
|
||||||
@ -105,12 +100,15 @@ constraints and risks, what is deliberately out of scope, and the path where the
|
|||||||
is saved. Never assume that a short list of task names is enough context. End
|
is saved. Never assume that a short list of task names is enough context. End
|
||||||
the final response by suggesting the next steps, in this order:
|
the final response by suggesting the next steps, in this order:
|
||||||
|
|
||||||
1. `@review-plan` — to get a second opinion on the plan before executing it.
|
1. `/review-plan` — to get a second opinion on the plan before executing it.
|
||||||
2. `@implement-plan` — to execute the plan from the current session context.
|
2. `/implement-plan` — to execute the plan from the current session context.
|
||||||
|
|
||||||
These are suggestions, not a required pipeline — any instruction from me
|
These are suggestions, not a required pipeline — any instruction from me
|
||||||
overrides them (for example, asking you to implement the plan directly).
|
overrides them (for example, asking you to implement the plan directly).
|
||||||
|
|
||||||
## User input, overrides and additional context
|
## User context
|
||||||
|
|
||||||
$ARGUMENTS
|
Extra context in the user's invocation (the message that triggered this skill)
|
||||||
|
plays the role command arguments play elsewhere: for example, `delegated` to
|
||||||
|
hand the research and drafting to the `general` subagent, or corrections and
|
||||||
|
feedback about a previous plan.
|
||||||
|
|||||||
@ -1,330 +0,0 @@
|
|||||||
---
|
|
||||||
name: migrate-ds-area
|
|
||||||
description: Migrate one Penpot UI area to the Design System components for one group of the DS migration epic (#12375): buttons and icons (icon-button*, button*, icon*), selects (select*) and later groups. Moves the area's SCSS off the deprecated styles, proves every change with a zero-tolerance visual test, then opens the draft PR and updates the group issue (PRs table row, QA comment). Use when the user asks to migrate an area or module to the DS, continue a DS migration group, or names an area of a group issue.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Skill: migrate-ds-area
|
|
||||||
|
|
||||||
Move one UI area (one `.cljs` + `.scss` pair, or a few related modules)
|
|
||||||
from legacy components and raw HTML to the Design System components,
|
|
||||||
prove with pixels what changed, and ship it as a draft PR that QA can
|
|
||||||
test.
|
|
||||||
|
|
||||||
The epic is #12375. Each control type is a group with its own issue
|
|
||||||
(buttons and icons #12376, selects #12377, radios #12378, …). The group
|
|
||||||
issue holds the plan (order, waiting areas), the changes QA should
|
|
||||||
expect, and the PRs table where people claim areas. Read it first.
|
|
||||||
|
|
||||||
## Input
|
|
||||||
|
|
||||||
- The group issue (e.g. `#12376`) and the area: a module path (e.g.
|
|
||||||
`dashboard/fonts`) or an area named in the group issue.
|
|
||||||
- No area given: take the next unclaimed area in the group issue's plan
|
|
||||||
order, and say which one.
|
|
||||||
|
|
||||||
## Ground rules
|
|
||||||
|
|
||||||
- Never `git push`. The user pushes; then you open the PR.
|
|
||||||
- PRs go to `develop`; branches start from `origin/develop`.
|
|
||||||
- **Stay in the group.** Only the controls of this group change. In the
|
|
||||||
buttons/icons group, selects, radios, numeric/text inputs, checkboxes,
|
|
||||||
menus (`%menu-*`, `%dropdown-*`) and modal structure (`%modal-*`) stay;
|
|
||||||
a checkbox tick or an input label icon stays legacy.
|
|
||||||
- **Accept the DS look.** Do not add CSS to imitate legacy sizes or
|
|
||||||
colors. Do keep positions: icons and labels must not move unless the
|
|
||||||
DS size forces it, and then say so.
|
|
||||||
- No negative margins to compensate; use positive DS spacing or
|
|
||||||
`px2rem()`.
|
|
||||||
- **Gaps in the DS wait.** An area that needs an icon or a feature the
|
|
||||||
DS lacks keeps its legacy control; say so in the PR.
|
|
||||||
- Skip legacy shared components that another group will replace
|
|
||||||
(`context_menu_a11y`, `forms`, `select`, `dropdown`, `radio_buttons`,
|
|
||||||
`search_bar`, `title_bar`, …): they wait for that group's cleanup,
|
|
||||||
where they are updated if still used or deleted if not.
|
|
||||||
- Debug-only UI gets no QA comment and no compare image.
|
|
||||||
|
|
||||||
## Devenv
|
|
||||||
|
|
||||||
Run every test, lint and `pnpm` command inside the workspace container,
|
|
||||||
never on the host (a host `pnpm` relinks `node_modules` and breaks the
|
|
||||||
container's watcher). The container is `penpot-devenv-ws<N>-main`, where
|
|
||||||
`<N>` is the workspace number (`ws0` is the main repo; `wsN` lives in
|
|
||||||
`~/.penpot/penpot_workspaces/wsN`). Write output to a file, then read it:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
C=penpot-devenv-ws1-main # your workspace
|
|
||||||
docker exec -u penpot -w /home/penpot/penpot/frontend $C \
|
|
||||||
bash -lc '<command>' > <scratch>/out.txt 2>&1
|
|
||||||
```
|
|
||||||
|
|
||||||
When the app does not behave as the code says, check the build first:
|
|
||||||
|
|
||||||
- **Stale build after a branch switch** ("is not a function", or a page
|
|
||||||
with empty `stl/css` classes): `touch` the stale `.cljs`/`.scss`, wait
|
|
||||||
for the compiled file under `frontend/resources/public/` to update,
|
|
||||||
hard-reload.
|
|
||||||
- **A whole area unstyled:** a new `.scss` added after the watcher
|
|
||||||
started is missing from `main.css` (grep `main.css` for the module
|
|
||||||
prefix), or `main.css` was written corrupted after many `.scss`
|
|
||||||
changed at once. Touch a `.scss`; if the module is still missing,
|
|
||||||
restart the watcher in the workspace's tmux session (`penpot:0`,
|
|
||||||
`./scripts/watch app`).
|
|
||||||
- **Blank app after switching between `develop` and `staging`:**
|
|
||||||
dependencies differ. Run `pnpm install --frozen-lockfile` in the
|
|
||||||
container and restart the watcher.
|
|
||||||
|
|
||||||
## Workflow
|
|
||||||
|
|
||||||
### 1. Claim the area and branch
|
|
||||||
|
|
||||||
1. Read the group issue: plan, waiting areas, expected changes, PRs table.
|
|
||||||
2. Add a row to the PRs table with no PR number, the user's @login as
|
|
||||||
Owner and the state `Claimed` (`gh issue view/edit <n> --body-file`).
|
|
||||||
Read the body right before editing, and read it again after saving:
|
|
||||||
when two people edit at the same time, GitHub keeps only the last
|
|
||||||
edit, so a row can vanish. Put yours back if it is gone.
|
|
||||||
Skip an area someone else already claimed, unless the claim has had
|
|
||||||
no PR for 7 days and its owner did not answer a comment asking.
|
|
||||||
3. `git switch -c <user>-ds-<group>-<area> origin/develop`.
|
|
||||||
4. Survey the area: every control of the group in the `.cljs`, the
|
|
||||||
legacy icons, the placeholders and mixins the `.scss` uses, the
|
|
||||||
`div`/`span` with `:on-click`.
|
|
||||||
|
|
||||||
### 2. Visual baseline
|
|
||||||
|
|
||||||
Add a `test.describe("<Area> controls", …)` block to the matching spec
|
|
||||||
in `frontend/playwright/ui/visual-specs/` (project `ds`, dark theme).
|
|
||||||
Put it next to the blocks of the same screen, not always at the end of
|
|
||||||
the file: two PRs that both append at the end conflict.
|
|
||||||
|
|
||||||
- Every shot: `toHaveScreenshot({ maxDiffPixelRatio: 0, threshold: 0 })`.
|
|
||||||
- Show every changed control at rest, on hover and open or pressed.
|
|
||||||
Capture the element or the smallest stable container.
|
|
||||||
- Locators must work before and after the change: text, role, testid,
|
|
||||||
`[class*='…']`, or `a.or(b)` when the element type changes (raw
|
|
||||||
`[class*='menu-btn']` before, `getByRole("button", { name: "Options" })`
|
|
||||||
after). Scope `.or()` to the area so it cannot match elsewhere.
|
|
||||||
- Missing data? Add a fixture under `frontend/playwright/data/` and mock
|
|
||||||
it (`dashboardPage.mockRPC(...)`, `DashboardPage.mockConfigFlags` for
|
|
||||||
flags). Watch for expired or inconsistent fixtures (dates in the past,
|
|
||||||
wrong file for a mock).
|
|
||||||
- Capture with `--update-snapshots=all`:
|
|
||||||
```bash
|
|
||||||
npx playwright test --project=ds <spec> -g "<describe>" --update-snapshots=all
|
|
||||||
```
|
|
||||||
Plain `--update-snapshots` keeps a snapshot within the project's 0.5%
|
|
||||||
tolerance, so a real diff looks like 0.
|
|
||||||
- Copy the snapshots (`<spec>.spec.js-snapshots/<Describe>-*`) to
|
|
||||||
`<scratch>/diffs/<area>/before/` and look at them: the state you
|
|
||||||
wanted must really be on screen.
|
|
||||||
|
|
||||||
### 3. Controls commit
|
|
||||||
|
|
||||||
#### Buttons and icons
|
|
||||||
|
|
||||||
| Legacy | DS |
|
|
||||||
|---|---|
|
|
||||||
| icon-only raw button | `[:> icon-button* {:variant "ghost" :aria-label (tr …) :icon i/x :on-click f}]` (always pass `:variant`; `"action"` for 24px icon toggles) |
|
|
||||||
| pressed/selected | `:aria-pressed (boolean x)` |
|
|
||||||
| text button | `[:> button* {:variant "primary"/"secondary"/"ghost"/"destructive" :type "button"} label]` |
|
|
||||||
| `[:input {:type "button"}]` | `button*` |
|
|
||||||
| modal close | `icon-button*` ghost, `:aria-label (tr "labels.close")`, `:tooltip-class` carrying the corner position |
|
|
||||||
| legacy icon outside a button | `[:> icon* {:icon-id i/x :class …}]` |
|
|
||||||
|
|
||||||
- Not every raw button changes: rows, tabs, swatches, avatar widgets,
|
|
||||||
full-height segments, round custom buttons and link-style text buttons
|
|
||||||
stay raw (their legacy icon still changes). List the kept ones in the
|
|
||||||
PR.
|
|
||||||
- A `div`/`span` with `:on-click` in the area becomes a `[:button]`
|
|
||||||
(with `aria-expanded`/`aria-haspopup` when it opens something). An
|
|
||||||
`[:a]` without `href` stays; list it in the PR.
|
|
||||||
- **Tooltip wrapper.** `icon-button*` renders inside a tooltip trigger
|
|
||||||
wrapper. Position (`position: absolute`, grid placement, margins
|
|
||||||
against siblings) goes on `:tooltip-class`; look (`--button-height`,
|
|
||||||
colors) goes on `:class`.
|
|
||||||
- **Tooltip at the right edge.** Small icon buttons at the right end of
|
|
||||||
a sidebar row or title bar get `:tooltip-placement "top-left"`; list
|
|
||||||
it as an expected change.
|
|
||||||
- **Sizes through custom properties:** `--button-height: #{px2rem(64)}` /
|
|
||||||
`--button-width`. Sass does not evaluate functions inside custom
|
|
||||||
properties without `#{}`.
|
|
||||||
- **A grown `button*` keeps its label at the start**: add
|
|
||||||
`justify-content: center` when it is wider than its content.
|
|
||||||
- **Icon colors:** DS icons use `stroke: currentColor`. Set `color` on
|
|
||||||
the icon class, not `stroke`/`fill`. A legacy `color: transparent` left
|
|
||||||
on the button or wrapper makes the DS icon invisible: drop it. A class
|
|
||||||
that redefines the color variable on the icon breaks the hover that
|
|
||||||
changes it on the button: define the variable on the button.
|
|
||||||
- **Every DS icon needs a color of its own** (on its class or a parent):
|
|
||||||
one that inherits none shows in the devenv debug yellow.
|
|
||||||
- **Icon sizes:** `"s"` draws 12px inside a 16px box (compensate the
|
|
||||||
margin by 2px per side to keep the drawing in place); `"m"` 16px; `"l"`
|
|
||||||
24px; `"xl"` 32px.
|
|
||||||
- **Stroke width:** DS icons keep the DS stroke width. Never set
|
|
||||||
`stroke-width` on a DS icon to match the legacy one; a thinner or
|
|
||||||
thicker line is part of the DS look.
|
|
||||||
- **Legacy placeholders that style `svg` descendants** (e.g.
|
|
||||||
`%dropdown-element-base` → `span svg { 12px box; stroke }`) override a
|
|
||||||
DS icon placed inside them: give the icon class its own box
|
|
||||||
(`inline-size`/`block-size` 16px) and `stroke: currentcolor` with more
|
|
||||||
specificity.
|
|
||||||
- **Flex shrink:** a DS svg inside a small flex button can shrink and be
|
|
||||||
cut; add `flex-shrink: 0` to the icon class.
|
|
||||||
- **Rotated legacy arrows:** prefer `i/arrow-left`/`-right`/`-up`/`-down`
|
|
||||||
over rotating `i/arrow` (same path), unless a rotation class drives the
|
|
||||||
open/closed state.
|
|
||||||
- **Menus anchored by the button size** move when the button grows; open
|
|
||||||
them from the top (`inset-block-start: calc(100% + var(--sp-xs))`) or
|
|
||||||
fix the context menu offset, and say so.
|
|
||||||
|
|
||||||
#### Selects
|
|
||||||
|
|
||||||
`[:& select {:default-value v :options [{:value :label}] :on-change f}]`
|
|
||||||
→ `[:> select* {:default-selected <id> :options <memoized vector of {:id :label}> :on-change f}]`
|
|
||||||
(`app.main.ui.ds.controls.select`).
|
|
||||||
|
|
||||||
- **Ids are non-blank strings.** A blank id shows a dimmed "--", and an
|
|
||||||
id that matches no option falls back to the first one. Give mixed,
|
|
||||||
none and auto their own ids (`"multiple"`, `"none"`, `"auto"`) and map
|
|
||||||
them back in the handler. Use `""` only where "--" is the wanted look.
|
|
||||||
- **Convert the value.** The legacy select ran `d/read-string`, so
|
|
||||||
handlers got keywords, numbers or uuids; `select*` passes the `:id`
|
|
||||||
string. Convert with `keyword`, `d/parse-integer` or `uuid/parse`.
|
|
||||||
- **Memoized options, live selection.** `select*` resets its selection
|
|
||||||
when `:default-selected` or the `:options` identity changes. Build
|
|
||||||
options with `mf/with-memo` and `mapv` (the schema wants a non-empty
|
|
||||||
vector) and pass `:default-selected` from the live value, never a
|
|
||||||
constant.
|
|
||||||
- **Never pass nil.** In dev builds a present prop with value nil
|
|
||||||
(`:class`, `:wrapper-class`, `:disabled`, `:default-selected`) throws
|
|
||||||
`invalid props on component select*`. Use `(boolean x)`, `d/nilv`, or
|
|
||||||
add the prop only when it has a value.
|
|
||||||
- **Props the legacy select ignored stay out**: `select*` passes rest
|
|
||||||
props to its button, so they would reach the DOM.
|
|
||||||
- **Classes:** `:wrapper-class` for layout, `:class` for look.
|
|
||||||
- **Portal:** add `:has-portal true` only where the visual test shows the
|
|
||||||
list cut at the bottom of a panel, and say so in the QA comment.
|
|
||||||
- **Locators:** the button is a `combobox` with no accessible name; use
|
|
||||||
`getByRole("combobox").filter({ hasText: "Linear" })` (it matches the
|
|
||||||
legacy select too) and `getByRole("option", { name: … })`.
|
|
||||||
- **Keyboard:** the arrows no longer change the value while the list is
|
|
||||||
closed. It is an expected change, already listed in #12377.
|
|
||||||
|
|
||||||
#### All groups
|
|
||||||
|
|
||||||
- New labels: add the key to `en.po` and `es.po` by hand, in sorted
|
|
||||||
position, with a `#:` reference to the cljs line. Never run the
|
|
||||||
translations sync.
|
|
||||||
- The `.scss` only gets what the new controls need in this commit.
|
|
||||||
- Some e2e specs are not Prettier-clean on develop: never run
|
|
||||||
`prettier --write` on a whole spec; format only your block.
|
|
||||||
|
|
||||||
Then wait for the watcher (grep the compiled JS/CSS under
|
|
||||||
`frontend/resources/public/` for the change), recapture with `=all`,
|
|
||||||
copy to `after/`, diff:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
SK=.agents/skills/migrate-ds-area/scripts
|
|
||||||
python3 -I $SK/diff.py <before> <after> # per-file pixel count + bbox
|
|
||||||
python3 -I $SK/trip.py <b> <a> <out.png> <scale> # before | after | red diff
|
|
||||||
```
|
|
||||||
|
|
||||||
`trip.py` pads images of different sizes, so a taller "after" still
|
|
||||||
renders.
|
|
||||||
Explain every diff. Fix what is not a DS-look change (moved icons, cut
|
|
||||||
icons, lost hover color). Rerun a shot that changes on unchanged code
|
|
||||||
before trusting it; flaky spots seen so far: the invite modal textarea
|
|
||||||
border, the search input caret, the user account page, the path handler
|
|
||||||
menu trigger.
|
|
||||||
|
|
||||||
Lint, then commit (read `mem:workflow/creating-commits` first):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx prettier --check <spec> <fixtures>; npx stylelint <scss>; clj-kondo --lint <cljs>; cljfmt check <cljs>
|
|
||||||
git add -f <cljs> <scss> <po> <spec> <fixtures> # -f: visual-specs/ is gitignored
|
|
||||||
./scripts/check-commit
|
|
||||||
```
|
|
||||||
|
|
||||||
A plain `git add` with an ignored path in the list adds nothing; always
|
|
||||||
`-f`, and check `git show --stat`. Never commit the screenshots.
|
|
||||||
Subject: `:recycle: Use DS <controls> in <area>`. A pre-existing bug
|
|
||||||
found and fixed on the way goes in its own `:bug:` commit.
|
|
||||||
|
|
||||||
### 4. SCSS commit
|
|
||||||
|
|
||||||
Run the `refactor-scss` skill on every `.scss` the PR touched (only
|
|
||||||
those), in its own commit. Keep `refactor/` only for component-family
|
|
||||||
placeholders (`%modal-*`, `%menu-*`, `%input-*`, `%checkbox-*`) and say
|
|
||||||
why in a comment above the `@use`. Unused selectors are deleted, not
|
|
||||||
commented out (list them in the commit body). Typography without an
|
|
||||||
exact match uses the closest DS typography. Run the skill's
|
|
||||||
**Self-review** before committing: no bare element selectors (add
|
|
||||||
classes in the `.cljs`), no copied properties that do nothing, z-index
|
|
||||||
tokens by purpose. Compare against the controls commit: it should be
|
|
||||||
0 px; explain anything else (typically a typography or border change).
|
|
||||||
For files that several modules share or that are huge, stop and propose
|
|
||||||
a separate PR instead.
|
|
||||||
|
|
||||||
### 5. Hand off, PR and tracking
|
|
||||||
|
|
||||||
1. Report to the user: commits, visible changes, kept raw controls,
|
|
||||||
pre-existing bugs, and the compare image path
|
|
||||||
(`<scratch>/diffs/<area>/compare.png`, before | after | diff). Give
|
|
||||||
the push command: `git push -u origin <branch>` (the branch tracks
|
|
||||||
`origin/develop`, so a bare `git push` is refused).
|
|
||||||
2. After the user pushes, check `git rev-parse HEAD origin/<branch>`,
|
|
||||||
then (read `mem:workflow/creating-prs` first):
|
|
||||||
```bash
|
|
||||||
gh pr create --repo penpot/penpot --draft --base develop --head <branch> \
|
|
||||||
--title "<commit subject>" --body-file <body> \
|
|
||||||
--label "WG adoption" --label "no issue required" \
|
|
||||||
--milestone <group issue milestone> --project Main
|
|
||||||
gh pr edit <n> --repo penpot/penpot --remove-label "needs triage"
|
|
||||||
```
|
|
||||||
Never add `no changelog` to a PR: that label goes on issues.
|
|
||||||
Body: AI note, `Part of #<group> (DS migration epic #12375).`, a
|
|
||||||
short What / How, the kept raw controls, an empty `## Screenshots`
|
|
||||||
when something is visible (the user attaches the image). Never
|
|
||||||
`Closes #<group>`. Keep it short: reviewers find long PRs hard to read.
|
|
||||||
3. In the group issue's PRs table, fill your row:
|
|
||||||
`| #<n> | <area>: <controls> (<visible changes>) | @<owner> | Draft |`.
|
|
||||||
4. Post a QA comment on the group issue: `**#<n>: <area>**`, *Where* (how
|
|
||||||
to reach it), *Expected changes* (every visible change; QA treats
|
|
||||||
anything not listed as a bug), *No other change* (what still works
|
|
||||||
the same).
|
|
||||||
|
|
||||||
Do not mark the draft ready or ask for review: the user decides when.
|
|
||||||
|
|
||||||
### 6. Review fixes
|
|
||||||
|
|
||||||
When the reviewer comments on a PR:
|
|
||||||
|
|
||||||
1. Fix each comment in a new commit on the branch (never amend pushed
|
|
||||||
commits). A comment you do not apply gets a short reason the user can
|
|
||||||
post, with an image when it is visual.
|
|
||||||
2. Rerun the area's visual spec before and after the fix with `=all`.
|
|
||||||
Build a compare image for every visible change and give the user its
|
|
||||||
full path, saying which PR it goes to.
|
|
||||||
3. Update everything the fix makes stale, in the same turn: the QA
|
|
||||||
comment (*Expected changes* must list the new visible changes), the
|
|
||||||
PRs table row, and the PR body.
|
|
||||||
4. When working on several PRs in one go, report per PR: branch, new
|
|
||||||
commit, what changed, image path. Never mix two branches in one list.
|
|
||||||
5. Give the push command per branch. If a rebase is coming soon, say
|
|
||||||
that pushing now costs one extra CI run; the user decides.
|
|
||||||
6. After a round of review fixes, check whether the same issue exists in
|
|
||||||
the user's other open PRs of the group, and fix it there too.
|
|
||||||
|
|
||||||
### 7. After merges
|
|
||||||
|
|
||||||
Whenever PRs merge (or go from draft to ready), sync the state column of
|
|
||||||
the group's PRs table with GitHub for **every** row, not only your own:
|
|
||||||
read each row's PR (`gh pr view <n> --json state,isDraft`) and set
|
|
||||||
Merged / In review / Draft. The table drifts when other people merge.
|
|
||||||
|
|
||||||
## Output
|
|
||||||
|
|
||||||
- Branch with 2 commits (controls, SCSS) plus any `:bug:` commit.
|
|
||||||
- Visual spec block with zero-tolerance shots.
|
|
||||||
- Compare image in the scratch folder.
|
|
||||||
- After the push: draft PR, row and QA comment in the group issue.
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
"""Pixel diff of two folders of PNG snapshots with the same file names.
|
|
||||||
|
|
||||||
Usage: python3 -I diff.py <before-dir> <after-dir>
|
|
||||||
Prints, per file, the number of differing pixels and their bounding box,
|
|
||||||
or the two sizes when they differ.
|
|
||||||
"""
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from PIL import Image, ImageChops
|
|
||||||
|
|
||||||
before, after = sys.argv[1], sys.argv[2]
|
|
||||||
for name in sorted(os.listdir(before)):
|
|
||||||
other = os.path.join(after, name)
|
|
||||||
if not os.path.exists(other):
|
|
||||||
print(name, "missing in", after)
|
|
||||||
continue
|
|
||||||
a = Image.open(os.path.join(before, name)).convert("RGB")
|
|
||||||
b = Image.open(other).convert("RGB")
|
|
||||||
if a.size != b.size:
|
|
||||||
print(name, "size", a.size, b.size)
|
|
||||||
continue
|
|
||||||
diff = ImageChops.difference(a, b)
|
|
||||||
count = sum(1 for p in diff.getdata() if p != (0, 0, 0))
|
|
||||||
print(name, count, diff.getbbox())
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
"""Before | after | red diff image, one row per snapshot.
|
|
||||||
|
|
||||||
Usage: python3 -I trip.py <before-dir> <after-dir> <out.png> <scale>
|
|
||||||
Both folders hold PNGs with the same names (crop them first if needed).
|
|
||||||
"""
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from PIL import Image, ImageChops
|
|
||||||
|
|
||||||
before, after, out, scale = sys.argv[1], sys.argv[2], sys.argv[3], int(sys.argv[4])
|
|
||||||
rows = []
|
|
||||||
for name in sorted(os.listdir(before)):
|
|
||||||
a = Image.open(os.path.join(before, name)).convert("RGB")
|
|
||||||
b = Image.open(os.path.join(after, name)).convert("RGB")
|
|
||||||
w, h = max(a.width, b.width), max(a.height, b.height)
|
|
||||||
pad_a = Image.new("RGB", (w, h), (200, 200, 200)); pad_a.paste(a, (0, 0))
|
|
||||||
pad_b = Image.new("RGB", (w, h), (200, 200, 200)); pad_b.paste(b, (0, 0))
|
|
||||||
mask = ImageChops.difference(pad_a, pad_b).convert("L").point(lambda v: 255 if v else 0)
|
|
||||||
red = Image.new("RGB", (w, h), (255, 255, 255))
|
|
||||||
red.paste((255, 0, 0), mask=mask)
|
|
||||||
row = Image.new("RGB", (w * 3 + 20, h), (200, 200, 200))
|
|
||||||
for i, im in enumerate([pad_a, pad_b, red]):
|
|
||||||
row.paste(im, (i * (w + 10), 0))
|
|
||||||
rows.append(row.resize((row.width * scale, row.height * scale), Image.NEAREST))
|
|
||||||
width = max(r.width for r in rows)
|
|
||||||
height = sum(r.height + 10 for r in rows)
|
|
||||||
canvas = Image.new("RGB", (width, height), (255, 255, 255))
|
|
||||||
y = 0
|
|
||||||
for r in rows:
|
|
||||||
canvas.paste(r, (0, y))
|
|
||||||
y += r.height + 10
|
|
||||||
canvas.save(out)
|
|
||||||
@ -1,105 +1,315 @@
|
|||||||
---
|
---
|
||||||
name: plan-review-criteria
|
name: plan-review-criteria
|
||||||
description: Criteria for reviewing implementation plans, including evidence, severity and verdicts. Loaded by the review-plan subagent.
|
description: Plan review criteria — the six review axes, severity rubric, approval standard, and output format for reviewing implementation plans. Loaded by the reviewer subagent of the review-plan flow. Not a user-facing flow — to review a plan, use the review-plan flow.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Plan Review Criteria
|
# Plan Review Criteria
|
||||||
|
|
||||||
Evaluate whether the plan can deliver its stated goal safely and whether a
|
## Overview
|
||||||
skilled implementer can execute and verify it without guessing. Perfect plans
|
|
||||||
do not exist: do not block on personal preferences or missing sections that
|
|
||||||
add no useful information. Apply each criterion in proportion to the plan's
|
|
||||||
scope and risks; explain when a criterion is not applicable.
|
|
||||||
|
|
||||||
Follow `review-plan` for delegation, permitted edits, decisions and handover.
|
Multi-dimensional plan review with quality gates. Every plan gets reviewed before implementation starts — no exceptions. Review covers six axes: completeness, task quality, architecture & sequencing, risk coverage, actionability, and proposed code quality.
|
||||||
Do not run tests, builds or other state-changing checks during the review.
|
|
||||||
|
|
||||||
## Evidence and scope
|
**The approval standard:** Approve a plan when it is specific enough that a skilled implementer could execute it without guessing, the task ordering is sound, and risks are acknowledged. Perfect plans don't exist — the goal is confidence that implementation won't derail. Don't block a plan because it isn't exactly how you would have structured it. If it's executable and well-organized, approve it.
|
||||||
|
|
||||||
- Read the plan, relevant code, project guidance and module memories. Check
|
## When to Use
|
||||||
that cited paths, symbols and proposed commands exist and are appropriate;
|
|
||||||
distinguish verified facts from assumptions and unknowns. Do not invent
|
|
||||||
findings or claim checks were run when they were not.
|
|
||||||
- Check that tasks serve the stated goal and respect existing requirements and
|
|
||||||
decisions. Identify scope creep, contradictions and dependencies on external
|
|
||||||
work. A consequential change in scope, behavior or tradeoffs needs the user's
|
|
||||||
decision.
|
|
||||||
- Evaluate the proposed approach even without code snippets: does it solve the
|
|
||||||
problem, fit existing conventions and avoid unnecessary complexity? If the
|
|
||||||
plan includes code, also check its types, signatures and examples.
|
|
||||||
|
|
||||||
## Six review axes
|
- The reviewer subagent of the `review-plan` flow loads this skill to perform
|
||||||
|
the review of a plan.
|
||||||
|
- To review a plan, always go through the `review-plan` flow — never load this
|
||||||
|
skill directly for that. This is the criteria reference, not the flow.
|
||||||
|
|
||||||
|
**Do NOT use for:** Single-file changes with obvious scope, or when the task is trivial enough to just do.
|
||||||
|
|
||||||
|
## The Six-Axis Review
|
||||||
|
|
||||||
|
Every plan gets evaluated across these dimensions:
|
||||||
|
|
||||||
### 1. Completeness
|
### 1. Completeness
|
||||||
|
|
||||||
Are the problem, intended outcome, affected areas and relevant constraints
|
Does the plan cover everything needed to implement successfully?
|
||||||
clear? Does the plan explain important decisions and include an appropriate
|
|
||||||
testing strategy? Identify missing information that would change the outcome
|
|
||||||
or force an implementer to guess. Require risk, rollback, migration or
|
|
||||||
parallelization details only when relevant.
|
|
||||||
|
|
||||||
### 2. Task quality
|
- Is the **context** clear? (What problem, why now, what's the goal?)
|
||||||
|
- Are **affected modules** identified with paths?
|
||||||
|
- Are **architecture decisions** documented with rationale?
|
||||||
|
- Is there a **testing strategy**?
|
||||||
|
- Are **verification commands** explicit (not "run the tests")?
|
||||||
|
- Are **open questions** listed (not buried in someone's head)?
|
||||||
|
- Is there a **parallelization** assessment for multi-task plans?
|
||||||
|
|
||||||
Are tasks scoped, ordered and specific enough to execute? Check likely files,
|
**Missing any of these is a gap, not a nit.**
|
||||||
dependencies, rationale, acceptance criteria and verification where relevant.
|
|
||||||
Acceptance criteria should describe observable behavior, including important
|
|
||||||
failure cases. Split work when it is too large to understand or verify safely,
|
|
||||||
not merely because it crosses an arbitrary task count.
|
|
||||||
|
|
||||||
### 3. Architecture and sequencing
|
### 2. Task Quality
|
||||||
|
|
||||||
Does the approach fit the existing architecture and reuse appropriate
|
Are the tasks well-defined and independently executable?
|
||||||
facilities? Do dependencies precede their consumers, and can the work be
|
|
||||||
verified as it progresses? Prefer independently testable slices where useful;
|
|
||||||
use checkpoints where risk or coordination warrants them, not at a fixed
|
|
||||||
interval. Flag unrelated work or abstractions that add complexity without
|
|
||||||
helping the goal.
|
|
||||||
|
|
||||||
### 4. Risk coverage
|
- Does every task have **acceptance criteria**? (Testable, not vague)
|
||||||
|
- Does every task have **verification steps**?
|
||||||
|
- Are tasks **sized appropriately**? (XS–M is ideal, L is acceptable, XL must be split)
|
||||||
|
- Are **dependencies** between tasks explicitly stated?
|
||||||
|
- Are **files likely touched** listed?
|
||||||
|
- Is each task a **single, self-contained change**? (Not "implement the whole feature")
|
||||||
|
- Could a skilled implementer pick up any task and execute it without asking clarifying questions?
|
||||||
|
|
||||||
Consider relevant edge cases, security, performance, compatibility, data
|
### 3. Architecture & Sequencing
|
||||||
integrity, migrations and external dependencies. Where failure has meaningful
|
|
||||||
consequences, check detection, mitigation and rollback or recovery. Do not
|
|
||||||
invent risks or demand a rollback section for changes that do not need one.
|
|
||||||
|
|
||||||
### 5. Actionability and verification
|
Is the plan structured so implementation flows correctly?
|
||||||
|
|
||||||
Can the implementer identify the affected code, follow project conventions and
|
- Does implementation order follow the **dependency graph** (foundations first)?
|
||||||
run the stated project-specific checks? Are commands and prerequisites correct?
|
- Are tasks **vertically sliced** (feature paths) rather than horizontally layered?
|
||||||
Do tests and other checks demonstrate the intended behavior and important
|
- Does each task leave the system in a **working state**?
|
||||||
failure cases? Surface unknowns honestly rather than presenting an unverified
|
- Are there **checkpoints** between major phases?
|
||||||
command or assumption as fact.
|
- Are **high-risk tasks early** (fail fast)?
|
||||||
|
- Is the total plan a reasonable number of tasks? (More than ~15 tasks suggests the scope should be split into multiple plans)
|
||||||
|
|
||||||
### 6. Proposed solution quality
|
### 4. Risk Coverage
|
||||||
|
|
||||||
Assess correctness, clarity, architecture, security and performance of the
|
Are the hard parts acknowledged and mitigated?
|
||||||
proposed solution, even when the plan contains no code. For any code sketches,
|
|
||||||
also check boundary cases, names, types and contracts. Preserve intended
|
|
||||||
behavior unless a change is explicitly agreed; prefer the simplest solution
|
|
||||||
that meets the requirements.
|
|
||||||
|
|
||||||
## Findings and verdict
|
- Are **edge cases** identified?
|
||||||
|
- Are **breaking changes** or **migration concerns** noted?
|
||||||
|
- Are **security implications** considered?
|
||||||
|
- Are **performance implications** considered?
|
||||||
|
- Are **external dependencies** or integration risks flagged?
|
||||||
|
- Is there a plan for **rollback** if something goes wrong?
|
||||||
|
- Are **data integrity** risks addressed (what happens if a migration fails mid-way)?
|
||||||
|
|
||||||
Give each reported item a stable ID (`P1`, `P2`, …); retain it throughout the
|
### 5. Actionability
|
||||||
review and any decision walkthrough. For each item state the evidence, impact,
|
|
||||||
concrete remedy and verification needed. For a consequential user decision,
|
|
||||||
include real options, consequences and a recommendation.
|
|
||||||
|
|
||||||
- **Blocking:** implementation cannot proceed safely or an essential user
|
Can an implementer actually execute this?
|
||||||
decision remains open. Explain what blocks it.
|
|
||||||
- **Improvement:** a clear correction that preserves the agreed goal, scope
|
|
||||||
and behavior. Apply it under `review-plan`'s permitted-edit rules.
|
|
||||||
- **Optional:** a suggestion that does not prevent implementation. Do not
|
|
||||||
silently expand scope or override the user's decisions.
|
|
||||||
|
|
||||||
Report applied improvements and any outstanding items with their IDs. Give a
|
- Are **file paths** specific (not "update the relevant files")?
|
||||||
provisional verdict before any walkthrough and a final verdict after applying
|
- Are **function/method names** mentioned where applicable?
|
||||||
the decisions:
|
- Are **verification commands** copy-pasteable (not "run the linter")?
|
||||||
|
- Are **test commands** project-specific (not generic)?
|
||||||
|
- Is the **code shape** described where the implementation isn't obvious?
|
||||||
|
- Are **conventions** referenced (naming, patterns, existing utilities to reuse)?
|
||||||
|
- Does the plan reference **existing code** the implementer should read first?
|
||||||
|
|
||||||
- **Ready:** no blocking issue or essential decision remains.
|
### 6. Proposed Code Quality *(when the plan includes implementation details)*
|
||||||
- **Awaiting decisions:** user decisions are needed before the plan is ready.
|
|
||||||
- **Blocked:** required work or evidence is missing and cannot be resolved by
|
|
||||||
applying clear improvements or obtaining the current decisions alone.
|
|
||||||
|
|
||||||
Do not approve an unresolved blocker. A plan may be ready with optional
|
If the plan proposes code shapes, function signatures, data structures, or API designs, evaluate those proposals against `code-review-criteria`:
|
||||||
suggestions; identify them without treating them as required.
|
|
||||||
|
- **Correctness:** Do the proposed types/signatures handle edge cases (null, empty, boundaries)?
|
||||||
|
- **Readability:** Are proposed names descriptive and consistent with project conventions?
|
||||||
|
- **Architecture:** Do proposed abstractions follow existing patterns? Are they justified (not over-engineered)?
|
||||||
|
- **Security:** Do proposed APIs validate input at boundaries? Any injection/XSS vectors in the design?
|
||||||
|
- **Performance:** Do proposed data structures avoid N+1 patterns? Any unbounded operations in the design?
|
||||||
|
|
||||||
|
**When to apply:** Only when the plan includes specific code snippets, type definitions, API contracts, or function signatures. Plans that only describe "what" without showing "how" skip this axis.
|
||||||
|
|
||||||
|
## Structural Remedies
|
||||||
|
|
||||||
|
When you flag a structural problem in a plan, propose the fix — not just the problem:
|
||||||
|
|
||||||
|
- **A task is too large (XL):** Split it into vertical slices. Each slice should be independently testable.
|
||||||
|
- **Missing acceptance criteria:** Draft 2–3 specific, testable conditions for the task.
|
||||||
|
- **Wrong sequencing:** Identify the dependency and propose the correct order.
|
||||||
|
- **No checkpoints:** Suggest where checkpoints should go (typically after every 2–3 tasks).
|
||||||
|
- **Vague verification:** Replace "run tests" with the actual project command.
|
||||||
|
- **Horizontal slicing:** Restructure into vertical feature paths.
|
||||||
|
- **Missing risk section:** Draft the risks you can identify from the plan content.
|
||||||
|
|
||||||
|
Prefer the remedy that makes the plan immediately actionable over one that just flags the gap.
|
||||||
|
|
||||||
|
## Plan Sizing
|
||||||
|
|
||||||
|
Plans should be scoped to a single deliverable:
|
||||||
|
|
||||||
|
```
|
||||||
|
1–5 tasks → Good. A focused feature or bug fix.
|
||||||
|
6–10 tasks → Acceptable for a moderate feature.
|
||||||
|
11–15 tasks → Large. Consider splitting into phases.
|
||||||
|
15+ tasks → Too large. Split into multiple plans.
|
||||||
|
```
|
||||||
|
|
||||||
|
**What counts as "one plan":** A self-contained set of changes that delivers a single coherent capability. If you can describe the goal in one sentence, it's one plan.
|
||||||
|
|
||||||
|
## Categorize Findings
|
||||||
|
|
||||||
|
Label every comment with its severity so the author knows what's required vs optional:
|
||||||
|
|
||||||
|
| Prefix | Meaning | Author Action |
|
||||||
|
|--------|---------|---------------|
|
||||||
|
| *(no prefix)* | Required change | Must address before implementation starts |
|
||||||
|
| **Critical:** | Blocks implementation | Missing security consideration, data integrity risk, fundamentally wrong approach |
|
||||||
|
| **Nit:** | Minor, optional | Author may ignore — wording, formatting |
|
||||||
|
| **Optional:** / **Consider:** | Suggestion | Worth considering but not required |
|
||||||
|
| **FYI** | Informational only | No action needed — context for future reference |
|
||||||
|
|
||||||
|
**Lead with what matters.** Order findings by leverage: missing risks and wrong sequencing first, then task quality gaps, then completeness, then nits. If you have one critical sequencing problem and ten nits, the sequencing problem *is* the review.
|
||||||
|
|
||||||
|
## Review Process
|
||||||
|
|
||||||
|
### Step 1: Understand the Goal
|
||||||
|
|
||||||
|
Before evaluating structure, understand intent:
|
||||||
|
|
||||||
|
```
|
||||||
|
- What is this plan trying to accomplish?
|
||||||
|
- What problem does it solve?
|
||||||
|
- What does "done" look like?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Check Completeness First
|
||||||
|
|
||||||
|
Scan for missing sections before diving into content:
|
||||||
|
|
||||||
|
```
|
||||||
|
- Context present?
|
||||||
|
- Affected modules listed?
|
||||||
|
- Architecture decisions documented?
|
||||||
|
- Risks acknowledged?
|
||||||
|
- Testing strategy defined?
|
||||||
|
- Verification commands explicit?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 3: Review Task Quality
|
||||||
|
|
||||||
|
Walk through each task:
|
||||||
|
|
||||||
|
```
|
||||||
|
For each task:
|
||||||
|
1. Can I tell exactly what to build?
|
||||||
|
2. Are acceptance criteria specific and testable?
|
||||||
|
3. Is the size reasonable (not XL)?
|
||||||
|
4. Are dependencies clear?
|
||||||
|
5. Would I know which files to touch?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 4: Validate Sequencing
|
||||||
|
|
||||||
|
Check the dependency graph:
|
||||||
|
|
||||||
|
```
|
||||||
|
- Are foundations built first?
|
||||||
|
- Does each task leave the system working?
|
||||||
|
- Are checkpoints placed correctly?
|
||||||
|
- Are high-risk items early?
|
||||||
|
- Is it vertically sliced?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5: Assess Actionability
|
||||||
|
|
||||||
|
Put yourself in the implementer's shoes:
|
||||||
|
|
||||||
|
```
|
||||||
|
- Could I pick up task 1 and start coding without asking any questions?
|
||||||
|
- Are the verification commands copy-pasteable?
|
||||||
|
- Are file paths and function names specific?
|
||||||
|
- Is existing code referenced where I'd need to read it?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 6: Verify the Verification Story
|
||||||
|
|
||||||
|
Check that the plan can actually confirm it worked:
|
||||||
|
|
||||||
|
```
|
||||||
|
- What tests should pass after implementation?
|
||||||
|
- What build/compile commands are relevant?
|
||||||
|
- What manual checks are needed?
|
||||||
|
- How do we know the feature works end-to-end?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 7: Evaluate Proposed Code Quality *(if applicable)*
|
||||||
|
|
||||||
|
If the plan includes code snippets, types, or API designs:
|
||||||
|
|
||||||
|
```
|
||||||
|
- Load code-review-criteria skill for criteria
|
||||||
|
- Check proposed signatures for edge cases
|
||||||
|
- Verify naming follows project conventions
|
||||||
|
- Confirm abstractions follow existing patterns
|
||||||
|
- Scan for security vectors in proposed APIs
|
||||||
|
- Check for performance issues in proposed data structures
|
||||||
|
```
|
||||||
|
|
||||||
|
## Review Checklist
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Review: [Plan title]
|
||||||
|
|
||||||
|
### Completeness
|
||||||
|
- [ ] Context explains the problem and goal
|
||||||
|
- [ ] Affected modules are listed with paths
|
||||||
|
- [ ] Architecture decisions have rationale
|
||||||
|
- [ ] Testing strategy is defined
|
||||||
|
- [ ] Verification commands are explicit and project-specific
|
||||||
|
- [ ] Open questions are listed
|
||||||
|
|
||||||
|
### Task Quality
|
||||||
|
- [ ] Every task has acceptance criteria
|
||||||
|
- [ ] Every task has verification steps
|
||||||
|
- [ ] Tasks are sized XS–M (L acceptable, XL must be split)
|
||||||
|
- [ ] Task dependencies are stated
|
||||||
|
- [ ] Files likely touched are listed
|
||||||
|
|
||||||
|
### Architecture & Sequencing
|
||||||
|
- [ ] Order follows dependency graph (foundations first)
|
||||||
|
- [ ] Vertically sliced (not horizontal layers)
|
||||||
|
- [ ] Each task leaves system working
|
||||||
|
- [ ] Checkpoints exist between phases
|
||||||
|
- [ ] High-risk tasks are early
|
||||||
|
|
||||||
|
### Risk Coverage
|
||||||
|
- [ ] Edge cases identified
|
||||||
|
- [ ] Breaking changes / migrations noted
|
||||||
|
- [ ] Security implications considered
|
||||||
|
- [ ] Performance implications considered
|
||||||
|
- [ ] Rollback strategy exists (if applicable)
|
||||||
|
|
||||||
|
### Actionability
|
||||||
|
- [ ] File paths are specific
|
||||||
|
- [ ] Verification commands are copy-pasteable
|
||||||
|
- [ ] Existing code to read is referenced
|
||||||
|
- [ ] Conventions and patterns are noted
|
||||||
|
|
||||||
|
### Proposed Code Quality *(if plan includes implementation details)*
|
||||||
|
- [ ] Proposed types/signatures handle edge cases
|
||||||
|
- [ ] Proposed names follow project conventions
|
||||||
|
- [ ] Proposed abstractions follow existing patterns
|
||||||
|
- [ ] No security vectors in proposed APIs
|
||||||
|
- [ ] No performance issues in proposed structures
|
||||||
|
|
||||||
|
### Verdict
|
||||||
|
- [ ] **Approve** — Ready to implement
|
||||||
|
- [ ] **Request changes** — Gaps must be addressed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Rationalizations
|
||||||
|
|
||||||
|
| Rationalization | Reality |
|
||||||
|
|---|---|
|
||||||
|
| "I'll figure out the details during implementation" | That's how you discover blocking dependencies mid-task. Surface them now. |
|
||||||
|
| "The tasks are obvious, no need for criteria" | Write them anyway. Explicit criteria surface hidden assumptions. |
|
||||||
|
| "It's just a small feature, it doesn't need a plan" | Small features have edge cases too. 3 tasks with criteria takes 5 minutes. |
|
||||||
|
| "The plan is good enough" | "Good enough" without acceptance criteria means the implementer defines "done" — and they might define it differently. |
|
||||||
|
| "I'll add verification steps later" | Later never comes. The plan is the contract — define verification now. |
|
||||||
|
| "Risks are minimal" | Every change has risks. If you can't name them, you haven't thought about them. |
|
||||||
|
| "The file paths are obvious" | They're obvious to the author. The implementer might not know the codebase. |
|
||||||
|
| "The code in the plan is fine, it'll get reviewed later" | Plan-level code review catches design problems before implementation — fixing them after coding is more expensive. |
|
||||||
|
|
||||||
|
## Red Flags
|
||||||
|
|
||||||
|
- No acceptance criteria on any task
|
||||||
|
- Tasks that say "implement the feature" without specifics
|
||||||
|
- No verification steps anywhere in the plan
|
||||||
|
- All tasks are XL-sized
|
||||||
|
- No checkpoints between phases
|
||||||
|
- Dependency order isn't considered (e.g., API handler before domain model)
|
||||||
|
- No testing strategy
|
||||||
|
- Verification commands are generic ("run tests") instead of project-specific
|
||||||
|
- Plan has 20+ tasks (scope too large for one plan)
|
||||||
|
- No risk section on a plan with migrations, breaking changes, or security implications
|
||||||
|
- Horizontal slicing (all domain, then all services, then all API)
|
||||||
|
- File paths are vague ("update the relevant files")
|
||||||
|
- Missing open questions section despite stated unknowns
|
||||||
|
- Proposed code ignores project conventions or existing patterns
|
||||||
|
- Proposed types use gratuitous `any`/`unknown`/optional without justification
|
||||||
|
- Proposed APIs don't validate input at boundaries
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- For producing plans, use the `planner` skill
|
||||||
|
- For reviewing implemented code, use `code-review-criteria` — also the criteria source for axis 6
|
||||||
|
- For security-specific concerns, see `security-and-hardening`
|
||||||
|
- For testing strategy guidance, see `testing`
|
||||||
|
|||||||
@ -42,10 +42,9 @@ Skipping this step is the #1 cause of incorrect or incomplete plans.
|
|||||||
only file you may write is the plan itself, and only when the command or
|
only file you may write is the plan itself, and only when the command or
|
||||||
user explicitly instructs you to save it.
|
user explicitly instructs you to save it.
|
||||||
- You do **not** run builds, tests, linters, or any commands that modify state.
|
- You do **not** run builds, tests, linters, or any commands that modify state.
|
||||||
- You do **not** create commits or run commands that modify version control.
|
- You do **not** create git commits or interact with version control.
|
||||||
Read-only inspection such as `git status`, `git log`, `git show` and
|
- You do **not** execute shell commands beyond read-only searches (`rg`, `ls`,
|
||||||
`git diff` is allowed.
|
`find`, `cat`, `bat`).
|
||||||
- Shell commands must be read-only.
|
|
||||||
- Your output is a structured plan or analysis, ready for handoff to an
|
- Your output is a structured plan or analysis, ready for handoff to an
|
||||||
engineer agent or developer.
|
engineer agent or developer.
|
||||||
|
|
||||||
@ -193,8 +192,8 @@ Source: review-code over `<commit>` (branch `<branch>`) | task `NN` of roadmap `
|
|||||||
Created: YYYY-MM-DD
|
Created: YYYY-MM-DD
|
||||||
```
|
```
|
||||||
|
|
||||||
End the response by suggesting the next steps: `@review-plan` to get a second
|
End the response by suggesting the next steps: `/review-plan` to get a second
|
||||||
opinion on the plan and `@implement-plan` to execute it.
|
opinion on the plan and `/implement-plan` to execute it.
|
||||||
|
|
||||||
### Plan Structure
|
### Plan Structure
|
||||||
|
|
||||||
@ -224,16 +223,16 @@ Review Log:
|
|||||||
log. `reviewed` never means "a review was emitted" — it means
|
log. `reviewed` never means "a review was emitted" — it means
|
||||||
"review feedback was incorporated". A plan approved with no changes
|
"review feedback was incorporated". A plan approved with no changes
|
||||||
goes `draft` → `done` without passing through `reviewed`.
|
goes `draft` → `done` without passing through `reviewed`.
|
||||||
- Before implementation, `review-plan` applies clear review feedback and
|
- Only a user-triggered apply step writes them before implementation:
|
||||||
agreed decisions, flips to `reviewed` and appends one UTC ISO 8601 entry
|
when the user says to apply `review-plan` findings, `make-a-plan`
|
||||||
when the plan changed. `make-a-plan` can also do this for additional
|
applies the changes, flips to `reviewed`, and appends one UTC
|
||||||
feedback when the user asks.
|
ISO 8601 line describing what changed.
|
||||||
- `implement-plan` flips to `done` on completion and appends one line
|
- `implement-plan` flips to `done` on completion and appends one line
|
||||||
with the issue URL when one exists (standalone mode); otherwise
|
with the issue URL when one exists (standalone mode); otherwise
|
||||||
just `done`. Never record commit hashes — they rot on amend/rebase
|
just `done`. Never record commit hashes — they rot on amend/rebase
|
||||||
and git already links the commit.
|
and git already links the commit.
|
||||||
- The log is append-only: never rewrite or delete lines.
|
- The log is append-only: never rewrite or delete lines.
|
||||||
- `review-code` never writes these fields.
|
- `review-plan` and `review-code` never write these fields.
|
||||||
|
|
||||||
Omit empty sections only when they do not apply. Every implementation task
|
Omit empty sections only when they do not apply. Every implementation task
|
||||||
still requires acceptance criteria, verification, dependencies, likely files,
|
still requires acceptance criteria, verification, dependencies, likely files,
|
||||||
@ -262,5 +261,5 @@ Before delivering the plan, confirm:
|
|||||||
- [ ] No task is XL or larger — break it down instead
|
- [ ] No task is XL or larger — break it down instead
|
||||||
- [ ] Checkpoints exist after every 2-3 tasks
|
- [ ] Checkpoints exist after every 2-3 tasks
|
||||||
- [ ] The response states the plan's path (saved or suggested) and suggests
|
- [ ] The response states the plan's path (saved or suggested) and suggests
|
||||||
`@review-plan` and `@implement-plan`
|
`/review-plan` and `/implement-plan`
|
||||||
- [ ] The plan is ready for human review
|
- [ ] The plan is ready for human review
|
||||||
|
|||||||
@ -1,421 +0,0 @@
|
|||||||
---
|
|
||||||
name: refactor-scss
|
|
||||||
description: Migrate one Penpot SCSS module off the deprecated styles under frontend/resources/styles/common/refactor/ to the current Design System (ds/ tokens, mixins and px2rem). Pure refactor, no visual change. Use when the user asks to refactor, migrate or clean up a .scss file to the DS.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Skill: refactor-scss
|
|
||||||
|
|
||||||
Refactor a single SCSS file so that it no longer depends on the deprecated
|
|
||||||
styling system, using the current Design System instead.
|
|
||||||
|
|
||||||
This is a **pure refactor**. Do NOT introduce visual or behavioral changes.
|
|
||||||
Preserve the generated CSS behavior exactly unless a rule below requires
|
|
||||||
otherwise. The rules that allow a small visible change (closest DS
|
|
||||||
typography, DS border width) want it shown in the visual check and listed
|
|
||||||
in the report and the commit body.
|
|
||||||
|
|
||||||
Reviewers read every line of the result. A line that is
|
|
||||||
copied but does nothing, a bare element selector or a raw z-index comes
|
|
||||||
back as a review comment, so the rules below are strict about them.
|
|
||||||
|
|
||||||
## Input
|
|
||||||
|
|
||||||
- The path to one `.scss` file (e.g. `frontend/src/app/main/ui/foo/bar.scss`).
|
|
||||||
- If no path is given, ask for it. Do not pick a file yourself.
|
|
||||||
|
|
||||||
## Workflow
|
|
||||||
|
|
||||||
1. Read the target `.scss` file and the `.cljs` file with the same name next
|
|
||||||
to it.
|
|
||||||
2. Read every deprecated source the file uses, so you inline real values,
|
|
||||||
never remembered ones:
|
|
||||||
- `frontend/resources/styles/common/refactor/mixins.scss`
|
|
||||||
- `frontend/resources/styles/common/refactor/design-tokens.scss`
|
|
||||||
- `frontend/resources/styles/common/refactor/spacing.scss`
|
|
||||||
- any other file under `frontend/resources/styles/common/refactor/` that
|
|
||||||
the stylesheet pulls in (placeholders, borders, z-index, fonts...).
|
|
||||||
3. Read the DS modules you will map to:
|
|
||||||
- `frontend/src/app/main/ui/ds/_utils.scss` (`px2rem()`)
|
|
||||||
- `frontend/src/app/main/ui/ds/spacing.scss`
|
|
||||||
- `frontend/src/app/main/ui/ds/_sizes.scss`
|
|
||||||
- `frontend/src/app/main/ui/ds/typography.scss` (`use-typography()`)
|
|
||||||
- `frontend/src/app/main/ui/ds/_borders.scss`
|
|
||||||
- `frontend/src/app/main/ui/ds/z-index.scss`
|
|
||||||
4. Apply the rules below and edit the file in place.
|
|
||||||
5. Verify (see **Verification** and **Visual check**).
|
|
||||||
6. Report (see **Output**). Do not commit. When the refactor goes with other
|
|
||||||
changes, it belongs in its own commit, after the task's commits.
|
|
||||||
|
|
||||||
## Primary goal
|
|
||||||
|
|
||||||
After the refactor, the SCSS file must not depend on anything under
|
|
||||||
`frontend/resources/styles/common/refactor/`. This includes imports, mixins,
|
|
||||||
placeholder selectors, functions, deprecated variables and design-token
|
|
||||||
aliases.
|
|
||||||
|
|
||||||
### Partial refactor
|
|
||||||
|
|
||||||
Some placeholders stand for a whole component family that will move to the DS
|
|
||||||
in its own PR: `%input-element`, `%input-with-label`, `%input-checkbox`,
|
|
||||||
`%modal-*`, `%menu-dropdown`, `%menu-item-base`, `%shortcut-*` and similar.
|
|
||||||
Inlining them in a small task produces big, risky diffs. In that case:
|
|
||||||
|
|
||||||
- migrate everything else (tokens, sizes, spacing, small mixins);
|
|
||||||
- keep the `refactor/` import only for those placeholders;
|
|
||||||
- list each remaining dependency and the selectors that use it in the report,
|
|
||||||
so the user can plan it as a separate PR.
|
|
||||||
|
|
||||||
## General rules
|
|
||||||
|
|
||||||
- Keep the resulting SCSS as small and readable as possible.
|
|
||||||
- Avoid duplicated declarations and duplicated selectors.
|
|
||||||
- Do not change class names.
|
|
||||||
- Do not change DOM structure.
|
|
||||||
- Do not change specificity unless required.
|
|
||||||
- Follow the project's SCSS formatting (Prettier, see **Verification**).
|
|
||||||
|
|
||||||
## Imports
|
|
||||||
|
|
||||||
Use the DS modules. Import them with `as *` when they expose mixins,
|
|
||||||
variables or functions:
|
|
||||||
|
|
||||||
```scss
|
|
||||||
@use "ds/_utils.scss" as *;
|
|
||||||
```
|
|
||||||
|
|
||||||
not
|
|
||||||
|
|
||||||
```scss
|
|
||||||
@use "ds/_utils.scss" as utils;
|
|
||||||
```
|
|
||||||
|
|
||||||
Do not introduce namespaces such as `utils.`, `typography.`, `borders.`,
|
|
||||||
`spacing.` or `sizes.` unless a module explicitly requires one.
|
|
||||||
|
|
||||||
Remove every unused import.
|
|
||||||
|
|
||||||
## Deprecated mixins
|
|
||||||
|
|
||||||
If the stylesheet uses mixins from
|
|
||||||
`frontend/resources/styles/common/refactor/mixins.scss`:
|
|
||||||
|
|
||||||
- locate the mixin;
|
|
||||||
- inline its generated CSS (then apply the rest of these rules to it);
|
|
||||||
- remove the `@include`;
|
|
||||||
- remove the import.
|
|
||||||
|
|
||||||
Do not leave deprecated mixins.
|
|
||||||
|
|
||||||
## Placeholders
|
|
||||||
|
|
||||||
Replace every `@extend %placeholder` with the generated CSS. Remove every
|
|
||||||
deprecated placeholder, except the component-family ones described in
|
|
||||||
**Partial refactor**.
|
|
||||||
|
|
||||||
Inline only what does something on that element. Do not paste a
|
|
||||||
placeholder (or mixin) body as it is. For each property, check:
|
|
||||||
|
|
||||||
- **It applies to the element.** `fill`, `stroke` and `stroke-width` only
|
|
||||||
act on SVG shapes: drop them from a `span`, `div` or `button`.
|
|
||||||
`color: transparent` on a wrapper that only holds an icon does nothing
|
|
||||||
useful: drop it and set the real color.
|
|
||||||
- **It is not the default or already given.** `stroke-width: 1px` is the
|
|
||||||
SVG default; `fill: none` and `stroke: currentColor` are already set by
|
|
||||||
the DS `icon*` (`.icon`). Drop them.
|
|
||||||
- **A later rule does not override it.**
|
|
||||||
- **It is not a stroke width on a DS icon.** DS icons keep the DS
|
|
||||||
stroke width; drop any `stroke-width` that only imitates the legacy
|
|
||||||
icon (1.33px, 2.25px...).
|
|
||||||
|
|
||||||
`%button-icon` is the usual case: on a wrapper it leaves `color:
|
|
||||||
transparent; fill: none; stroke-width: 1px`, and none of the three is
|
|
||||||
needed.
|
|
||||||
|
|
||||||
## Element selectors
|
|
||||||
|
|
||||||
Do not style HTML elements directly (`svg {}`, `h3 {}`, `button {}`,
|
|
||||||
`input.x {}`, or `.component { svg {} }`).
|
|
||||||
|
|
||||||
When no class exists, **add one in the `.cljs`**: a DS component takes
|
|
||||||
`:class (stl/css :x)` (`icon*`, `heading*`, `button*`…), and a plain
|
|
||||||
element takes `{:class (stl/css :x)}`. Touching the `.cljs` for this is
|
|
||||||
part of the refactor. A comment like "the icon has no class" is not an
|
|
||||||
answer.
|
|
||||||
|
|
||||||
Prefer the DS component when one fits: `heading*` for `h1`–`h6`
|
|
||||||
(`:level`, `:typography`), `text*` for text, `icon*` for icons.
|
|
||||||
|
|
||||||
`element.class` (e.g. `input.element-title`) is not needed to beat the
|
|
||||||
input defaults: try the class alone and check it in the visual check.
|
|
||||||
|
|
||||||
An element selector stays only for markup you cannot reach (injected
|
|
||||||
HTML, third-party widgets), with a comment saying so.
|
|
||||||
|
|
||||||
**Icon colors.** A DS icon draws with `stroke: currentColor`. Set
|
|
||||||
`color` on the icon class or its parent, never `stroke`/`fill` on an
|
|
||||||
`svg` selector.
|
|
||||||
|
|
||||||
## Color variables
|
|
||||||
|
|
||||||
Whenever a color changes across states, introduce a component-local CSS
|
|
||||||
variable.
|
|
||||||
|
|
||||||
Instead of
|
|
||||||
|
|
||||||
```scss
|
|
||||||
.button {
|
|
||||||
color: var(--color-foreground-primary);
|
|
||||||
|
|
||||||
&:hover {
|
|
||||||
color: var(--color-accent-primary);
|
|
||||||
}
|
|
||||||
|
|
||||||
&:disabled {
|
|
||||||
color: var(--color-foreground-disabled);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
write
|
|
||||||
|
|
||||||
```scss
|
|
||||||
.button {
|
|
||||||
--button-foreground-color: var(--color-foreground-primary);
|
|
||||||
|
|
||||||
color: var(--button-foreground-color);
|
|
||||||
|
|
||||||
&:hover {
|
|
||||||
--button-foreground-color: var(--color-accent-primary);
|
|
||||||
}
|
|
||||||
|
|
||||||
&:disabled {
|
|
||||||
--button-foreground-color: var(--color-foreground-disabled);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Use this pattern for `color`, `background-color`, `border-color`,
|
|
||||||
`outline-color`, `fill`, `stroke` and any similar property.
|
|
||||||
|
|
||||||
## Design token aliases
|
|
||||||
|
|
||||||
Remove every alias defined in
|
|
||||||
`frontend/resources/styles/common/refactor/design-tokens.scss`. Resolve each
|
|
||||||
alias to its final DS token. Do not keep intermediate aliases.
|
|
||||||
|
|
||||||
Instead of `color: var(--button-foreground-hover);` write
|
|
||||||
`color: var(--color-accent-primary);`.
|
|
||||||
|
|
||||||
## Spacing
|
|
||||||
|
|
||||||
Replace deprecated spacing variables using
|
|
||||||
`frontend/src/app/main/ui/ds/spacing.scss` for `margin`, `padding`, `gap` and
|
|
||||||
`inset`.
|
|
||||||
|
|
||||||
If no exact spacing token exists, use `px2rem()`. Do not approximate with the
|
|
||||||
closest token.
|
|
||||||
|
|
||||||
## Sizes
|
|
||||||
|
|
||||||
Replace deprecated size variables using
|
|
||||||
`frontend/src/app/main/ui/ds/_sizes.scss` for `inline-size`, `block-size`,
|
|
||||||
`width`, `height` and min/max sizes.
|
|
||||||
|
|
||||||
If no exact size exists, use `px2rem()` from
|
|
||||||
`frontend/src/app/main/ui/ds/_utils.scss`. Do not leave hardcoded pixel values
|
|
||||||
unless absolutely necessary.
|
|
||||||
|
|
||||||
## Typography
|
|
||||||
|
|
||||||
When any of `font-size`, `font-weight`, `line-height`, `font-family` or
|
|
||||||
`letter-spacing` appear, check whether together they match one of the
|
|
||||||
definitions in `frontend/src/app/main/ui/ds/typography.scss`.
|
|
||||||
|
|
||||||
If they match, replace all the individual declarations with:
|
|
||||||
|
|
||||||
```scss
|
|
||||||
@include use-typography("<typography-name>");
|
|
||||||
```
|
|
||||||
|
|
||||||
If there is no exact match, use the **closest DS typography** (same role:
|
|
||||||
a panel title in uppercase → `headline-small`, body text → `body-*`),
|
|
||||||
even when more than one detail differs. Show the change in the visual
|
|
||||||
check and state it in the report and in the commit body (e.g. "11px
|
|
||||||
regular → 12px medium").
|
|
||||||
|
|
||||||
Keep the original declarations only when no DS typography fits the role
|
|
||||||
(e.g. a 32px display number in a 14px-only area); then leave a TODO
|
|
||||||
naming the closest one and ask the user.
|
|
||||||
|
|
||||||
## Borders
|
|
||||||
|
|
||||||
Replace deprecated border radius and border width values using
|
|
||||||
`frontend/src/app/main/ui/ds/_borders.scss`. A raw width close to a token
|
|
||||||
(`1.75px`) takes the token (`$b-2`); say so in the report. If nothing is
|
|
||||||
close, use `px2rem()`.
|
|
||||||
|
|
||||||
## Logical properties
|
|
||||||
|
|
||||||
Prefer logical properties whenever they preserve the existing behavior:
|
|
||||||
|
|
||||||
- `width` → `inline-size`
|
|
||||||
- `height` → `block-size`
|
|
||||||
- `max-width` → `max-inline-size`
|
|
||||||
- `margin-left` → `margin-inline-start`
|
|
||||||
- `padding-right` → `padding-inline-end`
|
|
||||||
- `top` → `inset-block-start`
|
|
||||||
- `left` → `inset-inline-start`
|
|
||||||
|
|
||||||
## Z-index
|
|
||||||
|
|
||||||
Never leave magic z-index values. Use tokens from
|
|
||||||
`frontend/src/app/main/ui/ds/z-index.scss`, and pick the token **by what
|
|
||||||
the element is, not by its number**: a dropdown, menu or select →
|
|
||||||
`--z-index-dropdown`; a toolbar, palette, sidebar or panel →
|
|
||||||
`--z-index-panels`; and so on (read the comments in that file). A raw `4`
|
|
||||||
on a dropdown becomes `var(--z-index-dropdown)` even though the number
|
|
||||||
changes. Check the visual check for overlap.
|
|
||||||
|
|
||||||
Leave a TODO only when the element fits no token's purpose.
|
|
||||||
|
|
||||||
Legacy z-index values between sibling elements that do not overlap can be
|
|
||||||
removed, but only when the **Visual check** shows no pixel change in every
|
|
||||||
state that matters (open menus, collapsed, hidden). Say so in the report.
|
|
||||||
|
|
||||||
## Duplicated properties
|
|
||||||
|
|
||||||
Within the same selector, avoid duplicated properties, duplicated CSS
|
|
||||||
variables and duplicated declarations introduced by the refactor. Allow
|
|
||||||
duplicates only when they are intentional browser fallbacks.
|
|
||||||
|
|
||||||
## Unused classes
|
|
||||||
|
|
||||||
Open the `.cljs` file with the same name as the SCSS file and check whether
|
|
||||||
every CSS class is referenced (as `(stl/css :class-name)`,
|
|
||||||
`(stl/css-case :class-name ...)` or similar).
|
|
||||||
|
|
||||||
CSS modules prefix every class with its module
|
|
||||||
(`main_ui_<path>__<class>`), so only the `.cljs` of the same module can use
|
|
||||||
it. Before calling a selector unused, also search the whole `frontend/src`
|
|
||||||
for the class name as a string, a `:global` use, or a dynamic class built
|
|
||||||
at runtime.
|
|
||||||
|
|
||||||
If a selector is unused after that check:
|
|
||||||
|
|
||||||
- delete it (do not leave it commented out, do not add a TODO);
|
|
||||||
- list every deleted selector in the report and in the commit body.
|
|
||||||
|
|
||||||
A rule that matches nothing because the markup changed (e.g. `.icon svg`
|
|
||||||
when the DS icon is the `svg` itself) is deleted the same way. Before
|
|
||||||
deleting a descendant rule, check every element it matched, not only
|
|
||||||
the one you changed: `.placeholder .icon svg` can also color a second
|
|
||||||
icon, which then has no color (in the devenv it shows in the debug
|
|
||||||
yellow).
|
|
||||||
|
|
||||||
Every DS icon needs a color of its own (`color` on its class or on a
|
|
||||||
parent with a defined color): an icon that inherits nothing shows in
|
|
||||||
the debug yellow in the devenv.
|
|
||||||
|
|
||||||
Classes used by markup injected from outside (e.g. an external widget)
|
|
||||||
stay, with a comment saying so.
|
|
||||||
|
|
||||||
Also check the other direction: every class the `.cljs` passes to
|
|
||||||
`stl/css` / `stl/css-case` must exist in the `.scss`. A missing one silently
|
|
||||||
does nothing; report it.
|
|
||||||
|
|
||||||
## Sass and CSS pitfalls
|
|
||||||
|
|
||||||
- Sass does not evaluate functions inside CSS custom properties. Write
|
|
||||||
`--button-height: calc(var(--height) - #{px2rem(16)});`, not
|
|
||||||
`... - px2rem(16))`, or the browser gets the literal `px2rem(16)`.
|
|
||||||
- A `/` between Sass size variables is read as a division
|
|
||||||
(`grid-template: $sz-32 / auto` breaks). Split it into
|
|
||||||
`grid-template-rows` / `grid-template-columns` (or areas).
|
|
||||||
- A CSS-wide keyword cannot be part of a shorthand: `inset-inline: unset 0`
|
|
||||||
is invalid and stylelint does not catch it. Use the longhands.
|
|
||||||
- After editing, check the compiled CSS for any of these
|
|
||||||
(`frontend/resources/public/css/main.css`, search the module class).
|
|
||||||
|
|
||||||
## Uncertainty
|
|
||||||
|
|
||||||
If any transformation is uncertain, never guess. Leave a TODO in the code
|
|
||||||
and explain why in the report.
|
|
||||||
|
|
||||||
## Self-review
|
|
||||||
|
|
||||||
Before the report, read the final diff as the reviewer would and search
|
|
||||||
the file for these; each hit must be fixed or have a real reason:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
rg -n 'svg \{|^\s*(h[1-6]|p|hr|input|button|span|a)\b[^-_]|[a-z]\.[a-z-]+ \{' <file>
|
|
||||||
rg -n 'stroke-width|color: transparent|fill: none|z-index: [0-9]|TODO' <file>
|
|
||||||
rg -n '[0-9]\.[0-9]+px|[^(]\b[0-9]+px' <file>
|
|
||||||
```
|
|
||||||
|
|
||||||
- an element selector → add a class (see **Element selectors**);
|
|
||||||
- a property that does not apply or is a default → drop it (see
|
|
||||||
**Placeholders**);
|
|
||||||
- a raw z-index → token by purpose;
|
|
||||||
- a typography TODO → closest DS typography;
|
|
||||||
- a raw px value → token or `px2rem()`.
|
|
||||||
|
|
||||||
## Verification
|
|
||||||
|
|
||||||
Run the project scripts from `frontend/` inside the devenv container
|
|
||||||
(`penpot-devenv-ws<N>-main` for workspace `wsN`; never run `pnpm` on the
|
|
||||||
host), writing output to a file first (never pipe lint output into
|
|
||||||
filters):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker exec -u penpot -w /home/penpot/penpot/frontend penpot-devenv-ws<N>-main \
|
|
||||||
bash -lc 'pnpm run lint:scss; echo LINT=$?; pnpm run check-fmt:scss; echo FMT=$?' \
|
|
||||||
> <scratch>/scss-check.txt 2>&1
|
|
||||||
```
|
|
||||||
|
|
||||||
If the format check fails, run `pnpm run fmt:scss` and check again.
|
|
||||||
|
|
||||||
**Dependency check.** A grep for `refactor/` is not enough. For the final
|
|
||||||
file, check:
|
|
||||||
|
|
||||||
- `@use` / `@import` sources: all must be `ds/...` (or the sidebar common
|
|
||||||
module, which is DS-only);
|
|
||||||
- every `@include`, `@extend` and `%placeholder`;
|
|
||||||
- every `$variable`: which imported module defines it (`$br-*` exists in both
|
|
||||||
`ds/_borders.scss` and `refactor/borders.scss`; the `@use` decides);
|
|
||||||
- every `var(--token)`: defined in the DS (colors, spacing, sizes) or only as a
|
|
||||||
`refactor/` alias.
|
|
||||||
|
|
||||||
Report any failure as it is; do not hide it.
|
|
||||||
|
|
||||||
## Visual check
|
|
||||||
|
|
||||||
"No visual change" must be shown, not assumed. When a visual spec covers the
|
|
||||||
component (`frontend/playwright/ui/visual-specs/`, project `ds`), or one can be
|
|
||||||
added:
|
|
||||||
|
|
||||||
1. Capture before (base branch styles) and after with
|
|
||||||
`pnpm exec playwright test --project=ds -g "<test>" --update-snapshots=all`
|
|
||||||
in the container. `=all` is required: plain `--update-snapshots` only
|
|
||||||
rewrites past the 0.5% tolerance, so a real diff can look like 0.
|
|
||||||
2. Before each capture, wait until the compiled CSS/JS shows the expected
|
|
||||||
version (search `main.css` for the changed rule).
|
|
||||||
3. Compare with zero tolerance. If pixels change, build the before | after |
|
|
||||||
diff (red) image and explain every change in the report.
|
|
||||||
|
|
||||||
## Output
|
|
||||||
|
|
||||||
1. The diff of the file (`git diff -- <file>`).
|
|
||||||
2. A summary with:
|
|
||||||
- removed imports;
|
|
||||||
- removed deprecated mixins;
|
|
||||||
- removed placeholders;
|
|
||||||
- typography replacements;
|
|
||||||
- design-token aliases removed;
|
|
||||||
- logical properties introduced;
|
|
||||||
- deleted unused selectors;
|
|
||||||
- TODOs requiring manual review, each with its reason;
|
|
||||||
- remaining `refactor/` dependencies (partial refactor) and where they are
|
|
||||||
used;
|
|
||||||
- classes missing from the `.scss`, if any.
|
|
||||||
3. The verification results, including the visual check (pixel count, or why
|
|
||||||
it was not possible).
|
|
||||||
@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: review-code
|
name: review-code
|
||||||
description: Code review flow — review a diff, PR, or code change, delegating the review to a subagent that follows the code-review-criteria skill. Use it when the user asks to review code or a PR, in any phrasing.
|
description: Code review flow — review a diff, PR, or code change, delegating the review to a subagent that follows the code-review-criteria skill. Use it when the user asks to review code or a PR, in any phrasing.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Review Code
|
# Review Code
|
||||||
@ -12,7 +11,7 @@ Act as a senior software engineer and perform a thorough code review.
|
|||||||
|
|
||||||
- The user asks to review code, in any phrasing: "review this diff",
|
- The user asks to review code, in any phrasing: "review this diff",
|
||||||
"review the PR", "check my changes", "code review" — or runs
|
"review the PR", "check my changes", "code review" — or runs
|
||||||
`@review-code`.
|
`/review-code`.
|
||||||
- A commit, branch, PR, or diff is ready and the user wants it assessed
|
- A commit, branch, PR, or diff is ready and the user wants it assessed
|
||||||
before merge.
|
before merge.
|
||||||
|
|
||||||
@ -22,61 +21,17 @@ Act as a senior software engineer and perform a thorough code review.
|
|||||||
diff, a commit range, a branch, a PR (number or URL), or specific files. If
|
diff, a commit range, a branch, a PR (number or URL), or specific files. If
|
||||||
the target is ambiguous, ask before reviewing.
|
the target is ambiguous, ask before reviewing.
|
||||||
2. Delegate the review to the `general` subagent (via the task tool), unless the
|
2. Delegate the review to the `general` subagent (via the task tool), unless the
|
||||||
user specifies another agent. The prompt carries the **`code-review-criteria`**
|
user specifies another agent. Include in the prompt the
|
||||||
skill name, all user context, and these requirements:
|
**`code-review-criteria`** skill name and all user context.
|
||||||
- Load `code-review-criteria` and follow its process and output format.
|
|
||||||
- Read `AGENTS.md` (if present) and the module memories it points to for the
|
|
||||||
code being reviewed.
|
|
||||||
- Return the COMPLETE review, verbatim, exactly as the skill instructs it to
|
|
||||||
be produced. Never summarize it.
|
|
||||||
- Read-only: modify no file, create no commit, and run no tests, builds,
|
|
||||||
linters or other state-changing checks. Use prior results or CI evidence;
|
|
||||||
state explicitly when evidence is unavailable.
|
|
||||||
- Do not invent problems: every finding must be real and actionable.
|
|
||||||
- Missing tests are an issue, not a suggestion — a severity-tagged finding.
|
|
||||||
- For each finding, give a concrete remedy and the tests needed to verify it.
|
|
||||||
If a user decision is needed, include the real options and a recommendation
|
|
||||||
in that finding. Do not pause to ask during the review.
|
|
||||||
- Prioritize by impact: one structural issue outweighs ten nits, and "this
|
|
||||||
could be better" is not a finding — say why and how.
|
|
||||||
- Inspect generated files and lockfiles when relevant to the change, its
|
|
||||||
dependencies or security; exclude unrelated working-tree modifications.
|
|
||||||
3. When the subagent returns, output the review to the user verbatim. Do not
|
3. When the subagent returns, output the review to the user verbatim. Do not
|
||||||
summarize it and do not act on its findings. Retain the subagent session ID,
|
summarize it and do not act on its findings.
|
||||||
review target and complete findings in the session context for follow-up;
|
|
||||||
do not invent an ID if the tool does not provide one.
|
|
||||||
4. Right after the review, suggest how to proceed based on the findings. These
|
4. Right after the review, suggest how to proceed based on the findings. These
|
||||||
are suggestions — the user decides:
|
are suggestions — the user decides:
|
||||||
- **Approve (no required changes):** say so — there is nothing to address.
|
- **Approve (no required changes):** say so — there is nothing to address.
|
||||||
- **Minor findings:** suggest direct fixes after the user ends the review if
|
- **Minor findings (nits):** applying them directly as-is is fine once the
|
||||||
appropriate; no plan is required.
|
review is done — no plan needed.
|
||||||
- **Substantive findings:** suggest `@make-a-plan` to make a plan to address
|
- **Substantive findings:** suggest `/make-a-plan` to make a plan to address
|
||||||
them.
|
them.
|
||||||
- If the user wants to discuss findings one by one, use `@issue-walkthrough`
|
|
||||||
on request; do not start it automatically. The walkthrough returns its
|
|
||||||
decisions to `@make-a-plan`, not to automatic code editing.
|
|
||||||
|
|
||||||
### Follow-up after implementation
|
|
||||||
|
|
||||||
When the user agrees to verify corrections, resume the original reviewer using
|
|
||||||
its session ID if the tool supports it. Give it the original review target and
|
|
||||||
findings, the decisions and plan, the exact correction commit range or diff,
|
|
||||||
and the test evidence. Require it to inspect the actual corrections and
|
|
||||||
evidence, not rely on its earlier context alone. If the original session is
|
|
||||||
unavailable or cannot be resumed, tell the user and delegate to a new reviewer
|
|
||||||
with the same context; never claim it is the original reviewer. If the review,
|
|
||||||
decisions or correction range cannot be established, ask for the missing
|
|
||||||
information rather than inventing it.
|
|
||||||
|
|
||||||
The reviewer follows `code-review-criteria` and remains read-only. It reports
|
|
||||||
each original finding with its unchanged ID as **resolved**, **pending**, or
|
|
||||||
**not addressed** (including the agreed reason); report any new problems with
|
|
||||||
new, non-conflicting IDs. For pending and new problems, give evidence, a remedy,
|
|
||||||
tests and any user decision as in the original review. Summarize separately
|
|
||||||
whether all agreed corrections are resolved and whether any findings remain,
|
|
||||||
including deferred findings. Do not equate deferred with resolved. Present the
|
|
||||||
result without implementing fixes; the user chooses whether to iterate, request
|
|
||||||
an independent review, or stop.
|
|
||||||
|
|
||||||
### Hard rule — read-only while reviewing
|
### Hard rule — read-only while reviewing
|
||||||
|
|
||||||
@ -84,29 +39,35 @@ This flow is read-only **for the duration of the review**: from the moment it
|
|||||||
starts until the user considers the review finished (including any feedback,
|
starts until the user considers the review finished (including any feedback,
|
||||||
questions, or clarifications about it). During that period, never fix,
|
questions, or clarifications about it). During that period, never fix,
|
||||||
implement, edit files or create commits — not even "obvious" fixes derived from
|
implement, edit files or create commits — not even "obvious" fixes derived from
|
||||||
the findings. Never run tests, builds, linters or state-changing checks during
|
the findings. Once the user explicitly states the review is done (or moves on to
|
||||||
the review; inspect existing evidence instead. Once the user explicitly states
|
a different task), this rule no longer applies and you act as a normal build
|
||||||
the review is done (or moves on to a different task), this rule no longer
|
agent again.
|
||||||
applies and you act as a normal build agent again.
|
|
||||||
|
|
||||||
## Posting as a GitHub comment
|
## Instructions for the subagent
|
||||||
|
|
||||||
Post only when the user asks for it explicitly; otherwise keep the review in the
|
1. Load the **`code-review-criteria`** skill and follow its process and output
|
||||||
session. PR comments go in English, with this minimal structure:
|
format.
|
||||||
|
2. Read `AGENTS.md` (if present) and follow its instructions for finding and
|
||||||
|
reading all related testing documentation from memories before reviewing.
|
||||||
|
3. Return in your final message the COMPLETE review, verbatim, exactly as the
|
||||||
|
skill instructs it to be produced. Do not summarize it — include the full
|
||||||
|
structured review.
|
||||||
|
|
||||||
1. **Intro line** — one sentence: what was found and the overall tone. No
|
### Strong rules for the subagent
|
||||||
greetings.
|
|
||||||
2. **`## Main issues`** — one subsection per required finding: what breaks, the
|
|
||||||
failure circumstances, and the minimal fix (code snippet when useful). A
|
|
||||||
missing test belongs here, not under minor suggestions.
|
|
||||||
3. **`## Minor suggestions`** — one bullet per minor finding: file/function,
|
|
||||||
problem, concrete remedy.
|
|
||||||
4. **Closing** — optional and short. Cut it when it adds nothing.
|
|
||||||
|
|
||||||
Reference every finding by its ID (`F1`, `F2`, … from
|
1. Do not invent problems. Every finding must be real and actionable.
|
||||||
`code-review-criteria`) so follow-up replies can point to findings
|
2. Read-only: do not modify any file and do not create a commit — reviewing
|
||||||
unambiguously.
|
never writes.
|
||||||
|
3. Be specific and constructive. "This could be better" is not helpful — explain
|
||||||
|
why and how.
|
||||||
|
4. Prioritize by impact. One structural issue outweighs ten nits.
|
||||||
|
5. Missing tests are an issue, not a suggestion. Report as a severity-tagged
|
||||||
|
finding — never as a recommendation.
|
||||||
|
6. Skip generated files, lockfile-only changes, and unrelated modifications
|
||||||
|
unless they introduce security risks.
|
||||||
|
|
||||||
## User input, overrides and additional context
|
## User context
|
||||||
|
|
||||||
$ARGUMENTS
|
Extra context in the user's invocation (the message that triggered this skill)
|
||||||
|
plays the role command arguments play elsewhere: for example, a PR number or
|
||||||
|
URL, a commit range, specific files, or a different agent to run the review.
|
||||||
|
|||||||
@ -1,60 +1,71 @@
|
|||||||
---
|
---
|
||||||
name: review-plan
|
name: review-plan
|
||||||
description: Review an implementation plan with a subagent, apply clear improvements and resolve consequential decisions with the user.
|
description: Plan review flow — evaluate an implementation plan before it is executed, delegating the review to a subagent that follows the plan-review-criteria skill. Use it when the user asks to review a plan, in any phrasing.
|
||||||
slash: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Review Plan
|
# Review Plan
|
||||||
|
|
||||||
Review an unimplemented plan with a subagent and improve the plan without
|
Act as a senior software engineer and perform a thorough review of an
|
||||||
implementing it. Use this flow when the user asks for a plan review or invokes
|
implementation plan.
|
||||||
`@review-plan`.
|
|
||||||
|
|
||||||
## Flow
|
## When to use
|
||||||
|
|
||||||
1. Identify and read the complete plan and its file. If the target or path is
|
- The user asks to review a plan, in any phrasing: "review this plan",
|
||||||
ambiguous, ask. If no saved file exists, ask for a path or have the user save
|
"does this plan look right?", "second opinion on the plan" — or runs
|
||||||
it first. Do not edit a completed plan: propose a derived plan instead.
|
`/review-plan`.
|
||||||
2. Delegate to `general`, unless the user specifies a different subagent or
|
- A plan was just produced (typically by `/make-a-plan`) and the user
|
||||||
model. Supply the plan path, relevant session context and these instructions:
|
wants it evaluated before executing it.
|
||||||
- Load `plan-review-criteria`, read `AGENTS.md` and the relevant module and
|
|
||||||
testing memories, and review the plan against the criteria.
|
|
||||||
- Apply clear, evidence-based improvements directly to that plan file only.
|
|
||||||
Preserve the goal, scope, agreed decisions and intended behavior. Examples:
|
|
||||||
clarify tasks, add missing tests, correct dependencies and specify actual
|
|
||||||
verification commands. Do not guess commands or invent findings.
|
|
||||||
- A change that affects the goal, user-visible behavior, scope, tradeoffs or
|
|
||||||
an existing decision needs the user's decision. Leave it unresolved; report
|
|
||||||
concrete options, consequences and a recommendation. Do not ask questions
|
|
||||||
from the subagent.
|
|
||||||
- Return a concise summary of applied changes, remaining decisions with
|
|
||||||
stable IDs, evidence and recommendations, and an honest provisional
|
|
||||||
verdict. Retain the subagent session ID for follow-up if available.
|
|
||||||
- Do not change source files, other plans or documents, run state-changing
|
|
||||||
checks, commit, or implement the plan. If the plan is not writable, report
|
|
||||||
this and return the proposed edits instead.
|
|
||||||
3. Show the summary. If decisions remain, start `@issue-walkthrough` immediately
|
|
||||||
in the parent session with those questions and their IDs. Follow its one
|
|
||||||
question per turn and read-only rules. Do not ask questions that the code or
|
|
||||||
existing decisions settle. Wait for every answer.
|
|
||||||
4. Resume the same subagent with the decision table and plan path. It applies
|
|
||||||
the decisions to the plan, rechecks consistency and reports changes and any
|
|
||||||
newly discovered consequential decisions. Repeat the walkthrough for new
|
|
||||||
decisions, then apply those answers. If the original session cannot be
|
|
||||||
resumed, tell the user and apply the changes in the parent or delegate a new
|
|
||||||
subagent with the full context. If the reviewer cannot write, apply its
|
|
||||||
proposed edits in the parent only if the plan file is writable; otherwise
|
|
||||||
explain the blocker and stop.
|
|
||||||
5. Once all decisions are resolved and the plan is coherent, update its
|
|
||||||
metadata: when review feedback changed the plan, set `Status: reviewed` and
|
|
||||||
append one UTC ISO 8601 `Review Log` entry for this review, summarizing the
|
|
||||||
changes. Preserve prior log entries. If no feedback changed the plan, leave
|
|
||||||
status and log unchanged. Never record commit hashes. If decisions or
|
|
||||||
required changes remain unresolved, do not claim the plan is ready or mark
|
|
||||||
it reviewed.
|
|
||||||
6. Show the final summary, plan path and verdict. Suggest `@implement-plan` only
|
|
||||||
when the plan is ready. Never execute the plan automatically.
|
|
||||||
|
|
||||||
The only permitted write in this flow is the specified local plan file,
|
## Instructions
|
||||||
including its status and log. Do not stage or commit it. If a user instruction
|
|
||||||
overrides automatic editing, respect it and report findings without editing.
|
1. **Determine the plan under review** from the session context (for example, a
|
||||||
|
plan just produced by `/make-a-plan`) or from a plan file path given by the
|
||||||
|
user (typically under `.agents/plans/`). If a file path is given, read the
|
||||||
|
file first so the complete plan is in context.
|
||||||
|
2. Delegate the review to the `general` subagent (via the task tool), unless the
|
||||||
|
user specifies another agent. Include in the prompt the
|
||||||
|
**`plan-review-criteria`** skill name and all user context.
|
||||||
|
3. When the subagent returns, output the review to the user verbatim. Do not
|
||||||
|
summarize it and do not act on its findings.
|
||||||
|
4. Right after the review, suggest the next step based on the verdict. These
|
||||||
|
are suggestions — the user decides, and any instruction overrides them:
|
||||||
|
- **Approve** → suggest `/implement-plan` to execute it.
|
||||||
|
- **Request changes** → suggest `/make-a-plan` to make a plan to address the
|
||||||
|
findings.
|
||||||
|
|
||||||
|
### Hard rule — read-only while reviewing
|
||||||
|
|
||||||
|
This flow is read-only **for the duration of the review**: from the moment it
|
||||||
|
starts until the user considers the review finished (including any feedback,
|
||||||
|
questions, or clarifications about it). During that period, never fix,
|
||||||
|
implement, edit files or create commits — not even "obvious" fixes derived from
|
||||||
|
the findings. Once the user explicitly states the review is done (or moves on to
|
||||||
|
a different task), this rule no longer applies and you act as a normal build
|
||||||
|
agent again.
|
||||||
|
|
||||||
|
## Instructions for the subagent
|
||||||
|
|
||||||
|
1. Load the **`plan-review-criteria`** skill and follow its process and output
|
||||||
|
format.
|
||||||
|
2. Read `AGENTS.md` (if present) and follow its instructions for finding and
|
||||||
|
reading all related documentation and testing memories before reviewing.
|
||||||
|
3. Return in your final message the COMPLETE review, verbatim, exactly as the
|
||||||
|
skill instructs it to be produced. Do not summarize it — include the full
|
||||||
|
structured review.
|
||||||
|
|
||||||
|
### Strong rules for the subagent
|
||||||
|
|
||||||
|
1. Do not invent problems. Every finding must be real and actionable.
|
||||||
|
2. Read-only: do not modify any file and do not create a commit — reviewing
|
||||||
|
never writes.
|
||||||
|
3. Be specific and constructive. "This could be better" is not helpful — explain
|
||||||
|
why and how.
|
||||||
|
4. Prioritize by impact. One structural issue outweighs ten nits.
|
||||||
|
5. Judge the plan as the implementer would: every task executable without
|
||||||
|
guessing, ordering follows the dependency graph, risks named.
|
||||||
|
|
||||||
|
## User context
|
||||||
|
|
||||||
|
Extra context in the user's invocation (the message that triggered this skill)
|
||||||
|
plays the role command arguments play elsewhere: for example, a plan file path
|
||||||
|
to review, or a different agent to run the review.
|
||||||
|
|||||||
@ -6,8 +6,9 @@ slash: true
|
|||||||
|
|
||||||
# Skill: rewrite-commit-message
|
# Skill: rewrite-commit-message
|
||||||
|
|
||||||
Rewrite HEAD's title and description from its own diff. This also handles a
|
HEAD's message is a concatenation of older messages (typical after a
|
||||||
squash message with several subjects, bodies and repeated trailers.
|
squash): several subjects, bodies and repeated trailers stacked in a
|
||||||
|
single message. Replace it with one proper message and amend HEAD.
|
||||||
|
|
||||||
## When to Use
|
## When to Use
|
||||||
|
|
||||||
@ -16,11 +17,9 @@ squash message with several subjects, bodies and repeated trailers.
|
|||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
1. Check `git diff --cached` first. If any changes are staged, stop and ask
|
1. Read the full current message (`git log -1 --format=%B HEAD`) and
|
||||||
the user to handle them; an amend must never include those changes. Read
|
the branch diff (`git diff develop..HEAD --stat`, plus the code
|
||||||
the full current message (`git log -1 --format=%B HEAD`) and HEAD's own
|
when the summary needs grounding).
|
||||||
diff (`git show --format= --stat HEAD` and the patch). Respect the project
|
|
||||||
rule on amending pushed commits.
|
|
||||||
2. Collect every DISTINCT `AI-assisted-by:` value in the current
|
2. Collect every DISTINCT `AI-assisted-by:` value in the current
|
||||||
message. All of them survive into the new message, one line each:
|
message. All of them survive into the new message, one line each:
|
||||||
attributions are never dropped in a rewrite, even when most of
|
attributions are never dropped in a rewrite, even when most of
|
||||||
@ -28,7 +27,7 @@ squash message with several subjects, bodies and repeated trailers.
|
|||||||
3. Draft one message per `mem:workflow/creating-commits` (read it
|
3. Draft one message per `mem:workflow/creating-commits` (read it
|
||||||
end-to-end first): single subject (imperative, capitalized, no
|
end-to-end first): single subject (imperative, capitalized, no
|
||||||
trailing period, ≤80 chars), blank line, body wrapped at ≤80
|
trailing period, ≤80 chars), blank line, body wrapped at ≤80
|
||||||
chars covering HEAD's diff (not the old per-commit slices),
|
chars covering the whole diff (not the old per-commit slices),
|
||||||
then the preserved trailers.
|
then the preserved trailers.
|
||||||
4. Write it to a file (a heredoc keeps real newlines; inline `-m`
|
4. Write it to a file (a heredoc keeps real newlines; inline `-m`
|
||||||
with `\n` does not) and `git commit --amend -F <file>`.
|
with `\n` does not) and `git commit --amend -F <file>`.
|
||||||
|
|||||||
@ -67,7 +67,7 @@ rg "user_\d+"
|
|||||||
rg -F "function()"
|
rg -F "function()"
|
||||||
|
|
||||||
# Multiline search
|
# Multiline search
|
||||||
rg -U '(?s)start.*end'
|
rg -U "start.*end"
|
||||||
|
|
||||||
# Only show matches, not lines
|
# Only show matches, not lines
|
||||||
rg -o "https?://[^\s]+"
|
rg -o "https?://[^\s]+"
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: ste
|
name: ste
|
||||||
description: Write or rewrite text in ASD-STE100 Simplified Technical English. ONLY use this skill when the user explicitly invokes it by name — i.e. they type "@ste" or literally write "use the ste skill" / "apply ASD-STE100". Do NOT trigger it on paraphrased intent such as "simplify this", "make it clearer", "write technical documentation", or "shorter sentences please" — the user has deliberately scoped this skill to explicit invocation only. For those requests, respond normally without loading this skill unless they name it.
|
description: Write or rewrite text in ASD-STE100 Simplified Technical English. ONLY use this skill when the user explicitly invokes it by name — i.e. they type "/ste" or literally write "use the ste skill" / "apply ASD-STE100". Do NOT trigger it on paraphrased intent such as "simplify this", "make it clearer", "write technical documentation", or "shorter sentences please" — the user has deliberately scoped this skill to explicit invocation only. For those requests, respond normally without loading this skill unless they name it.
|
||||||
---
|
---
|
||||||
|
|
||||||
# ASD-STE100 Simplified Technical English
|
# ASD-STE100 Simplified Technical English
|
||||||
@ -11,7 +11,7 @@ Compliance note (for you, not for output): the official specification and its di
|
|||||||
|
|
||||||
## When to use
|
## When to use
|
||||||
|
|
||||||
Only when the user explicitly invokes it: they type `@ste`, or say "use
|
Only when the user explicitly invokes it: they type `/ste`, or say "use
|
||||||
the ste skill" / "apply ASD-STE100". Requests like "simplify this",
|
the ste skill" / "apply ASD-STE100". Requests like "simplify this",
|
||||||
"make it clearer", or "shorter sentences" do NOT invoke it — respond
|
"make it clearer", or "shorter sentences" do NOT invoke it — respond
|
||||||
normally unless it is named.
|
normally unless it is named.
|
||||||
|
|||||||
116
.agents/skills/taiga/SKILL.md
Normal file
116
.agents/skills/taiga/SKILL.md
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
---
|
||||||
|
name: taiga
|
||||||
|
description: Fetch information from Taiga public API for the Penpot project (id 345963) — issues, user stories, and tasks, without authentication.
|
||||||
|
metadata: {"clawdbot":{"requires":{"bins":["python3"]}}}
|
||||||
|
---
|
||||||
|
|
||||||
|
# Taiga API Skill
|
||||||
|
|
||||||
|
Fetch information from Taiga public API for the **Penpot** project
|
||||||
|
(project id: `345963`, slug: `penpot`).
|
||||||
|
|
||||||
|
**No authentication required** — only public project data is accessed.
|
||||||
|
|
||||||
|
## When to use
|
||||||
|
|
||||||
|
- The user asks about Penpot issues, user stories, or tasks tracked in
|
||||||
|
Taiga — fetch them via the public API (project id 345963), no
|
||||||
|
authentication needed.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- `python3` — the `scripts/taiga.py` CLI script is self-contained (stdlib only)
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
The easiest way is to use the bundled Python script:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Pass a Taiga URL directly
|
||||||
|
python3 scripts/taiga.py https://tree.taiga.io/project/penpot/issue/13714
|
||||||
|
|
||||||
|
# Or use "<type> <ref>" syntax
|
||||||
|
python3 scripts/taiga.py us 14128
|
||||||
|
python3 scripts/taiga.py task 13648
|
||||||
|
|
||||||
|
# Add --json for raw output
|
||||||
|
python3 scripts/taiga.py --json issue 13714
|
||||||
|
|
||||||
|
# See full usage
|
||||||
|
python3 scripts/taiga.py --help
|
||||||
|
```
|
||||||
|
|
||||||
|
## URL Pattern Reference
|
||||||
|
|
||||||
|
Taiga web URLs follow these patterns:
|
||||||
|
|
||||||
|
| Type | Web URL Pattern |
|
||||||
|
|------|----------------|
|
||||||
|
| Issue | `https://tree.taiga.io/project/penpot/issue/<REF>` |
|
||||||
|
| User Story | `https://tree.taiga.io/project/penpot/us/<REF>` |
|
||||||
|
| Task | `https://tree.taiga.io/project/penpot/task/<REF>` |
|
||||||
|
|
||||||
|
To extract the **type** and **ref** from a URL:
|
||||||
|
- `issue/13714` → type=`issue`, ref=`13714`
|
||||||
|
- `us/14128` → type=`us`, ref=`14128`
|
||||||
|
- `task/13648` → type=`task`, ref=`13648`
|
||||||
|
|
||||||
|
## Python Script Reference
|
||||||
|
|
||||||
|
The `scripts/taiga.py` script wraps the Taiga API into a single convenient CLI
|
||||||
|
with sensible defaults.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
python3 scripts/taiga.py <taiga-url>
|
||||||
|
python3 scripts/taiga.py <type> <ref>
|
||||||
|
python3 scripts/taiga.py [--json] <taiga-url>
|
||||||
|
python3 scripts/taiga.py [--json] <type> <ref>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# By URL (recommended — no need to think about type/ref)
|
||||||
|
python3 scripts/taiga.py https://tree.taiga.io/project/penpot/issue/13714
|
||||||
|
|
||||||
|
# By type and ref
|
||||||
|
python3 scripts/taiga.py us 14128
|
||||||
|
python3 scripts/taiga.py task 13648
|
||||||
|
|
||||||
|
# Raw JSON output
|
||||||
|
python3 scripts/taiga.py --json issue 13714
|
||||||
|
```
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
The script prints a clean, structured summary:
|
||||||
|
|
||||||
|
```text
|
||||||
|
User Story #11964 — 🔴 [DESIGN TOKENS] Typography Composite Input
|
||||||
|
================================
|
||||||
|
Status: Defining
|
||||||
|
Milestone: design-systems-sprint-26
|
||||||
|
Points: 3 role(s)
|
||||||
|
Assignee: Natacha Menjibar
|
||||||
|
Author: Natacha Menjibar
|
||||||
|
Created: 2025-09-01
|
||||||
|
Tags: iop-design-tokens
|
||||||
|
URL: https://tree.taiga.io/project/penpot/us/11964
|
||||||
|
================================
|
||||||
|
<full description text, unmodified>
|
||||||
|
```
|
||||||
|
|
||||||
|
The fields section includes type-specific information:
|
||||||
|
- **Issues:** Status, Type ID, Severity ID, Priority ID
|
||||||
|
- **User Stories:** Status, Milestone, Points
|
||||||
|
- **Tasks:** Status, Milestone, Parent US
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
- API docs: https://docs.taiga.io/api.html
|
||||||
|
- Taiga instance: https://tree.taiga.io
|
||||||
|
- API base: https://api.taiga.io/api/v1
|
||||||
|
- Penpot project id: `345963`
|
||||||
|
- Penpot project slug: `penpot`
|
||||||
@ -5,18 +5,16 @@ description: Update the project CHANGES.md with issues from a given GitHub miles
|
|||||||
|
|
||||||
# Skill: update-changelog
|
# Skill: update-changelog
|
||||||
|
|
||||||
Entry point for all changelog work. All rules — sections, exclusions, entry
|
Update `CHANGES.md` with entries for all issues and PRs in a given GitHub
|
||||||
format, the `:boom:`, `:rocket:` and `:lock:` contracts, pre-flight, and the
|
milestone. Each entry references the user-facing issue (not the PR) as the
|
||||||
anomaly report — live in `mem:workflow/updating-changelog` (file:
|
primary link, with the fix PR inline on the same line.
|
||||||
`.serena/memories/workflow/updating-changelog.md`). This skill routes to that
|
|
||||||
memory; it does not repeat it.
|
|
||||||
|
|
||||||
## When to Use
|
## When to Use
|
||||||
|
|
||||||
- Before a new release, to populate the changelog with all fixed issues
|
- Before a new release, to populate the changelog with all fixed issues
|
||||||
- When new issues are added to an existing milestone and the changelog needs
|
- When new issues are added to an existing milestone and the changelog needs
|
||||||
to be refreshed
|
to be refreshed
|
||||||
- To audit or repair an existing version section
|
- To ensure every entry follows the correct format for the changelog
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
@ -25,37 +23,271 @@ memory; it does not repeat it.
|
|||||||
- `scripts/gh.py` for GitHub queries, `scripts/changelog.py` for changelog
|
- `scripts/gh.py` for GitHub queries, `scripts/changelog.py` for changelog
|
||||||
checks (run `python3 scripts/changelog.py <command> --help` for usage)
|
checks (run `python3 scripts/changelog.py <command> --help` for usage)
|
||||||
|
|
||||||
## What to Read
|
## Workflow
|
||||||
|
|
||||||
1. `mem:workflow/updating-changelog` — the canonical flow: sources of truth,
|
### 1. Determine the target version
|
||||||
layout, entry rules, the `## Breaking change note` comment contract, the
|
|
||||||
advisory (`:lock:`) contract, pre-flight checks, anomaly types, and pitfalls.
|
|
||||||
2. `mem:scripts/changelog` — `boom`, `security`, `check-merged`, `cross-ref`,
|
|
||||||
`dev-only-bugs`, `report`.
|
|
||||||
3. `mem:scripts/gh` — `issues`, `issue`, `comments`, `prs`, `advisories`.
|
|
||||||
|
|
||||||
## Commands
|
The version is typically a semver string like `2.15.3`. Confirm with the user
|
||||||
|
if not specified.
|
||||||
|
|
||||||
|
### 2. Fetch all issues in the milestone
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 scripts/gh.py issues "<VERSION>" --exclude "no changelog"
|
# All closed issues (default)
|
||||||
python3 scripts/gh.py issues "<VERSION>" --label "release blocker" --exclude "no changelog" # closed non-bug residue to review by hand
|
python3 scripts/gh.py issues "2.16.0"
|
||||||
python3 scripts/gh.py advisories --patched-version "<VERSION>"
|
|
||||||
python3 scripts/changelog.py dev-only-bugs "<VERSION>" # list bugs that never reached production
|
# Include open issues too
|
||||||
python3 scripts/changelog.py dev-only-bugs "<VERSION>" --apply # label the sure ones `no changelog`
|
python3 scripts/gh.py issues "2.16.0" --state all
|
||||||
python3 scripts/changelog.py check-merged <PR numbers...>
|
|
||||||
python3 scripts/changelog.py boom "<VERSION>" # print the :boom: section
|
# Exclude entries that should not go in the changelog
|
||||||
python3 scripts/changelog.py boom "<VERSION>" --write # replace it in CHANGES.md
|
python3 scripts/gh.py issues "2.16.0" --exclude "release blocker,no changelog"
|
||||||
python3 scripts/changelog.py security "<VERSION>" # print the :lock: section
|
|
||||||
python3 scripts/changelog.py security "<VERSION>" --write # replace it in CHANGES.md
|
|
||||||
python3 scripts/changelog.py cross-ref "<VERSION>"
|
|
||||||
python3 scripts/changelog.py report "<VERSION>"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Hard Rules
|
**Exclusion rules (issue-level):**
|
||||||
|
- `no changelog` label — chore/refactor work, no entry needed
|
||||||
|
- `release blocker` label — blocked issues not yet ready for changelog
|
||||||
|
- `Task` issue type — internal chores, not user-facing; excluded by `gh.py`
|
||||||
|
(use `--include-tasks` to override)
|
||||||
|
- **Rejected project status** — issues with "Rejected" status on the "Main"
|
||||||
|
project board are excluded by `gh.py` (use `--include-rejected` to override).
|
||||||
|
This status is independent of the GitHub issue `state`.
|
||||||
|
|
||||||
- `CHANGES.md` is edited only on explicit request or during the release process.
|
**Exclusion rules (PR-level):** PRs with these labels stay out regardless of
|
||||||
- Only closed, non-excluded milestone issues are included; the issue is the changelog unit and the PR is inline.
|
their linked issue's labels: `release blocker`, `no issue required`.
|
||||||
- `:boom:` and `:rocket:` are label-generated and `:lock:` is advisory-generated: never hand-edit them; edit the label, the `## Breaking change note` comment or the advisory and re-run the command.
|
|
||||||
- Verify PR merge status before writing; only merged PRs are referenced.
|
Each entry carries `number`, `title`, `state`, `issue_type`, `labels`,
|
||||||
- Bugs that never reached production stay out: `dev-only-bugs --apply` labels the sure ones; candidates are the user's call, never label them yourself.
|
`closing_prs`, and `project_status`.
|
||||||
- Fill `patched_versions` in the advisories before running `security`; unpublished advisories are valid.
|
|
||||||
|
### 3. Identify missing entries (optional)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 scripts/gh.py issues "2.16.0" --exclude "release blocker,no changelog" --compare CHANGES.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns only milestone issues not yet referenced in the changelog. Note: it
|
||||||
|
compares **issues** only. For unreferenced merged **PRs**, use the
|
||||||
|
cross-reference in step 8.
|
||||||
|
|
||||||
|
### 4. Fetch additional PR details when needed
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# One or more PR numbers (also: --file prs.txt, or --stdin)
|
||||||
|
python3 scripts/gh.py prs 9179 9204 9311
|
||||||
|
|
||||||
|
# All merged PRs in a milestone (default); --state all/open/closed for others
|
||||||
|
python3 scripts/gh.py prs --milestone "2.16.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns `number`, `title`, `body`, `state`, `merged_at`, `author`, `labels`,
|
||||||
|
and `closing_issues`. Milestone mode uses paginated GraphQL (100 per page).
|
||||||
|
|
||||||
|
### 5. Categorize entries — strictly by issue type, never by labels or emoji
|
||||||
|
|
||||||
|
Use the **Issue Type** field (`issue_type` in the `gh.py` output). No separate
|
||||||
|
query is needed.
|
||||||
|
|
||||||
|
> **⚠️ CRITICAL: Never use labels or title emoji prefixes for categorization.**
|
||||||
|
> Labels like `bug`/`enhancement` and prefixes like `:bug:`/`:sparkles:` are
|
||||||
|
> often wrong or missing. `issue_type` is the single source of truth.
|
||||||
|
|
||||||
|
| `issue_type` value | Changelog section |
|
||||||
|
|--------------------|-------------------|
|
||||||
|
| `Bug` | `### :bug: Bugs fixed` |
|
||||||
|
| `Feature` or `Enhancement` | `### :sparkles: New features & Enhancements` |
|
||||||
|
| `Task` | **Exclude** — internal chores, not user-facing |
|
||||||
|
| `null` (not set) | Fallback to labels: `bug` label → bugs, otherwise enhancements |
|
||||||
|
|
||||||
|
**Breaking changes override everything:** an issue with the `breaking change`
|
||||||
|
label goes under `### :boom: Breaking changes & Deprecations`, no matter its
|
||||||
|
issue type. This is the only label-based rule — it is an explicit exception
|
||||||
|
to the "never by labels" principle above. The `:boom:` subsection goes first
|
||||||
|
in the version, before `:rocket:` (matching the existing precedent).
|
||||||
|
|
||||||
|
**Preserve highlighted entries:** if an entry already sits under
|
||||||
|
`### :rocket: Epics and highlights`, keep it there when refreshing. Do not
|
||||||
|
move it down just because its type would place it under `:sparkles:`.
|
||||||
|
|
||||||
|
**Community attribution:** if the issue or its fix PR has the
|
||||||
|
`community contribution` label, add `(by @<github_username>)` on the entry
|
||||||
|
line, **before** the issue/PR references. Use the **PR author** (the `author`
|
||||||
|
field from step 4), not the issue author:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
- Fix description of the bug (by @username) [#<ISSUE>](...) (PR: [#<PR>](...))
|
||||||
|
```
|
||||||
|
|
||||||
|
**Only closed issues are included**, even if open ones are tracked in the
|
||||||
|
milestone.
|
||||||
|
|
||||||
|
**Pairing rules:**
|
||||||
|
|
||||||
|
| Pattern | Changelog format |
|
||||||
|
|---------|-----------------|
|
||||||
|
| Closed issue + one or more fix PRs | Primary link = issue, PRs inline comma-separated |
|
||||||
|
| PR with no linked issue | Link the issue if a matching closed one exists in the milestone; otherwise skip (the issue is the changelog unit) |
|
||||||
|
| Closed issue with no fix PR in milestone | Link the issue directly, no PR reference |
|
||||||
|
|
||||||
|
> **False-positive associations:** a PR may wrongly claim to close an issue
|
||||||
|
> from another context (ancient PR, cross-project reference). If titles are
|
||||||
|
> clearly unrelated or the PR predates the issue by years, treat it as a data
|
||||||
|
> glitch and skip it.
|
||||||
|
|
||||||
|
### 5a. Verify PR merge status before writing
|
||||||
|
|
||||||
|
A closed issue may list closing PRs that were **closed without merging**
|
||||||
|
(e.g. a superseded community PR). Only **merged** PRs go in the changelog:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 scripts/changelog.py check-merged <ALL_PR_NUMBERS>
|
||||||
|
# also accepts: --file prs.txt, or numbers via --stdin
|
||||||
|
```
|
||||||
|
|
||||||
|
If a closing PR is closed-unmerged, find the merged PR that superseded it
|
||||||
|
(other PRs in the issue's closing list, similar titles, or pointers in the
|
||||||
|
closed PR's timeline) and reference that one instead.
|
||||||
|
|
||||||
|
### 5b. Security advisory (GHSA) entries
|
||||||
|
|
||||||
|
Advisories fixed in a release go in the changelog even though they are
|
||||||
|
**neither milestone issues nor PRs**. The GHSA ID and description come from
|
||||||
|
the user or the release notes — never from the milestone fetch.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
- Fix <user-facing description> (https://github.com/penpot/penpot/security/advisories/GHSA-XXXX-XXXX-XXXX)
|
||||||
|
```
|
||||||
|
|
||||||
|
Rules: place under `### :bug: Bugs fixed` with **no issue or PR link**; do
|
||||||
|
**not** fetch or verify the URL (it may be draft/unpublished and 404); write
|
||||||
|
the description in imperative mood from the advisory title. These entries are
|
||||||
|
invisible to the automation — add them by hand, and in step 9 apply only the
|
||||||
|
backport/duplicate check to them.
|
||||||
|
|
||||||
|
### 6. Read the current CHANGES.md and run pre-flight checks
|
||||||
|
|
||||||
|
Newest version goes at the top, right after the `# CHANGELOG` header:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## <VERSION>
|
||||||
|
|
||||||
|
### :boom: Breaking changes & Deprecations
|
||||||
|
|
||||||
|
- <breaking change or deprecation> [#<ISSUE>](https://github.com/penpot/penpot/issues/<ISSUE>) (PR: [#<PR>](https://github.com/penpot/penpot/pull/<PR>))
|
||||||
|
|
||||||
|
### :bug: Bugs fixed
|
||||||
|
|
||||||
|
- Fix description of the bug [#<ISSUE>](https://github.com/penpot/penpot/issues/<ISSUE>) (PR: [#<PR>](https://github.com/penpot/penpot/pull/<PR>))
|
||||||
|
- Fix another bug (by @contributor) [#<ISSUE>](https://github.com/penpot/penpot/issues/<ISSUE>) (PR: [#<PR>](https://github.com/penpot/penpot/pull/<PR>))
|
||||||
|
|
||||||
|
### :sparkles: New features & Enhancements
|
||||||
|
|
||||||
|
- Add new feature description [#<ISSUE>](https://github.com/penpot/penpot/issues/<ISSUE>) (PR: [#<PR>](https://github.com/penpot/penpot/pull/<PR>))
|
||||||
|
```
|
||||||
|
|
||||||
|
Format details: entries start with `- ` plus a short imperative description;
|
||||||
|
PR refs stay inline (`(PR: [#<N>](<url>))`, comma-separated for several);
|
||||||
|
`(by @<username>)` goes before the issue link; only include non-empty
|
||||||
|
sections; blank line between a section's last entry and the next title; never
|
||||||
|
duplicate an entry from an earlier version section (the earlier version wins
|
||||||
|
for backports).
|
||||||
|
|
||||||
|
**Pre-flight checks — fix violations directly in `CHANGES.md` before writing
|
||||||
|
the new section.** Reconcile every existing entry (any version section) and
|
||||||
|
every milestone candidate against the current milestone state (re-fetch, do
|
||||||
|
not trust cached data):
|
||||||
|
|
||||||
|
1. **Duplicate across versions** → remove from the current section.
|
||||||
|
2. **Stale milestone assignment** (issue moved out of this milestone) →
|
||||||
|
remove the entry (or drop it if the section does not exist yet).
|
||||||
|
3. **Newly applied exclusion labels** (`no changelog`, `release blocker`) →
|
||||||
|
remove the entry.
|
||||||
|
4. **Issue no longer closed/deleted/Rejected** → remove the entry.
|
||||||
|
5. **Unmerged or moved PR reference** → fix the reference or remove the
|
||||||
|
entry (a PR merged in a *different* milestone is a step-9 anomaly, do not
|
||||||
|
silently remove it).
|
||||||
|
6. **Issue type changed to `Task`** → remove the entry.
|
||||||
|
7. **Breaking change misplaced** (issue has the `breaking change` label but
|
||||||
|
sits in another section) → move the entry to `:boom:`.
|
||||||
|
8. **Missing valid issues** (closed, non-excluded, unreferenced anywhere) →
|
||||||
|
add them to the current section per step 5.
|
||||||
|
|
||||||
|
### 7. Build the description text
|
||||||
|
|
||||||
|
Derive it from the **issue title**, not the PR title. Strip leading emoji
|
||||||
|
prefixes (`:bug:`, `:sparkles:`, `:tada:`) and describe the user-facing
|
||||||
|
behavior:
|
||||||
|
|
||||||
|
| Issue title | Changelog description |
|
||||||
|
|-------------|----------------------|
|
||||||
|
| `Plugin API token methods fail with schema validation error on PRO` | `Fix Plugin API token methods failing with schema validation error on PRO` |
|
||||||
|
| `Comment content is not sanitized before rendering, enabling stored XSS` | `Sanitize comment content on rendering` |
|
||||||
|
| `Custom uploaded font family names are not sanitized` | `Sanitize font family names on custom uploaded fonts` |
|
||||||
|
|
||||||
|
Insert the new version section right after the `# CHANGELOG` header with the
|
||||||
|
`edit` tool and enough context for a unique match.
|
||||||
|
|
||||||
|
### 7b. Propose and populate `:rocket: Epics and highlights`
|
||||||
|
|
||||||
|
Create the subsection if missing (place it before `### :sparkles:`) and pick
|
||||||
|
2–5 of the most impactful/user-visible `:sparkles:` entries: new visible
|
||||||
|
features, big capabilities, items that make self-hosted users want to update.
|
||||||
|
`frontend/src/app/main/ui/releases/v2_<MINOR>.cljs` slide titles are optional
|
||||||
|
hints (they may not exist for every version). Every `:rocket:` entry MUST
|
||||||
|
carry issue AND PR references; never remove entries from a prior run.
|
||||||
|
|
||||||
|
### 8. Cross-reference milestone PRs against the changelog
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 scripts/changelog.py cross-ref "<MILESTONE>" [--changes CHANGES.md]
|
||||||
|
```
|
||||||
|
|
||||||
|
Lists merged milestone PRs missing from the changelog section (decide per PR:
|
||||||
|
add it or confirm its exclusion labels) and warns about CLOSED (unmerged) PRs
|
||||||
|
in the milestone. GHSA entries never appear here — that absence is expected.
|
||||||
|
|
||||||
|
### 9. Generate the anomaly report
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 scripts/changelog.py report "<MILESTONE>" [--changes CHANGES.md --output CHANGES-ISSUES.md]
|
||||||
|
```
|
||||||
|
|
||||||
|
Overwrites `CHANGES-ISSUES.md` with the current state. Every number renders as
|
||||||
|
a full `[#N](https://github.com/penpot/penpot/issues/N)` or
|
||||||
|
`[#N](https://github.com/penpot/penpot/pull/N)` link.
|
||||||
|
|
||||||
|
**An anomaly is a milestone mismatch or a `:boom:` mislabel** (the changelog
|
||||||
|
pairing is misleading and a human must judge intent):
|
||||||
|
|
||||||
|
1. Issue in this milestone, referenced PR in another milestone (or none).
|
||||||
|
2. PR in this milestone, closed issue in another milestone — except an issue
|
||||||
|
with *no* milestone, which belongs to another (probably private) project
|
||||||
|
and is neither anomaly nor changelog candidate.
|
||||||
|
3. `:boom:` entry whose issue lacks the `breaking change` label. These stay
|
||||||
|
listed in the report **and** in the changelog: either label the issue or
|
||||||
|
move the entry to its regular section.
|
||||||
|
|
||||||
|
**Highlight gaps are warnings, not anomalies:** missing `:rocket:` on a
|
||||||
|
released X.Y.0 (patches never carry highlights); `:rocket:` entry without
|
||||||
|
issue AND PR references. Gaps never count toward the anomaly total.
|
||||||
|
|
||||||
|
**Anything else is a rule violation**, not a report item: fix it in step 6
|
||||||
|
pre-flight. If one shows up in the report, re-run the workflow.
|
||||||
|
|
||||||
|
## Key Principles
|
||||||
|
|
||||||
|
- **Issue = changelog unit**, PR = implementation detail inline.
|
||||||
|
- **Latest version first**, below the `# CHANGELOG` header.
|
||||||
|
- **Issue Type decides the section — exclusively**, except `breaking change`
|
||||||
|
label → `:boom:` first.
|
||||||
|
- **User-facing descriptions** in imperative mood.
|
||||||
|
- **Community attribution** uses the PR author, placed before the issue link.
|
||||||
|
- **Only closed issues**; **Rejected** project status excludes.
|
||||||
|
- **`no changelog` and `Task`** stay out.
|
||||||
|
- **Multiple fix PRs** go comma-separated inline.
|
||||||
|
- **Duplicates**: the earlier version section wins.
|
||||||
|
- **Taiga references**: resolve to the GitHub issue via description text or
|
||||||
|
PRs mentioning the Taiga URL, then link issue + PR.
|
||||||
|
- **GHSA entries** live under `:bug:` with only the advisory URL (see 5b).
|
||||||
|
- **Re-fetch before editing**; prefer `scripts/gh.py` over raw `gh api`.
|
||||||
|
- **Verify PR merge status** (`check-merged`); PR-level exclusions apply.
|
||||||
|
- **Cross-reference PRs, not just issues** (`cross-ref`); watch for
|
||||||
|
false-positive PR-to-issue links.
|
||||||
|
|||||||
@ -9,8 +9,7 @@
|
|||||||
app.common.data.macros/get-in clojure.core/get-in
|
app.common.data.macros/get-in clojure.core/get-in
|
||||||
app.common.data.macros/with-open clojure.core/with-open
|
app.common.data.macros/with-open clojure.core/with-open
|
||||||
app.common.data.macros/select-keys clojure.core/select-keys
|
app.common.data.macros/select-keys clojure.core/select-keys
|
||||||
app.common.logging/with-context clojure.core/do
|
app.common.logging/with-context clojure.core/do}
|
||||||
benches.render-wasm.errors/attempt clojure.core/do}
|
|
||||||
|
|
||||||
:hooks
|
:hooks
|
||||||
{:analyze-call
|
{:analyze-call
|
||||||
@ -23,13 +22,7 @@
|
|||||||
rumext.v2/defc hooks.export/rumext-defc
|
rumext.v2/defc hooks.export/rumext-defc
|
||||||
rumext.v2/lazy-component hooks.export/rumext-lazycomponent
|
rumext.v2/lazy-component hooks.export/rumext-lazycomponent
|
||||||
shadow.lazy/loadable hooks.export/rumext-lazycomponent
|
shadow.lazy/loadable hooks.export/rumext-lazycomponent
|
||||||
app.util.i18n/tr hooks.i18n/tr-dynamic
|
}}
|
||||||
app.common.i18n/tr hooks.i18n/tr-dynamic
|
|
||||||
benches.render-wasm.declarations/defscene hooks.benches/defscene
|
|
||||||
benches.render-wasm.declarations/defcase hooks.benches/defcase
|
|
||||||
benches.render-wasm.runtime.commands/defcommand hooks.benches/defcommand
|
|
||||||
benches.render-wasm.runtime.protocol/resolve-or-reject hooks.benches/resolve-or-reject
|
|
||||||
benches.render-wasm.runtime.protocol/resolve-or-reject-with hooks.benches/resolve-or-reject-with}}
|
|
||||||
|
|
||||||
:output
|
:output
|
||||||
{:exclude-files
|
{:exclude-files
|
||||||
@ -41,7 +34,7 @@
|
|||||||
"^(?:backend|frontend|exporter|common)/deps.edn"
|
"^(?:backend|frontend|exporter|common)/deps.edn"
|
||||||
"^(?:backend|frontend|exporter|common)/scripts/"
|
"^(?:backend|frontend|exporter|common)/scripts/"
|
||||||
"^(?:backend|frontend|exporter|common)/dev/"
|
"^(?:backend|frontend|exporter|common)/dev/"
|
||||||
"^(?:backend|frontend|exporter|common)/test/(?!performance_tests/)"]
|
"^(?:backend|frontend|exporter|common)/test/"]
|
||||||
|
|
||||||
:linter-name true}
|
:linter-name true}
|
||||||
|
|
||||||
@ -52,9 +45,6 @@
|
|||||||
:potok/reify-type
|
:potok/reify-type
|
||||||
{:level :error}
|
{:level :error}
|
||||||
|
|
||||||
:penpot/tr-dynamic
|
|
||||||
{:level :warning}
|
|
||||||
|
|
||||||
:redundant-primitive-coercion
|
:redundant-primitive-coercion
|
||||||
{:level :off}
|
{:level :off}
|
||||||
|
|
||||||
@ -106,4 +96,6 @@
|
|||||||
|
|
||||||
:unused-binding
|
:unused-binding
|
||||||
{:exclude-destructured-as true
|
{:exclude-destructured-as true
|
||||||
:exclude-destructured-keys-in-fn-args false}}}
|
:exclude-destructured-keys-in-fn-args false
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
|||||||
@ -1,77 +0,0 @@
|
|||||||
;; This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
;; License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
||||||
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
;;
|
|
||||||
;; Copyright (c) KALEIDOS SUBSIDIARY SL
|
|
||||||
|
|
||||||
(ns hooks.benches
|
|
||||||
(:require [clj-kondo.hooks-api :as api]))
|
|
||||||
|
|
||||||
(defn defscene
|
|
||||||
"Analyzes scene options and its compiled builder body."
|
|
||||||
[{:keys [node]}]
|
|
||||||
(let [[_ _ opts argv & body] (:children node)]
|
|
||||||
(if (and argv (api/vector-node? argv))
|
|
||||||
{:node (api/list-node [(api/token-node (quote do)) opts
|
|
||||||
(api/list-node (into [(api/token-node (quote fn)) argv] body))])}
|
|
||||||
{:node node})))
|
|
||||||
|
|
||||||
(defn defcase
|
|
||||||
"Analyzes case options and its compiled operation body."
|
|
||||||
[{:keys [node]}]
|
|
||||||
(let [[_ _ opts argv & body] (:children node)]
|
|
||||||
(if (and (seq body) argv (api/vector-node? argv))
|
|
||||||
{:node (api/list-node [(api/token-node (quote do)) opts
|
|
||||||
(api/list-node (into [(api/token-node (quote fn)) argv] body))])}
|
|
||||||
{:node node})))
|
|
||||||
|
|
||||||
(defn defcommand
|
|
||||||
"Analyzes command options and both generated functions."
|
|
||||||
[{:keys [node]}]
|
|
||||||
(let [[_ command & forms] (:children node)
|
|
||||||
[doc forms] (if (string? (api/sexpr (first forms)))
|
|
||||||
[(first forms) (next forms)]
|
|
||||||
[nil forms])
|
|
||||||
[options forms] (if (api/map-node? (first forms))
|
|
||||||
[(first forms) (next forms)]
|
|
||||||
[nil forms])
|
|
||||||
[argv & body] forms
|
|
||||||
[conditions body] (if (and (api/map-node? (first body)) (next body))
|
|
||||||
[(first body) (next body)]
|
|
||||||
[nil body])
|
|
||||||
handlers (:async (some-> options api/sexpr))
|
|
||||||
core (api/list-node
|
|
||||||
(into [(api/token-node 'fn)
|
|
||||||
(api/vector-node (mapv api/token-node handlers))]
|
|
||||||
body))
|
|
||||||
starred (api/token-node (symbol (str (api/sexpr command) "*")))
|
|
||||||
measured (get (some-> options api/sexpr) :measured-variant true)
|
|
||||||
definition (api/list-node
|
|
||||||
(into [(api/token-node 'defn) command]
|
|
||||||
(concat (when doc [doc]) [argv]
|
|
||||||
(when conditions [conditions]) [core])))]
|
|
||||||
{:node (api/list-node
|
|
||||||
(into [(api/token-node 'do)]
|
|
||||||
(concat (when options [(api/coerce (dissoc (api/sexpr options) :async))])
|
|
||||||
[definition]
|
|
||||||
(when measured
|
|
||||||
[(api/list-node [(api/token-node 'def)
|
|
||||||
starred command])]))))}))
|
|
||||||
|
|
||||||
(defn resolve-or-reject
|
|
||||||
"Analyzes the body of a Promise-returning form."
|
|
||||||
[{:keys [node]}]
|
|
||||||
(let [[_ & body] (:children node)]
|
|
||||||
{:node (api/list-node (into [(api/token-node (quote do))] body))}))
|
|
||||||
|
|
||||||
(defn resolve-or-reject-with
|
|
||||||
"Analyzes the cause handler and body. Binds `cause` in the handler only."
|
|
||||||
[{:keys [node]}]
|
|
||||||
(let [[_ cause on-error & body] (:children node)]
|
|
||||||
{:node (api/list-node
|
|
||||||
(into [(api/token-node (quote do))
|
|
||||||
(api/list-node
|
|
||||||
[(api/token-node (quote let))
|
|
||||||
(api/vector-node [cause (api/token-node nil)])
|
|
||||||
on-error])]
|
|
||||||
body))}))
|
|
||||||
@ -1,9 +1,3 @@
|
|||||||
;; This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
;; License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
||||||
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
;;
|
|
||||||
;; Copyright (c) KALEIDOS SUBSIDIARY SL
|
|
||||||
|
|
||||||
(ns hooks.export
|
(ns hooks.export
|
||||||
(:require [clj-kondo.hooks-api :as api]))
|
(:require [clj-kondo.hooks-api :as api]))
|
||||||
|
|
||||||
|
|||||||
@ -1,17 +0,0 @@
|
|||||||
(ns hooks.i18n
|
|
||||||
(:require [clj-kondo.hooks-api :as api]))
|
|
||||||
|
|
||||||
(defn tr-dynamic
|
|
||||||
[{:keys [:node]}]
|
|
||||||
(let [[_ code & _] (:children node)]
|
|
||||||
(when (and (some? code)
|
|
||||||
(not (api/string-node? code)))
|
|
||||||
(let [{:keys [:row :col :end-row :end-col]} (meta code)]
|
|
||||||
(api/reg-finding! {:message "dynamic key in (tr ...) is invisible to rehash; use a string literal or declare it with ;; (tr \"key\")"
|
|
||||||
:type :penpot/tr-dynamic
|
|
||||||
:row row
|
|
||||||
:col col
|
|
||||||
;; end positions are required for #_:clj-kondo/ignore to match
|
|
||||||
:end-row end-row
|
|
||||||
:end-col end-col}))))
|
|
||||||
{:node node})
|
|
||||||
@ -10,7 +10,5 @@
|
|||||||
:extra-indents {rumext.v2/fnc [[:inner 0]]
|
:extra-indents {rumext.v2/fnc [[:inner 0]]
|
||||||
cljs.test/async [[:inner 0]]
|
cljs.test/async [[:inner 0]]
|
||||||
promesa.exec/thread [[:inner 0]]
|
promesa.exec/thread [[:inner 0]]
|
||||||
specify! [[:inner 0] [:inner 1]]
|
specify! [[:inner 0] [:inner 1]]}
|
||||||
benches.render-wasm.runtime.commands/defcommand [[:inner 0]]
|
|
||||||
benches.render-wasm.runtime.protocol/resolve-or-reject-with [[:inner 0]]}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -85,10 +85,6 @@ target instance is running and its MCP config has been generated:
|
|||||||
# 'main', 'ws1' and similar spellings are rejected.
|
# 'main', 'ws1' and similar spellings are rejected.
|
||||||
./manage.sh start-coding-agent claude --ws 1
|
./manage.sh start-coding-agent claude --ws 1
|
||||||
./manage.sh start-coding-agent opencode --ws 2
|
./manage.sh start-coding-agent opencode --ws 2
|
||||||
|
|
||||||
# Run a different executable (e.g. a wrapper script) with the same MCP
|
|
||||||
# wiring. --ws and --bin may come in any order.
|
|
||||||
./manage.sh start-coding-agent claude --bin claude-alt
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Equivalents by hand (run from inside the workspace directory):
|
Equivalents by hand (run from inside the workspace directory):
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
description: An unexpected problem or behavior
|
description: Create a report to help us improve
|
||||||
labels: ["needs triage"]
|
name: Bug report
|
||||||
name: Bug
|
|
||||||
type: Bug
|
type: Bug
|
||||||
|
labels: ["needs triage"]
|
||||||
|
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
@ -15,7 +15,7 @@ body:
|
|||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps To Reproduce
|
label: Steps To Reproduce
|
||||||
description: Steps to reproduce the behavior
|
description: Steps to reproduce the behavior.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
1. Go to '...'
|
1. Go to '...'
|
||||||
@ -26,22 +26,22 @@ body:
|
|||||||
- type: textarea
|
- type: textarea
|
||||||
id: expected
|
id: expected
|
||||||
attributes:
|
attributes:
|
||||||
|
description: A clear and concise description of what you expected to happen.
|
||||||
label: Expected behavior
|
label: Expected behavior
|
||||||
description: A clear and concise description of what you expected to happen
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: actual
|
id: actual
|
||||||
attributes:
|
attributes:
|
||||||
|
description: A clear and concise description of what happens instead; what the bug is.
|
||||||
label: Actual behavior
|
label: Actual behavior
|
||||||
description: A clear and concise description of what happens instead; what the bug is
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: screenshots
|
id: screenshots
|
||||||
attributes:
|
attributes:
|
||||||
|
description: If applicable, add screenshots to help explain your problem.
|
||||||
label: Screenshots or video
|
label: Screenshots or video
|
||||||
description: If applicable, add screenshots to help explain your problem
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: desktop
|
id: desktop
|
||||||
attributes:
|
attributes:
|
||||||
@ -87,4 +87,4 @@ body:
|
|||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional context
|
label: Additional context
|
||||||
description: Add any other context or screenshots about the bug here
|
description: Any other context about the problem.
|
||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1 +1 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: true
|
||||||
|
|||||||
38
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
38
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
@ -1,38 +0,0 @@
|
|||||||
description: Improvement to existing behavior
|
|
||||||
labels: ["needs triage"]
|
|
||||||
name: "Enhancement"
|
|
||||||
type: Enhancement
|
|
||||||
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
## Before you start
|
|
||||||
|
|
||||||
Please search our [existing issues](https://github.com/penpot/penpot/issues) and open [pull requests](https://github.com/penpot/penpot/pulls) to lessen the change of filing duplicate issues or feature requests. Thank you.
|
|
||||||
|
|
||||||
---
|
|
||||||
- type: textarea
|
|
||||||
id: problem
|
|
||||||
attributes:
|
|
||||||
label: Is your feature request related to a problem? Please describe
|
|
||||||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when (...)
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: solution
|
|
||||||
attributes:
|
|
||||||
label: Describe the solution you'd like
|
|
||||||
description: A clear and concise description of what you want to happen
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternatives
|
|
||||||
attributes:
|
|
||||||
label: Describe alternatives you've considered
|
|
||||||
description: A clear and concise description of any alternative solutions or features you've considered
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context or screenshots about the enhancement here
|
|
||||||
26
.github/ISSUE_TEMPLATE/epic.yml
vendored
26
.github/ISSUE_TEMPLATE/epic.yml
vendored
@ -1,26 +0,0 @@
|
|||||||
description: An epic is a large user story that cannot be delivered as defined within a single iteration
|
|
||||||
labels: ["needs triage"]
|
|
||||||
name: "EPIC"
|
|
||||||
type: EPIC
|
|
||||||
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
## Before you start
|
|
||||||
|
|
||||||
Please search our [existing issues](https://github.com/penpot/penpot/issues) and open [pull requests](https://github.com/penpot/penpot/pulls) to lessen the change of filing duplicate issues or feature requests. Thank you.
|
|
||||||
|
|
||||||
---
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Epic description
|
|
||||||
description: Tell us which epic feature do you want to discuss
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context or screenshots about the feature request here
|
|
||||||
@ -1,7 +1,7 @@
|
|||||||
description: Suggest an idea for this project
|
description: Suggest an idea for this project.
|
||||||
labels: ["needs triage"]
|
labels: ["needs triage"]
|
||||||
name: "Feature request"
|
name: "Feature request"
|
||||||
type: Feature
|
type: Enhancement
|
||||||
|
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
@ -15,24 +15,24 @@ body:
|
|||||||
- type: textarea
|
- type: textarea
|
||||||
id: problem
|
id: problem
|
||||||
attributes:
|
attributes:
|
||||||
label: Is your feature request related to a problem? Please describe
|
|
||||||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when (...)
|
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when (...)
|
||||||
|
label: Is your feature request related to a problem? Please describe.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: solution
|
id: solution
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe the solution you'd like
|
description: A clear and concise description of what you want to happen.
|
||||||
description: A clear and concise description of what you want to happen
|
label: Describe the solution you'd like.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: alternatives
|
id: alternatives
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe alternatives you've considered
|
label: Describe alternatives you've considered.
|
||||||
description: A clear and concise description of any alternative solutions or features you've considered
|
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional context
|
label: Additional context
|
||||||
description: Add any other context or screenshots about the feature request here
|
description: Add any other context or screenshots about the feature request here.
|
||||||
26
.github/ISSUE_TEMPLATE/task.yml
vendored
26
.github/ISSUE_TEMPLATE/task.yml
vendored
@ -1,26 +0,0 @@
|
|||||||
description: A specific piece of work
|
|
||||||
labels: []
|
|
||||||
name: "Task"
|
|
||||||
type: Task
|
|
||||||
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
## Before you start
|
|
||||||
|
|
||||||
Please search our [existing issues](https://github.com/penpot/penpot/issues) and open [pull requests](https://github.com/penpot/penpot/pulls) to lessen the change of filing duplicate issues or feature requests. Thank you.
|
|
||||||
|
|
||||||
---
|
|
||||||
- type: textarea
|
|
||||||
id: task
|
|
||||||
attributes:
|
|
||||||
description: A clear and concise description of the task
|
|
||||||
label: Please describe
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context or screenshots about the task here
|
|
||||||
160
.github/workflows/auto-label.yml
vendored
160
.github/workflows/auto-label.yml
vendored
@ -5,7 +5,7 @@ name: Auto Label and Add to Project
|
|||||||
# code, it only reads ids from the event payload.
|
# code, it only reads ids from the event payload.
|
||||||
on:
|
on:
|
||||||
issues:
|
issues:
|
||||||
types: [opened, closed]
|
types: [opened]
|
||||||
pull_request_target:
|
pull_request_target:
|
||||||
types: [opened]
|
types: [opened]
|
||||||
|
|
||||||
@ -43,9 +43,6 @@ jobs:
|
|||||||
// === 1. CONFIGURATION ===
|
// === 1. CONFIGURATION ===
|
||||||
const PROJECT_NUMBER = 8; // <--- Replace with your project board number
|
const PROJECT_NUMBER = 8; // <--- Replace with your project board number
|
||||||
const IS_ORG = true; // <--- Set to false if this is a personal project, true if an organization
|
const IS_ORG = true; // <--- Set to false if this is a personal project, true if an organization
|
||||||
const STATUS_FIELD_ID = 'PVTSSF_lADOAcyBPM4BV2pqzhRPY48';
|
|
||||||
const STATUS_BACKLOG = 'f75ad846';
|
|
||||||
const STATUS_TECH_REVIEW = 'b0f45db9';
|
|
||||||
const OWNER = context.repo.owner;
|
const OWNER = context.repo.owner;
|
||||||
const REPO = context.repo.repo;
|
const REPO = context.repo.repo;
|
||||||
|
|
||||||
@ -53,100 +50,6 @@ jobs:
|
|||||||
const isPR = !!context.payload.pull_request;
|
const isPR = !!context.payload.pull_request;
|
||||||
const contentId = isPR ? context.payload.pull_request.node_id : context.payload.issue.node_id;
|
const contentId = isPR ? context.payload.pull_request.node_id : context.payload.issue.node_id;
|
||||||
|
|
||||||
// A completed issue is already closed by GitHub. Route its Main
|
|
||||||
// project status according to whether QA needs to verify it.
|
|
||||||
if (context.eventName === 'issues' && context.payload.action === 'closed') {
|
|
||||||
const issue = context.payload.issue;
|
|
||||||
if (issue.state_reason !== 'completed') {
|
|
||||||
console.log(`Issue #${issue.number} was closed as ${issue.state_reason}; leaving project status unchanged.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const targetStatus = issue.labels.some(({ name }) => name === 'team-qa')
|
|
||||||
? 'Ready for QA'
|
|
||||||
: 'Product Review';
|
|
||||||
|
|
||||||
const projectQuery = `
|
|
||||||
query($owner: String!, $number: Int!) {
|
|
||||||
organization(login: $owner) {
|
|
||||||
projectV2(number: $number) {
|
|
||||||
id
|
|
||||||
fields(first: 100) {
|
|
||||||
nodes {
|
|
||||||
... on ProjectV2SingleSelectField {
|
|
||||||
id
|
|
||||||
name
|
|
||||||
options { id name }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
`;
|
|
||||||
const projectRes = await github.graphql(projectQuery, {
|
|
||||||
owner: OWNER,
|
|
||||||
number: PROJECT_NUMBER
|
|
||||||
});
|
|
||||||
const project = projectRes.organization.projectV2;
|
|
||||||
if (!project) {
|
|
||||||
throw new Error(`Could not find Main project #${PROJECT_NUMBER}.`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const statusField = project.fields.nodes.find(({ name }) => name === 'Status');
|
|
||||||
const statusOption = statusField?.options.find(({ name }) => name === targetStatus);
|
|
||||||
if (!statusField || !statusOption) {
|
|
||||||
throw new Error(`Could not find Status option "${targetStatus}" in Main.`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const issueProjectItemsQuery = `
|
|
||||||
query($issueId: ID!) {
|
|
||||||
node(id: $issueId) {
|
|
||||||
... on Issue {
|
|
||||||
projectItems(first: 100) {
|
|
||||||
nodes {
|
|
||||||
id
|
|
||||||
project { id }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
`;
|
|
||||||
const issueProjectItemsRes = await github.graphql(issueProjectItemsQuery, {
|
|
||||||
issueId: contentId
|
|
||||||
});
|
|
||||||
const projectItems = issueProjectItemsRes.node?.projectItems?.nodes || [];
|
|
||||||
const projectItem = projectItems.find(
|
|
||||||
({ project: itemProject }) => itemProject.id === project.id
|
|
||||||
);
|
|
||||||
if (!projectItem) {
|
|
||||||
console.log(`Issue #${issue.number} is not in Main project #${PROJECT_NUMBER}; skipping status update.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const updateStatusMutation = `
|
|
||||||
mutation($projectId: ID!, $itemId: ID!, $fieldId: ID!, $optionId: String!) {
|
|
||||||
updateProjectV2ItemFieldValue(input: {
|
|
||||||
projectId: $projectId
|
|
||||||
itemId: $itemId
|
|
||||||
fieldId: $fieldId
|
|
||||||
value: { singleSelectOptionId: $optionId }
|
|
||||||
}) {
|
|
||||||
projectV2Item { id }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
`;
|
|
||||||
await github.graphql(updateStatusMutation, {
|
|
||||||
projectId: project.id,
|
|
||||||
itemId: projectItem.id,
|
|
||||||
fieldId: statusField.id,
|
|
||||||
optionId: statusOption.id
|
|
||||||
});
|
|
||||||
console.log(`Issue #${issue.number} closed; Main status set to "${targetStatus}".`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Define your labels here
|
// Define your labels here
|
||||||
const labelToApply = 'needs triage';
|
const labelToApply = 'needs triage';
|
||||||
|
|
||||||
@ -185,65 +88,6 @@ jobs:
|
|||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
let itemId;
|
await github.graphql(addToProjectMutation, { projectId, contentId });
|
||||||
try {
|
|
||||||
const addRes = await github.graphql(addToProjectMutation, { projectId, contentId });
|
|
||||||
itemId = addRes.addProjectV2ItemById.item.id;
|
|
||||||
} catch (error) {
|
|
||||||
const messages = [
|
|
||||||
error && error.message,
|
|
||||||
...(Array.isArray(error && error.errors)
|
|
||||||
? error.errors.map(e => e && e.message)
|
|
||||||
: [])
|
|
||||||
].filter(Boolean).join('\n');
|
|
||||||
if (!messages.includes('Content already exists in this project')) {
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
console.log('Item already in project, fetching existing item...');
|
|
||||||
const existing = await github.graphql(
|
|
||||||
`query($contentId: ID!) {
|
|
||||||
node(id: $contentId) {
|
|
||||||
... on Issue {
|
|
||||||
projectItems(first: 50) {
|
|
||||||
nodes { id project { id } }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
... on PullRequest {
|
|
||||||
projectItems(first: 50) {
|
|
||||||
nodes { id project { id } }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}`,
|
|
||||||
{ contentId }
|
|
||||||
);
|
|
||||||
const nodes = (existing.node && existing.node.projectItems && existing.node.projectItems.nodes) || [];
|
|
||||||
const match = nodes.find(n => n.project.id === projectId);
|
|
||||||
if (!match) {
|
|
||||||
throw new Error(`Item already in a project, but not found in project ${projectId}`);
|
|
||||||
}
|
|
||||||
itemId = match.id;
|
|
||||||
}
|
|
||||||
|
|
||||||
// === 4. SET PROJECT STATUS ===
|
|
||||||
const statusOptionId = isPR ? STATUS_TECH_REVIEW : STATUS_BACKLOG;
|
|
||||||
const statusName = isPR ? 'Tech Review' : 'Backlog';
|
|
||||||
console.log(`Setting status to "${statusName}" for ${isPR ? 'PR' : 'Issue'} #${issueNumber}...`);
|
|
||||||
await github.graphql(
|
|
||||||
`mutation($projectId: ID!, $itemId: ID!, $fieldId: ID!, $optionId: String!) {
|
|
||||||
updateProjectV2ItemFieldValue(input: {
|
|
||||||
projectId: $projectId,
|
|
||||||
itemId: $itemId,
|
|
||||||
fieldId: $fieldId,
|
|
||||||
value: { singleSelectOptionId: $optionId }
|
|
||||||
}) {
|
|
||||||
projectV2Item {
|
|
||||||
id
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}`,
|
|
||||||
{ projectId, itemId, fieldId: STATUS_FIELD_ID, optionId: statusOptionId }
|
|
||||||
);
|
|
||||||
|
|
||||||
console.log("Automation successfully completed!");
|
console.log("Automation successfully completed!");
|
||||||
|
|
||||||
|
|||||||
36
.github/workflows/build-bundle.yml
vendored
36
.github/workflows/build-bundle.yml
vendored
@ -61,7 +61,6 @@ jobs:
|
|||||||
outputs:
|
outputs:
|
||||||
gh_ref: ${{ steps.vars.outputs.gh_ref }}
|
gh_ref: ${{ steps.vars.outputs.gh_ref }}
|
||||||
bundle_version: ${{ steps.vars.outputs.bundle_version }}
|
bundle_version: ${{ steps.vars.outputs.bundle_version }}
|
||||||
build_key: ${{ steps.vars.outputs.build_key }}
|
|
||||||
short_sha: ${{ steps.vars.outputs.short_sha }}
|
short_sha: ${{ steps.vars.outputs.short_sha }}
|
||||||
sha: ${{ steps.vars.outputs.sha }}
|
sha: ${{ steps.vars.outputs.sha }}
|
||||||
commit_title: ${{ steps.vars.outputs.commit_title }}
|
commit_title: ${{ steps.vars.outputs.commit_title }}
|
||||||
@ -80,26 +79,16 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
GH_REF: ${{ inputs.gh_ref || github.ref_name }}
|
GH_REF: ${{ inputs.gh_ref || github.ref_name }}
|
||||||
run: |
|
run: |
|
||||||
# Same command the build uses to stamp version.txt.
|
|
||||||
BUNDLE_VERSION=$(./manage.sh version)
|
|
||||||
SHORT_SHA=$(git rev-parse --short=12 HEAD)
|
|
||||||
# The key takes only the closest tag (--abbrev=0): the sha already
|
|
||||||
# pins the commit, and the full describe output is not stable
|
|
||||||
# across checkouts (its -g<sha> suffix length depends on the
|
|
||||||
# local object count). Must match build-docker.yml.
|
|
||||||
VERSION_TAG=$(git describe --tags --match '*.*.*' --abbrev=0)
|
|
||||||
echo "gh_ref=$GH_REF" >> $GITHUB_OUTPUT
|
echo "gh_ref=$GH_REF" >> $GITHUB_OUTPUT
|
||||||
echo "bundle_version=$BUNDLE_VERSION" >> $GITHUB_OUTPUT
|
echo "bundle_version=$(git describe --tags --always)" >> $GITHUB_OUTPUT
|
||||||
echo "build_key=sha-${SHORT_SHA}-${VERSION_TAG}" >> $GITHUB_OUTPUT
|
echo "short_sha=$(git rev-parse --short=12 HEAD)" >> $GITHUB_OUTPUT
|
||||||
echo "short_sha=$SHORT_SHA" >> $GITHUB_OUTPUT
|
|
||||||
echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
|
echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
|
||||||
echo "commit_title=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
echo "commit_title=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
# Keyed by commit sha AND version, same as build-docker.yml's marker
|
# Keyed by commit sha, same as build-docker.yml's marker check, so
|
||||||
# check, so both pipelines agree on what "already built" means. The
|
# both pipelines agree on what "already built" means: any ref that
|
||||||
# version is stamped into the bundle, so a new tag on an already
|
# points at an already-bundled commit skips the build, regardless of
|
||||||
# bundled commit (2.18.1-RC1 -> 2.18.1) must produce a new bundle.
|
# which ref built it first. `force` bypasses this check entirely.
|
||||||
# `force` bypasses this check entirely.
|
|
||||||
- name: Check if this bundle is already built
|
- name: Check if this bundle is already built
|
||||||
id: check
|
id: check
|
||||||
env:
|
env:
|
||||||
@ -108,7 +97,8 @@ jobs:
|
|||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
FORCE: ${{ inputs.force }}
|
FORCE: ${{ inputs.force }}
|
||||||
BUILD_KEY: ${{ steps.vars.outputs.build_key }}
|
SHORT_SHA: ${{ steps.vars.outputs.short_sha }}
|
||||||
|
BUNDLE_VERSION: ${{ steps.vars.outputs.bundle_version }}
|
||||||
run: |
|
run: |
|
||||||
if [ "$FORCE" = "true" ]; then
|
if [ "$FORCE" = "true" ]; then
|
||||||
echo "exists=false" >> $GITHUB_OUTPUT
|
echo "exists=false" >> $GITHUB_OUTPUT
|
||||||
@ -122,7 +112,7 @@ jobs:
|
|||||||
|
|
||||||
BUNDLE_EXISTS=$(aws s3api head-object \
|
BUNDLE_EXISTS=$(aws s3api head-object \
|
||||||
--bucket "$S3_BUCKET" \
|
--bucket "$S3_BUCKET" \
|
||||||
--key "penpot-${BUILD_KEY}.zip" \
|
--key "penpot-sha-${SHORT_SHA}.zip" \
|
||||||
> /dev/null 2>&1 && echo "true" || echo "false")
|
> /dev/null 2>&1 && echo "true" || echo "false")
|
||||||
|
|
||||||
if [ "$BUNDLE_EXISTS" = "true" ]; then
|
if [ "$BUNDLE_EXISTS" = "true" ]; then
|
||||||
@ -130,7 +120,7 @@ jobs:
|
|||||||
{
|
{
|
||||||
echo "### ⏭️ Bundle build skipped"
|
echo "### ⏭️ Bundle build skipped"
|
||||||
echo ""
|
echo ""
|
||||||
echo "The bundle in S3 was already built for \`${BUILD_KEY}\`."
|
echo "The bundle in S3 was already built from \`sha-${SHORT_SHA}\` (\`${BUNDLE_VERSION}\`)."
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
} >> "$GITHUB_STEP_SUMMARY"
|
||||||
else
|
else
|
||||||
echo "exists=false" >> $GITHUB_OUTPUT
|
echo "exists=false" >> $GITHUB_OUTPUT
|
||||||
@ -174,11 +164,11 @@ jobs:
|
|||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
BUILD_KEY: ${{ needs.check.outputs.build_key }}
|
SHORT_SHA: ${{ needs.check.outputs.short_sha }}
|
||||||
BUNDLE_VERSION: ${{ needs.check.outputs.bundle_version }}
|
BUNDLE_VERSION: ${{ needs.check.outputs.bundle_version }}
|
||||||
run: |
|
run: |
|
||||||
aws s3 cp zips/penpot.zip \
|
aws s3 cp zips/penpot.zip \
|
||||||
"s3://${S3_BUCKET}/penpot-${BUILD_KEY}.zip" \
|
"s3://${S3_BUCKET}/penpot-sha-${SHORT_SHA}.zip" \
|
||||||
--metadata "bundle-version=${BUNDLE_VERSION}"
|
--metadata "bundle-version=${BUNDLE_VERSION}"
|
||||||
|
|
||||||
- name: Write step summary
|
- name: Write step summary
|
||||||
@ -190,7 +180,7 @@ jobs:
|
|||||||
{
|
{
|
||||||
echo "### ✅ Bundle built"
|
echo "### ✅ Bundle built"
|
||||||
echo ""
|
echo ""
|
||||||
echo "- Version: \`${BUNDLE_VERSION}\` (\`./manage.sh version\`)"
|
echo "- Version: \`${BUNDLE_VERSION}\` (\`git describe --tags --always\`)"
|
||||||
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
||||||
echo "- Built at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
echo "- Built at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
} >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
|||||||
4
.github/workflows/build-docker-devenv.yml
vendored
4
.github/workflows/build-docker-devenv.yml
vendored
@ -38,13 +38,13 @@ jobs:
|
|||||||
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
||||||
|
|
||||||
- name: Login to Docker Registry (push destination)
|
- name: Login to Docker Registry (push destination)
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
||||||
|
|
||||||
- name: Login to Docker Hardened Images registry (base image pull)
|
- name: Login to Docker Hardened Images registry (base image pull)
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: dhi.io
|
registry: dhi.io
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
|
|||||||
64
.github/workflows/build-docker.yml
vendored
64
.github/workflows/build-docker.yml
vendored
@ -85,7 +85,6 @@ jobs:
|
|||||||
bundle_version: ${{ steps.vars.outputs.bundle_version }}
|
bundle_version: ${{ steps.vars.outputs.bundle_version }}
|
||||||
sha: ${{ steps.vars.outputs.sha }}
|
sha: ${{ steps.vars.outputs.sha }}
|
||||||
short_sha: ${{ steps.vars.outputs.short_sha }}
|
short_sha: ${{ steps.vars.outputs.short_sha }}
|
||||||
build_key: ${{ steps.vars.outputs.build_key }}
|
|
||||||
commit_title: ${{ steps.vars.outputs.commit_title }}
|
commit_title: ${{ steps.vars.outputs.commit_title }}
|
||||||
exists: ${{ steps.check.outputs.exists }}
|
exists: ${{ steps.check.outputs.exists }}
|
||||||
|
|
||||||
@ -106,15 +105,10 @@ jobs:
|
|||||||
REF_SLUG=$(printf '%s' "$GH_REF" | tr -c 'A-Za-z0-9._-' '-' | cut -c1-100)
|
REF_SLUG=$(printf '%s' "$GH_REF" | tr -c 'A-Za-z0-9._-' '-' | cut -c1-100)
|
||||||
echo "gh_ref=$GH_REF" >> $GITHUB_OUTPUT
|
echo "gh_ref=$GH_REF" >> $GITHUB_OUTPUT
|
||||||
echo "ref_slug=$REF_SLUG" >> $GITHUB_OUTPUT
|
echo "ref_slug=$REF_SLUG" >> $GITHUB_OUTPUT
|
||||||
# Must match the key computed by build-bundle.yml.
|
|
||||||
BUNDLE_VERSION=$(./manage.sh version)
|
|
||||||
SHORT_SHA=$(git rev-parse --short=12 HEAD)
|
|
||||||
VERSION_TAG=$(git describe --tags --match '*.*.*' --abbrev=0)
|
|
||||||
echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
|
echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
|
||||||
echo "short_sha=$SHORT_SHA" >> $GITHUB_OUTPUT
|
echo "short_sha=$(git rev-parse --short=12 HEAD)" >> $GITHUB_OUTPUT
|
||||||
echo "commit_title=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
echo "commit_title=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT
|
||||||
echo "bundle_version=$BUNDLE_VERSION" >> $GITHUB_OUTPUT
|
echo "bundle_version=$(git describe --tags --always)" >> $GITHUB_OUTPUT
|
||||||
echo "build_key=sha-${SHORT_SHA}-${VERSION_TAG}" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
# The image set is a single block, so a single set-level check is
|
# The image set is a single block, so a single set-level check is
|
||||||
# enough: `promote` drops a marker object in S3 only after every
|
# enough: `promote` drops a marker object in S3 only after every
|
||||||
@ -129,14 +123,14 @@ jobs:
|
|||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
FORCE: ${{ inputs.force }}
|
FORCE: ${{ inputs.force }}
|
||||||
BUILD_KEY: ${{ steps.vars.outputs.build_key }}
|
SHORT_SHA: ${{ steps.vars.outputs.short_sha }}
|
||||||
run: |
|
run: |
|
||||||
if [ "$FORCE" = "true" ]; then
|
if [ "$FORCE" = "true" ]; then
|
||||||
echo "exists=false" >> $GITHUB_OUTPUT
|
echo "exists=false" >> $GITHUB_OUTPUT
|
||||||
mkdir -p "$BUNDLE_CACHE"
|
mkdir -p "$BUNDLE_CACHE"
|
||||||
find "$BUNDLE_CACHE" -type f -mtime +1 -delete || true
|
find "$BUNDLE_CACHE" -type f -mtime +1 -delete || true
|
||||||
ZIP="$BUNDLE_CACHE/penpot-${BUILD_KEY}.zip"
|
ZIP="$BUNDLE_CACHE/penpot-sha-${SHORT_SHA}.zip"
|
||||||
aws s3 cp "s3://${S3_BUCKET}/penpot-${BUILD_KEY}.zip" "$ZIP.$$.tmp"
|
aws s3 cp "s3://${S3_BUCKET}/penpot-sha-${SHORT_SHA}.zip" "$ZIP.$$.tmp"
|
||||||
mv "$ZIP.$$.tmp" "$ZIP"
|
mv "$ZIP.$$.tmp" "$ZIP"
|
||||||
{
|
{
|
||||||
echo "### 🔁 Image set build forced"
|
echo "### 🔁 Image set build forced"
|
||||||
@ -148,13 +142,13 @@ jobs:
|
|||||||
|
|
||||||
if aws s3api head-object \
|
if aws s3api head-object \
|
||||||
--bucket "$S3_BUCKET" \
|
--bucket "$S3_BUCKET" \
|
||||||
--key "markers/images-${BUILD_KEY}" \
|
--key "markers/images-sha-${SHORT_SHA}" \
|
||||||
> /dev/null 2>&1; then
|
> /dev/null 2>&1; then
|
||||||
echo "exists=true" >> $GITHUB_OUTPUT
|
echo "exists=true" >> $GITHUB_OUTPUT
|
||||||
{
|
{
|
||||||
echo "### ⏭️ Image set build skipped"
|
echo "### ⏭️ Image set build skipped"
|
||||||
echo ""
|
echo ""
|
||||||
echo "The whole set was already built and promoted for \`${BUILD_KEY}\`."
|
echo "The whole set was already built and promoted for \`sha-${SHORT_SHA}\`."
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
} >> "$GITHUB_STEP_SUMMARY"
|
||||||
else
|
else
|
||||||
echo "exists=false" >> $GITHUB_OUTPUT
|
echo "exists=false" >> $GITHUB_OUTPUT
|
||||||
@ -164,9 +158,9 @@ jobs:
|
|||||||
# prune stale bundles while at it.
|
# prune stale bundles while at it.
|
||||||
mkdir -p "$BUNDLE_CACHE"
|
mkdir -p "$BUNDLE_CACHE"
|
||||||
find "$BUNDLE_CACHE" -type f -mtime +1 -delete || true
|
find "$BUNDLE_CACHE" -type f -mtime +1 -delete || true
|
||||||
ZIP="$BUNDLE_CACHE/penpot-${BUILD_KEY}.zip"
|
ZIP="$BUNDLE_CACHE/penpot-sha-${SHORT_SHA}.zip"
|
||||||
if [ ! -f "$ZIP" ]; then
|
if [ ! -f "$ZIP" ]; then
|
||||||
aws s3 cp "s3://${S3_BUCKET}/penpot-${BUILD_KEY}.zip" "$ZIP.$$.tmp"
|
aws s3 cp "s3://${S3_BUCKET}/penpot-sha-${SHORT_SHA}.zip" "$ZIP.$$.tmp"
|
||||||
mv "$ZIP.$$.tmp" "$ZIP"
|
mv "$ZIP.$$.tmp" "$ZIP"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
@ -200,7 +194,7 @@ jobs:
|
|||||||
ref: ${{ inputs.sha != '' && inputs.sha || inputs.gh_ref }}
|
ref: ${{ inputs.sha != '' && inputs.sha || inputs.gh_ref }}
|
||||||
|
|
||||||
- name: Login to Docker Registry
|
- name: Login to Docker Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: ${{ secrets.DOCKER_REGISTRY }}
|
registry: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
@ -210,7 +204,7 @@ jobs:
|
|||||||
# images from DockerHub for unregistered users.
|
# images from DockerHub for unregistered users.
|
||||||
# https://docs.docker.com/docker-hub/usage/
|
# https://docs.docker.com/docker-hub/usage/
|
||||||
- name: Login to DockerHub Registry
|
- name: Login to DockerHub Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
||||||
@ -222,7 +216,7 @@ jobs:
|
|||||||
# reuses the same PUB_DOCKER_* credentials as the DockerHub
|
# reuses the same PUB_DOCKER_* credentials as the DockerHub
|
||||||
# login above.
|
# login above.
|
||||||
- name: Login to Docker Hardened Images registry (base image pull)
|
- name: Login to Docker Hardened Images registry (base image pull)
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: dhi.io
|
registry: dhi.io
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
@ -237,14 +231,14 @@ jobs:
|
|||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
IMAGE: ${{ matrix.image }}
|
IMAGE: ${{ matrix.image }}
|
||||||
run: |
|
run: |
|
||||||
ZIP="$BUNDLE_CACHE/penpot-${BUILD_KEY}.zip"
|
ZIP="$BUNDLE_CACHE/penpot-sha-${SHORT_SHA}.zip"
|
||||||
if [ ! -f "$ZIP" ]; then
|
if [ ! -f "$ZIP" ]; then
|
||||||
echo "Bundle not found in host cache; falling back to S3."
|
echo "Bundle not found in host cache; falling back to S3."
|
||||||
mkdir -p "$BUNDLE_CACHE"
|
mkdir -p "$BUNDLE_CACHE"
|
||||||
aws s3 cp "s3://${S3_BUCKET}/penpot-${BUILD_KEY}.zip" "$ZIP.$$.tmp"
|
aws s3 cp "s3://${S3_BUCKET}/penpot-sha-${SHORT_SHA}.zip" "$ZIP.$$.tmp"
|
||||||
mv "$ZIP.$$.tmp" "$ZIP"
|
mv "$ZIP.$$.tmp" "$ZIP"
|
||||||
fi
|
fi
|
||||||
# Extract only the bundle this job needs.
|
# Extract only the bundle this job needs.
|
||||||
@ -280,7 +274,7 @@ jobs:
|
|||||||
sbom: true
|
sbom: true
|
||||||
# Immutable tag only; branch tags are moved atomically for the
|
# Immutable tag only; branch tags are moved atomically for the
|
||||||
# whole image set by the `promote` job.
|
# whole image set by the `promote` job.
|
||||||
tags: ${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:${{ needs.prepare.outputs.build_key }}
|
tags: ${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:sha-${{ needs.prepare.outputs.short_sha }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
cache-from: type=registry,ref=${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:buildcache
|
cache-from: type=registry,ref=${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:buildcache
|
||||||
cache-to: type=registry,ref=${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:buildcache,mode=max
|
cache-to: type=registry,ref=${{ secrets.DOCKER_REGISTRY }}/${{ matrix.image }}:buildcache,mode=max
|
||||||
@ -301,7 +295,7 @@ jobs:
|
|||||||
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
||||||
|
|
||||||
- name: Login to Docker Registry
|
- name: Login to Docker Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: ${{ secrets.DOCKER_REGISTRY }}
|
registry: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
@ -311,13 +305,13 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
DOCKER_REGISTRY: ${{ secrets.DOCKER_REGISTRY }}
|
DOCKER_REGISTRY: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
run: |
|
run: |
|
||||||
set -e
|
set -e
|
||||||
for image in $ALL_IMAGES; do
|
for image in $ALL_IMAGES; do
|
||||||
docker buildx imagetools create \
|
docker buildx imagetools create \
|
||||||
-t "${DOCKER_REGISTRY}/${image}:${REF_SLUG}" \
|
-t "${DOCKER_REGISTRY}/${image}:${REF_SLUG}" \
|
||||||
"${DOCKER_REGISTRY}/${image}:${BUILD_KEY}"
|
"${DOCKER_REGISTRY}/${image}:sha-${SHORT_SHA}"
|
||||||
done
|
done
|
||||||
|
|
||||||
# The marker is written LAST: its presence certifies that all five
|
# The marker is written LAST: its presence certifies that all five
|
||||||
@ -328,27 +322,26 @@ jobs:
|
|||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
run: |
|
run: |
|
||||||
echo "$GITHUB_RUN_ID" | aws s3 cp - \
|
echo "$GITHUB_RUN_ID" | aws s3 cp - \
|
||||||
"s3://${S3_BUCKET}/markers/images-${BUILD_KEY}"
|
"s3://${S3_BUCKET}/markers/images-sha-${SHORT_SHA}"
|
||||||
|
|
||||||
- name: Write step summary
|
- name: Write step summary
|
||||||
env:
|
env:
|
||||||
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
||||||
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
|
||||||
BUNDLE_VERSION: ${{ needs.prepare.outputs.bundle_version }}
|
BUNDLE_VERSION: ${{ needs.prepare.outputs.bundle_version }}
|
||||||
COMMIT_TITLE: ${{ needs.prepare.outputs.commit_title }}
|
COMMIT_TITLE: ${{ needs.prepare.outputs.commit_title }}
|
||||||
run: |
|
run: |
|
||||||
{
|
{
|
||||||
echo "### ✅ Image set promoted"
|
echo "### ✅ Image set promoted"
|
||||||
echo ""
|
echo ""
|
||||||
echo "- Version: \`${BUNDLE_VERSION}\` (\`./manage.sh version\`)"
|
echo "- Version: \`${BUNDLE_VERSION}\` (\`git describe --tags --always\`)"
|
||||||
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
||||||
echo "- Built at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
echo "- Built at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
||||||
echo ""
|
echo ""
|
||||||
echo "All \`:${REF_SLUG}\` tags now point to \`${BUILD_KEY}\`."
|
echo "All \`:${REF_SLUG}\` tags now point to \`sha-${SHORT_SHA}\`."
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
} >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
|
||||||
# ── 3b. Skip path: make sure THIS ref's tags point to the existing
|
# ── 3b. Skip path: make sure THIS ref's tags point to the existing
|
||||||
@ -371,7 +364,7 @@ jobs:
|
|||||||
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
||||||
|
|
||||||
- name: Login to Docker Registry
|
- name: Login to Docker Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: ${{ secrets.DOCKER_REGISTRY }}
|
registry: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
@ -381,31 +374,30 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
DOCKER_REGISTRY: ${{ secrets.DOCKER_REGISTRY }}
|
DOCKER_REGISTRY: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
run: |
|
run: |
|
||||||
set -e
|
set -e
|
||||||
for image in $ALL_IMAGES; do
|
for image in $ALL_IMAGES; do
|
||||||
docker buildx imagetools create \
|
docker buildx imagetools create \
|
||||||
-t "${DOCKER_REGISTRY}/${image}:${REF_SLUG}" \
|
-t "${DOCKER_REGISTRY}/${image}:${REF_SLUG}" \
|
||||||
"${DOCKER_REGISTRY}/${image}:${BUILD_KEY}"
|
"${DOCKER_REGISTRY}/${image}:sha-${SHORT_SHA}"
|
||||||
done
|
done
|
||||||
|
|
||||||
- name: Write step summary
|
- name: Write step summary
|
||||||
env:
|
env:
|
||||||
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
REF_SLUG: ${{ needs.prepare.outputs.ref_slug }}
|
||||||
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
BUILD_KEY: ${{ needs.prepare.outputs.build_key }}
|
|
||||||
BUNDLE_VERSION: ${{ needs.prepare.outputs.bundle_version }}
|
BUNDLE_VERSION: ${{ needs.prepare.outputs.bundle_version }}
|
||||||
COMMIT_TITLE: ${{ needs.prepare.outputs.commit_title }}
|
COMMIT_TITLE: ${{ needs.prepare.outputs.commit_title }}
|
||||||
run: |
|
run: |
|
||||||
{
|
{
|
||||||
echo "### ✅ Image set already built (branch tags ensured)"
|
echo "### ✅ Image set already built (branch tags ensured)"
|
||||||
echo ""
|
echo ""
|
||||||
echo "- Version: \`${BUNDLE_VERSION}\` (\`./manage.sh version\`)"
|
echo "- Version: \`${BUNDLE_VERSION}\` (\`git describe --tags --always\`)"
|
||||||
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
echo "- Commit: [\`${SHORT_SHA}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${SHORT_SHA}) — ${COMMIT_TITLE}"
|
||||||
echo "- Checked at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
echo "- Checked at: $(date -u +'%Y-%m-%d %H:%M:%S UTC')"
|
||||||
echo ""
|
echo ""
|
||||||
echo "All \`:${REF_SLUG}\` tags now point to \`${BUILD_KEY}\`."
|
echo "All \`:${REF_SLUG}\` tags now point to \`sha-${SHORT_SHA}\`."
|
||||||
} >> "$GITHUB_STEP_SUMMARY"
|
} >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
|
||||||
# ── 4. Single failure notification for the whole workflow ─────────────
|
# ── 4. Single failure notification for the whole workflow ─────────────
|
||||||
|
|||||||
34
.github/workflows/build-renovate.yml
vendored
34
.github/workflows/build-renovate.yml
vendored
@ -27,7 +27,7 @@ jobs:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
outputs:
|
outputs:
|
||||||
bundle_key: ${{ steps.bundle.outputs.bundle_key }}
|
short_sha: ${{ steps.bundle.outputs.short_sha }}
|
||||||
images: ${{ steps.changes.outputs.images }}
|
images: ${{ steps.changes.outputs.images }}
|
||||||
devenv: ${{ steps.changes.outputs.devenv }}
|
devenv: ${{ steps.changes.outputs.devenv }}
|
||||||
imagemagick: ${{ steps.changes.outputs.imagemagick }}
|
imagemagick: ${{ steps.changes.outputs.imagemagick }}
|
||||||
@ -60,9 +60,7 @@ jobs:
|
|||||||
} >> "$GITHUB_OUTPUT"
|
} >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
# Renovate only changes Dockerfiles and package manager versions, so
|
# Renovate only changes Dockerfiles and package manager versions, so
|
||||||
# the most recent develop bundle is enough to build the images. The
|
# the most recent develop bundle is enough to build the images.
|
||||||
# version part of the key does not matter here: take any bundle of
|
|
||||||
# the commit.
|
|
||||||
- name: Find the latest develop bundle
|
- name: Find the latest develop bundle
|
||||||
id: bundle
|
id: bundle
|
||||||
env:
|
env:
|
||||||
@ -74,12 +72,10 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
for SHA in $(git rev-list --first-parent --max-count=50 "$BASE_SHA"); do
|
for SHA in $(git rev-list --first-parent --max-count=50 "$BASE_SHA"); do
|
||||||
SHORT_SHA=$(git rev-parse --short=12 "$SHA")
|
SHORT_SHA=$(git rev-parse --short=12 "$SHA")
|
||||||
BUNDLE_KEY=$(aws s3api list-objects-v2 --bucket "$S3_BUCKET" \
|
if aws s3api head-object --bucket "$S3_BUCKET" \
|
||||||
--prefix "penpot-sha-${SHORT_SHA}-" \
|
--key "penpot-sha-${SHORT_SHA}.zip" > /dev/null 2>&1; then
|
||||||
--query 'Contents[0].Key' --output text)
|
echo "short_sha=$SHORT_SHA" >> "$GITHUB_OUTPUT"
|
||||||
if [ -n "$BUNDLE_KEY" ] && [ "$BUNDLE_KEY" != "None" ]; then
|
echo "Using bundle \`penpot-sha-${SHORT_SHA}.zip\`" >> "$GITHUB_STEP_SUMMARY"
|
||||||
echo "bundle_key=$BUNDLE_KEY" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "Using bundle \`${BUNDLE_KEY}\`" >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
@ -114,20 +110,20 @@ jobs:
|
|||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Login to Docker Registry
|
- name: Login to Docker Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: ${{ secrets.DOCKER_REGISTRY }}
|
registry: ${{ secrets.DOCKER_REGISTRY }}
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
|
||||||
- name: Login to DockerHub Registry
|
- name: Login to DockerHub Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
||||||
|
|
||||||
- name: Login to Docker Hardened Images registry
|
- name: Login to Docker Hardened Images registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: dhi.io
|
registry: dhi.io
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
@ -139,13 +135,13 @@ jobs:
|
|||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
|
||||||
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
|
||||||
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
S3_BUCKET: ${{ secrets.S3_BUCKET }}
|
||||||
BUNDLE_KEY: ${{ needs.prepare.outputs.bundle_key }}
|
SHORT_SHA: ${{ needs.prepare.outputs.short_sha }}
|
||||||
IMAGE: ${{ matrix.image }}
|
IMAGE: ${{ matrix.image }}
|
||||||
run: |
|
run: |
|
||||||
ZIP="$BUNDLE_CACHE/${BUNDLE_KEY}"
|
ZIP="$BUNDLE_CACHE/penpot-sha-${SHORT_SHA}.zip"
|
||||||
if [ ! -f "$ZIP" ]; then
|
if [ ! -f "$ZIP" ]; then
|
||||||
mkdir -p "$BUNDLE_CACHE"
|
mkdir -p "$BUNDLE_CACHE"
|
||||||
aws s3 cp "s3://${S3_BUCKET}/${BUNDLE_KEY}" "$ZIP.$$.tmp"
|
aws s3 cp "s3://${S3_BUCKET}/penpot-sha-${SHORT_SHA}.zip" "$ZIP.$$.tmp"
|
||||||
mv "$ZIP.$$.tmp" "$ZIP"
|
mv "$ZIP.$$.tmp" "$ZIP"
|
||||||
fi
|
fi
|
||||||
pushd docker/images
|
pushd docker/images
|
||||||
@ -191,13 +187,13 @@ jobs:
|
|||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Login to DockerHub Registry
|
- name: Login to DockerHub Registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
password: ${{ secrets.PUB_DOCKER_PASSWORD }}
|
||||||
|
|
||||||
- name: Login to Docker Hardened Images registry
|
- name: Login to Docker Hardened Images registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: dhi.io
|
registry: dhi.io
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
@ -242,7 +238,7 @@ jobs:
|
|||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Login to Docker Hardened Images registry
|
- name: Login to Docker Hardened Images registry
|
||||||
uses: docker/login-action@8aa5831fb8d48d8f76594c7ddde61ae58019f550 # v4.8.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
registry: dhi.io
|
registry: dhi.io
|
||||||
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
username: ${{ secrets.PUB_DOCKER_USERNAME }}
|
||||||
|
|||||||
1
.github/workflows/commit-checker.yml
vendored
1
.github/workflows/commit-checker.yml
vendored
@ -58,7 +58,6 @@ jobs:
|
|||||||
- name: Checkout trusted code
|
- name: Checkout trusted code
|
||||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
|
||||||
with:
|
with:
|
||||||
persist-credentials: false
|
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: ${{ github.event.pull_request.base.sha || github.sha }}
|
ref: ${{ github.event.pull_request.base.sha || github.sha }}
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/lint-workflows.yml
vendored
2
.github/workflows/lint-workflows.yml
vendored
@ -34,7 +34,7 @@ permissions: {}
|
|||||||
|
|
||||||
env:
|
env:
|
||||||
ACTIONLINT_VERSION: '1.7.12'
|
ACTIONLINT_VERSION: '1.7.12'
|
||||||
ZIZMOR_VERSION: '1.32.0'
|
ZIZMOR_VERSION: '1.31.1'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
|
|||||||
4
.github/workflows/plugins-deploy-api-doc.yml
vendored
4
.github/workflows/plugins-deploy-api-doc.yml
vendored
@ -48,10 +48,10 @@ jobs:
|
|||||||
# No dependency cache here: a deploy must not restore a cache that
|
# No dependency cache here: a deploy must not restore a cache that
|
||||||
# other workflows can write to.
|
# other workflows can write to.
|
||||||
- name: Setup pnpm + Node.js
|
- name: Setup pnpm + Node.js
|
||||||
uses: pnpm/setup@731dfb6463bbd11c11fd0ee11fe00ed0e36d48a1 # v3.2.0
|
uses: pnpm/setup@a0881977cd8ea73b1ed212236c99ca10dcc80cf4 # v3.1.1
|
||||||
with:
|
with:
|
||||||
working-directory: plugins
|
working-directory: plugins
|
||||||
runtime: node@24.22.3
|
runtime: node@24.22.1
|
||||||
install: false
|
install: false
|
||||||
|
|
||||||
- name: Install deps
|
- name: Install deps
|
||||||
|
|||||||
@ -46,10 +46,10 @@ jobs:
|
|||||||
# No dependency cache here: a deploy must not restore a cache that
|
# No dependency cache here: a deploy must not restore a cache that
|
||||||
# other workflows can write to.
|
# other workflows can write to.
|
||||||
- name: Setup pnpm + Node.js
|
- name: Setup pnpm + Node.js
|
||||||
uses: pnpm/setup@731dfb6463bbd11c11fd0ee11fe00ed0e36d48a1 # v3.2.0
|
uses: pnpm/setup@a0881977cd8ea73b1ed212236c99ca10dcc80cf4 # v3.1.1
|
||||||
with:
|
with:
|
||||||
working-directory: plugins
|
working-directory: plugins
|
||||||
runtime: node@24.22.3
|
runtime: node@24.22.1
|
||||||
install: false
|
install: false
|
||||||
|
|
||||||
- name: Install deps
|
- name: Install deps
|
||||||
|
|||||||
138
.github/workflows/prs-pre-validations.yml
vendored
138
.github/workflows/prs-pre-validations.yml
vendored
@ -1,138 +0,0 @@
|
|||||||
name: PRs Pre-Validations
|
|
||||||
|
|
||||||
# pull_request_target is required so the job gets a write token for PRs from
|
|
||||||
# forks. It is safe here: the workflow never checks out or runs PR code, it
|
|
||||||
# only reads ids from the event payload and calls the GitHub API.
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
- ready_for_review
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
validate-public-pr:
|
|
||||||
name: Validate public PR
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 5
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
steps:
|
|
||||||
- name: Close public PR that does not meet the validation rules
|
|
||||||
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
|
|
||||||
with:
|
|
||||||
script: |
|
|
||||||
const ASSOCIATIONS_WITH_ACCESS = new Set(['COLLABORATOR', 'MEMBER', 'OWNER']);
|
|
||||||
const CONTRIBUTION_GUIDE_URL = 'https://github.com/penpot/penpot/blob/develop/CONTRIBUTING.md';
|
|
||||||
const REASONS = {
|
|
||||||
NO_LINKED_ISSUE: [
|
|
||||||
'Thank you for taking the time to contribute to Penpot!',
|
|
||||||
'',
|
|
||||||
'This pull request was closed automatically because it is not linked to any issue yet. Please open an issue describing the change, or find an existing one, link it to this pull request and reopen it. We will be happy to review it then.'
|
|
||||||
].join('\n'),
|
|
||||||
NEEDS_TRIAGE: [
|
|
||||||
'Thank you for your interest in improving Penpot.',
|
|
||||||
'',
|
|
||||||
'This pull request was closed automatically because it is linked to an issue labelled `needs triage`. Our product team is still reviewing that issue, so it is not open for contributions yet. Once a maintainer confirms that the issue is ready, please reopen this pull request.'
|
|
||||||
].join('\n'),
|
|
||||||
INTERNAL_ISSUE: [
|
|
||||||
'Thank you for wanting to help with Penpot.',
|
|
||||||
'',
|
|
||||||
'This pull request was closed automatically because it is linked to an issue labelled `internal`. Internal issues are not open to outside contributions. Please choose an issue that is explicitly open for contributions, or ask in the issue first, and then reopen this pull request.'
|
|
||||||
].join('\n')
|
|
||||||
};
|
|
||||||
const GUIDE_FOOTER = [
|
|
||||||
'',
|
|
||||||
'If you are unsure where to start, our [contribution guide](' +
|
|
||||||
CONTRIBUTION_GUIDE_URL +
|
|
||||||
') explains how we triage issues and when they become open for contributions.'
|
|
||||||
].join('\n');
|
|
||||||
|
|
||||||
const pr = context.payload.pull_request;
|
|
||||||
if (!pr) {
|
|
||||||
throw new Error('This workflow only runs for pull_request_target events.');
|
|
||||||
}
|
|
||||||
if (pr.draft) {
|
|
||||||
console.log(`PR #${pr.number} is a draft; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (pr.user.type === 'Bot') {
|
|
||||||
console.log(`PR #${pr.number} was opened by a bot; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Exemption labels such as `no issue required` do not apply to
|
|
||||||
// public contributors: the author classification wins.
|
|
||||||
if (ASSOCIATIONS_WITH_ACCESS.has(pr.author_association)) {
|
|
||||||
console.log(`PR #${pr.number} was opened by ${pr.author_association}; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (pr.author_association === 'MANNEQUIN') {
|
|
||||||
console.log(`PR #${pr.number} was opened by a migrated placeholder user; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { owner, repo } = context.repo;
|
|
||||||
const result = await github.graphql(
|
|
||||||
`query($owner: String!, $repo: String!, $number: Int!) {
|
|
||||||
repository(owner: $owner, name: $repo) {
|
|
||||||
pullRequest(number: $number) {
|
|
||||||
isDraft
|
|
||||||
closingIssuesReferences(first: 100) {
|
|
||||||
nodes {
|
|
||||||
number
|
|
||||||
labels(first: 100) {
|
|
||||||
nodes {
|
|
||||||
name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}`,
|
|
||||||
{ owner, repo, number: pr.number }
|
|
||||||
);
|
|
||||||
|
|
||||||
const pullRequest = result.repository.pullRequest;
|
|
||||||
if (pullRequest.isDraft) {
|
|
||||||
console.log(`PR #${pr.number} became a draft; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const issues = pullRequest.closingIssuesReferences.nodes;
|
|
||||||
const hasLabel = (issue, name) =>
|
|
||||||
issue.labels.nodes.some(({ name: labelName }) => labelName === name);
|
|
||||||
const reasons = [];
|
|
||||||
if (issues.length === 0) {
|
|
||||||
reasons.push('NO_LINKED_ISSUE');
|
|
||||||
} else {
|
|
||||||
if (issues.some((issue) => hasLabel(issue, 'needs triage'))) {
|
|
||||||
reasons.push('NEEDS_TRIAGE');
|
|
||||||
}
|
|
||||||
if (issues.some((issue) => hasLabel(issue, 'internal'))) {
|
|
||||||
reasons.push('INTERNAL_ISSUE');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (reasons.length === 0) {
|
|
||||||
console.log(`PR #${pr.number} has a suitable linked issue; skipping.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const body = reasons.map((reason) => REASONS[reason]).join('\n\n') + GUIDE_FOOTER;
|
|
||||||
await github.rest.issues.createComment({
|
|
||||||
owner,
|
|
||||||
repo,
|
|
||||||
issue_number: pr.number,
|
|
||||||
body
|
|
||||||
});
|
|
||||||
await github.rest.pulls.update({
|
|
||||||
owner,
|
|
||||||
repo,
|
|
||||||
pull_number: pr.number,
|
|
||||||
state: 'closed'
|
|
||||||
});
|
|
||||||
console.log(`Closed PR #${pr.number}: ${reasons.join(', ')}.`);
|
|
||||||
90
.github/workflows/require-linked-issue.yml
vendored
90
.github/workflows/require-linked-issue.yml
vendored
@ -1,90 +0,0 @@
|
|||||||
name: Require Linked Issue
|
|
||||||
|
|
||||||
# A pull request must have at least one closing-issue reference, unless it
|
|
||||||
# carries the `no issue required` or `pr pt` label.
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
- synchronize
|
|
||||||
- edited
|
|
||||||
- labeled
|
|
||||||
- unlabeled
|
|
||||||
- ready_for_review
|
|
||||||
- converted_to_draft
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: read
|
|
||||||
issues: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check-linked-issue:
|
|
||||||
name: Require Linked Issue
|
|
||||||
if: ${{ !github.event.pull_request.draft }}
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Check linked issue
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
OWNER: ${{ github.repository_owner }}
|
|
||||||
REPO: ${{ github.event.repository.name }}
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
# shellcheck disable=SC2016 # GraphQL variables, not shell expansion.
|
|
||||||
result=$(gh api graphql \
|
|
||||||
-F owner="$OWNER" \
|
|
||||||
-F repo="$REPO" \
|
|
||||||
-F number="$PR_NUMBER" \
|
|
||||||
-f query='
|
|
||||||
query($owner: String!, $repo: String!, $number: Int!) {
|
|
||||||
repository(owner: $owner, name: $repo) {
|
|
||||||
pullRequest(number: $number) {
|
|
||||||
isDraft
|
|
||||||
labels(first: 100) {
|
|
||||||
nodes {
|
|
||||||
name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
closingIssuesReferences(first: 100) {
|
|
||||||
nodes {
|
|
||||||
number
|
|
||||||
title
|
|
||||||
url
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
')
|
|
||||||
|
|
||||||
pull_request=$(echo "$result" | jq '.data.repository.pullRequest')
|
|
||||||
|
|
||||||
if [ "$(echo "$pull_request" | jq -r '.isDraft')" = "true" ]; then
|
|
||||||
echo "Draft PR: linked issue check skipped."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
has_exemption=$(echo "$pull_request" | jq -r '
|
|
||||||
any(.labels.nodes[]; .name == "no issue required" or .name == "pr pt")
|
|
||||||
')
|
|
||||||
if [ "$has_exemption" = "true" ]; then
|
|
||||||
echo 'Exempt label found: linked issue check skipped.'
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
issues=$(echo "$pull_request" | jq -r '
|
|
||||||
.closingIssuesReferences.nodes[]
|
|
||||||
| "- #\(.number): \(.title) (\(.url))"
|
|
||||||
')
|
|
||||||
|
|
||||||
if [ -z "$issues" ]; then
|
|
||||||
echo '::error::This pull request must have a linked issue, or an exempt label ("no issue required").'
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Linked issue(s):"
|
|
||||||
echo "$issues"
|
|
||||||
@ -1,76 +0,0 @@
|
|||||||
name: Require Milestone on Linked Issues
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
- synchronize
|
|
||||||
- edited
|
|
||||||
- ready_for_review
|
|
||||||
- converted_to_draft
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: read
|
|
||||||
issues: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check-linked-issues:
|
|
||||||
name: Require Milestones on Linked Issues
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Check linked issues
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
IS_DRAFT: ${{ github.event.pull_request.draft }}
|
|
||||||
REPOSITORY: ${{ github.repository }}
|
|
||||||
run: |
|
|
||||||
if [ "$IS_DRAFT" = "true" ]; then
|
|
||||||
echo "Draft PR: milestone check skipped."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
OWNER="${REPOSITORY%%/*}"
|
|
||||||
REPO="${REPOSITORY#*/}"
|
|
||||||
|
|
||||||
# shellcheck disable=SC2016 # GraphQL variables, not shell expansion.
|
|
||||||
ISSUES=$(gh api graphql \
|
|
||||||
-F owner="$OWNER" \
|
|
||||||
-F repo="$REPO" \
|
|
||||||
-F number="$PR_NUMBER" \
|
|
||||||
-f query='
|
|
||||||
query($owner: String!, $repo: String!, $number: Int!) {
|
|
||||||
repository(owner: $owner, name: $repo) {
|
|
||||||
pullRequest(number: $number) {
|
|
||||||
closingIssuesReferences(first: 100) {
|
|
||||||
nodes {
|
|
||||||
number
|
|
||||||
title
|
|
||||||
url
|
|
||||||
milestone {
|
|
||||||
title
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
')
|
|
||||||
|
|
||||||
MISSING=$(echo "$ISSUES" | jq -r '
|
|
||||||
.data.repository.pullRequest.closingIssuesReferences.nodes[]
|
|
||||||
| select(.milestone == null)
|
|
||||||
| "- #\(.number): \(.title) (\(.url))"
|
|
||||||
')
|
|
||||||
|
|
||||||
if [ -n "$MISSING" ]; then
|
|
||||||
echo "::error::The following linked issues have no milestone:"
|
|
||||||
echo "$MISSING"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "All linked issues have a milestone."
|
|
||||||
45
.github/workflows/require-milestone.yml
vendored
45
.github/workflows/require-milestone.yml
vendored
@ -1,45 +0,0 @@
|
|||||||
name: Require Milestone
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
- synchronize
|
|
||||||
- edited
|
|
||||||
- milestoned
|
|
||||||
- demilestoned
|
|
||||||
- ready_for_review
|
|
||||||
- converted_to_draft
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check-milestone:
|
|
||||||
name: Require Milestone
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Check milestone
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
run: |
|
|
||||||
pr_api="repos/${GITHUB_REPOSITORY}/pulls/${PR_NUMBER}"
|
|
||||||
|
|
||||||
is_draft=$(gh api "$pr_api" --jq '.draft')
|
|
||||||
milestone=$(gh api "$pr_api" --jq '.milestone.title // ""')
|
|
||||||
|
|
||||||
if [ "$is_draft" = "true" ]; then
|
|
||||||
echo "Draft PR: milestone check skipped."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$milestone" ]; then
|
|
||||||
echo "::error::This pull request must have a milestone."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Milestone assigned: $milestone"
|
|
||||||
40
.github/workflows/tests-backend.yml
vendored
40
.github/workflows/tests-backend.yml
vendored
@ -34,9 +34,6 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
test-backend:
|
test-backend:
|
||||||
if: ${{ !github.event.pull_request.draft }}
|
if: ${{ !github.event.pull_request.draft }}
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write # coverage comment on the PR
|
|
||||||
name: "Backend Tests"
|
name: "Backend Tests"
|
||||||
runs-on: penpot-extended-runner
|
runs-on: penpot-extended-runner
|
||||||
container:
|
container:
|
||||||
@ -94,39 +91,4 @@ jobs:
|
|||||||
|
|
||||||
run: |
|
run: |
|
||||||
mkdir -p /tmp/penpot;
|
mkdir -p /tmp/penpot;
|
||||||
clojure -M:dev:test:coverage
|
clojure -M:dev:test
|
||||||
|
|
||||||
- name: Coverage summary
|
|
||||||
if: ${{ !cancelled() && hashFiles('backend/target/coverage/lcov.info') != '' }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-summary.mjs \
|
|
||||||
--title "Backend test coverage" \
|
|
||||||
--note "Namespaces under \`backend/src/app\`." \
|
|
||||||
--lcov backend/target/coverage/lcov.info \
|
|
||||||
> backend/target/coverage/summary.md
|
|
||||||
cat backend/target/coverage/summary.md >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
|
|
||||||
- name: Coverage comment
|
|
||||||
# Fork PRs get a read-only token, so only branches of this repo comment.
|
|
||||||
if: ${{ !cancelled() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && hashFiles('backend/target/coverage/lcov.info') != '' }}
|
|
||||||
continue-on-error: true
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-comment.mjs \
|
|
||||||
--project Backend \
|
|
||||||
--lcov backend/target/coverage/lcov.info \
|
|
||||||
--emma-xml backend/target/coverage/coverage.xml \
|
|
||||||
--prefix backend/
|
|
||||||
|
|
||||||
- name: Upload coverage report
|
|
||||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
||||||
if: ${{ !cancelled() }}
|
|
||||||
with:
|
|
||||||
name: backend-coverage
|
|
||||||
path: backend/target/coverage/
|
|
||||||
overwrite: true
|
|
||||||
if-no-files-found: ignore
|
|
||||||
retention-days: 7
|
|
||||||
|
|||||||
38
.github/workflows/tests-common.yml
vendored
38
.github/workflows/tests-common.yml
vendored
@ -32,9 +32,6 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
test-common:
|
test-common:
|
||||||
if: ${{ !github.event.pull_request.draft }}
|
if: ${{ !github.event.pull_request.draft }}
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write # coverage comment on the PR
|
|
||||||
name: "Common Tests"
|
name: "Common Tests"
|
||||||
runs-on: penpot-extended-runner
|
runs-on: penpot-extended-runner
|
||||||
container:
|
container:
|
||||||
@ -61,38 +58,3 @@ jobs:
|
|||||||
working-directory: ./common
|
working-directory: ./common
|
||||||
run: |
|
run: |
|
||||||
./scripts/test
|
./scripts/test
|
||||||
|
|
||||||
- name: Coverage summary
|
|
||||||
if: ${{ !cancelled() && hashFiles('common/target/coverage/lcov.info') != '' }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-summary.mjs \
|
|
||||||
--title "Common JVM test coverage" \
|
|
||||||
--note "Namespaces under \`common/src/app\`, measured by the JVM tests." \
|
|
||||||
--lcov common/target/coverage/lcov.info \
|
|
||||||
> common/target/coverage/summary.md
|
|
||||||
cat common/target/coverage/summary.md >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
|
|
||||||
- name: Coverage comment
|
|
||||||
# Fork PRs get a read-only token, so only branches of this repo comment.
|
|
||||||
if: ${{ !cancelled() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && hashFiles('common/target/coverage/lcov.info') != '' }}
|
|
||||||
continue-on-error: true
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-comment.mjs \
|
|
||||||
--project Common \
|
|
||||||
--lcov common/target/coverage/lcov.info \
|
|
||||||
--emma-xml common/target/coverage/coverage.xml \
|
|
||||||
--prefix common/
|
|
||||||
|
|
||||||
- name: Upload coverage report
|
|
||||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
||||||
if: ${{ !cancelled() }}
|
|
||||||
with:
|
|
||||||
name: common-coverage
|
|
||||||
path: common/target/coverage/
|
|
||||||
overwrite: true
|
|
||||||
if-no-files-found: ignore
|
|
||||||
retention-days: 7
|
|
||||||
|
|||||||
5
.github/workflows/tests-exporter.yml
vendored
5
.github/workflows/tests-exporter.yml
vendored
@ -61,3 +61,8 @@ jobs:
|
|||||||
working-directory: ./exporter
|
working-directory: ./exporter
|
||||||
run: |
|
run: |
|
||||||
./scripts/test
|
./scripts/test
|
||||||
|
|
||||||
|
- name: Check no invoke_* in exporter JS glue
|
||||||
|
working-directory: ./render-wasm
|
||||||
|
run: |
|
||||||
|
./check-no-invoke-v export
|
||||||
|
|||||||
39
.github/workflows/tests-frontend.yml
vendored
39
.github/workflows/tests-frontend.yml
vendored
@ -36,9 +36,6 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
test-frontend:
|
test-frontend:
|
||||||
if: ${{ !github.event.pull_request.draft }}
|
if: ${{ !github.event.pull_request.draft }}
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write # coverage comment on the PR
|
|
||||||
name: "Frontend Tests"
|
name: "Frontend Tests"
|
||||||
runs-on: penpot-extended-runner
|
runs-on: penpot-extended-runner
|
||||||
container:
|
container:
|
||||||
@ -69,42 +66,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
./scripts/test
|
./scripts/test
|
||||||
|
|
||||||
- name: Coverage summary
|
|
||||||
if: ${{ !cancelled() && hashFiles('frontend/coverage/lcov.info') != '' }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-summary.mjs \
|
|
||||||
--title "Frontend unit test coverage" \
|
|
||||||
--note "Logic namespaces under \`frontend/src/app\`, without \`app/main/ui\`." \
|
|
||||||
--lcov frontend/coverage/lcov.info \
|
|
||||||
--unloaded frontend/coverage/unloaded.txt \
|
|
||||||
> frontend/coverage/summary.md
|
|
||||||
cat frontend/coverage/summary.md >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
|
|
||||||
- name: Coverage comment
|
|
||||||
# Fork PRs get a read-only token, so only branches of this repo comment.
|
|
||||||
if: ${{ !cancelled() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && hashFiles('frontend/coverage/lcov.info') != '' }}
|
|
||||||
continue-on-error: true
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
||||||
run: |
|
|
||||||
node scripts/coverage-comment.mjs \
|
|
||||||
--project Frontend \
|
|
||||||
--lcov frontend/coverage/lcov.info \
|
|
||||||
--json-summary frontend/coverage/coverage-summary.json \
|
|
||||||
--unloaded frontend/coverage/unloaded.txt
|
|
||||||
|
|
||||||
- name: Upload coverage report
|
|
||||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
||||||
if: ${{ !cancelled() }}
|
|
||||||
with:
|
|
||||||
name: frontend-coverage
|
|
||||||
path: frontend/coverage/
|
|
||||||
overwrite: true
|
|
||||||
if-no-files-found: ignore
|
|
||||||
retention-days: 7
|
|
||||||
|
|
||||||
- name: Component Tests
|
- name: Component Tests
|
||||||
working-directory: ./frontend
|
working-directory: ./frontend
|
||||||
env:
|
env:
|
||||||
|
|||||||
64
.github/workflows/tests-wasm.yml
vendored
64
.github/workflows/tests-wasm.yml
vendored
@ -32,9 +32,6 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
test-render-wasm:
|
test-render-wasm:
|
||||||
if: ${{ !github.event.pull_request.draft }}
|
if: ${{ !github.event.pull_request.draft }}
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write # coverage comment on the PR
|
|
||||||
name: "Render WASM Tests"
|
name: "Render WASM Tests"
|
||||||
runs-on: penpot-extended-runner
|
runs-on: penpot-extended-runner
|
||||||
container:
|
container:
|
||||||
@ -52,71 +49,24 @@ jobs:
|
|||||||
- name: Format
|
- name: Format
|
||||||
working-directory: ./render-wasm
|
working-directory: ./render-wasm
|
||||||
run: |
|
run: |
|
||||||
./fmt --check
|
cargo fmt --check
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
working-directory: ./render-wasm
|
working-directory: ./render-wasm
|
||||||
run: |
|
run: |
|
||||||
./lint
|
./lint
|
||||||
|
|
||||||
- name: Install cargo-llvm-cov
|
|
||||||
env:
|
|
||||||
CARGO_LLVM_COV_VERSION: "0.9.1"
|
|
||||||
run: |
|
|
||||||
case "$(uname -m)" in
|
|
||||||
aarch64|arm64)
|
|
||||||
arch="aarch64"
|
|
||||||
sha256="abf5f13c1520f8756d2192bfaaeadb0208f5b7eaa8cadc15bf847befa42b7360"
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
arch="x86_64"
|
|
||||||
sha256="b3f68e625481fed9b16444174f3fa5ebcdbde4a1878803a35eabe2dcefcdc41a"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
archive="cargo-llvm-cov-${arch}-unknown-linux-gnu.tar.gz"
|
|
||||||
curl -fsSL --retry 3 -o "$RUNNER_TEMP/$archive" \
|
|
||||||
"https://github.com/taiki-e/cargo-llvm-cov/releases/download/v${CARGO_LLVM_COV_VERSION}/${archive}"
|
|
||||||
echo "${sha256} $RUNNER_TEMP/$archive" | sha256sum -c -
|
|
||||||
tar -xzf "$RUNNER_TEMP/$archive" -C /usr/local/bin cargo-llvm-cov
|
|
||||||
cargo llvm-cov --version
|
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
working-directory: ./render-wasm
|
working-directory: ./render-wasm
|
||||||
env:
|
|
||||||
RENDER_WASM_COVERAGE: "true"
|
|
||||||
run: |
|
run: |
|
||||||
./test
|
./test
|
||||||
|
|
||||||
- name: Coverage summary
|
- name: Build
|
||||||
if: ${{ !cancelled() && hashFiles('render-wasm/target/coverage/lcov.info') != '' }}
|
working-directory: ./render-wasm
|
||||||
run: |
|
run: |
|
||||||
node scripts/coverage-summary.mjs \
|
NODE_ENV=production ./build frontend
|
||||||
--title "Render WASM test coverage" \
|
|
||||||
--note "Rust sources under \`render-wasm/src\`, measured by cargo-llvm-cov on the native test build." \
|
|
||||||
--lcov render-wasm/target/coverage/lcov.info \
|
|
||||||
> render-wasm/target/coverage/summary.md
|
|
||||||
cat render-wasm/target/coverage/summary.md >> "$GITHUB_STEP_SUMMARY"
|
|
||||||
|
|
||||||
- name: Coverage comment
|
- name: Check no invoke_*V in JS glue
|
||||||
# Fork PRs get a read-only token, so only branches of this repo comment.
|
working-directory: ./render-wasm
|
||||||
if: ${{ !cancelled() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && hashFiles('render-wasm/target/coverage/lcov.info') != '' }}
|
|
||||||
continue-on-error: true
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
||||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
||||||
run: |
|
run: |
|
||||||
node scripts/coverage-comment.mjs \
|
./check-no-invoke-v
|
||||||
--project "Render WASM" \
|
|
||||||
--lcov render-wasm/target/coverage/lcov.info \
|
|
||||||
--llvm-json render-wasm/target/coverage/summary.json
|
|
||||||
|
|
||||||
- name: Upload coverage report
|
|
||||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
||||||
if: ${{ !cancelled() }}
|
|
||||||
with:
|
|
||||||
name: render-wasm-coverage
|
|
||||||
path: render-wasm/target/coverage/
|
|
||||||
overwrite: true
|
|
||||||
if-no-files-found: ignore
|
|
||||||
retention-days: 7
|
|
||||||
|
|||||||
3
.github/zizmor.yml
vendored
3
.github/zizmor.yml
vendored
@ -17,12 +17,9 @@ rules:
|
|||||||
# Accepted: auto-label.yml needs pull_request_target so the GitHub App
|
# Accepted: auto-label.yml needs pull_request_target so the GitHub App
|
||||||
# secrets are available for PRs from forks. It never checks out or runs
|
# secrets are available for PRs from forks. It never checks out or runs
|
||||||
# PR code, it only reads ids from the event payload.
|
# PR code, it only reads ids from the event payload.
|
||||||
# prs-pre-validations.yml needs pull_request_target so it can close
|
|
||||||
# PRs from forks. It never checks out or runs PR code either.
|
|
||||||
dangerous-triggers:
|
dangerous-triggers:
|
||||||
ignore:
|
ignore:
|
||||||
- auto-label.yml
|
- auto-label.yml
|
||||||
- prs-pre-validations.yml
|
|
||||||
# Style nudge towards the `$/...` syntax; not worth enforcing.
|
# Style nudge towards the `$/...` syntax; not worth enforcing.
|
||||||
self-repository:
|
self-repository:
|
||||||
disable: true
|
disable: true
|
||||||
|
|||||||
7
.gitignore
vendored
7
.gitignore
vendored
@ -27,6 +27,7 @@ opencode.json
|
|||||||
!AGENTS.md
|
!AGENTS.md
|
||||||
!CODE_OF_CONDUCT.md
|
!CODE_OF_CONDUCT.md
|
||||||
!SECURITY.md
|
!SECURITY.md
|
||||||
|
!HIGHLIGHTS.md
|
||||||
/*.png
|
/*.png
|
||||||
/*.svg
|
/*.svg
|
||||||
/*.sql
|
/*.sql
|
||||||
@ -61,14 +62,11 @@ opencode.json
|
|||||||
/docker/images/bundle*
|
/docker/images/bundle*
|
||||||
/exporter/target
|
/exporter/target
|
||||||
/exporter/.shadow-cljs
|
/exporter/.shadow-cljs
|
||||||
/exporter/resources/wasm/
|
|
||||||
/exporter/src/app/wasm/shared.js
|
|
||||||
/frontend/.storybook/preview-body.html
|
/frontend/.storybook/preview-body.html
|
||||||
/frontend/.storybook/preview-head.html
|
/frontend/.storybook/preview-head.html
|
||||||
/frontend/playwright-report/
|
/frontend/playwright-report/
|
||||||
/frontend/playwright/ui/visual-specs/
|
/frontend/playwright/ui/visual-specs/
|
||||||
/frontend/text-editor/src/wasm/
|
/frontend/text-editor/src/wasm/
|
||||||
/frontend/coverage/
|
|
||||||
/frontend/dist/
|
/frontend/dist/
|
||||||
/frontend/npm-debug.log
|
/frontend/npm-debug.log
|
||||||
/frontend/out/
|
/frontend/out/
|
||||||
@ -122,8 +120,7 @@ opencode.json
|
|||||||
/.opencode/reports
|
/.opencode/reports
|
||||||
/.opencode/prompts
|
/.opencode/prompts
|
||||||
/.ci-logs
|
/.ci-logs
|
||||||
/tmp
|
/tmp/
|
||||||
/.codex/
|
/.codex/
|
||||||
/scripts/__pycache__/
|
/scripts/__pycache__/
|
||||||
/tools/__pycache__
|
/tools/__pycache__
|
||||||
/scripts/__pycache__
|
|
||||||
|
|||||||
10
.opencode/commands/create-pr.md
Normal file
10
.opencode/commands/create-pr.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
description: Create a PR for the current task branch or update an existing one — loads and follows the create-pr skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`create-pr`** skill and follow it as your only instruction.
|
||||||
|
|
||||||
|
## User input, overrides and additional context
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
10
.opencode/commands/implement-plan.md
Normal file
10
.opencode/commands/implement-plan.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
description: Execute a ready plan — task checklist, your confirmation, then all tasks with one commit (default) or step by step with a commit and a pause per task; creates issue + branch when on a base branch, or commits on the current branch with "direct" — loads and follows the implement-plan skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`implement-plan`** skill and follow it as your only instruction.
|
||||||
|
|
||||||
|
## User input, overrides and additional context
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
10
.opencode/commands/make-a-plan.md
Normal file
10
.opencode/commands/make-a-plan.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
description: Investigate the chosen task, produce an implementation plan, and save it — loads and follows the make-a-plan skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`make-a-plan`** skill and follow it as your only instruction.
|
||||||
|
|
||||||
|
## User input, overrides and additional context
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
6
.opencode/commands/resolve-git-conflicts.md
Normal file
6
.opencode/commands/resolve-git-conflicts.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
description: Resolve local git conflicts and stage the resolved files; never continues the rebase — loads and follows the resolve-git-conflicts skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`resolve-git-conflicts`** skill and follow it as your only instruction.
|
||||||
10
.opencode/commands/review-code.md
Normal file
10
.opencode/commands/review-code.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
description: Code review — review a diff, PR, or code change — loads and follows the review-code skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`review-code`** skill and follow it as your only instruction.
|
||||||
|
|
||||||
|
## User input, overrides and additional context
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
10
.opencode/commands/review-plan.md
Normal file
10
.opencode/commands/review-plan.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
description: Plan review — evaluate an implementation plan before executing it — loads and follows the review-plan skill
|
||||||
|
agent: build
|
||||||
|
---
|
||||||
|
|
||||||
|
Load the **`review-plan`** skill and follow it as your only instruction.
|
||||||
|
|
||||||
|
## User input, overrides and additional context
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
@ -1,342 +0,0 @@
|
|||||||
# Audit Log and event processing
|
|
||||||
|
|
||||||
Complete guide to the Penpot event system: what gets recorded, where each piece lives, and how events travel from the moment they happen until they are archived. Start with the overview (sections 1-3); the deeper technical detail comes later (section 8 on). If you only want the idea, the first three sections are enough.
|
|
||||||
|
|
||||||
> Note about this memory: unlike other Serena memories (dense notes written for LLM agents, see `mem:memory-maintenance`), this document is also written for human developers who need full context. That is why it uses plain language and examples. It replaces the old `mem:backend/audit-log`, which is now just a redirect stub.
|
|
||||||
|
|
||||||
## 1. What it is (2-minute overview)
|
|
||||||
|
|
||||||
The *audit log* answers "who did what, when, and from where". Every important user action becomes an **event**: a small object with a name, a type, who did it, from which IP, plus action data (`props`) and metadata (`context`).
|
|
||||||
|
|
||||||
The system has:
|
|
||||||
|
|
||||||
- **Three producers** (they create events): the Penpot backend (RPC layer), the Penpot frontend (browser app), and the Nitrate admin-console, which sends both server-side and client-side events.
|
|
||||||
- **One central buffer**: the Postgres `audit_log` table in Penpot. It is temporary: it holds events for minutes/hours until they are archived, then they are deleted.
|
|
||||||
- **Four consumers** (they read events): webhooks, error reporters, telemetry, and the external archives in Nexus and in the admin console.
|
|
||||||
- **Two long-term archives**: **Nexus**, a separate service that stores events for the long term, and the **admin console** (Nitrate), which ingests its own allowlisted events through a second archive job (see section 12).
|
|
||||||
|
|
||||||
```
|
|
||||||
Penpot frontend ─ POST push-audit-events (public) ─────────▶┐
|
|
||||||
Nitrate admin-console (browser) ─ POST push-audit-events ──▶│
|
|
||||||
Nitrate admin-console (server) ─ POST push-audit-events ──▶│ ─▶ audit_log table (buffer) ──┬─ cron 0s every 5m ──▶ Nexus (archive)
|
|
||||||
Penpot backend (RPC wrap-audit) ─ submit ───────────────────┘ │ └─ cron 30s every 5m ─▶ admin console (archive)
|
|
||||||
│ ├──▶ webhooks
|
|
||||||
│ ├──▶ error reporters
|
|
||||||
└──▶ telemetry (shadow rows)
|
|
||||||
```
|
|
||||||
|
|
||||||
The Penpot backend is the **center**: it checks, completes, and stores every event, no matter where it comes from. Nobody writes to the database directly; everything goes through the backend.
|
|
||||||
|
|
||||||
This document is the reference for all flows. One thing to keep in mind while reading: the Nitrate admin-console (both its server and its browser UI) is a **private** application, not a public client. Its events describe private SaaS management actions (organizations, subscriptions, SSO), and its server channel uses a trusted shared key instead of a user session.
|
|
||||||
|
|
||||||
## 2. The three kinds of events
|
|
||||||
|
|
||||||
Not all events are worth the same. This is the most important distinction in this document:
|
|
||||||
|
|
||||||
| Aspect | Backend events | Penpot frontend events | Nitrate admin-console events |
|
|
||||||
|---|---|---|---|
|
|
||||||
| What they describe | Real actions run on the server (create file, login, invite to team...) | Things that happen in the Penpot browser app (navigate, edit, JS errors, performance) | Organization and subscription actions in the admin-console (create/rename/delete organization, members, SSO settings, checkout, onboarding) |
|
|
||||||
| Trust level | **High**: created inside the same request that runs the action | **Best-effort**: some loss is expected (tab closed, offline, full buffer); they show **usage**, they are not strict proof | **Mixed**: server-side events are high trust (like backend); browser events are best-effort (like frontend) |
|
|
||||||
| Who sets `profile-id` | The server, from the logged-in session (never trusts the client) | The server too: it ignores what the client says and uses the session | Server channel: the trusted admin-console server sends it explicitly. Browser channel: the Penpot server uses the session |
|
|
||||||
| Who sets the time | Server time (`created-at`); the source of truth | Client proposes `tracked-at`, but the server fixes it if it is in the future or more than 1h late | Same rule: server stamps `created-at`; client `tracked-at` is corrected |
|
|
||||||
| Used for | Audit, webhooks, compliance, abuse checks | Product analytics, usage counters, crash reports | Organization audit trail (admin-console e2e spec), subscription metrics |
|
|
||||||
|
|
||||||
Rule of thumb: if you need to know for sure "did this user do X?", look at `source = backend`. If you want to know "how do people use the app?", also look at `source = frontend`.
|
|
||||||
|
|
||||||
## 3. The `audit_log` table: a buffer, not a store
|
|
||||||
|
|
||||||
The Penpot `audit_log` table **is not the final destination**. It is a waiting tray: events sit here until every active consumer (Nexus, admin console) confirms them, and whoever finishes last deletes the row.
|
|
||||||
|
|
||||||
Main columns (migration `backend/src/app/migrations/sql/0054-add-audit-log-table.sql` and later ones):
|
|
||||||
|
|
||||||
- `id` uuid PK (`gen_random_uuid()` today; the PK used to be `(created_at, profile_id)`).
|
|
||||||
- `name` / `type` text NOT NULL (for example `name = "create-file"`, `type = "action"`).
|
|
||||||
- `created_at` timestamptz NOT NULL default `now()`: **server time**, the source of truth.
|
|
||||||
- `tracked_at` timestamptz default `now()`: what the client claimed; fixed on ingest.
|
|
||||||
- `profile_id` uuid NOT NULL: who did it.
|
|
||||||
- `source` text: `backend` / `frontend` for full rows, `telemetry:backend` / `telemetry:frontend` for anonymized copies (see section 10).
|
|
||||||
- `ip_addr` inet: real IP (or `0.0.0.0` on telemetry rows).
|
|
||||||
- `props` / `context` jsonb holding transit-encoded maps: action data and metadata (versions, browser, request-id...).
|
|
||||||
- No `archived_at`: the `audit_log_pending` queue (migration `0157`, consumer `1` = Nexus, `2` = admin console, ids never reused) tracks what is left. Every record is born pending only for the consumers enabled at insert time (never a fixed both): cheaper on single-consumer hosts and true to the design doc. Consequence, accepted on purpose: rows born with no send flag on get no pendings, so enabling archiving later does not pick them up — the sweep deletes them unarchived.
|
|
||||||
|
|
||||||
Indexes (each consumer has its own, so a slow consumer never blocks the others):
|
|
||||||
|
|
||||||
- `audit_log_pending` PK `(consumer, audit_log_id)`: each consumer owns its queue at constant cost, even with millions pending.
|
|
||||||
- `audit_log (created_at, id)` (migration `0157`): the chronological drain order (`ORDER BY created_at ASC, id ASC`; same total order for both consumers, so concurrent drains cannot deadlock).
|
|
||||||
- `audit_log_pending (audit_log_id)`: serves the "is anything still pending?" check of the final delete.
|
|
||||||
- `(source, created_at)`: used by the telemetry scan.
|
|
||||||
|
|
||||||
Life of a row: `INSERT` (row plus one pending per enabled consumer, same transaction; a rollback takes both) → (every 5 min, Nexus at second 0 and admin console at second 30) each archive job sends its own 128-row batches oldest-first and deletes its pendings in the same transaction → whoever deletes the last pending deletes the row. A batch the destination refuses rolls back and stays for the next tick. Pendings of consumers that are off are reaped at the start of each job run (covers later deactivations), and orphan rows are swept at the end of each run, so there is no separate GC task. The FK is plain `DEFERRABLE` (never `INITIALLY DEFERRED`): every deleter removes pendings before rows, including the telemetry task's own deletes.
|
|
||||||
|
|
||||||
## 4. Anatomy of an event
|
|
||||||
|
|
||||||
Every event ends up with this shape (schema `schema:event` in `backend/src/app/loggers/audit.clj`):
|
|
||||||
|
|
||||||
- `name`: what happened (`"create-file"`, `"navigate"`, `"create-organization"`...). For backend, it defaults to the RPC command name (prefixed with `<module>-` outside `main`).
|
|
||||||
- `type`: category (`"action"`, `"identify"`, `"trigger"`). Most are `"action"`.
|
|
||||||
- `profile-id`: **who** did it (uuid). See the invariant in section 5.
|
|
||||||
- `ip-addr`: request IP (or `"0.0.0.0"` on telemetry).
|
|
||||||
- `props`: action data (team/project/file ids, visited route...). **Never secrets** (see `clean-props`).
|
|
||||||
- `context`: metadata about how/when it was captured (backend/frontend version, user-agent, locale, browser, `request-id`, `initiator`, `event-origin`...). See section 8 for the full field guide, including `initiator` (which app started it: `"app"` means Penpot itself).
|
|
||||||
- `source`: `backend`, `frontend`, `telemetry:backend`, `telemetry:frontend`. Nitrate admin-console server events land as `backend`; its browser events land as `frontend` (see section 7).
|
|
||||||
- `source`: `backend`, `frontend`, `telemetry:backend`, `telemetry:frontend`.
|
|
||||||
- `tracked-at` / `created-at`: claimed time and server time.
|
|
||||||
- Memory-only (never stored): `::webhooks/event?`, `::webhooks/batch-key`, `::webhooks/batch-timeout` for the webhook fan-out.
|
|
||||||
|
|
||||||
Backend `create-file` example (simplified):
|
|
||||||
|
|
||||||
```clojure
|
|
||||||
{:name "create-file" :type "action" :source "backend"
|
|
||||||
:profile-id #uuid "…" :ip-addr "203.0.113.7"
|
|
||||||
:props {:project-id #uuid "…" :name "My design"}
|
|
||||||
:context {:version "2.x" :initiator "app" :request-id "…"
|
|
||||||
:client-version "2.x" :client-user-agent "Mozilla/…"}
|
|
||||||
:created-at #inst "…" :tracked-at #inst "…"}
|
|
||||||
```
|
|
||||||
|
|
||||||
Frontend `navigate` example:
|
|
||||||
|
|
||||||
```clojure
|
|
||||||
{:name "navigate" :type "action" :source "frontend"
|
|
||||||
:profile-id #uuid "…" :ip-addr "203.0.113.7"
|
|
||||||
:props {:route "dashboard" :team-id #uuid "…"}
|
|
||||||
:context {:version "2.x" :locale "en" :browser "Chrome" :os "Linux"
|
|
||||||
:event-origin "dashboard" :session-id "…" :session #inst "…"}
|
|
||||||
:created-at #inst "…" :tracked-at #inst "…"}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 5. Backend events: the happy path
|
|
||||||
|
|
||||||
Most backend events need **no manual code**. The `wrap-audit` wrapper in `backend/src/app/rpc.clj` runs after every RPC command when `:webhooks`, `:audit-log`, or `:telemetry` is on (unless the command sets `::audit/skip`). It builds the event with `prepare-rpc-event` and passes it to `audit/submit`.
|
|
||||||
|
|
||||||
Each command can customize through result metadata (`rph/with-meta`):
|
|
||||||
|
|
||||||
- `::audit/replace-props`: replaces props fully (auth commands use `profile->props` so a register event carries the profile, not the password).
|
|
||||||
- `::audit/props`: merges extras over the request params.
|
|
||||||
- `::audit/context`, `::audit/profile-id`, `::audit/name`, `::audit/type`: override the defaults.
|
|
||||||
- `clean-props` always strips nils, namespaced keys, and `:session-id/:password/:old-password/:token/:client-secret` as a last line of defense. **Never put secrets in props.**
|
|
||||||
|
|
||||||
Critical `profile-id` INVARIANT: the event belongs to **whoever made the request**. It resolves as `::audit/profile-id` metadata → `::rpc/profile-id` → `uuid/zero`. It is **never** taken from the response: some results carry someone else's `:profile-id` (for example `get-error-report` returns the report with its content merged; `verify-token` on an invitation returns the inviter), and using it would blame the wrong person. Commands with `::rpc/auth false` (`login-*`, `register-profile`, `create-demo-profile`, `verify-token`, `prepare-register-profile`) have no caller to fall back on, so they **must** set `::audit/profile-id` in the metadata or the event lands on `uuid/zero`.
|
|
||||||
|
|
||||||
The `::audit/profile-id` override goes through `coerce-profile-id`: a string is parsed, anything that cannot become a uuid is dropped (with a warning) and the event falls back to the caller. Do not pass the value raw: `schema:event` needs a uuid and `submit*` swallows the validation error (it only logs, the RPC still succeeds), so a non-uuid override **loses the row silently**. Hand-built events with `event-from-rpc-params` + `submit` (clone template, accept team invitation, `management/nitrate` push-audit-events) do **not** go through that coercion: they must already carry a uuid.
|
|
||||||
|
|
||||||
### Team id and entity ids (projection data)
|
|
||||||
|
|
||||||
The event stream is meant to let a consumer (Nexus) rebuild what it needs **without joining production tables**, so events carry the ids a projection keys on:
|
|
||||||
|
|
||||||
- **Team id enrichment.** After `clean-props`, `prepare-rpc-event` calls `enrich-team-id`: when props have no `:team-id` but carry a `:project-id` or `:file-id`, it resolves the team with a local query and adds `:team-id`. It never resolves from `:id` (read commands put the entity id there, and that would add a query to every read), and it skips read events entirely (`get-*` names plus `has-file-libraries`: their events carry no consumer state). Commands that already loaded the team add `:team-id` themselves in `::audit/props` (`delete-file`, comments, media upload, `delete/update-webhook`, `clone-template`, ...), so the resolver does not run.
|
|
||||||
- **Membership.** `add-profile-to-team!` emits `add-team-member` (props `:team-id`, `:member-id`, `:role`, `:is-owner`, `:is-admin`, `:can-edit`) whenever it actually inserts a row, only with `:audit-log` on, inside the caller's transaction. It covers the flows that add a member with no event of their own (`create-team` owner, invitee added directly when `:email-verification` is off, approved join-request, duplicated team). With `on-conflict-do-nothing?` a conflict returns nil and emits nothing, so an existing membership is reported once. The event belongs to the actor: the two flows where the owner adds somebody else (`create-invitation`, `add-member-to-team`) pass `:actor-id` through a separate `event-opts` arg (never in `params`, which is inserted as-is); everywhere else actor and member coincide. `:role` is derived in the emitter from the flags (inverse of `permissions-for-role`: owner > admin > editor > viewer) because the table has no role column; request context travels in `event-opts` as `:rpc-params`.
|
|
||||||
- **Created entity ids.** `create-project` and `create-file` add the new row's `:id` (and `:project-id`/`:team-id`) to `::audit/props`, so a projection can key it.
|
|
||||||
- **Bulk operations.** `clone-template`, `import-binfile` and `duplicate-project` create entities through internal calls that emit nothing on their own; they emit a `create-file` (and `create-project`) per entity (only with `:audit-log`). The import paths go through `audit/submit-file-created-event`, which reads the light columns (`id`, `name`, `project-id`, timestamps, `revn`) back from the row — the file must really exist, a phantom id emits nothing. `duplicate-project` already holds the rows and uses `audit/submit-create-event` directly. Both binfile versions return the same shape from `import-files!` (`{:file-ids [...]}`).
|
|
||||||
- **Deletes.** `delete-team` still returns nil but carries the deleted row (`:id`, `:name`, `:created-at`, `:modified-at`, `:deleted-at`) in `::audit/props`, like `delete-project`. `delete-profile` carries `:id`, `:email`, `:fullname`, `:created-at`, `:modified-at` and `:deleted-at` (without this its props are empty: every param is namespaced and `clean-props` drops them). `create-team` adds `:created-at` and `:modified-at`. `delete-team-member` needs nothing: the delete is physical and the params already carry `:team-id`/`:member-id`.
|
|
||||||
- **Hard deletes.** `objects-gc` emits one `hard-delete-objects` event per purged chunk, carrying only that chunk's entity key (`:team-ids`, `:project-ids` or `:file-ids`; one chunk transaction purges a single entity, so one event can never span sections) with context `{:triggered-by "objects-gc"}`, only with `:audit-log` on. No other GC path emits (profiles, fonts, thumbnails); those purges stay silent.
|
|
||||||
- **SREPL deletes.** `delete-profile!` carries the subject id in props (it used to emit nothing usable); the event profile stays zero because SREPL has no actor. `delete-team!` props already carried the id. Both travel as actions with a `triggered-by: srepl` context.
|
|
||||||
- **SREPL restores.** `restore-profile!` carries the full row (with id) in props with a zero event profile; `restore-team!` and `restore-project!` already carried their ids. The consumer resolves the subject from props by a uniform rule, with no SREPL special case.
|
|
||||||
- **Cascades.** The `:delete-object` worker task emits one `delete-object-with-cascade` event per execution, type `action`, with `:object`/`:id`/`:deleted-at` plus the affected ids nested under `:cascade` (`:team-ids`, `:project-ids`, `:file-ids`), in the same transaction. The handler submits unconditionally (`submit` fans out per flag, so no `:audit-log` re-check); the `audit_log` row itself is still only written with `:audit-log` on. Direct calls (objects-gc) and snapshot cascades stay silent on purpose.
|
|
||||||
- **Ownership.** `create-team-with-invitations` carries the new team `:id` like `create-team`; `update-team-member-role` names the demoted member in `:prev-owner-id` on owner transfers.
|
|
||||||
|
|
||||||
Entry points:
|
|
||||||
|
|
||||||
- `submit`: the normal one (fills defaults, validates, runs inside `tx-run!`, never breaks the RPC).
|
|
||||||
- `insert`: low level, for CLI helpers and the webhook subsystem; direct write, no webhook/telemetry fan-out, silent unless `:audit-log` is on.
|
|
||||||
- Boot emits `trigger/instance-start` from `setup/props` so every restart stays visible.
|
|
||||||
|
|
||||||
Cases already covered by tests, do not break: `accept-organization-invitation` tells its two flows apart **with props, not with origin**: `:organization-member-add-source` is `"direct-organization-invitation"` or `"team-invitation"`, and `:belongs-to-team-on-add` repeats it as a boolean. Do not add a third prop. The `context` `:event-origin` belongs to the browser (`make-data-event` sets it and it is on the frontend allowlist; `safe-backend-context-keys` has no `:event-origin`, so a backend event has nowhere to put one).
|
|
||||||
|
|
||||||
## 6. Penpot frontend events: what is collected, with what guarantees
|
|
||||||
|
|
||||||
The browser **never writes to the table**; it POSTs transit batches to `push-audit-events` (`backend/src/app/rpc/commands/audit.clj`), which stamps server `id`, session `profile-id`, request IP, server `created-at`, and server-side `:initiator` (from the `x-client` header, see section 8; anything the client sends as `initiator` is overwritten), and distrusts the client clock (future or >1h-late `tracked-at` is reset, the original kept in `context.original-tracked-at`). Without `:audit-log`/`:telemetry`, or on a read-only pool, the endpoint is a no-op.
|
|
||||||
|
|
||||||
Valid types (`schema:frontend-event`): `"action"`, `"identify"`, `"trigger"`. Names must match `#"[\d\w-]{1,50}"` (max 250). `props` is a free map with no schema: **tests are the only guard of the contract** (see section 13).
|
|
||||||
|
|
||||||
What they are for: usage metrics (navigation, editing), workspace file stats, Nitrate membership changes, crash reports (`unhandled-exception` / `exception-page`). **Not proof for audit**: collection is best-effort and includes `PerformanceObserver` noise (`performance-*`, `user-input`, `long-task`). So backend tests must never assert exact frontend event counts.
|
|
||||||
|
|
||||||
How the browser collects (`frontend/src/app/main/data/event.cljs`), most to least important:
|
|
||||||
|
|
||||||
1. **On-demand start**: `initialize` asks the backend with `get-environment-data` (old `get-enabled-flags` is deprecated) and only starts on `:audit-log` or `:telemetry`. On RPC failure it still starts in telemetry mode (the backend will reject if needed).
|
|
||||||
2. **Potok translation**: `make-proto-event` (events with the `Event` protocol) and `make-data-event` (data-events with `::name`) turn the action into `{type, name, props, context}`. `simplify-props` flattens complex values (maps → `:placeholder/map`, and so on) and drops namespaced keys and nils. Context gains `:event-origin`, `:event-namespace`, `:event-symbol`.
|
|
||||||
3. **Capped buffer**: queue of max 1024 events (`append-to-buffer` drops beyond that); every 2s debounce (or on logout, or `::force-persist`) a chunk of max 100 is taken, filtered to the current profile, and sent fire-and-forget to `api/main/methods/push-audit-events` as transit. On confirm, the chunk leaves the buffer (`::chunk-persisted`).
|
|
||||||
4. **Performance noise**: `PerformanceObserver` (`event`/`longtask`) plus blocking measurement with `scheduler.postTask` create `trigger` events (`performance-blocking-event`, `user-input`, `long-task`) with 1s debounce and 1s threshold. Info only, not audit.
|
|
||||||
5. **`skip-audit?`**: UI flag (for example resuming a pending dashboard action after Nitrate SSO, or moving a team into an organization) so one user gesture is not counted twice.
|
|
||||||
|
|
||||||
## 7. Nitrate admin-console events: the third producer
|
|
||||||
|
|
||||||
The admin-console is the third producer. It sends organization and subscription events through **two channels** that look the same once stored, but have different trust levels. All the sending code (server and browser helpers) lives in the private Nitrate repo: it is not Penpot code and no file paths are cited here. What this section documents is only the Penpot-visible side: endpoints, payloads, and which event names arrive.
|
|
||||||
|
|
||||||
### 7a. Server-side channel (high trust, like backend events)
|
|
||||||
|
|
||||||
Code: the admin-console server has a helper that POSTs to the Penpot **management** API:
|
|
||||||
|
|
||||||
```
|
|
||||||
POST api/management/methods/push-audit-events
|
|
||||||
headers: x-shared-key: "admin-console <key>", Cookie: <user cookies>
|
|
||||||
body: {events: [{name, props, profileId, context?}]}
|
|
||||||
```
|
|
||||||
|
|
||||||
Auth happens at the HTTP layer (`backend/src/app/http/middleware.clj` `wrap-shared-key-auth`): the `x-shared-key` header carries `"<key-id> <secret>"` (`admin-console` here), checked in constant time against the configured keys; the key-id lands in the event context as `:initiator`. The call goes server-to-server (ky client, internal URI, user cookies forwarded).
|
|
||||||
|
|
||||||
Who uses it:
|
|
||||||
|
|
||||||
- Organization management (best-effort wrapper): `create-organization`, `rename-organization`, `delete-organization`, member add/remove, and more. It optionally passes the UI origin in the context.
|
|
||||||
- Subscriptions: `create-subscription`, renewals, cancellations, and more, including deployment lookup (saas/selfhost).
|
|
||||||
|
|
||||||
Failure policy: every send is best-effort. A failure never rolls back the business action; it is only recorded for debugging.
|
|
||||||
|
|
||||||
Backend side (`backend/src/app/rpc/management/nitrate.clj` `::push-audit-events`): `::audit/skip`, `::rpc/auth false` (trust comes from the shared key, not from a user session; only the `admin-console` key id is allowed). It builds context with `audit/prepare-context-from-request` + `request-id`, takes the given `profile-id` as-is (no coercion here, must already be a uuid), sets `tracked-at = request-at`, defaults `type` to `"action"`, and calls `audit/submit` (which defaults `source` to `"backend"`). So these rows land as **`source = backend`**: they are audited like backend events because a trusted service set the author.
|
|
||||||
|
|
||||||
### 7b. Browser channel (best-effort, like frontend events)
|
|
||||||
|
|
||||||
Code: the admin-console browser has a helper that POSTs to the Penpot **public** API:
|
|
||||||
|
|
||||||
```
|
|
||||||
POST api/main/methods/push-audit-events
|
|
||||||
credentials: include, keepalive: true
|
|
||||||
headers: x-client: "penpot-admin-console/<version>"
|
|
||||||
body: {events: [{name, type: "action", timestamp, props, context: {eventOrigin?}}]}
|
|
||||||
```
|
|
||||||
|
|
||||||
Dozens of helpers cover the admin-console UI: `create-organization`, `delete-organization-member`, `create-subscription` / `create-trial-subscription`, `open-subscription-modal`, `start-nitrate-checkout`, `open-current-subscription`, SSO settings flows (`open/apply/success/fail/discard-organization-sso-changes`, activate/deactivate modals), `change-organization-advanced-permission`, `onboarding-step` / `onboarding-finish`, `close-subscription-modal`. These helpers live in the private Nitrate repo: they are not Penpot code, you will not find them in this repository. Only the event names above (what arrives at Penpot) are listed here on purpose.
|
|
||||||
|
|
||||||
These rows land as **`source = frontend`** with the session `profile-id`: same guarantees as Penpot frontend events (best-effort, usage analytics). Every browser helper sends an `eventOrigin` in the context: plain `"admin-console"`, with a suffix only when the same event is emitted from two places in the app (for example the SSO discard event distinguishes the config form from the unsaved-changes modal).
|
|
||||||
|
|
||||||
The Nitrate repo also has a shared, generic push client for the management endpoint (not tied to the admin-console server): any other Nitrate-side service that needs to record something in the Penpot audit log can reuse it instead of writing its own HTTP call. Same endpoint, same payload shape as the server channel above.
|
|
||||||
|
|
||||||
## 8. How the frontend helps the backend audit: HTTP headers
|
|
||||||
|
|
||||||
Besides explicit events, **every RPC request from the frontend carries headers** so the backend can fill its own event `context`. This is how the backend learns "which browser/version/screen" made the request:
|
|
||||||
|
|
||||||
- `x-frontend-version` and `x-client: penpot-frontend/<version>`: added by `default-headers` in `frontend/src/app/util/http.cljs` to **all** fetch requests (unless `omit-default-headers`). The admin-console browser channel sends `penpot-admin-console/<version>` instead (`x-frontend-version` is ignored on the event-ingest path, only `x-client` matters there).
|
|
||||||
- `user-agent`: set by the browser alone; the backend trims it to 500 chars (`get-client-user-agent`).
|
|
||||||
- `x-external-session-id`: external SaaS session via `cf/external-session-id`; added by `repo.cljs` (`send!`, special `cmd!`, `multipart-upload`, export...) and also stored by `persist-events` in the frontend event context. The backend checks it (max 256, ignores `"null"`/empty).
|
|
||||||
- `x-session-id`: `cf/session-id` (tab session), only in the main `send!`.
|
|
||||||
- `x-event-origin`: UI origin (`::ev/origin` from param metadata, for example `"dashboard"`, `"workspace"`); sent by `send!` and the OIDC/export/upload `cmd!`. The backend trims it to 200 chars and stores it as `:client-event-origin` (different from the `:event-origin` the frontend puts in its own context!).
|
|
||||||
|
|
||||||
On the backend, `prepare-context-from-request` (`backend/src/app/loggers/audit.clj`) joins everything into the event context: `:external-session-id`, `:initiator` (`auth-key-id` or `"app"`), `:access-token-id/type`, `:client-event-origin`, `:client-user-agent`, `:client-version`, `:version` (backend), plus `:request-id`. Only `safe-backend-context-keys` (`:version`, `:initiator`, `:client-version`, `:client-user-agent`) survive in the telemetry shadow copy; the rest (`:client-event-origin`, `:external-session-id`, `:access-token-id/type`, `:request-id`...) is stored fully in the normal row and sent to Nexus, but dropped from telemetry.
|
|
||||||
|
|
||||||
### Context field guide: `initiator`
|
|
||||||
|
|
||||||
`initiator` labels the application that started a request. The server sets it on both channels, but only the shared-key channel authenticates the sending application:
|
|
||||||
|
|
||||||
- **Backend channel** (RPC + management API): it comes from the shared-key auth layer (`wrap-shared-key-auth` in `backend/src/app/http/middleware.clj`): when a trusted service calls the management API with `x-shared-key: "<key-id> <secret>"`, the key-id (lowercased) is stored on the request as `::http/auth-key-id`, and `prepare-context-from-request` copies it into `:initiator`. When there is no shared key (a normal user RPC), it falls back to `"app"`, which means Penpot itself.
|
|
||||||
- **Frontend channel** (`push-audit-events`): `get-client-initiator` maps the `x-client` header product to an initiator: `penpot-frontend` → `"app"`, `penpot-admin-console` → `"admin-console"`, legacy `penpot-nitrate` (old admin-console releases, remove once redeployed) → `"admin-console"`, missing or unknown → `"app"`. It overwrites any `initiator` in the event context, but the caller controls the header. Any authenticated caller can claim `"admin-console"` by sending that product in `x-client`. Use this label for usage analytics; it does not prove which application sent the event or grant permissions. The session still determines `profile-id`.
|
|
||||||
|
|
||||||
Values you will see:
|
|
||||||
|
|
||||||
- `"app"`: normal Penpot traffic (browser → public RPC or event ingest, or backend internal work). This is the vast majority.
|
|
||||||
- `"admin-console"`: the authenticated Nitrate admin-console on management API calls (section 7a), or a caller claiming that product on browser events (section 7b, via the `x-client` mapping).
|
|
||||||
- `"nexus"`, `"exporter"`, `"media-processor"`: other first-party services using their own shared keys (key ids come from `::setup/shared-keys` in `backend/src/app/setup.clj`, derived from the instance secret unless overridden).
|
|
||||||
|
|
||||||
Why it matters: it supports per-application usage counts, with the trust level described above. It survives into telemetry on both channels (one of the four backend keys, and on the frontend allowlist too), so per-initiator counts stay available even on anonymized rows.
|
|
||||||
|
|
||||||
More metadata the Penpot frontend adds inside each event (not as headers): `collect-context` with `ua-parser` (browser, engine, OS, device, screen, CPU arch), `locale` (updated on language change), `:session` / `:session-id` / `:external-session-id`, and SaaS host extras (`add-external-context-info`).
|
|
||||||
|
|
||||||
## 9. Consumers I: webhooks
|
|
||||||
|
|
||||||
Webhooks let an external URL get notified when something happens in a team (for example "a file was created"). The flow has three steps:
|
|
||||||
|
|
||||||
1. **Match.** Some audit events are marked as webhook-relevant when they are created. For each of those, Penpot looks up the active webhooks of the affected team: it reads the team straight from the event, or finds it through the project or the file in the event. Each matching webhook gets its own delivery job. If several quick events belong together, they are grouped into one delivery (the grouping rule travels with the event itself).
|
|
||||||
2. **Deliver.** Penpot POSTs the event to the webhook URL in the format that webhook asked for: JSON (with camelCase keys), transit, or form-encoded. Every attempt is written to a delivery log with the request, the response, and the error if any, so failures can be inspected later.
|
|
||||||
3. **Protect.** Each webhook counts its consecutive failures. After 3 in a row, Penpot switches the webhook off automatically, so a dead URL stops receiving traffic until someone fixes it. A successful delivery resets the counter to zero.
|
|
||||||
|
|
||||||
One guarantee: sending webhooks never changes the audit event itself. If delivery fails, only the webhook (and its delivery log) is affected; the audit row stays untouched and still gets archived normally.
|
|
||||||
|
|
||||||
Every match also writes a `webhook` / `trigger` row to `audit_log` (even with zero matches): its props are `{:name <origin event name>, :event-id <origin row id>, :total-affected <matched webhook count>}`. `process-event` assigns the origin row id up-front so the trigger can reference it; the telemetry shadow row always gets its own id (reusing it would collide on the PK).
|
|
||||||
|
|
||||||
## 10. Consumers II: error reporters
|
|
||||||
|
|
||||||
Both `app.loggers.database` and `app.loggers.mattermost` listen to backend `:error` logs **and** frontend crash events (found by the `::audit/event` marker), through a sliding-buffer channel so a flood cannot stall the app. The database one stores them in `server-error-report` (source 3 = backend log, 4 = audit-log origin, 5 = rate-limit); the Mattermost one forwards a short note to `:error-report-webhook` when set.
|
|
||||||
|
|
||||||
Both reporters only start when the `:error-reporting` flag is on (off by default). The database reporter starts on the flag alone; the Mattermost reporter needs the flag **plus** its webhook URL configured. Without the flag, nothing is stored and `emit` calls from `push-audit-events` are silent no-ops. Each reporter also keeps a runtime on/off switch for emergencies via REPL.
|
|
||||||
|
|
||||||
Result: crash reports only exist if the frontend collector runs and `push-audit-events` accepts `unhandled-exception`/`exception-page`. Turning off the whole pipeline also blinds frontend error reporting.
|
|
||||||
|
|
||||||
## 11. Consumers III: telemetry (shadow rows)
|
|
||||||
|
|
||||||
Telemetry reuses the same table with **anonymized shadow rows** (`source LIKE 'telemetry:%'`): day-truncated times, `0.0.0.0` IPs, props reduced to uuid/boolean/number values plus a few allowed fields (`source`, `lang`, `auth-backend`, `activation`, derived `email-domain` — never raw emails), and a minimal context allowlist. Full + shadow rows can exist together per event when both flags are on; that duplication is on purpose.
|
|
||||||
|
|
||||||
Filters (`filter-telemetry-props` / `filter-telemetry-context`): by default only uuid/boolean/number with a simple key; exceptions: login/register/update-profile and frontend `identify` keep `lang`/`auth-backend`/`source`/`activation`/`email-domain`; `organization-sso-auth-failed` keeps `failure-reason` if it is a known one; `instance-start` passes whole; frontend `navigate` keeps `[:route :file-id :team-id :page-id]`. Subscription actions have event-specific contracts: backend and frontend `create-subscription` / `create-trial-subscription` preserve the default uuid/boolean/number props plus `type`, `deployment`, `quantity` and `subscription-mode`; backend `update-subscription` preserves only `type`, `deployment`, `previous-status`, `status`, `previous-cancel-at-period-end`, `cancel-at-period-end`, `previous-cancel-at`, `cancel-at` and `changed-fields`; backend `subscription-summary` preserves only `type`, `deployment`, `instance-id`, `snapshot-date`, the per-status `*-count` values, `total-count`, `sync-succeeded`, `sync-failed` and `snapshot-complete`. These subscription exceptions apply only to action events. Other free text drops from telemetry but **stays in the full row and in Nexus**. In `register-profile`, `activation` is a prop (it is what reaches PostHog). `action` exists only in the `context` of the full `register-profile-retry` rows; `filter-telemetry-context` drops it from the anonymised copy, which keeps only `:version`, `:initiator`, `:client-version` and `:client-user-agent`.
|
|
||||||
|
|
||||||
Shipping (`backend/src/app/tasks/telemetry.clj`): the cron sends shadows to `:telemetry-uri` as JSON in 10k batches and **deletes** them on success; it purges leftovers older than 7 days. It also sends a legacy report (counters, teams, email domains...). On official hosts nothing is collected or sent (`telemetry-excluded?` covers `penpot.app`/`penpot.dev`).
|
|
||||||
|
|
||||||
### Where telemetry events go: `telemetry.penpot.app` is Nexus
|
|
||||||
|
|
||||||
The default `:telemetry-uri` (`https://telemetry.penpot.app/`) points at the **Nexus telemetry endpoint**, so telemetry is a second road into Nexus, separate from the archive cron. The payload is plain JSON:
|
|
||||||
|
|
||||||
```
|
|
||||||
POST https://telemetry.penpot.app/
|
|
||||||
{type: "telemetry-events", version, instance-id, events: [...]}
|
|
||||||
```
|
|
||||||
|
|
||||||
Nexus dispatches on `:type`: `"telemetry-events"` batches are coerced and inserted into its own `audit_log`; anything else (old flat payloads, `"telemetry-legacy-report"`) is upserted into `telemetry_report` per instance + day. Three details matter:
|
|
||||||
|
|
||||||
- **Anonymization happens in Penpot, before sending.** By the time events leave, times are day-truncated, IPs are already `0.0.0.0`, props/context are filtered (see above), and emails are gone (only derived `email-domain` survives). Nexus additionally forces the outcome: it prefixes any non-`telemetry:` source, sets `received-at = tracked-at` (already truncated), pins IP to `0.0.0.0`, and stamps the sending `instance-id` into every event context.
|
|
||||||
- **No personal data is expected.** Profile ids are random UUIDs with no PII, so the telemetry consumer needs no login guard; grouping is by `instance`, not by person (see posthog-telemetry below).
|
|
||||||
- **The endpoint always answers 200.** Failures are swallowed and only counted (`nexus_telemetry_errors_total`), so a bad batch never breaks the sending instance; successes are counted (`nexus_telemetry_events_total`, `nexus_telemetry_reports_total`). A body the parser cannot read never reaches the handler: it answers 400 and counts in `nexus_http_malformed_requests_total`. Old instances may send a fressian+zstd base64 blob instead of a plain vector; Nexus decodes both (50 MiB cap against decompression bombs).
|
|
||||||
|
|
||||||
## 12. Archive to Nexus and to the admin console
|
|
||||||
|
|
||||||
### How it works today
|
|
||||||
|
|
||||||
Every 5 min each archive job drains its own queue (`:audit-log-consumer-nexus` on flag `:nexus`, cron `0 */5 * * * ?`; `:audit-log-consumer-admin-console` on flag `:admin-console`, cron `30 */5 * * * ?`, 30s offset so the two drains never start on the same second), in 128-row chunks taken oldest-first (`ORDER BY created_at ASC, id ASC`) with `FOR UPDATE OF audit_log` (`SET LOCAL lock_timeout = '30s'`) inside the same transaction that sends and completes them, with 100 ms pauses between chunks. Batches arrive at Nexus in chronological order (it numbers by arrival for order-sensitive consumers). Nexus receives transit `{:events [...]}` with `x-shared-key: "nexus <key>"` (`:nexus-shared-key`, or derived from the instance secret) and `origin` = public-uri; flag on but no URI raises `:task-not-configured`. The admin console receives only its allowlisted event names (enriched with team names, props emails, and optional top-level `:profile-email` / `:profile-name` from the actor `:profile-id`); anything filtered out counts as done for the admin-console queue. A chunk whose destination refuses it (Nexus non-204 raises `:consumer-chunk-refused`) or throws (transport failure, admin-console error) rolls back and stays for the next tick, and the job aborts as failed: it archives what it can, and the cron retries the rest. Committed chunks stay sent. The send fns return counts or throw carrying the attempted count as `:events`; `run-single-consumer` records the `failed` metric from it, outside every chunk transaction (a local DB failure carries no `:events` and stays uncounted — it is not a destination failure). No `warn` before the throw: the runner reports the aborted job. Each job touches only its own queue, so a fallen Nexus never starves the admin console (nor vice versa).
|
|
||||||
|
|
||||||
A chunk is **one POST** and the task advances only on 204, so a single oversized event wedges the whole queue: a crash report whose message embeds a whole payload (a serialized file, for example) can push the request past the proxy body limit and the rejection blocks every later event until it is pruned by hand. Frontend crash reports are therefore size-bounded at the source (`mem:frontend/routing-app-shell-subtleties`): `app.common.exceptions/get-hint` and the CLJS `format-throwable` clamp exception messages (`max-message-length`).
|
|
||||||
|
|
||||||
On the other side, Nexus checks `origin` against its allowlist (403 if not allowed), coerces the events, and inserts them into its own `audit_log` (partitioned by `received_at`, with an incrementing sequence number and `source`). Watch the rename: Penpot's `created-at` is stored as **`received-at`** in Nexus; Nexus's `created-at` is when it was created there. `tracked-at` keeps the origin time. Telemetry batches arriving at `telemetry.penpot.app` land in the same table through the telemetry endpoint above.
|
|
||||||
|
|
||||||
Concurrent jobs are safe: both lock rows in `created_at ASC, id ASC` order (one total order, deliberately blocking — no `SKIP LOCKED`, so archive arrival stays chronological), so the second waits for the first to commit and then sees whether it was last. Only acknowledged work deletes pendings; an admin-console failure never blocks the Nexus send of the same rows (each job owns its queue).
|
|
||||||
|
|
||||||
Observability (`backend/src/app/loggers/audit/consumer_task.clj`, definitions in `backend/src/app/main.clj:default-metrics`): one `dbg` summary per job run (`:consumer` label, sent/skipped/chunks, reaped disabled pendings, swept orphans, `:elapsed` as `"1.5s"` via `ct/format-duration`, frozen in a strict binding first because log props evaluate lazily in the logger thread), one `dbg` per admin-console send call (`ready` with totals, `sent`/`failed` with counts), plus `dbg` when the queue is empty or the job's send flag is off. Queue depth is Grafana's business: it queries the database directly, so the run performs no `GROUP BY` for the logs. No `warn` before a throw: the runner reports the aborted job (refusal details travel in the error data). Metrics, all recorded with bounded labels only: `penpot_audit_consumer_events_total{ destination = nexus|admin-console, outcome = archived|failed|skipped }` (`skipped` = filtered by the admin-console allowlist) and `penpot_audit_consumer_discarded_total{ reason = reaped|swept }` (entries discarded without archiving: `reaped` counts pendings dropped for disabled consumers, `swept` counts rows deleted while nobody waited for them — the silent R3 loss, now dashboard-visible instead of log-only). Timing needs no custom histogram: the jobs substrate already records execution time per job (`jobs-execution-timing`, split by job name), so each archive job is timed as itself. No queue-depth gauge: pending depth is read off the replica database directly. The bulk frontend ingest counts `penpot_audit_ingest_events_total{ kind = full|shadow, outcome = inserted|failed }` (both faces share one transaction, so a failure drops the batch on both). Archive success counts are recorded by `run-single-consumer` on the drain totals: a chunk that returns normally committed its transaction (a rollback always throws instead), so they cannot inflate. Logs never carry event data (`props`, `context`, `profile-id`, `ip-addr`, `team-name`, emails): only counts, statuses and the uri host.
|
|
||||||
|
|
||||||
### How Nexus consumes the data (and forwards to PostHog)
|
|
||||||
|
|
||||||
Stored rows are not the end: a consumer pipeline reads them back in sequence order and processes them. Each consumer remembers its place (sequence number), fetches the next chunk, runs its handler, then saves the new position. Three consumers run in order:
|
|
||||||
|
|
||||||
1. **`local`**: keeps a mirror of user profiles. It listens to profile events (`register-profile`, `update-profile`, `login-with-*`, `delete-profile`, ...) and upserts email, name, props, and delete markers. It runs first because the next consumer needs profile data.
|
|
||||||
2. **`posthog`** (runs after `local`): forwards our own SaaS archived events to PostHog. It sends an allowlist of backend track events (teams, members, projects, files, comments, Nitrate/SSO, ...) plus frontend events minus a noise exclusion list, grouped by **team**, with person identify data from the local profile mirror and snake_case props. Both paths include the `initiator` property when the stored context has one, so PostHog can split Penpot vs admin-console traffic.
|
|
||||||
3. **`posthog-telemetry`**: forwards events with `source = telemetry:frontend|telemetry:backend` to a separate PostHog project. Because these rows are already anonymous (no IPs, truncated times, filtered props), grouping is by **instance** (the self-hosted server, from `context.instance-id`), with one `$groupidentify` event per instance per chunk so PostHog learns per-instance properties (version, URI, flags). Each consumer has its own PostHog credentials.
|
|
||||||
|
|
||||||
So the full journey is: Penpot buffer → Nexus `audit_log` (via either archive cron or the telemetry endpoint) → consumers → PostHog (SaaS events grouped by team, telemetry grouped by instance) plus local analytics views and materialized KPIs.
|
|
||||||
|
|
||||||
### Admin console: the second consumer
|
|
||||||
|
|
||||||
Penpot → admin-console archiving lives in its own job (`:audit-log-consumer-admin-console`, consumer `2`, flag `:admin-console`, params closed empty): it drains its own pending queue and ingests allowlisted events through `nitrate/call :ingest-audit-log`, enriched as described above. What also exists (do not confuse with archiving):
|
|
||||||
|
|
||||||
- **Nitrate → Penpot**: `POST /api/management/methods/push-audit-events` (`backend/src/app/rpc/management/nitrate.clj`) lets the trusted Nitrate backend inject events into the Penpot audit log (no RPC auth, `::audit/skip`, request context + `submit`; only the `admin-console` shared-key id can call it). Section 7a is the main user.
|
|
||||||
- **Admin-console browser → collector**: usage events from the admin-console UI traveling through the normal public `push-audit-events` (section 7b).
|
|
||||||
- **Penpot frontend Nitrate bits**: membership/subscription events (`frontend/src/app/main/data/nitrate.cljs`, `nitrate-audit/*`) through the same public endpoint.
|
|
||||||
|
|
||||||
## 13. Flags and config
|
|
||||||
|
|
||||||
Flags (`common/src/app/common/flags.cljc`, varia; enabled with `PENPOT_FLAGS=enable-<name>`):
|
|
||||||
|
|
||||||
| Flag | What it does |
|
|
||||||
|---|---|
|
|
||||||
| `:audit-log` | Stores full rows; turns on `wrap-audit` and frontend ingest |
|
|
||||||
| `:nexus` | Send flag of the Nexus archive job `:audit-log-consumer-nexus` (cron `0 */5 * * * ?`; needs `:nexus-uri` (ingest path `api/audit` appended by the job)) |
|
|
||||||
| `:admin-console` | Send flag of the admin-console archive job `:audit-log-consumer-admin-console` (cron `30 */5 * * * ?`, 30s after Nexus); also the module flag for the admin-console integration |
|
|
||||||
| `:audit-log-logger` | Structured `app.audit` log per event |
|
|
||||||
| `:error-reporting` | Starts the error reporters (off by default); database reporter on flag alone, Mattermost on flag plus webhook URL |
|
|
||||||
| `:telemetry` | Stores shadow rows and turns on shipping (auto with `:telemetry-enabled`) |
|
|
||||||
|
|
||||||
Config (`backend/src/app/config.clj`): `:nexus-uri`, `:telemetry-uri` (default `https://telemetry.penpot.app/`), `:nexus-shared-key` / instance secret, `:public-uri` (sent as `origin` to Nexus).
|
|
||||||
|
|
||||||
## 14. Practical guide: add or change events
|
|
||||||
|
|
||||||
- **New backend command that must (or must not) emit**: `wrap-audit` does it alone; to exclude it set `::audit/skip`. To customize props/name/type use result metadata. Add a test mocking `app.loggers.audit/submit` (nil; `helpers.clj` stubs it globally) and assert `:call-args-list` — see `backend_tests/rpc-audit-test.clj` (full-row, telemetry-only, dual, no-op without flags, `insert`, `prepare-rpc-event`) and `rpc-team-test/accept-organization-invitation-audit-event` (three cases, exact props; counts matter: asserting with `first` passes even when a command emits the same name twice).
|
|
||||||
- **New Penpot frontend event**: create the data-event or implement `Event`/`PerformanceEvent` in `app.main.data.event`, with `::name`/`::type`/`::origin`. Honor `skip-audit?` if the action can resume. Remember: with no props schema, **your asserts are the contract**.
|
|
||||||
- **New admin-console event**: server action → add the backend-log call next to the mutation, best-effort so it never breaks the action; browser action → add a new event helper plus its test.
|
|
||||||
- **Command that creates an entity or already knows its team**: put the new row's `:id` in `::audit/props` (`create-project`/`create-file`) and set `:team-id` when the team is loaded, so the consumer never has to join production tables. For entities created inside an internal call (`clone-template`, `import-binfile`, `duplicate-project`), emit one event per entity: `audit/submit-file-created-event` when only the id is known (it reads the row back), `audit/submit-create-event` when the row is already in hand.
|
|
||||||
- **Never** put secrets in `props`; `clean-props` is a last defense, not an excuse.
|
|
||||||
- **Do not duplicate events**: if the backend already emits an event for an action, do not add a frontend (or admin-console browser) event for the same action — the backend one wins because it is reliable. A second event for the same action is only acceptable with a strong reason (for example the backend cannot see it at all), and then it must be clearly justified.
|
|
||||||
- **Follow the naming policy**: use kebab-case names (`"create-organization"`, not `"createOrganization"`), and before inventing prop keys, look at similar existing events and reuse their key names (`organization-id`, `team-id`, `file-id`, `event-origin`...). Same concept, same key spelling — that is what keeps the data queryable later.
|
|
||||||
|
|
||||||
## 15. Code map
|
|
||||||
|
|
||||||
- Backend producer: `backend/src/app/loggers/audit.clj` (`submit`, `submit*`, `insert`, `prepare-rpc-event`, `enrich-team-id`, `submit-create-event`, `event-from-rpc-params`, telemetry filters), `backend/src/app/rpc.clj` (`wrap-audit`), `backend/src/app/rpc/commands/audit.clj` (`push-audit-events`, `get-environment-data`, deprecated `get-enabled-flags`), `backend/src/app/rpc/management/nitrate.clj` (`push-audit-events` Nitrate→Penpot), `backend/src/app/http/middleware.clj` + `backend/src/app/http/management.clj` (shared-key auth).
|
|
||||||
- Membership emitter: `backend/src/app/rpc/commands/teams.clj` (`add-profile-to-team!` → `add-team-member`).
|
|
||||||
- Penpot frontend producer: `frontend/src/app/main/data/event.cljs` (collector, buffer, send), `frontend/src/app/main/repo.cljs` + `frontend/src/app/util/http.cljs` (headers), `frontend/src/app/main/data/nitrate.cljs` (Nitrate membership events).
|
|
||||||
- Admin-console producer (private repo, no paths cited here): server-side organization/subscription events through the management `push-audit-events`, browser-side UI events through the public `push-audit-events`.
|
|
||||||
- Consumers: `backend/src/app/loggers/webhooks.clj`, `backend/src/app/loggers/database.clj`, `backend/src/app/loggers/mattermost.clj`, `backend/src/app/tasks/telemetry.clj`.
|
|
||||||
- Archive (two jobs sharing one namespace + pending queue, no GC): `backend/src/app/loggers/audit/consumer_task.clj` (`:audit-log-consumer-nexus` / `:audit-log-consumer-admin-console` job-defs, shared drain/reap/sweep helpers), producer hook in `backend/src/app/loggers/audit.clj` (`append-audit-entry`, single `queue-pendings` helper) plus the bulk ingest in `backend/src/app/rpc/commands/audit.clj` (`handle-events`), metrics/cron wiring in `backend/src/app/main.clj` (one cron entry per job, Nexus at second 0 and admin console at second 30, each gated by its own send flag), single migration `0157` (queue, drop of `archived_at`, covering `(created_at, id)` index for the chronological scan; no backfill — pre-existing rows are swept unsent, an accepted loss).
|
|
||||||
- Nexus (private repo, no paths cited here): archive ingest, ordered consumers (local profile mirror, PostHog SaaS events, PostHog telemetry), telemetry endpoint, analytics views.
|
|
||||||
- Tests: `backend_tests/rpc-audit-test.clj`, `rpc-team-test/accept-organization-invitation-audit-event`.
|
|
||||||
@ -1,3 +1,54 @@
|
|||||||
# Backend Audit Log
|
# Backend Audit Log
|
||||||
|
|
||||||
Superseded by `mem:audit-log`: the full audit-log and event-processing guide (backend center, frontend collection, headers, webhooks, error reporters, telemetry, Nexus archive and planned Nitrate archive, table-as-buffer lifecycle, event anatomy, flags, tests). Read that memory instead; keep this stub so old references do not rot.
|
Penpot records what users do as events in the Postgres `audit_log` table. There are two producers (the backend RPC layer and the frontend app) and four consumers (webhooks, error reporters, telemetry shipping, and the Nexus archive). Everything below follows that flow: purpose, storage, producers, consumers, archival.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
- The audit log answers "who did what, when, from where": every RPC mutation and selected frontend actions become a row with `name`, `type`, `profile-id`, `ip-addr`, `props` and `context`. Product analytics, abuse investigation and compliance exports all read from here, so keep events truthful and never put secrets in `props`.
|
||||||
|
- It is also the trigger bus for side effects: the same event object fans out to webhooks, error reporting and telemetry without the RPC handler knowing. New features should reuse this bus instead of building parallel notification paths.
|
||||||
|
|
||||||
|
## Storage
|
||||||
|
|
||||||
|
- Live `audit_log` columns: `id` uuid PK default `gen_random_uuid()`; `name`/`type` text NOT NULL; `created_at` timestamptz NOT NULL default `now()` (server time, the source of truth); `tracked_at` timestamptz default `now()` (client-claimed time, corrected on ingest); `profile_id` uuid NOT NULL; `source` text telling full rows (`backend`/`frontend`) apart from anonymized copies (`telemetry:backend`/`telemetry:frontend`); `ip_addr` inet; `props`/`context` jsonb holding transit-encoded maps; `archived_at` timestamptz set once Nexus acknowledges the row.
|
||||||
|
- Indexes: PK on `(id)`; partial `created_at WHERE archived_at IS NULL` serving the archive scan; partial `archived_at WHERE archived_at IS NOT NULL` serving the GC; `(source, created_at)` serving the telemetry scan. Each consumer has its own index, so a slow consumer never blocks the others.
|
||||||
|
|
||||||
|
## Backend producers (`app.loggers.audit`)
|
||||||
|
|
||||||
|
- Most backend events need no manual code: `wrap-audit` in `app.rpc` runs after every RPC handler when `:webhooks`, `:audit-log` or `:telemetry` is on (unless the command sets `::audit/skip`) and builds the event via `prepare-rpc-event`. The event name defaults to the command name (prefixed with `<module>-` outside `main`), props default to the request params, and timestamps come from the server request time.
|
||||||
|
- Commands customize through result metadata (`rph/with-meta`): `::audit/replace-props` swaps the props wholesale (auth commands use `profile->props` so a register event carries the profile, not the password), `::audit/props` merges extras, `::audit/context`/`profile-id`/`name`/`type` override the defaults. `clean-props` always strips nils, qualified keys and `:session-id/:password/:old-password/:token/:client-secret` as a last line of defense.
|
||||||
|
- INVARIANT: the event's `profile-id` is the caller, resolved as `::audit/profile-id` metadata -> `::rpc/profile-id` -> `uuid/zero`. It is NEVER taken from the response. Results carry `:profile-id` keys that belong to someone else (`get-error-report` returns the report with its content merged, so the profile that owned the report; `verify-token` on a team invitation returns the inviter), and honoring them misattributes the action. Commands with `::rpc/auth false` (`login-*`, `register-profile`, `create-demo-profile`, `verify-token`, `prepare-register-profile`) have no caller to fall back on, so they MUST set `::audit/profile-id` in the result metadata or the event lands on `uuid/zero`.
|
||||||
|
- The `::audit/profile-id` override goes through `coerce-profile-id`: a string is parsed, anything that cannot become a uuid is discarded (with a warning) and the event falls back to the caller. Do not pass the value straight through: `schema:event` requires `::sm/uuid` and `submit*` swallows the validation error, so a non-uuid override silently loses the row instead of failing loudly. Hand-built events built with `event-from-rpc-params` + `submit` (clone-template, accept-team-invitation, `management/nitrate` push-audit-events) do NOT go through that coercion: they must supply a uuid.
|
||||||
|
- `submit` is the normal entry point (fills defaults, validates `schema:event`, runs inside `tx-run!`, logs failures without failing the RPC). `insert` is the low-level one for CLI/helpers and the webhook subsystem: direct write, no webhook/telemetry fan-out, silent unless `:audit-log` is on. Boot emits `trigger/instance-start` from `setup/props` so every restart is visible in the log.
|
||||||
|
- `accept-organization-invitation` distinguishes its two flows with the props, not with an origin: `:organization-member-add-source` is `"direct-organization-invitation"` for a direct organization invitation and `"team-invitation"` for a team invitation that also adds to the organization, and `:belongs-to-team-on-add` repeats the same distinction as a boolean. Do not add a third prop for it. The event `context` has an `:event-origin`, but it belongs to the browser: `make-data-event` in `app.main.data.event` puts the UI origin there and it is on the frontend allowlist, while `safe-backend-context-keys` lists no `:event-origin`, so a backend event has nowhere to put one. Text props are dropped from the telemetry shadow rows by `filter-telemetry-props`; the full `audit_log` row and the Nexus archive still carry them.
|
||||||
|
|
||||||
|
## Consumers I: webhooks (`app.loggers.webhooks`)
|
||||||
|
|
||||||
|
- Webhooks are the first dependent: when an event carries `::webhooks/event?`, `process-event` (worker task `:process-webhook-event`) finds the team's active webhooks from the event props (`team-id`, else `project-id`, else `file-id`), records a `trigger webhook` row, and enqueues one `:run-webhook` delivery per match. Batching and dedupe come from the audit event itself (`batch-key` + `batch-timeout`), not from webhook config.
|
||||||
|
- `:run-webhook` POSTs the event in the webhook's `mtype` (JSON camelCase, transit, or form-encoded), logs each attempt in `webhook-delivery`, and disables the webhook after 3 consecutive errors. Delivery problems never touch the audit row itself.
|
||||||
|
|
||||||
|
## Consumers II: error reporters (`app.loggers.database`, `app.loggers.mattermost`)
|
||||||
|
|
||||||
|
- Both reporters listen for backend `:error` log records and for frontend crash events (recognized by the `::audit/event` marker), through a sliding-buffer channel so a flood of errors cannot stall the app. The database reporter persists them into `server-error-report` (source 4 = audit-log origin); the Mattermost reporter forwards a short notification to `:error-report-webhook` when configured.
|
||||||
|
- Consequence for producers: crash reports only exist if the frontend collector is running and `push-audit-events` accepts `unhandled-exception`/`exception-page` events. Disabling the whole pipeline also blinds error reporting from the frontend.
|
||||||
|
|
||||||
|
## Consumers III: telemetry (`app.loggers.audit` + `app.tasks.telemetry`)
|
||||||
|
|
||||||
|
- Telemetry reuses the same table with anonymized shadow rows (`source LIKE 'telemetry:%'`): day-truncated timestamps, `0.0.0.0` IPs, props reduced to uuid/boolean/number values plus a few allowlisted fields (`lang`, `auth-backend`, derived `email-domain`, never raw emails), and a minimal context allowlist. Both full and shadow rows can coexist per event; that duplication is intentional.
|
||||||
|
- The telemetry cron ships shadow rows to `:telemetry-uri` as JSON in 10k batches, deletes them on success, and purges leftovers older than 7d. Nothing is collected or sent on official hosts (`telemetry-excluded?` covers `penpot.app`/`penpot.dev`).
|
||||||
|
|
||||||
|
## Frontend ingestion (`app.rpc.commands.audit`, `app.main.data.event`)
|
||||||
|
|
||||||
|
- The browser cannot write to the table directly; it POSTs transit batches to `push-audit-events`, which stamps server `id`, session `profile-id`, request ip and server `created-at`, and distrusts the client clock (future or >1h-lagging `tracked-at` is reset, original preserved in context). The endpoint is a no-op without `:audit-log`/`:telemetry` or on a read-only pool.
|
||||||
|
- The in-browser collector (`app.main.data.event`) only starts after `get-enabled-flags` confirms the backend wants events. It turns Potok events and explicit `ev/event` calls (nitrate membership changes, workspace file stats, crash reports) into a capped buffer (1024, chunks of 100, 2s debounce, current profile only) and sends fire-and-forget. `skip-audit?` exists for resumed dashboard actions so one user gesture is not counted twice.
|
||||||
|
- Because collection is best-effort and includes `PerformanceObserver` noise (`performance-*` triggers), backend tests must never assert exact frontend event counts.
|
||||||
|
|
||||||
|
## Archival to Nexus and retention
|
||||||
|
|
||||||
|
- Long-term storage lives outside Penpot in Nexus. Every 5m the `:audit-log-archive` cron takes chunks of 128 unarchived rows (`FOR UPDATE SKIP LOCKED`), POSTs them as transit `{:events [...]}` authenticated with `x-shared-key: "nexus <key>"` (`:nexus-shared-key`, else derived from the instance secret), and marks `archived_at=now()` only on HTTP 204, in the same transaction. Anything else is retried on the next run; a missing URI with the flag on raises `:task-not-configured`.
|
||||||
|
- Every 5m the `:audit-log-gc` cron deletes all archived rows (no age filter), so archive must run before GC or data ships never. Cron dedup is best-effort (`mem:prod-infra/core`): two backends can fire the archiver twice, which is why the Nexus endpoint must be idempotent and the DB only marks acknowledged rows.
|
||||||
|
- Flags live in `common/flags.cljc` varia and are enabled as `PENPOT_FLAGS=enable-<name>`: `:audit-log`, `:audit-log-archive`, `:audit-log-gc`, `:audit-log-logger` (structured `app.audit` log). `:telemetry-enabled` config auto-adds `:enable-telemetry`.
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
- `backend_tests/rpc-audit-test.clj` exercises the whole backend path (full-row insert, telemetry-only and dual-row modes, `submit*`, no-op without flags, `insert` gating, `prepare-rpc-event` resolution) with `with-redefs [cf/flags #{...}]` against real `audit_log` rows.
|
||||||
|
- Other RPC suites mock `app.loggers.audit/submit` (nil return; `helpers.clj` stubs it globally) and assert on `:call-args-list`; any new command that must (or must not) emit an event needs the same treatment. `rpc-team-test/accept-organization-invitation-audit-event` is the reference for invitation events: three scenarios (direct org invitation, team invitation that adds to the org, already-a-member) asserting the emitted props, the add source and the team flag that tell the two flows apart, and the exact number of rows per event name. The count matters: asserting props against the first match with `first` passes even when a command emits the same name twice. Props have no schema on either ingest path, so these assertions are the only guard on the event contract.
|
||||||
|
|||||||
@ -7,18 +7,8 @@
|
|||||||
- Basic Penpot registration is token staged: prepare/register creates or verifies temporary tokens, then profile creation/session setup is reused by other auth backends. The frontend `/auth/verify-token` flow is a hub for registration confirmation, email change, and invitation tokens.
|
- Basic Penpot registration is token staged: prepare/register creates or verifies temporary tokens, then profile creation/session setup is reused by other auth backends. The frontend `/auth/verify-token` flow is a hub for registration confirmation, email change, and invitation tokens.
|
||||||
- OIDC-compatible providers share a generic flow: redirect to provider, validate callback/request token, fetch identity data, then login an existing profile or register a new one. Known providers may have hardcoded endpoints; generic OIDC can use discovery/configured endpoints.
|
- OIDC-compatible providers share a generic flow: redirect to provider, validate callback/request token, fetch identity data, then login an existing profile or register a new one. Known providers may have hardcoded endpoints; generic OIDC can use discovery/configured endpoints.
|
||||||
- LDAP login validates credentials against the external directory, fetches identity data, then logs in or registers a matching Penpot profile. LDAP registration is not a separate Penpot signup flow.
|
- LDAP login validates credentials against the external directory, fetches identity data, then logs in or registers a matching Penpot profile. LDAP registration is not a separate Penpot signup flow.
|
||||||
- LDAP session identity MUST come from the directory-returned email (`info.email`): the profile matching the typed email can differ (aliases, UPNs, multi-valued `mail` attributes) and is used only for lockout checks, never to bind the session.
|
|
||||||
- Account lockout (flag `:account-lockout`, `app.auth.login-lockout`) is Redis-backed and keyed per profile id. Password and LDAP flows check/increment on the profile derived from the typed email and clear on the profile that actually logs in.
|
|
||||||
- Lockout and RPC rate limits share the `app.http.errors/handle-error :rate-limit` HTTP path: status 429, body `{:type :rate-limit :code ... :hint ... :ttl ...}`, and any supplied `::http/headers` preserved. Account lockout raises `:code :account-locked` and, when it carries a non-nil `:ttl` (seconds), the handler adds `retry-after`. The RPC limiter (`app.rpc.rlimit`) raises `:code :request-blocked` and sets `retry-after` itself in `::http/headers` (seconds until the longest rejecting limit resets), alongside `x-rate-limit-remaining`/`x-rate-limit-reset`. CORS (`app.http.middleware/with-cors-headers`) exposes `content-type`, `retry-after`, and both `x-rate-limit-*` headers. External flags: `enable-account-lockout`, `enable-rpc-rlimit`.
|
|
||||||
- Logout may return an OIDC provider redirect URI when the session claims include provider/session data and the provider has a logout URI.
|
- Logout may return an OIDC provider redirect URI when the session claims include provider/session data and the provider has a logout URI.
|
||||||
- Organization SSO (Nitrate): the RPC `check-nitrate-sso` takes the route's **query string proper** (`:query-string`, e.g. `screen=workspace&team-id=…`), never a URL and never with the `?` separator: the client strips it (`rt/token->query-string`) and the server puts it back. The server builds the destination with `app.auth.oidc/build-dest-url` (`public-uri` + `?` + the params, parsed and rendered back), so the redirect can never leave the public URI; a value whose parsed keys are not param names is not a route: a URL parses into a single key holding the whole URL, and a key carrying `:`, `/`, `?` or `#` is rejected with a `:warn` and the user lands on the public URI (the RPC never fails because of it). Do not reason from `u/map->query-string`: it keeps a valueless key as `key=`, so rendering is not what filters a URL out — the key shape is. A leading `?` is still trimmed server-side, so a client bundled before the trim keeps its destination. Never require `screen`: the root of the app carries its params instead of a screen (`?template=…`), and `check-nitrate-sso` is called from that branch too (`dtm/resolve-login-team-id`, which today reads only `:authorized` and never follows the redirect, so a wrong destination there is a silent `:warn` and not a visible break); the callback re-checks the destination before redirecting, which covers state tokens minted before that. The state token also carries `:profile-id`: only that session is granted the `props :sso` entry (`session-mismatch` otherwise, and the redirect still happens).
|
|
||||||
- Organization SSO needs `app.nitrate/organization-access?` whenever the RPC receives an `:organization-id` (that id always comes from the client): the profile must be a member of the organization or its owner; otherwise the RPC answers `{:authorized true :reason :no-organization-access}`, the same short-circuit shape as `:no-team-access`.
|
|
||||||
- Invitation tokens are verified through token issuers and only accepted when the token member id/email matches the authenticated profile; otherwise login proceeds without consuming the invitation.
|
- Invitation tokens are verified through token issuers and only accepted when the token member id/email matches the authenticated profile; otherwise login proceeds without consuming the invitation.
|
||||||
- When public registration is disabled, invitation-based password registration also requires a matching, non-expired `team_invitation` row; registration revalidates it under a row lock before creating the profile. SSO registration (OIDC and compatible providers) follows the OIDC callback gate: it requires `:registration` or `:oidc-registration`, or a team invitation token issued for the registering email (an invitation substitutes the flags only when `member-email` matches the OIDC/`prepared-register` email via `clean-email`, as in the password flow, which raises `:email-does-not-match-invitation` otherwise). The OIDC callback verifies the invitation JWT and the email before redirecting to register, and `register-profile` revalidates the invitation under a row lock when no SSO flag is set; it never requires password login. Only OIDC-typed backends (`oidc-provider-types` in `app.auth.oidc`) take the SSO registration gate; any other `:backend` in a prepared-register token is rejected as `:invalid-token`.
|
|
||||||
- Access tokens (`app.http.access-token`): personal tokens have JWT issuer `access-token` and DB type other than `mcp`; MCP tokens have issuer `urn:penpot:mcp-token` (`actoken/mcp-token-issuer`) and DB type `mcp`. Authentication requires issuer and type to agree, and the claim `uid` to match the row's profile; other issuers and undecryptable tokens are treated as anonymous.
|
|
||||||
- Management RPC (`/api/management/methods/:name`) is shared-key only. The middleware authenticates `<id> <secret>`; the RPC wrapper `wrap-shared-key-authorization` authorizes the key id against the method's `::rpc/allowed-shared-keys` set. Absent metadata accepts any configured key; all current methods declare one (`exporter`/`media-processor` for `upload-tempfile`, `nexus` for file analysis, `exporter` for jobs, `admin-console` for Nitrate). A valid key outside the set answers 403 `:shared-key-not-allowed`; denied calls do not reach the audit wrapper.
|
|
||||||
- Personal tokens need flag `:access-tokens`. MCP tokens need `:mcp` or `:access-tokens`, and only on routes whose `actoken/authz` gets `::actoken/allow-mcp true` (the RPC routes); elsewhere (e.g. assets) they are anonymous.
|
|
||||||
- On RPC, an MCP token reaches only commands with `::rpc/token-type "mcp"` (`wrap-authentication` in `app.rpc`); every other command answers 403 `:token-auth-required`. A command with that metadata also rejects sessions and personal tokens. Currently only `send-mcp-feedback`. Blocking a profile invalidates sessions, not tokens, so such commands check `:is-blocked`/`:is-active` themselves.
|
|
||||||
- HTTP/session parsing details such as cookie/header precedence, JWT session token versions, and SameSite behavior are in `mem:backend/subtleties`.
|
- HTTP/session parsing details such as cookie/header precedence, JWT session token versions, and SameSite behavior are in `mem:backend/subtleties`.
|
||||||
|
|
||||||
## Permission model
|
## Permission model
|
||||||
@ -26,16 +16,13 @@
|
|||||||
- `app.rpc.permissions` provides predicate/check factories. Failed permission checks intentionally raise `:not-found` / `:object-not-found`, not an authorization-specific error, to avoid leaking object existence.
|
- `app.rpc.permissions` provides predicate/check factories. Failed permission checks intentionally raise `:not-found` / `:object-not-found`, not an authorization-specific error, to avoid leaking object existence.
|
||||||
- Team role flags are normalized as owner > admin > editor > viewer. Owner/admin imply edit; any membership row implies read.
|
- Team role flags are normalized as owner > admin > editor > viewer. Owner/admin imply edit; any membership row implies read.
|
||||||
- File/project role rows only count with a live team membership: the file/project permission queries require a matching `team_profile_rel` row, and leaving or removing a member deletes their team-scoped `file`/`project`/`team-project-profile-rel` rows (GHSA-v9r9-h77c-55m2).
|
- File/project role rows only count with a live team membership: the file/project permission queries require a matching `team_profile_rel` row, and leaving or removing a member deletes their team-scoped `file`/`project`/`team-project-profile-rel` rows (GHSA-v9r9-h77c-55m2).
|
||||||
- The organization-owner fallback (`get-organization-owner-permissions` via Nitrate over HTTP) grants read-only access for a non-member organization owner. It resolves the owning team through `resolve-team-id`, which refuses soft-deleted file/project/team: the file and project lookups filter `deleted_at`, and a final `db/get*` check covers the team row itself — `nil` means no access. `db/get*` only filters soft-deleted rows when `deleted_at` is in the projection. The re-checks of open websocket subscriptions rely on this (`mem:backend/websocket-subscriptions`).
|
|
||||||
- File/project/comment checks are implemented in the owning command namespaces, often via helpers imported from `files`, `teams`, or `projects`; do not bypass those helpers with direct DB lookups unless preserving their not-found semantics.
|
- File/project/comment checks are implemented in the owning command namespaces, often via helpers imported from `files`, `teams`, or `projects`; do not bypass those helpers with direct DB lookups unless preserving their not-found semantics.
|
||||||
- Comment permission includes both logged-in state and the file/team comment policy. Shared viewer paths may pass `share-id`; preserve that path when changing comment queries. RPCs that accept `share-id` enforce the link's page scope before mutating (`share-link-pages` + `check-page-scope`): a thread or page outside the link raises `:not-found`, and that check runs before the ownership checks. `get-profiles-for-file-comments` filters its query by the same pages. `mark-all-threads-as-read` does not take `share-id`.
|
- Comment permission includes both logged-in state and the file/team comment policy. Shared viewer paths may pass `share-id`; preserve that path when changing comment queries.
|
||||||
|
|
||||||
## Teams, projects, and invitations
|
## Teams, projects, and invitations
|
||||||
|
|
||||||
- Team/project commands mix DB changes, email, message bus notifications, media/storage cleanup, feature flags, quotas, and audit metadata. Keep mutations transactional when the existing command does so.
|
- Team/project commands mix DB changes, email, message bus notifications, media/storage cleanup, feature flags, quotas, and audit metadata. Keep mutations transactional when the existing command does so.
|
||||||
- Invitation flows validate muted/bounced emails before sending and use tokenized invitation state. Accepting an invitation is tied to the invited member identity, not just possession of a token.
|
- Invitation flows validate muted/bounced emails before sending and use tokenized invitation state. Accepting an invitation is tied to the invited member identity, not just possession of a token.
|
||||||
- The whole invitation family is team-admin only: creating, updating and deleting invitations, minting the invitation token (`get-team-invitation-token`) and listing the pending ones (`get-team-invitations`, which carries the invited email and the offered role). The token of an invitation that grants the `owner` role is restricted to the team owner, because an admin cannot create nor promote an owner invitation (`cant-promote-to-owner`). This family is the exception to the rule above: it answers `:validation` / `:insufficient-permissions` instead of `:not-found`, so the five commands speak one language.
|
|
||||||
- With the `:admin-console` flag, the organization `send-invitations` policy (role value plus Nitrate `restrictions-met`, through `cto/allowed?`) gates every invitation command that hands out or manages access: create (and resend, which reuses it), `update-team-invitation-role`, `delete-team-invitation` and `get-team-invitation-token`. Only `get-team-invitations` stays on team admin alone, so a blocked admin still sees the list. The shared helper `check-send-invitations-policy` in `teams_invitations.clj` does a strict Nitrate lookup (fails closed; 404 means no organization) and runs outside a DB transaction, which is why the role and delete commands carry no `::db/transaction`.
|
|
||||||
- Logical deletion is used for many product objects; prefer existing logical-deletion helpers over hard deletes unless the command already performs permanent cleanup.
|
- Logical deletion is used for many product objects; prefer existing logical-deletion helpers over hard deletes unless the command already performs permanent cleanup.
|
||||||
- Bounced/spam-complaint emails can mute/block a profile for login/registration and email sending. Devenv Mailpit is the normal local path for registration/email-flow testing.
|
- Bounced/spam-complaint emails can mute/block a profile for login/registration and email sending. Devenv Mailpit is the normal local path for registration/email-flow testing.
|
||||||
|
|
||||||
|
|||||||
@ -4,18 +4,15 @@ Backend: JVM Clojure; Integrant; PostgreSQL; Redis/Valkey; RPC; HTTP; storage; m
|
|||||||
|
|
||||||
## Focused memories
|
## Focused memories
|
||||||
|
|
||||||
- Cross-cutting backend subtleties (RPC, DB helpers, workers, cron, CLIMIT, config and HTTP/session middleware, http self-metrics, media processing, and file data persistence): `mem:backend/subtleties`
|
- RPC, DB helpers, workers, cron, CLIMIT, config and HTTP/session middleware, http self-metrics, media processing, and file data persistence: `mem:backend/subtleties`
|
||||||
- Storage abstraction, logical buckets, object lifecycle, deduplication, access, and garbage collection: `mem:backend/storage`.
|
- Storage abstraction, logical buckets, object lifecycle, deduplication, access, and garbage collection: `mem:backend/storage`.
|
||||||
- Embedded Ladybug graph experiment, projection, incremental sync, console, and risks: `mem:backend/graph-experiment`
|
|
||||||
- Session lifetime config, token `:exp`, and idle/absolute GC: `mem:backend/session-expiration`.
|
|
||||||
- Auth flows, permission model, teams, projects, invitations, comments, webhooks, audit: `mem:backend/auth-permissions-product-domains`
|
- Auth flows, permission model, teams, projects, invitations, comments, webhooks, audit: `mem:backend/auth-permissions-product-domains`
|
||||||
- WebSocket subscriptions, the connection registry (local per backend, unlike the bus), and how a lost permission gets revoked: `mem:backend/websocket-subscriptions`.
|
- Audit-log event collection (RPC wrapper, frontend ingestion), telemetry duality, webhook fan-out, error reporters, Nexus archival and retention: `mem:backend/audit-log`
|
||||||
- Audit-log event collection (RPC wrapper, frontend ingestion), telemetry duality, webhook fan-out, error reporters, Nexus archival and retention: `mem:audit-log` (guía completa, también para perfiles junior; el stub `mem:backend/audit-log` solo redirige aquí)
|
|
||||||
- Services, task-queue/Pub-Sub topology constraints -> `mem:prod-infra/core`.
|
- Services, task-queue/Pub-Sub topology constraints -> `mem:prod-infra/core`.
|
||||||
|
|
||||||
## Stable namespace map
|
## Stable namespace map
|
||||||
|
|
||||||
- `app.rpc.commands.*`: RPC command implementations exposed under `/api/main/methods/<method-name>`; `/api/rpc/command/<method-name>` remains as a backward-compatible route.
|
- `app.rpc.commands.*`: RPC command implementations exposed under `/api/rpc/command/<cmd-name>`.
|
||||||
- `app.rpc.permissions`: permission predicate/check helper factories.
|
- `app.rpc.permissions`: permission predicate/check helper factories.
|
||||||
- `app.http.*`: HTTP routes and middleware.
|
- `app.http.*`: HTTP routes and middleware.
|
||||||
- `app.auth.*`: provider-specific authentication helpers such as LDAP/OIDC.
|
- `app.auth.*`: provider-specific authentication helpers such as LDAP/OIDC.
|
||||||
@ -33,65 +30,29 @@ Backend: JVM Clojure; Integrant; PostgreSQL; Redis/Valkey; RPC; HTTP; storage; m
|
|||||||
|
|
||||||
RPC commands are defined with `app.util.services/defmethod` and schemas. Use `get-` prefixes for read operations. Command metadata usually includes auth, docs version, params schema, and result schema. Return plain maps/vectors or raise structured exceptions from `app.common.exceptions`.
|
RPC commands are defined with `app.util.services/defmethod` and schemas. Use `get-` prefixes for read operations. Command metadata usually includes auth, docs version, params schema, and result schema. Return plain maps/vectors or raise structured exceptions from `app.common.exceptions`.
|
||||||
|
|
||||||
Backend RPC command areas without focused memories include access tokens (auth rules, incl. MCP tokens, in `mem:backend/auth-permissions-product-domains`), binfile, demo, feedback, file snapshots, fonts, management, Nitrate, and webhooks beyond the notes in `mem:backend/auth-permissions-product-domains`; inspect nearby command tests and command metadata before changing them.
|
Backend RPC command areas without focused memories include access tokens, binfile, demo, feedback, file snapshots, fonts, management, Nitrate, and webhooks beyond the notes in `mem:backend/auth-permissions-product-domains`; inspect nearby command tests and command metadata before changing them.
|
||||||
|
|
||||||
## DB conventions
|
## DB conventions
|
||||||
|
|
||||||
`app.db` helpers accept cfg, pool, or conn in most places and convert kebab-case to snake_case:
|
`app.db` helpers accept cfg, pool, or conn in most places and convert kebab-case to snake_case:
|
||||||
- `db/get`, `db/get*`, `db/query`, `db/insert!`, `db/update!`, `db/delete!`.
|
- `db/get`, `db/get*`, `db/query`, `db/insert!`, `db/update!`, `db/delete!`.
|
||||||
- `db/get*`/`db/query` signature is `(ds table where-params & {:as opts})`: trailing keywords become an opts MAP (ignored by the select builder — use `{::db/remove-deleted false}` map as the single vararg to also see rows with `deleted_at` set), while a trailing ODD number of keywords crashes with "Don't know how to create ISeq from: Keyword". Extra keywords are NOT a column filter: rows always come back with all columns.
|
|
||||||
- Next.js/JDBC caveat: where-maps don't support value vectors (no `IN`); use `status = ANY(?)` with `db/create-array` inside `db/tx-run!`.
|
|
||||||
- Use `db/run!` for multiple operations on one connection.
|
- Use `db/run!` for multiple operations on one connection.
|
||||||
- Use `db/tx-run!` for transactions.
|
- Use `db/tx-run!` for transactions.
|
||||||
- `job`-substrate specifics (unified jobs): the only writers of a job status are `claim`, `retry-job`, `complete`, `fail` and `cancel` in `app.jobs`; each one is a conditional update plus its `job_event` row in the same transaction, so history can never contradict the row. A writer that affects no row writes no event and no metric. They never join the caller's transaction, because a lifecycle write reports on work that already happened: a rolled back caller cannot undo a transition, and an independent connection cannot see the caller's uncommitted job row, so a job must be committed before it can be claimed. GC deletes return resource ids via `RETURNING` inside one transaction.
|
|
||||||
- Every public function of `app.jobs` takes a cfg map. A bare pool or connection is a caller bug and is not coerced: the substrate has no conversion of its own, and the ones in `app.db` are the db layer's business.
|
|
||||||
- Every new foreign key of the substrate is `DEFERRABLE`, `job_event.job_id` included.
|
|
||||||
- Some tables carry a SQL deletion guard (`raise_deletion_protection` + a `deletion_protection__tgr` statement trigger): `profile`, `team`, `team_font_variant`, `file_media_object`, `file_thumbnail`, `file_tagged_object_thumbnail` and `job`. A `DELETE` raises unless the transaction runs `SET LOCAL rules.deletion_protection TO off` (the guard is on when the GUC is unset, empty or `on`); see `app.tasks.objects-gc`, `app.jobs.gc` and `th/db-force-delete`.
|
|
||||||
|
|
||||||
Database migrations live in `backend/src/app/migrations/`; pure SQL migrations are under `backend/src/app/migrations/sql/`. SQL filenames conventionally start with a sequence and verb/table description, e.g. `0026-mod-profile-table-add-is-active-field`. Applied migrations are tracked in the `migrations` table.
|
Database migrations live in `backend/src/app/migrations/`; pure SQL migrations are under `backend/src/app/migrations/sql/`. SQL filenames conventionally start with a sequence and verb/table description, e.g. `0026-mod-profile-table-add-is-active-field`. Applied migrations are tracked in the `migrations` table.
|
||||||
|
|
||||||
Migrations must stay within PostgreSQL 15 syntax: the official docker images (`docker/images/docker-compose.yaml`) pin `postgres:15`, so anything newer breaks those deployments (`SET STORAGE DEFAULT` is PostgreSQL 16, for instance). The documented floor is >=15.
|
Migrations must stay within PostgreSQL 15 syntax: the official docker images (`docker/images/docker-compose.yaml`) pin `postgres:15`, so anything newer breaks those deployments (`SET STORAGE DEFAULT` is PostgreSQL 16, for instance). The documented floor is >=15.
|
||||||
|
|
||||||
For interactive PostgreSQL access with correct dev defaults, use `scripts/psql`; to dump the current DDL schema, use `scripts/db-schema` (see `mem:scripts/psql`).
|
For interactive PostgreSQL access with correct dev defaults, use `scripts/psql`; to dump
|
||||||
|
the current DDL schema, use `scripts/db-schema` (see `mem:scripts/psql`).
|
||||||
|
|
||||||
For deeper details on transaction semantics, advisory locks, Transit vs JSON helpers, and dev/test DB URLs: `mem:backend/subtleties`.
|
For deeper details on transaction semantics, advisory locks, Transit vs JSON helpers, and dev/test DB URLs: `mem:backend/subtleties`.
|
||||||
|
|
||||||
## Background tasks (unified jobs)
|
## Background tasks
|
||||||
|
|
||||||
Every background job is a job-def: a plain `(defn execute-X [cfg params] ...)` in its namespace + a malli params schema + an `ig/init-key` that returns the job-def map `{::jobs/name, ::jobs/schema, ::jobs/handler, ::jobs/decoder, ::jobs/validator}` (decoder/validator precompiled at init), optionally with `::jobs/result-schema` when the result carries types plain JSON does not keep (a uuid, whether a value or a map key): the substrate compiles the decoder from that schema on registry init and checks a result against the schema before storing it. The registry is the `::jobs/defs` wiring in `app.main`, which also populates a module-level registry used by `jobs/submit` as fallback — job-def components cannot ig/ref `::jobs/defs` (wiring cycle). Submit from RPC code passes its RPC cfg (it carries `::jobs/defs` via ig/ref).
|
A task handler is an Integrant component with `ig/assert-key`, `ig/expand-key`, and `ig/init-key`, returning the function run by the worker. New tasks also need wiring in `app.main`: handler config, worker registry entry, and cron entry if scheduled.
|
||||||
|
|
||||||
- `::jobs/handler` is `(fn [context params] ...)`. It is NOT given the runner cfg: a job-def closes over its own dependencies, and handing it the runner cfg would let a handler reach the pool or any other component. A wrapper passes the context to its implementation only when the implementation takes it; most do not, and their implementation stays `[cfg params]`.
|
|
||||||
- The context is built by `jobs/make-context` and has exactly five keys: `id`, `name`, `label`, `resource-id`, `profile-id`, behind a closed schema. `profile-id` is the owner of a user-facing job and nil for an internal one, and it is there so a handler can revalidate permissions and check who owns its resource without a second query. `queue` is absent on purpose (a routing detail of the dispatcher, not a property of the job) and so are `retry-num`/`max-retries`/`attempt` (retry policy belongs to the runner, and an attempt number cannot be durable because the `noop` strategy re-runs without incrementing the counter).
|
|
||||||
- `jobs/invoke` is the in-process escape hatch: it delivers a nil context without a row, validates and delivers `::jobs/context` when given, and keeps `::jobs/job-id` independent. `::jobs/context` and `::jobs/job-id` are cfg options, not params.
|
|
||||||
- Business params live in the `params` column (plain JSON, decoded with the job-def decoder). `submit` takes optional `::jobs/profile-id`, `::jobs/resource-id` (both validated as UUIDs) and `::jobs/expires-at` (an instant: the retention the jobs GC sweeps by), all stored as columns; nothing is inferred from `params`. The binfile creation commands are the callers that pass a profile-id and a resource.
|
|
||||||
- A job-def may carry optional metadata keys read from the registry by its consumers, never by the substrate: `::jobs/family` (e.g. `:export`) groups the jobs of a family for quotes, `::jobs/resource-role` (`:input` or `:output`) says whether the job's `resource_id` is what it consumes or what it produces, and `::jobs/queue-name` names the queue the creation command routes the job to (`submit-job` falls back to `:binfile` when the def does not set it).
|
|
||||||
- Job resources (`app.jobs.storage`) are the objects a job owns through `job.resource_id`: they live in the `job-resource` bucket, are written with the profile of the job as owner (only that profile can read them back from `/assets/by-id`) and are never deduplicated. They carry no expiry of their own, because `expired-at` is stored as `deleted_at` and an object with it is unreadable from birth: the retention of the artifact is the retention of its job row. The writer marks the object as touched right away, so an artifact that no row references (a crash between the upload and the completion) is reclaimed by `storage-gc-touched`, and a row that does reference it freezes it until the jobs GC deletes the row and touches the object.
|
|
||||||
- The binfile jobs (`:export-binfile` and `:import-binfile`) run the core of `bf.v1`/`bf.v3` through `app.binfile.jobs`, which turns the `:progress` taps of the core into `progress` events of the job with `jobs/heartbeat` (the `modified_at` touch at most once per second, progress events at up to ~200ms). Each event is a self-contained milestone: a `:stage` keyword of one vocabulary shared by the two formats (the same work has a different name in v1 and v3) and an optional `:counters` map, with the counter of the activity named after its own stage and the outer scopes in course as context, which the tap carries itself (the reader puts `::outer-counters` in every tap inside them — today only `:files`, extendable to `:teams`/`:projects` for multi-scope exports — so the adapter remembers nothing between taps and a tap that happens outside any scope has no context); the ids and names the taps carry never reach the event. Every tap is reported, so a tap with no units to count still keeps the job alive, and a milestone the throttle drops loses nothing because the next one carries the same state. The adapter checks that the job is still active before the run, and the beat raises an `:interrupt` right there on the run thread when the job is no longer active, so the work stops at its next event point inside the transaction of its handler, which rolls back. A run whose last tap predates the interruption is discarded by the check once it returns. The adapter passes the job id from the handler context. Their job-def components carry pool, storage, metrics and msgbus, because a job with a `profile_id` cannot store an event without a msgbus on its cfg. Both readers answer with the same shape (`:file-ids` and, in version 3, the resolution of the libraries), because the version 1 reader returns a bare set of file ids.
|
|
||||||
- Both binfile handlers revalidate their permission at run time, not only when the job is created, because it can be revoked while the job waits: the export checks the read permission of every file before reading anything and stores the package in `job-resource` as the resource of the job (answering with the completion envelope), and the import checks the edition permission of the destination and runs the core inside a transaction, which is what makes a cancelled import roll back instead of leaving half of a file. The import releases its package (marks it as deleted and drops the reference from the job row in the same transaction) and deletes its temporary copy once the job is terminal, whatever the outcome. Both handlers check their own result against a schema before returning it (the import job-def declares that same schema as its result schema, which is what types the resolution when the row is read).
|
|
||||||
- The v3 and v1 imports only materialize a library relation when both ids belong to the package and the link would neither be a self link nor close a dependency cycle (the same `bfc/library-link-status` check that `link-file-to-library` uses to raise); relations are processed in sorted `(file_id, library_file_id)` order, which `get-files-rels` also returns, so the first edge wins deterministically, and every edge it ignores is logged with a warning. The v2 import stays out of that guard on purpose: it is only reachable from the developer REPL (`app.srepl.binfile`) and keeps inserting the relations as they come. Migration `0158-del-forbidden-file-library-rels` deletes the legacy cross-team and self rows from `file_library_rel` and their `file_library_sync` rows, sync rows first.
|
|
||||||
- A version 1 package lists its files in the metadata and the importer creates one file per entry. The v1 export (gone from the product; only tests and the developer REPL use it) unioned the requested files with their libraries without deduplicating, so a package exported from a file inside a library cycle lists that file twice. The importer reads the pair of objects of every entry to keep the stream in sync, imports the first occurrence only, warns about the repeats, and answers with one id per imported file.
|
|
||||||
- The domain cfg of a binfile request lives in `app.binfile.common` (`export-cfg`, `import-cfg`), so the legacy RPC and the jobs freeze the same ids, resolve the same team features and apply the same anti-zip-bomb limits. `resolve-export-type` is the translation the legacy RPC needs for its deprecated boolean flags; the creation command asks the caller for the type instead of guessing a default.
|
|
||||||
- Two retention knobs, easy to confuse: `:jobs-retention` sweeps terminal internal rows (the ones without a profile), while `:jobs-user-ttl` is the default expiry a user-facing job gets when it is created; the jobs GC deletes the row once `expires_at` passes and touches its resource. The heavy work of a user job runs on its own `:binfile` queue (`:worker-binfile-parallelism`, default 1) so it does not block the default runner.
|
|
||||||
- The quote of a family of jobs (`::export-jobs-per-profile`, `::import-jobs-per-profile`) counts the jobs of the profile that are still on their way (`new`/`scheduled`/`running`/`retry`) whose name the registry gives for that family, so a new job of the family is covered without touching the quote.
|
|
||||||
- A user-facing job is created through `app.rpc.commands.jobs`. One command per job type: `create-export-binfile-job` and `create-import-binfile-job` name the job they create and their body carries only `:params`, whose schema the command imports from the job namespace (`::sm/params`), so the RPC validates the business params up front, before the command runs; the job-def is still the place that owns them and validates them again at run time. The commands check the permission and the quote of the family before the expensive part, submit with `max-retries 0`, an expiry from `:jobs-user-ttl` and the queue the job-def routes to through `::jobs/queue-name` (`:binfile` when the def says nothing; read by the command, never by the substrate), and answer with a summary of the row. The import command has its own creation schema (`import-binfile/schema:create-params`, version optional) because the request is not the stored params: the command fills the version (from the caller or the package header) and the manifest metadata kept for audit. It assembles the upload, reads the manifest of a version 3 package for the audit (never its content) and stores the package in `job-resource` as the resource of the job, releasing it when the job never comes to own it.
|
|
||||||
- `get-job` is the read surface a profile has over its own jobs: it answers with the same summary the creation commands return plus the `result` of a finished job or its public error (through `decode-job-error`, so the keywords come back), and a job of another profile is not distinguishable from one that does not exist: both answer `not-found`. `decode-row` decodes `params`, `result` and `error`, and the result is then decoded with the decoder the substrate compiled from the result schema the job-def the row names declares (`decode-result`; a def without one, or a row whose job-def is gone, keeps the plain JSON the row holds: a uuid as the text it is on disk, a uuid used as a map key as a keyword). The event log still has no read surface: a client that follows a job takes its progress from the websocket.
|
|
||||||
- `heartbeat` uses named options `[cfg & {:keys [job-id progress] :as options}]` and returns the number of durable writes, so 0 means there was nothing to write: no job context, or the throttle did not allow it. A write that finds the job no longer active (terminal or gone) raises an `:interrupt` (`code :job-interrupted`, carrying the job id and the status it found) through the shared `jobs/check-active` instead of counting zero, so a task in course stops at its next beat; the interrupt is internal and never reaches HTTP (the management progress report answers `:skip` for it). The job id falls back to `::jobs/job-id` on the cfg and then to the runner-bound `*job-id*`. The `modified_at` touch is throttled to ~1s and the progress event to ~200ms, so the check fires at most once per second with no extra query (the read of the row happens only when a write already found nothing). A progress report is a milestone (`schema:progress`): a required `:stage` keyword plus an optional `:counters` map of `scope -> {:current, :total?}`, and no other key. Counters are non-negative, a `total` is positive and never lower than its `current`, and stage and counter keys are names of at most 64 characters. A milestone without counters is valid (a point of the run with no units to count), the stage vocabulary belongs to the worker and not to the substrate, and a client must degrade for a stage it does not know. Read a stored payload back with `jobs/decode-progress`: the database holds the keywords as strings. The 1s beat (down from 60s, so a cancelled heavy job is seen as gone at its next beat) costs one `modified_at` touch per beating job per second: cheap while the only heavy beater runs alone on its queue, revisit if concurrent beating jobs ever grow.
|
|
||||||
- `job.error` conforms to `app.jobs/schema:job-error` (`type` and `code` keywords, `hint` text, extra details allowed). Read it back with `jobs/decode-job-error`; a plain `db/decode-json-pgobject` leaves the keywords as strings. `complete` takes named options and an optional `resource-id`, which is only ever set, never replaced: it reads the row locked inside its own transaction and applies the rules in a fixed order, skipping a job that is no longer completable before refusing one for its resource, so the answer is a function of the row and not of the order two callers arrive in. It checks the result against the schema the job-def of the row declares before it writes (a violation raises `:invalid-result` and nothing is stored), and only for a transition that is going to write: a terminal job answers `:skip` without validating. `complete` is the single door of a result, so the check covers the runner and the external worker that completes a job through the management RPC (`::complete-job`), which stores a result the substrate would otherwise take blind.
|
|
||||||
|
|
||||||
For worker dispatch, cron, retry semantics (`ex/raise :type ::wrk/retry` with `:delay`/`:strategy`), deduplication, job events, and queue internals: `mem:backend/subtleties`.
|
|
||||||
|
|
||||||
## Jobs metrics
|
|
||||||
|
|
||||||
- `app.jobs.metrics` owns the jobs metric names, bounded labels and the periodic backlog sampler.
|
|
||||||
- Metrics use only `name`, `queue`, `outcome`, `reason`, `stage` and `kind` labels. Job IDs, profile IDs, params, reply bodies and exception text must never be labels. Every label goes as-is (lowercased where case varies): values come from fixed call sites, so a new value in Prometheus means new code, not noise. Only a missing value falls back (`other`, or `failed` for outcomes).
|
|
||||||
- The canonical job name is a keyword (`app.jobs/schema:job-name`): `submit` and `invoke` reject strings. The row stores text, so `jobs/get-job-def` still coerces (it is the runner's boundary), cron entries carry the job under `:job` with `d/name` only at the SQL/log boundary, and test helpers keyword-ize row names before invoking.
|
|
||||||
- The durable lifecycle metrics are submitted, dispatched, completed, retries, orphaned and rescheduled counters; queue-wait, execution and total-time histograms; dispatcher and backlog state; GC, cron and ephemeral request metrics.
|
|
||||||
- `app.metrics/run!` is safe for recording failures, but metrics components still require a valid metrics instance. Durable submit call sites carry `::mtx/metrics` through RPC or job-def configuration. The jobs substrate takes the **cfg**, not the instance, and resolves it with `app.metrics/instance`, which raises `:missing-metrics` when absent: `app.jobs`, `app.jobs.metrics`, the runner, the dispatcher, cron and the jobs GC all follow that. `app.http`, `app.rpc.climit` and `app.storage.s3.metrics` still take the instance and were left out of scope on purpose, so do not read the codebase as uniform. The six job writers resolve at the top of their body, before writing, because their metric lands in a `db/after-commit` callback that swallows exceptions. The GC, the dispatcher and cron resolve inside that callback instead, so their guarantee rests on the component schema instead. A job that calls `heartbeat` from a component cfg must carry `::mtx/metrics` on it, and the event helper records the counter from the cfg the transaction hands it.
|
|
||||||
- SQL-backed job metrics are registered with `app.db/after-commit` from INSIDE the transaction that changed the row, so a rollback cannot inflate submitted, terminal, retry, event or dispatcher counters. Every lifecycle writer owns that transaction (`app.jobs/own-transaction` drops `::db/conn`), and `db/transact!` gives a transaction that joins no other its own callback context, so the write and its metric commit or vanish together. `submit` is the exception and joins the caller on purpose: creating a job is part of the caller's business work.
|
|
||||||
- `penpot_jobs_events_total` counts stored job events with no labels: the interesting split is `kind`, and grouping a growing append-only table to build a metric is not worth the query on the write path.
|
|
||||||
- The backlog sampler is `::jobs-metrics/sampler`; it runs every 30 seconds on worker-enabled, writable systems, groups by status and publishes the oldest pending age, and does not start on a read-only database.
|
|
||||||
- `penpot_tasks_timing` remains exported for compatibility while the jobs-specific histograms are adopted.
|
|
||||||
|
|
||||||
|
For worker dispatch, cron, retry semantics, deduplication, and queue internals: `mem:backend/subtleties`.
|
||||||
|
|
||||||
## REPL
|
## REPL
|
||||||
|
|
||||||
@ -138,7 +99,9 @@ IMPORTANT: all CLI commands must be executed from the `backend/` subdirectory.
|
|||||||
* **Linting:** `pnpm run lint:clj`.
|
* **Linting:** `pnpm run lint:clj`.
|
||||||
* **Formatting:** `pnpm run check-fmt:clj` to check, `pnpm run fmt:clj` to fix. After running `fmt:clj`, `check-fmt:clj` is redundant. Avoid unrelated whitespace diffs.
|
* **Formatting:** `pnpm run check-fmt:clj` to check, `pnpm run fmt:clj` to fix. After running `fmt:clj`, `check-fmt:clj` is redundant. Avoid unrelated whitespace diffs.
|
||||||
|
|
||||||
**Before linting:** if delimiter errors are suspected (after LLM edits), run `scripts/paren-repair` on the affected files first. Delimiter errors produce misleading linter/compiler output. See `mem:scripts/paren-repair`.
|
**Before linting:** if delimiter errors are suspected (after LLM edits), run
|
||||||
|
`scripts/paren-repair` on the affected files first. Delimiter errors produce
|
||||||
|
misleading linter/compiler output. See `mem:scripts/paren-repair`.
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
|
|||||||
@ -1,633 +0,0 @@
|
|||||||
# Graph Experiment
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
- Purpose: project Penpot file data into an embedded Ladybug graph database.
|
|
||||||
- Purpose: keep the graph current with Penpot file changes.
|
|
||||||
- Purpose: expose a read-only graph console for backend debugging.
|
|
||||||
- This is an experiment, not a replacement for PostgreSQL file storage.
|
|
||||||
- The graph subsystem is off unless `:graph` is in the backend flags.
|
|
||||||
- The main Penpot frontend has no graph feature code for this subsystem.
|
|
||||||
- The graph console is a backend-served HTML template with JavaScript.
|
|
||||||
|
|
||||||
## Memory Links
|
|
||||||
|
|
||||||
- Read `mem:backend/core` for backend architecture, HTTP routes, DB rules, and test commands.
|
|
||||||
- Read `mem:backend/subtleties` for RPC and message bus behavior, and for file data loading and realization.
|
|
||||||
- Read `mem:common/changes-architecture` for the change record vocabulary.
|
|
||||||
- Read `mem:frontend/routing-app-shell-subtleties` for the existing notification WebSocket.
|
|
||||||
- Read `mem:prod-infra/core` for Redis or Valkey message bus topology.
|
|
||||||
|
|
||||||
## Branch Surface
|
|
||||||
|
|
||||||
- The graph experiment adds about 6,336 lines and changes about 27 files.
|
|
||||||
- The graph implementation lives under `backend/src/app/graph/`.
|
|
||||||
- The graph console lives at `backend/resources/app/templates/graph-console.tmpl`.
|
|
||||||
- The existing debug page gains graph links in `backend/resources/app/templates/debug.tmpl`.
|
|
||||||
- The existing debug HTTP routes gain graph handlers in `backend/src/app/http/debug.clj`.
|
|
||||||
- The backend system passes the message bus to the debug route component in `backend/src/app/main.clj`.
|
|
||||||
- The backend adds Ladybug and Arrow dependencies in `backend/deps.edn`.
|
|
||||||
- The backend adds JVM options for Ladybug and Arrow native access.
|
|
||||||
- The common flag registry adds `:graph` in `common/src/app/common/flags.cljc`.
|
|
||||||
- The graph experiment adds `graph_sync_parity_test.clj` and `graph_binder_gate_test.clj`.
|
|
||||||
|
|
||||||
## System Model
|
|
||||||
|
|
||||||
### Storage layers
|
|
||||||
|
|
||||||
- PostgreSQL remains the source of truth for Penpot files.
|
|
||||||
- The graph database stores a projection of one file.
|
|
||||||
- A persistent graph uses a `.lbug` path under `PENPOT_GRAPH_DIR`.
|
|
||||||
- The default graph directory is `/tmp/penpot-graph`.
|
|
||||||
- A debug session uses a Ladybug `:memory:` database.
|
|
||||||
- A debug session database lives inside the backend JVM process.
|
|
||||||
- A debug session does not survive a backend restart.
|
|
||||||
- A debug session does not store file data back to PostgreSQL.
|
|
||||||
|
|
||||||
### Two graph update paths
|
|
||||||
|
|
||||||
- Cold projection reads the complete file and rebuilds the graph.
|
|
||||||
- Incremental sync reads file change records and updates the open graph.
|
|
||||||
- Both paths must produce the same graph for the same file state.
|
|
||||||
- The parity test treats cold projection as the reference path.
|
|
||||||
- A reload discards the session graph and uses cold projection again.
|
|
||||||
|
|
||||||
## Main Namespaces
|
|
||||||
|
|
||||||
### `app.graph.ladybug`
|
|
||||||
|
|
||||||
- Opens and closes Ladybug `Database` and `Connection` objects.
|
|
||||||
- Installs and loads the Ladybug JSON extension.
|
|
||||||
- Executes Cypher statements.
|
|
||||||
- Executes prepared statements.
|
|
||||||
- Binds scalar parameters.
|
|
||||||
- Formats UUID, string, integer, number, JSON, and timestamp values.
|
|
||||||
- Formats compound values such as arrays, maps, and structs.
|
|
||||||
- Converts Ladybug values back to Clojure values.
|
|
||||||
- Limits normal query results to 200 rows by default.
|
|
||||||
- Detects result truncation with `:truncated?`.
|
|
||||||
- Uses query timeout `0` by default.
|
|
||||||
- Query timeout `0` disables the timeout.
|
|
||||||
- Provides `validate-on-connection!` for parse, bind, and read-only checks.
|
|
||||||
- `exec-prepared-on-connection!` prepares every statement before the first execution.
|
|
||||||
- A prepare failure stops the batch before a mutation runs.
|
|
||||||
|
|
||||||
### `app.graph.schema`
|
|
||||||
|
|
||||||
- Provides the public schema facade.
|
|
||||||
- Exposes schema version `penpot-graph-slice-4`.
|
|
||||||
- Delegates node and relationship definitions to `app.graph.schema.nodes`.
|
|
||||||
|
|
||||||
### `app.graph.schema.nodes`
|
|
||||||
|
|
||||||
- Holds the single registry for graph node tables.
|
|
||||||
- Generates node DDL.
|
|
||||||
- Generates relationship DDL.
|
|
||||||
- Maps Penpot shape types to graph tables.
|
|
||||||
- Projects source attributes into graph attributes.
|
|
||||||
- Formats graph column values.
|
|
||||||
- Quotes reserved graph labels such as `Group` and `Boolean`.
|
|
||||||
- Defines container tables and shape tables.
|
|
||||||
- Defines `IsChildOf`, `IsInstanceOf`, `RefersTo`, and `FillsSwapSlot`.
|
|
||||||
|
|
||||||
### `app.graph.schema.contract`
|
|
||||||
|
|
||||||
- Records deliberate graph contract decisions.
|
|
||||||
- Renames graph columns such as `:revn` to `revision`.
|
|
||||||
- Drops attributes that do not belong in this graph slice.
|
|
||||||
- Records attributes that the graph does not project.
|
|
||||||
- Applies per-table dropped attributes.
|
|
||||||
- Defines type overrides for vectors, transforms, colors, maps, and JSON arrays.
|
|
||||||
- Maps selected map keys to the frontend JSON naming convention.
|
|
||||||
- `:background-blur` remains a declared unprojected attribute.
|
|
||||||
|
|
||||||
### `app.graph.schema.projection`
|
|
||||||
|
|
||||||
- Derives projected schemas from canonical Malli schemas.
|
|
||||||
- Builds the projected document schema.
|
|
||||||
- Builds projected shape schemas.
|
|
||||||
- Selects the schema for each shape type.
|
|
||||||
|
|
||||||
### `app.graph.schema.types`
|
|
||||||
|
|
||||||
- Maps Malli types to Ladybug types.
|
|
||||||
- Maps matrices to `DOUBLE[6]`.
|
|
||||||
- Maps points to `DOUBLE[2]`.
|
|
||||||
- Maps rectangles to `DOUBLE[4]`.
|
|
||||||
- Maps colors to `UINT32`.
|
|
||||||
- Maps collections to Ladybug arrays.
|
|
||||||
- Maps `:map-of` schemas to `MAP`.
|
|
||||||
- Maps closed scalar maps to `STRUCT`.
|
|
||||||
- Maps other complex values to `JSON`.
|
|
||||||
|
|
||||||
### `app.graph.schema.values`
|
|
||||||
|
|
||||||
- Coerces source values to graph column values.
|
|
||||||
- Writes fixed vectors with deterministic order.
|
|
||||||
- Packs colors into the graph color representation.
|
|
||||||
- Sorts set values when deterministic output is needed.
|
|
||||||
|
|
||||||
### `app.graph.arrow`
|
|
||||||
|
|
||||||
- Loads projection rows with Apache Arrow.
|
|
||||||
- Creates temporary staged node and relationship tables.
|
|
||||||
- Uses `COPY ... FROM (MATCH ...)` for bulk loading.
|
|
||||||
- Groups relationship loads by source and target table pair.
|
|
||||||
- Resolves relationship endpoints with joins.
|
|
||||||
- Does not use `createArrowRelTable` for UUID relationship endpoints.
|
|
||||||
- The Arrow `RootAllocator` nests outside the Ladybug connection and closes after the connection and database close sequence; Ladybug keeps staged buffers until connection close, so an inner allocator leaks.
|
|
||||||
- `with-allocator!` keeps the body exception when the allocator close also throws, attaching the close failure as suppressed.
|
|
||||||
|
|
||||||
### `app.graph.ingest`
|
|
||||||
|
|
||||||
- Fetches a complete file with `bfc/get-file` and `:realize? true`.
|
|
||||||
- Rejects missing files.
|
|
||||||
- Rejects files without file data.
|
|
||||||
- Can run file data validation before projection.
|
|
||||||
- Creates the DDL.
|
|
||||||
- Loads nodes and edges through Arrow.
|
|
||||||
- Executes post-load transforms.
|
|
||||||
- Writes graph metadata last.
|
|
||||||
- Treats the final metadata write as the complete-build marker.
|
|
||||||
- Supports a persistent database path and an open connection.
|
|
||||||
- `ingest-on-connection!` requires a caller-owned `:arrow-alloc` that outlives the connection; it raises `:missing-arrow-allocator` without one.
|
|
||||||
|
|
||||||
### `app.graph.projection.document`
|
|
||||||
|
|
||||||
- Projects `Document`, `Page`, `Component`, and supported shape nodes.
|
|
||||||
- Skips the page root frame.
|
|
||||||
- Creates `IsChildOf` edges from shapes to parents.
|
|
||||||
- Creates page edges to the document.
|
|
||||||
- Creates component edges to the document.
|
|
||||||
- Stores page order in `Page.index` and edge `position`.
|
|
||||||
- Reverses the stored `:shapes` list for Penpot z-order.
|
|
||||||
- Adds `page-id` to every projected shape.
|
|
||||||
- Propagates an instance head `component-id` to descendants.
|
|
||||||
- Stops component inheritance at a non-Frame shape with its own component ID.
|
|
||||||
- Skips deleted components during cold projection.
|
|
||||||
- Logs unsupported shape types and missing shape records.
|
|
||||||
|
|
||||||
### `app.graph.projection.transforms`
|
|
||||||
|
|
||||||
- Runs after the base nodes and edges load.
|
|
||||||
- `link-component-instances` creates `IsInstanceOf` edges.
|
|
||||||
- A Frame needs `component-file` to qualify as an instance head.
|
|
||||||
- `link-shape-refs` creates `RefersTo` edges from `shape-ref`.
|
|
||||||
- Ladybug limits multi-label relationship `MERGE` statements.
|
|
||||||
- The transform emits one statement for each shape-table pair.
|
|
||||||
- `link-swap-slots` creates `FillsSwapSlot` edges.
|
|
||||||
- Swap slot IDs come from `swap-slot-<uuid>` entries in `touched`.
|
|
||||||
- The transform removes swap slot entries from `touched` after edge creation.
|
|
||||||
- The transform order matters because it reads and then changes `touched`.
|
|
||||||
|
|
||||||
### `app.graph.meta`
|
|
||||||
|
|
||||||
- Stores graph provenance in `GraphMeta`.
|
|
||||||
- Stores schema version, source revision, producer, and build time.
|
|
||||||
- The source revision identifies the file revision used for cold projection.
|
|
||||||
|
|
||||||
### `app.graph.stats` and `app.graph.report`
|
|
||||||
|
|
||||||
- `app.graph.stats` counts graph nodes and relationships from the live catalog.
|
|
||||||
- `app.graph.report` prints ingest information for REPL use.
|
|
||||||
|
|
||||||
## Cold Projection Flow
|
|
||||||
|
|
||||||
1. Get the file row and realized file data from PostgreSQL.
|
|
||||||
2. Read the file revision from the file row.
|
|
||||||
3. Build the node and edge projection.
|
|
||||||
4. Create all graph tables from the graph schema.
|
|
||||||
5. Load node rows with Arrow.
|
|
||||||
6. Load relationship rows with Arrow.
|
|
||||||
7. Run `CHECKPOINT;`.
|
|
||||||
8. Run the registered derived transforms.
|
|
||||||
9. Write `GraphMeta` as the final build step.
|
|
||||||
10. Return file ID, file revision, database path, projection stats, and transform stats.
|
|
||||||
|
|
||||||
### Projection node groups
|
|
||||||
|
|
||||||
- `Document` contains file-level attributes without the file data blob.
|
|
||||||
- `Document.options` receives file-level options from the data blob.
|
|
||||||
- `Page` contains page attributes without the page object map.
|
|
||||||
- `Component` contains component attributes without component object maps.
|
|
||||||
- Shape tables contain the supported shape attributes.
|
|
||||||
- The graph stores selected derived attributes such as `page-id`.
|
|
||||||
|
|
||||||
### Projection relationship groups
|
|
||||||
|
|
||||||
- Structural edges use `IsChildOf`.
|
|
||||||
- Page and component edges point to `Document`.
|
|
||||||
- Derived edges come from the post-load transform registry.
|
|
||||||
|
|
||||||
## Incremental Sync
|
|
||||||
|
|
||||||
### Change source
|
|
||||||
|
|
||||||
- `app.rpc.commands.files-update` persists the file update first.
|
|
||||||
- The same command publishes a `:file-change` message to the file topic.
|
|
||||||
- The topic key is the file UUID.
|
|
||||||
- The message contains the file ID, profile ID, session ID, revision, version, and changes.
|
|
||||||
- Library changes also publish a team-topic message.
|
|
||||||
- The graph session only consumes the file-topic `:file-change` messages.
|
|
||||||
|
|
||||||
### Session subscription
|
|
||||||
|
|
||||||
- `app.graph.debug/start-sync-loop!` creates a channel with a dropping buffer of 64.
|
|
||||||
- The session subscribes the channel to the file UUID topic.
|
|
||||||
- The loop reads one message at a time.
|
|
||||||
- The loop ignores message types other than `:file-change`.
|
|
||||||
- The loop stops when the channel closes.
|
|
||||||
- `destroy-session!` closes the channel and purges its message bus subscription.
|
|
||||||
|
|
||||||
### Session state
|
|
||||||
|
|
||||||
- Sessions are stored in a global `defonce` atom.
|
|
||||||
- The map key is the string form of `profile-id`.
|
|
||||||
- One profile has one graph session.
|
|
||||||
- Loading another file first destroys the old session.
|
|
||||||
- A session stores the Ladybug database, connection, and Arrow allocator; the allocator closes after the connection and database.
|
|
||||||
- A session stores a shared lock for graph access.
|
|
||||||
- A session stores file metadata.
|
|
||||||
- A session stores the incremental sync index.
|
|
||||||
- A session stores the message bus channel.
|
|
||||||
- A session stores load time and profile ID.
|
|
||||||
- The session keeps projection statistics but drops full projection rows after index creation.
|
|
||||||
|
|
||||||
### Sync index
|
|
||||||
|
|
||||||
- `build-index` starts from the complete cold projection.
|
|
||||||
- The index stores the graph file ID and document ID.
|
|
||||||
- The index stores the current graph revision.
|
|
||||||
- The index stores page IDs, names, and positions.
|
|
||||||
- The index stores component IDs, names, and deleted state.
|
|
||||||
- The index stores shape table, parent, position, frame, page, and component context.
|
|
||||||
- The index stores child IDs by parent ID.
|
|
||||||
- The index supports later change application without another PostgreSQL file read.
|
|
||||||
|
|
||||||
### Change application
|
|
||||||
|
|
||||||
- `apply-changes!` processes the change list in source order.
|
|
||||||
- Each supported change returns a new index and a list of Cypher statements.
|
|
||||||
- Unsupported changes enter the `:skipped` result.
|
|
||||||
- Supported changes enter the `:applied` result.
|
|
||||||
- The function collects all statements before it executes them.
|
|
||||||
- The function appends a document revision statement when at least one change applies.
|
|
||||||
- The index revision advances only when at least one change applies.
|
|
||||||
- A larger incoming revision than the index revision creates a warning.
|
|
||||||
- A revision gap does not trigger catch-up.
|
|
||||||
|
|
||||||
### Shape change rules
|
|
||||||
|
|
||||||
- `:add-obj` reuses `projection.document/denormalized-shape`.
|
|
||||||
- `:add-obj` creates the shape node and its parent edge.
|
|
||||||
- `:mod-obj` applies supported `:set` operations to graph columns.
|
|
||||||
- `:mod-obj` keeps false and zero values as values.
|
|
||||||
- `:del-obj` deletes shapes in deep post-order.
|
|
||||||
- `:mov-objects` detaches shapes from the old parent.
|
|
||||||
- `:mov-objects` closes the old sibling position gap.
|
|
||||||
- `:mov-objects` inserts shapes at the new position.
|
|
||||||
- `:mov-objects` updates `parent_id` and `frame_id`.
|
|
||||||
- `:mov-objects` rewrites container `shapes` values.
|
|
||||||
- The parent columns and child lists must match a cold projection.
|
|
||||||
|
|
||||||
### Page and component change rules
|
|
||||||
|
|
||||||
- Page add creates a projected page node and a document edge.
|
|
||||||
- Page delete removes the page subtree.
|
|
||||||
- Page modification updates supported page attributes.
|
|
||||||
- Component add creates a component node and document edge.
|
|
||||||
- Component modification updates supported component attributes.
|
|
||||||
- Component delete uses a soft-delete state.
|
|
||||||
- Component restore removes the soft-delete state.
|
|
||||||
- Component purge removes the component node and document edge.
|
|
||||||
- Component sync paths need more parity coverage than the current tests provide.
|
|
||||||
|
|
||||||
## Session Locking
|
|
||||||
|
|
||||||
- The sync loop and HTTP handlers share one lock per session.
|
|
||||||
- The lock protects one Ladybug connection from concurrent access.
|
|
||||||
- Queries acquire the lock before binder validation and execution.
|
|
||||||
- Graph data export acquires the lock before catalog reads.
|
|
||||||
- Session export acquires the lock before `EXPORT DATABASE`.
|
|
||||||
- A long query blocks sync for the same session.
|
|
||||||
- A sync batch blocks queries for the same session.
|
|
||||||
- Ladybug connection thread safety is not assumed.
|
|
||||||
|
|
||||||
## Graph Query Rules
|
|
||||||
|
|
||||||
- The console accepts Cypher text.
|
|
||||||
- Blank query text raises a validation error.
|
|
||||||
- The query first passes Ladybug prepare and bind checks.
|
|
||||||
- The query must pass the engine read-only analysis.
|
|
||||||
- A mutating query is rejected.
|
|
||||||
- The graph console does not provide a write path.
|
|
||||||
- A session graph is rebuilt from the file by Reload.
|
|
||||||
- Normal query results have a 200-row limit.
|
|
||||||
- Query results use string values for the HTML console representation.
|
|
||||||
- JSON requests receive a Transit JSON response with the query and result.
|
|
||||||
- HTML requests receive the rendered console with the result.
|
|
||||||
|
|
||||||
## Graph Data Export
|
|
||||||
|
|
||||||
### G6 data
|
|
||||||
|
|
||||||
- `/dbg/actions/graph-data` reads the live Ladybug database.
|
|
||||||
- It does not read the sync index for nodes and edges.
|
|
||||||
- It therefore shows database drift if a batch fails after index update.
|
|
||||||
- Node export covers all registered node tables.
|
|
||||||
- Relationship export reads the Ladybug relationship catalog.
|
|
||||||
- Relationship export includes source, target, relationship name, and position.
|
|
||||||
- Node and relationship export uses a 100,000-row limit.
|
|
||||||
- The response reports `truncated` when a limit cuts the result.
|
|
||||||
- The response reports buffer-manager memory usage.
|
|
||||||
|
|
||||||
### `.lbug` export
|
|
||||||
|
|
||||||
- `source=file` rebuilds the persistent graph from PostgreSQL file data.
|
|
||||||
- `source=file` runs a synchronous full ingest for each request.
|
|
||||||
- `source=session` exports the caller profile's live in-memory graph.
|
|
||||||
- Session export uses Ladybug `EXPORT DATABASE` to Parquet files.
|
|
||||||
- Session export creates a new `.lbug` database with `IMPORT DATABASE`.
|
|
||||||
- The temporary Parquet staging directory is deleted after import.
|
|
||||||
- The final session `.lbug` file remains in the system temporary directory.
|
|
||||||
- The HTTP response streams the database file to the caller.
|
|
||||||
|
|
||||||
## HTTP Routes and Access
|
|
||||||
|
|
||||||
- The graph routes live in `backend/src/app/http/debug.clj`.
|
|
||||||
- The graph route list is added only when `:graph` is enabled.
|
|
||||||
- `/dbg/graph` serves the graph console page.
|
|
||||||
- `/dbg/actions/graph-files` returns the profile file tree.
|
|
||||||
- `/dbg/actions/graph-load` loads a file into the profile session.
|
|
||||||
- `/dbg/actions/graph-unload` closes the profile session.
|
|
||||||
- `/dbg/actions/graph-reload` rebuilds the loaded file graph.
|
|
||||||
- `/dbg/actions/graph-query` runs a read-only Cypher query.
|
|
||||||
- `/dbg/actions/graph-sync-status` returns the sync state.
|
|
||||||
- `/dbg/actions/graph-data` returns nodes and edges for G6.
|
|
||||||
- `/dbg/actions/graph-export` streams a `.lbug` database.
|
|
||||||
- The `/dbg` session middleware remains active.
|
|
||||||
- The `/dbg` admin middleware remains active.
|
|
||||||
- A devenv host with a profile ID passes the debug authorization rule.
|
|
||||||
- Other hosts need a profile email in the configured admin set.
|
|
||||||
- `/dbg/actions/graph-files` lists reachable teams, projects, and files.
|
|
||||||
- The file tree query has a 500-file limit.
|
|
||||||
- The graph handlers resolve graph namespaces at call time.
|
|
||||||
- The backend requires `app.graph.debug` and `app.graph.ingest` when the flag is on.
|
|
||||||
- Ladybug native loading then fails during route initialization instead of first use.
|
|
||||||
|
|
||||||
## Console Frontend
|
|
||||||
|
|
||||||
### Page type
|
|
||||||
|
|
||||||
- `graph-console.tmpl` is a backend resource template.
|
|
||||||
- It is not a Rumext component.
|
|
||||||
- It is not part of the main frontend route table.
|
|
||||||
- The page uses browser `fetch` calls and a browser WebSocket.
|
|
||||||
- The page loads G6 version `5.1.1` from jsDelivr.
|
|
||||||
|
|
||||||
### File tree
|
|
||||||
|
|
||||||
- The page fetches `/dbg/actions/graph-files`.
|
|
||||||
- The response contains team, project, and file groups.
|
|
||||||
- The page creates the tree with DOM APIs.
|
|
||||||
- A file click submits the graph load form.
|
|
||||||
- The page shows a message when no file exists.
|
|
||||||
|
|
||||||
### Graph rendering
|
|
||||||
|
|
||||||
- The page fetches `/dbg/actions/graph-data`.
|
|
||||||
- The page converts graph nodes and edges to G6 data.
|
|
||||||
- The page skips repaint when the node and edge signature does not change.
|
|
||||||
- The page marks added, removed, and changed graph entities.
|
|
||||||
- The page supports tree, dagre, circular, force, and combo layouts.
|
|
||||||
- The page supports collapsed container combos.
|
|
||||||
- The page has render guards at 4,000 nodes and 8,000 edges.
|
|
||||||
- The `?safe` query option bypasses the render guard.
|
|
||||||
- The page shows graph size by node count and relationship count.
|
|
||||||
- The page shows buffer-manager memory in MiB.
|
|
||||||
- The page reports a CDN failure when G6 is undefined.
|
|
||||||
|
|
||||||
### Query result filtering
|
|
||||||
|
|
||||||
- A query can return `filter_*` columns with node IDs.
|
|
||||||
- The HTML result table hides columns with the `filter_` prefix.
|
|
||||||
- The JSON result keeps the full result.
|
|
||||||
- The graph view uses the hidden IDs to select matching nodes.
|
|
||||||
- The graph view re-runs the query after graph refresh.
|
|
||||||
- This keeps the query filter aligned with the current graph.
|
|
||||||
- A user column named `filter_*` follows the same hiding rule.
|
|
||||||
|
|
||||||
### Node inspector
|
|
||||||
|
|
||||||
- A node click creates a query for that node.
|
|
||||||
- The inspector calls `/dbg/actions/graph-query` with JSON negotiation.
|
|
||||||
- The inspector displays the full projected row.
|
|
||||||
- The inspector uses table and ID values from the graph data.
|
|
||||||
|
|
||||||
## WebSocket Data Flow
|
|
||||||
|
|
||||||
1. The page opens `/ws/notifications` with a random `session-id` query value.
|
|
||||||
2. The page sends `:subscribe-file` with a Transit UUID value.
|
|
||||||
3. The server makes sure that the file exists and that the profile has read permission.
|
|
||||||
4. The server subscribes the connection to the file topic.
|
|
||||||
5. `files_update` publishes `:file-change` to the same topic.
|
|
||||||
6. The graph session consumes the message from its message bus subscription.
|
|
||||||
7. The WebSocket server sends the message to the browser connection.
|
|
||||||
8. The browser adds the change to the changelog.
|
|
||||||
9. The browser fetches sync status after 150 milliseconds.
|
|
||||||
10. The browser fetches graph data after a 400-millisecond debounce.
|
|
||||||
11. The browser repaints the G6 graph when the graph data changes.
|
|
||||||
|
|
||||||
### WebSocket reconnect behavior
|
|
||||||
|
|
||||||
- The page reconnects after three seconds when the socket closes.
|
|
||||||
- The page resubscribes to the file after the socket opens.
|
|
||||||
- The page refreshes sync status after reconnect.
|
|
||||||
- The page refreshes graph data after reconnect.
|
|
||||||
- Reconnect does not recover dropped message-bus changes.
|
|
||||||
- The page shows the sync error or skipped-change state when the status reports it.
|
|
||||||
|
|
||||||
## Feature Flag and Runtime Dependencies
|
|
||||||
|
|
||||||
- `:graph` is defined in `common/src/app/common/flags.cljc`.
|
|
||||||
- The flag is off by default.
|
|
||||||
- `com.ladybugdb/lbug` version `0.20.4` is a backend dependency.
|
|
||||||
- `org.apache.arrow/arrow-memory-netty` version `19.0.0` supports Arrow `RootAllocator`.
|
|
||||||
- The JVM uses `--enable-native-access=ALL-UNNAMED`.
|
|
||||||
- The JVM uses `--add-opens=java.base/java.nio=ALL-UNNAMED`.
|
|
||||||
- The JVM uses `--sun-misc-unsafe-memory-access=allow`.
|
|
||||||
- The JVM options appear in the development alias and backend launch scripts.
|
|
||||||
- A Ladybug version change needs new binder and parity tests.
|
|
||||||
- A JDK version change needs a startup test with the graph flag enabled.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
### `backend-tests.graph-sync-parity-test`
|
|
||||||
|
|
||||||
- Uses two Ladybug `:memory:` databases under one Arrow allocator outer to both; an allocator closed before its connections leaks.
|
|
||||||
- Does not use PostgreSQL or a live graph session.
|
|
||||||
- Projects initial file data into database A.
|
|
||||||
- Applies changes to database A through incremental sync.
|
|
||||||
- Applies the same changes to file data.
|
|
||||||
- Projects the changed file data into database B.
|
|
||||||
- Compares every node row and relationship row.
|
|
||||||
- Reports differences by table, row key, and column.
|
|
||||||
- Covers shape add, shape modification, shape deletion, movement, and page changes.
|
|
||||||
- Contains a test that injects a sync defect and expects a graph difference.
|
|
||||||
- Contains a test that `ingest-on-connection!` without `:arrow-alloc` raises `:missing-arrow-allocator`.
|
|
||||||
- Does not cover all component change variants.
|
|
||||||
- Does not cover every movement insertion mode.
|
|
||||||
|
|
||||||
### `backend-tests.graph-binder-gate-test`
|
|
||||||
|
|
||||||
- Creates the live graph DDL in a Ladybug `:memory:` database.
|
|
||||||
- Prepares each sync statement template without executing it.
|
|
||||||
- Detects parse errors and missing tables.
|
|
||||||
- Detects missing columns and bad label quoting.
|
|
||||||
- Reports the expected read-only classification.
|
|
||||||
- Covers reserved node labels across the node registry.
|
|
||||||
- Reports an error result for an invalid statement.
|
|
||||||
|
|
||||||
### Test gaps
|
|
||||||
|
|
||||||
- No automated HTTP handler tests cover graph routes.
|
|
||||||
- No automated session lifecycle tests cover load and unload.
|
|
||||||
- No automated WebSocket tests cover graph subscription.
|
|
||||||
- No automated export tests cover persistent and session sources.
|
|
||||||
- Component add, modify, delete, restore, and purge need parity tests.
|
|
||||||
- Page delete needs parity coverage.
|
|
||||||
- Movement with `:after-shape` needs parity coverage.
|
|
||||||
- Buffer overflow and revision gap behavior need tests.
|
|
||||||
- Partial batch failure and recovery need tests.
|
|
||||||
- Query timeout and long-query behavior need tests.
|
|
||||||
|
|
||||||
## Known Risks and Limits
|
|
||||||
|
|
||||||
### Dropped changes
|
|
||||||
|
|
||||||
- The sync channel uses a dropping buffer of 64.
|
|
||||||
- A burst can discard file-change messages.
|
|
||||||
- The sync loop logs a revision gap when it sees a larger revision.
|
|
||||||
- The sync loop does not fetch missing rows from `file_change`.
|
|
||||||
- Reload is the only built-in recovery path.
|
|
||||||
|
|
||||||
### Partial batch state
|
|
||||||
|
|
||||||
- `apply-changes!` does not provide Ladybug transaction atomicity.
|
|
||||||
- A statement failure can leave a partly changed graph.
|
|
||||||
- The in-memory index can advance before the database state is complete.
|
|
||||||
- `/dbg/actions/graph-data` reads the database and exposes this drift.
|
|
||||||
- Reload rebuilds the graph from PostgreSQL file data.
|
|
||||||
|
|
||||||
### Query resource use
|
|
||||||
|
|
||||||
- The default session query timeout is zero.
|
|
||||||
- A costly query can hold the session lock for a long time.
|
|
||||||
- The same lock blocks incremental sync.
|
|
||||||
- The graph export also holds the same lock during catalog reads.
|
|
||||||
- The graph schema has a high memory floor.
|
|
||||||
- The console reports about 115 MiB for the wide slice before file data.
|
|
||||||
|
|
||||||
### Session lifecycle
|
|
||||||
|
|
||||||
- Sessions have no TTL.
|
|
||||||
- Sessions remain until unload, replacement, or process shutdown.
|
|
||||||
- Each session owns native Ladybug memory and its Arrow allocator.
|
|
||||||
- Many profiles can create many native databases.
|
|
||||||
- A profile load replaces its previous session.
|
|
||||||
- Two browser tabs for one profile share one graph session.
|
|
||||||
|
|
||||||
### Temporary files
|
|
||||||
|
|
||||||
- Session export leaves the final `.lbug` file in the system temporary directory.
|
|
||||||
- Long-lived servers can accumulate exported session databases.
|
|
||||||
- The staging directory is deleted after import.
|
|
||||||
|
|
||||||
### Browser dependency
|
|
||||||
|
|
||||||
- The graph view depends on a runtime CDN request.
|
|
||||||
- A network restriction can remove the G6 view.
|
|
||||||
- Queries and session status still use backend endpoints without G6.
|
|
||||||
|
|
||||||
### Data exposure
|
|
||||||
|
|
||||||
- The graph console can list many files available to the profile.
|
|
||||||
- The console can load complete projected file data.
|
|
||||||
- The console can export a graph database.
|
|
||||||
- The console can inspect all projected node attributes.
|
|
||||||
- The console is safe only when the `/dbg` access boundary is correct.
|
|
||||||
- The graph flag must remain off for deployments that do not need this tool.
|
|
||||||
|
|
||||||
### Contract drift
|
|
||||||
|
|
||||||
- The graph schema is a deliberate slice of the Penpot file model.
|
|
||||||
- New source attributes do not enter the graph automatically in all cases.
|
|
||||||
- Dropped and unprojected attributes need an explicit contract decision.
|
|
||||||
- `applied_tokens` key mapping depends on the JSON naming function.
|
|
||||||
- `filter_*` is a frontend convention, not a graph schema guarantee.
|
|
||||||
|
|
||||||
### Ladybug dialect coupling
|
|
||||||
|
|
||||||
- Cypher strings contain Ladybug-specific syntax.
|
|
||||||
- Label quoting handles reserved labels explicitly.
|
|
||||||
- Relationship transforms depend on Ladybug relationship limits.
|
|
||||||
- Arrow loading depends on Ladybug `COPY FROM (MATCH ...)` behavior.
|
|
||||||
- A dependency upgrade needs schema, binder, Arrow, and parity checks.
|
|
||||||
|
|
||||||
## REPL Helpers
|
|
||||||
|
|
||||||
- `app.srepl.main` resolves graph functions only when a helper runs.
|
|
||||||
- `graph-smoke-test!` runs a basic Ladybug operation.
|
|
||||||
- `graph-query-test!` runs a graph query test.
|
|
||||||
- `ingest-file-to-graph!` projects a file into a graph database.
|
|
||||||
- These helpers use `requiring-resolve` to keep the graph dependency lazy.
|
|
||||||
|
|
||||||
## Operational Invariants
|
|
||||||
|
|
||||||
- PostgreSQL file data remains authoritative.
|
|
||||||
- Cold projection and incremental sync must produce equal graph state.
|
|
||||||
- The graph revision must identify the last applied file revision.
|
|
||||||
- The document revision must update when a sync batch applies.
|
|
||||||
- A missing or skipped change must remain visible in sync status.
|
|
||||||
- A graph query from the console must be read-only.
|
|
||||||
- A graph session must serialize connection access.
|
|
||||||
- Graph routes must remain behind the `:graph` flag and `/dbg` access control.
|
|
||||||
- The Arrow allocator nests outside the Ladybug connection and must outlive all Ladybug operations that use its buffers; a session owns its allocator until unload.
|
|
||||||
- `GraphMeta` must be written after the full ingest and transforms finish.
|
|
||||||
|
|
||||||
## Key Files
|
|
||||||
|
|
||||||
- `backend/src/app/graph/ladybug.clj`: Ladybug API and query gates.
|
|
||||||
- `backend/src/app/graph/arrow.clj`: Arrow bulk load.
|
|
||||||
- `backend/src/app/graph/ingest.clj`: Complete file ingest.
|
|
||||||
- `backend/src/app/graph/debug.clj`: Session lifecycle, sync loop, query, and export.
|
|
||||||
- `backend/src/app/graph/sync.clj`: Incremental change application.
|
|
||||||
- `backend/src/app/graph/meta.clj`: Graph provenance.
|
|
||||||
- `backend/src/app/graph/stats.clj`: Graph counts.
|
|
||||||
- `backend/src/app/graph/report.clj`: REPL ingest report.
|
|
||||||
- `backend/src/app/graph/projection/document.clj`: Base document projection.
|
|
||||||
- `backend/src/app/graph/projection/transforms.clj`: Derived relationship transforms.
|
|
||||||
- `backend/src/app/graph/schema/nodes.clj`: Node and relationship registry.
|
|
||||||
- `backend/src/app/graph/schema/contract.clj`: Projection contract decisions.
|
|
||||||
- `backend/src/app/graph/schema/projection.clj`: Malli projection schemas.
|
|
||||||
- `backend/src/app/graph/schema/types.clj`: Malli-to-Ladybug type mapping.
|
|
||||||
- `backend/src/app/graph/schema/values.clj`: Value coercion.
|
|
||||||
- `backend/src/app/http/debug.clj`: Graph route registration and handlers.
|
|
||||||
- `backend/src/app/http/websocket.clj`: File WebSocket subscription handlers.
|
|
||||||
- `backend/src/app/rpc/commands/files_update.clj`: File-change publication.
|
|
||||||
- `backend/src/app/main.clj`: Integrant message bus wiring.
|
|
||||||
- `backend/resources/app/templates/graph-console.tmpl`: Graph console browser code.
|
|
||||||
- `backend/resources/app/templates/debug.tmpl`: Debug page graph links.
|
|
||||||
- `common/src/app/common/flags.cljc`: `:graph` feature flag.
|
|
||||||
- `backend/test/backend_tests/graph_sync_parity_test.clj`: Cold versus sync parity.
|
|
||||||
- `backend/test/backend_tests/graph_binder_gate_test.clj`: Cypher binder gate.
|
|
||||||
|
|
||||||
## Development Commands
|
|
||||||
|
|
||||||
- Run backend commands from the `backend/` directory.
|
|
||||||
- Run focused parity tests with `clojure -M:dev:test --focus backend-tests.graph-sync-parity-test`.
|
|
||||||
- Run focused binder tests with `clojure -M:dev:test --focus backend-tests.graph-binder-gate-test`.
|
|
||||||
- Run the backend test suite with `clojure -M:dev:test`.
|
|
||||||
- Examine Clojure formatting with `pnpm run check-fmt:clj`.
|
|
||||||
- Run backend Clojure lint with `pnpm run lint:clj`.
|
|
||||||
- Write test output to a file before reading or filtering it.
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
# Backend Session Expiration
|
|
||||||
|
|
||||||
## Config
|
|
||||||
|
|
||||||
- `:auth-token-cookie-name` / `PENPOT_AUTH_TOKEN_COOKIE_NAME` (default `auth-token`): cookie name.
|
|
||||||
- `:auth-token-cookie-max-age` / `PENPOT_AUTH_TOKEN_COOKIE_MAX_AGE` (default 7d): idle window; drives the sliding cookie `Expires` and the GC idle threshold.
|
|
||||||
- `:auth-token-cookie-max-age-absolute` / `PENPOT_AUTH_TOKEN_COOKIE_MAX_AGE_ABSOLUTE` (default 30d): hard cap from `created-at`; drives the token `:exp` and the GC absolute threshold.
|
|
||||||
- Durations decode as `<n><unit>` with hour/minute/second units (`168h`, `30m`); day units like `7d` are rejected by the `Duration/parse` string path, use hours (`168h`, `720h`).
|
|
||||||
- Session lifetime defaults live only as code constants in `session.clj` (`default-cookie-max-age`, `default-cookie-max-age-absolute`); do not duplicate them in the `config.clj` default map. Call sites always pass the constant as the `cf/get` fallback.
|
|
||||||
|
|
||||||
## Token and session model
|
|
||||||
|
|
||||||
- Sessions live only in `http_session_v2`. Legacy v1 support (`http_session`, string ids, `:ver 0` tokens) was removed and the table dropped (`0155-drop-http-session-table`).
|
|
||||||
- `assign-token` emits header `{:kid 1 :ver 1}` with claims `:sid`, `:iat` (= `modified-at`) and `:exp` = `created-at + absolute-max-age` (omitted only when `created-at` is nil, which neither manager produces today; the branch is defensive).
|
|
||||||
- `:exp` is anchored to `created-at`, never `modified-at`, so renewal cannot extend the absolute maximum.
|
|
||||||
- Tokens issued before `:exp` existed carry no `:exp`; they are still bounded by the GC's `created_at` condition and acquire `:exp` on their next renewal (self-healing, no operator action).
|
|
||||||
- `wrap-authz` resolves the session by `(:sid claims)` only; there is no fallback to reading a session by the raw token string.
|
|
||||||
- `middleware/wrap-auth` attaches `::http/auth-data` only for `kid=1`/`ver=1` tokens with a configured decoder; anything else stays unauthenticated.
|
|
||||||
- Renewal fires when `modified-at` is older than 6h (`default-renewal-max-age`, not configurable). It `UPDATE`s the same row (`modified-at` only) and issues a new token that keeps the original `:exp`.
|
|
||||||
- `read-session` does not check age. Idle expiration is enforced on every request by `wrap-authz` (sessions past the idle window authenticate like missing ones and are never renewed); the GC only deletes the rows afterwards.
|
|
||||||
|
|
||||||
## Revocation paths
|
|
||||||
|
|
||||||
- Profile deletion → `session/invalidate-all` (all sessions of the profile die).
|
|
||||||
- Authenticated password change → `session/invalidate-others` (every session except the caller's dies).
|
|
||||||
- Password recovery (`recover-profile`, GHSA-3j2p-qr45-q365) → `session/invalidate-all` inside the same transaction as the password `UPDATE`; there is no current session to preserve, and a captured session must not survive recovery. Sibling of GHSA-mj9f-5cwq-7p3q (logout deletes the current session row).
|
|
||||||
|
|
||||||
## GC (`::tasks/gc`, cron `session-gc`, daily)
|
|
||||||
|
|
||||||
- Deletes from `http_session_v2` where `modified_at < now - :auth-token-cookie-max-age` **or** `created_at < now - :auth-token-cookie-max-age-absolute`.
|
|
||||||
- The two thresholds are separate task params (`::tasks/max-age`, `::tasks/max-age-absolute`) built in `ig/expand-key`; both must be durations.
|
|
||||||
- Do not collapse the two conditions: `modified_at` alone never collects active sessions; `created_at` alone logs out active users at the idle window.
|
|
||||||
|
|
||||||
## Related lifetimes
|
|
||||||
|
|
||||||
- Organization SSO entries in session `:props` (`:sso {org-id exp}`) last 4h, hardcoded in `app.auth.oidc`.
|
|
||||||
- Access tokens (`app.rpc.commands.access-token`) have a user-chosen `:expires-at` (Never/30/60/90/180d), independent from HTTP sessions.
|
|
||||||
- Cookie `SameSite`/`secure` depend on `:cors`, `:strict-session-cookies`, `:secure-session-cookies`; `parse-flags` auto-adds `:disable-secure-session-cookies` for non-localhost HTTP `public-uri`.
|
|
||||||
- Without `PENPOT_SECRET_KEY`, derived subsystem keys change on restart and all sessions/invitations are invalidated.
|
|
||||||
- Read-only DB pool: sessions fall back to `inmemory-manager`, lost on restart, no GC.
|
|
||||||
- HTTP middleware and cookie/header precedence details: `mem:backend/subtleties`.
|
|
||||||
@ -24,61 +24,20 @@
|
|||||||
- `get-object` excludes rows with `deleted_at`.
|
- `get-object` excludes rows with `deleted_at`.
|
||||||
- Existing object values can remain readable until physical deletion.
|
- Existing object values can remain readable until physical deletion.
|
||||||
- `:expired-at` blocks reads after the expiration time.
|
- `:expired-at` blocks reads after the expiration time.
|
||||||
- `del-object!` sets `deleted_at` on live rows only (`deleted_at IS NULL`): a repeated call returns `false`. It does not remove backend content.
|
- `del-object!` sets `deleted_at`. It does not remove backend content.
|
||||||
- `storage-gc-deleted` removes the database row and backend content after the deletion delay, processing the pending objects in chunks of 25 with keyset pagination (`(deleted_at, id)` cursor, matching the `storage_object(deleted_at, id)` index). Only `status = 'valid'` objects are read: pending ones (still being written, see the status lifecycle) stay untouched even when already marked as deleted. Each chunk is one short read-write transaction: `SELECT ... FOR UPDATE SKIP LOCKED` (so two concurrent runs never take the same chunk; no separate read transaction exists and the run does not block the table vacuum) followed by the database delete and the backend delete grouped by backend. The cursor advances to the `(deleted_at, id)` of the last row read regardless of the deletion result, so a chunk that fails is skipped and not visited again in the same run: the error aborts the transaction (nothing of the chunk is deleted, locks are released), the handler catches it inside the transaction function and rolls it back explicitly — the commit that `tx-run!` performs afterwards is a JDBC-driver no-op on the already-rolled-back connection — and the loop continues with the returned rows. Accepted quirks, both benign and self-healing: (1) with rows of several backends in one chunk, a failure after one group's physical delete leaves those rows pending with already-removed content — pending rows are excluded from reads and the next run finishes them, since the physical delete is idempotent (S3 ignores missing keys, FS uses `deleteIfExists`); (2) rows locked by a concurrent run are skipped via `SKIP LOCKED` and deferred to the next scheduled run, and the `deleted_at <= now` cutoff is sampled per chunk. It emits the `penpot_storage_gc_deleted_objects_total{backend}` counter (one increment per deleted backend group, reported only after the chunk commits, so rolled-back chunks are never counted twice); run duration is covered by the generic `penpot_tasks_timing{name="storage-gc-deleted"}` histogram and chunk failures by the log-derived `penpot_log_events_total`. Every 5000 deleted objects the run pauses 5 seconds (throttle between chunk transactions, never holding one open). It runs as the `storage-gc-deleted` job (`::job-def`) and beats `jobs/heartbeat` after each committed chunk, so a long sweep keeps its lease and never holds it during a chunk transaction.
|
- `storage-gc-deleted` removes the database row and backend content after the deletion delay, processing the pending objects in chunks of 25 with keyset pagination (`(deleted_at, id)` cursor, matching the `storage_object(deleted_at, id)` index). Each chunk is one short read-write transaction: `SELECT ... FOR UPDATE SKIP LOCKED` (so two concurrent runs never take the same chunk; no separate read transaction exists and the run does not block the table vacuum) followed by the database delete and the backend delete grouped by backend. The cursor advances to the `(deleted_at, id)` of the last row read regardless of the deletion result, so a chunk that fails is skipped and not visited again in the same run: the error aborts the transaction (nothing of the chunk is deleted, locks are released), the handler catches it inside the transaction function and rolls it back explicitly — the commit that `tx-run!` performs afterwards is a JDBC-driver no-op on the already-rolled-back connection — and the loop continues with the returned rows. Accepted quirks, both benign and self-healing: (1) with rows of several backends in one chunk, a failure after one group's physical delete leaves those rows pending with already-removed content — pending rows are excluded from reads and the next run finishes them, since the physical delete is idempotent (S3 ignores missing keys, FS uses `deleteIfExists`); (2) rows locked by a concurrent run are skipped via `SKIP LOCKED` and deferred to the next scheduled run, and the `deleted_at <= now` cutoff is sampled per chunk. It emits the `penpot_storage_gc_deleted_objects_total{backend}` counter (one increment per deleted backend group, reported only after the chunk commits, so rolled-back chunks are never counted twice); run duration is covered by the generic `penpot_tasks_timing{name="storage-gc-deleted"}` histogram and chunk failures by the log-derived `penpot_log_events_total`. Every 5000 deleted objects the run pauses 5 seconds (throttle between chunk transactions, never holding one open).
|
||||||
- `storage-gc-touched` finds references before it sets `deleted_at`.
|
- `storage-gc-touched` finds references before it sets `deleted_at`.
|
||||||
- Orphan watch: `SELECT COALESCE(metadata->>'bucket', metadata->>'~:bucket') AS bucket, count(*) FROM storage_object so WHERE touched_at IS NULL AND deleted_at IS NULL AND status = 'valid' AND NOT EXISTS (SELECT 1 FROM upload_session_chunk usc WHERE usc.object_id = so.id) GROUP BY 1;` Only the `upload-session` row of that output is a leak signal (its rows always have a mapping or a pending touch/deleted mark); other buckets use domain-table references, not this mapping.
|
|
||||||
- `objects-gc` removes deleted domain rows and touches their storage object IDs. Each proc streams its pending keys with `db/plan` inside a read-only transaction and deletes them in chunks, each chunk in its own transaction with `FOR UPDATE SKIP LOCKED`: a chunk that fails is logged and skipped instead of aborting the run.
|
- `objects-gc` removes deleted domain rows and touches their storage object IDs. Each proc streams its pending keys with `db/plan` inside a read-only transaction and deletes them in chunks, each chunk in its own transaction with `FOR UPDATE SKIP LOCKED`: a chunk that fails is logged and skipped instead of aborting the run.
|
||||||
- Use `::db/reuse-conn true` with `sto/resolve` inside a database transaction.
|
- Use `::db/reuse-conn true` with `sto/resolve` inside a database transaction.
|
||||||
|
|
||||||
## GC Cost Model
|
|
||||||
|
|
||||||
- `sto/touch-object!` is one `UPDATE storage_object SET touched_at`: DB-only, never touches S3/FS backend content.
|
|
||||||
- Physical FK cascades are avoided by convention; domain deletion is logical (`deleted_at`) everywhere. GC removes small objects first, then parents, then grandparents (see the call order in `app.tasks.objects-gc/execute-objects-gc`). Per-row delete cost is small and bounded.
|
|
||||||
- `objects-gc` sweeps in chunks of 100 (`::chunk-size`, overridable per job params); `storage-gc-deleted` in chunks of 25. `objects-gc` (and the other `db/plan` sweeps) stream the pending keys in a read-only transaction of their own and delete every chunk in a transaction of its own: the cursor fetch and the deletes are never the same transaction. `storage-gc-deleted` has no separate cursor transaction: it reads, locks and deletes each chunk in the same short transaction (see the keyset pagination above).
|
|
||||||
- Consequence: per-chunk cost is DB-only and bounded, so these sweeps cannot outrun the 30-minute jobs lease in practice (would need millions of pending rows in one proc). Per-chunk `heartbeat` where present is belt-and-braces, not load-bearing.
|
|
||||||
|
|
||||||
## Connection Reuse Details
|
|
||||||
|
|
||||||
### `app.storage/resolve` patterns:
|
|
||||||
|
|
||||||
**1. Pool mode (default)** - `(sto/resolve cfg)`
|
|
||||||
- Returns storage abstraction from config
|
|
||||||
- Uses whatever database pool is available
|
|
||||||
- **Safe to call outside transaction context**
|
|
||||||
- Used in: `rpc/commands/media.clj:363`, `rpc/commands/auth.clj:327`, `rpc/commands/profile.clj:362`
|
|
||||||
|
|
||||||
**2. Connection reuse mode** - `(sto/resolve cfg ::db/reuse-conn true)`
|
|
||||||
- Internally calls `db/get-connection cfg` to obtain connectable
|
|
||||||
- Configures storage with the specific connection from config
|
|
||||||
- **Must be paired with transaction that owns this connection**
|
|
||||||
- Used in: `features/fdata.clj:100`, `rpc/commands/media.clj:425`, `rpc/commands/files_thumbnails.clj:307,319`, `binfile/v3.clj:722`
|
|
||||||
|
|
||||||
**3. Explicit configuration** - `(sto/configure storage conn)`
|
|
||||||
- Sets `::db/conn` on storage map directly
|
|
||||||
- Asserts `db/conn? connection` (storage.clj:349)
|
|
||||||
- Used inside `db/tx-run!` blocks where `conn` is already available
|
|
||||||
- Used in: `tasks/file_gc.clj:256`, `rpc/commands/files_thumbnails.clj:347,371`
|
|
||||||
|
|
||||||
### Key Warning (from function notes):
|
|
||||||
|
|
||||||
The improved note in `import-storage-objects` and `handle-persistence` warns: **Do not reuse the main database connection for storage operations within a transaction.** The storage upload process can fail mid-operation, leaving orphaned objects on the backend. If the outer transaction aborts, pending storage objects become unreconciliable because the storage subsystem registers its pending state in separate transactions.
|
|
||||||
|
|
||||||
### Rule of Thumb for `sto/put-object!`:
|
|
||||||
|
|
||||||
Since `put-object!` uses backend-specific operations (`impl/resolve-backend` + `impl/put-object`) and does not directly use `::db/conn` or `::db/pool`, **all usage of `put-object!` will never run inside a common transaction** (if configured at all). The storage backend operations are independent of the database transaction boundary.
|
|
||||||
|
|
||||||
## Deduplication
|
## Deduplication
|
||||||
|
|
||||||
- Deduplication requires `::sto/deduplicate?`, a content hash, and bucket metadata.
|
- Deduplication requires `::sto/deduplicate?`, a content hash, and bucket metadata.
|
||||||
- The lookup matches hash, bucket, backend, and `deleted_at IS NULL`.
|
- The lookup matches hash, bucket, backend, and `deleted_at IS NULL`.
|
||||||
- The lookup only considers rows with `status='valid'`; pending rows are invisible.
|
|
||||||
- A hit whose blob is missing is repaired in place: the same row/id is kept, and `put-object!` rewrites the blob under that id. This heals all existing references to the object. If the rewrite fails, the row is left live and valid for a later retry.
|
|
||||||
- The lookup does not include file ID, profile ID, team ID, or organization ID.
|
- The lookup does not include file ID, profile ID, team ID, or organization ID.
|
||||||
- Objects can therefore share content across users and files within one bucket.
|
- Objects can therefore share content across users and files within one bucket.
|
||||||
- Deleted objects are not reused.
|
- Deleted objects are not reused.
|
||||||
- `tempfile` objects never use deduplication, even when the caller requests it.
|
- `tempfile` objects never use deduplication, even when the caller requests it.
|
||||||
- `job-resource` objects never use deduplication either, whatever the caller asks: the object belongs to one profile, and a shared blob would serve the artifact of one user to the job of another. `put-object!` excludes the bucket from the dedupable set, so the invariant does not depend on call sites.
|
|
||||||
- Use `sto/wrap-with-hash` when the caller already calculated the content hash.
|
- Use `sto/wrap-with-hash` when the caller already calculated the content hash.
|
||||||
|
|
||||||
## Bucket Rules
|
## Bucket Rules
|
||||||
@ -91,18 +50,16 @@ Since `put-object!` uses backend-specific operations (`impl/resolve-backend` + `
|
|||||||
| `file-thumbnail` | File grid thumbnails in `file_thumbnail.media_id`. | Yes | Authentication required | Reference scan. |
|
| `file-thumbnail` | File grid thumbnails in `file_thumbnail.media_id`. | Yes | Authentication required | Reference scan. |
|
||||||
| `profile` | User and team profile photos. References: `profile.photo_id` and `team.photo_id`. | Yes | Authentication required | Reference scan. |
|
| `profile` | User and team profile photos. References: `profile.photo_id` and `team.photo_id`. | Yes | Authentication required | Reference scan. |
|
||||||
| `organization` | Organization logos uploaded by the Nitrate management API. | Yes | Public | No reference scan. A touched object is deleted. |
|
| `organization` | Organization logos uploaded by the Nitrate management API. | Yes | Public | No reference scan. A touched object is deleted. |
|
||||||
| `tempfile` | Export files and temporary font downloads. | No | Authentication required | No reference scan. A touched object uses a two-hour deletion delay. |
|
| `tempfile` | Export files, chunked-upload chunks, and temporary font downloads. | No | Authentication required | No reference scan. A touched object uses a two-hour deletion delay. |
|
||||||
| `upload-session` | Chunked-upload chunks. References: `upload_session_chunk.object_id` and `upload_session_chunk.session_id` (both NO ACTION DEFERRABLE: restrict semantics, procedural deletion). | No | Authentication required | Reference scan on `upload_session_chunk.object_id`; a referenced chunk freezes, an orphan is deleted after the delay. Deferred rows keep their mappings until give-up. |
|
| `file-data` | Encoded file data when `file-data-backend` is `storage`. Reference metadata has `storage-ref-id`, `file-id`, and the `file_data` row ID. | Yes | Authentication required | Reference scan. |
|
||||||
| `file-data` | Encoded file data when `file-data-backend` is `storage`. Reference: the `file_data.storage_object_id` column (FK `NO ACTION DEFERRABLE INITIALLY IMMEDIATE`); the object metadata keeps `file-id` and the `file_data` row ID. | Yes | Authentication required | Reference scan. |
|
|
||||||
| `file-data-fragment` | Compatibility value for file-data fragments. The current backend has no dedicated producer for this bucket. | No current write semantics | Public | No touched-object collector case. |
|
| `file-data-fragment` | Compatibility value for file-data fragments. The current backend has no dedicated producer for this bucket. | No current write semantics | Public | No touched-object collector case. |
|
||||||
| `file-change` | Compatibility value for file changes. Current snapshots store data in `file_data`, not this bucket. | No current write semantics | Authentication required | No touched-object collector case. |
|
| `file-change` | Compatibility value for file changes. Current snapshots store data in `file_data`, not this bucket. | No current write semantics | Authentication required | No touched-object collector case. |
|
||||||
| `job-resource` | Storage objects owned by job rows (`job.resource_id`), written by `app.jobs.storage`. | No | Authentication required, owner-scoped | jobs-GC touch → reference scan. |
|
|
||||||
|
|
||||||
- The valid bucket set is `app.storage.schema/metadata-buckets` (derived from `bucket-requirements`, where a new bucket and its required metadata keys are one entry); `app.storage/valid-buckets` aliases it.
|
- The valid bucket set lives in `app.storage/valid-buckets`.
|
||||||
- `file-media-object` is the default bucket for old rows without bucket metadata.
|
- `file-media-object` is the default bucket for old rows without bucket metadata.
|
||||||
- Do not assign a new bucket without adding its access and cleanup behavior.
|
- Do not assign a new bucket without adding its access and cleanup behavior.
|
||||||
- The touched-object collector raises an internal error for an unknown bucket.
|
- The touched-object collector raises an internal error for an unknown bucket.
|
||||||
- It supports `file-media-object`, `team-font-variant`, `file-object-thumbnail`, `file-thumbnail`, `profile`, `file-data`, `tempfile`, `upload-session`, `job-resource`, and `organization`.
|
- It supports `file-media-object`, `team-font-variant`, `file-object-thumbnail`, `file-thumbnail`, `profile`, `file-data`, `tempfile`, and `organization`.
|
||||||
- It does not support `file-data-fragment` or `file-change`.
|
- It does not support `file-data-fragment` or `file-change`.
|
||||||
|
|
||||||
## Access Rules
|
## Access Rules
|
||||||
@ -110,7 +67,6 @@ Since `put-object!` uses backend-specific operations (`impl/resolve-backend` + `
|
|||||||
- `app.http.assets` decides direct object authentication from the bucket.
|
- `app.http.assets` decides direct object authentication from the bucket.
|
||||||
- Public buckets are `file-media-object`, `file-object-thumbnail`, `team-font-variant`, `file-data-fragment`, and `organization`.
|
- Public buckets are `file-media-object`, `file-object-thumbnail`, `team-font-variant`, `file-data-fragment`, and `organization`.
|
||||||
- Other valid buckets require a session or access-token profile ID.
|
- Other valid buckets require a session or access-token profile ID.
|
||||||
- `tempfile` and `job-resource` are owner-scoped: the request must come from the profile stored in the object metadata, and a mismatch answers 404 (counted as `unauthorized`). A missing owner is tolerated only in `tempfile`, where legacy objects predate the metadata; `job-resource` always carries one, so an object without it is never served.
|
|
||||||
- File-media routes also require file read permission.
|
- File-media routes also require file read permission.
|
||||||
- Non-public direct responses set `content-disposition: attachment`.
|
- Non-public direct responses set `content-disposition: attachment`.
|
||||||
- FS responses use `x-accel-redirect` for the configured asset path.
|
- FS responses use `x-accel-redirect` for the configured asset path.
|
||||||
@ -118,56 +74,10 @@ Since `put-object!` uses backend-specific operations (`impl/resolve-backend` + `
|
|||||||
|
|
||||||
## File Data
|
## File Data
|
||||||
|
|
||||||
- `file-data-backend` accepts `legacy-db`, `db`, or `storage`; `legacy-db` is read-only and the default is `db`. The configuration reads `legacy-db` as `db` at startup, with a warning (`normalize-file-data-backend`), so a deployment that kept the variable saves instead of failing on every write.
|
- `file-data-backend` accepts `legacy-db`, `db`, or `storage`.
|
||||||
- `legacy-db` reads main data from `file.data` and snapshots from `file_change.data`; it no longer writes them (`fdata/upsert!` rejects it).
|
- `legacy-db` stores main data in `file.data` and snapshots in `file_change.data`.
|
||||||
- `db` stores encoded data in `file_data.data`.
|
- `db` stores encoded data in `file_data.data`.
|
||||||
- `storage` stores encoded data in storage subsystem with `file-data` bucket, keeps `data` nil in `file_data` table, and points at the object with `file_data.storage_object_id`.
|
- `storage` stores encoded data in storage subsystem with `file-data` bucket and keeps `data` nil in `file_data` table.
|
||||||
- `file_data.storage_object_id` is a `NO ACTION DEFERRABLE INITIALLY IMMEDIATE` foreign key to `storage_object(id)`: the database refuses to physically delete a referenced object. The `IMMEDIATE` is load-bearing: the RI violation fires inside the `storage-gc-deleted` chunk transaction, so the chunk rolls back, is logged at error level with a generic hint plus the `constraint` and `table` the database reports (any `NO ACTION` foreign key on `storage_object` can block the delete, not only `file_data`'s) and is retried on the next run; with `INITIALLY DEFERRED` the check would fire at commit, outside the catch, and the sweep would never move past the blocked chunk.
|
- The `file_data.metadata.storage-ref-id` value points to the storage object.
|
||||||
- The column is the only source of truth. The release is a coordinated restart (no rolling deploy) when the instance uses the storage backend (`PENPOT_FILE_DATA_BACKEND=storage`) or still has rows carrying `metadata.storage-ref-id`; with the default `db` backend and no such rows the previous and the new code read the same `file_data.data` column, so a rolling deploy is safe. `metadata.storage-ref-id` is no longer written or read, and the `file-data` metadata schema does not declare it. The migration backfills the rows it can resolve (valid uuid with an existing `storage_object`) and removes the key from those rows; a corrupt or orphan pointer keeps the key, which nothing reads. A large instance runs `operations/2.20.0-file-data-storage-object-id.md`: column, index and FK online, then the backfill (only if a row still carries `metadata.storage-ref-id`) with every instance stopped, verifies, and marks the migration as applied (`INSERT INTO migrations`). The backfill must never run while the previous code serves when the storage backend is in use (or rows with the pointer remain), because that code writes and scans the metadata pointer. A rollback to the previous code cannot read the rows written by this release when the storage backend is in use.
|
- `fdata/upsert!` touches a storage object from incoming metadata before it stores the new row.
|
||||||
- `fdata/upsert!` touches the `storage_object_id` it receives in the params (the pointer the persisted row had) before replacing it, so the replaced blob is reclaimed. Callers pass the column from the file map (main/restore), `nil` for a new row (fragments, snapshots, new files) or the row itself (offload); there is no query in the upsert path, which is why every caller reads the file under the row lock first (the migration-on-read path included, see `mem:backend/subtleties`). It returns `{:written <bool> :storage-object-id <uuid or nil>}`, the pointer of the object the write created (nil for `db`/`legacy-db`), and `binfile.common/update-file!` propagates it so a migrating read returns the map with the pointer of the row it persisted instead of the pre-write one. The write also compares the expected pointer with `IS NOT DISTINCT FROM` (the caller's value, not the new one) and raises `:stale-file-data-pointer` when the row changed under it, so a stale map fails instead of leaking the replaced blob; the check lives in `upsert-in-database` because the `legacy-db` branches do not use the upsert SQL.
|
|
||||||
- `binfile.common/update-file!` takes the file map read from the database plus the fields to change (`[cfg file & params]`), merges them and builds the `file_data` params from the merged map, so the pointer travels in the read map and a caller cannot lose it by building a partial map; the params cannot override `:storage-object-id`. `insert-file!` always drops it (an INSERT never replaces a persisted pointer; `duplicate-file` hands the source map there). `bfc/get-file` keeps the pointer for the write paths, and every response goes through `bfc/file->response`, which strips it and any residual `storage-ref-id` left in the metadata of the rows the migration does not backfill: each `file-data` object is authentication-only and any logged-in profile could otherwise fetch it from `/assets/by-id`.
|
|
||||||
- The in-place binfile import was removed: `import-files!` raises `:not-supported` when the cfg carries `::bfc/file-id`, so no caller can overwrite a storage-backed row without carrying its previous pointer.
|
|
||||||
- File snapshots use `file_data` for snapshot data and `file_change` for snapshot metadata.
|
- File snapshots use `file_data` for snapshot data and `file_change` for snapshot metadata.
|
||||||
- Tiered offload (`:tiered-file-data-storage` flag + `db` backend): `file-gc` submits an `:offload-file-data` job (priority 10, delay 1000, same params) only when it actually processed the file; the handler takes the `file` row with `FOR UPDATE SKIP LOCKED` and skips (`{:skipped 1}`, no error) when the row is locked or gone, then moves every live `file_data` row of that file with `backend = 'db'` to `backend = 'storage'` via `fdata/upsert!` (one `put-object!` in bucket `file-data` per row, `data` becomes nil and `storage_object_id` points at the new object) inside a single all-or-nothing transaction per file. The skip only serializes because every `file_data` writer locks the `file` row first (the update RPC and the snapshot paths with `FOR UPDATE` through `lock-for-update?`, the migration-on-read path with `FOR UPDATE`). A storage failure aborts only that file and bubbles for a runner retry; orphans go to `storage-gc-touched`. A second run is a no-op because the query only matches `backend = 'db'`.
|
|
||||||
- The offload normalizes each `SELECT fd.*` row before `upsert!`: the row builder omits NULL columns, jsonb metadata arrives as a `PGobject`, and a JSON `null` decodes to nil and must disappear instead of travelling as `:metadata nil`, which the update schema rejects.
|
|
||||||
- Offload pacing: none by deliberate decision. Sleeps only make sense when batching multiple transactions; the per-file transaction is short by construction and the scheduler run takes minutes per production metrics, so neither loop sleeps. `jobs/heartbeat` (pool-based liveness, ~1 write/s) stays on both paths.
|
|
||||||
- Offload metrics (bounded labels only, never ids or error text): `penpot_file_data_offload_rows_total{type}` and `penpot_file_data_offload_bytes_total{type}` (`type`: `main`/`snapshot`/`fragment`, successful runs only) plus `penpot_file_data_offload_timing_ms{result}` (`result`: `ok`/`skip`/`error`). Helpers live in `app.jobs.metrics`; the job-def requires `::mtx/metrics`.
|
|
||||||
- Writes always resolve the backend through `fdata/default-backend` (`cf/get :file-data-backend`), so post-offload edits land back in hot (`db`) storage without extra code; reads stay transparent through `fdata/resolve-file-data` + `decode-file-data` + `realize`.
|
|
||||||
- Deleting an offloaded row touches its storage object first (`objects-gc/delete-file-data-chunk` via `fdata/touch-storage-object` with the row's `storage_object_id`), so `storage-gc-touched` reclaims the blob with the usual delay; restoring a file unmarks the referenced objects.
|
|
||||||
- `storage-gc-touched` resolves the `file-data` reference with `SELECT EXISTS (SELECT 1 FROM file_data WHERE storage_object_id = ?)`, an indexed lookup that no longer parses the object metadata.
|
|
||||||
- A row with `backend='storage'` and no readable object makes `resolve-file-data` raise `:missing-storage-object` with the file and row ids instead of failing later in the storage backend.
|
|
||||||
- The `file-id` and row id kept in the storage object metadata are informational for diagnostics; nothing parses them to resolve the reference (the reference is the column).
|
|
||||||
|
|
||||||
## File Change
|
|
||||||
|
|
||||||
- `file_change` is partitioned by `HASH (file_id)` in 16 partitions, with the same bounds as `file_data`, so a join between them is resolved partition by partition (`enable_partitionwise_join` is set on every pooled connection).
|
|
||||||
- The automatic migration (`0158-partition-file-change`) refuses to run when `file_change` is above 10 GiB total size or 2M rows (`pg_total_relation_size` + `pg_class.reltuples`, catalog reads). It analyzes the table first, because `reltuples` is -1 without statistics. It raises with the path of `operations/2.20.0-file-change-partition.md`, because the copy happens inside the migration transaction and a big instance would restart in a loop. Below the guard it raises `statement_timeout` to 30 minutes for the copy and the index builds, and analyzes the new partitions at the end, after the copy and the indexes, so the planner does not start with empty statistics.
|
|
||||||
- Its primary key is `(file_id, id)`: a partitioned table needs the partition key in the primary key, so every access filters by `file_id`. From 2.20 the four snapshot commands (`update-file-snapshot`, `delete-file-snapshot`, `lock-file-snapshot`, `unlock-file-snapshot`) require the `file-id` param, because they use it to prune the partition; without it they answer `:params-validation`.
|
|
||||||
- It has a `kind` column: `1` is a snapshot (it has a label and its data lives in `file_data`; the read-only `legacy-db` backend keeps old payloads in `data`) and `2` is a revision (it has no label and it holds the changes). The values are in `app.features.file-changes`.
|
|
||||||
- `kind` is a deliberate reserve, not a leftover: today no query filters by it, the queries still tell a snapshot from a revision by its label (`label IS NOT NULL`), and `kind` takes over when they are rewritten. No constraint ties `kind` and `label` together on purpose: the day `kind` is the source of truth, that constraint would have to go. It stays nullable on purpose: the previous version inserts without it, and a rollback to it has to keep writing; the `NOT NULL` comes in a later migration.
|
|
||||||
- Every write of the application to a row of `file_change` moves `updated_at` to the moment of the write (`lock-by!`, `unlock!`, the snapshot rename and delete, `delete-object`, the restore of a file). The actions of the foreign keys (`ON DELETE SET NULL` on `locked_by` and `profile_id`) change the row without touching it; during the partition both tables carry the same keys, so both receive them. The runbook of the partition uses it as the watermark of its delta passes: a write of the application that leaves it behind is lost at the cutover.
|
|
||||||
- `file_change_legacy` is a frozen copy of the previous layout of the partition: it keeps the rows and the indexes of the old table. A new instance (empty table) does not keep it. On an upgraded instance the table stays until the operator drops it by hand days later (`DROP TABLE file_change_legacy;`, see `operations/2.20.0-file-change-partition.md`); nothing drops it automatically.
|
|
||||||
- A revision carries only the delta of a save (the changes). The features of the file are not repeated on it: nobody read them from there.
|
|
||||||
- A snapshot carries the features and the migrations of the file.
|
|
||||||
- It keeps the `data` column for reading only: migration `0157-migrate-legacy-file-data` moved the existing blobs to `file_data`, and `legacy-db` remains as a read-only backend for the payloads still in `data`. `fdata/upsert!` rejects `legacy-db` and the `file-data-backend` default is `db`. It has no `data_ref_id` or `data_backend` columns: nothing read them since the file storage refactor.
|
|
||||||
- It has no index for the system snapshots. The old one filtered them by `data IS NOT NULL`, and with the payload living in `file_data` the column no longer tells snapshots apart. The new one could only filter them by `deleted_at IS NULL`, but the system snapshots always carry a deletion date in the future, so it would never match a row. The query that would use it filters that date with an "or", which no partial index can serve.
|
|
||||||
- The `objects-gc` purge groups each chunk by `file_id` and locks it with `file_id = ?` and `id = ANY(?::uuid[])`: a tuple `IN ((file_id, id), ...)` gives the planner no constant partition key, so it scans all 16 partitions in every chunk. Each group is one `FOR UPDATE SKIP LOCKED` query inside the chunk transaction.
|
|
||||||
|
|
||||||
## Metrics
|
|
||||||
|
|
||||||
- `bucket` is always the Penpot logical bucket (object metadata), never an S3 bucket. Unknown/absent buckets are labeled `"unknown"`.
|
|
||||||
- `target` is the physical S3 destination id. Today it is always `"default"` (hardcoded in `app.storage.s3/build-s3-client`; the `::target-id` config key was removed as unused until the per-bucket routing plan lands).
|
|
||||||
- Physical S3 API calls (AWS SDK `MetricPublisher`, `app.storage.s3.metrics`):
|
|
||||||
- `penpot_storage_s3_requests_total{operation,target,result}` — one count per logical SDK call (the published `ApiCall` collection, not per attempt); retries are counted apart in `retries_total`, so total attempts = `requests + retries`. `result` is `"ok"` only when the SDK reports success as exactly `true`; a missing success flag counts as `error`.
|
|
||||||
- `penpot_storage_s3_retries_total{operation,target}` — SDK retry count.
|
|
||||||
- `penpot_storage_s3_timing{operation,target}` — call latency histogram (ms); explicit buckets up to 60000 ms (S3 slow calls exceed the default 7500 ms cap).
|
|
||||||
- Logical storage operations (`app.storage`, `::mtx/metrics` required by the schema):
|
|
||||||
- `penpot_storage_operations_total{op,bucket,backend}` — `put`, `repair`, `get-data`, `get-bytes`, `del`, `touch`, `exists`. All ops are success-only: `put`/`repair` emit after the backend write, `get-*` after the backend fetch opens, `touch`/`del` only when a row actually changed. `touch-object!`/`del-object!` take the object id (UUID) only — no object overload. Labels come from the updated row itself via `UPDATE ... RETURNING id, backend, metadata` (no extra `SELECT`); with no row matched they emit nothing. `del-object!` only matches live rows (`deleted_at IS NULL`): a repeated del returns `false` and emits nothing. Post-open stream read errors stay counted as attempts. `del` only marks `deleted_at`; physical deletion is a GC concern. `exists` is emitted per deduplication-hit probe, always paired with a `hit`/`repair` outcome (never on probe failure), not per user-facing existence check.
|
|
||||||
- `penpot_storage_dedup_total{result,bucket}` — `hit`, `miss`, `repair`, `skip`.
|
|
||||||
- Storage GC poison (`app.storage.gc-touched`, `::mtx/metrics` required in the handler cfg):
|
|
||||||
- `penpot_storage_gc_poison_total` — touched rows whose metadata fails to decode. Each one is logged at error level and deferred exactly one day instead of aborting the chunk. No labels; incremented once per row per scan.
|
|
||||||
- Asset serving (`app.http.assets`, `::mtx/metrics` required in the handler cfg):
|
|
||||||
- `penpot_storage_asset_requests_total{route,backend,bucket,result}` — `route` is `by-id`, `by-file-media-id`, or `thumbnail`; `result` is `served` (<400), `not-found` (404), `unauthorized` (401/403), or `error` (everything else, including a nil/non-number status: every serve path must set `::yres/status`). Serve-path exceptions are counted by `serve-object-measured` and then rethrown. Permission-denied file-media requests and tempfile ownership mismatches both answer HTTP 404 (to avoid leaking existence) but are counted as `unauthorized`. Malformed UUIDs raise before any emission point and are never counted. Counts backend requests that trigger a browser GET to the object store (one per cache miss), so it is a proxy for object GETs, not an exact count.
|
|
||||||
- The physical and logical counters intentionally overlap in coverage but differ in meaning; do not sum them.
|
|
||||||
- Metrics is not optional: `::mtx/metrics` is required by the storage and s3-backend schemas, and the assets handler cfg always carries it. Wiring a component without metrics is a bug, not a supported mode.
|
|
||||||
- Recording never fails: `app.metrics/run!` is safe by default at every emit point (`emit-op!`, `emit-dedup!`, `emit-asset!`, and the three S3 publisher emissions). The first recording failure per metric id logs at `warn`, later ones at `debug` (no log flood). The `instance` precondition is a plain assert and the collector lookup is outside the recording guard, so a missing instance fails hard (see `mem:backend/subtleties`). The `publish` outer try/catch stays: it is an SDK `MetricPublisher` contract boundary, not a metrics guard.
|
|
||||||
|
|||||||
@ -9,7 +9,6 @@
|
|||||||
- Params with `::sm/params` are decoded/conformed through the JSON transformer and successful IObj results get `:encode/json` metadata. Legacy spec conforming only applies when no Malli params schema exists. Client params are stripped of qualified keys (`d/without-qualified`) before merging with the server auth context, so request bodies cannot override `::profile-id`, `::auth-type`, or `::token-perms`.
|
- Params with `::sm/params` are decoded/conformed through the JSON transformer and successful IObj results get `:encode/json` metadata. Legacy spec conforming only applies when no Malli params schema exists. Client params are stripped of qualified keys (`d/without-qualified`) before merging with the server auth context, so request bodies cannot override `::profile-id`, `::auth-type`, or `::token-perms`.
|
||||||
- Params schemas are open by default, so undeclared client keys reach the handler unless the map is `:closed true`. Creation commands (`create-file`, `create-project`, `create-team`, `create-team-with-invitations`, `upload-file-media-object`, `create-file-media-object-from-url`, `assemble-file-media-object`) use closed schemas: a client-provided `:id` fails with `:params-validation`. Their internal creation functions still accept an optional explicit `:id` for imports, duplicates and deterministic test fixtures.
|
- Params schemas are open by default, so undeclared client keys reach the handler unless the map is `:closed true`. Creation commands (`create-file`, `create-project`, `create-team`, `create-team-with-invitations`, `upload-file-media-object`, `create-file-media-object-from-url`, `assemble-file-media-object`) use closed schemas: a client-provided `:id` fails with `:params-validation`. Their internal creation functions still accept an optional explicit `:id` for imports, duplicates and deterministic test fixtures.
|
||||||
- Nil RPC bodies become HTTP 204 unless explicit status metadata is present. Stream bodies default to `application/octet-stream` when no content type is set.
|
- Nil RPC bodies become HTTP 204 unless explicit status metadata is present. Stream bodies default to `application/octet-stream` when no content type is set.
|
||||||
- The upload schema (`media.v/schema:upload`) takes a `:path` from the caller, and a Transit body can tag any string as a `path`, so a command that reads such an upload reads a file the client named. `create-import-binfile-job` avoids that boundary by accepting only a chunked upload (`:upload-id`); the commands that still take a plain file (the legacy `import-binfile`, the media and font uploads) trust it, and the guard belongs where uploads are accepted, not in each command.
|
|
||||||
|
|
||||||
## Concurrency limiter (CLIMIT)
|
## Concurrency limiter (CLIMIT)
|
||||||
|
|
||||||
@ -18,50 +17,37 @@
|
|||||||
- The waiting counters are a field of the `ConcurrencyLimiter` component (a `ConcurrentHashMap` of name to `AtomicLong`), so they start at zero, die with the component, and the sampler that closes over that map republishes only its own names every 15 s; the sampler stops with the component in `halt-key!`. `impl-invoke` pairs one decrement with one increment through a per-call flag: the flag turns a second call into a no-op and the `finally` guarantees that there is one. The increment sits inside the `try` and the decrement lives only in the acquired callback and the `finally`, so a handler that throws, a rejection and a throwable from the publishing path all leave the count where it was and the thread without the limiter marked as held (a leftover mark would skip that limiter for that key for ever). Concurrent `inc`/`dec` publications of two threads can land out of order and the value can read low for a moment; the republish corrects it.
|
- The waiting counters are a field of the `ConcurrencyLimiter` component (a `ConcurrentHashMap` of name to `AtomicLong`), so they start at zero, die with the component, and the sampler that closes over that map republishes only its own names every 15 s; the sampler stops with the component in `halt-key!`. `impl-invoke` pairs one decrement with one increment through a per-call flag: the flag turns a second call into a no-op and the `finally` guarantees that there is one. The increment sits inside the `try` and the decrement lives only in the acquired callback and the `finally`, so a handler that throws, a rejection and a throwable from the publishing path all leave the count where it was and the thread without the limiter marked as held (a leftover mark would skip that limiter for that key for ever). Concurrent `inc`/`dec` publications of two threads can land out of order and the value can read low for a moment; the republish corrects it.
|
||||||
- The `app.rpc.climit` log lines carry `queue`, `queue-max`, `permits`, `elapsed`, `code` and `reason`, and their `id` carries the key (`name/<profile or key>`). That is the only place where the profile behind a queue is visible: a pile-up is chased there, on demand, not in the metrics. The `queue` of the line is the calls inside the limiter minus its permits, so it reads 0 for a lone caller that times out: that line goes out at TRACE instead of WARN, and the rejection count has to come from the metric.
|
- The `app.rpc.climit` log lines carry `queue`, `queue-max`, `permits`, `elapsed`, `code` and `reason`, and their `id` carries the key (`name/<profile or key>`). That is the only place where the profile behind a queue is visible: a pile-up is chased there, on demand, not in the metrics. The `queue` of the line is the calls inside the limiter minus its permits, so it reads 0 for a lone caller that times out: that line goes out at TRACE instead of WARN, and the rejection count has to come from the metric.
|
||||||
- Nothing in the limiter path has a timeout unless the config sets one, and `psm/acquire` then calls `Semaphore.acquire`, which parks the calling thread forever. A parked thread still counts as in-system for every outer limiter of its chain, so the outermost one (the method's own by-profile limiter) stops granting permits and answers 429 to everything. A limiter without `:queue` gets an unlimited queue and therefore never rejects: its pile-up is silent, with no 429 and no log line except the WARN `enqueued`/`acquired` lines of the keyed id.
|
- Nothing in the limiter path has a timeout unless the config sets one, and `psm/acquire` then calls `Semaphore.acquire`, which parks the calling thread forever. A parked thread still counts as in-system for every outer limiter of its chain, so the outermost one (the method's own by-profile limiter) stops granting permits and answers 429 to everything. A limiter without `:queue` gets an unlimited queue and therefore never rejects: its pile-up is silent, with no 429 and no log line except the WARN `enqueued`/`acquired` lines of the keyed id.
|
||||||
- Deadlock shape between a command's own limits and the root ones (fixed): a command declaring its own limits held `process-image/by-profile` before `root/by-profile`, while a command with no limits of its own takes the roots first and then re-enters with the same keyed limits from inside its handler (`create-file-media-object-from-url`, `upload-photo`) and waits for them holding a root permit. Two calls of one profile then held the same two limiters inverted and parked for good: 69 threads at 0 CPU, an audit limiter with 0 acquisitions in 24h and 100% 429s, on an instance that never served a 204. Both commands declare their limits now, so the shape cannot happen any more: the root limits are taken last and every path takes the limiters in the same order.
|
- Deadlock shape between a command's own limits and the root ones (fixed): a command declaring its own limits held `process-image/by-profile` before `root/by-profile`, while a command with no limits of its own takes the roots first and then re-enters with the same keyed limits from inside its handler (`create-file-media-object-from-url`, `upload-photo`) and waits for them holding a root permit. Two calls of one profile then held the same two limiters inverted and parked for good: 69 threads at 0 CPU, an audit limiter with 0 acquisitions in 24h and 100% 429s, on an instance that never served a 204.
|
||||||
- `climit/wrap` takes the command's own limits before the root ones: the root limiters are appended to the sequence first and the last element of the sequence is the outermost one, so `root/global`/`root/by-profile` end up innermost. A request waiting for its own limits no longer holds the root permits of its profile, which is what kept a pile-up of heavy requests from blocking the other commands of that profile. Every acquisition goes through that wrapper, so every path takes the limiters in the same order: there is no way to enter the limiter from inside a handler, and a command that calls another command internally would take the limiters twice (the second call waits for a permit the first one holds and answers 429 when the timeout runs out). The key of a limit is a function of the params (a keyword is looked up in them, a function is applied to them, any other value is the key itself). Commands declare the by-profile limit before the global one, which makes it the outermost of the pair, and a test fails when the relation between all the limits the commands declare cannot be sorted: two commands that take the same limits in opposite order, or a ring of three, leave the paths of one profile holding them in opposite order.
|
- `climit/wrap` now appends the root limiters after the command's own, so `root/global`/`root/by-profile` end up outermost and every path meets them first; the nested `climit/invoke!` chains carry only the command's own limits and run inside them, which puts both paths in the same order. `impl-invoke` also keeps, per thread, the set of limiters that thread is inside of and runs the handler inline when a call asks for one it already holds, instead of queueing behind itself. That check relies on `pbh/invoke!` running the handler on the calling thread; the mark is removed in a `finally`. Commands declare the by-profile limit before the global one, which makes it the outermost of the pair: keep that declaration order, the reverse one would put two paths back in inverted order. The two nested call sites (`create-file-media-object-from-url`, `upload-photo`) still share `process-image` with the enclosing call instead of getting a limiter of their own, so the comment there about keeping the download out of that limit no longer holds.
|
||||||
- The two commands that used to enter climit from inside their handler declare their limits now, so the whole command runs inside them: the download of an external image takes a `process-image` permit, and that limit has one permit per profile, so a slow download holds the image processing of that profile for as long as it takes. It takes the global permit of that limit too (8 permits, queue 20), so eight slow downloads of eight different profiles leave the image processing of every profile waiting. The copy of the body has no timeout (the 30 s of the request covers the connection and the headers), so a server that stops sending keeps the permits until the operating system gives up. The storage write of the profile photo runs inside its limit too.
|
- The shipped `backend/resources/climit.edn` sets a timeout on every limiter, 60s for operations that can be slow and 30s otherwise, with a test that fails when an entry ships without one, and `init-key` logs a WARN for every entry without a timeout. The production file lives outside the repository: mirror it there, and remember that a parked thread only goes away with a restart or a deploy.
|
||||||
- The shipped `backend/resources/climit.edn` sets a timeout and a queue on every limiter, 60s for operations that can be slow and 30s otherwise, with a test that fails when an entry ships without one, and `init-key` logs a WARN for every entry without a timeout. The queue matters because the root limits no longer bound the waiters: a command takes its own limits first, so a pile-up waits in the queue of that limit. The file and the declarations have to list the same ids: a `::climit/id` without an entry makes `wrap` log `no config found for specified queue` and run the handler with no limiter at all, and a test fails when a command declares an id the file does not list. Only key a limit by profile when the work contends on something shared (`update-file`, images, fonts, thumbnails, the profile row): a global cap on a cheap command adds a rejection path nobody needs, which is why `profile-plugin-ops` and `submit-audit-events` declare only `by-profile`. The production file lives outside the repository: mirror it there, and remember that a parked thread only goes away with a restart or a deploy.
|
|
||||||
|
|
||||||
## DB helpers
|
## DB helpers
|
||||||
|
|
||||||
- Most `app.db` helpers accept a pool, connection, or map containing `::db/pool` / `::db/conn`; preserve that convention in shared code.
|
- Most `app.db` helpers accept a pool, connection, or map containing `::db/pool` / `::db/conn`; preserve that convention in shared code.
|
||||||
- `db/tx-run!` uses `next.jdbc.transaction/*nested-tx* :ignore`: nested transaction calls reuse the outer transaction, not a savepoint. Use explicit savepoints when nested rollback semantics matter.
|
- `db/tx-run!` uses `next.jdbc.transaction/*nested-tx* :ignore`: nested transaction calls reuse the outer transaction, not a savepoint. Use explicit savepoints when nested rollback semantics matter.
|
||||||
- Whether a call is nested is decided by the CONNECTION, not by an ambient flag: `db/transact!` binds `*after-commit-conn*` around the body, and a transactable that is not identical to that connection is an independent unit of work that owns its own after-commit context. A `tx-run!` that passes a pool while a transaction is open therefore commits on its own and drains its own callbacks, instead of leaving them in a context that may roll back.
|
|
||||||
- `after-commit` callbacks run on commit only. A transaction marked `::db/rollback` (used by `srepl` and `app.tasks/offload-file-data`) commits nothing, so it runs none of them.
|
|
||||||
- `db/run!` opens/reuses one connection but does not create a transaction.
|
- `db/run!` opens/reuses one connection but does not create a transaction.
|
||||||
- `db/tjson` is Transit JSON for jsonb storage; `db/json` is plain JSON. Job params (`job.params`) are plain JSON, decoded with the job-def decoder (`app.jobs/decode-params`); only the legacy `task` props were Transit (`decode-transit-pgobject`). Job results (`job.result`) are plain JSON too: they are read with the result decoder of the job-def (`app.jobs/decode-result`), and a result map keyed by uuid must declare its schema (`[:map-of ::sm/uuid ...]`, the import resolution does) or every key comes back as a keyword and every uuid as the text it is on disk.
|
- `db/tjson` is Transit JSON for jsonb storage; `db/json` is plain JSON. Worker task props use Transit and are decoded with `decode-transit-pgobject`.
|
||||||
- Advisory transaction locks accept UUIDs or ints. UUID locks are hashed using a zero-UUID seeded siphash.
|
- Advisory transaction locks accept UUIDs or ints. UUID locks are hashed using a zero-UUID seeded siphash.
|
||||||
|
|
||||||
## Workers and cron
|
## Workers and cron
|
||||||
|
|
||||||
- `job` carries `tenant` (the instance the job belongs to) and a bare `queue`. Several instances share one database and the tenant is what keeps an instance from claiming another environment's jobs, so every query that acts on one instance's work filters on `tenant`: dispatch claim, orphan sweep, lost-job reschedule, cron no-overlap count, submit dedupe. The `job__dispatcher__idx` leads with `tenant` (equality) then `(priority DESC, scheduled_at)`; `queue` does not lead because the dispatcher claims every queue of its tenant. The `<tenant>:<queue>` prefix survives only in the Redis key, composed once by `app.worker/queue-key`.
|
- Task queues are tenant-prefixed. Submit dedupe only removes not-yet-due `new` tasks with the same name/queue/label; it does not dedupe due, scheduled, retry, running, or completed work.
|
||||||
- Submit dedupe only removes not-yet-due `new` jobs of the same tenant with the same name/queue/label; it does not dedupe due, scheduled, retry, running, or completed work. The `::jobs/skip-if-active` submit option goes further: it skips the insert (returning `nil`, recording `penpot_jobs_skipped_total`) when a live job (`new`/`scheduled`/`running`/`retry`) already exists for the same tenant/name/queue/label, requires an explicit non-blank label, and carries the same best-effort cross-backend race caveat as dedupe.
|
- The dispatcher selects `new`/`retry` tasks with `FOR UPDATE SKIP LOCKED`, marks them `scheduled`, and publishes Redis payload `[id scheduled-at]`. The runner skips Redis messages whose scheduled timestamp no longer matches DB state.
|
||||||
- Jobs metrics rule (one event, one family): counters exist only for events without latency; when an event has a histogram, its `_count` is the counter (no twin counter). `dispatched` (pushes) vs `queue-wait` (claims) are deliberately different events — do not merge them.
|
- Lost `scheduled` tasks are rescheduled after about 5 minutes; `running` tasks older than about 24 hours are marked failed as orphans.
|
||||||
- The dispatcher selects `new`/`retry` jobs with `FOR UPDATE SKIP LOCKED`, marks them `scheduled`, and publishes the JSON payload `[id scheduled-at]` to the `penpot.worker.queue:<tenant>:<queue>` Redis list. The runner skips Redis messages whose scheduled timestamp no longer matches DB state.
|
- A task handler that is missing or returns an invalid result currently defaults to completed after warning. Throwing with `ex-data :type ::retry` controls retry behavior; `:strategy ::noop` retries without incrementing retry count.
|
||||||
- Lost `scheduled` jobs are rescheduled after 5 minutes; `running` jobs untouched longer than `:jobs-lease` (default 30 min) are marked `aborted` with `app.jobs/orphan-error` (`type :internal`, `code :orphan`). `aborted` is a system-side terminal state like `cancelled` (never retried, swept by retention like other terminals, reported with an error log); long jobs must `heartbeat` per chunk so a healthy backlog is never mistaken for a dead process. The `:progress` report is optional and only feeds the durable log. A beat whose write finds the job no longer active raises an `:interrupt` (`code :job-interrupted`) instead of counting zero: it is the internal stop-the-work signal, not an error, so neither the listener nor the runner logs it as one.
|
- Cron jobs lock their `scheduled_task` row with `FOR UPDATE SKIP LOCKED`, disable statement/idle-in-transaction timeouts locally, and reschedule themselves in `finally` unless interrupted. Worker, dispatcher, and cron components do not start when the DB pool is read-only.
|
||||||
- An orphan gets its `end` event (`outcome "aborted"`) from the sweep itself: one bulk `INSERT ... SELECT` in the same transaction as the bulk `UPDATE`, never one insert per orphan. No msgbus notification goes out for it; orphans alert through the error log and the orphaned counter.
|
|
||||||
- `job_event` is append-only and deleted by cascade with the job. `progress` is a row there, not a column: no Redis and no mutable column to keep in sync.
|
|
||||||
- `job` is deletion-protected at the SQL level (`deletion_protection__tgr`): a stray `DELETE FROM job` raises instead of dropping the row and its `job_event` cascade without touching the referenced `storage_object`. The only intended deleters, the jobs GC and the submit dedupe, disable the guard with `SET LOCAL rules.deletion_protection TO off` inside their transaction; tests use `th/db-force-delete`.
|
|
||||||
- A missing job-def raises (`:no-job-definition`) instead of completing. Throwing with `ex-data :type ::retry` still controls retry behavior; `:strategy ::noop` retries without incrementing retry count.
|
|
||||||
- Cron entries claim their `scheduled_task` row with `FOR UPDATE SKIP LOCKED`, disable statement/idle-in-transaction timeouts locally, submit one `job` row per entry when no active instance exists (no-overlap), and reschedule themselves in `finally` unless interrupted. Worker, dispatcher, and cron components do not start when the DB pool is read-only.
|
|
||||||
- Integrant params schemas name injected components as bare `::ns/key` entries (pool, metrics, msgbus, job defs), and a bare entry is a malli registry lookup, not `any?`: the owning namespace must `sm/register!` it at load, or the backend crashes at boot with `:malli.core/invalid-schema` instead of asserting. Unit tests never build those keys, so `backend-tests.worker-test` compiles the three worker schemas and `backend-tests.http-websocket-test` compiles the revocation-watcher one to catch it. The assertion only runs with `PENPOT_FLAGS=enable-backend-asserts`, so without it a broken schema reaches production and only crashes at boot.
|
|
||||||
- Whether a bare entry works has nothing to do with its position or with how many of them there are: it is a registry lookup, so it works only if that exact keyword was `sm/register!`'d. `[:map ::db/pool ::metrics/metrics]` is fine, `[:map :app.aaa/unregistered :app.ccc/unregistered]` throws. When a component is **not** registered as a malli type, spell it as an explicit pair instead of registering a type just to satisfy the lookup — `[:app.nitrate/client {:optional true} [:maybe :map]]` is how `auth.oidc/schema:routes-params` and `loggers.audit.archive-task/schema:audit-log-archive-params` declare it. `{:optional true}` matters because `init-key` yields `nil` when the owning feature flag (`:admin-console`) is off, and a required key would then fail the assert on a perfectly normal boot.
|
|
||||||
- `sm/valid?` catches every `Throwable` and returns `false`, so an uncompilable schema and a genuinely invalid value both surface as a bare `Assert failed:` with no cause. When an `assert-key` fires with no message, compile the schema by hand to see the real exception.
|
|
||||||
|
|
||||||
## Config and HTTP/session middleware
|
## Config and HTTP/session middleware
|
||||||
|
|
||||||
- `app.config/config` and `flags` are dynamic `defonce` vars populated from `PENPOT_*` env vars through the shared schema string transformer. Tests and tooling can bind them.
|
- `app.config/config` and `flags` are dynamic `defonce` vars populated from `PENPOT_*` env vars through the shared schema string transformer. Tests and tooling can bind them.
|
||||||
- Duration config values are parsed as ISO-8601 with the `PT` prefix, so a day is written in hours (`:jobs-retention` and `:jobs-user-ttl` default to a week, and an operator writes `168h`): `7d` does not parse, and the value fails validation at boot instead of being silently ignored.
|
|
||||||
- `app.main` wires `PENPOT_DATABASE_*` into `::db/pool`, and `app.db/create-datasource-config` forwards pgjdbc's own knobs as `dataSourceProperties`, which `Properties.getProperty` silently drops unless the value is a String (hence the `str`). A query parameter of the same name in `PENPOT_DATABASE_URI` (for example `?prepareThreshold=0`) wins over the property: pgjdbc ignores the Properties value when the URL carries it, so the URI is the place to look when a variable seems to do nothing. The prepared statement cache is three optional `PENPOT_DATABASE_PREPARED_STATEMENT_CACHE_*` keys: the threshold is the executions before a statement is server-prepared and accepts `-1` or non-negatives (`{:min -1}`; the driver clamps any other negative to `-1`, so rejecting it only turns a typo into a boot error), its `0` stops server-side prepared statements while the driver's client-side cache of parsed queries stays in use, `..._QUERIES` and `..._SIZE` reject negatives and `0` in either disables that cache, and the size is bytes rounded up to the whole MiB the driver accepts. Do not describe the threshold `0` as disabling the cache: it only stops the server-side prepares.
|
|
||||||
- `parse-flags` automatically adds `:disable-secure-session-cookies` when `public-uri` is plain HTTP and not localhost. This changes cookie defaults without an explicit env flag.
|
- `parse-flags` automatically adds `:disable-secure-session-cookies` when `public-uri` is plain HTTP and not localhost. This changes cookie defaults without an explicit env flag.
|
||||||
- The backend sets Clojure `*assert*` globally from the `:backend-asserts` feature flag. Assertion-dependent checks can therefore differ by runtime flags.
|
- The backend sets Clojure `*assert*` globally from the `:backend-asserts` feature flag. Assertion-dependent checks can therefore differ by runtime flags.
|
||||||
- Request body parsing is mostly POST-oriented and supports Transit JSON plus plain JSON. Plain JSON request keys are kebab-decoded before being merged into `:params`. A body the parser cannot read is a client error, classified at the parse site and never by exception class (`clojure.data.json` signals its syntax errors with a bare `java.lang.Exception`): 400 `:validation`/`:malformed-json`, one `warn` line (`malformed request body`) carrying path, peer address and content-type instead of a stack trace, and `penpot_http_malformed_requests_total`. `RequestTooBigException` keeps its 413.
|
- Request body parsing is mostly POST-oriented and supports Transit JSON plus plain JSON. Plain JSON request keys are kebab-decoded before being merged into `:params`.
|
||||||
- Response formatting negotiates with `Accept` or `_fmt=json`. Transit is the default for collection/boolean bodies; JSON encoding has special pointer-map handling.
|
- Response formatting negotiates with `Accept` or `_fmt=json`. Transit is the default for collection/boolean bodies; JSON encoding has special pointer-map handling.
|
||||||
- Auth prefers the session cookie token before the `Authorization` header. Headers may be `Token` or `Bearer`. Only `kid=1`/`ver=1` tokens are decoded as session tokens; anything else is left unauthenticated (legacy v1 tokens were removed).
|
- Auth prefers the session cookie token before the `Authorization` header. Headers may be `Token` or `Bearer`; JWTs with `kid=1` and `ver=1` are decoded as v1 session tokens, otherwise they are treated as legacy tokens.
|
||||||
- Shared-key auth requires `x-shared-key` as `<key-id> <key>` and stores the lowercased key id on the request. If no shared keys are configured it always rejects. Management methods declare the key ids they accept with `::rpc/allowed-shared-keys`; a valid key outside that set answers 403 `:shared-key-not-allowed`, and a method without the metadata accepts any configured key.
|
- Shared-key auth requires `x-shared-key` as `<key-id> <key>` and stores the lowercased key id on the request. If no shared keys are configured it always rejects.
|
||||||
- Session management uses DB storage unless the DB pool is read-only, then falls back to the in-memory manager. Sessions use only the v2 UUID model (`http_session_v2`); legacy string ids were removed.
|
- Session management uses DB storage unless the DB pool is read-only, then falls back to the in-memory manager. DB sessions support both legacy string ids and v2 UUID session ids.
|
||||||
- Session cookies are renewed when `modified-at` is older than the 6h renewal interval. SameSite is `none` for CORS, otherwise strict/lax based on config. Session lifetime config and GC: `mem:backend/session-expiration`.
|
- Session cookies are renewed when using a legacy string id or when `modified-at` is older than the renewal interval. SameSite is `none` for CORS, otherwise strict/lax based on config.
|
||||||
|
|
||||||
## HTTP server self-metrics
|
## HTTP server self-metrics
|
||||||
|
|
||||||
@ -71,48 +57,29 @@
|
|||||||
- The xnio worker MXBean can return transient `-1` (e.g. on the queue or the pool size); negative samples are discarded (gauge keeps its previous value). Undertow exposes absolute request/error totals, so the sampler keeps a watermark atom and publishes deltas; a counter reset (decreasing totals) skips the negative delta and moves the watermark forward.
|
- The xnio worker MXBean can return transient `-1` (e.g. on the queue or the pool size); negative samples are discarded (gauge keeps its previous value). Undertow exposes absolute request/error totals, so the sampler keeps a watermark atom and publishes deltas; a counter reset (decreasing totals) skips the negative delta and moves the watermark forward.
|
||||||
- The `process_*` families (`process_open_fds`, `process_max_fds`, `process_cpu_seconds_total`, …) come from the prometheus client `StandardExports`, registered by `app.metrics/create-registry`. They read the OS MXBean reflectively and need the `jdk.management` module: on a pruned `jlink` JRE the MXBean is `sun.management.BaseOperatingSystemImpl`, the getters throw `NoSuchMethodException` and `StandardExports#collect` swallows it, so those families silently vanish from `/metrics`. `docker/images/Dockerfile.backend` keeps `jdk.management` in the `--add-modules` list, and `backend-tests.metrics-test` pins the contract.
|
- The `process_*` families (`process_open_fds`, `process_max_fds`, `process_cpu_seconds_total`, …) come from the prometheus client `StandardExports`, registered by `app.metrics/create-registry`. They read the OS MXBean reflectively and need the `jdk.management` module: on a pruned `jlink` JRE the MXBean is `sun.management.BaseOperatingSystemImpl`, the getters throw `NoSuchMethodException` and `StandardExports#collect` swallows it, so those families silently vanish from `/metrics`. `docker/images/Dockerfile.backend` keeps `jdk.management` in the `--add-modules` list, and `backend-tests.metrics-test` pins the contract.
|
||||||
|
|
||||||
## Metrics recording
|
|
||||||
|
|
||||||
- `app.metrics/run!` is safe by default: a recording failure never throws (a metrics bug must not change the behavior of the measured operation). The first failure per metric id logs at `warn`, later ones at `debug`. The `instance` precondition is a plain assert (the backend enables `:backend-asserts`), and the collector lookup sits outside the recording guard, so a missing instance fails hard even when asserts are disabled. `::mtx/metrics` is required by the storage, s3-backend, db-pool and jobs APIs; jobs helpers never silently skip a missing metrics instance. The resolver is `app.metrics/instance` and it raises, unlike `run!`.
|
|
||||||
- `app.msgbus` (`pub!`, `sub!`, `purge!`) keeps taking the **instance** on purpose: msgbus is what produces it, and `app.rpc.notifications` already shows the caller passing a cfg. `app.jobs` resolves `::mbus/msgbus` from the cfg internally, and `insert-event` keeps its explicit pre-insert check so a profile job never loses its notification.
|
|
||||||
- `app.db/after-commit` is the boundary for SQL-backed metrics: callbacks are drained by the commit of the transaction that owns the connection they were registered on, and discarded when it rolls back. Because nesting follows the connection, that transaction is the outermost one only for a real nested call.
|
|
||||||
- `penpot_http_malformed_requests_total` (counter, no labels) counts requests whose body the parser could not read. `app.http.middleware/wrap-parse-request` emits it where it classifies the error, so the instance travels as a middleware argument (`[mw/parse-request (::mtx/metrics cfg)]`) and each service declares the definition with its own prefix (nexus: `nexus_http_malformed_requests_total`). The per-endpoint request counters of nexus do not count these requests: they sit inside the parse middleware, so the failure happens before them.
|
|
||||||
|
|
||||||
## Log-derived metrics
|
## Log-derived metrics
|
||||||
|
|
||||||
- `app.loggers.metrics/reporter` counts the log records the application emits and publishes them as `penpot_log_events_total{logger, level}` (counter), so the error panels do not have to count text in Loki. It is a component that hooks `add-watch` on `app.common.logging/log-record`, like `app.loggers.database`, but with no thread and no channel: the increment is in memory, so it goes straight in the watcher. Only `warn`, `error` and `fatal` are counted, and only the records that go through `app.common.logging` (the application's own logs; a library writing straight to log4j2 is not counted, and today that is one line in a thousand). The body of the watcher is wrapped in a `try/catch` that swallows the error on purpose: the watcher fires from the `swap!` of the log record, inside the logging path. With `::l/sync?` (`app.binfile.v1`, `app.msgbus`) an exception there would reach whoever was logging; on the async path it escapes to the logging executor worker, whose trace goes to the thread's uncaught handler -- outside the application's logging -- and the pool replaces the dead worker, so logging continues and that line is lost. The catch also makes a publication that fails every time invisible: `penpot_log_events_total` stays flat and nothing is written about it. The published `level` values are lowercase (`warn`), unlike the `level` label of the Loki logs (`ERROR`), so a panel that moves from one source to the other has to change it. Cardinality is `logger` (fixed names taken from the code) times `level`; a logger built from a dynamic value would break that.
|
- `app.loggers.metrics/reporter` counts the log records the application emits and publishes them as `penpot_log_events_total{logger, level}` (counter), so the error panels do not have to count text in Loki. It is a component that hooks `add-watch` on `app.common.logging/log-record`, like `app.loggers.database`, but with no thread and no channel: the increment is in memory, so it goes straight in the watcher. Only `warn`, `error` and `fatal` are counted, and only the records that go through `app.common.logging` (the application's own logs; a library writing straight to log4j2 is not counted, and today that is one line in a thousand). The body of the watcher is wrapped in a `try/catch` that swallows the error on purpose: the watcher fires from the `swap!` of the log record, inside the logging path. With `::l/sync?` (`app.binfile.v1`, `app.msgbus`) an exception there would reach whoever was logging; on the async path it escapes to the logging executor worker, whose trace goes to the thread's uncaught handler -- outside the application's logging -- and the pool replaces the dead worker, so logging continues and that line is lost. The catch also makes a publication that fails every time invisible: `penpot_log_events_total` stays flat and nothing is written about it. The published `level` values are lowercase (`warn`), unlike the `level` label of the Loki logs (`ERROR`), so a panel that moves from one source to the other has to change it. Cardinality is `logger` (fixed names taken from the code) times `level`; a logger built from a dynamic value would break that.
|
||||||
|
|
||||||
## Storage and media
|
## Storage and media
|
||||||
|
|
||||||
- The `media-storage-bytes-per-team` quota check on `upload-file-media-object` is TEMPORARILY DISABLED (2026-10-19, kept commented in `app.rpc.commands.media` with its `sql:get-team-id-for-file` lookup still active for the audit props): the quote performs a full `SUM` over `storage_object` per upload and was too slow in production. The `upload-sessions-per-profile` quota is unaffected and stays active. Re-enable only with a cheaper approximation.
|
|
||||||
- Storage abstraction, backend configuration, logical buckets, object lifecycle, deduplication, access rules, and garbage collection: `mem:backend/storage`.
|
- Storage abstraction, backend configuration, logical buckets, object lifecycle, deduplication, access rules, and garbage collection: `mem:backend/storage`.
|
||||||
- SVG validation strips DOCTYPE and uses secure SAX parsing. Basic SVG info falls back to 100x100 dimensions when width/height/viewBox are missing.
|
- SVG validation strips DOCTYPE and uses secure SAX parsing. Basic SVG info falls back to 100x100 dimensions when width/height/viewBox are missing.
|
||||||
- The SVG sanitizer (`app.media.svg`) is a **blocklist**, not an allowlist: it drops dangerous elements and attributes by name and escapes every text and attribute value when it writes the tree back, so a payload hidden in a value cannot become live markup again. The allowlist rework is [#12190](https://github.com/penpot/penpot/issues/12190) and lands in media-processor, not here. `sanitize-svg` also tracks the namespace bindings through the recursion and drops any element that is not in the SVG namespace, so a document whose root is not an `svg` element in the SVG namespace is rejected and a child that rebinds `xmlns` to XHTML (`iframe`/`srcdoc`/`meta`) is dropped with its subtree; it compares the scheme of an URL the way the browser does (dropping tab/CR/LF/spaces), so `java	script:` does not slip through the `javascript:` filter. The paths that store an uploaded SVG as its final object go through `app.media.svg/sanitize-svg-upload` (media upload, the URL download, both thumbnail writers and the organization logo); the three binfile imports go through `app.binfile.common/sanitize-imported-svg`, which calls `sanitize-svg` directly. The profile picture is not an SVG: `import-profile-picture` ignores an `image/svg+xml` download, because the avatar is always rendered as an image. The caller checks the size before calling it: the helper reads the whole file, and the size limit applies to the upload, not to the sanitized copy, which can be up to six times bigger.
|
|
||||||
- Upload handlers run the `media.v` checks in a fixed order: `check-upload-path`, then `check-media-type`, then `check-media-size` (or `check-font-size` for fonts). The path check gates every later read: `check-media-type` sniffs the bytes at `:path` and `check-media-size` reads `fs/size`, so a path the client named outside `allowed-upload-prefixes` must be rejected before either touches the disk. `check-media-size` leans on that and answers a file it cannot read with the path code (`:params-validation`), not `:media-max-file-size-reached`. Keep the order when touching or adding a handler; two branches that reorder these lines conflict.
|
|
||||||
- Raster metadata is shell-derived with ImageMagick `identify`, verifies detected MIME against the supplied MIME, and swaps dimensions for EXIF orientations 6/8.
|
- Raster metadata is shell-derived with ImageMagick `identify`, verifies detected MIME against the supplied MIME, and swaps dimensions for EXIF orientations 6/8.
|
||||||
- Remote image download requires 2xx status, `content-length`, a known MIME, and size under the configured maximum before writing the temp file; mismatched byte count is an internal error.
|
- Remote image download requires 2xx status, `content-length`, a known MIME, and size under the configured maximum before writing the temp file; mismatched byte count is an internal error.
|
||||||
- Font processing shells out to FontForge and WOFF conversion tools and can derive TTF/OTF/WOFF variants from uploaded fonts.
|
- Font processing shells out to FontForge and WOFF conversion tools and can derive TTF/OTF/WOFF variants from uploaded fonts.
|
||||||
|
|
||||||
## File data persistence
|
## File data persistence
|
||||||
|
|
||||||
- File data backends for writing are `db` and `storage`; `legacy-db` is a read-only alias for old payloads. The storage backend keeps encoded file data in storage bucket `file-data`; the DB row stores nil data and points at the object with the `storage_object_id` column (FK `NO ACTION DEFERRABLE`).
|
- File data backends are `legacy-db`, `db`, and `storage`. The storage backend keeps encoded file data in storage bucket `file-data`; the DB row stores metadata with `storage-ref-id` and nil data.
|
||||||
- `fdata/upsert!` touches the storage object the persisted row pointed at before replacing it; the pointer travels in the params (`file->file-data-params` from the read file map, `nil` for a new row, the row for the offload) and the params of `update-file!` cannot override it. `binfile.common/update-file!` merges the read file map with the fields to change, so the pointer survives; `insert-file!` drops it because an INSERT never replaces a persisted object. The column is the only source of truth and the metadata no longer carries `storage-ref-id` (the migration removes it from the backfilled rows and the write path never stores it); the release is a coordinated restart when the storage backend is in use (the previous code cannot read the new rows), while the default `db` backend reads the same data column and tolerates a rolling deploy. Responses built from a file map go through `bfc/file->response`, which strips the pointer and a residual `storage-ref-id` from the metadata.
|
- `fdata/upsert!` touches any storage object referenced by incoming metadata before storing the new row/blob.
|
||||||
- Pointer-map fragments are persisted separately as type `fragment`, and only modified pointer maps are written. A pointer keeps its id while nothing changes; content (`assoc`/`without`) and metadata (`with-meta`) changes produce a fresh id, so a fragment row is never rewritten after it is written. Re-assoc with an identical value returns the same map in array and hash maps alike, so a save keeps the fragment id of every page it does not change.
|
- Pointer-map fragments are persisted separately as type `fragment`, and only modified pointer maps are written.
|
||||||
- `enable-objects-map` skips unloaded pointer pages: their fragment was already wrapped when it was written, and loading it only to wrap it again costs one page read per untouched page on every save. A page with a plain fragment is wrapped when it is first loaded or edited; a data migration that enables `fdata/objects-map` must rewrite the data itself.
|
|
||||||
- Snapshots share fragment rows with the live file (they are stored with pointers, not materialized). `file-gc` marks every fragment referenced neither by the current main file nor by an unpurged snapshot; the file is read unrealized and unchanged pages keep their ids via reattach, so a pass over an unchanged file writes no new fragments.
|
|
||||||
- A save attaches its automatic snapshot before applying pending file migrations: the snapshot keeps the pre-migration pointers, data and migration set, and restoring it leaves the next read to migrate the file. This also holds for files without the feature. The preview (`get-file-snapshot`) applies the pending migrations in memory with the live file's libraries and never persists them: the stored version keeps its data, the payload carries the snapshot's `:migrations` (an ordered set) and `fdata/objects-map` is realized for clients that do not declare it. The historical feature set is deliberately not checked against the enabled one: a version may predate a feature change. The window is narrow: the `get-file` RPC reads with `migrate?` on and its ETag hashes `available-migrations`, so a post-deploy read cannot be a 304 from the pre-deploy state and migrates before any save in the normal flow; the pre-migration snapshot only appears when the save is the first request to touch the file after the deploy (an open tab that saves without re-reading, or a non-UI writer). `create-file-snapshot` and the restore backup read with `migrate?` on, so those versions are stored already migrated.
|
|
||||||
- `:migrations` is always a `d/ordered-set`: `file-migrations/resolve-applied-migrations` builds one, `fmg/migrate` re-wraps the union after applying, and `file-snapshots/decode-snapshot` converts the `file_change` pgarray (as a plain vector, `set/difference` and `contains?` would compare indexes instead of names). A snapshot with NULL `:migrations` and an old `:version` predates the `file_change.migrations` column (SQL migration 0140): the preview regenerates the set from the stored version and applies that full chain, while `restore!` uses a fixed 67 baseline, so preview and restore can disagree for very old snapshots.
|
|
||||||
- The migration read path (`binfile.common/get-file*`) reads the `file` row once (`sql:get-file`, with its data columns; with the storage backend the blob lives in the object, not in the column) plus an explicit `resolve-applied-migrations`, because a row read does not resolve them. A read with no pending migration is completed by `attach-file-data` on that map: one row read and one migrations resolution. Only when a migration is pending is the row re-read under `FOR UPDATE` on the `file` row, where `need-migration?` is re-checked on the fresh map and the migrated file persisted (`binfile.common/migrate-file`); that re-read resolves the migrations again, and `migrate-file` once more after persisting, to return the applied set. The migration path holds two raw copies of the blob (the first read and the locked re-read) but a single decoded one: the alternative, a row-only probe before the read, avoided the first raw copy at the cost of an extra row read on every open, and was removed. `get-file` runs the read inside `db/tx-run!` (joining the caller's transaction when the cfg carries a connection) so the persist commits with the read; a read-only read (`:read-only?`) takes no lock and writes nothing, so it runs on a plain connection (`db/run!`) instead of opening a transaction of its own, and with a cfg that already carries a connection it still joins the caller's. It accepts a cfg map only and throws an `IllegalArgumentException` otherwise (`assert` is elided without `:backend-asserts`); a data read rejects `:lock-for-share?` (only row-only reads accept it), because the migration branch re-reads with `FOR UPDATE`, and a lock option needs a read-write transaction from the caller because PostgreSQL rejects row locks in a read-only transaction. A row-only read (`load-data?` false) resolves the applied migrations by default too (`:load-migrations?`), because the row can be completed later and the caller may need them; a caller that does not want them passes `:load-migrations? false`. Persisting is an optimization of the read (the read already returns migrated data): a row that changed between the first read and the locked read is not overwritten, and a pending migration discovered on the unlocked read is applied in memory only (the next read persists it under the lock). This was the only writer of the file row outside the lock protocol (save, library absorption, restore, `file-gc` and offload already take it); without it, a save that committed in between was overwritten by the stale map (lost content, `revn` moving back so the next save fails with `:revn-conflict`, and the object the save left as a frozen orphan). `migrate-file` captures `fdata/original-pointers` before realizing, reattaches unchanged positions after applying the migrations, and persists the reattached file; it returns that reattached map when it persists (the pages the migration does not change keep their pointers and fragment ids) and the realized map when it does not, so a read is plain only when the caller asks with `:realize?`, and a migration that adds `fdata/objects-map` skips the reattach so the pages get wrapped.
|
|
||||||
- `fdata/load-pointer` reads rows that a previous `file-gc` pass marked on purpose (explicit `::db/remove-deleted false`): the fragment is only gone once `objects-gc` purges it. The `get-file-fragment` RPC keeps rejecting marked rows.
|
|
||||||
- Bind the fragment loader through `fdata/with-pointers` (reads), `fdata/with-tracked-pointers` (writes with a loader) or `fdata/with-tracked` (writes with nothing to load yet, e.g. file creation), and `fdata/with-untracked` (validation passes that must track nothing) instead of hand-rolled `binding` forms. Two direct bindings remain on purpose: the fine-grained tracked toggles of `app.rpc.commands.files-update` (validation/repair turn tracking off, restore the existing atom and read it before repairing), and `binfile.common/encode-file` (a fresh tracked set inheriting the current one). Converge them only if atom-scoped macros (`with-tracking`, `with-inherited-tracking`) are added; today the extra indirection buys nothing.
|
|
||||||
- Snapshot creation takes `FOR UPDATE` on the file row: both `create-file-snapshot` and the backup read of `restore-file-snapshot` hold it from the read to the insert, so they serialize with a `file-gc` pass (`FOR UPDATE ... SKIP LOCKED`) and with a concurrent save, and never pin fragments the pass is about to mark. The lock is exclusive and not `FOR SHARE` because the migration-on-read path may re-read the same row with `FOR UPDATE`: a shared lock that asks for the exclusive one deadlocks two concurrent readers (one creating a snapshot, the other saving, both seeing a pending migration). `get-file-snapshot` realizes the snapshot pointers with the live file id (fragment rows are keyed by file, not by snapshot).
|
|
||||||
- `fdata/realize` combines pointer realization and object-map realization. Use it before operations that need complete in-memory file data instead of pointer placeholders.
|
- `fdata/realize` combines pointer realization and object-map realization. Use it before operations that need complete in-memory file data instead of pointer placeholders.
|
||||||
- A `file_data` row is one of three classes, told apart by `type`: `main` is the file's current state and carries `id = file_id`; `snapshot` is a point-in-time copy whose `id` is the one its `file_change` row shares; `fragment` is a piece of the pointer-map, referenced from the file's data.
|
- A `file_data` row is one of three classes, told apart by `type`: `main` is the file's current state and carries `id = file_id`; `snapshot` is a point-in-time copy whose `id` is the one its `file_change` row shares; `fragment` is a piece of the pointer-map, referenced from the file's data.
|
||||||
- Their lifecycles differ: `main` and `snapshot` live with the file (dated when it is deleted, undated when it is restored), while a `fragment` carries no date and is collected by `file_gc` once the file stops referencing it. Neither is a session buffer, so do not read a `fragment` as an ephemeral revision.
|
- Their lifecycles differ: `main` and `snapshot` live with the file (dated when it is deleted, undated when it is restored), while a `fragment` carries no date and is collected by `file_gc` once the file stops referencing it. Neither is a session buffer, so do not read a `fragment` as an ephemeral revision.
|
||||||
- File snapshots (versions) keep their metadata row in `file_change` and their payload in `file_data` (`type = 'snapshot'`). With the `db` backend `file_change.data` stays NULL: that column is only read by the `legacy-db` backend (it is no longer written), plus the rows written before the 2025-07 file storage refactor.
|
- File snapshots (versions) keep their metadata row in `file_change` and their payload in `file_data` (`type = 'snapshot'`). With the `db` backend `file_change.data` stays NULL: that column is only written by the `legacy-db` backend, plus the rows written before the 2025-07 file storage refactor.
|
||||||
- Tell a snapshot apart by `label IS NOT NULL` (with `created_by` / `deleted_at` as needed), never by `file_change.data IS NOT NULL`: the label holds with every file data backend, and the payload column stopped meaning "this is a snapshot" when the payload moved out. Queries that identify versions must use the label. `0157-migrate-legacy-file-data` moved the labelled leftovers to `file_data` and deleted the unlabelled payload rows, so from 2.19 on the label is the only marker there is.
|
- Tell a snapshot apart by `label IS NOT NULL` (with `created_by` / `deleted_at` as needed), never by `file_change.data IS NOT NULL`: the label holds with every file data backend, and the payload column stopped meaning "this is a snapshot" when the payload moved out. Queries that identify versions must use the label.
|
||||||
- The version quota counts of `app.rpc.quotes` (`sql:get-snapshots-per-file`, `sql:get-snapshots-per-team`) are served by the partial index `file_change__user_snapshots__idx`, whose predicate mirrors their where clause; changing one without the other drops the index only scan and the count walks the whole table again.
|
- The version quota counts of `app.rpc.quotes` (`sql:get-snapshots-per-file`, `sql:get-snapshots-per-team`) are served by the partial index `file_change__user_snapshots__idx`, whose predicate mirrors their where clause; changing one without the other drops the index only scan and the count walks the whole table again.
|
||||||
- Revisions live only in `file_change` and have no `file_data` counterpart. They are born already scheduled for deletion one hour later (`app.rpc.commands.files-update`) and the snapshot paths cannot reach one, because they resolve their row through a `label IS NOT NULL` filter.
|
- Revisions live only in `file_change` and have no `file_data` counterpart. They are born already scheduled for deletion one hour later (`app.rpc.commands.files-update`) and the snapshot paths cannot reach one, because they resolve their row through a `label IS NOT NULL` filter.
|
||||||
- A deletion date is assigned once and never moved: `restore-files` (`app.rpc.commands.files`) unmarks only durable history, which is `label IS NOT NULL` (the unlabelled rows that still carry a legacy payload are removed by `0157-migrate-legacy-file-data`, so restore leaves them dated), the `:file` method of `app.tasks.delete-object` dates only rows that have no date yet, and `objects-gc` collects only rows that carry one. Unmarking a revision leaves it invisible to `objects-gc` for ever, because nothing sets that date again.
|
- A deletion date is assigned once and never moved: `restore-files` (`app.rpc.commands.files`) unmarks only durable history, the `:file` method of `app.tasks.delete-object` dates only rows that have no date yet, and `objects-gc` collects only rows that carry one. Unmarking a revision leaves it invisible to `objects-gc` for ever, because nothing sets that date again.
|
||||||
- Binfile v1/v3 import and the v3 export `get-file` step run inside one long transaction. They raise `idle_in_transaction_session_timeout` to 30 min (`app.binfile.common/transaction-idle-timeout-ms`) instead of disabling it, so a connection left idle while the ZIP is decoded or the file data is realized is bounded; `statement_timeout` stays at 300 s.
|
- Binfile v1/v3 import and the v3 export `get-file` step run inside one long transaction. They raise `idle_in_transaction_session_timeout` to 30 min (`app.binfile.common/transaction-idle-timeout-ms`) instead of disabling it, so a connection left idle while the ZIP is decoded or the file data is realized is bounded; `statement_timeout` stays at 300 s.
|
||||||
- `update-file` with `:changes-with-metadata` groups that all carry `:commit-id` is partial: fast path applies and validates everything once; on a change failure it bisects the commits for the longest prefix that applies and validates (each attempt applies a prefix from the original data and runs referential integrity + file schema; ~log2 K attempts, none for a single commit, the first attempt's error reused), keeping that prefix (a commit that repairs an earlier one can keep both) and answering 200 with `:rejected {:commit-ids :failed-commit-id :error}`, plus `:preexisting-damage true` when the data the first rejected commit touches already fails validation without it (`preexisting-damage?`: one more referential + schema check of its pages/components on the base file, the accepted prefix or the original; the frontend then says the page data is damaged). Only accepted changes reach `file_change`, persistence and the msgbus; a fully rejected request writes and broadcasts nothing (revn unchanged). Flat `:changes` or groups without ids stay all-or-nothing. Before each attempt (`apply-prefix`, which returns `{:file :tracked :refs}` or the cause) `pmap/*tracked*` and the `cpc/*state*` atom are reset to their pre-attempt values (at the end `apply-commits` sets those of the kept prefix): a pointer map already `modified?` keeps its id when changed again, so the failed version would be persisted. DB/IO/interrupt errors and `:not-found` fragments (`change-failure?`) fail the whole request, never reject a commit. A rejection whose ex-info has no `:type` reports `:internal :unexpected-error`. `app.http.errors` answers 503 (`:server-error` + code) for transient SQLSTATEs (classes 08/53, 57P01–3, 40001, 40P01), `SQLTransientException`, `InterruptedException` and only the `IOException`s that pass on their own (`transient-io-exception?`: `SocketException`, `InterruptedIOException` incl. socket timeouts, `UnknownHostException`, `HttpTimeoutException`), which the client's save retries (and GETs retry by themselves); any other `IOException` (EOF from a corrupt blob, Jackson parse errors, missing files) stays 500 `:io-exception`, as do other SQL errors. With the `:debug-save-faults` flag, a `:set-plugin-data` file change in namespace `:penpot-debug` keyed `save-fault:<kind>` raises that fault in `apply-changes` (used by `debug.failNextSave`/`commitInvalidChange`). With a schema check running (hard schema validation without skip-validate, or soft) and 2+ commits, the touched pages' objects are decoded on the original file first (`decode-objects`; referential validation alone reads few objects, so no pre-decode then): objects-map caches decoded values per instance and a derived map copies the cache, so otherwise every attempt re-decodes the page (~260 ms at 10k shapes). Validation step timings (`with-validation-timing`, upstream `penpot_rpc_update_file_validation_timing` + the `update-file` debug log) come from the first attempt only (retries run with a cfg without metrics and timings); the whole bisection is one `retry` step sample, and the rejection log carries `:attempts`/`:elapsed`.
|
|
||||||
|
|||||||
@ -3,35 +3,10 @@
|
|||||||
JVM `clojure.test` (kaocha runner) under `backend/test/backend_tests/`.
|
JVM `clojure.test` (kaocha runner) under `backend/test/backend_tests/`.
|
||||||
|
|
||||||
- READ `mem:testing` FIRST — it defines the execution discipline (no piping, tee to file, preferred commands) that applies to all JVM test runs.
|
- READ `mem:testing` FIRST — it defines the execution discipline (no piping, tee to file, preferred commands) that applies to all JVM test runs.
|
||||||
- Test DB/Redis come from the `PENPOT_TEST_*` env vars already set in the shell (`PENPOT_TEST_DATABASE_URI`, `PENPOT_TEST_REDIS_URI`, ...); per instance they point at `penpot_test` / `penpot_test_wsN` and valkey DB `6+N` (`mem:devenv/core`). Do not override them with values copied from CI logs or other sources unless the user asks (e.g. "use a temporary database"); the CI env (`redis://redis/1`, `postgresql://postgres/penpot_test`) only works inside the CI docker network.
|
|
||||||
- The test database may have migrations applied from newer versions (it is shared dev infra). Reinitializing it — `dropdb`/`createdb` of the `PENPOT_TEST_*` database only — is explicitly permitted when that blocks a test run; never drop the main `penpot` database or another instance's test database.
|
|
||||||
- All CLI commands must be executed from the `backend/` subdirectory.
|
- All CLI commands must be executed from the `backend/` subdirectory.
|
||||||
- Tests are invoked directly via `clojure -M:dev:test` (kaocha) — there is no pnpm wrapper. Kaocha auto-discovers test namespaces, so no runner registration is needed.
|
- Tests are invoked directly via `clojure -M:dev:test` (kaocha) — there is no pnpm wrapper. Kaocha auto-discovers test namespaces, so no runner registration is needed.
|
||||||
- **Preferred way to run them: `scripts/ci <module> --test`**, which runs lint, tests and format per module and writes a log per task under `.ci-logs/`. It exports `PENPOT_FLAGS` with `enable-backend-asserts` appended, so use it rather than calling `clojure -M:dev:test` by hand.
|
|
||||||
- **Why the flag matters:** `clojure.core/assert` is elided at compile time when `*assert*` is false, and `app.config` only sets that var from the flags when it loads. The test fixture redefines the flags after that, so they never reach it: without the flag the suite runs with every assertion compiled out, and a test that depends on an assert only means something with it set. `scripts/ci` and `tests-backend.yml` export the flag (GitHub Actions sets it too). When running the suite directly — including a `--focus` run — the command is `PENPOT_FLAGS="enable-backend-asserts" clojure -M:dev:test`.
|
|
||||||
- Coverage: if code is added or modified in `src/`, corresponding tests in `test/backend_tests/` must be added or updated.
|
- Coverage: if code is added or modified in `src/`, corresponding tests in `test/backend_tests/` must be added or updated.
|
||||||
- Isolated run: `clojure -M:dev:test --focus backend-tests.my-ns-test` for a specific test namespace, or `clojure -M:dev:test --focus backend-tests.my-ns-test/my-test-var` for a specific test var. Keep the `PENPOT_FLAGS="enable-backend-asserts"` prefix on these too; a focused run without it hides assert-dependent failures exactly like a full one.
|
- Isolated run: `clojure -M:dev:test --focus backend-tests.my-ns-test` for a specific test namespace, or `clojure -M:dev:test --focus backend-tests.my-ns-test/my-test-var` for a specific test var.
|
||||||
- A **whole-suite** crash reported as `Execution error ... Assert failed: ...` with no `FAIL in` line is not a test failure: an `ig/assert-key` ran while the test system was being built, which happens outside `clojure.test`, so kaocha reports it as a load/build error and the summary has no counts. Fix the offending schema (see `mem:backend/subtleties`) rather than hunting for a test.
|
|
||||||
- Multiple focus symbols are supported by REPEATING the flag (kaocha accumulates them, last-wins does not apply): `clojure -M:dev:test --focus backend-tests.ns-one --focus backend-tests.ns-two` — preferred over a shell loop of isolated runs.
|
|
||||||
- Regression run: `clojure -M:dev:test` to ensure no regressions in related functional areas.
|
- Regression run: `clojure -M:dev:test` to ensure no regressions in related functional areas.
|
||||||
- Line coverage: append the `:coverage` alias (`clojure -M:dev:test:coverage`, kaocha-cloverage). It instruments every `app.*` namespace under `src/` at load, before any test runs, so even a `--focus` run instruments them all; options live under `:cloverage/opts` in `tests.edn`, output in `target/coverage/` (lcov, HTML, and EMMA `coverage.xml` whose form counts the PR report shows as statements; cloverage measures no functions or branches) (`lcov.info`, HTML). About 2x slower and noisy with reflection warnings (instrumented forms lose type hints): never use it for normal runs. `tests-backend.yml` runs it and renders the step summary with `scripts/coverage-summary.mjs`.
|
|
||||||
- If you need to filter output, tee to a temp file first: `clojure -M:dev:test 2>&1 | tee /tmp/penpot-test-output.txt`.
|
- If you need to filter output, tee to a temp file first: `clojure -M:dev:test 2>&1 | tee /tmp/penpot-test-output.txt`.
|
||||||
- RPC test helpers `command!`/`management-command!` split the data map: qualified keys become server params, unqualified keys become request body params. To inject request-level context (headers, `:app.http/auth-key-id`, ip), pass a map under `:app.http/request` metadata; non-map `IRequest` stubs fall back to a dummy request.
|
- `backend-tests.helpers` has `metrics-stub` (a metrics instance with no collectors, where every `run!` is a no-op), `init-climit` (a concurrency limiter built from an inline config map, with an optional second argument for the metrics instance to publish to) and `with-climit`, the macro that builds one, runs the body and halts it. `init-climit` starts the republisher daemon thread, so a test that builds a limiter without halting it leaks that thread for the rest of the JVM run: use `with-climit`. Log lines are capturable with `add-watch` on `app.common.logging/log-record` (it holds the last record; the watcher sees every one, but only of the levels the logger has enabled: a line the app writes at TRACE never gets there).
|
||||||
- The test system is `main/system-config` + `main/worker-config` with the
|
|
||||||
components that must not run in the background dropped: HTTP, the srepl,
|
|
||||||
cron, the dispatcher and **every** `[<profile> :app.worker/runner]`
|
|
||||||
(`helpers/remove-job-runners`). A live runner of any queue races the tests
|
|
||||||
that drive the loop by hand (`wdisp/run-batch` + `@#'wrkr/run-worker-loop`):
|
|
||||||
it takes the job the test just dispatched and completes it behind the test's
|
|
||||||
back, so the test's own assertions read a state it did not produce. Do not
|
|
||||||
re-add a runner by editing that list by hand; the removal matches by key
|
|
||||||
shape on purpose.
|
|
||||||
- `system-config` and `worker-config` are `def`s: their `(cf/get ...)` calls
|
|
||||||
are evaluated when the namespace loads, against the real environment, while
|
|
||||||
test code calling `cf/get` at run time sees the `penpot-test`-prefixed
|
|
||||||
config. The two can disagree — in the devenv `:tenant` is `devenv-ws0` for
|
|
||||||
the defs and `default` inside a test — so a component built from
|
|
||||||
`worker-config` can talk to a different Redis key prefix than a cfg the test
|
|
||||||
builds itself. The symptom is a component that silently does nothing
|
|
||||||
locally and races in CI (which sets no `PENPOT_TENANT`).
|
|
||||||
- `backend-tests.helpers` has `metrics-stub` (a metrics instance with no collectors, where every `run!` is a no-op), `init-climit` (a concurrency limiter built from an inline config map, with an optional second argument for the metrics instance to publish to) and `with-climit`, the macro that builds one, runs the body and halts it. `init-climit` starts the republisher daemon thread, so a test that builds a limiter without halting it leaks that thread for the rest of the JVM run: use `with-climit`. Log lines are capturable with `add-watch` on `app.common.logging/log-record` (it holds the last record; the watcher sees every one, but only of the levels the logger has enabled: a line the app writes at TRACE never gets there). The logger swaps the record on an executor thread, after the call that logged it returns: keep the watch installed until the record arrives (poll for it) and only then remove it, or the record lands on nobody under load.
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
# Backend WebSocket Subscriptions
|
|
||||||
|
|
||||||
## Registry
|
|
||||||
|
|
||||||
- `app.http.websocket/state` holds `{:connections {conn-id → wsp} :by-profile {profile-id → #{conn-id}}}` in **one** atom, so a single `swap!` keeps both consistent; `register-connection`/`unregister-connection` maintain them together and drop a profile from the index once its last connection leaves.
|
|
||||||
- Each connection's own `::ws/state` atom holds its subscriptions (`::file-subscription`, `::team-subscription`). `state` is shadowed by `::ws/state` in every `handle-message` destructuring, so only `on-connect`, `on-disconnect` and the `repl-*` helpers touch the registry — reading the registry from a handler is a bug.
|
|
||||||
- `::profile-id` and `::session-id` on a connection live in the `app.http.websocket` namespace, while `::ws/id`, `::ws/state`, `::ws/output-ch`, `::ws/session-id` live in `app.util.websocket`. Mixing them up yields silently `nil` values (a `nil` `session-id` makes the channel's `:xf` drop **every** message).
|
|
||||||
- The registry is local to one backend instance. The message bus is shared (`mem:prod-infra/core`). Anything that must reach connections owned by another instance has to go through the bus — closing a connection from an RPC handler only ever works in a single-backend deployment.
|
|
||||||
|
|
||||||
## Revocation model
|
|
||||||
|
|
||||||
A subscription is authorized once, at `:subscribe-file`/`:subscribe-team`, and that decision used to be trusted for the whole connection life (GHSA-m53j-2766-6jqw, medium). Two independent mechanisms now bound it:
|
|
||||||
|
|
||||||
- **Announcement (primary).** A mutation that can change access publishes on `app.rpc.notifications/internal-revocation-topic` (`notify-permissions-changed` for one profile, `notify-team-permissions-changed` for one team id — the watcher resolves the members itself, so a large team is one event, not N). The `::revocation-watcher` Integrant component in `app.http.websocket` subscribes and calls `revalidate-profile-subscriptions`, which looks the profile up in `:by-profile` and re-checks every subscription with `file-readable?`/`team-readable?`: existence (the file gate is the same `sql:get-minimal-file` as the `:subscribe-file` gate, made non-throwing via `{:db/throw-if-not-exists false}`; the team gate is `db/get*` with `::sql/columns [:id :deleted-at]` — `deleted_at` must be in the projection or the soft-delete filter is a no-op) AND the `has-read-permissions?` predicates — and `sql:file-permissions` additionally filters `deleted_at` on file, project and team, as do `sql:get-team-id-for-file`/`-project` plus a final team-row check in `resolve-team-id`, so the organization-owner fallback grants nothing through soft-deleted file/project/team. The existence gate closes that fallback (expelled org owner, deleted resource). The event is only the trigger; the fresh check is the decision, which is what keeps a downgrade to `viewer` (still readable) and a non-member organization owner on a live resource from being mistaken for a revocation. Both publishers defer through `db/after-commit`, because the watcher checks on another connection and would otherwise see the pre-commit state. `:subscribe-team` deliberately has no existence gate of its own; only the re-checks add one, matching the file side (user decision, PR #12189 review).
|
|
||||||
- **Interval (safety net).** `start-relay` runs the relay as a `go-loop` that waits on the subscription channel and a one-shot tick channel together via `sp/alts!` with `:priority true` on the tick: when both hold something, the tick wins, so a steady stream of messages can never push the re-check away. The cadence is `subscription-revalidation-interval` (default `default-revalidation-interval`, 5 min, a code constant in `app.http.websocket` and **not** in the `config.clj` default map, same rule as session lifetimes). The deadline is fixed per cadence: a single tick channel covers a whole cadence and message turns reuse it (minting a fresh timeout per turn would both churn timers and starve under load exactly like an in-loop timer does); a new one is minted only after a tick fires. It covers what no announcement can: Nitrate transferring organization ownership (an HTTP call to another service) and rows deleted straight over SQL. Closing the channel ends the loop either way, because a take on a closed channel is always ready with nil — every way a subscription can end closes it, so a finished relay never keeps polling. Cost is three or four queries per subscription per interval (existence row + predicates), plus one Nitrate call per team per interval when the `:admin-console` flag is on (cached 30 s); one `timeout-chan` per subscription per cadence on promesa's default scheduler (one or two threads shared with every other scheduled task) — do not shorten the interval without sizing that. A tick abandoned at teardown (the subscription closed while it was pending) still fires its scheduled close harmlessly. Two places fail open, deliberately: `still-authorized?` (a transient DB error logs and keeps the subscription; `InterruptedException` is rethrown) and the `catch Throwable` in `watch-revocations`.
|
|
||||||
|
|
||||||
Which mutations announce: `delete-team-member`, `leave-team`, `update-team-member-role` (member only), `delete-team`, `delete-file`, `delete-project`, `move-files`, `move-project` (one team event each). Anything not listed here is covered only by the interval. `delete-share-link` deliberately does not: a share-link visitor never passes the websocket subscribe check, because `check-read-permissions!` is called without a `share-id` and that arity only considers team membership.
|
|
||||||
|
|
||||||
`close-file-subscription`/`close-team-subscription` are idempotent: no-op on a mismatched id, and they `dissoc` the subscription so a repeat call and `:pointer-update` do not publish to a dead topic. Closing the channel is what ends the relay (`take!` on a closed channel returns `nil`).
|
|
||||||
|
|
||||||
## Topic and layering
|
|
||||||
|
|
||||||
- `internal-revocation-topic` is a fixed uuid that is never a real resource id, so it cannot collide with a file, team or profile topic — and deliberately not the `uuid/zero` system topic, which is `sp/pipe`d straight into the client output and anything published there reaches every client. No client can subscribe to the internal topic: `:subscribe-file`/`:subscribe-team` only accept ids that already passed a permission check, and `:broadcast`/`:pointer-update` only republish to ids the server already holds.
|
|
||||||
- The topic and the publish helpers live in `app.rpc.notifications`, not in `app.http.websocket`: the command namespaces cannot require the watcher, because `app.http.websocket` already requires `app.rpc.commands.files`/`teams`. The watcher keeps the registry, which is the part it owns.
|
|
||||||
|
|
||||||
## Time and channel traps in this namespace
|
|
||||||
|
|
||||||
- The relay waits with `sp/alts!` over `[tick-ch channel]` with `:priority true`, following the `msgbus.clj` pattern (`start-io-loop` destructures the same `[val port]` shape and compares ports with `identical?`). A take on a closed channel is always ready with nil, which is what ends the loop — and what makes closing the channel from any teardown path prompt even while parked in `alts!`. `sp/timeout-chan` is one-shot: it closes once after the delay, and one abandoned at teardown still fires its scheduled close harmlessly.
|
|
||||||
- `ct/diff a b` returns **b − a** (`Duration/between`), so "time until a future instant" is `(inst-ms (ct/diff (ct/now) future))`.
|
|
||||||
- `ct/duration` unit keywords are singular: `{:millis 150}`, `{:minutes 5}`, never `:milliseconds`/`:days`.
|
|
||||||
- `still-authorized?` takes the check itself: `(boolean (check-access))`. Calling `(boolean pred)` on the closure is always true and silently disables the interval — this exact bug shipped once and no test caught it until the resubscribe-counting test existed. Naming rule here: no `?` for the action that queries and can fail (`check-access`), `?` only for the safe yes/no answer (`still-authorized?`).
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
`backend/test/backend_tests/http_websocket_test.clj` drives the real Redis-backed msgbus, so the revocation tests are end-to-end: register the connection in the real registry, run the real command, wait for the subscription to drop, then assert no content arrives. A connection built without `register-connection` is invisible to the watcher, so the watcher-based tests must go through `open-registered-connection`. Interval tests shorten the config via `with-redefs` on `cf/get` rather than waiting minutes. `with-clean-registry` runs as an `:each` fixture, so no test can leak a live relay loop into the next one. `captured-events` forwards the keyword args through to the real `mbus/pub!` — rebuilding them positionally publishes to the topic `:message` with a `nil` payload and silently untests every other notice. Interval tests take access away with a direct row delete, never with a command: a command announces, so the test would pass even with the interval removed. The same rule covers the two counting/fan-out tests: `revocation-closes-subscriptions-that-are-no-longer-authorized` takes access away with `delete-team-membership!` (raw row delete, publishes nothing) because a command announcement lets the live watcher close both subscriptions before the test's own `revalidate-profile-subscriptions` call, and its `(= 2 …)` count then reads 0; `team-event-closes-every-member-subscription` soft-deletes the team row (`sql:team-members` joins `team_profile_rel` and `profile` only, so the watcher still resolves every member) and asserts nothing closed before one synthetic `notify-team-permissions-changed`, leaving the command path to `deleting-a-team-announces-once` and `deleting-a-team-closes-open-subscriptions`. The resubscribe-counting test is the one that proves finished relays stop polling. The soft-delete + org-owner re-check tests pair a direct row soft-delete with `with-redefs` on `nitrate/organization-owner-of-team?`: before the existence gate, the org-owner fallback kept the subscription open on a deleted resource. The soft-deleted-project/team-closes-org-owner-file-subscription tests pin the root fix in `app.rpc.permissions` (`resolve-team-id` refuses dead file/project/team for every caller of the fallback). `watcher-consumes-revocation-events-from-the-bus` takes access away with a direct row delete and drives the watcher with a synthetic bus event — never a command and never a second `notify-*` — so the "still subscribed" assertion cannot race an after-commit hook and a broken command announcement cannot mask a broken watcher. `moving-a-project-closes-source-team-subscriptions` pins the move-project asymmetry: the file subscription drops, the source-team subscription survives (the member is still a member).
|
|
||||||
|
|
||||||
`revocation-watcher-schema-resolves-every-ref` covers the `::revocation-watcher` params schema, which no other test compiles. It existed broken for a while: the three injected keys were written as bare keywords, which is a valid malli *property* position and not a key, so the schema raised `:malli.core/invalid-schema` — invisible unless `PENPOT_FLAGS=enable-backend-asserts` was set, and a crash of the whole system build rather than one test (see `mem:backend/testing` on the flag).
|
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- `mem:backend/auth-permissions-product-domains` for the permission predicates and the not-found semantics that the re-checks reuse.
|
|
||||||
- `mem:prod-infra/core` for why the bus crosses backends and the registry does not.
|
|
||||||
- `mem:frontend/routing-app-shell-subtleties` for the client side: the frontend already reacts to `team-membership-change` by navigating away, which is why revocation needs no new client message.
|
|
||||||
- `.agents/plans/2026-10-07-websocket-subscription-revocation.md` for the original plan, and the sibling `.agents/plans/2026-10-05-leave-team-file-access-cleanup.md` whose hardened permission queries this re-verification depends on (without live team membership required in `sql:file-permissions`, the re-check would keep reporting access for a member who already left).
|
|
||||||
@ -1,4 +1,4 @@
|
|||||||
# Clojure Core
|
# Clojure Design Rules
|
||||||
|
|
||||||
How to shape a function in this codebase. Each rule came from a review round; do not re-derive from taste.
|
How to shape a function in this codebase. Each rule came from a review round; do not re-derive from taste.
|
||||||
|
|
||||||
@ -8,8 +8,7 @@ How to shape a function in this codebase. Each rule came from a review round; do
|
|||||||
- **Functions that obtain data start with `get-` or `fetch-`.** A reader must see at a glance that the function reads (`get-file`, `get-snapshot`, `get-file-json`); a bare noun hides it (`file-json` says nothing about reading). New helpers that fetch by id follow this, never a `current-` prefix: the id parameter already says which one it is.
|
- **Functions that obtain data start with `get-` or `fetch-`.** A reader must see at a glance that the function reads (`get-file`, `get-snapshot`, `get-file-json`); a bare noun hides it (`file-json` says nothing about reading). New helpers that fetch by id follow this, never a `current-` prefix: the id parameter already says which one it is.
|
||||||
- **`?` marks a predicate, not a data prop.** A var or function that answers a question takes `?` (`export-error?`, `(defn editable? …)`); a map key that names a property does not (`:export-error`, never `:export-error?`), even when its value is a boolean. Existing `?` keys are legacy to remove gradually; do not add a new one.
|
- **`?` marks a predicate, not a data prop.** A var or function that answers a question takes `?` (`export-error?`, `(defn editable? …)`); a map key that names a property does not (`:export-error`, never `:export-error?`), even when its value is a boolean. Existing `?` keys are legacy to remove gradually; do not add a new one.
|
||||||
- **Do not shape production code for tests.** No return values added just to assert them; assert on the observable effect. When preconditions move, move the tests with them.
|
- **Do not shape production code for tests.** No return values added just to assert them; assert on the observable effect. When preconditions move, move the tests with them.
|
||||||
- **All code-facing text MUST be in English** — identifiers, comments, docstrings, test descriptions. No exceptions; see the hard rule in `AGENTS.md`.
|
|
||||||
|
|
||||||
Reference implementation: the http metrics samplers in `app.http` (`sample-worker-metrics` / `sample-connector-metrics` are guard-free; `sample-http-metrics` guards at the boundary).
|
Reference implementation: the http metrics samplers in `app.http` (`sample-worker-metrics` / `sample-connector-metrics` are guard-free; `sample-http-metrics` guards at the boundary).
|
||||||
|
|
||||||
See also: `mem:clojure/idioms` (language behaviors and naming exceptions), `mem:clojure/logging` (structured logging), `mem:testing` (TDD and test conventions).
|
See also: `mem:clojure/idioms` (language behaviors), `mem:testing` (TDD and test conventions).
|
||||||
@ -1,15 +1,21 @@
|
|||||||
# Clojure Idioms (verified)
|
# Clojure Idioms (verified)
|
||||||
|
|
||||||
Behaviors confirmed against the language/stdlib — do not re-derive from assumption; a wrong assumption here already cost a review round.
|
Behaviors confirmed against the language/stdlib — do not re-derive from
|
||||||
|
assumption; a wrong assumption here already cost a review round.
|
||||||
|
|
||||||
- `int?` is NOT 32-bit-only: true for `Long`, `Integer`, `Short`, `Byte` (fixed-precision integers). Clojure integer literals are `Long`, so `(int? 5000)` is true.
|
- `int?` is NOT 32-bit-only: true for `Long`, `Integer`, `Short`,
|
||||||
- `integer?` is the general integer predicate; prefer it when any integer kind must match, `int?` only when fixed precision is meant.
|
`Byte` (fixed-precision integers). Clojure integer literals are
|
||||||
- `await` is a `cljs.core` macro asserting `(:async &env)`: it fails at compile time outside an `^:async` context, never silently.
|
`Long`, so `(int? 5000)` is true.
|
||||||
- The analyzer reads `:async` only from the fn name meta and the `fn` operator meta; list-level meta is ignored (would make a MetaFn). `(fn ^:async [] …)` puts the meta on argv (pre/post only, NOT async).
|
- `integer?` is the general integer predicate; prefer it when any
|
||||||
- Valid: `(defn ^:async f)`, `(defn- ^:async f)`, `(^:async fn [] …)` (the latter is what stock `t/async` generates itself).
|
integer kind must match, `int?` only when fixed precision is meant.
|
||||||
- `^:async` fns never throw synchronously (rejected promises instead); `try/catch/finally` supported; continuations are microtasks, timers and RxJS schedulers are macrotasks (FIFO).
|
- `await` is a `cljs.core` macro asserting `(:async &env)`: it fails at
|
||||||
- Inside an `^:async` fn, a nested call that needs a temp binding (e.g. calling a local fn `(g (f x))`, whose arg gets a `G__` binding) compiles to `(await (async function(){…})())`: `await` unwraps a returned promise, so `(settled (upload (make-ctx)))` blocks until the upload promise settles instead of passing the promise on (a test that pushes the answer later hangs, idle). Bind each step in its own `let` binding.
|
compile time outside an `^:async` context, never silently.
|
||||||
- `!` suffix allowed cases (only exceptions to the no-new-`!` rule in `mem:clojure/core`): mutating public `app.db` API (`insert!`, `update!`, `delete!`, `run!`, `tx-run!`, `exec!`, ...) and fns whose contract is to work over transients (stdlib `conj!`, `assoc!`, `dissoc!`, `disj!`, `persistent!` and custom helpers over them); any further case must be registered here with justification before use.
|
- The analyzer reads `:async` only from the fn name meta and the `fn`
|
||||||
- Penpot extends `clojure.core/Inst` in `app.common.time` ( JVM-only section), so `inst-ms` also accepts `Duration` (returns `.toMillis`, NOT epoch millis), `FileTime` and `OffsetDateTime`. It only works where that namespace is loaded; on a bare `Duration`, prefer explicit `.toMillis`, which reads as what it is (an amount, not an instant).
|
operator meta; list-level meta is ignored (would make a MetaFn).
|
||||||
- The threading macros insert the threaded value at DIFFERENT positions: `->` and `some->` put it FIRST (`(-> x (f a))` → `(f x a)`), `->>` and `some->>` put it LAST (`(->> x (f a))` → `(f a x)`). `some->`/`some->>` also short-circuit on nil. With unary calls both nest the same way (`(-> x (f) (g))` and `(->> x (f) (g))` are both `(g (f x))`): what changes between them is the position inside each call, not the order of the steps. A pipeline that calls a fn whose first argument is a config/context (`app.features.fdata/resolve-file-data` is `(cfg, file)`) must use `->>`/`some->>`; with `->`/`some->` the arguments are swapped and the call silently returns the wrong value (it cost a broken `get-snapshot` in `app.features.file-snapshots`).
|
`(fn ^:async [] …)` puts the meta on argv (pre/post only, NOT async).
|
||||||
|
- Valid: `(defn ^:async f)`, `(defn- ^:async f)`, `(^:async fn [] …)`
|
||||||
|
(the latter is what stock `t/async` generates itself).
|
||||||
|
- `^:async` fns never throw synchronously (rejected promises instead);
|
||||||
|
`try/catch/finally` supported; continuations are microtasks, timers and
|
||||||
|
RxJS schedulers are macrotasks (FIFO).
|
||||||
- `cuerdas.core/index-of` returns `nil` (not `-1`) when the substring is absent, like `clojure.string/index-of`. `(pos? nil)` **throws on the JVM** but evaluates to `false` in CLJS (JS coercion), so `(if (pos? (str/index-of s "\n")) …)` works in the browser and crashes the backend. Guard with `some?` before `pos?` (this was `app.common.exceptions/first-line`).
|
- `cuerdas.core/index-of` returns `nil` (not `-1`) when the substring is absent, like `clojure.string/index-of`. `(pos? nil)` **throws on the JVM** but evaluates to `false` in CLJS (JS coercion), so `(if (pos? (str/index-of s "\n")) …)` works in the browser and crashes the backend. Guard with `some?` before `pos?` (this was `app.common.exceptions/first-line`).
|
||||||
|
|||||||
@ -1,7 +0,0 @@
|
|||||||
# Clojure Logging Conventions
|
|
||||||
|
|
||||||
Structured logging through `app.common.logging` (`l/trc`/`l/dbg`/`l/info`/`l/wrn`/`l/error`/`l/fatal`): `:hint` carries the human-readable message, every other datum goes in its own keyword field (`:id`, `:container`, `:removed`, ...).
|
|
||||||
|
|
||||||
- `:hint` values start lowercase: `"fix dangling children"`, not `"Fix dangling children"`. Uppercase-first hints exist as legacy (~57 occurrences, the densest in `backend/src`; also `l/trc` in migration `legacy-28` and `log/error` in `app.common.files.repair`) — do not copy them, and do not mass-rewrite them unless the surrounding code needs the change.
|
|
||||||
- A name that requires uppercase (an env var like `PENPOT_MEDIA_PROCESSING_SERVICE_URI`, an acronym like `MCP` or `LDAP`) stays uppercase inside an otherwise lowercase sentence.
|
|
||||||
- Repair work done by a file migration logs at `l/trc`, only when it changes something, and with the ids it touched: the house style of `migrations.cljc` (`legacy-28` precedes; the file has no `warn`/`info` lines). The shipped `log4j2.xml` pins the `app` logger to `info` (static file, `monitorInterval="60"`), so those trace lines appear only after the operator raises the level; the durable record of a repaired file is the migration id in its `:migrations`.
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
# Promesa
|
|
||||||
|
|
||||||
Promise library of the monorepo (frontend CLJS and common, `funcool/promesa` 12.0.1 in `common/deps.edn`). Its API has two call styles and mixing them in one expression is the trap: `fmap`/`mcat`/`merr` are **fn first, promise last** (`->>` friendly) and `then`/`then'`/`catch`/`handle` are **promise first, fn last** (`->` friendly). Convention: `fmap`/`mcat`/`merr` inside `->>` pipelines, `then`/`catch` with `->`. A `then` written inside a `->>` reads backwards and hides whether the step carries a value or a promise.
|
|
||||||
- `fmap` (alias `map`, both `(f p)`) is functor map: `f` returns a plain value.
|
|
||||||
- `mcat` (alias `mapcat`, both `(f p)`) is monadic bind: `f` must return a promise, and the result mirrors it.
|
|
||||||
- `then` also unwraps a promise returned by `f`, which is why it covers both cases at the cost of not naming which one it is; `then'` maps without unwrapping.
|
|
||||||
- `merr` (fn first) and `catch` (promise first) are the error side.
|
|
||||||
- `all` takes a collection of promises (a lazy seq works); `let` chains sequential bindings.
|
|
||||||
- Seam with the rx pipelines of the frontend: `beicon.v2.core/from` builds an observable from "arrays, collections, and promise instance" (`external/beicon`), so `(->> p (p/mcat f) (rx/from) (rx/map g))` is the usual bridge (`app.main.data.imports`, `app.util.zip`).
|
|
||||||
@ -8,7 +8,6 @@ Each change is a map such as `{:type ... :id ... :page-id ...}`. Common families
|
|||||||
|
|
||||||
- `:add-obj`, `:mod-obj`, `:del-obj`: shape lifecycle. `:mod-obj` contains `:operations`, commonly `{:type :set :attr ... :val ... :ignore-geometry ... :ignore-touched ...}` or `{:type :set-touched ...}`.
|
- `:add-obj`, `:mod-obj`, `:del-obj`: shape lifecycle. `:mod-obj` contains `:operations`, commonly `{:type :set :attr ... :val ... :ignore-geometry ... :ignore-touched ...}` or `{:type :set-touched ...}`.
|
||||||
- `:add-component`, `:mod-component`, `:del-component`: component/library metadata.
|
- `:add-component`, `:mod-component`, `:del-component`: component/library metadata.
|
||||||
- Shapes stored inside the component record (deleted components keep them in `:objects`) are never written as a whole map: `mod-component` carries only component metadata by default, and shapes travel as `:mod-obj`/`:add-obj`/`:del-obj` changes scoped with `:component-id`. `pcb/update-component` has an `:objects? true` option for the two repairs that move or clear that key, and `ctkl/mod-component` reads an absent `:objects` as "leave the stored shapes alone" (only an explicit `nil` drops them). Before this, one component swap resent the full object map of every deleted component it touched (~6 MB in the request); do not reintroduce it.
|
|
||||||
- `:add-children`, `:remove-children`, `:reg-objects`: tree and object-map edits.
|
- `:add-children`, `:remove-children`, `:reg-objects`: tree and object-map edits.
|
||||||
- `:set-option`, `:add-page`, `:mov-page`, and related file/page metadata changes.
|
- `:set-option`, `:add-page`, `:mov-page`, and related file/page metadata changes.
|
||||||
|
|
||||||
@ -22,7 +21,7 @@ High-value builder operations:
|
|||||||
- `pcb/with-page-id`, `pcb/with-objects`, `pcb/with-library-data`: set context for following operations.
|
- `pcb/with-page-id`, `pcb/with-objects`, `pcb/with-library-data`: set context for following operations.
|
||||||
- `pcb/update-shapes ids update-fn`: emits `:mod-obj` with diff-derived `:set` ops. Options include `{:with-objects? true}`, `{:ignore-touched true}`, and `{:attrs #{...}}`.
|
- `pcb/update-shapes ids update-fn`: emits `:mod-obj` with diff-derived `:set` ops. Options include `{:with-objects? true}`, `{:ignore-touched true}`, and `{:attrs #{...}}`.
|
||||||
- `pcb/add-objects`, `pcb/change-parent`, `pcb/remove-objects`, `pcb/resize-parents`: shape/tree edits.
|
- `pcb/add-objects`, `pcb/change-parent`, `pcb/remove-objects`, `pcb/resize-parents`: shape/tree edits.
|
||||||
- `pcb/add-component`, `pcb/update-component`, `pcb/mod-component`: component/library edits. Repairs that fix shapes inside a component use `pcb/with-container` + `pcb/with-objects` + `pcb/update-shapes` so the changes come out scoped with `:component-id`.
|
- `pcb/add-component`, `pcb/update-component`, `pcb/mod-component`: component/library edits.
|
||||||
- `pcb/set-translation? true`: marks the whole change set as translation-only, which lets component sync skip expensive work.
|
- `pcb/set-translation? true`: marks the whole change set as translation-only, which lets component sync skip expensive work.
|
||||||
|
|
||||||
## Applying changes in tests
|
## Applying changes in tests
|
||||||
|
|||||||
@ -26,12 +26,6 @@ Respect the intended abstraction direction in new/refactored code:
|
|||||||
|
|
||||||
Some legacy code violates this layering; do not copy those violations into new code when a focused refactor is practical.
|
Some legacy code violates this layering; do not copy those violations into new code when a focused refactor is practical.
|
||||||
|
|
||||||
## Build-mode dependent laziness
|
|
||||||
|
|
||||||
`app.common.data.macros/lazy-delay` returns a delay whose expression is evaluated eagerly by default. Only the builds that set the `app.common.data.macros/lazy-delay?` closure define to `true` defer it to the first deref; every production build does (frontend `main` and `worker`, exporter, library), so the Closure compiler replaces the constant and drops the eager branch. On the JVM it is always eager.
|
|
||||||
|
|
||||||
`app.common.schema/check-fn` resolves its schema through it: an invalid schema definition fails when the namespace loads in development and in tests, and only on the first check call in production. The other lazily built parts of `check-fn` (validator and explainer) are always deferred.
|
|
||||||
|
|
||||||
## Focused memory routing
|
## Focused memory routing
|
||||||
|
|
||||||
Model, schema, and persistence shape:
|
Model, schema, and persistence shape:
|
||||||
|
|||||||
@ -6,7 +6,7 @@
|
|||||||
- Do not treat nil as a distinct persisted state from absence. Import/export and cleanup paths may filter nil attrs away.
|
- Do not treat nil as a distinct persisted state from absence. Import/export and cleanup paths may filter nil attrs away.
|
||||||
- Avoid Clojure-special naming in exported object attrs, especially boolean names ending in `?`; exported/imported data must survive JSON/SVG/Transit and external tooling.
|
- Avoid Clojure-special naming in exported object attrs, especially boolean names ending in `?`; exported/imported data must survive JSON/SVG/Transit and external tooling.
|
||||||
- Any new shape attr that participates in component sync must be listed in `app.common.types.component/sync-attrs` with the correct touched group. Attrs absent from `sync-attrs` are ignored by component synchronization.
|
- Any new shape attr that participates in component sync must be listed in `app.common.types.component/sync-attrs` with the correct touched group. Attrs absent from `sync-attrs` are ignored by component synchronization.
|
||||||
- Shape `:svg-attrs` keys are kebab-case (`fill-rule`, not `fillRule`): birth (`app.common.svg/attrs->kebab-props`, applied everywhere data lands on a shape) normalizes any outside spelling through the `svg-props` whitelist, and render boundaries (`get-svg-props`, `render-xml*`, `svg-node*`) translate back to camelCase for React. `:svg-defs` node attrs follow the same rule recursively; svg-raw `:content` attrs are kebab-ized spelling-only, never filtered — the sidebar reads `:stroke-style`, which is outside the whitelist. Non-spec attrs Penpot keeps live in `penpot-extra-attrs` (seeded with `:stroke-style`) and travel in source spelling. Excluded, each with its reason: `:tag` values (React and tag sets need them verbatim; the schema decoder restores keywords from stored strings), outer `:svg-defs` keys (id strings at birth, keywords or strings after JSON decode — accept both), all values (the kebab reader never touches values). Repair sites: birth plus migration `0035-fix-shape-svg-attrs-and-defs` (replaces the withdrawn `0021`); the binfile cleaner carries no svg repair.
|
- Shape `:svg-attrs` is the one map whose keys are camelCase React prop names (`fillRule`, not `fill-rule`), because the SVG import path runs them through `app.common.svg/attrs->props`. The `.penpot` reader (`app.common.json/read-kebab-key`) rewrites every json key of every entry to kebab-case, nested maps included, so any code that decodes a binary file must run `:svg-attrs` back through `attrs->props` or the names are lost. `:svg-defs` and the `:content` tree of `svg-raw` shapes keep their source names and round-trip on their own.
|
||||||
|
|
||||||
## Cross-module update checklist
|
## Cross-module update checklist
|
||||||
|
|
||||||
|
|||||||
@ -52,8 +52,3 @@ its own drift. Comparing `:selrect.width` from shape A to
|
|||||||
`:selrect.width` from shape B is comparing two values that
|
`:selrect.width` from shape B is comparing two values that
|
||||||
"semantically" should be equal but were computed via different
|
"semantically" should be equal but were computed via different
|
||||||
operation chains — exact equality will often be false.
|
operation chains — exact equality will often be false.
|
||||||
|
|
||||||
## Library sync comparison
|
|
||||||
|
|
||||||
- `update-attrs` (`app.common.logic.libraries`) compares main vs copy attrs exactly first, then with tolerance for: `drifting-geometry-attrs` (`:x :y :width :height :selrect :points`, via `gsh/close-attrs?`); path and bool `:content` (`segment/content-close?`; bool shapes keep their path in `:content`); and text `:position-data` (`position-data-close?` over `mth/close-map?`: every numeric field of every entry within `mth/close?`, other fields such as fills, fonts and text exact). All other attrs (`:opacity`, radii, `:transform`, `:rotation`, text `:content`) stay exact: tolerance there hides real changes.
|
|
||||||
- `close-attrs?` pairs lists with `d/zip`, which truncates to the shorter list and treats nil vs vector as equal for `:points`/`:position-data`. Do not use it for variable-length data. That is why `:position-data` has its own helper, and why `attr-equal?` checks the `:points` count before calling it.
|
|
||||||
|
|||||||
@ -20,10 +20,7 @@
|
|||||||
|
|
||||||
- Full referential/semantic validation currently runs only when file features contain `"components/v2"`.
|
- Full referential/semantic validation currently runs only when file features contain `"components/v2"`.
|
||||||
- Validation starts at root plus orphan shapes, then validates component records. `validate-file!` raises `:validation :referential-integrity` with collected details.
|
- Validation starts at root plus orphan shapes, then validates component records. `validate-file!` raises `:validation :referential-integrity` with collected details.
|
||||||
- `update-file` validates per save with the change-scoped variants: `validate-file-affected!` (referential, whole touched pages/components) and `validate-file-schema-affected!` (file schema with `:pages-index` reduced to the touched pages; non-page data checked whole). The schema variant maps change types to pages itself (`touched-page-ids`): a new change type that writes a page must be added there, or to `file-level-change-types` if it touches no page; an unknown type makes it check the whole file. The whole-file schema check loads and decodes every page, ~75–80% of a save on multi-page files.
|
|
||||||
- `repair-file` does not mutate data directly; it reduces validation errors into redo changes using `changes-builder`. Callers must apply or persist those changes.
|
- `repair-file` does not mutate data directly; it reduces validation errors into redo changes using `changes-builder`. Callers must apply or persist those changes.
|
||||||
- `repair-file-until-valid` stops on: no errors; unchanged `:data` after apply (backend page/`PointerMap` `=` is pointer identity); stable error fingerprint `(frequencies (map #(dissoc % :shape) errors))` vs previous pass (check fingerprint before `repair-file`/`process-changes`); or `max-iterations`. Each `repair-error` builds from the original `file-data`, so N `:set`-based errors on one shape take N passes.
|
|
||||||
- `:ref-shape-not-found` repair: when the copy root's local component has a `:main-instance-id` that resolves to no shape but a `:main-instance` shape of that component sits on its `:main-instance-page`, it emits `mod-component` pointing the id back to that main (keeps the copy linked; a repair scoped to the copy's page never sees the main's `:invalid-main-instance-id`). Otherwise near-main reassign, else detach the copy subtree.
|
|
||||||
- `:missing-slot` fires only for a REAL swap: a copy sub-head whose `shape-ref` is no longer a child of the near main parent. A pure positional mismatch (ref still a sibling elsewhere) is a reorder — valid, realigned by the async component sync; do not "repair" it by assigning swap slots (a slot freezes the child out of normal sync). `fix-missing-swap-slots` (migration 0019) follows the same membership rule.
|
- `:missing-slot` fires only for a REAL swap: a copy sub-head whose `shape-ref` is no longer a child of the near main parent. A pure positional mismatch (ref still a sibling elsewhere) is a reorder — valid, realigned by the async component sync; do not "repair" it by assigning swap slots (a slot freezes the child out of normal sync). `fix-missing-swap-slots` (migration 0019) follows the same membership rule.
|
||||||
|
|
||||||
## Migrations
|
## Migrations
|
||||||
@ -32,9 +29,3 @@
|
|||||||
- Migrations are an ordered set mixing legacy version-derived ids and newer named ids. Keep append order stable; `migrate` applies the set difference between available migrations and file migrations.
|
- Migrations are an ordered set mixing legacy version-derived ids and newer named ids. Keep append order stable; `migrate` applies the set difference between available migrations and file migrations.
|
||||||
- `migrate-file` synthesizes legacy migration ids from old numeric versions when `:migrations` is absent, migrates legacy features, and records feature flags created through `cfeat/*new*`.
|
- `migrate-file` synthesizes legacy migration ids from old numeric versions when `:migrations` is absent, migrates legacy features, and records feature flags created through `cfeat/*new*`.
|
||||||
- When a file had no previous `:migrations`, `migrate-file` marks all migrations as migrated in metadata so callers persist the complete migration set, not only transformations that changed data.
|
- When a file had no previous `:migrations`, `migrate-file` marks all migrations as migrated in metadata so callers persist the complete migration set, not only transformations that changed data.
|
||||||
- Closed schemas (`schema:stroke-attrs` and others) reject a key that was dropped from the declaration, so removing a declared attr needs a migration in the same change, for data already written with it.
|
|
||||||
- Rebase collision on a migration number: upstream keeps the id. Renumber the branch migration to the next free one, keep it last in `available-migrations`, and rename everything that spells the number — its test file and namespace (`files_migrations_00NN_test.cljc`), the test names, and comments in production code or memories that name it.
|
|
||||||
- Withdrawing a migration id: remove both the `defmethod` and the id from `available-migrations`; the replacement migration subsumes it and files that recorded the old id re-migrate through the replacement (persisted `:migrations` keep the old id via union — do not rewrite them, including playwright fixture JSONs). Idempotent/pure-cleanup migrations only; never withdraw one whose transform must not run again unless the replacement is safe for those files. Precedents: "0021-fix-shape-svg-attrs" -> "0035-fix-shape-svg-attrs-and-defs"; "legacy-36" -> "0036-clear-nil-keys-in-objects".
|
|
||||||
- A shipped migration whose behavior must change AND reach every file (most files already recorded its id, so `migrate` skips it): rename it to `<id>-v2` and swap the old id for the new one in `available-migrations` at the SAME position. Precedents: `0002-normalize-bool-content-v2`, `0003-convert-path-content-v2`, `0008-fix-library-colors-v4`, and `0035-fix-shape-svg-attrs-and-defs` withdrawing `0021-fix-shape-svg-attrs`. Files keep the old id in `:migrations`, which is harmless because `migrate` diffs against the available set. Cost: one full pass over every file on its next read (the `get-file` ETag hashes `available-migrations`, so clients refetch).
|
|
||||||
- The alternative is patch the old id plus add a new migration id for the files that already applied it. Then the position in the list decides which repair runs first: a coerce-then-drop repair must come before a drop-only one, or the strings are gone before they can be parsed.
|
|
||||||
- `0033-normalize-main-instance-names-v2` repairs the container before its naming walk: child ids stored as strings are parsed with `uuid/coerce`, ids missing from `:objects` are dropped, duplicates are removed (the one `0032` adds when a child is stored as a string). The walk only re-assocs a shape when the normalization changed it (`identical?` on the normalized shape), so a healthy container keeps its `ObjectsMap` instance: no `modified` flag, no page rewrite. `0035-fix-dangling-children` prunes whatever is left.
|
|
||||||
|
|||||||
@ -15,7 +15,6 @@ From `common/`:
|
|||||||
- Full JS test run (always builds, build output visible): `pnpm run test`
|
- Full JS test run (always builds, build output visible): `pnpm run test`
|
||||||
- Focus a JVM test namespace: `clojure -M:dev:test --focus common-tests.logic.variants-switch-test`
|
- Focus a JVM test namespace: `clojure -M:dev:test --focus common-tests.logic.variants-switch-test`
|
||||||
- Focus a JVM test var: `clojure -M:dev:test --focus common-tests.logic.variants-switch-test/test-basic-switch`
|
- Focus a JVM test var: `clojure -M:dev:test --focus common-tests.logic.variants-switch-test/test-basic-switch`
|
||||||
- JVM line coverage: `clojure -M:dev:test:coverage` (kaocha-cloverage, about 2x slower; `:cloverage/opts` in `tests.edn`, which excludes `app.common.test-helpers.*`; output in `target/coverage/` (lcov, HTML, and EMMA `coverage.xml` whose form counts the PR report shows as statements; cloverage measures no functions or branches)). `scripts/test` (CI) uses it; the JS side has no coverage.
|
|
||||||
- Focus a JS test namespace: `pnpm run test:quiet -- --focus common-tests.logic.comp-sync-test`
|
- Focus a JS test namespace: `pnpm run test:quiet -- --focus common-tests.logic.comp-sync-test`
|
||||||
- Focus a JS test var: `pnpm run test:quiet -- --focus common-tests.logic.comp-sync-test/test-sync-when-changing-attribute`
|
- Focus a JS test var: `pnpm run test:quiet -- --focus common-tests.logic.comp-sync-test/test-sync-when-changing-attribute`
|
||||||
- Quiet logging during a JS run: append `--log-level warn` (or `trace|debug|info|warn|error`)
|
- Quiet logging during a JS run: append `--log-level warn` (or `trace|debug|info|warn|error`)
|
||||||
@ -39,10 +38,6 @@ Useful builders:
|
|||||||
|
|
||||||
`add-variant-with-copy` does not accept position params for children; use `gsh/absolute-move` after creation if positions matter.
|
`add-variant-with-copy` does not accept position params for children; use `gsh/absolute-move` after creation if positions matter.
|
||||||
|
|
||||||
## Generative sampling caution
|
|
||||||
|
|
||||||
- `sg/sample` is unseeded per run. If a test filters samples by type (e.g. keep only `:svg-raw`) then `first` can yield nil on unlucky seeds; `assoc` onto nil builds a typeless map that fails `:multi` dispatch on `:type`. Pin `:seed` in `sg/sample` opts whenever a test depends on a filtered subtype being present (verified seed 42 deals svg-raw shapes on JVM and JS).
|
|
||||||
|
|
||||||
## Driving production paths
|
## Driving production paths
|
||||||
|
|
||||||
For shape mutations, prefer production-path helpers such as `cls/generate-update-shapes` plus `thf/apply-changes`. For component swaps with keep-touched behavior, use `tho/swap-component-in-shape` with `{:keep-touched? true}`.
|
For shape mutations, prefer production-path helpers such as `cls/generate-update-shapes` plus `thf/apply-changes`. For component swaps with keep-touched behavior, use `tho/swap-component-in-shape` with `{:keep-touched? true}`.
|
||||||
|
|||||||
@ -6,29 +6,24 @@ You are working on the GitHub project `penpot/penpot`, a monorepo.
|
|||||||
- A section's top-level memory is `<section>/core`. When a section is relevant, read the core memory before focused memories.
|
- A section's top-level memory is `<section>/core`. When a section is relevant, read the core memory before focused memories.
|
||||||
- Edits/stale refs/duplication cleanup: `mem:memory-maintenance`.
|
- Edits/stale refs/duplication cleanup: `mem:memory-maintenance`.
|
||||||
- Cross-cutting testing principles, TDD workflow, and anti-patterns: `mem:testing`.
|
- Cross-cutting testing principles, TDD workflow, and anti-patterns: `mem:testing`.
|
||||||
- Structured logging conventions (`:hint` casing and fields, log levels): `mem:clojure/logging` — read before adding or changing any log call.
|
|
||||||
- Verified Clojure language behaviors that contradict common assumptions (e.g. `int?` covers `Long`; `integer?` is the general predicate): `mem:clojure/idioms` — read before assuming stdlib predicate semantics.
|
- Verified Clojure language behaviors that contradict common assumptions (e.g. `int?` covers `Long`; `integer?` is the general predicate): `mem:clojure/idioms` — read before assuming stdlib predicate semantics.
|
||||||
- Read `mem:clojure/core` (function shape, boundary checks, naming) before writing or modifying Clojure/ClojureScript code — not only when designing a solution or an API.
|
- Read `mem:clojure/design-rules` (function shape, boundary checks, naming) before writing or modifying Clojure/ClojureScript code — not only when designing a solution or an API.
|
||||||
- Promises: which call style to use where (`fmap`/`mcat`/`merr` vs `then`/`catch`) and how they bridge to rx: `mem:clojure/promesa` — read before chaining promises or mixing them with observables.
|
|
||||||
|
|
||||||
# Development workflow
|
# Development workflow
|
||||||
|
|
||||||
- Commit/PR/issue creation is **on explicit request only**. Before any of these actions, read the relevant memory — don't infer format from prior examples:
|
- Commit/PR/issue creation is **on explicit request only**. Before any of these actions, read the relevant memory — don't infer format from prior examples:
|
||||||
- Before `git commit` → `mem:workflow/creating-commits` (subject/body format, 80-char body wrapping enforced by `scripts/check-commit`, `AI-assisted-by: model-name` trailer)
|
- Before `git commit` → `mem:workflow/creating-commits` (subject/body format, 76-char body wrapping enforced by `scripts/check-commit`, `AI-assisted-by: model-name` trailer)
|
||||||
- Before `gh issue create` → `mem:workflow/creating-issues` (title derivation, body template, labels, Issue Type)
|
- Before `gh issue create` → `mem:workflow/creating-issues` (title derivation, body template, labels, Issue Type)
|
||||||
- Before `gh pr create` / `gh pr edit` → `mem:workflow/creating-prs` (title format, body structure, "Note:" line)
|
- Before `gh pr create` / `gh pr edit` → `mem:workflow/creating-prs` (title format, body structure, "Note:" line)
|
||||||
- Before updating `CHANGES.md` → `mem:workflow/updating-changelog` (sources of truth, entry rules, the `:boom:`/`:rocket:` label contracts, pre-flight checks, anomaly report)
|
|
||||||
- Before a repo-wide pnpm version update → `mem:workflow/updating-pnpm` (workspace layout, `scripts/sync-pnpm-version` flow, the stamp-missing-field and ignored-builds gotchas, verification steps)
|
- Before a repo-wide pnpm version update → `mem:workflow/updating-pnpm` (workspace layout, `scripts/sync-pnpm-version` flow, the stamp-missing-field and ignored-builds gotchas, verification steps)
|
||||||
- Before a Node version update → `mem:workflow/updating-node` (the six pin sites in `.nvmrc`, the devenv and image Dockerfiles and the plugins-deploy workflows, the DHI tag and digest rules, what to verify)
|
|
||||||
- Before bumping a non-JS dependency pinned in `docker/images/` (JDK, ImageMagick) → `mem:workflow/docker-images`
|
|
||||||
- **Never `git push`, force-push, or modify `git origin`** (or any other remote). The user pushes from their own shell; if a push is required, say so and wait. Never amend a commit that the user has already pushed unless explicitly asked.
|
- **Never `git push`, force-push, or modify `git origin`** (or any other remote). The user pushes from their own shell; if a push is required, say so and wait. Never amend a commit that the user has already pushed unless explicitly asked.
|
||||||
- **Never edit `CHANGES.md` by hand.** The changelog is generated from GitHub milestones during the release process; update it only via `mem:workflow/updating-changelog` (the `update-changelog` skill flow) or on explicit user request.
|
- **Never edit `CHANGES.md` by hand.** The changelog is generated from GitHub milestones during the release process; update it only via the `update-changelog` skill flow or on explicit user request.
|
||||||
- You have access to the GitHub CLI `gh` or corresponding MCP tools.
|
- You have access to the GitHub CLI `gh` or corresponding MCP tools.
|
||||||
|
- Issues are also managed on Taiga. Read issues using the `read_taiga_issue` tool.
|
||||||
- Before writing code, analyze the task in depth and describe your plan. If the task is complex, break it down into atomic steps. After making changes, run the applicable lint and format checks for the affected module before considering the work done (per example `mem:backend/core` or `mem:frontend/core`).
|
- Before writing code, analyze the task in depth and describe your plan. If the task is complex, break it down into atomic steps. After making changes, run the applicable lint and format checks for the affected module before considering the work done (per example `mem:backend/core` or `mem:frontend/core`).
|
||||||
- Align `let` binding values: when a `let` form has multiple bindings spanning several lines, align the value forms to the same column with spaces.
|
- Align `let` binding values: when a `let` form has multiple bindings spanning several lines, align the value forms to the same column with spaces.
|
||||||
- If you introduce delimiter errors (mismatched parens/brackets) in Clojure/CLJS files, fix them with `scripts/paren-repair` BEFORE running lint/format checks. See `mem:scripts/paren-repair` for usage.
|
- If you introduce delimiter errors (mismatched parens/brackets) in Clojure/CLJS files, fix them with `scripts/paren-repair` BEFORE running lint/format checks. See `mem:scripts/paren-repair` for usage.
|
||||||
- Never run anything that destroys data without explicit permission, including `drop-devenv`, `docker compose down -v`, `docker volume rm ...`. The user's real work lives in the volumes of the shared infra.
|
- Never run anything that destroys data without explicit permission, including `drop-devenv`, `docker compose down -v`, `docker volume rm ...`. The user's real work lives in the volumes of the shared infra.
|
||||||
- **Never wait for background work with a sleep.** A long command moved to the background reports its own completion: do not poll it with `sleep 150` (or any other wait) inside a foreground command, and do not re-read its output file to check whether it finished. Keep working on something else, or end the response and wait for the notification.
|
|
||||||
|
|
||||||
# Project modules
|
# Project modules
|
||||||
|
|
||||||
@ -60,14 +55,11 @@ The memory is structured in a way that you can get the critical information abou
|
|||||||
- `scripts/psql` — PostgreSQL client wrapper with devenv defaults. Companion: `scripts/db-schema` for DDL dumps. See `mem:scripts/psql`.
|
- `scripts/psql` — PostgreSQL client wrapper with devenv defaults. Companion: `scripts/db-schema` for DDL dumps. See `mem:scripts/psql`.
|
||||||
- `scripts/taiga.py` — Fetch public issues, user stories, and tasks from the Penpot Taiga project without authentication. See `mem:scripts/taiga`.
|
- `scripts/taiga.py` — Fetch public issues, user stories, and tasks from the Penpot Taiga project without authentication. See `mem:scripts/taiga`.
|
||||||
- `scripts/gh.py` — GitHub operations helper: list milestone issues, fetch PR details, compare against CHANGES.md. Requires `gh` CLI. See `mem:scripts/gh`.
|
- `scripts/gh.py` — GitHub operations helper: list milestone issues, fetch PR details, compare against CHANGES.md. Requires `gh` CLI. See `mem:scripts/gh`.
|
||||||
- `scripts/coverage-summary.mjs` — Renders an lcov file as a markdown table grouped by source area, for `$GITHUB_STEP_SUMMARY` (`--title`, `--lcov`, optional `--note`, `--unloaded`). Used by the backend, common and frontend test workflows; module coverage commands are in `mem:backend/testing`, `mem:common/testing`, `mem:frontend/testing`.
|
|
||||||
- `scripts/coverage-comment.mjs` — Keeps one PR comment (`<!-- coverage-report -->`) with the coverage table of Backend, Common, Frontend and Render WASM, in the format of the Vitest Coverage Report Action (status, metric, %, covered/total, changed-file coverage, run/commit footer). Each test job updates its own project: the data of all three lives base64-encoded in a hidden `coverage-data` block, and the job re-reads after `SETTLE_MS` and rewrites if a concurrent job dropped its data; extra report comments from simultaneous creates are merged and deleted. Targets (`THRESHOLDS`, per project and metric, status colour only, never fail CI) are on lines only: 70 Backend, 70 Common, 50 Frontend, 40 Render WASM; other metrics get the blue dot. Statements are Clojure forms for Backend/Common (`--emma-xml`) and llvm regions for Render WASM (`--llvm-json`). Shared lcov parsing: `scripts/coverage-lcov.mjs`. The test workflows run it only for PRs from branches of this repo (job-level `pull-requests: write`, `continue-on-error`): fork PRs get a read-only token, so they only get the run-page summary. A fork-safe `workflow_run` commenter would run only from the default branch's copy of the workflow.
|
|
||||||
- `scripts/project-anomalies.py` — Main-board anomaly check for a milestone (`check` writes `tmp/<MILESTONE>-ANOMALIES.md`). Bulk resolution via `scripts/gh.py`. See `mem:scripts/project-anomalies`.
|
- `scripts/project-anomalies.py` — Main-board anomaly check for a milestone (`check` writes `tmp/<MILESTONE>-ANOMALIES.md`). Bulk resolution via `scripts/gh.py`. See `mem:scripts/project-anomalies`.
|
||||||
- `scripts/changelog.py` — Changelog checks for `mem:workflow/updating-changelog`: `boom` (generate the `:boom:` section from `breaking change` issues), `check-merged` (PR merge status), `cross-ref` (milestone PRs vs changelog section), `report` (anomaly report to CHANGES-ISSUES.md). Calls `scripts/gh.py` via subprocess. See `mem:scripts/changelog`.
|
- `scripts/changelog.py` — Changelog checks for the `update-changelog` skill: `check-merged` (PR merge status), `cross-ref` (milestone PRs vs changelog section), `report` (anomaly report to CHANGES-ISSUES.md). Calls `scripts/gh.py` via subprocess. See `mem:scripts/changelog`.
|
||||||
- `scripts/error-reports.mjs` — Query error reports via RPC API with token authentication. Supports list/get operations with filtering and pagination. See `mem:scripts/error-reports`.
|
- `scripts/error-reports.mjs` — Query error reports via RPC API with token authentication. Supports list/get operations with filtering and pagination. See `mem:scripts/error-reports`.
|
||||||
- `scripts/clean-node-modules` — Remove stale `node_modules` from all pnpm workspaces (root, modules, member packages). Keeps the shared pnpm store at `<repo>/.pnpm-store` unless `--store`; ignores `external/` and `.opencode/`. Usage and reinstall steps: `mem:workflow/updating-pnpm`.
|
- `scripts/clean-node-modules` — Remove stale `node_modules` from all pnpm workspaces (root, modules, member packages). Keeps the shared pnpm store at `<repo>/.pnpm-store` unless `--store`; ignores `external/` and `.opencode/`. Usage and reinstall steps: `mem:workflow/updating-pnpm`.
|
||||||
- `scripts/setup-opencode` — Install the opencode CLI in-container as a global pnpm package in `$PNPM_HOME`. Not part of the devenv image; see `mem:devenv/core`.
|
- `scripts/ci` — CI orchestration script: runs lint, tests, and format checks per module (`frontend backend common render-wasm exporter mcp plugins library`). Logs go to `.ci-logs/`; read the log file on failure. See `mem:scripts/ci`.
|
||||||
- `scripts/ci` — CI orchestration script: runs lint, tests, and format checks per module, plus the production build on request (`--build`). Modules: `frontend backend common render-wasm exporter mcp plugins library media-processor`. Logs go to `.ci-logs/`; read the log file on failure. It is the preferred way to run the backend tests, and it exports `PENPOT_FLAGS` with `enable-backend-asserts`, which is what makes `clojure.core/assert` exist in the compiled test code. See `mem:scripts/ci`.
|
|
||||||
|
|
||||||
# Dependency graph
|
# Dependency graph
|
||||||
|
|
||||||
|
|||||||
@ -1,21 +1,19 @@
|
|||||||
# Devenv startup and configuration
|
# Devenv startup and configuration
|
||||||
|
|
||||||
Compose-based dev environment under `docker/devenv/`, driven by `manage.sh`. Parallel instances share infra + Postgres + RustFS; each instance has its own `main` container, Valkey, source checkout, tmux session. The main database (`penpot`) and the S3 bucket (`penpot`) are shared by all instances on purpose; backend-test databases are isolated per instance (`penpot_test` on ws0, `penpot_test_wsN` on wsN) with per-instance Valkey DB numbers (`6+N`, since runtime backends occupy `0..5`).
|
Compose-based dev environment under `docker/devenv/`, driven by `manage.sh`. Parallel instances share infra + Postgres + RustFS; each instance has its own `main` container, Valkey, source checkout, tmux session.
|
||||||
|
|
||||||
## Compose project layout
|
## Compose project layout
|
||||||
|
|
||||||
- `penpotdev-infra`: shared `postgres`, `rustfs`, `valkey`, `mailer`, `ldap`. File: `docker-compose.infra.yml`.
|
- `penpotdev-infra`: shared `postgres`, `rustfs`, `valkey`, `mailer`, `ldap`. File: `docker-compose.infra.yml`.
|
||||||
- `penpotdev-wsN` (N=0,1,…): per-instance `main` + `redis` (Valkey). File: `docker-compose.main.yml`. ws0 (a.k.a. `main`) binds `$PWD`; ws1+ bind clones at `${PENPOT_WORKSPACES_DIR}/wsN/` (default `${XDG_DATA_HOME:-~/.local/share}/penpot-devenv/workspaces/`, or the former `~/.penpot/penpot_workspaces/` when it already exists), maintained by the developer.
|
- `penpotdev-wsN` (N=0,1,…): per-instance `main` + `redis` (Valkey). File: `docker-compose.main.yml`. ws0 (a.k.a. `main`) binds `$PWD`; ws1+ bind clones at `${PENPOT_WORKSPACES_DIR}/wsN/` (default `~/.penpot/penpot_workspaces/`), maintained by the developer.
|
||||||
- Optional overlay `docker-compose.opencode.yml`: added by `instance-compose` as an extra `-f` only when `PENPOT_OPENCODE_CONFIG_DIR` is set (i.e. `run-devenv --opencode-config-dir DIR` ran in this process). Bind-mounts the host dir at `/home/penpot/.config/opencode` (`:z`). Flag-only, per-call; not read from ambient env. Parser `parse-opencode-config-dir` absolutizes (`~`, realpath) because compose resolves relative bind sources against the compose file's dir. Only instances brought up with the flag get the mount.
|
- Optional overlay `docker-compose.opencode.yml`: added by `instance-compose` as an extra `-f` only when `PENPOT_OPENCODE_CONFIG_DIR` is set (i.e. `run-devenv --opencode-config-dir DIR` ran in this process). Bind-mounts the host dir at `/home/penpot/.config/opencode` (`:z`). Flag-only, per-call; not read from ambient env. Parser `parse-opencode-config-dir` absolutizes (`~`, realpath) because compose resolves relative bind sources against the compose file's dir. Only instances brought up with the flag get the mount.
|
||||||
- All projects join external network `penpot_shared`. Created idempotently by `ensure-devenv-network`, never removed by lifecycle commands.
|
- All projects join external network `penpot_shared`. Created idempotently by `ensure-devenv-network`, never removed by lifecycle commands.
|
||||||
|
|
||||||
## Source-of-truth files
|
## Source-of-truth files
|
||||||
|
|
||||||
- `docker/devenv/defaults.env`: ws0 baseline — container/volume names, runtime env, published host ports, tmux defaults. `manage.sh` aborts if unreadable.
|
- `docker/devenv/defaults.env`: ws0 baseline — container/volume names, runtime env, published host ports, tmux defaults. `manage.sh` aborts if unreadable.
|
||||||
- For ws1+, `instance-env-overrides` computes the per-instance overrides (container/volume names, host ports offset `10000·N`, `PENPOT_PUBLIC_URI`, `PENPOT_REDIS_URI`, `PENPOT_TEST_DATABASE_URI`, `PENPOT_TEST_REDIS_URI`) and `instance-compose` injects them as env vars at compose time — never written to disk, recomputed each call so they can't drift. ws0 uses `defaults.env` as-is.
|
- For ws1+, `instance-env-overrides` computes the per-instance overrides (container/volume names, host ports offset `10000·N`, `PENPOT_PUBLIC_URI`, `PENPOT_REDIS_URI`, `PENPOT_BACKEND_WORKER=false`) and `instance-compose` injects them as env vars at compose time — never written to disk, recomputed each call so they can't drift. ws0 uses `defaults.env` as-is.
|
||||||
- Per-instance test databases are created by `ensure-instance-test-database` (called from `start-instance`): `CREATE DATABASE` guarded by a `pg_database` existence check, so it is idempotent. Needed because `postgresql_init.sql` only runs on first volume creation. The backend applies migrations itself on first use, so an empty database is enough.
|
|
||||||
- `backend/scripts/_env`: backend-internal only — secret keys, `PENPOT_FLAGS` (with `enable-backend-worker` gated on `PENPOT_BACKEND_WORKER`), `JAVA_OPTS`, `setup_s3_bucket()`. Never duplicates `defaults.env`.
|
- `backend/scripts/_env`: backend-internal only — secret keys, `PENPOT_FLAGS` (with `enable-backend-worker` gated on `PENPOT_BACKEND_WORKER`), `JAVA_OPTS`, `setup_s3_bucket()`. Never duplicates `defaults.env`.
|
||||||
- Frontend admin-console is off by default in devenv: `docker-compose.main.yml` sets `PENPOT_DEVENV=true`, which makes `app.config` (`goog-define devenv-mode`) prepend `disable-admin-console` ahead of the user `config.js` flags; flags parse in order and user flags win, so `enable-admin-console` in `frontend/resources/public/js/config.js` re-enables it. Outside devenv (prod builds) the default is unset and the admin-console stays on, matching `flags/default`.
|
|
||||||
- Compose files use pure `${VAR}` substitution; missing var = compose fails.
|
- Compose files use pure `${VAR}` substitution; missing var = compose fails.
|
||||||
|
|
||||||
## Invariants
|
## Invariants
|
||||||
@ -25,12 +23,10 @@ Compose-based dev environment under `docker/devenv/`, driven by `manage.sh`. Par
|
|||||||
- Network aliases (`- main`, `- redis`) are not declared in main.yml. Compose's auto-service-alias still registers `redis` on the shared network, so DNS for `redis` is non-deterministic with multiple instances. Backend uses `PENPOT_REDIS_URI=redis://penpot-devenv-wsN-valkey/0` (container_name) instead.
|
- Network aliases (`- main`, `- redis`) are not declared in main.yml. Compose's auto-service-alias still registers `redis` on the shared network, so DNS for `redis` is non-deterministic with multiple instances. Backend uses `PENPOT_REDIS_URI=redis://penpot-devenv-wsN-valkey/0` (container_name) instead.
|
||||||
- No cross-project `depends_on`. `manage.sh ensure-infra-up` uses Compose `--wait`; PostgreSQL, RustFS, and Mailpit expose healthchecks. PostgreSQL checks TCP so its temporary init server cannot report ready.
|
- No cross-project `depends_on`. `manage.sh ensure-infra-up` uses Compose `--wait`; PostgreSQL, RustFS, and Mailpit expose healthchecks. PostgreSQL checks TCP so its temporary init server cannot report ready.
|
||||||
- `JAVA_OPTS` in `manage.sh` is shadowed inside the container by `_env`. The `-e JAVA_OPTS=...` flag only matters for processes that don't source `_env`.
|
- `JAVA_OPTS` in `manage.sh` is shadowed inside the container by `_env`. The `-e JAVA_OPTS=...` flag only matters for processes that don't source `_env`.
|
||||||
- opencode is not part of the devenv image. `scripts/setup-opencode` installs the `@opencode/cli` global pnpm package into the penpot user's `$PNPM_HOME` (`/home/penpot/.local/share/pnpm`, inside the user-data volume, so it survives a container re-creation); nothing pins the version in the repo, it tracks the `latest` dist-tag at install time. pnpm 12 puts the global packages in `$PNPM_HOME/global` and the bin dir in `$PNPM_HOME/bin`, and aborts with `ERR_PNPM_GLOBAL_BIN_DIR_NOT_IN_PATH` unless that bin dir is on `PATH`; `files/bashrc` and the script both add it. The script exports `PNPM_HOME` itself because non-interactive shells never read `~/.bashrc`.
|
|
||||||
- `files/entrypoint.sh` chowns penpot's whole `~/.local` and `~/.cache` on every start, because `EXTERNAL_UID` remaps penpot's UID to the host user and build-time ownership then stops matching. That covers pnpm's global dir, store, `package-manager-store` and metadata cache, plus opencode's own state; without it, global installs and pnpm's `packageManager` auto-download fail on permissions. The dotfiles copied from `/root` (`.bashrc`, `.vimrc`, `.tmux.conf`) are chowned in the same pass. `~/.config` stays out on purpose (the opencode overlay bind-mounts a host directory inside it) and so does `/home/penpot` itself, which holds the repo bind mount.
|
|
||||||
|
|
||||||
## Worker policy
|
## Worker policy
|
||||||
|
|
||||||
Backend workers run only on ws0. `_env` gates `enable-backend-worker` on `PENPOT_BACKEND_WORKER`; ws1+ inject it as false. Workers are pure fire-and-forget: `jobs/submit` inserts a row into the shared Postgres `job` table and returns (the legacy `task` table stays dormant); RPC handlers never wait on completion and workers never publish to msgbus. The reason for "ws0 only" is avoiding multi-instance worker races (cron dedup is best-effort across instances, `jobs/submit` `dedupe` is racy across submitters); details in `mem:prod-infra/core`.
|
Backend workers run only on ws0. `_env` gates `enable-backend-worker` on `PENPOT_BACKEND_WORKER`; ws1+ inject it as false. Workers are pure fire-and-forget: `wrk/submit!` inserts a row into the shared Postgres `task` table and returns; RPC handlers never wait on completion and workers never publish to msgbus. The reason for "ws0 only" is avoiding multi-instance worker races (cron dedup is best-effort across instances, `wrk/submit!` `dedupe` is racy across submitters); details in `mem:prod-infra/core`.
|
||||||
|
|
||||||
Each workspace is independent and can be started/stopped in any order. Shared infra (Postgres, RustFS, etc.) is shut down only when no instances remain running.
|
Each workspace is independent and can be started/stopped in any order. Shared infra (Postgres, RustFS, etc.) is shut down only when no instances remain running.
|
||||||
|
|
||||||
@ -78,42 +74,3 @@ No `--delete` on the working-tree pass: gitignored caches in the workspace survi
|
|||||||
- `start-devenv` / `log-devenv` / `drop-devenv`: legacy paths around ws0 + shared infra. `drop-devenv` never removes volumes.
|
- `start-devenv` / `log-devenv` / `drop-devenv`: legacy paths around ws0 + shared infra. `drop-devenv` never removes volumes.
|
||||||
|
|
||||||
`exporter/scripts/run` and `wait-and-start.sh` source `backend/scripts/_env` then `_env.local` if present.
|
`exporter/scripts/run` and `wait-and-start.sh` source `backend/scripts/_env` then `_env.local` if present.
|
||||||
|
|
||||||
## Image and dependency pins
|
|
||||||
|
|
||||||
Two Dockerfile trees, both multi-arch (`linux/amd64,linux/arm64`):
|
|
||||||
`docker/devenv` (dev) and `docker/images` + `docker/imagemagick` (prod).
|
|
||||||
|
|
||||||
- Hand-pinned versions, one source each:
|
|
||||||
- `docker/devenv/Dockerfile`: `NODE_VERSION` (+ per-arch `NODE_SHA256`),
|
|
||||||
`PNPM_VERSION` (+ `PNPM_SHA256`), `CADDY_VERSION`, `CLOJURE_VERSION`,
|
|
||||||
Zulu JDK URL + `ESUM`, `RUSTUP_VERSION`/`RUST_VERSION`/
|
|
||||||
`EMSCRIPTEN_VERSION`, `CLJKONDO_VERSION`, `BABASHKA_VERSION`,
|
|
||||||
`CLJFMT_VERSION`, `PIXI_VERSION`, `GITHUB_CLI_VERSION`,
|
|
||||||
`AWS_CLI_VERSION` (+ `BINARY_SHA256`), `UV_VERSION`, `SERENA_VERSION`,
|
|
||||||
`postgresql-client-18`, and the `penpotapp/imagemagick:<tag>`
|
|
||||||
`COPY --from`.
|
|
||||||
- `docker/images/Dockerfile.backend`: Zulu JDK URL + `ESUM`. The `jlink`
|
|
||||||
`--add-modules` list must keep `jdk.management`
|
|
||||||
(`mem:backend/subtleties`).
|
|
||||||
- `docker/images/Dockerfile.{exporter,mcp,media-processor}`: `ARG
|
|
||||||
PNPM_VERSION` (+ arch SHAs, same values as devenv).
|
|
||||||
- Node and pnpm must agree in five places: `.nvmrc`, the devenv tarball pin,
|
|
||||||
the two `plugins-deploy-*` workflows that set `runtime: node@<version>`, and
|
|
||||||
the four Dockerfile pins. pnpm procedure: `mem:workflow/updating-pnpm`.
|
|
||||||
- `dhi.io` base images are pinned `tag@sha256:<index digest>`; Renovate moves
|
|
||||||
them (`penpot-renovate[bot]`, commits titled `:arrow_up: Update DHI base
|
|
||||||
images`). Tag and digest move together: a new tag with the old digest still
|
|
||||||
pulls the old image, and the digest must be the multi-arch index, not a
|
|
||||||
per-platform one.
|
|
||||||
- Every hand-pinned checksum is per architecture; one wrong value breaks half
|
|
||||||
of the multi-arch build.
|
|
||||||
- `SERENA_UPDATE_VERSION` in `docker-compose.main.yml` must never be lower than the Dockerfile's `SERENA_VERSION`. Any value makes `start-tmux.sh` install that Serena release on start, overriding the version baked into the image; a stale value silently downgrades Serena (it once replaced 1.7.0 with 1.6.1). If the image already has that version the install is an offline no-op; otherwise it downloads on every start (`run-devenv` recreates the container) and, offline, fails after ~25s and keeps the image version. Bump both together; empty means use the image version.
|
|
||||||
- Infra images live in `docker-compose.infra.yml`: `rustfs/rustfs` (owns the
|
|
||||||
S3 data volume), `axllent/mailpit` (SQLite in a volume), `valkey/valkey`,
|
|
||||||
`postgres:18.6`, `rroemhild/test-openldap`. Keep the volume names stable
|
|
||||||
when bumping them; replacement services get new volumes and leave the old
|
|
||||||
data untouched.
|
|
||||||
- Build locally: `docker build -f docker/devenv/Dockerfile docker/devenv/`
|
|
||||||
and `cd docker/images && ./build.sh <image> --local`. CI:
|
|
||||||
`build-docker-devenv.yml`, `build-docker.yml`.
|
|
||||||
|
|||||||
@ -1,106 +0,0 @@
|
|||||||
# Auth Events and the Session Origin
|
|
||||||
|
|
||||||
`signin` is the frontend `identify` event emitted once per session from
|
|
||||||
`logged-in` (`app.main.data.auth`). It carries the profile plus a closed
|
|
||||||
vocabulary that says why the session started.
|
|
||||||
|
|
||||||
## Vocabulary
|
|
||||||
|
|
||||||
- `source`: `login` | `register`. Always present.
|
|
||||||
- `auth-backend`: `penpot` | `ldap` | `google` | `github` | `gitlab` | `oidc`.
|
|
||||||
Same key the profile already uses. Always present.
|
|
||||||
- `activation`: `immediate` | `email-verification`. Only on signups.
|
|
||||||
- `from-invitation`: boolean. Always present in `signin`
|
|
||||||
(`(some? (:invitation-token profile))`); `auth-origin` omits it when `nil`.
|
|
||||||
|
|
||||||
`auth-origin` (public, validated against `schema:auth-origin`) drops the nil
|
|
||||||
fields and checks with `(assert (sm/check ...))`: it throws in development and
|
|
||||||
tests, and `:elide-asserts true` removes it from the release build, so a bad
|
|
||||||
value can never break a real login. Emitters never call it directly.
|
|
||||||
|
|
||||||
## Where each value comes from
|
|
||||||
|
|
||||||
- `source` and `activation` travel as profile metadata (`::ev/source`,
|
|
||||||
`::ev/activation`), written by `origin-meta`. `login-from-token` derives both
|
|
||||||
from the token issuer with `iss->origin`: `:auth` → `login`; `:verify-email` →
|
|
||||||
`register` + `email-verification`. An unknown `:iss` produces no metadata, so
|
|
||||||
the assertion fires in development and the event goes without `:source` in
|
|
||||||
production.
|
|
||||||
- `auth-backend` and `from-invitation` are read from the profile.
|
|
||||||
- `profile-origin` composes the four and `logged-in` merges them into the event;
|
|
||||||
the emitters only declare the fact.
|
|
||||||
|
|
||||||
| Flow | `source` | `activation` | `from-invitation` |
|
|
||||||
|---|---|---|---|
|
|
||||||
| Password login | login | | false |
|
|
||||||
| Password login from an invitation link | login | | true |
|
|
||||||
| LDAP login | login | | false |
|
|
||||||
| Social login, existing active profile | login | | false |
|
|
||||||
| Signup, email verification disabled | register | immediate | false |
|
|
||||||
| Signup, email verification enabled | register | email-verification | false |
|
|
||||||
| Social signup, active profile | register | immediate | false |
|
|
||||||
| Social signup, inactive profile | register | email-verification | false |
|
|
||||||
| Signup from an invitation link, email verification disabled | register | immediate | true |
|
|
||||||
| Signup from an invitation link, email verification enabled | register | email-verification | true |
|
|
||||||
| Social login from an invitation link | login | | true |
|
|
||||||
| Social signup from an invitation link, email verification enabled | register | email-verification | true |
|
|
||||||
| LDAP login from an invitation link | login | | true |
|
|
||||||
|
|
||||||
LDAP is the explicit exception: the directory provisions the account on the
|
|
||||||
first login, but there is no user signup, so the flow is always `login` and
|
|
||||||
never carries `activation`. Do not "fix" it by inferring a signup.
|
|
||||||
|
|
||||||
## Invitations go through `logged-in`
|
|
||||||
|
|
||||||
- `login-from-register` accepts an optional `:invitation-token`;
|
|
||||||
`with-register-origin` decorates the profile and `logged-in` does the rest.
|
|
||||||
The four places that used to navigate by hand to `:auth-verify-token`
|
|
||||||
(`ui/auth/register.cljs` twice, `ui/static.cljs`, `ui/auth/login_modal.cljs`)
|
|
||||||
emit `login-from-register` with the token. The modal used to live in
|
|
||||||
`ui/viewer/login.cljs`; it was extracted to the shared
|
|
||||||
`ui/auth/login_modal.cljs` (`login-register-modal*`, also used by
|
|
||||||
`ui/mcp_authorize.cljs`).
|
|
||||||
- The invitation navigates through `get-invitation-nav`, which does not wait for
|
|
||||||
`::dtm/teams-fetched`: `fetch-teams` has no error handling, so depending on it
|
|
||||||
would leave the invitation unaccepted when `get-teams` fails. For invited
|
|
||||||
profiles `get-redirect-events` emits `rx/empty`, so the teams path cannot move
|
|
||||||
the user away from the token verification screen.
|
|
||||||
- The OIDC callback with an invitation mints an `:auth` token that carries the
|
|
||||||
invitation JWE in its claims (`backend/src/app/auth/oidc.clj`), so the
|
|
||||||
frontend follows the regular path (`login-from-token` → `logged-in`). That
|
|
||||||
flow visits the token verification screen twice.
|
|
||||||
- `ui/auth/login_modal.cljs` (the register modal: `:is-active` branch calls
|
|
||||||
`on-close`, or `on-register` when the caller passes one, as in the MCP
|
|
||||||
authorize flow) and `ui/static.cljs` (`rt/reload true`) `:is-active`
|
|
||||||
branches still bypass `logged-in`; they are a separate decision, not an
|
|
||||||
oversight.
|
|
||||||
|
|
||||||
## Backend side
|
|
||||||
|
|
||||||
- The `register-profile` success branches
|
|
||||||
(`backend/src/app/rpc/commands/auth.clj`) put `activation` in the event props
|
|
||||||
and emit **no** `action`: the name already says it is a signup, and a constant
|
|
||||||
action would only add noise. The retry branches
|
|
||||||
(`register-profile-retry`) keep `action` in `context`
|
|
||||||
(`ignore-because-blocked`, `ignore`, `resend-email-verification`,
|
|
||||||
`ignore-because-complaints`), where it distinguishes outcomes.
|
|
||||||
- The LDAP invitation branch of `login-with-ldap` returns the full profile plus
|
|
||||||
`:invitation-token`; a partial map would break the `auth-origin` assertion.
|
|
||||||
- `register-profile` does not accept the invitation: it mints the session and
|
|
||||||
returns the token. The acceptance is `accept-team-invitation`, emitted from
|
|
||||||
`verify-token`.
|
|
||||||
- `filter-telemetry-props` keeps `source` and `activation` in the anonymised
|
|
||||||
row; `:action` is not on the allowlist.
|
|
||||||
|
|
||||||
## Analytics
|
|
||||||
|
|
||||||
- `register-profile` is a track event, so the props adapter forwards
|
|
||||||
`activation` with no extra work.
|
|
||||||
- `signin` is an identify event built from a closed list of profile keys. It
|
|
||||||
only reaches analytics if the identify branch of Nexus forwards `source`,
|
|
||||||
`activation` and `from_invitation` (`external/nexus`, another repository).
|
|
||||||
|
|
||||||
## `::ev/source` is no longer dead metadata
|
|
||||||
|
|
||||||
It is read by `profile-origin`. Do not remove it as unused, and keep the
|
|
||||||
vocabulary in sync with `schema:auth-origin` and the table above.
|
|
||||||
@ -49,23 +49,16 @@ Get `team-id` from `(:current-team-id @app.main.store/state)`. Get file ids from
|
|||||||
|
|
||||||
## Runtime patching with `set!`
|
## Runtime patching with `set!`
|
||||||
|
|
||||||
Some frontend vars are deliberately mutable escape hatches for runtime instrumentation or circular-dependency patching. From `cljs_repl`, use `set!` for temporary debugging of CLJS vars such as `app.main.errors/reload-file`, `app.main.errors/is-plugin-error?`, `app.main.errors/last-report`, or `app.main.errors/last-exception`. These patches affect only the live browser runtime and disappear on reload or recompilation.
|
Some frontend vars are deliberately mutable escape hatches for runtime instrumentation or circular-dependency patching. From `cljs_repl`, use `set!` for temporary debugging of CLJS vars such as `app.main.store/on-event`, `app.main.errors/reload-file`, `app.main.errors/is-plugin-error?`, `app.main.errors/last-report`, or `app.main.errors/last-exception`. These patches affect only the live browser runtime and disappear on reload or recompilation.
|
||||||
|
|
||||||
`set!` on `app.main.store/on-event` does nothing at runtime: the store captured the function when it was created. To watch events, subscribe to the store stream and dispose the subscription after:
|
|
||||||
|
|
||||||
```clojure
|
```clojure
|
||||||
;; Log non-noisy Potok events temporarily.
|
;; Log non-noisy Potok events temporarily.
|
||||||
(def sub
|
(set! app.main.store/on-event
|
||||||
(beicon.v2.core/subs!
|
|
||||||
(fn [event]
|
(fn [event]
|
||||||
(when (potok.v2.core/event? event)
|
(when (potok.v2.core/event? event)
|
||||||
(.log js/console (potok.v2.core/repr-event event))))
|
(.log js/console (potok.v2.core/repr-event event)))))
|
||||||
app.main.store/stream))
|
|
||||||
;; (beicon.v2.core/dispose! sub)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`cljs_repl` starts every call in `cljs.user`; begin a call with `(in-ns 'my-ns)` to reuse helpers defined in another namespace.
|
|
||||||
|
|
||||||
Restore mutable hooks after debugging, or reload the frontend. Use JVM `alter-var-root` only for JVM Clojure; it is not the normal way to patch live CLJS browser vars.
|
Restore mutable hooks after debugging, or reload the frontend. Use JVM `alter-var-root` only for JVM Clojure; it is not the normal way to patch live CLJS browser vars.
|
||||||
|
|
||||||
## Browser-console debug namespace
|
## Browser-console debug namespace
|
||||||
|
|||||||
@ -150,5 +150,5 @@ The frontend bundle is built once per SHA and restored by this job (`mem:fronten
|
|||||||
Details: README, "Running in CI".
|
Details: README, "Running in CI".
|
||||||
|
|
||||||
## Substrate
|
## Substrate
|
||||||
`mem:common/testing`, `mem:common/component-data-model`, `mem:common/component-swap-pipeline`,
|
`mem:common/test-setup`, `mem:common/component-data-model`, `mem:common/component-swap-pipeline`,
|
||||||
`mem:frontend/testing`.
|
`mem:frontend/testing`.
|
||||||
|
|||||||
@ -12,7 +12,7 @@ Frontend: CLJS SPA; React/Rumext; Potok; RxJS; okulary refs; SCSS modules; share
|
|||||||
- `app.render_wasm.*`: frontend bridge to Rust/WASM renderer.
|
- `app.render_wasm.*`: frontend bridge to Rust/WASM renderer.
|
||||||
- `app.util.*`: DOM, HTTP, i18n, keyboard, codegen, and general frontend utilities.
|
- `app.util.*`: DOM, HTTP, i18n, keyboard, codegen, and general frontend utilities.
|
||||||
- `frontend/packages/*` and `frontend/text-editor`: JS/TS workspace packages consumed by the app.
|
- `frontend/packages/*` and `frontend/text-editor`: JS/TS workspace packages consumed by the app.
|
||||||
- Nitrate subscription/organization UI and flows live under `app.main.data.nitrate` and `app.main.ui.nitrate*`; backend/API behavior is covered by backend memories, and shared organization permission rules (`allowed?`, `can-send-invitations?`) are in `common/src/app/common/types/organization.cljc`.
|
- Nitrate subscription/organization UI and flows live under `app.main.data.nitrate` and `app.main.ui.nitrate*`; backend/API behavior is covered by backend memories, and shared permission rules are in `common/src/app/common/types/nitrate_permissions.cljc`.
|
||||||
- `app.config` external bridges (`external-feature-flag`, `external-session-id`, `external-context-info`, `external-notify-register-success`, `initialize-external-context-info`) delegate to `globalThis` hooks injected by the SaaS host. Never delete `external-feature-flag`, even with zero call sites: it is the seam for future A/B tests.
|
- `app.config` external bridges (`external-feature-flag`, `external-session-id`, `external-context-info`, `external-notify-register-success`, `initialize-external-context-info`) delegate to `globalThis` hooks injected by the SaaS host. Never delete `external-feature-flag`, even with zero call sites: it is the seam for future A/B tests.
|
||||||
|
|
||||||
|
|
||||||
@ -37,7 +37,6 @@ See `mem:scripts/paren-repair`.
|
|||||||
UI and packages:
|
UI and packages:
|
||||||
- App UI components, SCSS modules, style-system boundaries, accessibility, i18n, and render performance: `mem:frontend/ui-conventions-and-style-system`.
|
- App UI components, SCSS modules, style-system boundaries, accessibility, i18n, and render performance: `mem:frontend/ui-conventions-and-style-system`.
|
||||||
- JS/TS packages, shared UI package, text editor, Storybook, and package builds: `mem:frontend/ui-packages-text-editor-workflow`.
|
- JS/TS packages, shared UI package, text editor, Storybook, and package builds: `mem:frontend/ui-packages-text-editor-workflow`.
|
||||||
- PO translation workflow and per-locale conventions: `mem:frontend/translations`.
|
|
||||||
|
|
||||||
Workspace behavior:
|
Workspace behavior:
|
||||||
- Workspace state, commits, persistence, undo, repo calls, and refs: `mem:frontend/workspace-state-persistence-subtleties`.
|
- Workspace state, commits, persistence, undo, repo calls, and refs: `mem:frontend/workspace-state-persistence-subtleties`.
|
||||||
@ -46,7 +45,6 @@ Workspace behavior:
|
|||||||
|
|
||||||
App shell and product flows:
|
App shell and product flows:
|
||||||
- Routing, root app shell, websocket, and global errors: `mem:frontend/routing-app-shell-subtleties`.
|
- Routing, root app shell, websocket, and global errors: `mem:frontend/routing-app-shell-subtleties`.
|
||||||
- Authentication events, the session origin vocabulary, and the invitation flow: `mem:frontend/auth-events`.
|
|
||||||
- Dashboard and viewer flows: `mem:frontend/dashboard-viewer-subtleties`.
|
- Dashboard and viewer flows: `mem:frontend/dashboard-viewer-subtleties`.
|
||||||
- Plugin JS API runtime inside the frontend app: `mem:frontend/plugin-api-to-cljs-binding`.
|
- Plugin JS API runtime inside the frontend app: `mem:frontend/plugin-api-to-cljs-binding`.
|
||||||
|
|
||||||
|
|||||||
@ -5,17 +5,12 @@
|
|||||||
- Dashboard initialization fetches projects and fonts for the team, then listens to websocket messages only for global topic `uuid/zero` or the current profile id.
|
- Dashboard initialization fetches projects and fonts for the team, then listens to websocket messages only for global topic `uuid/zero` or the current profile id.
|
||||||
- Project fetch replaces each project map completely instead of merging, so fields such as `deleted-at` can disappear cleanly.
|
- Project fetch replaces each project map completely instead of merging, so fields such as `deleted-at` can disappear cleanly.
|
||||||
- Dashboard file/project mutations are often optimistic local updates with fire-and-forget RPC watchers. Bulk permanent delete/restore paths use SSE progress and progress notifications.
|
- Dashboard file/project mutations are often optimistic local updates with fire-and-forget RPC watchers. Bulk permanent delete/restore paths use SSE progress and progress notifications.
|
||||||
- The v3 format carries no size per file: the size of one is the sum of its own entries plus the `objects/` its media and thumbnail metadata reference, the only link between a file and that shared storage.
|
|
||||||
- Those metadata entries are read one at a time on purpose: a container holds thousands and every read opens its own decompression stream, which makes Chromium fail the analysis — zip.js then masks the cause behind a `Cannot close a ERRORED writable stream` — while Firefox tolerates it. Do not turn this back into a parallel read. The read is best-effort: a reference that cannot be read leaves that file without size, never the whole package.
|
|
||||||
- The `:error` of an import entry is user-facing text, never an i18n key. The legacy SSE import stays in the backend for other clients.
|
|
||||||
- File creation/duplication strips file `:data` before putting file summaries into dashboard state.
|
- File creation/duplication strips file `:data` before putting file summaries into dashboard state.
|
||||||
- The pending invitations are a team-admin only list (backend `:is-admin` already includes the owner). The dashboard hides the invitations entry from the header tabs and the team-options dropdown for non-admins, `invitations-section-content` keys the section on `:is-admin`, and `fetch-invitations` answers `insufficient-permissions` by emitting `invitations-fetched` with `[]`, so a demoted admin does not keep the cached emails and the header does not paint the invite button from a stale list. The organization `send-invitations` policy (`can-invite?`) does not gate the list, but it gates every action on it: inviting (header and empty-state buttons render disabled with the `dashboard.invite-profile-disabled` tooltip), the role selector (read-only label), row selection (so resend and delete never show) and copy link (`invitation-link-copyable?`). The backend enforces the same rule.
|
|
||||||
|
|
||||||
## Viewer
|
## Viewer
|
||||||
|
|
||||||
- `app.main.ui.ui` parses the viewer's `file-id` query param with `uuid/parse*`, so a missing or malformed id arrives as nil. `viewer-page*` calls `check-file-id!` (same namespace) during render, before mounting `viewer*`: it raises `ex/raise :type :not-found :code :missing-file-id`, which the error boundary turns into the not-found page. Without the guard the `dv/initialize` assertion fails on the nil file-id and the user gets an internal-error page. Test: `frontend-tests.ui.viewer-test/check-file-id-raises-not-found-for-invalid-file-id`.
|
|
||||||
- Viewer initialization sets `:current-file-id`, `:current-share-id`, and `:viewer-local`, then fetches the view-only bundle. Comment threads are fetched only for logged-in users.
|
- Viewer initialization sets `:current-file-id`, `:current-share-id`, and `:viewer-local`, then fetches the view-only bundle. Comment threads are fetched only for logged-in users.
|
||||||
- Viewer bundle fetch sends the full supported feature set because anonymous shared viewers may not know team-enabled features.
|
- Viewer bundle fetch sends the full supported feature set because anonymous shared viewers may not know team-enabled features.
|
||||||
- View-only bundles can contain pointer values in `:pages-index` and file data. Viewer resolves those fragments with `:get-file-fragment` before storing the bundle, through `app.main.features.pointer-map/resolve-pointer` (share-link scoped; the workspace and library loaders use `resolve-file`, which resolves the same two levels). Both fail loudly: a fragment that cannot be resolved rejects the stream and is logged with file id and fragment id instead of silently dropping the page.
|
- View-only bundles can contain pointer values in `:pages-index` and file data. Viewer resolves those fragments with `:get-file-fragment` before storing the bundle.
|
||||||
- `bundle-fetched` indexes pages and precomputes viewer frames/all-frames, stores libraries/users/thumbnails/permissions under `:viewer`, then navigates to frame id, query index, or auto-selected frame.
|
- `bundle-fetched` indexes pages and precomputes viewer frames/all-frames, stores libraries/users/thumbnails/permissions under `:viewer`, then navigates to frame id, query index, or auto-selected frame.
|
||||||
- Viewer zoom and interaction mode changes update both `:viewer-local` and the `:viewer` route query params. `update-zoom-querystring` guards with a query-param comparison (`not= current expected`) and uses `::rt/replace`; without that guard the load sequence (`bundle-fetched` → `zoom-to-fill` → `update-zoom-querystring` → `rt/nav`) re-runs on every navigation and crashes with React "maximum update depth exceeded" (2.18.0-RC5 regression, fixed in `31b73460c3`; regression test: `bundle-fetched-with-zoom-fill-url-does-not-navigate`).
|
- Viewer zoom and interaction mode changes update both `:viewer-local` and the `:viewer` route query params.
|
||||||
@ -15,9 +15,6 @@
|
|||||||
## Runtime initialization and permissions
|
## Runtime initialization and permissions
|
||||||
|
|
||||||
- The frontend initializes `@penpot/plugins-runtime` only after `features/initialize` and only when feature `plugins/runtime` is active. It also installs the runtime `isPluginError` predicate into frontend error handling.
|
- The frontend initializes `@penpot/plugins-runtime` only after `features/initialize` and only when feature `plugins/runtime` is active. It also installs the runtime `isPluginError` predicate into frontend error handling.
|
||||||
- `app.plugins/init-plugins-runtime` returns whether `ɵloadPlugin` was installed. It calls `preg/signal-runtime-ready` even on failure: `workspace.cljs` waits on that promise before `mcp/init`, so skipping it hangs MCP initialization forever.
|
|
||||||
- When SES bootstrap fails, `app.plugins` emits one `plugins-runtime-unavailable` telemetry event (with the SES error message), and `app.main.data.plugins/load-plugin!` shows the lazy `plugins.runtime-unavailable` toast when the user opens a plugin. `start-plugin!` (MCP path) stays silent by design.
|
|
||||||
- Runtime availability is detected by the existing `(fn? (unchecked-get global "ɵloadPlugin"))` check; do not add a second mechanism.
|
|
||||||
- Manifest parsing expands write permissions to read permissions (`content:write` => `content:read`, etc.). Permission checks also allow the all-zero plugin id and the hard-coded MCP plugin id.
|
- Manifest parsing expands write permissions to read permissions (`content:write` => `content:read`, etc.). Permission checks also allow the all-zero plugin id and the hard-coded MCP plugin id.
|
||||||
- Manifest URL origin differs by manifest version: v1 clears the path; v2 joins `.` to the plugin URL. Existing plugin ids are reused by matching manifest name and host.
|
- Manifest URL origin differs by manifest version: v1 clears the path; v2 joins `.` to the plugin URL. Existing plugin ids are reused by matching manifest name and host.
|
||||||
- The MCP plugin id is defined in `app.plugins.register` to avoid a circular dependency with workspace MCP code.
|
- The MCP plugin id is defined in `app.plugins.register` to avoid a circular dependency with workspace MCP code.
|
||||||
@ -26,9 +23,6 @@
|
|||||||
|
|
||||||
- Public Plugin API objects are lightweight handles, not durable snapshots. Most getters locate fresh state from `app.main.store/state` using hidden `$id`, `$file`, `$page`, etc.
|
- Public Plugin API objects are lightweight handles, not durable snapshots. Most getters locate fresh state from `app.main.store/state` using hidden `$id`, `$file`, `$page`, etc.
|
||||||
- `not-valid` logs by default but throws when the plugin flag `throwValidationErrors` is enabled. The MCP execute-code handler deliberately enables that flag while running code.
|
- `not-valid` logs by default but throws when the plugin flag `throwValidationErrors` is enabled. The MCP execute-code handler deliberately enables that flag while running code.
|
||||||
- A write to a removed shape always throws `Shape not found`, whatever that flag: setters through the shape proxy's `:on-set u/check-shape-writable` (runs outside the error handling), and methods that must not vanish silently (`resize`, `rotate`) call `u/check-shape-located` first. Methods run inside `:on-error (u/handle-error ...)`, which logs instead of throwing when the flag is off, so it rethrows errors whose `ex-data :type` is `::u/shape-not-found` or `::r/read-only`.
|
|
||||||
- A write while the workspace cannot take it (`r/read-only-reason`: save-failure lock `[:workspace-global :persistence-lock]`, `[:permissions :can-edit]` false, version preview `:preview-id`, lost render context `[:render-state :lost]`) always throws, whatever that flag. The `[:workspace-global :read-only?]` flag alone does not block: the Inspect tab sets it and plugins may still write. `r/check-permission` with `content:write`/`library:write` calls `r/check-writable` first, which covers most writers; writers without a permission check (most top-level context methods in `api.cljs`: `create*`, `group`, `align*`, …; z-order methods; text range `applyTypography`; ruler guide `remove`) call `r/check-writable` themselves, and shape setters get it through `u/check-shape-writable`. A new writer without a write-permission check must call it too. An async writer calls it again after each server await, before the next server write or commit (`rx/tap` on the response stream; `dwm/create-svg-shape-with-images` takes it as `:check-writable`), so a lock that lands mid-way rejects the promise with the read-only error. `r/has-permission?` is the check without it, used by the undo blocks so a block opened before a lock still closes. Comments (`comment:write`) stay writable: they do not go through file saves.
|
|
||||||
- `penpotMgmt` (`app.plugins.management`) checks permissions with `r/has-permission?` (`granted?`), never `r/check-permission`: its calls act on files through the backend, often from the dashboard with no file open, so the workspace read-only check (`check-writable`) must not block them.
|
|
||||||
- `naturalChildOrdering` and `throwValidationErrors` are stored per plugin under `[:plugins :flags plugin-id ...]`; changing default behavior affects automation and MCP diagnostics.
|
- `naturalChildOrdering` and `throwValidationErrors` are stored per plugin under `[:plugins :flags plugin-id ...]`; changing default behavior affects automation and MCP diagnostics.
|
||||||
- Plugin data is stored under keyword namespaces: private data uses `(keyword "plugin" plugin-id)`, shared data uses `(keyword "shared" namespace)`.
|
- Plugin data is stored under keyword namespaces: private data uses `(keyword "plugin" plugin-id)`, shared data uses `(keyword "shared" namespace)`.
|
||||||
|
|
||||||
@ -37,7 +31,4 @@
|
|||||||
- Plugin listeners are watches on the global store and callbacks are debounced about 10ms. Callback exceptions are caught and logged so plugin code does not crash the app.
|
- Plugin listeners are watches on the global store and callbacks are debounced about 10ms. Callback exceptions are caught and logged so plugin code does not crash the app.
|
||||||
- `selectionchange` callbacks receive arrays of shape id strings, while `filechange`, `pagechange`, and `shapechange` return proxies.
|
- `selectionchange` callbacks receive arrays of shape id strings, while `filechange`, `pagechange`, and `shapechange` return proxies.
|
||||||
- `contentsave` fires only when persistence status transitions to `:saved`; it calls the callback with no value.
|
- `contentsave` fires only when persistence status transitions to `:saved`; it calls the callback with no value.
|
||||||
- `penpot.waitForSave(timeout?)` (`app.plugins.persist/wait-for-save`; runtime forwarder checks `content:read`) waits on the **shared** persistence queue, not only the plugin's own commits. Flow: ~100ms intake race (buffer/queue non-empty vs deadline, capped to the timeout) → empty resolves; pending emits `::dps/force-persist` and races `dps/wait-persisted-or-error` against `::dps/rollback-rejected` / `::dps/rolled-back` (rollback rejects even if status later reads `:saved`). Default 60s. `:error` status at intake rejects at once (`earlier-failure`): `save-retrying` while `dps/save-retrying?` (slow retry cycle, recovers by itself), otherwise the stored `[:error :code]` with reopen advice (a terminal failure stays until the file is reopened, so it fails every call). Rejections are `Error`s with `code`: `save-timeout`, `rolled-back`, `save-retrying`, or the failure code (`save-failed` unless the backend gave one).
|
|
||||||
- Plugin timeouts validate through `u/valid-timeout?` (positive finite number ≤ `u/max-timeout`, signed 32-bit) and reject through `u/reject-not-valid`, which rejects an `Error` (never a bare string) so callers can read `.message`.
|
|
||||||
- `contentrollback` is not a state watch: it subscribes to `st/stream` for `::dps/rolled-back` (kept in `subscriptions`, disposed by `remove-listener`), not debounced, delivered async so the reverted state is in place. Payload `{fileIds pageIds shapeIds}` from `pcm/rollback-targets` (page shapes only, from the reverted commits' redo changes). When the rollback falls back to reloading the file, `::dps/rolled-back` waits for the reloaded data, so the callback never reads the rejected data. The runtime's `validEvents` must list every event name, or `penpot.on` rejects it; a stale runtime build rejects new events. The MCP plugin forwards these rollbacks with the next task response and the server puts a warning first in that tool response (`RollbackNotices`). Unsent ones survive a tab or plugin reload in `penpot.localStorage` (key `rollbacks/<file-id>`, `LocalStorageRollbackStore`; the MCP manifest in `app.main.data.workspace.mcp` and `mcp/packages/plugin/public/manifest.json` grant `allow:localstorage`, which the runtime checks on access); the entry goes once a response carried them.
|
|
||||||
- Plugin history `undoBlockBegin` creates a workspace undo transaction with a JS `Symbol`; `undoBlockFinish` commits that symbol. Missing finish eventually relies on the workspace transaction timeout.
|
- Plugin history `undoBlockBegin` creates a workspace undo transaction with a JS `Symbol`; `undoBlockFinish` commits that symbol. Missing finish eventually relies on the workspace transaction timeout.
|
||||||
@ -2,16 +2,9 @@
|
|||||||
|
|
||||||
## Router, app shell, and errors
|
## Router, app shell, and errors
|
||||||
|
|
||||||
- Routing uses browser-history query tokens (`?screen=<route-name>¶ms`, single `/` path), but `on-navigate` rejects navigation if the current origin/path does not match `cf/public-uri`.
|
- Routing uses browser-history hash tokens, but `on-navigate` rejects navigation if the current origin/path does not match `cf/public-uri`.
|
||||||
- `app.util.browser-history` (CLJS, not the old `goog.history.Html5History` wrapper) is the only history layer: the token is `location.search`, the URL of a token is `(:path cf/public-uri)` + token, and every change (own `pushState`/`replaceState` or back/forward) lands on the `token-changes` subject the router subscribes to. Nothing about it lives in the store: `rt/initialize-history` is effect-only.
|
- Route params are split into `:path` and `:query`; duplicate query params can become vectors, so use `rt/get-query-param` when a scalar is required.
|
||||||
- `set-token!` and `replace-token!` are deliberately asymmetric. `set-token!` is a total no-op when the token already is the current one (no URL write, no report), so navigating to the screen you are on cannot grow the history stack. `replace-token!` always writes and always reports, because it is how the app corrects the URL in place (legacy `#/…` translation, cleaned share links) and that correction must reach the router even when the token did not change. This matches `Html5History`, which did the same; do not "fix" the asymmetry without deciding what navigates to the current screen.
|
|
||||||
- `app.util.dom/replace-history-state!` is the deliberate bypass used by `app.main.ui.dashboard`/`app.main.ui.static` to rewrite the URL **without** routing. Keep using it there instead of `replace-token!`, which would re-enter the router.
|
|
||||||
- Route params live entirely in the query map under the reserved `screen` key; duplicate query params can become vectors, so use `rt/get-query-param` when a scalar is required.
|
|
||||||
- The organization SSO flow sends the **query string** (`rt/get-current-query-string`), not the URL and not the token: the backend builds the destination URL from `public-uri` + `?` + those params, so the client never chooses the origin of the redirect. The history token (`rt/get-current-token`, `location.search`) keeps its leading `?` because every other consumer concatenates it over the base path (`str cf/public-uri token`, `dom/append-query-param`, `dom/remove-query-param`); `rt/token->query-string` is the only bridge between the two shapes, so do not trim at a call site by hand; `rt/token->url` is the single client builder of an absolute destination from either shape (used by the SSO retry and error flow), so do not assemble `public-uri + "?" + params` at call sites. The gate is not the only caller: `dtm/resolve-login-team-id` runs from the root branch of `on-navigate` too, and there the URL carries its params instead of a screen (`?template=…`) — that call only reads `:authorized`, so it never follows the destination, which is exactly why a wrong destination there goes unnoticed. Do not add a rule that requires `screen`. See `mem:backend/auth-permissions-product-domains`.
|
|
||||||
- The router events expose their payload through `@event` (`IDeref`): `rt/navigate` returns `{:id :params :options}` and `rt/nav-raw` returns its `:href`/`:uri`. `rt/nav-raw` is the way out of the router (raw URL, outside the token scheme) and nothing in the app listens to `::rt/nav-raw`; the destination travels in the effect, so `@event` is the only way to tell where the user is being sent (tests included).
|
|
||||||
- Legacy `#/…` hash URLs translate client-side to the query format (one-version compat; see `legacy-routes` in `app.main.ui.routes`, TODO(next-version) to delete).
|
|
||||||
- Unknown/empty routes trigger an extra `get-profile`/`get-teams` check before redirecting. This avoids invitation and root-route race conditions.
|
- Unknown/empty routes trigger an extra `get-profile`/`get-teams` check before redirecting. This avoids invitation and root-route race conditions.
|
||||||
- The root app has two error layers, and they reset differently. `:exception` in the store renders `static/exception-page*` directly and is cleared by `rt/navigated`; a React render error is caught by `app.main.ui.error-boundary` (`react-error-boundary`), whose error lives in internal React state that only `reset-error-boundary` clears. Because every exit from the error page (the logo, the no-permission dialogs, the SSO dialog, the feedback link) only *navigates*, the boundary is given `:resetKeys [(eb/reset-key route)]` — the screen name — so a navigation counts as a fresh attempt at rendering. Three traps in that `resetKeys` value, all learned the hard way: it must be a real JS array (`#js [...]`), never a ClojureScript vector, because `react-error-boundary` reads `.length` and `.some` and a `PersistentVector` has neither, so `componentDidUpdate` throws `some is not a function`; it must hold the screen name as a *string*, because the library compares entries with `Object.is` and ClojureScript does not intern keywords, so two equal keywords are two objects and a keyword key would read as new on every route rebuilt, resetting the boundary on a param change inside the same screen; and it must be the screen rather than the params, so a param change does not replay the screen that just crashed. Navigating to the *same* screen therefore does not reset, and a reload is the only way out of that case.
|
|
||||||
- The root app renders an exception page from `:exception` state before the normal error boundary. `rt/navigated` clears `:exception`.
|
- The root app renders an exception page from `:exception` state before the normal error boundary. `rt/navigated` clears `:exception`.
|
||||||
- Frontend error handling treats stale cross-build JS chunk failures specially: messages containing `$cljs$cst$` or `$cljs$core$I` plus undefined/null/not-a-function signatures trigger throttled reload.
|
- Frontend error handling treats stale cross-build JS chunk failures specially: messages containing `$cljs$cst$` or `$cljs$core$I` plus undefined/null/not-a-function signatures trigger throttled reload.
|
||||||
- Plugin-originated uncaught errors are identified through the plugin runtime hook and logged rather than turning into the global exception page.
|
- Plugin-originated uncaught errors are identified through the plugin runtime hook and logged rather than turning into the global exception page.
|
||||||
@ -24,9 +17,6 @@
|
|||||||
- `flash-persistence` only delegates to another handler for `:authentication`, `:not-found` and `:code :vern-conflict`. Everything else it reports itself, and the report type is derived from the cause: `#{:validation :server-error :internal}` are application defects and report as `unhandled-exception` so they reach the internal reports and the alerts; the rest stay `handled-exception`. `:cause-type` wins over `:type` when classifying, because `persistence-failed` wraps the original cause under `:type :persistence`. Environment failures are deliberately kept handled: they land here after the retry budget is spent and the user's connection is not our bug. `:assertion` is also kept handled, matching its own handler.
|
- `flash-persistence` only delegates to another handler for `:authentication`, `:not-found` and `:code :vern-conflict`. Everything else it reports itself, and the report type is derived from the cause: `#{:validation :server-error :internal}` are application defects and report as `unhandled-exception` so they reach the internal reports and the alerts; the rest stay `handled-exception`. `:cause-type` wins over `:type` when classifying, because `persistence-failed` wraps the original cause under `:type :persistence`. Environment failures are deliberately kept handled: they land here after the retry budget is spent and the user's connection is not our bug. `:assertion` is also kept handled, matching its own handler.
|
||||||
- The report governor is global and stateful across tests: two reports with the same fingerprint inside `report-window-ms` collapse. Call `errors/reset-report-governor!` between assertions that expect an emission.
|
- The report governor is global and stateful across tests: two reports with the same fingerprint inside `report-window-ms` collapse. Call `errors/reset-report-governor!` between assertions that expect an emission.
|
||||||
- Error messages are bounded at the source: `app.common.exceptions/get-hint` clamps to `max-message-length` (1000 chars) and the CLJS `format-throwable` clamps the message line of the stack trace and honors `:trace-length`. A message can embed a whole payload (a serialized file, for example) and reach megabytes; the bound keeps the audit `:hint` prop and the `:report` string small. The `Context: Hint:` header in `generate-report` prints `get-hint` (not the raw `:hint` from `ex-data`) for the same reason.
|
- Error messages are bounded at the source: `app.common.exceptions/get-hint` clamps to `max-message-length` (1000 chars) and the CLJS `format-throwable` clamps the message line of the stack trace and honors `:trace-length`. A message can embed a whole payload (a serialized file, for example) and reach megabytes; the bound keeps the audit `:hint` prop and the `:report` string small. The `Context: Hint:` header in `generate-report` prints `get-hint` (not the raw `:hint` from `ex-data`) for the same reason.
|
||||||
- A team scoped navigation carries a team whenever any of the four tiers exists, and `app.main.data.common/resolve-team-id` decides it for every team scoped `go-to-*` helper of that namespace: the UUID the caller passes, `:current-team-id`, the team of the route already on screen (`?team-id`), then the profile `:default-team-id`. `go-to-feedback` and `go-to-viewer` are not team scoped and do not go through it, and `:team-id :default` keeps meaning the profile default, resolved before the rest. The route goes before the profile default because an emitter that runs from a team screen knows which team the user is looking at, and the personal team would open their file under another team. Two `rt/nav` emitters outside that namespace still decide their own id and can still emit nil, and they are the residual: `app.main.ui.nitrate.entry/nitrate-entry*` (the profile default) and the root branch of `app.main.ui.routes/on-query-navigate` (`dtm/resolve-login-team-id`, which answers nil when the profile has no default team). When none of the tiers exists the helper still fires the navigation with a nil id, so the not-found page appears instead of the click doing nothing.
|
|
||||||
- `app.main.ui/team-container*` raises `:not-found :invalid-team-id` for a dashboard or workspace route without a valid `team-id`; the raise is what keeps a broken URL from painting a blank shell, so it stays after the hook fix of #12728. `exception-section*` skips `errors/submit-report` for `:not-found`, so this failure never reaches PostHog and cannot be measured from the error dashboard. The exit from that page is the `error-container*` header (logo plus `not-found.no-permission.go-dashboard`), which emits `go-to-dashboard-recent` with the profile default and falls back to `rt/nav-root`; every not-found and authentication page already carries it, so there is no button to add there.
|
|
||||||
- A click cannot reach a team screen before its team is resolved: `team-container*` paints its children only when the route id matches the store team, and `refs/team` derives from `:current-team-id`, so with that key empty the dashboard and the workspace paint nothing clickable. The nil-id emissions come from events that run on their own (login, invitation acceptance, membership change, the sidebar logo, the workspace shortcuts) and from typed or bookmarked URLs.
|
|
||||||
|
|
||||||
## Store and websocket
|
## Store and websocket
|
||||||
|
|
||||||
@ -34,4 +24,3 @@ For general store mechanics such as `emit!`, `last-events`, persistence, and und
|
|||||||
|
|
||||||
- Websocket initialization uses `cf/public-uri` joined with `ws/notifications`, converting `http/https` to `ws/wss`, and includes the current `session-id` as query param.
|
- Websocket initialization uses `cf/public-uri` joined with `ws/notifications`, converting `http/https` to `ws/wss`, and includes the current `session-id` as query param.
|
||||||
- Reinitializing or finalizing websocket stops the previous receive stream. Incoming websocket payloads become Potok data events under `app.main.data.websocket/message`.
|
- Reinitializing or finalizing websocket stops the previous receive stream. Incoming websocket payloads become Potok data events under `app.main.data.websocket/message`.
|
||||||
- A job the client created is followed with `app.main.data.jobs/watch-job`: it emits the `:job-event` messages of that job (filtered by `:job-id`) and one final outcome read from the row with `get-job`, which is read when the stream starts and again on every `opened` of the websocket, so a job that ended before the client started following it, or while the socket was down, still answers. The stream ends after that outcome, and a read that fails reaches the caller: the repo retries the transient transport errors of a GET, and anything else is a real failure the flow has to show. The `:stage` of a progress event is a stable key of the vocabulary of the worker, never a display string: `app.main.ui.jobs.progress` resolves it with a `case` of literal `tr` calls, falls back to a generic label for a stage it does not know, and the counter of the activity is named after its own stage (the counter of `:files` is the outer context).
|
|
||||||
|
|||||||
@ -12,42 +12,15 @@ Frontend unit tests live under `frontend/test/frontend_tests/` and use `cljs.tes
|
|||||||
|
|
||||||
Frontend testing is async-first: everything essentially asynchronous is modeled with a test reproducing the asynchrony, even when the test could be written "synchronously". Sync-passing tests prove nothing about async behavior and rot as soon as an async boundary appears downstream. Consequences: mock through `frontend-tests.helpers.mock`, never `with-redefs`, except unit tests of purely synchronous functions; transport doubles deliver asynchronously (`observe-on :async`) while the test keeps scenario timing (explicit pushes); assertions always follow quiescence (`wait-for` on presence, bare `settle` tick for absence-only blocks), never a trigger.
|
Frontend testing is async-first: everything essentially asynchronous is modeled with a test reproducing the asynchrony, even when the test could be written "synchronously". Sync-passing tests prove nothing about async behavior and rot as soon as an async boundary appears downstream. Consequences: mock through `frontend-tests.helpers.mock`, never `with-redefs`, except unit tests of purely synchronous functions; transport doubles deliver asynchronously (`observe-on :async`) while the test keeps scenario timing (explicit pushes); assertions always follow quiescence (`wait-for` on presence, bare `settle` tick for absence-only blocks), never a trigger.
|
||||||
|
|
||||||
### Primitives
|
### Mock primitives
|
||||||
|
|
||||||
- `mock/with-mocks` (callback style, legacy compat): installs with `set!` so mocks survive async boundaries; bodies run deferred past the current tick via `asap`, so only done-chained (`t/async`) contexts are allowed; `done'` restores and completes exactly once (twice only warns; never calling it stalls the run and leaks the mocks). Prefer `mock/with-mocks*` for new tests.
|
- `mock/with-mocks` (callback style, the default): installs with `set!` so mocks survive async boundaries. Body runs immediately and `done'` restores and completes — so the call site must be inside `t/async`, and `done'` is called exactly once (twice only warns; never calling it stalls the run and leaks the mocks).
|
||||||
- `mock/with-mocks*` (direction): body forms wrapped in a generated `^:async` fn, evaluates to a promise — `await` it, `await` nested scopes too, no `done` in test code. Rejections and non-promise returns report as `:error` via `run-mocked`.
|
- `mock/with-mocks*` (preferred for new tests): body forms are wrapped in a generated `^:async` fn and it evaluates to a promise — `await` it, `await` nested scopes too, no `done` in test code. A rejection or a non-promise return is reported as an `:error` by `run-mocked`, which restores the originals in either case.
|
||||||
|
- `mock/asap` runs `f` on the next macrotask; used to make a scheduled callback fire under test control.
|
||||||
- `mock/stub` wraps fns for arities 0-6 (the `:esm` test build dispatches multi-arity vars as `cljs$core$IFn$_invoke$arity$N`); when the mocked var is variadic-defined (or called with more than 6 args), the call compiles to variadic dispatch, so use a plain variadic `fn` — the stub does not forward variadic. A mock must not call the mocked var again (self-delegation inside a multi-arity function recurses).
|
- `mock/stub` wraps fns for arities 0-6 (the `:esm` test build dispatches multi-arity vars as `cljs$core$IFn$_invoke$arity$N`); when the mocked var is variadic-defined (or called with more than 6 args), the call compiles to variadic dispatch, so use a plain variadic `fn` — the stub does not forward variadic. A mock must not call the mocked var again (self-delegation inside a multi-arity function recurses).
|
||||||
- Helpers in `frontend-tests.helpers.async`: `->promise` (single-value observable → promise; beicon has no `to-promise`), `await-response` (subscribe→push→await, atomic), `settle`, `wait-for`, `wait-for-store`, `observe` (stream → termination promise; asserts provided, timeout rejects).
|
- Helpers in `frontend-tests.helpers.async`: `->promise` (single-value observable → promise; beicon has no `to-promise`), `await-response` (subscribe→push→await, atomic), `settle`, `wait-for` (immediate check + bounded poll, fails instead of hanging), `observe` (stream → termination promise; asserts provided, timeout rejects).
|
||||||
- `wait-for` waits on a **signal**, not on turns: `:signal` (an observable) re-checks the predicate on every emission and resolves on the event that changes the state; `:timeout-ms` (default 5000) only bounds failure then. Without a signal it polls against a real-time deadline — 50 turns were ~54 ms idle, and turns are not a unit of time. `wait-for-store` passes `ptk/input-stream` as the signal (the store notifies after applying the update, so the predicate sees the new state); the persistence fixture exposes `requests$` for `(= N (count @requests))`. A wait that resolves on an event consumes no turn. The waits with nothing to listen to stay on the poll: test atoms filled outside the store (`@cycles`, `@reports`, `@done`), `@failures`, and predicates over JS objects or closures.
|
|
||||||
- Fixtures return promises (`with-watchdog`, `with-persistence`); `await` them from `^:async` tests. `main_errors` and `fonts` are fully migrated (no legacy `with-mocks` left).
|
|
||||||
- Valid `^:async` placements: `mem:clojure/idioms`.
|
- Valid `^:async` placements: `mem:clojure/idioms`.
|
||||||
|
|
||||||
### Observing event streams
|
|
||||||
|
|
||||||
To assert over emitted event sequences, observe termination: subscribe through `observe` (async delivery forced even for sync sources), `await` its promise, then assert the collected values. Never branch on nil (`when-let` skipping observation lets setup bugs pass as "empty"): producers answer refusals with empty streams, never nil, so every path subscribes uniformly. Observed termination is exact quiescence — no manual `settle` after it. Errors reject unless `:on-error` handles them.
|
|
||||||
|
|
||||||
### Runner and library facts (verified: CLJS 1.12.145, beicon2 `df7058a`)
|
|
||||||
|
|
||||||
- `cljs.test` keeps its env in a `set!` var: assertions inside deferred ticks count. `run-block`: double `done` only warns; missing `done` stalls.
|
|
||||||
- `t/async` discards the body promise — completion signals ONLY via `done`. `t/deftest ^:async` adds auto async-context + auto `done`, but awaiting stays the author's job; without it the test passes empty.
|
|
||||||
- `take 1` is per-subscription on a hot subject: subscribe-before-push or hang. `end!`/`.error` with pending takes only forwards valueless completion.
|
|
||||||
|
|
||||||
### Traps that bit
|
|
||||||
|
|
||||||
- `^:async` tests require map-style fixtures (`(t/use-fixtures :each {:before f})`): function-style fixtures abort the whole run ("Async tests require fixtures to be specified as maps").
|
|
||||||
- `st/emit!` doubles collect heterogeneous events: audit `DataEvent`s deref, toast reify-objects do not — discriminate with `ptk/type` (total, never throws), never blind `deref`.
|
|
||||||
- Subscription order decides delivery order: never resolve settlement from a pre-subscribed branch racing the pipeline.
|
|
||||||
- Auto-answering mocks lose deadline expressiveness (can't time answers), need teardown timer-cancellation, and post-teardown deliveries hit real implementations — explicit pushes + async delivery + `wait-for` won on every axis.
|
|
||||||
- A wait that observes an effect the test asserts takes a signal. A wait that means "the side effect advanced before the next emit" has no event to listen to: keep the poll (or an explicit `settle`) and say so, because a signal would resolve inside the same `emit!` and the next step would overtake the pipeline (`persistence-rollback-test` drove its four emits this way).
|
|
||||||
- With `rp/cmd!` mocked, a store-state wait can resolve before the flow that changes it ends, and the mock scope then closes in flight: the next call hits the real HTTP layer (malformed URL from a nil `cf/public-uri`) and the error is reported on a later test. `unlink-file-from-library` dissocs the library before its async chain, so the only proof the chain ran inside the mock is its second RPC call; wait for that, through the mock.
|
|
||||||
- Teardown belongs to the terminal continuation, never to `finally`-around-triggers (it would dispose in-flight flows).
|
|
||||||
- A body that awaits must be `(^:async fn …)` even if the rest is sync; sync sequences are atomic vs the event loop.
|
|
||||||
- `app.main.errors` prints every handled cause with `ex/print-throwable` before notifying, and the app logger does not gate it. A test that runs a real handler end to end stubs that var (`main-errors-test/quiet-throwable`): without it, the 10 000-error governor test alone wrote 190 k of the 192 k lines of a run log (13,8 MB), and GitHub truncates a step log past ~4 MB, cutting the summary and any failing assertion. Same for a production `console.error` a test provokes on purpose: `code-gen-markup-svg-wasm-test` silences `(.-error js/console)` in a `try/finally` while two WASM panics go through `get-svg-markup` (2 blocks, 70 lines, and the exception dumps its own `data`/`arr`).
|
|
||||||
- The `:esm` test build cannot load the CommonJS `sax` module behind `tubax`, so SVG parsing fails in tests (`dwm/valid-svg-string?` answers false, `dwm/svg->clj` errors): mock both with the parsed data.
|
|
||||||
- A hook-order violation in a mounted component reaches neither the root's `onUncaughtError`/`onCaughtError`/`onRecoverableError` nor the markup: React logs an internal error to `console.error` and recovers, so the callbacks stay empty and the tree repaints. Assert on a captured `console.error` too. It only fires when a render *adds* hooks (nil → uuid); a render that calls none at all slips through React's bookkeeping, so the regression test needs the "hooks arrive" direction. `frontend-tests.ui.team-container-test` does both, with a jsdom document.
|
|
||||||
- `beicon.v2.core` has no `never`. A stream that must **not emit** is `(rx/empty)`: it completes at once, which is enough for `merge`, `filter` and `take` where only the emission matters. A stream that must **stay open** is a `(rx/subject)` nobody pushes to; `rx/empty` would complete the flow behind it. An undeclared `rx/never` compiles to an undefined var and the test dies as a rejected body, which `cljs.test` reports as a test with zero assertions instead of a failure.
|
|
||||||
- `set!` mocks are global and outlive the fixture, so a flow another module left running (a store's pending timer) can still reach the mocked transport mid-test; `with-persistence` records every command for that reason. Filter to the commands your layer issues — persistence only sends `update-file` — before counting or asserting emptiness, and never let a stray call release a `wait-for` on one.
|
|
||||||
|
|
||||||
From `frontend/`:
|
From `frontend/`:
|
||||||
- Full unit test run (always builds, suppressed output): `pnpm run test:quiet`.
|
- Full unit test run (always builds, suppressed output): `pnpm run test:quiet`.
|
||||||
- Full unit test run (always builds, build output visible): `pnpm run test`.
|
- Full unit test run (always builds, build output visible): `pnpm run test`.
|
||||||
@ -57,13 +30,12 @@ From `frontend/`:
|
|||||||
- Build test target only (no run): `pnpm run build:test`.
|
- Build test target only (no run): `pnpm run build:test`.
|
||||||
- After `build:test` has been run, run the compiled runner directly: `node target/tests/test.js [--focus ...] [--log-level ...]`.
|
- After `build:test` has been run, run the compiled runner directly: `node target/tests/test.js [--focus ...] [--log-level ...]`.
|
||||||
- Watch tests: `pnpm run watch:test`.
|
- Watch tests: `pnpm run watch:test`.
|
||||||
- Coverage: `pnpm run test:coverage` (builds, runs the suite under `NODE_V8_COVERAGE`, keeps its exit code). `scripts/coverage.js` maps V8 data back to `.cljs`/`.cljc` through the test build's source maps (`ast-v8-to-istanbul` + acorn) and writes `coverage/` (`lcov.info`, `coverage-summary.json`, `html/`, `unloaded.txt`); `tests-frontend.yml` renders the step summary with `scripts/coverage-summary.mjs` and uploads `coverage/` as the `frontend-coverage` artifact. `scripts/test` (CI) runs `test:coverage`, not `test`. Scope: `frontend/src/app/**` minus `app/main/ui/` (`EXCLUDED_DIRS`); namespaces no test loads are listed apart, never counted. Never pass `ignoreSourceCode` to `convert`: CLJS maps point past source lines and it throws. Trust line % over branch % (branches are of the generated JS).
|
|
||||||
|
|
||||||
New frontend test namespaces must be required/listed in `frontend_tests/runner.cljs`; new vars in existing namespaces need no runner change.
|
New frontend test namespaces must be required/listed in `frontend_tests/runner.cljs`; new vars in existing namespaces need no runner change.
|
||||||
|
|
||||||
## Playwright integration tests
|
## Playwright integration tests
|
||||||
|
|
||||||
Do not add, modify, or run Playwright integration tests under `frontend/playwright` unless explicitly asked. When explicitly asked, run the whole suite with a worker count sized to the machine: `pnpm run test:e2e --workers=N` from `frontend/`, about one worker per two hardware threads, because each keeps two or three busy and holds about 2 GB of browser memory. The config's default of one worker leaves it slow; four take a 16-thread host from 48 minutes to 35 and fit a 64 GB machine beside a watching devenv, while a 32 GB machine takes two, or four with a slim devenv. `--grep "pattern"` narrows the run. Ensure dependencies are installed through `./scripts/setup` if the environment is not prepared.
|
Do not add, modify, or run Playwright integration tests under `frontend/playwright` unless explicitly asked. When explicitly asked, use `pnpm run test:e2e` or `pnpm run test:e2e --grep "pattern"` from `frontend/`; ensure dependencies are installed through `./scripts/setup` if the environment is not prepared.
|
||||||
|
|
||||||
Integration tests fake backend behavior by intercepting network/websocket traffic, so every RPC or websocket the page needs must be mocked. Use existing Page Object Models:
|
Integration tests fake backend behavior by intercepting network/websocket traffic, so every RPC or websocket the page needs must be mocked. Use existing Page Object Models:
|
||||||
- `BasePage.mockRPC` intercepts RPC calls and already prefixes `/api/rpc/command/`; pass command names such as `get-profile`, not full URLs.
|
- `BasePage.mockRPC` intercepts RPC calls and already prefixes `/api/rpc/command/`; pass command names such as `get-profile`, not full URLs.
|
||||||
|
|||||||
@ -1,77 +0,0 @@
|
|||||||
# Frontend Translations
|
|
||||||
|
|
||||||
PO-based UI i18n. Files: `frontend/translations/*.po`. `en.po` is the
|
|
||||||
source of truth (`msgid` = key, `msgstr` = English); `es.po` is a
|
|
||||||
high-coverage support reference, never the base.
|
|
||||||
|
|
||||||
## Workflow
|
|
||||||
|
|
||||||
- Canonicalize with `node ./scripts/translations.js sync -l <locale>` from `frontend/`: sorts entries, syncs `#:` comments from `en`, deletes keys missing in `en`.
|
|
||||||
- `sync` never ADDS a key missing in the locale: it only syncs comments (for keys that already exist) and drops keys absent from `en`. A key added to `en` alone stays missing in `es` and its text silently falls back to English. Every new key is born in `en` AND `es` in the same change; compare the `msgid` sets to check (`comm -23 <(grep '^msgid ' en.po | sort -u) <(grep '^msgid ' es.po | sort -u)` must be empty).
|
|
||||||
- `sync` copies ALL comment flags from `en`, including `#, fuzzy`. Translated entries must NOT stay fuzzy: strip the flag after translating (mirror `es.po`, which keeps fuzzy only on genuinely untranslated entries). Fuzzy entries are excluded from `msgfmt --statistics` translated counts.
|
|
||||||
- Canonical files carry NO `#~` obsolete blocks (`en`/`es` have zero). Drop them; `sync` does not resurrect them.
|
|
||||||
- Definition of done: `msgfmt --check <locale>.po` exit 0, `msgfmt --statistics` shows 0 fuzzy, 0 untranslated, and the locale's `msgid` set is identical to `en.po`'s (no key missing, none extra).
|
|
||||||
- `rehash` scans `frontend/src` AND `common/src` for `(tr "key"` occurrences (any line counts, including `;;` comments) and refreshes `#:` refs in `en`, marking unreferenced keys `#, unused`. The refs in `en` are broadly stale, so a repo-wide `rehash` rewrites hundreds of lines (measured: ~487 on `en` alone): it is a maintenance action on its own, never a step to run inside a change that only adds or edits a key.
|
|
||||||
- Dynamic keys are invisible to `rehash`: eliminate them instead of
|
|
||||||
declaring them. Preference order: literal `(tr "key")` args only;
|
|
||||||
never put a branch inside `tr`, hoist it out (`(if cond (tr "a") (tr "b"))`);
|
|
||||||
resolve code→message maps with `case` returning literal calls;
|
|
||||||
key-forwarding components take pre-translated strings (callers translate
|
|
||||||
with literals). Only when no simple fix exists (open key sets sent by the
|
|
||||||
backend, large data-driven matrices like `shortcuts.*`) declare each key
|
|
||||||
with a `;; (tr "the.key")` comment next to the call site (grouped under
|
|
||||||
`;; Execution time translation strings:`), otherwise the next `rehash`
|
|
||||||
flags them `unused`. The declaration convention is legacy fallback, not
|
|
||||||
the default: never introduce new declarations where a hoist or
|
|
||||||
pre-translation works, and remove existing ones when fixing the call
|
|
||||||
site. Same for `:error/code "key"` data: prefer `:error/fn #(tr "key")`. Any non-literal first arg to `tr` is reported by the `:penpot/tr-dynamic` clj-kondo warning (hook in `.clj-kondo/hooks/i18n.clj`, registered for `app.util.i18n/tr` and `app.common.i18n/tr`) and forbidden by the `tr` docstring: only `(tr "literal" ...)` is statically resolvable. Translation keys must not contain spaces (use `-` or `.`).
|
|
||||||
- Shortcut command/section/subsection labels (`shortcuts.*`, including `shortcuts.section.*` and `shortcuts.subsection.*`) resolve through `:label` fns holding static `(tr "literal")` calls, executed at render time: commands carry `:label` on their definitions in the `app.main.data.*.shortcuts` namespaces, sections/subsections in static registries in `app.main.ui.shortcuts` next to `translation-keyname` (id lookup with raw-key fallback for stale custom ids). When adding, renaming, or removing commands/sections/subsections, add/update/remove the `:label`/registry entry; `rehash` sees the literals with no comment needed, and the exhaustiveness test fails otherwise. Exempt, untranslated by design: debug `:preview-frame` and colorpicker `:delete-stop` (no PO keys).
|
|
||||||
|
|
||||||
## Entry rules
|
|
||||||
|
|
||||||
- Placement: a key names the feature that renders it (`dashboard.import.*`,
|
|
||||||
`files-export-modal.*`, `jobs.*`); `labels.*` is the bucket for the short
|
|
||||||
generic words reused across screens (Accept, Cancel, Download…), never the
|
|
||||||
home of a feature's own vocabulary. Keep a feature's strings together: the
|
|
||||||
durable jobs write their progress stages as `jobs.progress.stage.*` and
|
|
||||||
their row statuses as `jobs.*`, not half in `labels.*`.
|
|
||||||
- Keys resolved dynamically from server-provided data carry a `#, backend`
|
|
||||||
flag (set it in `en`, `sync` copies it to the locales): do not remove or
|
|
||||||
rename these entries, and keep their `%s` placeholders (the backend only
|
|
||||||
sends the key). The code side keeps a `;; (tr "key")` marker for `rehash`
|
|
||||||
plus a `#_{:clj-kondo/ignore [:penpot/tr-dynamic]}` on the call site.
|
|
||||||
- New entries take `#:` refs from `en`; copy `#, unused`, never `#, fuzzy`.
|
|
||||||
- `en` keys with empty `msgstr` (or `#, fuzzy` + empty): translate from `es`/source context, never leave empty.
|
|
||||||
- Entries whose `en` uses `msgid_plural` need `msgstr[0]`/`msgstr[1]` (header: `nplurals=2; plural=n != 1`). Keep the `msgid_plural` line: a singular `msgstr` on a plural key silently breaks count selection at runtime (the app build reads 1-elem `msgstr` as singular). Exception: single-form locales (`nplurals=1`, e.g. `jpn_JP`, `ko`) keep ONE `msgstr[0]` that includes the count `%s` (build emits a plain string, runtime formats it with the count for every n); `check` compares it against the `en` plural form.
|
|
||||||
- `sync` re-adds `#, fuzzy` on EVERY run for entries fuzzy in `en`; re-strip after the last sync, never before it.
|
|
||||||
- Preserve verbatim: `%s`/`%d`, `{var}`/`{{...}}`, markdown `[text](%s)`, HTML tags, `\n` positions, brand names (Penpot), key names (Ctrl/Shift/Alt), technical terms (SVG, CSS, HSV, RGB).
|
|
||||||
|
|
||||||
## Catalan (ca) conventions
|
|
||||||
- Normative IEC/Termcat Catalan. Address the user in VOSALTRES (2nd person plural): "Deseu", "Creeu", "Ja teniu un compte?". Buttons/menus use short imperatives ("Crea", "Mou", "Restaura").
|
|
||||||
- Established glossary (reuse exactly, do not re-coin): layer=capa, board=tauler, stroke=traç, fill=Emplenat, blur=Difuminat, shadow=Ombra, clipboard=porta-retalls, delete=Elimina, rename=Canvia el nom, shortcut=drecera, grid=graella (keep "grid" where the file already does, e.g. grid-layout editing), plugins/extensions UI=extensions, layout=Disposició, gradient=Degradat, wireframing kept as loanword.
|
|
||||||
- Ela geminada uses the middle dot: Cancel·la, paral·lel, al·lega.
|
|
||||||
- ALL-CAPS source stays ALL-CAPS in Catalan; keep `$175`-style amounts in IEC format (`175 $/mes`) only where `es` already adapts.
|
|
||||||
- Shortcut/action names (`shortcuts.*`) are noun/infinitive labels, not sentences. Error strings are direct, no hedging.
|
|
||||||
- Same English source in different contexts may legitimately differ (verb "Copia" vs noun "Còpia"; "Desactivat" vs "Deshabilitada" agreeing with "drecera"). Normalize only true duplicates.
|
|
||||||
|
|
||||||
## Russian (ru) conventions
|
|
||||||
|
|
||||||
- Formal address with capital ВЫ ("Вы уверены…", "Вы собираетесь…"). Buttons/menus use infinitives ("Создать", "Удалить", "Дублировать"), never imperatives.
|
|
||||||
- Established glossary (reuse exactly, do not re-coin): layer=слой, board=доска (EN `board` is NEVER кадр — normalized in lote1: toolbar/viewer/shape-menu/header-menu/export-frames/undo/num-of-frames), path/draw tool=контур, stroke=обводка, fill=заливка, blur=размытие, shadow=тень, grid=сетка, clipboard=буфер обмена, shortcuts=сочетания клавиш (normalized in lote1: title/show-shortcuts/not-found), plugin=плагин, layout=макет (`labels.layout` fixed in lote1), gradient=градиент, token=токен, set=набор, theme=тема, file=файл, project=проект, team=команда, library=библиотека, component=компонент.
|
|
||||||
- No external RU style guide applies verbatim (Mozilla ru guide is marketing-only, GNOME glossary unmaintained, Adobe uses монтажная область for artboard but `ru.po` majority already says доска — keep доска for consistency).
|
|
||||||
- `words.ru.txt` `[function]` DELIBERATELY omits 1-letter words (в/с/к/о/у/а/и) and ending-colliding particles (на/по/не/ли/же/бы/его/их/те/или…): Russian inflects (проект→проекта, запросили=запрос+или), so listing them flags every inflected noun/verb. Never "complete" that list; put tripped valid words in `[ok]`.
|
|
||||||
- Never abbreviate т. д. / т. е. in `ru.po`: the lone т/д tokens poison the glue detector's frequency map and flag short words (тон→т+он). Write и так далее out.
|
|
||||||
- Tokens-domain glossary (lote2, reuse): alias=алиас, remap=переназначить, viewport=вьюпорт, set=набор, theme=тема, spread (shadow)=распространение, margins=внешние отступы, paddings=внутренние отступы, gaps=промежутки, type identifiers stay in English (Line Height, Font Size, innerShadow/dropShadow, none/Uppercase/Lowercase/Capitalize, thin/light/regular/bold/Italic).
|
|
||||||
- Editor-domain glossary (lote3, reuse): variant=вариант, property=свойство, guide=направляющая, board guide=направляющая доски, MCP server=MCP-сервер, size preset=пресет размера, border-radius section=скругление, path handler=маркер, canvas=холст, render=рендер/рендеринг, plugin (never extensión)=плагин.
|
|
||||||
- Avoid standalone те (those) in phrasing ("те же" → "такие же"): one lone те validates те+мы splits and flags every темы. Same poisoning class as т. д.
|
|
||||||
- `words.ru.txt` `[function]` also omits пока (dropped in lote4): with standalone за anywhere in the file, пока+за flags показа. Rare-typo detection loss accepted.
|
|
||||||
- Billing-domain glossary (lote4, reuse): plan names follow shipped `ru.po`, NOT es: Enterprise=Корпоративный, Professional=Профессиональный, Unlimited=Безлимитный, trial=пробный; subscription=подписка, storage=хранилище, seat editors=редакторы, viewer role=наблюдатель, amounts as `175 $/мес.` / `10 ГБ`; access token=токен доступа, MCP key=MCP-ключ (regenerate=перевыпустить), markdown `[text|target:self](%s)` kept verbatim.
|
|
||||||
- Closing-domain glossary (lote5, reuse): shortcut noun everywhere=сочетание (shortcuts section titles are noun/infinitive labels, never ярлыки); node=узел, segment=сегмент, measurements=размеры; WebGL unavailable flow uses гайд/руководство по неполадкам + рендеринг WebGL выключен/включён; `ru.po` reached 2275/2275 keys (100%) with 0 fuzzy, 0 untranslated per `msgfmt --statistics`.
|
|
||||||
|
|
||||||
## QA before commit
|
|
||||||
|
|
||||||
- Run `node ./scripts/translations.js check -l <locale>` from `frontend/` (no default locale: pass `-l` explicitly): 0 errors required; review warnings by hand. Word lists live in `frontend/scripts/check-translations/words.<locale>.txt` (`[elision]` `[function]` `[common]` `[ok]` `[brands]`); new valid words that trip the gate go to `[ok]`; `check --self-test` covers the detector rules. Without a catalog only the universal checks run. `#, fuzzy` entries are skipped (known-pending, owned elsewhere).
|
|
||||||
- Placeholder parity per entry (singular AND each plural form, also enforced by the script); verify `%s` against the `tr` call site when `en`/`es`/code disagree (a `%s` the code never passes renders literally; a dropped one swallows the argument). On `#, unused` keys the script only warns: never "fix" them by deleting placeholders or links, a reactivation may need them.
|
|
||||||
- Glued words (AI batches drop spaces at wrap boundaries): the script flags function-word splits (`del'equip`, `lapolítica`, `sinecessiteu`), `,/.`/`:` without following space, lowercase+Uppercase joins (`delPenpot`, `oCapitalize`) and `%s` glued to a word.
|
|
||||||
- Balanced `[]`/`()` in markdown links; no double spaces; no glued words around `·`; trailing spaces match the source.
|
|
||||||
- `git diff --stat` must touch only `frontend/translations/<locale>.po`.
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
|
|
||||||
- Co-located SCSS modules are preferred. Use `app.main.style/stl` helpers from CLJS and design-system SCSS tokens/mixins instead of legacy global selectors or high-specificity nesting.
|
- Co-located SCSS modules are preferred. Use `app.main.style/stl` helpers from CLJS and design-system SCSS tokens/mixins instead of legacy global selectors or high-specificity nesting.
|
||||||
- Keep CSS specificity low. Avoid nested selectors unless they target elements the component owns; CSS Modules already prevent class-name collisions.
|
- Keep CSS specificity low. Avoid nested selectors unless they target elements the component owns; CSS Modules already prevent class-name collisions.
|
||||||
- Prefer CSS logical properties for directional spacing/layout (`padding-inline-start`, etc.). Physical `width`/`height` are still acceptable where they are clearer. Never mix: a stylesheet logical property (`inline-size`) and an inline physical `width` on the same element cascade separately, and the logical mapping wins — a dynamically driven width must be `width` on both sides (import modal progress bar hit this). And an inline style passed from CLJS must be a JS object (`#js {:width …}`): for plain `[:div …]` elements the Rumext macro does not convert the `:style` map at runtime — a plain CLJS map reaches React raw and React never finds the keys (static style literals are converted at compile time, which is why `:style` maps seem to work elsewhere).
|
- Prefer CSS logical properties for directional spacing/layout (`padding-inline-start`, etc.). Physical `width`/`height` are still acceptable where they are clearer.
|
||||||
- Use named design-system variables/tokens for spacing, borders, fixed dimensions, colors, and typography. Avoid hardcoded px/rem values and deprecated `resources/styles/common/refactor/spacing.scss` variables.
|
- Use named design-system variables/tokens for spacing, borders, fixed dimensions, colors, and typography. Avoid hardcoded px/rem values and deprecated `resources/styles/common/refactor/spacing.scss` variables.
|
||||||
- Use component-local CSS custom properties for variants and theming instead of one-off Sass variables when a component has multiple visual states.
|
- Use component-local CSS custom properties for variants and theming instead of one-off Sass variables when a component has multiple visual states.
|
||||||
- Prefer DS typography components (`heading*`, `text*`) and typography mixins instead of plain text wrappers or deprecated typography mixins.
|
- Prefer DS typography components (`heading*`, `text*`) and typography mixins instead of plain text wrappers or deprecated typography mixins.
|
||||||
@ -33,7 +33,6 @@
|
|||||||
## Performance
|
## Performance
|
||||||
|
|
||||||
- Keep expensive derived data in refs, memoized selectors, or pure helpers. In hot render paths, prefer existing `app.common.data.macros` helpers where local code already uses them.
|
- Keep expensive derived data in refs, memoized selectors, or pure helpers. In hot render paths, prefer existing `app.common.data.macros` helpers where local code already uses them.
|
||||||
- Derive index-aware or sorted/filtered sequences once: wrap the transformation in `mf/with-memo` keyed on the source collection instead of calling `d/enumerate` in the render body. Use the shared `d/xf:add-index`, which attaches `:app.common.data/index` to each item; the items must be associative (maps/records), so it does not work on keywords or plain ids.
|
|
||||||
- Avoid creating new callback functions/objects inside hot renders when a named function, memoized callback, data attribute, or precomputed JS props object works.
|
- Avoid creating new callback functions/objects inside hot renders when a named function, memoized callback, data attribute, or precomputed JS props object works.
|
||||||
- Destructure props/state values used repeatedly. Avoid repeated deref/property access in render loops.
|
- Destructure props/state values used repeatedly. Avoid repeated deref/property access in render loops.
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@ -6,7 +6,6 @@
|
|||||||
- `apply-modifiers*` is the lower-level commit path once object/text modifiers are ready. It updates frame guides, frame comment threads, and then emits `update-shapes` with `:reg-objects? true`.
|
- `apply-modifiers*` is the lower-level commit path once object/text modifiers are ready. It updates frame guides, frame comment threads, and then emits `update-shapes` with `:reg-objects? true`.
|
||||||
- Transform commits restrict diff attrs to `transform-attrs` to avoid scanning unrelated shape attrs.
|
- Transform commits restrict diff attrs to `transform-attrs` to avoid scanning unrelated shape attrs.
|
||||||
- Text transforms may carry derived `:position-data`; `assoc-position-data` attaches it while preserving the original text shape context.
|
- Text transforms may carry derived `:position-data`; `assoc-position-data` attaches it while preserving the original text shape context.
|
||||||
- A drag commits when its `mse/drag-stopper` fires, `:interrupt` (Escape) included. The save-failure lock emits `::plk/cancel-gestures` first: drags built on `plk/gesture-stopper` (start-move, start-resize, start-rotate, start-move-line-point, box/curve/line drawing) see a `cancelled?` flag set before the stop and emit `dwt/cancel-transform` (`clear-local-transform` + `finish-transform`) or `cancel-drawing` instead. A new drag gesture must use it (or, in a component, drop the drag when read-only turns on): `commit-changes` refuses the commit anyway, but the preview (WASM modifiers/props) would stay.
|
|
||||||
|
|
||||||
## Component-copy touched suppression
|
## Component-copy touched suppression
|
||||||
|
|
||||||
|
|||||||
@ -13,27 +13,20 @@ enabling advanced AI-driven features in Penpot.
|
|||||||
- Build Tool: TypeScript Compiler (tsc) + esbuild
|
- Build Tool: TypeScript Compiler (tsc) + esbuild
|
||||||
- Package Manager: pnpm
|
- Package Manager: pnpm
|
||||||
|
|
||||||
## Principles & Code Style
|
## General Principles
|
||||||
|
|
||||||
IMPORTANT: Use an idiomatic, object-oriented style.
|
IMPORTANT: Use an idiomatic, object-oriented style.
|
||||||
* You keep each concern in exactly one home.
|
In particular, this implies that, for any non-trivial interfaces, you use interfaces that expect explicitly typed abstractions
|
||||||
A mechanism whose parts are only correct in combination is implemented as a single component/class, and its parts are private to it;
|
|
||||||
expose a minimal public surface. Java-like encapsulation: If helper functions and constants are only used by one abstraction,
|
|
||||||
make them internal to the respective class.
|
|
||||||
* For any non-trivial interfaces, you use functions/methods that expect explicitly typed abstractions
|
|
||||||
rather than mere functions (i.e. use the strategy pattern, for example).
|
rather than mere functions (i.e. use the strategy pattern, for example).
|
||||||
* Prefer declaring and instantiating concrete classes over defining only interfaces and using object literals.
|
|
||||||
|
|
||||||
Comments:
|
Comments:
|
||||||
* When describing parameters, methods/functions and classes, you use a precise style, where the initial (elliptical) phrase
|
When describing parameters, methods/functions and classes, you use a precise style, where the initial (elliptical) phrase
|
||||||
clearly defines *what* it is. Any details then follow in subsequent sentences.
|
clearly defines *what* it is. Any details then follow in subsequent sentences.
|
||||||
* When describing what blocks of code do, you also use an elliptical style and start with a lower-case letter unless
|
|
||||||
|
When describing what blocks of code do, you also use an elliptical style and start with a lower-case letter unless
|
||||||
the comment is a lengthy explanation with at least two sentences (in which case you start with a capital letter, as is
|
the comment is a lengthy explanation with at least two sentences (in which case you start with a capital letter, as is
|
||||||
required for sentences).
|
required for sentences).
|
||||||
|
|
||||||
Syntax:
|
|
||||||
* Never use if blocks (or other blocks) without braces, even for single-line cases.
|
|
||||||
|
|
||||||
## Project Structure (Excerpt)
|
## Project Structure (Excerpt)
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -57,7 +50,7 @@ mcp/
|
|||||||
│ ├── src/
|
│ ├── src/
|
||||||
│ │ ├── main.ts # handles communication
|
│ │ ├── main.ts # handles communication
|
||||||
│ │ └── plugin.ts # plugin implementation
|
│ │ └── plugin.ts # plugin implementation
|
||||||
│ └── package.json # Plugin deps: published plugin-styles, linked plugin-types
|
│ └── package.json # Includes @penpot-mcp/common dependency
|
||||||
└── prepare-api-docs # Python project for the generation of API docs
|
└── prepare-api-docs # Python project for the generation of API docs
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -92,51 +85,8 @@ From the `mcp/` directory, run
|
|||||||
|
|
||||||
* `pnpm run build` to test the build of all packages
|
* `pnpm run build` to test the build of all packages
|
||||||
* `pnpm run fmt` to apply the auto-formatter
|
* `pnpm run fmt` to apply the auto-formatter
|
||||||
* `pnpm run test` runs the tests of `plugin` (node test runner) and `server` (tsx).
|
|
||||||
The committed `typescript` version is 6.x: the 7.x line ships only a version stub
|
|
||||||
at the `typescript` entry point, and its synchronous compiler API is gone, so
|
|
||||||
`ts.transpileModule` (used by the plugin tests to compile `main.ts`/`plugin.ts`
|
|
||||||
into a sandboxed browser-like context) fails there.
|
|
||||||
* `packages/server` type-checks against the built `dist` of `@penpot/mcp-common`;
|
|
||||||
a stale `packages/common/dist` makes `types:check` fail with missing exports
|
|
||||||
(e.g. `PenpotSession`). Run `pnpm --filter mcp-common run build` first.
|
|
||||||
* The server logger (`packages/server/src/logger.ts`) uses pino transports only
|
|
||||||
outside `node:test` (`logTransportTargets`). A transport spawns a worker thread
|
|
||||||
whose message port stays referenced once a line is in flight, so the test child
|
|
||||||
process keeps running after the tests finish and the suite hangs intermittently
|
|
||||||
(node reports `Promise resolution is still pending but the event loop has
|
|
||||||
already resolved` for the file's root test). Inside tests the logger writes to
|
|
||||||
stdout directly. `NODE_TEST_CONTEXT` is the env var `node --test` sets.
|
|
||||||
* `packages/plugin` takes `@penpot/plugin-styles` from the registry but links
|
|
||||||
`@penpot/plugin-types` to `plugins/libs/plugin-types` (`link:` in the manifest
|
|
||||||
and in `mcp/pnpm-lock.yaml`, with no registry entry, because a linked package
|
|
||||||
has no resolution): the published types do not declare the `penpotMgmt`
|
|
||||||
global the plugin needs. On a plugins libs version bump, only the styles
|
|
||||||
version moves. After editing the manifest, `pnpm install --lockfile-only` in
|
|
||||||
`mcp/` must leave the lock untouched.
|
|
||||||
* Cross-cutting testing principles and anti-patterns: `mem:testing`.
|
* Cross-cutting testing principles and anti-patterns: `mem:testing`.
|
||||||
|
|
||||||
## OAuth for remote MCP clients
|
|
||||||
|
|
||||||
- Authorization/discovery URLs, self-contained client IDs, consent and PKCE/code binding, backend Redis state, deployment wiring, and compatibility limits: `mem:mcp/oauth`.
|
|
||||||
|
|
||||||
## Host and Origin allowlist (`RequestGuard`)
|
|
||||||
|
|
||||||
- `RequestGuard` checks `Host` and `Origin` (hostname only, port ignored) on `/mcp`, the REPL (Express middleware, 403) and the plugin WebSocket (close `1008` before any message is read). It stops web pages on the user's machine from driving a local server (DNS rebinding, cross-site WebSocket).
|
|
||||||
- Allowlist: `PENPOT_MCP_ALLOWED_HOSTS` (`*` turns the check off); unset → loopback only in single-user mode (local or remote: no other barrier, `execute_code` still runs in the user's session), any host in multi-user mode (relies on user tokens; behind nginx `/mcp/ws` the server sees `Host: penpot-mcp:4402`). A missing `Origin` passes (non-browser clients).
|
|
||||||
- Entries must be `*`, a hostname or a bracketed IPv6 address; one with a scheme, port or path makes `fromEnvironment` throw, so the server does not start. Startup logs a `warn` when the check is off in single-user mode.
|
|
||||||
- The plugin iframe has `allow-same-origin`, so its WebSocket carries the real plugin origin (`http://localhost:4400` locally, the Penpot origin when integrated).
|
|
||||||
- Test mocks of `PenpotMcpServer` passed to `PluginBridge` must provide `requestGuard`.
|
|
||||||
|
|
||||||
## Backend tools (`submit_feedback`)
|
|
||||||
|
|
||||||
- Tools that call the Penpot backend directly (not through the plugin) register only when `PENPOT_MCP_BACKEND_URI` is nonblank (`PenpotMcpServer.initTools`). Currently only `SubmitFeedbackTool`.
|
|
||||||
- `PenpotBackendClient` owns the HTTP call and the status-to-message mapping; it posts to `api/main/methods/send-mcp-feedback` with `Authorization: Token <MCP user token>`. The token comes from the session context (OAuth bearer or `?userToken=`); without one the tool fails before calling the backend.
|
|
||||||
- Tool zod schemas mirror the backend malli schema (lengths, blank, control characters); keep both in sync. The backend is the authority.
|
|
||||||
- Success means the mail job was queued, not delivered; the tool text says so. `formatArgs` hides the feedback from logs.
|
|
||||||
- Backend side: `send-mcp-feedback` in `app.rpc.commands.feedback`, configured by `PENPOT_MCP_FEEDBACK_EMAIL`; MCP-token auth rules in `mem:backend/auth-permissions-product-domains`.
|
|
||||||
- User docs: `mcp/README.md` (env tables), `docs/mcp/index.md` (tool list), `docs/technical-guide/configuration.md` (MCP feedback section).
|
|
||||||
|
|
||||||
## Devenv plugin/server wiring
|
## Devenv plugin/server wiring
|
||||||
|
|
||||||
In the normal Penpot devenv MCP path, the browser plugin does not discover or route through Postgres. The frontend provides the plugin extension API with `mcp.getServerUrl()`, currently derived from `frontend/src/app/config.cljs` as `penpotMcpServerURI` if set, otherwise `<public-uri>/mcp/ws`. The MCP plugin opens a direct WebSocket to that URL and appends the current MCP access token as a query parameter.
|
In the normal Penpot devenv MCP path, the browser plugin does not discover or route through Postgres. The frontend provides the plugin extension API with `mcp.getServerUrl()`, currently derived from `frontend/src/app/config.cljs` as `penpotMcpServerURI` if set, otherwise `<public-uri>/mcp/ws`. The MCP plugin opens a direct WebSocket to that URL and appends the current MCP access token as a query parameter.
|
||||||
@ -144,15 +94,3 @@ In the normal Penpot devenv MCP path, the browser plugin does not discover or ro
|
|||||||
The live plugin connection registry is in-memory inside each MCP server process (`PluginBridge.connectedClients` / `clientsByToken`). The database only stores MCP access tokens and profile props such as `mcp-enabled`; it does not manage which plugin is connected to which MCP server.
|
The live plugin connection registry is in-memory inside each MCP server process (`PluginBridge.connectedClients` / `clientsByToken`). The database only stores MCP access tokens and profile props such as `mcp-enabled`; it does not manage which plugin is connected to which MCP server.
|
||||||
|
|
||||||
For parallel devenvs, prefer same-origin MCP routing: each Penpot instance should expose `/mcp/ws` through its own nginx/Caddy path to the MCP server running inside the same main container. Keep container-internal ports fixed (MCP defaults `4401/4402/4403`, backend/exporter/frontend defaults, etc.) and only offset host-side published ports per instance. If internal ports are offset, hardcoded local proxy config such as `docker/devenv/files/nginx.conf` will misroute unless templated too.
|
For parallel devenvs, prefer same-origin MCP routing: each Penpot instance should expose `/mcp/ws` through its own nginx/Caddy path to the MCP server running inside the same main container. Keep container-internal ports fixed (MCP defaults `4401/4402/4403`, backend/exporter/frontend defaults, etc.) and only offset host-side published ports per instance. If internal ports are offset, hardcoded local proxy config such as `docker/devenv/files/nginx.conf` will misroute unless templated too.
|
||||||
|
|
||||||
## Plugin reconnect policy
|
|
||||||
|
|
||||||
- The plugin treats WebSocket close code `1008` (policy violation) as terminal: it stops auto-reconnecting and stays disconnected until the user explicitly reconnects. Other close codes keep the capped-backoff retry. The decision lives in `ReconnectPolicy.ts` (`shouldReconnectAfterClose`), kept as a pure module so it is unit-testable without DOM/CSS.
|
|
||||||
- The MCP server emits `1008` for a `Host`/`Origin` outside the `RequestGuard` allowlist, for a missing `userToken` in multi-user mode, for missing/invalid connection metadata, and to close a connection displaced by a newer one with the same user and session ID.
|
|
||||||
- Session IDs are deterministic per tab and file, so a reconnect reuses its ID while the old socket may be half-open: the newest connection wins (`PluginBridge.displaceConnection`). Across instances, each new connection publishes a session claim on a per-user Redis channel; an instance displaces its local connection only on a foreign claim that arrives after its own claim (channel order, no clocks). Discovery deduplicates by session ID.
|
|
||||||
- A tab rejected with `1008` never reaches `connected`, so the frontend's 60s reconnect watcher (`start-reconnect-watcher` in `app.main.data.workspace.mcp`, started only on `connected`) does not engage; recovery is manual via the MCP menu.
|
|
||||||
|
|
||||||
## Rollback warnings
|
|
||||||
|
|
||||||
- `ExecuteCodeTaskHandler` awaits `penpot.waitForSave()` after the code and outside its swallow catch, so a save failure, save timeout or rollback during the wait fails that `execute_code` call itself. It hard-fails as "missing Plugin API support" when `penpot.waitForSave` is absent (old Penpot or stale runtime build, or broken `api.cljs` wiring). Both waits run only when `penpotMgmt.workspace.status` is `"ready"` (or there is no `penpotMgmt`), checked at each wait: dashboard calls skip them, because persistence `:error` outlives the workspace and would fail successful `penpotMgmt` calls. Budget: layout wait 30s before the code + save wait 60s after it, under `PENPOT_MCP_TOOL_TIMEOUT_S` (120s). `RollbackNotices` below only cover rollbacks that land after the call returned (concurrent edits, a response after a timeout).
|
|
||||||
- The plugin's `RollbackLog` (`packages/plugin/src/RollbackLog.ts`) holds the `contentrollback` events not yet sent with a task response; `Task.sendResponse` attaches them and acknowledges them once sent, and the server's `unclaimed-rollbacks` message (a response that came after its task timed out) puts them back. With a `RollbackStore` (`LocalStorageRollbackStore` over `penpot.localStorage`, one entry per file) every change is written through, so a reload of the tab or plugin keeps them; storage failures fall back to memory. Plugin tests run with `node --experimental-strip-types`, which rejects TypeScript parameter properties: declare fields explicitly.
|
|
||||||
|
|||||||
@ -1,47 +0,0 @@
|
|||||||
# MCP OAuth
|
|
||||||
|
|
||||||
## Contract and scope
|
|
||||||
|
|
||||||
- MCP-specific authorization; existing Penpot login identifies the user on the approval page. No application vetting or persistent consent policy. Access requires user approval; registration alone grants nothing.
|
|
||||||
- Return the existing fixed MCP user token. On approval, enable `:mcp-enabled` and create the token only if no usable one exists; preserve an existing usable token. A token is unusable, and replaced, when expired (settings can give MCP tokens an expiry), when its JWT issuer is not `urn:penpot:mcp-token` (tokens issued before MCP tokens had their own issuer), or when this instance cannot decrypt it (e.g. secret key changed); the backend rejects all three. No refresh token, `expires_in`, or new token lifetime.
|
|
||||||
- No new client database table or schema migration. Client IDs must remain usable across separate authorization flows without server-side registration storage. Do not replace them with expiring Redis registrations.
|
|
||||||
- MCP transport continues matching user tokens to connected Penpot plugins; no new per-request token introspection or independent semantic validation. The logged-in Penpot instance remains the content-access boundary. Do not silently add resource-server validation or change token semantics.
|
|
||||||
- README scope: user/developer usage instructions; document `PENPOT_MCP_AUTH_URI` in its environment-variable table. Keep OAuth architecture and protocol details here and non-obvious invariants in source comments.
|
|
||||||
|
|
||||||
## Deployment and discovery
|
|
||||||
|
|
||||||
- MCP process: `PENPOT_MCP_AUTH_URI=https://penpot.example/api/mcp/oauth` with `--multi-user`. Unset/empty disables OAuth; configured OAuth requires multi-user. Absolute HTTPS, or HTTP on loopback for development; no userinfo, query, or fragment. Invalid configuration fails startup; startup logs OAuth status.
|
|
||||||
- Devenv: `mcp/scripts/start-mcp-devenv-oauth` starts multi-user mode with `PENPOT_MCP_AUTH_URI` derived from `PENPOT_PUBLIC_URI`. Manual opt-in only: agentic tooling needs the single-user `start-mcp-devenv`.
|
|
||||||
- Public MCP transport: `<Penpot public URI>/mcp/stream`, proxied to Node `/mcp`. Missing credentials with OAuth enabled: 401 plus `WWW-Authenticate` referencing `<auth base>/resource` and scope `mcp`.
|
|
||||||
- Bearer header takes precedence over legacy `?userToken=`. Malformed headers do not fall back to the query token. Existing query-token clients remain supported.
|
|
||||||
- Protected-resource metadata: `/api/mcp/oauth/resource`; issuer: `/api/mcp/oauth`; authorization-server metadata: `/.well-known/oauth-authorization-server/api/mcp/oauth`. All reach the backend. Bundled devenv/production nginx configs forward the well-known path; custom proxies must do likewise. Keep Penpot public URI and external URLs consistent.
|
|
||||||
- Node implementation: `mcp/packages/server/src/McpAuthentication.ts`, integrated by `PenpotMcpServer.ts`; OAuth-enabled tools advertise `_meta.securitySchemes`.
|
|
||||||
|
|
||||||
## Client identification
|
|
||||||
|
|
||||||
- `backend/src/app/mcp/oauth_clients.clj`: dynamic registration at `/api/mcp/oauth/register`, HTTPS client metadata documents (CIMD), and registrations obtained in advance via `(app.mcp.oauth-clients/register! {} metadata)`.
|
|
||||||
- DCR returns `penpot-mcp-v1.` plus unpadded base64url JSON: normalized callback URLs, optional name, authentication method, random nonce, optional secret hash. Fixed grant/response/scope values are reconstructed. Nonce distinguishes registrations with otherwise identical metadata.
|
|
||||||
- IDs are public, unsigned, unencrypted, non-expiring metadata; validate on every resolution. Client secrets are generated randomly and returned separately; only the hash enters the ID. No signing/encryption key or client record in PostgreSQL/Redis. Old experimental database-backed UUID IDs require registration again.
|
|
||||||
- An edited payload changes the ID. Authorization-code exchange compares the exact ID string against the approved request before resolving metadata. Do not replace this with comparison of decoded fields; code ownership and PKCE binding must survive metadata edits.
|
|
||||||
- Supported authentication: `none`, `client_secret_basic`, `client_secret_post`; no `private_key_jwt`. CIMD selects public-client `none` from the document's supported methods; other listed methods do not imply support here. Scope `mcp`; grant `authorization_code`; response `code`. CIMD may advertise additional grants (e.g. Codex lists `refresh_token`); require `authorization_code` support and normalize to the grant Penpot implements, rather than reject broader client capabilities.
|
|
||||||
- Entire ID capped at 2,048 ASCII characters. DCR returns `invalid_client_metadata` if encoded metadata exceeds this; shorter/fewer callback URLs reduce size. OAuth defines no fixed ID-length maximum (RFC 6749 §2.2); stateless IDs are explicitly described by RFC 7591 §A.5.2. Installed MCP client SDK 2.3.1 accepts a 2,048-character ID; this does not establish Codex/Claude compatibility.
|
|
||||||
- Redirect matching is exact except loopback HTTP port changes for native clients (`127.0.0.1`, `[::1]`, exact `localhost`). Host, path and query must still match; reject fragments/userinfo and lookalike localhost domains. Allow HTTPS, loopback HTTP, and reverse-domain native schemes.
|
|
||||||
- CIMD: fetch with existing SSRF-checked `app.http.client/req`, no redirect following, require matching document `client_id`, bounded 64-KiB body and request/body-read timeouts. Cache max 256 entries/one minute, further limited by HTTP max-age; no-store/no-cache/no max-age means no reuse.
|
|
||||||
|
|
||||||
## Approval and exchange
|
|
||||||
|
|
||||||
- `backend/src/app/http/mcp_oauth.clj`: separate router branch from ordinary RPC middleware; preserve OAuth snake_case JSON and form encoding. Session auth applies to approval request/decision only. Public metadata/register/token endpoints allow noncredentialed CORS; MCP transport CORS was not added.
|
|
||||||
- Errors: every failure answers with an OAuth `{"error": ...}` body, never the shared Penpot error shape. Failures without `:oauth-error` are also passed to `app.http.errors/handle` for logging only; its response is discarded. `wrap-errors` also wraps the session middleware of `/request` and `/decision`. Safe to log because these routes never set request `:params`.
|
|
||||||
- `/authorize`: validate client/callback, `code`, PKCE S256, scope/resource/state; store pending request for 600 seconds; redirect to `?screen=mcp-authorize&request=<opaque handle>`.
|
|
||||||
- `frontend/src/app/main/ui/mcp_authorize.cljs`: existing login with return URL; show application and account details; submit explicit Allow/Cancel. No fixed MCP token in frontend state or browser redirect. Approval refreshes profile and broadcasts MCP enablement; does not connect a plugin automatically.
|
|
||||||
- `/request`: first authenticated read binds request to profile plus hashed login-session ID and CSRF value, using compare-and-replace. Re-read after the attempt: concurrent GETs may win/lose binding; only the matching session may proceed.
|
|
||||||
- `/decision`: check exact Origin, session binding and CSRF, then atomically consume the request. Denial creates no token/enables nothing. Approval calls transactional `access-token/ensure-mcp-access!`, then stores code for 120 seconds. Code state holds token row ID, never the fixed token. Callback echoes OAuth `state` and RFC 9207 `iss`.
|
|
||||||
- `/token`: validate grant, exact client ID/callback/resource and PKCE; resolve current client metadata/authentication method and verify any secret; atomically consume validated code; fetch the unexpired token by original row ID/profile/type. Regeneration deletes the old token row, so a pending code cannot silently yield the replacement token. Return fixed `access_token`, `token_type: Bearer`, scope `mcp`.
|
|
||||||
- `backend/src/app/mcp/oauth_state.clj` and Lua: tenant/kind/hash-prefixed keys; random handles; SET NX EX must succeed before returning handle. Reads retain raw JSON for atomic comparison. Consume/delete and bind/replace compare the validated raw record in Lua; replacement preserves TTL. Redis failures fail closed. Backend Redis is required independently of Node's optional Redis plugin bridge.
|
|
||||||
- `backend/src/app/rpc/commands/access_token.clj`: `ensure-mcp-access!` decodes the stored token with `ex/ignoring` to apply the usable-token rule above. Lock profile row in both MCP generation and OAuth provisioning, including when no token exists. Serializes simultaneous approvals and settings regeneration. Provisioning must run within a transaction.
|
|
||||||
|
|
||||||
## Verification and limits
|
|
||||||
|
|
||||||
- Tests: `mcp_oauth_clients_test.clj`, `mcp_oauth_http_test.clj`, `mcp_oauth_state_test.clj`, OAuth provisioning in `rpc_access_tokens_test.clj`; MCP authentication/HTTP tests; frontend approval tests. Cover no-storage registration, size boundaries, edited-ID rejection, code replay/concurrency, session/CSRF binding, and fixed-token reuse.
|
|
||||||
- Live OpenAI/Codex/Claude compatibility and marketplace acceptance remain unverified. In particular, verify token persistence without `expires_in` and acceptance of the existing matching-only resource boundary; do not claim protocol conformance from SDK tests alone.
|
|
||||||
- Protocol references: https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 ; https://www.rfc-editor.org/rfc/rfc7591.html#appendix-A.5.2 ; https://www.rfc-editor.org/rfc/rfc7636.html ; https://www.rfc-editor.org/rfc/rfc9207.html .
|
|
||||||
@ -26,7 +26,6 @@ No manual line wrapping: one line per bullet or paragraph, however long. Memorie
|
|||||||
## Add/update threshold
|
## Add/update threshold
|
||||||
|
|
||||||
Add or update memories only with stable, non-obvious project conventions that avoid complex rediscovery in the future.
|
Add or update memories only with stable, non-obvious project conventions that avoid complex rediscovery in the future.
|
||||||
Do not restate what the code already says (comments included): keep only what code cannot represent — decisions and their reasons, cross-file invariants, ordering constraints, environment and tool behavior, and traps that break builds.
|
|
||||||
Do not add: quick-read facts; generic language/framework knowledge; one-off task notes; volatile line-level details; behavior likely to change soon.
|
Do not add: quick-read facts; generic language/framework knowledge; one-off task notes; volatile line-level details; behavior likely to change soon.
|
||||||
|
|
||||||
## Maintenance Actions
|
## Maintenance Actions
|
||||||
|
|||||||
@ -18,7 +18,6 @@
|
|||||||
|
|
||||||
## Sandbox and global cleanup
|
## Sandbox and global cleanup
|
||||||
|
|
||||||
- `src/index.ts` calls `bootstrapSES()` (in `src/lib/bootstrap.ts`) at module load. If `repairIntrinsics` throws (e.g. SES 2.2+ rejects a `Temporal` wrapped by a browser extension), the error is caught, `getPluginsRuntimeError()` exposes it, and `initPluginsRuntime` installs no `ɵ*` globals: the frontend app still boots, plugins and MCP are unavailable in that environment. On failure, `Function.prototype.toString` has already been replaced but no intrinsics are hardened and no compartment/sandbox is created — never run plugins on that path.
|
|
||||||
- The runtime uses SES compartments. Public API return values are passed through `ses.safeReturn` before crossing back to plugin code.
|
- The runtime uses SES compartments. Public API return values are passed through `ses.safeReturn` before crossing back to plugin code.
|
||||||
- Plugin `fetch` is sanitized: credentials are omitted and Authorization is blanked. The exposed response only includes ok/status/statusText/url/text/json.
|
- Plugin `fetch` is sanitized: credentials are omitted and Authorization is blanked. The exposed response only includes ok/status/statusText/url/text/json.
|
||||||
- Timer callbacks are wrapped to mark plugin-originated errors, and timeout/interval IDs are tracked so plugin close can clear them.
|
- Timer callbacks are wrapped to mark plugin-originated errors, and timeout/interval IDs are tracked so plugin close can clear them.
|
||||||
@ -27,7 +26,7 @@
|
|||||||
|
|
||||||
## Lifecycle
|
## Lifecycle
|
||||||
|
|
||||||
- Loading a plugin closes existing non-background plugins and removes them from the runtime registry. Background plugins (`allowBackground`) keep running and must stay registered: the registry routes their UI `postMessage` traffic by sender iframe and is what `ɵunloadPlugin` searches.
|
- Loading a plugin closes existing non-background plugins and resets the runtime registry. Be careful around `allowBackground` semantics when changing load/close behavior.
|
||||||
- If sandbox evaluation fails, the runtime marks the error as plugin-originated, closes the plugin, and rethrows.
|
- If sandbox evaluation fails, the runtime marks the error as plugin-originated, closes the plugin, and rethrows.
|
||||||
- `plugin-manager` removes event listeners, timers, intervals, and modal state on close, and marks the plugin destroyed. Listener callbacks check that flag because Penpot events can fire after close.
|
- `plugin-manager` removes event listeners, timers, intervals, and modal state on close, and marks the plugin destroyed. Listener callbacks check that flag because Penpot events can fire after close.
|
||||||
|
|
||||||
|
|||||||
@ -4,36 +4,32 @@ Backend (`app.config`, `PENPOT_*` env vars) is parameterized; deployments choose
|
|||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
- **PostgreSQL**: durable store. Profiles, teams, files, sessions, audit, `storage_object` metadata, the `job` work queue (plus the dormant legacy `task` table), `scheduled_task` cron registry, migrations. File-data also lives here when the file-data backend is `legacy-db`/`db`. One shared DB across all backends.
|
- **PostgreSQL**: durable store. Profiles, teams, files, sessions, audit, `storage_object` metadata, the `task` queue, `scheduled_task` cron registry, migrations. File-data also lives here when the file-data backend is `legacy-db`/`db`. One shared DB across all backends.
|
||||||
- **Redis (Valkey-compatible)**: per-backend message bus and cache. Concrete uses: msgbus Pub/Sub for collaborative-editing broadcasts and team/profile-org notifications fired by RPC handlers (`app.rpc.notifications`, `files_update`, `teams`, `websocket`); file-summary cache gated by `enable-redis-cache`; rate-limit counters; and the dispatcher→runner work hand-off list `penpot.worker.queue:<tenant>:<queue>`. `PENPOT_REDIS_URI`. A burst of client-side `RedisCommandTimeoutException` (2s on `DEL`/`SET`, 10s on `BLPOP`) with the exporter healthy is the JVM paused or starved, not Redis: the timeout fires because nothing reads the reply.
|
- **Redis (Valkey-compatible)**: per-backend message bus and cache. Concrete uses: msgbus Pub/Sub for collaborative-editing broadcasts and team/profile-org notifications fired by RPC handlers (`app.rpc.notifications`, `files_update`, `teams`, `websocket`); file-summary cache gated by `enable-redis-cache`; rate-limit counters; and the dispatcher→runner work hand-off list `penpot.worker.queue:<tenant>:<queue>`. `PENPOT_REDIS_URI`. A burst of client-side `RedisCommandTimeoutException` (2s on `DEL`/`SET`, 10s on `BLPOP`) with the exporter healthy is the JVM paused or starved, not Redis: the timeout fires because nothing reads the reply.
|
||||||
- **Object storage**: backends `:s3` and `:fs`. S3 in prod; devenv uses RustFS. Holds uploaded media, file-data when the file-data backend is `storage`, exports. Backend-side details (resolve, dedup, bucket set, object lifecycle, and file-data backends): `mem:backend/storage`.
|
- **Object storage**: backends `:s3` and `:fs`. S3 in prod; devenv uses RustFS. Holds uploaded media, file-data when the file-data backend is `storage`, exports. Backend-side details (resolve, dedup, bucket set, object lifecycle, and file-data backends): `mem:backend/storage`.
|
||||||
- **SMTP mailer**: invitations, password resets, email verification (sent via the `:sendmail` worker job).
|
- **SMTP mailer**: invitations, password resets, email verification (sent via the `:sendmail` worker task).
|
||||||
- **LDAP** (optional auth provider): helpers in `app.auth.*`, gated by `enable-login-with-ldap`.
|
- **LDAP** (optional auth provider): helpers in `app.auth.*`, gated by `enable-login-with-ldap`.
|
||||||
|
|
||||||
## Task queue and worker model
|
## Task queue and worker model
|
||||||
|
|
||||||
Async jobs are enqueued via `jobs/submit` (`app.jobs`), which inserts a row into the shared Postgres `job` table tagged with `queue = "<tenant>:<queue-name>"`. Submission is **fire-and-forget** — RPC handlers never poll and never wait. The completion signal is the `job` row's `status` / `completed_at` columns, which the creation commands read back to answer with the state of the job they just created. A job submitted with `::jobs/profile-id` also publishes a `:job-event` message on that profile's msgbus topic after each transaction commits, and the binfile commands (`create-export-binfile-job`, `create-import-binfile-job`) are the callers that pass that owner, so the progress of their jobs does reach the msgbus. Soft-delete RPCs return immediately after marking the top-level row, leaving the cascade and reaping to workers.
|
Async tasks are enqueued via `wrk/submit!` (`app.worker`), which inserts a row into the shared Postgres `task` table tagged with `queue = "<tenant>:<queue-name>"`. Submission is **fire-and-forget** — RPC handlers never poll, never wait, and workers never publish to msgbus. The only completion signal is the `task` row's `status` / `completed_at` columns, which nothing in `rpc/` reads. Soft-delete RPCs return immediately after marking the top-level row, leaving the cascade and reaping to workers.
|
||||||
|
|
||||||
Workers run on backends with `enable-backend-worker` in `PENPOT_FLAGS`. Each worker-enabled backend has a `dispatcher` (polls `job` with `FOR UPDATE SKIP LOCKED`, marks status='scheduled', RPUSHes the JSON `[id scheduled-at]` payloads into **its own** Redis list) and one or more `runner`s per queue (BLPOP from that same local list, execute, update the Postgres row). The Redis hand-off list is purely intra-backend — cross-backend coordination happens at the Postgres row level. The queues are `default`, `webhooks`, `cron` and `binfile`: the last one carries the heavy work of a user job (`:worker-binfile-parallelism`, default 1), so a long export or import does not block the default runner.
|
Workers run on backends with `enable-backend-worker` in `PENPOT_FLAGS`. Each worker-enabled backend has a `dispatcher` (polls `task` with `FOR UPDATE SKIP LOCKED`, marks status='scheduled', RPUSHes claimed task IDs into **its own** Redis list) and one or more `runner`s per queue (BLPOP from that same local list, execute, update the Postgres row). The Redis hand-off list is purely intra-backend — cross-backend coordination happens at the Postgres row level.
|
||||||
|
|
||||||
## Cross-backend safety
|
## Cross-backend safety
|
||||||
|
|
||||||
Postgres row locking is the only correctness primitive: `job` claims via `FOR UPDATE SKIP LOCKED`, cron firing via `FOR UPDATE SKIP LOCKED` on the `scheduled_task` row, plus job-handler-internal locks (e.g. `file_gc_scheduler` locks candidate file rows). This makes the work-claim path safe across any number of worker-enabled backends.
|
Postgres row locking is the only correctness primitive: `task` claims via `FOR UPDATE SKIP LOCKED`, cron firing via `FOR UPDATE SKIP LOCKED` on the `scheduled_task` row, plus task-handler-internal locks (e.g. `file_gc_scheduler` locks candidate file rows). This makes the work-claim path safe across any number of worker-enabled backends.
|
||||||
|
|
||||||
Two known race patterns survive multi-backend operation:
|
Two known race patterns survive multi-backend operation:
|
||||||
|
|
||||||
- **Cron dedup is best-effort.** The lock on `scheduled_task` is released when the task body finishes. If two backends' cron timers fire for the same scheduled instant with a gap larger than the task body's runtime, both execute it. Penpot's cron entries are idempotent (`session-gc`, `objects-gc`, `storage-gc-*`, `storage-pending-gc`, `jobs-gc`, `file-gc-scheduler`); the exceptions are `:telemetry` (would double-report) and `:audit-log-consumer-nexus` / `:audit-log-consumer-admin-console` (depend on archive target idempotency).
|
- **Cron dedup is best-effort.** The lock on `scheduled_task` is released when the task body finishes. If two backends' cron timers fire for the same scheduled instant with a gap larger than the task body's runtime, both execute it. Penpot's cron entries are idempotent (`session-gc`, `objects-gc`, `storage-gc-*`, `tasks-gc`, `upload-session-gc`, `file-gc-scheduler`); the exceptions are `:telemetry` (would double-report) and `:audit-log-archive` (depends on archive target idempotency).
|
||||||
- **`jobs/submit ::dedupe true`** does a non-atomic `DELETE` then `INSERT`. Concurrent cross-backend submits can both bypass the `DELETE` (each sees the other's uncommitted insert as absent) and end up with duplicate `'new'` rows. Each row claims and runs once independently, so the underlying work is fine; the "at most one pending" guarantee weakens.
|
- **`wrk/submit! ::dedupe true`** does a non-atomic `DELETE` then `INSERT`. Concurrent cross-backend submits can both bypass the `DELETE` (each sees the other's uncommitted insert as absent) and end up with duplicate `'new'` rows. Each row claims and runs once independently, so the underlying work is fine; the "at most one pending" guarantee weakens.
|
||||||
|
|
||||||
Penpot in production lives with both: horizontal-scale deployments accept "exactly-once" as "essentially-once for idempotent operations." Devenv parallel instances handle it by running workers only on ws0 (see `mem:devenv/core`).
|
Penpot in production lives with both: horizontal-scale deployments accept "exactly-once" as "essentially-once for idempotent operations." Devenv parallel instances handle it by running workers only on ws0 (see `mem:devenv/core`).
|
||||||
|
|
||||||
## Jobs observability
|
|
||||||
|
|
||||||
Worker-enabled, writable backends publish unified jobs metrics through the normal Prometheus registry. Counters describe submit, dispatch, terminal outcomes, retries, orphan recovery, rescheduling and total stored job events (unlabelled); histograms separate queue wait, handler execution and total job age. SQL-backed events are recorded after the outer PostgreSQL transaction commits. The `::jobs-metrics/sampler` component publishes backlog by status and the oldest pending-job age every 30 seconds. All labels are bounded operational values; job IDs, profile IDs, params and error text are excluded. Read-only backends do not start the sampler or the workers.
|
|
||||||
|
|
||||||
## Draining one instance
|
## Draining one instance
|
||||||
|
|
||||||
Each backend has a per-process availability flag (`app.health`, a global atom). While offline, `/readyz` answers `503 OFFLINE` without querying the database, so the load balancer removes that instance from rotation while requests in flight still finish. Operator surface: `app.srepl.main/set-offline` / `set-online`; a restart comes back online. In-flight worker jobs are safe: jobs claimed as `scheduled` return to `new` after 5 minutes via `sql:reschedule-lost` and another instance picks them up.
|
Each backend has a per-process availability flag (`app.health`, a global atom). While offline, `/readyz` answers `503 OFFLINE` without querying the database, so the load balancer removes that instance from rotation while requests in flight still finish. Operator surface: `app.srepl.main/set-offline` / `set-online`; a restart comes back online. In-flight worker tasks are safe: tasks claimed as `scheduled` return to `new` after 5 minutes via `sql:reschedule-lost` and another instance picks them up.
|
||||||
|
|
||||||
## Touching production data
|
## Touching production data
|
||||||
|
|
||||||
@ -43,13 +39,7 @@ Production runs the deployed toolbox, not the devenv one:
|
|||||||
- **Start from the ids, not from an inventory.** The ids come from the error or the logs. Unbounded queries over tables with tens of millions of rows (`storage_object`, `file_media_object`) do not finish in a reasonable time; bounded to an id list they are index lookups.
|
- **Start from the ids, not from an inventory.** The ids come from the error or the logs. Unbounded queries over tables with tens of millions of rows (`storage_object`, `file_media_object`) do not finish in a reasonable time; bounded to an id list they are index lookups.
|
||||||
- **One query per reference column.** Two columns in one `IN (col_a, col_b)` lose the index and scan the whole table; split them.
|
- **One query per reference column.** Two columns in one `IN (col_a, col_b)` lose the index and scan the whole table; split them.
|
||||||
- The read-only replica cuts long queries: see `mem:prod-infra/grafana`.
|
- The read-only replica cuts long queries: see `mem:prod-infra/grafana`.
|
||||||
- A migration that builds an index runs inside the migration transaction, so it cannot use `CONCURRENTLY`, and a plain `CREATE INDEX` locks the table against writes for the whole build. On a large table build the index out of band, before deploying, with `CREATE INDEX CONCURRENTLY` on its own (never inside a transaction block). A concurrent build interrupted midway leaves the index invalid: drop it and retry (check `pg_index` and `pg_index.indisvalid`).
|
- A migration that builds an index runs inside the migration transaction, so it cannot use `CONCURRENTLY`, and a plain `CREATE INDEX` locks the table against writes for the whole build. On a large table (file saves write to `file_change` on every save) build the index out of band, before deploying, with `CREATE INDEX CONCURRENTLY` on its own (never inside a transaction block); the shipped migration uses `IF NOT EXISTS`, finds it and does nothing. A concurrent build interrupted midway leaves the index invalid: drop it and retry (check `pg_indexes` and `pg_index.indisvalid`).
|
||||||
- A partitioned parent cannot take `CREATE INDEX CONCURRENTLY` (`cannot create index on partitioned table ... concurrently`). Build one index per partition with `CONCURRENTLY`, then `CREATE INDEX ... ON ONLY` on the parent and `ALTER INDEX ... ATTACH PARTITION` for each child; the parent index only becomes valid when every partition is attached.
|
|
||||||
- Write the migration as plain, idempotent SQL: `ADD COLUMN IF NOT EXISTS`, `CREATE INDEX IF NOT EXISTS`, and `DROP CONSTRAINT IF EXISTS` followed by `ADD CONSTRAINT`. Do not encode shape checks as `pg_catalog` introspection: they are easy to get wrong (a missing `NOT condeferred` accepts an `INITIALLY DEFERRED` foreign key) and they duplicate what the runbook verifies by hand. `IF NOT EXISTS` matches the name, not the definition, so the out-of-band procedure verifies the index shape and completeness.
|
|
||||||
- The runbook is the contract for a large instance: it builds and verifies the out-of-band work and then marks the migration step as applied (`INSERT INTO migrations (module, step) ...`), so the body does not run at startup. Verify the column, the pending rows, the index (valid, no predicate or expression, every partition attached) and the constraint shape before inserting the row; the marker is the only thing that skips the migration.
|
|
||||||
- A reference that a GC task resolves must be `DEFERRABLE INITIALLY IMMEDIATE`, never `INITIALLY DEFERRED`: the immediate check fires inside the transaction that catches the violation and retries the chunk; the deferred one fires at commit, outside the catch. A validated foreign key belongs out of band: `ADD FOREIGN KEY` runs as an `ALTER TABLE` and it scans the whole referencing table; `NOT VALID` on a partitioned table only exists since PostgreSQL 18.
|
|
||||||
- A backfill that removes a key an old reader uses (for example `metadata.storage-ref-id`, which the previous storage GC scans) must run with the old code stopped. Otherwise the old reader loses the reference and can delete a live object, and the rows it writes in the meantime miss the backfill.
|
|
||||||
- `ADD COLUMN` takes a brief `ACCESS EXCLUSIVE` even when `IF NOT EXISTS` skips it, and `ADD FOREIGN KEY` takes `ACCESS EXCLUSIVE` on the referencing table and `SHARE ROW EXCLUSIVE` on the referenced one. A migration accepts those locks; a deployment that cannot take them runs the runbook and marks the step as applied.
|
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
|
|||||||
@ -20,24 +20,16 @@
|
|||||||
|
|
||||||
`./build` sources `_build_env`, which sets the Emscripten paths and `EMCC_CFLAGS`. The WASM heap starts at 256 MB and uses geometric growth.
|
`./build` sources `_build_env`, which sets the Emscripten paths and `EMCC_CFLAGS`. The WASM heap starts at 256 MB and uses geometric growth.
|
||||||
|
|
||||||
- Linux builds require `flock` (util-linux).
|
Build output is gitignored and stays untracked everywhere it lands: `frontend/resources/public/js/render-wasm.{js,wasm}` and `frontend/src/app/render_wasm/api/shared.js` from `./build`, plus `exporter/resources/wasm/render-wasm.{js,wasm}` and `exporter/src/app/wasm/shared.js`. Never commit generated JS/WASM; rebuild instead.
|
||||||
- `build`, target cleanup, and each watch rebuild share `render-wasm/.render-wasm-build.lock` per checkout. The dispatcher for both targets does not hold the lock in its parent process.
|
|
||||||
- The lock covers setup, Cargo build, and artifact copy. The watch process releases it while waiting for changes. The operating system releases it on success, error, or signal; the file remains.
|
|
||||||
- The lock only coordinates repository scripts. Manual Cargo commands do not take it.
|
|
||||||
- Set `RENDER_WASM_LOCK_FILE` to the same path only when separate checkouts intentionally share a `CARGO_TARGET_DIR`.
|
|
||||||
- Build output is gitignored and stays untracked everywhere it lands: `frontend/resources/public/js/render-wasm.{js,wasm}` and `frontend/src/app/render_wasm/api/shared.js` from `./build`, plus `exporter/resources/wasm/render-wasm.{js,wasm}` and `exporter/src/app/wasm/shared.js`. Never commit generated JS/WASM; rebuild instead.
|
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
From `render-wasm/`:
|
From `render-wasm/`:
|
||||||
- Build/copy frontend artifacts: `./build [frontend|export]`; no target builds frontend, then export.
|
- Build/copy frontend artifacts: `./build`.
|
||||||
- Clean one target: `./clean [frontend|export]`; never run root `cargo clean` on the shared `target/`.
|
- Watch rebuild: `./watch`.
|
||||||
- Watch rebuild: `./watch [frontend|export]`; its initial and change-triggered builds use `./build`.
|
|
||||||
- Rust tests: `./test` or `cargo test <name>`.
|
- Rust tests: `./test` or `cargo test <name>`.
|
||||||
- Rust coverage: `RENDER_WASM_COVERAGE=1 ./test` runs the same tests under `cargo llvm-cov` (needs `cargo-llvm-cov` on PATH; the script adds `llvm-tools-preview`) and writes `target/coverage/` (`lcov.info` with absolute paths, `summary.json` llvm export totals, `html/`). Native build only: code behind wasm-only `cfg` is not measured. `tests-wasm.yml` downloads a pinned, checksum-verified `cargo-llvm-cov` release because the devenv image lacks it.
|
|
||||||
- Cross-cutting testing principles and anti-patterns: `mem:testing`.
|
- Cross-cutting testing principles and anti-patterns: `mem:testing`.
|
||||||
- Lint: `./lint`.
|
- Lint: `./lint`.
|
||||||
- Format: `./fmt`; check only: `./fmt --check`.
|
- Format check: `cargo fmt --check`.
|
||||||
- `./build`, `./test`, `./lint` and `./fmt` all run `setup`, which selects the Rust version pinned in `_build_env` (skip with `PENPOT_WASM_PREPARED=1`).
|
|
||||||
|
|
||||||
Do not change exported WASM function signatures without updating the corresponding frontend bridge and verifying the frontend renderer path.
|
Do not change exported WASM function signatures without updating the corresponding frontend bridge and verifying the frontend renderer path.
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user