From 1fe9530f610e9ff91dc17c6b20efd4ce2d73ab4d Mon Sep 17 00:00:00 2001 From: regeloapp-coder Date: Mon, 26 Oct 2026 09:15:19 +0100 Subject: [PATCH 1/3] Add Supabase agent skills Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../CHANGELOG.md | 73 ++++++++ .../supabase-postgres-best-practices/SKILL.md | 64 +++++++ .../references/_contributing.md | 170 ++++++++++++++++++ .../references/_sections.md | 39 ++++ .../references/_template.md | 34 ++++ .../references/advanced-full-text-search.md | 55 ++++++ .../references/advanced-jsonb-indexing.md | 49 +++++ .../references/conn-idle-timeout.md | 46 +++++ .../references/conn-limits.md | 44 +++++ .../references/conn-pooling.md | 41 +++++ .../references/conn-prepared-statements.md | 46 +++++ .../references/data-batch-inserts.md | 54 ++++++ .../references/data-n-plus-one.md | 53 ++++++ .../references/data-pagination.md | 50 ++++++ .../references/data-upsert.md | 50 ++++++ .../references/lock-advisory.md | 56 ++++++ .../references/lock-deadlock-prevention.md | 68 +++++++ .../references/lock-short-transactions.md | 50 ++++++ .../references/lock-skip-locked.md | 54 ++++++ .../references/monitor-explain-analyze.md | 45 +++++ .../references/monitor-pg-stat-statements.md | 55 ++++++ .../references/monitor-vacuum-analyze.md | 55 ++++++ .../references/query-composite-indexes.md | 44 +++++ .../references/query-covering-indexes.md | 40 +++++ .../references/query-index-types.md | 48 +++++ .../references/query-missing-indexes.md | 43 +++++ .../references/query-partial-indexes.md | 45 +++++ .../references/schema-constraints.md | 80 +++++++++ .../references/schema-data-types.md | 46 +++++ .../references/schema-foreign-key-indexes.md | 59 ++++++ .../schema-lowercase-identifiers.md | 55 ++++++ .../references/schema-partitioning.md | 55 ++++++ .../references/schema-primary-keys.md | 61 +++++++ .../references/security-privileges.md | 54 ++++++ .../references/security-rls-basics.md | 50 ++++++ .../references/security-rls-performance.md | 63 +++++++ .agents/skills/supabase/CHANGELOG.md | 97 ++++++++++ .agents/skills/supabase/SKILL.md | 155 ++++++++++++++++ .../assets/feedback-issue-template.md | 17 ++ .../supabase/references/skill-feedback.md | 17 ++ skills-lock.json | 17 ++ 41 files changed, 2297 insertions(+) create mode 100644 .agents/skills/supabase-postgres-best-practices/CHANGELOG.md create mode 100644 .agents/skills/supabase-postgres-best-practices/SKILL.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/_contributing.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/_sections.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/_template.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/conn-limits.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/conn-pooling.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/data-batch-inserts.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/data-n-plus-one.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/data-pagination.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/data-upsert.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/lock-advisory.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/lock-short-transactions.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/lock-skip-locked.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/query-composite-indexes.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/query-covering-indexes.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/query-index-types.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/query-missing-indexes.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/query-partial-indexes.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-constraints.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-data-types.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-partitioning.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/schema-primary-keys.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/security-privileges.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/security-rls-basics.md create mode 100644 .agents/skills/supabase-postgres-best-practices/references/security-rls-performance.md create mode 100644 .agents/skills/supabase/CHANGELOG.md create mode 100644 .agents/skills/supabase/SKILL.md create mode 100644 .agents/skills/supabase/assets/feedback-issue-template.md create mode 100644 .agents/skills/supabase/references/skill-feedback.md create mode 100644 skills-lock.json diff --git a/.agents/skills/supabase-postgres-best-practices/CHANGELOG.md b/.agents/skills/supabase-postgres-best-practices/CHANGELOG.md new file mode 100644 index 0000000..6d7d0d2 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/CHANGELOG.md @@ -0,0 +1,73 @@ +# Changelog + +## [1.6.0](https://github.com/supabase/agent-skills/compare/supabase-postgres-best-practices-v1.5.0...supabase-postgres-best-practices-v1.6.0) (2026-07-30) + + +### Features + +* add schema-constraints reference for safe migration patterns ([#30](https://github.com/supabase/agent-skills/issues/30)) ([9b236f3](https://github.com/supabase/agent-skills/commit/9b236f3ebd65d76a2c570f19931353da9c858d5a)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* correct broken reference link in postgres best practices skill ([#58](https://github.com/supabase/agent-skills/issues/58)) ([f4e2277](https://github.com/supabase/agent-skills/commit/f4e22777fd8573537297b568c16e5a45a25927da)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* **supabase-postgres-best-practices:** make skill description trigger-rich ([#194](https://github.com/supabase/agent-skills/issues/194)) ([3291216](https://github.com/supabase/agent-skills/commit/32912161e2732c3e5001c6811a76c1f8308ed0da)) + +## [1.5.0](https://github.com/supabase/agent-skills/compare/supabase-postgres-best-practices-v1.4.0...supabase-postgres-best-practices-v1.5.0) (2026-07-30) + + +### Features + +* add schema-constraints reference for safe migration patterns ([#30](https://github.com/supabase/agent-skills/issues/30)) ([9b236f3](https://github.com/supabase/agent-skills/commit/9b236f3ebd65d76a2c570f19931353da9c858d5a)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* correct broken reference link in postgres best practices skill ([#58](https://github.com/supabase/agent-skills/issues/58)) ([f4e2277](https://github.com/supabase/agent-skills/commit/f4e22777fd8573537297b568c16e5a45a25927da)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* **supabase-postgres-best-practices:** make skill description trigger-rich ([#194](https://github.com/supabase/agent-skills/issues/194)) ([3291216](https://github.com/supabase/agent-skills/commit/32912161e2732c3e5001c6811a76c1f8308ed0da)) + +## [1.4.0](https://github.com/supabase/agent-skills/compare/v1.3.0...v1.4.0) (2026-07-10) + + +### Features + +* add schema-constraints reference for safe migration patterns ([#30](https://github.com/supabase/agent-skills/issues/30)) ([9b236f3](https://github.com/supabase/agent-skills/commit/9b236f3ebd65d76a2c570f19931353da9c858d5a)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* correct broken reference link in postgres best practices skill ([#58](https://github.com/supabase/agent-skills/issues/58)) ([f4e2277](https://github.com/supabase/agent-skills/commit/f4e22777fd8573537297b568c16e5a45a25927da)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) + +## [1.3.0](https://github.com/supabase/agent-skills/compare/v1.2.0...v1.3.0) (2026-06-05) + + +### Features + +* add schema-constraints reference for safe migration patterns ([#30](https://github.com/supabase/agent-skills/issues/30)) ([9b236f3](https://github.com/supabase/agent-skills/commit/9b236f3ebd65d76a2c570f19931353da9c858d5a)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* correct broken reference link in postgres best practices skill ([#58](https://github.com/supabase/agent-skills/issues/58)) ([f4e2277](https://github.com/supabase/agent-skills/commit/f4e22777fd8573537297b568c16e5a45a25927da)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) + +## [1.2.0](https://github.com/supabase/agent-skills/compare/v1.1.1...v1.2.0) (2026-06-02) + + +### Features + +* add schema-constraints reference for safe migration patterns ([#30](https://github.com/supabase/agent-skills/issues/30)) ([9b236f3](https://github.com/supabase/agent-skills/commit/9b236f3ebd65d76a2c570f19931353da9c858d5a)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* correct broken reference link in postgres best practices skill ([#58](https://github.com/supabase/agent-skills/issues/58)) ([f4e2277](https://github.com/supabase/agent-skills/commit/f4e22777fd8573537297b568c16e5a45a25927da)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) diff --git a/.agents/skills/supabase-postgres-best-practices/SKILL.md b/.agents/skills/supabase-postgres-best-practices/SKILL.md new file mode 100644 index 0000000..6400792 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/SKILL.md @@ -0,0 +1,64 @@ +--- +name: supabase-postgres-best-practices +description: "Postgres best practices maintained by Supabase, for Postgres running anywhere. Load this skill BEFORE writing or changing anything that lives in a Postgres database: creating or altering tables and columns (including choosing column types), schema design, migrations and declarative schema files, RLS policies and the tests that verify them, indexes, triggers, database functions, queues and scheduled jobs (pg_cron, pgmq), vector/semantic search (pgvector), and restoring dumps (pg_restore) or importing data. Also load it when diagnosing slow queries, high CPU, timeouts, EXPLAIN plans, connection exhaustion, locking, bloat, or rows visible to the wrong user or tenant. This is not just a performance guide — schema, migration, security, and SQL authoring tasks need these rules too, even for a one-column change or a single query." +license: MIT +metadata: + author: supabase + version: "1.1.1" + organization: Supabase + date: January 2026 + abstract: Comprehensive Postgres performance optimization guide for developers using Supabase and Postgres. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation. +--- + +# Supabase Postgres Best Practices + +Comprehensive performance optimization guide for Postgres, maintained by Supabase. Contains rules across 8 categories, prioritized by impact to guide automated query optimization and schema design. + +## When to Apply + +Reference these guidelines when: +- Writing SQL queries or designing schemas +- Implementing indexes or query optimization +- Reviewing database performance issues +- Configuring connection pooling or scaling +- Optimizing for Postgres-specific features +- Working with Row-Level Security (RLS) + +## Rule Categories by Priority + +| Priority | Category | Impact | Prefix | +|----------|----------|--------|--------| +| 1 | Query Performance | CRITICAL | `query-` | +| 2 | Connection Management | CRITICAL | `conn-` | +| 3 | Security & RLS | CRITICAL | `security-` | +| 4 | Schema Design | HIGH | `schema-` | +| 5 | Concurrency & Locking | MEDIUM-HIGH | `lock-` | +| 6 | Data Access Patterns | MEDIUM | `data-` | +| 7 | Monitoring & Diagnostics | LOW-MEDIUM | `monitor-` | +| 8 | Advanced Features | LOW | `advanced-` | + +## How to Use + +Read individual rule files for detailed explanations and SQL examples: + +``` +references/query-missing-indexes.md +references/query-partial-indexes.md +references/_sections.md +``` + +Each rule file contains: +- Brief explanation of why it matters +- Incorrect SQL example with explanation +- Correct SQL example with explanation +- Optional EXPLAIN output or metrics +- Additional context and references +- Supabase-specific notes (when applicable) + +## References + +- https://www.postgresql.org/docs/current/ +- https://supabase.com/docs +- https://wiki.postgresql.org/wiki/Performance_Optimization +- https://supabase.com/docs/guides/database/overview +- https://supabase.com/docs/guides/auth/row-level-security diff --git a/.agents/skills/supabase-postgres-best-practices/references/_contributing.md b/.agents/skills/supabase-postgres-best-practices/references/_contributing.md new file mode 100644 index 0000000..1c055af --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/_contributing.md @@ -0,0 +1,170 @@ +# Writing Guidelines for Postgres References + +This document provides guidelines for creating effective Postgres best +practice references that work well with AI agents and LLMs. + +## Key Principles + +### 1. Concrete Transformation Patterns + +Show exact SQL rewrites. Avoid philosophical advice. + +**Good:** "Use `WHERE id = ANY(ARRAY[...])` instead of +`WHERE id IN (SELECT ...)`" **Bad:** "Design good schemas" + +### 2. Error-First Structure + +Always show the problematic pattern first, then the solution. This trains agents +to recognize anti-patterns. + +```markdown +**Incorrect (sequential queries):** [bad example] + +**Correct (batched query):** [good example] +``` + +### 3. Quantified Impact + +Include specific metrics. Helps agents prioritize fixes. + +**Good:** "10x faster queries", "50% smaller index", "Eliminates N+1" +**Bad:** "Faster", "Better", "More efficient" + +### 4. Self-Contained Examples + +Examples should be complete and runnable (or close to it). Include `CREATE TABLE` +if context is needed. + +```sql +-- Include table definition when needed for clarity +CREATE TABLE users ( + id bigint PRIMARY KEY, + email text NOT NULL, + deleted_at timestamptz +); + +-- Now show the index +CREATE INDEX users_active_email_idx ON users(email) WHERE deleted_at IS NULL; +``` + +### 5. Semantic Naming + +Use meaningful table/column names. Names carry intent for LLMs. + +**Good:** `users`, `email`, `created_at`, `is_active` +**Bad:** `table1`, `col1`, `field`, `flag` + +--- + +## Code Example Standards + +### SQL Formatting + +```sql +-- Use lowercase keywords, clear formatting +CREATE INDEX CONCURRENTLY users_email_idx + ON users(email) + WHERE deleted_at IS NULL; + +-- Not cramped or ALL CAPS +CREATE INDEX CONCURRENTLY USERS_EMAIL_IDX ON USERS(EMAIL) WHERE DELETED_AT IS NULL; +``` + +### Comments + +- Explain _why_, not _what_ +- Highlight performance implications +- Point out common pitfalls + +### Language Tags + +- `sql` - Standard SQL queries +- `plpgsql` - Stored procedures/functions +- `typescript` - Application code (when needed) +- `python` - Application code (when needed) + +--- + +## When to Include Application Code + +**Default: SQL Only** + +Most references should focus on pure SQL patterns. This keeps examples portable. + +**Include Application Code When:** + +- Connection pooling configuration +- Transaction management in application context +- ORM anti-patterns (N+1 in Prisma/TypeORM) +- Prepared statement usage + +**Format for Mixed Examples:** + +````markdown +**Incorrect (N+1 in application):** + +```typescript +for (const user of users) { + const posts = await db.query("SELECT * FROM posts WHERE user_id = $1", [ + user.id, + ]); +} +``` +```` + +**Correct (batch query):** + +```typescript +const posts = await db.query("SELECT * FROM posts WHERE user_id = ANY($1)", [ + userIds, +]); +``` + +--- + +## Impact Level Guidelines + +| Level | Improvement | Use When | +|-------|-------------|----------| +| **CRITICAL** | 10-100x | Missing indexes, connection exhaustion, sequential scans on large tables | +| **HIGH** | 5-20x | Wrong index types, poor partitioning, missing covering indexes | +| **MEDIUM-HIGH** | 2-5x | N+1 queries, inefficient pagination, RLS optimization | +| **MEDIUM** | 1.5-3x | Redundant indexes, query plan instability | +| **LOW-MEDIUM** | 1.2-2x | VACUUM tuning, configuration tweaks | +| **LOW** | Incremental | Advanced patterns, edge cases | + +--- + +## Reference Standards + +**Primary Sources:** + +- Official Postgres documentation +- Supabase documentation +- Postgres wiki +- Established blogs (2ndQuadrant, Crunchy Data) + +**Format:** + +```markdown +Reference: +[Postgres Indexes](https://www.postgresql.org/docs/current/indexes.html) +``` + +--- + +## Review Checklist + +Before submitting a reference: + +- [ ] Title is clear and action-oriented +- [ ] Impact level matches the performance gain +- [ ] impactDescription includes quantification +- [ ] Explanation is concise (1-2 sentences) +- [ ] Has at least 1 **Incorrect** SQL example +- [ ] Has at least 1 **Correct** SQL example +- [ ] SQL uses semantic naming +- [ ] Comments explain _why_, not _what_ +- [ ] Trade-offs mentioned if applicable +- [ ] Reference links included +- [ ] `pnpm test` passes diff --git a/.agents/skills/supabase-postgres-best-practices/references/_sections.md b/.agents/skills/supabase-postgres-best-practices/references/_sections.md new file mode 100644 index 0000000..8ba57c2 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/_sections.md @@ -0,0 +1,39 @@ +# Section Definitions + +This file defines the rule categories for Postgres best practices. Rules are automatically assigned to sections based on their filename prefix. + +Take the examples below as pure demonstrative. Replace each section with the actual rule categories for Postgres best practices. + +--- + +## 1. Query Performance (query) +**Impact:** CRITICAL +**Description:** Slow queries, missing indexes, inefficient query plans. The most common source of Postgres performance issues. + +## 2. Connection Management (conn) +**Impact:** CRITICAL +**Description:** Connection pooling, limits, and serverless strategies. Critical for applications with high concurrency or serverless deployments. + +## 3. Security & RLS (security) +**Impact:** CRITICAL +**Description:** Row-Level Security policies, privilege management, and authentication patterns. + +## 4. Schema Design (schema) +**Impact:** HIGH +**Description:** Table design, index strategies, partitioning, and data type selection. Foundation for long-term performance. + +## 5. Concurrency & Locking (lock) +**Impact:** MEDIUM-HIGH +**Description:** Transaction management, isolation levels, deadlock prevention, and lock contention patterns. + +## 6. Data Access Patterns (data) +**Impact:** MEDIUM +**Description:** N+1 query elimination, batch operations, cursor-based pagination, and efficient data fetching. + +## 7. Monitoring & Diagnostics (monitor) +**Impact:** LOW-MEDIUM +**Description:** Using pg_stat_statements, EXPLAIN ANALYZE, metrics collection, and performance diagnostics. + +## 8. Advanced Features (advanced) +**Impact:** LOW +**Description:** Full-text search, JSONB optimization, PostGIS, extensions, and advanced Postgres features. diff --git a/.agents/skills/supabase-postgres-best-practices/references/_template.md b/.agents/skills/supabase-postgres-best-practices/references/_template.md new file mode 100644 index 0000000..91ace90 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/_template.md @@ -0,0 +1,34 @@ +--- +title: Clear, Action-Oriented Title (e.g., "Use Partial Indexes for Filtered Queries") +impact: MEDIUM +impactDescription: 5-20x query speedup for filtered queries +tags: indexes, query-optimization, performance +--- + +## [Rule Title] + +[1-2 sentence explanation of the problem and why it matters. Focus on performance impact.] + +**Incorrect (describe the problem):** + +```sql +-- Comment explaining what makes this slow/problematic +CREATE INDEX users_email_idx ON users(email); + +SELECT * FROM users WHERE email = 'user@example.com' AND deleted_at IS NULL; +-- This scans deleted records unnecessarily +``` + +**Correct (describe the solution):** + +```sql +-- Comment explaining why this is better +CREATE INDEX users_active_email_idx ON users(email) WHERE deleted_at IS NULL; + +SELECT * FROM users WHERE email = 'user@example.com' AND deleted_at IS NULL; +-- Only indexes active users, 10x smaller index, faster queries +``` + +[Optional: Additional context, edge cases, or trade-offs] + +Reference: [Postgres Docs](https://www.postgresql.org/docs/current/) diff --git a/.agents/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md b/.agents/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md new file mode 100644 index 0000000..582cbea --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md @@ -0,0 +1,55 @@ +--- +title: Use tsvector for Full-Text Search +impact: MEDIUM +impactDescription: 100x faster than LIKE, with ranking support +tags: full-text-search, tsvector, gin, search +--- + +## Use tsvector for Full-Text Search + +LIKE with wildcards can't use indexes. Full-text search with tsvector is orders of magnitude faster. + +**Incorrect (LIKE pattern matching):** + +```sql +-- Cannot use index, scans all rows +select * from articles where content like '%postgresql%'; + +-- Case-insensitive makes it worse +select * from articles where lower(content) like '%postgresql%'; +``` + +**Correct (full-text search with tsvector):** + +```sql +-- Add tsvector column and index +alter table articles add column search_vector tsvector + generated always as (to_tsvector('english', coalesce(title,'') || ' ' || coalesce(content,''))) stored; + +create index articles_search_idx on articles using gin (search_vector); + +-- Fast full-text search +select * from articles +where search_vector @@ to_tsquery('english', 'postgresql & performance'); + +-- With ranking +select *, ts_rank(search_vector, query) as rank +from articles, to_tsquery('english', 'postgresql') query +where search_vector @@ query +order by rank desc; +``` + +Search multiple terms: + +```sql +-- AND: both terms required +to_tsquery('postgresql & performance') + +-- OR: either term +to_tsquery('postgresql | mysql') + +-- Prefix matching +to_tsquery('post:*') +``` + +Reference: [Full Text Search](https://supabase.com/docs/guides/database/full-text-search) diff --git a/.agents/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md b/.agents/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md new file mode 100644 index 0000000..e3d261e --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md @@ -0,0 +1,49 @@ +--- +title: Index JSONB Columns for Efficient Querying +impact: MEDIUM +impactDescription: 10-100x faster JSONB queries with proper indexing +tags: jsonb, gin, indexes, json +--- + +## Index JSONB Columns for Efficient Querying + +JSONB queries without indexes scan the entire table. Use GIN indexes for containment queries. + +**Incorrect (no index on JSONB):** + +```sql +create table products ( + id bigint primary key, + attributes jsonb +); + +-- Full table scan for every query +select * from products where attributes @> '{"color": "red"}'; +select * from products where attributes->>'brand' = 'Nike'; +``` + +**Correct (GIN index for JSONB):** + +```sql +-- GIN index for containment operators (@>, ?, ?&, ?|) +create index products_attrs_gin on products using gin (attributes); + +-- Now containment queries use the index +select * from products where attributes @> '{"color": "red"}'; + +-- For specific key lookups, use expression index +create index products_brand_idx on products ((attributes->>'brand')); +select * from products where attributes->>'brand' = 'Nike'; +``` + +Choose the right operator class: + +```sql +-- jsonb_ops (default): supports all operators, larger index +create index idx1 on products using gin (attributes); + +-- jsonb_path_ops: only @> operator, but 2-3x smaller index +create index idx2 on products using gin (attributes jsonb_path_ops); +``` + +Reference: [JSONB Indexes](https://www.postgresql.org/docs/current/datatype-json.html#JSON-INDEXING) diff --git a/.agents/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md b/.agents/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md new file mode 100644 index 0000000..40b9cc5 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md @@ -0,0 +1,46 @@ +--- +title: Configure Idle Connection Timeouts +impact: HIGH +impactDescription: Reclaim 30-50% of connection slots from idle clients +tags: connections, timeout, idle, resource-management +--- + +## Configure Idle Connection Timeouts + +Idle connections waste resources. Configure timeouts to automatically reclaim them. + +**Incorrect (connections held indefinitely):** + +```sql +-- No timeout configured +show idle_in_transaction_session_timeout; -- 0 (disabled) + +-- Connections stay open forever, even when idle +select pid, state, state_change, query +from pg_stat_activity +where state = 'idle in transaction'; +-- Shows transactions idle for hours, holding locks +``` + +**Correct (automatic cleanup of idle connections):** + +```sql +-- Terminate connections idle in transaction after 30 seconds +alter system set idle_in_transaction_session_timeout = '30s'; + +-- Terminate completely idle connections after 10 minutes +alter system set idle_session_timeout = '10min'; + +-- Reload configuration +select pg_reload_conf(); +``` + +For pooled connections, configure at the pooler level: + +```ini +# pgbouncer.ini +server_idle_timeout = 60 +client_idle_timeout = 300 +``` + +Reference: [Connection Timeouts](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-IDLE-IN-TRANSACTION-SESSION-TIMEOUT) diff --git a/.agents/skills/supabase-postgres-best-practices/references/conn-limits.md b/.agents/skills/supabase-postgres-best-practices/references/conn-limits.md new file mode 100644 index 0000000..cb3e400 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/conn-limits.md @@ -0,0 +1,44 @@ +--- +title: Set Appropriate Connection Limits +impact: CRITICAL +impactDescription: Prevent database crashes and memory exhaustion +tags: connections, max-connections, limits, stability +--- + +## Set Appropriate Connection Limits + +Too many connections exhaust memory and degrade performance. Set limits based on available resources. + +**Incorrect (unlimited or excessive connections):** + +```sql +-- Default max_connections = 100, but often increased blindly +show max_connections; -- 500 (way too high for 4GB RAM) + +-- Each connection uses 1-3MB RAM +-- 500 connections * 2MB = 1GB just for connections! +-- Out of memory errors under load +``` + +**Correct (calculate based on resources):** + +```sql +-- Formula: max_connections = (RAM in MB / 5MB per connection) - reserved +-- For 4GB RAM: (4096 / 5) - 10 = ~800 theoretical max +-- But practically, 100-200 is better for query performance + +-- Recommended settings for 4GB RAM +alter system set max_connections = 100; + +-- Also set work_mem appropriately +-- work_mem * max_connections should not exceed 25% of RAM +alter system set work_mem = '8MB'; -- 8MB * 100 = 800MB max +``` + +Monitor connection usage: + +```sql +select count(*), state from pg_stat_activity group by state; +``` + +Reference: [Database Connections](https://supabase.com/docs/guides/platform/performance#connection-management) diff --git a/.agents/skills/supabase-postgres-best-practices/references/conn-pooling.md b/.agents/skills/supabase-postgres-best-practices/references/conn-pooling.md new file mode 100644 index 0000000..e2ebd58 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/conn-pooling.md @@ -0,0 +1,41 @@ +--- +title: Use Connection Pooling for All Applications +impact: CRITICAL +impactDescription: Handle 10-100x more concurrent users +tags: connection-pooling, pgbouncer, performance, scalability +--- + +## Use Connection Pooling for All Applications + +Postgres connections are expensive (1-3MB RAM each). Without pooling, applications exhaust connections under load. + +**Incorrect (new connection per request):** + +```sql +-- Each request creates a new connection +-- Application code: db.connect() per request +-- Result: 500 concurrent users = 500 connections = crashed database + +-- Check current connections +select count(*) from pg_stat_activity; -- 487 connections! +``` + +**Correct (connection pooling):** + +```sql +-- Use a pooler like PgBouncer between app and database +-- Application connects to pooler, pooler reuses a small pool to Postgres + +-- Configure pool_size based on: (CPU cores * 2) + spindle_count +-- Example for 4 cores: pool_size = 10 + +-- Result: 500 concurrent users share 10 actual connections +select count(*) from pg_stat_activity; -- 10 connections +``` + +Pool modes: + +- **Transaction mode**: connection returned after each transaction (best for most apps) +- **Session mode**: connection held for entire session (needed for prepared statements, temp tables) + +Reference: [Connection Pooling](https://supabase.com/docs/guides/database/connecting-to-postgres#connection-pooler) diff --git a/.agents/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md b/.agents/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md new file mode 100644 index 0000000..555547d --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md @@ -0,0 +1,46 @@ +--- +title: Use Prepared Statements Correctly with Pooling +impact: HIGH +impactDescription: Avoid prepared statement conflicts in pooled environments +tags: prepared-statements, connection-pooling, transaction-mode +--- + +## Use Prepared Statements Correctly with Pooling + +Prepared statements are tied to individual database connections. In transaction-mode pooling, connections are shared, causing conflicts. + +**Incorrect (named prepared statements with transaction pooling):** + +```sql +-- Named prepared statement +prepare get_user as select * from users where id = $1; + +-- In transaction mode pooling, next request may get different connection +execute get_user(123); +-- ERROR: prepared statement "get_user" does not exist +``` + +**Correct (use unnamed statements or session mode):** + +```sql +-- Option 1: Use unnamed prepared statements (most ORMs do this automatically) +-- The query is prepared and executed in a single protocol message + +-- Option 2: Deallocate after use in transaction mode +prepare get_user as select * from users where id = $1; +execute get_user(123); +deallocate get_user; + +-- Option 3: Use session mode pooling (port 5432 vs 6543) +-- Connection is held for entire session, prepared statements persist +``` + +Check your driver settings: + +```sql +-- Many drivers use prepared statements by default +-- Node.js pg: { prepare: false } to disable +-- JDBC: prepareThreshold=0 to disable +``` + +Reference: [Prepared Statements with Pooling](https://supabase.com/docs/guides/database/connecting-to-postgres#connection-pool-modes) diff --git a/.agents/skills/supabase-postgres-best-practices/references/data-batch-inserts.md b/.agents/skills/supabase-postgres-best-practices/references/data-batch-inserts.md new file mode 100644 index 0000000..997947c --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/data-batch-inserts.md @@ -0,0 +1,54 @@ +--- +title: Batch INSERT Statements for Bulk Data +impact: MEDIUM +impactDescription: 10-50x faster bulk inserts +tags: batch, insert, bulk, performance, copy +--- + +## Batch INSERT Statements for Bulk Data + +Individual INSERT statements have high overhead. Batch multiple rows in single statements or use COPY. + +**Incorrect (individual inserts):** + +```sql +-- Each insert is a separate transaction and round trip +insert into events (user_id, action) values (1, 'click'); +insert into events (user_id, action) values (1, 'view'); +insert into events (user_id, action) values (2, 'click'); +-- ... 1000 more individual inserts + +-- 1000 inserts = 1000 round trips = slow +``` + +**Correct (batch insert):** + +```sql +-- Multiple rows in single statement +insert into events (user_id, action) values + (1, 'click'), + (1, 'view'), + (2, 'click'), + -- ... up to ~1000 rows per batch + (999, 'view'); + +-- One round trip for 1000 rows +``` + +For large imports, use COPY: + +```sql +-- COPY is fastest for bulk loading +copy events (user_id, action, created_at) +from '/path/to/data.csv' +with (format csv, header true); + +-- Or from stdin in application +copy events (user_id, action) from stdin with (format csv); +1,click +1,view +2,click +\. +``` + +Reference: [COPY](https://www.postgresql.org/docs/current/sql-copy.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/data-n-plus-one.md b/.agents/skills/supabase-postgres-best-practices/references/data-n-plus-one.md new file mode 100644 index 0000000..2109186 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/data-n-plus-one.md @@ -0,0 +1,53 @@ +--- +title: Eliminate N+1 Queries with Batch Loading +impact: MEDIUM-HIGH +impactDescription: 10-100x fewer database round trips +tags: n-plus-one, batch, performance, queries +--- + +## Eliminate N+1 Queries with Batch Loading + +N+1 queries execute one query per item in a loop. Batch them into a single query using arrays or JOINs. + +**Incorrect (N+1 queries):** + +```sql +-- First query: get all users +select id from users where active = true; -- Returns 100 IDs + +-- Then N queries, one per user +select * from orders where user_id = 1; +select * from orders where user_id = 2; +select * from orders where user_id = 3; +-- ... 97 more queries! + +-- Total: 101 round trips to database +``` + +**Correct (single batch query):** + +```sql +-- Collect IDs and query once with ANY +select * from orders where user_id = any(array[1, 2, 3, ...]); + +-- Or use JOIN instead of loop +select u.id, u.name, o.* +from users u +left join orders o on o.user_id = u.id +where u.active = true; + +-- Total: 1 round trip +``` + +Application pattern: + +```sql +-- Instead of looping in application code: +-- for user in users: db.query("SELECT * FROM orders WHERE user_id = $1", user.id) + +-- Pass array parameter: +select * from orders where user_id = any($1::bigint[]); +-- Application passes: [1, 2, 3, 4, 5, ...] +``` + +Reference: [N+1 Query Problem](https://supabase.com/docs/guides/database/query-optimization) diff --git a/.agents/skills/supabase-postgres-best-practices/references/data-pagination.md b/.agents/skills/supabase-postgres-best-practices/references/data-pagination.md new file mode 100644 index 0000000..633d839 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/data-pagination.md @@ -0,0 +1,50 @@ +--- +title: Use Cursor-Based Pagination Instead of OFFSET +impact: MEDIUM-HIGH +impactDescription: Consistent O(1) performance regardless of page depth +tags: pagination, cursor, keyset, offset, performance +--- + +## Use Cursor-Based Pagination Instead of OFFSET + +OFFSET-based pagination scans all skipped rows, getting slower on deeper pages. Cursor pagination is O(1). + +**Incorrect (OFFSET pagination):** + +```sql +-- Page 1: scans 20 rows +select * from products order by id limit 20 offset 0; + +-- Page 100: scans 2000 rows to skip 1980 +select * from products order by id limit 20 offset 1980; + +-- Page 10000: scans 200,000 rows! +select * from products order by id limit 20 offset 199980; +``` + +**Correct (cursor/keyset pagination):** + +```sql +-- Page 1: get first 20 +select * from products order by id limit 20; +-- Application stores last_id = 20 + +-- Page 2: start after last ID +select * from products where id > 20 order by id limit 20; +-- Uses index, always fast regardless of page depth + +-- Page 10000: same speed as page 1 +select * from products where id > 199980 order by id limit 20; +``` + +For multi-column sorting: + +```sql +-- Cursor must include all sort columns +select * from products +where (created_at, id) > ('2024-01-15 10:00:00', 12345) +order by created_at, id +limit 20; +``` + +Reference: [Pagination](https://supabase.com/docs/guides/database/pagination) diff --git a/.agents/skills/supabase-postgres-best-practices/references/data-upsert.md b/.agents/skills/supabase-postgres-best-practices/references/data-upsert.md new file mode 100644 index 0000000..bc95e23 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/data-upsert.md @@ -0,0 +1,50 @@ +--- +title: Use UPSERT for Insert-or-Update Operations +impact: MEDIUM +impactDescription: Atomic operation, eliminates race conditions +tags: upsert, on-conflict, insert, update +--- + +## Use UPSERT for Insert-or-Update Operations + +Using separate SELECT-then-INSERT/UPDATE creates race conditions. Use INSERT ... ON CONFLICT for atomic upserts. + +**Incorrect (check-then-insert race condition):** + +```sql +-- Race condition: two requests check simultaneously +select * from settings where user_id = 123 and key = 'theme'; +-- Both find nothing + +-- Both try to insert +insert into settings (user_id, key, value) values (123, 'theme', 'dark'); +-- One succeeds, one fails with duplicate key error! +``` + +**Correct (atomic UPSERT):** + +```sql +-- Single atomic operation +insert into settings (user_id, key, value) +values (123, 'theme', 'dark') +on conflict (user_id, key) +do update set value = excluded.value, updated_at = now(); + +-- Returns the inserted/updated row +insert into settings (user_id, key, value) +values (123, 'theme', 'dark') +on conflict (user_id, key) +do update set value = excluded.value +returning *; +``` + +Insert-or-ignore pattern: + +```sql +-- Insert only if not exists (no update) +insert into page_views (page_id, user_id) +values (1, 123) +on conflict (page_id, user_id) do nothing; +``` + +Reference: [INSERT ON CONFLICT](https://www.postgresql.org/docs/current/sql-insert.html#SQL-ON-CONFLICT) diff --git a/.agents/skills/supabase-postgres-best-practices/references/lock-advisory.md b/.agents/skills/supabase-postgres-best-practices/references/lock-advisory.md new file mode 100644 index 0000000..572eaf0 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/lock-advisory.md @@ -0,0 +1,56 @@ +--- +title: Use Advisory Locks for Application-Level Locking +impact: MEDIUM +impactDescription: Efficient coordination without row-level lock overhead +tags: advisory-locks, coordination, application-locks +--- + +## Use Advisory Locks for Application-Level Locking + +Advisory locks provide application-level coordination without requiring database rows to lock. + +**Incorrect (creating rows just for locking):** + +```sql +-- Creating dummy rows to lock on +create table resource_locks ( + resource_name text primary key +); + +insert into resource_locks values ('report_generator'); + +-- Lock by selecting the row +select * from resource_locks where resource_name = 'report_generator' for update; +``` + +**Correct (advisory locks):** + +```sql +-- Session-level advisory lock (released on disconnect or unlock) +select pg_advisory_lock(hashtext('report_generator')); +-- ... do exclusive work ... +select pg_advisory_unlock(hashtext('report_generator')); + +-- Transaction-level lock (released on commit/rollback) +begin; +select pg_advisory_xact_lock(hashtext('daily_report')); +-- ... do work ... +commit; -- Lock automatically released +``` + +Try-lock for non-blocking operations: + +```sql +-- Returns immediately with true/false instead of waiting +select pg_try_advisory_lock(hashtext('resource_name')); + +-- Use in application +if (acquired) { + -- Do work + select pg_advisory_unlock(hashtext('resource_name')); +} else { + -- Skip or retry later +} +``` + +Reference: [Advisory Locks](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS) diff --git a/.agents/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md b/.agents/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md new file mode 100644 index 0000000..974da5e --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md @@ -0,0 +1,68 @@ +--- +title: Prevent Deadlocks with Consistent Lock Ordering +impact: MEDIUM-HIGH +impactDescription: Eliminate deadlock errors, improve reliability +tags: deadlocks, locking, transactions, ordering +--- + +## Prevent Deadlocks with Consistent Lock Ordering + +Deadlocks occur when transactions lock resources in different orders. Always +acquire locks in a consistent order. + +**Incorrect (inconsistent lock ordering):** + +```sql +-- Transaction A -- Transaction B +begin; begin; +update accounts update accounts +set balance = balance - 100 set balance = balance - 50 +where id = 1; where id = 2; -- B locks row 2 + +update accounts update accounts +set balance = balance + 100 set balance = balance + 50 +where id = 2; -- A waits for B where id = 1; -- B waits for A + +-- DEADLOCK! Both waiting for each other +``` + +**Correct (lock rows in consistent order first):** + +```sql +-- Explicitly acquire locks in ID order before updating +begin; +select * from accounts where id in (1, 2) order by id for update; + +-- Now perform updates in any order - locks already held +update accounts set balance = balance - 100 where id = 1; +update accounts set balance = balance + 100 where id = 2; +commit; +``` + +Alternative: use a single statement to update atomically: + +```sql +-- Single statement acquires all locks atomically +begin; +update accounts +set balance = balance + case id + when 1 then -100 + when 2 then 100 +end +where id in (1, 2); +commit; +``` + +Detect deadlocks in logs: + +```sql +-- Check for recent deadlocks +select * from pg_stat_database where deadlocks > 0; + +-- Enable deadlock logging +set log_lock_waits = on; +set deadlock_timeout = '1s'; +``` + +Reference: +[Deadlocks](https://www.postgresql.org/docs/current/explicit-locking.html#LOCKING-DEADLOCKS) diff --git a/.agents/skills/supabase-postgres-best-practices/references/lock-short-transactions.md b/.agents/skills/supabase-postgres-best-practices/references/lock-short-transactions.md new file mode 100644 index 0000000..e6b8ef2 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/lock-short-transactions.md @@ -0,0 +1,50 @@ +--- +title: Keep Transactions Short to Reduce Lock Contention +impact: MEDIUM-HIGH +impactDescription: 3-5x throughput improvement, fewer deadlocks +tags: transactions, locking, contention, performance +--- + +## Keep Transactions Short to Reduce Lock Contention + +Long-running transactions hold locks that block other queries. Keep transactions as short as possible. + +**Incorrect (long transaction with external calls):** + +```sql +begin; +select * from orders where id = 1 for update; -- Lock acquired + +-- Application makes HTTP call to payment API (2-5 seconds) +-- Other queries on this row are blocked! + +update orders set status = 'paid' where id = 1; +commit; -- Lock held for entire duration +``` + +**Correct (minimal transaction scope):** + +```sql +-- Validate data and call APIs outside transaction +-- Application: response = await paymentAPI.charge(...) + +-- Only hold lock for the actual update +begin; +update orders +set status = 'paid', payment_id = $1 +where id = $2 and status = 'pending' +returning *; +commit; -- Lock held for milliseconds +``` + +Use `statement_timeout` to prevent runaway transactions: + +```sql +-- Abort queries running longer than 30 seconds +set statement_timeout = '30s'; + +-- Or per-session +set local statement_timeout = '5s'; +``` + +Reference: [Transaction Management](https://www.postgresql.org/docs/current/tutorial-transactions.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/lock-skip-locked.md b/.agents/skills/supabase-postgres-best-practices/references/lock-skip-locked.md new file mode 100644 index 0000000..77bdbb9 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/lock-skip-locked.md @@ -0,0 +1,54 @@ +--- +title: Use SKIP LOCKED for Non-Blocking Queue Processing +impact: MEDIUM-HIGH +impactDescription: 10x throughput for worker queues +tags: skip-locked, queue, workers, concurrency +--- + +## Use SKIP LOCKED for Non-Blocking Queue Processing + +When multiple workers process a queue, SKIP LOCKED allows workers to process different rows without waiting. + +**Incorrect (workers block each other):** + +```sql +-- Worker 1 and Worker 2 both try to get next job +begin; +select * from jobs where status = 'pending' order by created_at limit 1 for update; +-- Worker 2 waits for Worker 1's lock to release! +``` + +**Correct (SKIP LOCKED for parallel processing):** + +```sql +-- Each worker skips locked rows and gets the next available +begin; +select * from jobs +where status = 'pending' +order by created_at +limit 1 +for update skip locked; + +-- Worker 1 gets job 1, Worker 2 gets job 2 (no waiting) + +update jobs set status = 'processing' where id = $1; +commit; +``` + +Complete queue pattern: + +```sql +-- Atomic claim-and-update in one statement +update jobs +set status = 'processing', worker_id = $1, started_at = now() +where id = ( + select id from jobs + where status = 'pending' + order by created_at + limit 1 + for update skip locked +) +returning *; +``` + +Reference: [SELECT FOR UPDATE SKIP LOCKED](https://www.postgresql.org/docs/current/sql-select.html#SQL-FOR-UPDATE-SHARE) diff --git a/.agents/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md b/.agents/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md new file mode 100644 index 0000000..542978c --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md @@ -0,0 +1,45 @@ +--- +title: Use EXPLAIN ANALYZE to Diagnose Slow Queries +impact: LOW-MEDIUM +impactDescription: Identify exact bottlenecks in query execution +tags: explain, analyze, diagnostics, query-plan +--- + +## Use EXPLAIN ANALYZE to Diagnose Slow Queries + +EXPLAIN ANALYZE executes the query and shows actual timings, revealing the true performance bottlenecks. + +**Incorrect (guessing at performance issues):** + +```sql +-- Query is slow, but why? +select * from orders where customer_id = 123 and status = 'pending'; +-- "It must be missing an index" - but which one? +``` + +**Correct (use EXPLAIN ANALYZE):** + +```sql +explain (analyze, buffers, format text) +select * from orders where customer_id = 123 and status = 'pending'; + +-- Output reveals the issue: +-- Seq Scan on orders (cost=0.00..25000.00 rows=50 width=100) (actual time=0.015..450.123 rows=50 loops=1) +-- Filter: ((customer_id = 123) AND (status = 'pending'::text)) +-- Rows Removed by Filter: 999950 +-- Buffers: shared hit=5000 read=15000 +-- Planning Time: 0.150 ms +-- Execution Time: 450.500 ms +``` + +Key things to look for: + +```sql +-- Seq Scan on large tables = missing index +-- Rows Removed by Filter = poor selectivity or missing index +-- Buffers: read >> hit = data not cached, needs more memory +-- Nested Loop with high loops = consider different join strategy +-- Sort Method: external merge = work_mem too low +``` + +Reference: [EXPLAIN](https://supabase.com/docs/guides/database/inspect) diff --git a/.agents/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md b/.agents/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md new file mode 100644 index 0000000..d7e82f1 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md @@ -0,0 +1,55 @@ +--- +title: Enable pg_stat_statements for Query Analysis +impact: LOW-MEDIUM +impactDescription: Identify top resource-consuming queries +tags: pg-stat-statements, monitoring, statistics, performance +--- + +## Enable pg_stat_statements for Query Analysis + +pg_stat_statements tracks execution statistics for all queries, helping identify slow and frequent queries. + +**Incorrect (no visibility into query patterns):** + +```sql +-- Database is slow, but which queries are the problem? +-- No way to know without pg_stat_statements +``` + +**Correct (enable and query pg_stat_statements):** + +```sql +-- Enable the extension +create extension if not exists pg_stat_statements; + +-- Find slowest queries by total time +select + calls, + round(total_exec_time::numeric, 2) as total_time_ms, + round(mean_exec_time::numeric, 2) as mean_time_ms, + query +from pg_stat_statements +order by total_exec_time desc +limit 10; + +-- Find most frequent queries +select calls, query +from pg_stat_statements +order by calls desc +limit 10; + +-- Reset statistics after optimization +select pg_stat_statements_reset(); +``` + +Key metrics to monitor: + +```sql +-- Queries with high mean time (candidates for optimization) +select query, mean_exec_time, calls +from pg_stat_statements +where mean_exec_time > 100 -- > 100ms average +order by mean_exec_time desc; +``` + +Reference: [pg_stat_statements](https://supabase.com/docs/guides/database/extensions/pg_stat_statements) diff --git a/.agents/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md b/.agents/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md new file mode 100644 index 0000000..e0e8ea0 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md @@ -0,0 +1,55 @@ +--- +title: Maintain Table Statistics with VACUUM and ANALYZE +impact: MEDIUM +impactDescription: 2-10x better query plans with accurate statistics +tags: vacuum, analyze, statistics, maintenance, autovacuum +--- + +## Maintain Table Statistics with VACUUM and ANALYZE + +Outdated statistics cause the query planner to make poor decisions. VACUUM reclaims space, ANALYZE updates statistics. + +**Incorrect (stale statistics):** + +```sql +-- Table has 1M rows but stats say 1000 +-- Query planner chooses wrong strategy +explain select * from orders where status = 'pending'; +-- Shows: Seq Scan (because stats show small table) +-- Actually: Index Scan would be much faster +``` + +**Correct (maintain fresh statistics):** + +```sql +-- Manually analyze after large data changes +analyze orders; + +-- Analyze specific columns used in WHERE clauses +analyze orders (status, created_at); + +-- Check when tables were last analyzed +select + relname, + last_vacuum, + last_autovacuum, + last_analyze, + last_autoanalyze +from pg_stat_user_tables +order by last_analyze nulls first; +``` + +Autovacuum tuning for busy tables: + +```sql +-- Increase frequency for high-churn tables +alter table orders set ( + autovacuum_vacuum_scale_factor = 0.05, -- Vacuum at 5% dead tuples (default 20%) + autovacuum_analyze_scale_factor = 0.02 -- Analyze at 2% changes (default 10%) +); + +-- Check autovacuum status +select * from pg_stat_progress_vacuum; +``` + +Reference: [VACUUM](https://supabase.com/docs/guides/database/database-size#vacuum-operations) diff --git a/.agents/skills/supabase-postgres-best-practices/references/query-composite-indexes.md b/.agents/skills/supabase-postgres-best-practices/references/query-composite-indexes.md new file mode 100644 index 0000000..fea6452 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/query-composite-indexes.md @@ -0,0 +1,44 @@ +--- +title: Create Composite Indexes for Multi-Column Queries +impact: HIGH +impactDescription: 5-10x faster multi-column queries +tags: indexes, composite-index, multi-column, query-optimization +--- + +## Create Composite Indexes for Multi-Column Queries + +When queries filter on multiple columns, a composite index is more efficient than separate single-column indexes. + +**Incorrect (separate indexes require bitmap scan):** + +```sql +-- Two separate indexes +create index orders_status_idx on orders (status); +create index orders_created_idx on orders (created_at); + +-- Query must combine both indexes (slower) +select * from orders where status = 'pending' and created_at > '2024-01-01'; +``` + +**Correct (composite index):** + +```sql +-- Single composite index (leftmost column first for equality checks) +create index orders_status_created_idx on orders (status, created_at); + +-- Query uses one efficient index scan +select * from orders where status = 'pending' and created_at > '2024-01-01'; +``` + +**Column order matters** - place equality columns first, range columns last: + +```sql +-- Good: status (=) before created_at (>) +create index idx on orders (status, created_at); + +-- Works for: WHERE status = 'pending' +-- Works for: WHERE status = 'pending' AND created_at > '2024-01-01' +-- Does NOT work for: WHERE created_at > '2024-01-01' (leftmost prefix rule) +``` + +Reference: [Multicolumn Indexes](https://www.postgresql.org/docs/current/indexes-multicolumn.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/query-covering-indexes.md b/.agents/skills/supabase-postgres-best-practices/references/query-covering-indexes.md new file mode 100644 index 0000000..9d2a494 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/query-covering-indexes.md @@ -0,0 +1,40 @@ +--- +title: Use Covering Indexes to Avoid Table Lookups +impact: MEDIUM-HIGH +impactDescription: 2-5x faster queries by eliminating heap fetches +tags: indexes, covering-index, include, index-only-scan +--- + +## Use Covering Indexes to Avoid Table Lookups + +Covering indexes include all columns needed by a query, enabling index-only scans that skip the table entirely. + +**Incorrect (index scan + heap fetch):** + +```sql +create index users_email_idx on users (email); + +-- Must fetch name and created_at from table heap +select email, name, created_at from users where email = 'user@example.com'; +``` + +**Correct (index-only scan with INCLUDE):** + +```sql +-- Include non-searchable columns in the index +create index users_email_idx on users (email) include (name, created_at); + +-- All columns served from index, no table access needed +select email, name, created_at from users where email = 'user@example.com'; +``` + +Use INCLUDE for columns you SELECT but don't filter on: + +```sql +-- Searching by status, but also need customer_id and total +create index orders_status_idx on orders (status) include (customer_id, total); + +select status, customer_id, total from orders where status = 'shipped'; +``` + +Reference: [Index-Only Scans](https://www.postgresql.org/docs/current/indexes-index-only-scans.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/query-index-types.md b/.agents/skills/supabase-postgres-best-practices/references/query-index-types.md new file mode 100644 index 0000000..93b3259 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/query-index-types.md @@ -0,0 +1,48 @@ +--- +title: Choose the Right Index Type for Your Data +impact: HIGH +impactDescription: 10-100x improvement with correct index type +tags: indexes, btree, gin, gist, brin, hash, index-types +--- + +## Choose the Right Index Type for Your Data + +Different index types excel at different query patterns. The default B-tree isn't always optimal. + +**Incorrect (B-tree for JSONB containment):** + +```sql +-- B-tree cannot optimize containment operators +create index products_attrs_idx on products (attributes); +select * from products where attributes @> '{"color": "red"}'; +-- Full table scan - B-tree doesn't support @> operator +``` + +**Correct (GIN for JSONB):** + +```sql +-- GIN supports @>, ?, ?&, ?| operators +create index products_attrs_idx on products using gin (attributes); +select * from products where attributes @> '{"color": "red"}'; +``` + +Index type guide: + +```sql +-- B-tree (default): =, <, >, BETWEEN, IN, IS NULL +create index users_created_idx on users (created_at); + +-- GIN: arrays, JSONB, full-text search +create index posts_tags_idx on posts using gin (tags); + +-- GiST: geometric data, range types, nearest-neighbor (KNN) queries +create index locations_idx on places using gist (location); + +-- BRIN: large time-series tables (10-100x smaller) +create index events_time_idx on events using brin (created_at); + +-- Hash: equality-only (slightly faster than B-tree for =) +create index sessions_token_idx on sessions using hash (token); +``` + +Reference: [Index Types](https://www.postgresql.org/docs/current/indexes-types.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/query-missing-indexes.md b/.agents/skills/supabase-postgres-best-practices/references/query-missing-indexes.md new file mode 100644 index 0000000..e6daace --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/query-missing-indexes.md @@ -0,0 +1,43 @@ +--- +title: Add Indexes on WHERE and JOIN Columns +impact: CRITICAL +impactDescription: 100-1000x faster queries on large tables +tags: indexes, performance, sequential-scan, query-optimization +--- + +## Add Indexes on WHERE and JOIN Columns + +Queries filtering or joining on unindexed columns cause full table scans, which become exponentially slower as tables grow. + +**Incorrect (sequential scan on large table):** + +```sql +-- No index on customer_id causes full table scan +select * from orders where customer_id = 123; + +-- EXPLAIN shows: Seq Scan on orders (cost=0.00..25000.00 rows=100 width=85) +``` + +**Correct (index scan):** + +```sql +-- Create index on frequently filtered column +create index orders_customer_id_idx on orders (customer_id); + +select * from orders where customer_id = 123; + +-- EXPLAIN shows: Index Scan using orders_customer_id_idx (cost=0.42..8.44 rows=100 width=85) +``` + +For JOIN columns, always index the foreign key side: + +```sql +-- Index the referencing column +create index orders_customer_id_idx on orders (customer_id); + +select c.name, o.total +from customers c +join orders o on o.customer_id = c.id; +``` + +Reference: [Query Optimization](https://supabase.com/docs/guides/database/query-optimization) diff --git a/.agents/skills/supabase-postgres-best-practices/references/query-partial-indexes.md b/.agents/skills/supabase-postgres-best-practices/references/query-partial-indexes.md new file mode 100644 index 0000000..3e61a34 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/query-partial-indexes.md @@ -0,0 +1,45 @@ +--- +title: Use Partial Indexes for Filtered Queries +impact: HIGH +impactDescription: 5-20x smaller indexes, faster writes and queries +tags: indexes, partial-index, query-optimization, storage +--- + +## Use Partial Indexes for Filtered Queries + +Partial indexes only include rows matching a WHERE condition, making them smaller and faster when queries consistently filter on the same condition. + +**Incorrect (full index includes irrelevant rows):** + +```sql +-- Index includes all rows, even soft-deleted ones +create index users_email_idx on users (email); + +-- Query always filters active users +select * from users where email = 'user@example.com' and deleted_at is null; +``` + +**Correct (partial index matches query filter):** + +```sql +-- Index only includes active users +create index users_active_email_idx on users (email) +where deleted_at is null; + +-- Query uses the smaller, faster index +select * from users where email = 'user@example.com' and deleted_at is null; +``` + +Common use cases for partial indexes: + +```sql +-- Only pending orders (status rarely changes once completed) +create index orders_pending_idx on orders (created_at) +where status = 'pending'; + +-- Only non-null values +create index products_sku_idx on products (sku) +where sku is not null; +``` + +Reference: [Partial Indexes](https://www.postgresql.org/docs/current/indexes-partial.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-constraints.md b/.agents/skills/supabase-postgres-best-practices/references/schema-constraints.md new file mode 100644 index 0000000..1d2ef8f --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-constraints.md @@ -0,0 +1,80 @@ +--- +title: Add Constraints Safely in Migrations +impact: HIGH +impactDescription: Prevents migration failures and enables idempotent schema changes +tags: constraints, migrations, schema, alter-table +--- + +## Add Constraints Safely in Migrations + +PostgreSQL does not support `ADD CONSTRAINT IF NOT EXISTS`. Migrations using this syntax will fail. + +**Incorrect (causes syntax error):** + +```sql +-- ERROR: syntax error at or near "not" (SQLSTATE 42601) +alter table public.profiles +add constraint if not exists profiles_birthchart_id_unique unique (birthchart_id); +``` + +**Correct (idempotent constraint creation):** + +```sql +-- Use DO block to check before adding +do $$ +begin + if not exists ( + select 1 from pg_constraint + where conname = 'profiles_birthchart_id_unique' + and conrelid = 'public.profiles'::regclass + ) then + alter table public.profiles + add constraint profiles_birthchart_id_unique unique (birthchart_id); + end if; +end $$; +``` + +For all constraint types: + +```sql +-- Check constraints +do $$ +begin + if not exists ( + select 1 from pg_constraint + where conname = 'check_age_positive' + ) then + alter table users add constraint check_age_positive check (age > 0); + end if; +end $$; + +-- Foreign keys +do $$ +begin + if not exists ( + select 1 from pg_constraint + where conname = 'profiles_birthchart_id_fkey' + ) then + alter table profiles + add constraint profiles_birthchart_id_fkey + foreign key (birthchart_id) references birthcharts(id); + end if; +end $$; +``` + +Check if constraint exists: + +```sql +-- Query to check constraint existence +select conname, contype, pg_get_constraintdef(oid) +from pg_constraint +where conrelid = 'public.profiles'::regclass; + +-- contype values: +-- 'p' = PRIMARY KEY +-- 'f' = FOREIGN KEY +-- 'u' = UNIQUE +-- 'c' = CHECK +``` + +Reference: [Constraints](https://www.postgresql.org/docs/current/ddl-constraints.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-data-types.md b/.agents/skills/supabase-postgres-best-practices/references/schema-data-types.md new file mode 100644 index 0000000..f253a58 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-data-types.md @@ -0,0 +1,46 @@ +--- +title: Choose Appropriate Data Types +impact: HIGH +impactDescription: 50% storage reduction, faster comparisons +tags: data-types, schema, storage, performance +--- + +## Choose Appropriate Data Types + +Using the right data types reduces storage, improves query performance, and prevents bugs. + +**Incorrect (wrong data types):** + +```sql +create table users ( + id int, -- Will overflow at 2.1 billion + email varchar(255), -- Unnecessary length limit + created_at timestamp, -- Missing timezone info + is_active varchar(5), -- String for boolean + price varchar(20) -- String for numeric +); +``` + +**Correct (appropriate data types):** + +```sql +create table users ( + id bigint generated always as identity primary key, -- 9 quintillion max + email text, -- No artificial limit, same performance as varchar + created_at timestamptz, -- Always store timezone-aware timestamps + is_active boolean default true, -- 1 byte vs variable string length + price numeric(10,2) -- Exact decimal arithmetic +); +``` + +Key guidelines: + +```sql +-- IDs: use bigint, not int (future-proofing) +-- Strings: use text, not varchar(n) unless constraint needed +-- Time: use timestamptz, not timestamp +-- Money: use numeric, not float (precision matters) +-- Enums: use text with check constraint or create enum type +``` + +Reference: [Data Types](https://www.postgresql.org/docs/current/datatype.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md b/.agents/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md new file mode 100644 index 0000000..6c3d6ff --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md @@ -0,0 +1,59 @@ +--- +title: Index Foreign Key Columns +impact: HIGH +impactDescription: 10-100x faster JOINs and CASCADE operations +tags: foreign-key, indexes, joins, schema +--- + +## Index Foreign Key Columns + +Postgres does not automatically index foreign key columns. Missing indexes cause slow JOINs and CASCADE operations. + +**Incorrect (unindexed foreign key):** + +```sql +create table orders ( + id bigint generated always as identity primary key, + customer_id bigint references customers(id) on delete cascade, + total numeric(10,2) +); + +-- No index on customer_id! +-- JOINs and ON DELETE CASCADE both require full table scan +select * from orders where customer_id = 123; -- Seq Scan +delete from customers where id = 123; -- Locks table, scans all orders +``` + +**Correct (indexed foreign key):** + +```sql +create table orders ( + id bigint generated always as identity primary key, + customer_id bigint references customers(id) on delete cascade, + total numeric(10,2) +); + +-- Always index the FK column +create index orders_customer_id_idx on orders (customer_id); + +-- Now JOINs and cascades are fast +select * from orders where customer_id = 123; -- Index Scan +delete from customers where id = 123; -- Uses index, fast cascade +``` + +Find missing FK indexes: + +```sql +select + conrelid::regclass as table_name, + a.attname as fk_column +from pg_constraint c +join pg_attribute a on a.attrelid = c.conrelid and a.attnum = any(c.conkey) +where c.contype = 'f' + and not exists ( + select 1 from pg_index i + where i.indrelid = c.conrelid and a.attnum = any(i.indkey) + ); +``` + +Reference: [Foreign Keys](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-FK) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md b/.agents/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md new file mode 100644 index 0000000..f007294 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md @@ -0,0 +1,55 @@ +--- +title: Use Lowercase Identifiers for Compatibility +impact: MEDIUM +impactDescription: Avoid case-sensitivity bugs with tools, ORMs, and AI assistants +tags: naming, identifiers, case-sensitivity, schema, conventions +--- + +## Use Lowercase Identifiers for Compatibility + +PostgreSQL folds unquoted identifiers to lowercase. Quoted mixed-case identifiers require quotes forever and cause issues with tools, ORMs, and AI assistants that may not recognize them. + +**Incorrect (mixed-case identifiers):** + +```sql +-- Quoted identifiers preserve case but require quotes everywhere +CREATE TABLE "Users" ( + "userId" bigint PRIMARY KEY, + "firstName" text, + "lastName" text +); + +-- Must always quote or queries fail +SELECT "firstName" FROM "Users" WHERE "userId" = 1; + +-- This fails - Users becomes users without quotes +SELECT firstName FROM Users; +-- ERROR: relation "users" does not exist +``` + +**Correct (lowercase snake_case):** + +```sql +-- Unquoted lowercase identifiers are portable and tool-friendly +CREATE TABLE users ( + user_id bigint PRIMARY KEY, + first_name text, + last_name text +); + +-- Works without quotes, recognized by all tools +SELECT first_name FROM users WHERE user_id = 1; +``` + +Common sources of mixed-case identifiers: + +```sql +-- ORMs often generate quoted camelCase - configure them to use snake_case +-- Migrations from other databases may preserve original casing +-- Some GUI tools quote identifiers by default - disable this + +-- If stuck with mixed-case, create views as a compatibility layer +CREATE VIEW users AS SELECT "userId" AS user_id, "firstName" AS first_name FROM "Users"; +``` + +Reference: [Identifiers and Key Words](https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-partitioning.md b/.agents/skills/supabase-postgres-best-practices/references/schema-partitioning.md new file mode 100644 index 0000000..13137a0 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-partitioning.md @@ -0,0 +1,55 @@ +--- +title: Partition Large Tables for Better Performance +impact: MEDIUM-HIGH +impactDescription: 5-20x faster queries and maintenance on large tables +tags: partitioning, large-tables, time-series, performance +--- + +## Partition Large Tables for Better Performance + +Partitioning splits a large table into smaller pieces, improving query performance and maintenance operations. + +**Incorrect (single large table):** + +```sql +create table events ( + id bigint generated always as identity, + created_at timestamptz, + data jsonb +); + +-- 500M rows, queries scan everything +select * from events where created_at > '2024-01-01'; -- Slow +vacuum events; -- Takes hours, locks table +``` + +**Correct (partitioned by time range):** + +```sql +create table events ( + id bigint generated always as identity, + created_at timestamptz not null, + data jsonb +) partition by range (created_at); + +-- Create partitions for each month +create table events_2024_01 partition of events + for values from ('2024-01-01') to ('2024-02-01'); + +create table events_2024_02 partition of events + for values from ('2024-02-01') to ('2024-03-01'); + +-- Queries only scan relevant partitions +select * from events where created_at > '2024-01-15'; -- Only scans events_2024_01+ + +-- Drop old data instantly +drop table events_2023_01; -- Instant vs DELETE taking hours +``` + +When to partition: + +- Tables > 100M rows +- Time-series data with date-based queries +- Need to efficiently drop old data + +Reference: [Table Partitioning](https://www.postgresql.org/docs/current/ddl-partitioning.html) diff --git a/.agents/skills/supabase-postgres-best-practices/references/schema-primary-keys.md b/.agents/skills/supabase-postgres-best-practices/references/schema-primary-keys.md new file mode 100644 index 0000000..fb0fbb1 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/schema-primary-keys.md @@ -0,0 +1,61 @@ +--- +title: Select Optimal Primary Key Strategy +impact: HIGH +impactDescription: Better index locality, reduced fragmentation +tags: primary-key, identity, uuid, serial, schema +--- + +## Select Optimal Primary Key Strategy + +Primary key choice affects insert performance, index size, and replication +efficiency. + +**Incorrect (problematic PK choices):** + +```sql +-- identity is the SQL-standard approach +create table users ( + id serial primary key -- Works, but IDENTITY is recommended +); + +-- Random UUIDs (v4) cause index fragmentation +create table orders ( + id uuid default gen_random_uuid() primary key -- UUIDv4 = random = scattered inserts +); +``` + +**Correct (optimal PK strategies):** + +```sql +-- Use IDENTITY for sequential IDs (SQL-standard, best for most cases) +create table users ( + id bigint generated always as identity primary key +); + +-- For distributed systems needing UUIDs, use UUIDv7 (time-ordered) +-- Requires pg_uuidv7 extension: create extension pg_uuidv7; +create table orders ( + id uuid default uuid_generate_v7() primary key -- Time-ordered, no fragmentation +); + +-- Alternative: time-prefixed IDs for sortable, distributed IDs (no extension needed) +create table events ( + id text default concat( + to_char(now() at time zone 'utc', 'YYYYMMDDHH24MISSMS'), + gen_random_uuid()::text + ) primary key +); +``` + +Guidelines: + +- Single database: `bigint identity` (sequential, 8 bytes, SQL-standard) +- Distributed/exposed IDs: UUIDv7 (requires pg_uuidv7) or ULID (time-ordered, no + fragmentation) +- `serial` works but `identity` is SQL-standard and preferred for new + applications +- Avoid random UUIDs (v4) as primary keys on large tables (causes index + fragmentation) + +Reference: +[Identity Columns](https://www.postgresql.org/docs/current/sql-createtable.html#SQL-CREATETABLE-PARMS-GENERATED-IDENTITY) diff --git a/.agents/skills/supabase-postgres-best-practices/references/security-privileges.md b/.agents/skills/supabase-postgres-best-practices/references/security-privileges.md new file mode 100644 index 0000000..448ec34 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/security-privileges.md @@ -0,0 +1,54 @@ +--- +title: Apply Principle of Least Privilege +impact: MEDIUM +impactDescription: Reduced attack surface, better audit trail +tags: privileges, security, roles, permissions +--- + +## Apply Principle of Least Privilege + +Grant only the minimum permissions required. Never use superuser for application queries. + +**Incorrect (overly broad permissions):** + +```sql +-- Application uses superuser connection +-- Or grants ALL to application role +grant all privileges on all tables in schema public to app_user; +grant all privileges on all sequences in schema public to app_user; + +-- Any SQL injection becomes catastrophic +-- drop table users; cascades to everything +``` + +**Correct (minimal, specific grants):** + +```sql +-- Create role with no default privileges +create role app_readonly nologin; + +-- Grant only SELECT on specific tables +grant usage on schema public to app_readonly; +grant select on public.products, public.categories to app_readonly; + +-- Create role for writes with limited scope +create role app_writer nologin; +grant usage on schema public to app_writer; +grant select, insert, update on public.orders to app_writer; +grant usage on sequence orders_id_seq to app_writer; +-- No DELETE permission + +-- Login role inherits from these +create role app_user login password 'xxx'; +grant app_writer to app_user; +``` + +Revoke public defaults: + +```sql +-- Revoke default public access +revoke all on schema public from public; +revoke all on all tables in schema public from public; +``` + +Reference: [Roles and Privileges](https://supabase.com/blog/postgres-roles-and-privileges) diff --git a/.agents/skills/supabase-postgres-best-practices/references/security-rls-basics.md b/.agents/skills/supabase-postgres-best-practices/references/security-rls-basics.md new file mode 100644 index 0000000..c61e1a8 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/security-rls-basics.md @@ -0,0 +1,50 @@ +--- +title: Enable Row Level Security for Multi-Tenant Data +impact: CRITICAL +impactDescription: Database-enforced tenant isolation, prevent data leaks +tags: rls, row-level-security, multi-tenant, security +--- + +## Enable Row Level Security for Multi-Tenant Data + +Row Level Security (RLS) enforces data access at the database level, ensuring users only see their own data. + +**Incorrect (application-level filtering only):** + +```sql +-- Relying only on application to filter +select * from orders where user_id = $current_user_id; + +-- Bug or bypass means all data is exposed! +select * from orders; -- Returns ALL orders +``` + +**Correct (database-enforced RLS):** + +```sql +-- Enable RLS on the table +alter table orders enable row level security; + +-- Create policy for users to see only their orders +create policy orders_user_policy on orders + for all + using (user_id = current_setting('app.current_user_id')::bigint); + +-- Force RLS even for table owners +alter table orders force row level security; + +-- Set user context and query +set app.current_user_id = '123'; +select * from orders; -- Only returns orders for user 123 +``` + +Policy for authenticated role: + +```sql +create policy orders_user_policy on orders + for all + to authenticated + using (user_id = auth.uid()); +``` + +Reference: [Row Level Security](https://supabase.com/docs/guides/database/postgres/row-level-security) diff --git a/.agents/skills/supabase-postgres-best-practices/references/security-rls-performance.md b/.agents/skills/supabase-postgres-best-practices/references/security-rls-performance.md new file mode 100644 index 0000000..c3c7c41 --- /dev/null +++ b/.agents/skills/supabase-postgres-best-practices/references/security-rls-performance.md @@ -0,0 +1,63 @@ +--- +title: Optimize RLS Policies for Performance +impact: HIGH +impactDescription: 5-10x faster RLS queries with proper patterns +tags: rls, performance, security, optimization +--- + +## Optimize RLS Policies for Performance + +Poorly written RLS policies can cause severe performance issues. Use subqueries and indexes strategically. + +**Incorrect (function called for every row):** + +```sql +create policy orders_policy on orders + using (auth.uid() = user_id); -- auth.uid() called per row! + +-- With 1M rows, auth.uid() is called 1M times +``` + +**Correct (wrap functions in SELECT):** + +```sql +create policy orders_policy on orders + using ((select auth.uid()) = user_id); -- Called once, cached + +-- 100x+ faster on large tables +``` + +Use security definer functions for complex checks: + +`SECURITY DEFINER` functions run with the creator's privileges and bypass RLS on any tables they touch — which is what makes them useful for internal lookups, but also what makes them dangerous if misused. Always include an explicit `auth.uid()` check inside the function body, keep them in a non-exposed schema, and revoke `EXECUTE` from any role that shouldn't call them directly. + +```sql +-- Create helper function in a private schema +create or replace function private.is_team_member(team_id bigint) +returns boolean +language sql +security definer +set search_path = '' +as $$ + select exists ( + select 1 from public.team_members + -- always check the calling user's identity inside the function + where team_id = $1 and user_id = (select auth.uid()) + ); +$$; + +-- Revoke direct execution from public roles +revoke execute on function private.is_team_member(bigint) from PUBLIC, anon, authenticated, service_role; + +-- Use in policy (indexed lookup, not per-row check) +create policy team_orders_policy on orders + using ((select private.is_team_member(team_id))); +``` + +Always add indexes on columns used in RLS policies: + +```sql +create index orders_user_id_idx on orders (user_id); +``` + +Reference: [RLS Performance](https://supabase.com/docs/guides/database/postgres/row-level-security#rls-performance-recommendations) diff --git a/.agents/skills/supabase/CHANGELOG.md b/.agents/skills/supabase/CHANGELOG.md new file mode 100644 index 0000000..16c4657 --- /dev/null +++ b/.agents/skills/supabase/CHANGELOG.md @@ -0,0 +1,97 @@ +# Changelog + +## [0.1.9](https://github.com/supabase/agent-skills/compare/v0.1.8...supabase-v0.1.9) (2026-09-28) + + +### Bug Fixes + +* **supabase:** recommend scoped personal access tokens for the Management API, CLI, and MCP ([#604](https://github.com/supabase/agent-skills/issues/604)) ([551274e](https://github.com/supabase/agent-skills/commit/551274ed2fe97c8fea1325f7ceb05803a542f8df)) + +## [0.1.8](https://github.com/supabase/agent-skills/compare/v0.1.7...supabase-v0.1.8) (2026-09-24) + + +### Features + +* **supabase:** add debugging workflows to the supabase skill ([#112](https://github.com/supabase/agent-skills/issues/112)) ([3a4f0ce](https://github.com/supabase/agent-skills/commit/3a4f0ce0782e0cbdcf187c362e8d15d9e324462b)) + + +### Bug Fixes + +* **supabase:** recommend scoped personal access tokens for the Management API, CLI, and MCP ([#604](https://github.com/supabase/agent-skills/issues/604)) ([551274e](https://github.com/supabase/agent-skills/commit/551274ed2fe97c8fea1325f7ceb05803a542f8df)) + +## [0.1.7](https://github.com/supabase/agent-skills/compare/v0.1.6...supabase-v0.1.7) (2026-08-12) + + +### Features + +* **supabase:** add debugging workflows to the supabase skill ([#112](https://github.com/supabase/agent-skills/issues/112)) ([3a4f0ce](https://github.com/supabase/agent-skills/commit/3a4f0ce0782e0cbdcf187c362e8d15d9e324462b)) + +## [0.1.6](https://github.com/supabase/agent-skills/compare/v0.1.5...supabase-v0.1.6) (2026-07-30) + + +### Features + +* add declarative schema section to schema management ([#120](https://github.com/supabase/agent-skills/issues/120)) ([94cf44f](https://github.com/supabase/agent-skills/commit/94cf44ff3a123edcf54a9af373929798cddefed8)) +* add instructions to check changelog ([#74](https://github.com/supabase/agent-skills/issues/74)) ([4bb13d8](https://github.com/supabase/agent-skills/commit/4bb13d858d19f1f848505a66f46fc9603fdcde95)) +* add npm supply-chain security guidance to supabase skill ([#94](https://github.com/supabase/agent-skills/issues/94)) ([82df90a](https://github.com/supabase/agent-skills/commit/82df90a5de1cd84386d8bc192746e50343b86dc0)) +* instructions on exposing tables to the data api ([#71](https://github.com/supabase/agent-skills/issues/71)) ([f15a5a4](https://github.com/supabase/agent-skills/commit/f15a5a40779072a530c9e53c3f14ec4131118ea6)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* bump supabase skill to v0.1.1 and fix Data API broken link ([#72](https://github.com/supabase/agent-skills/issues/72)) ([5a6542e](https://github.com/supabase/agent-skills/commit/5a6542e08fc026d90c9a6a0f5a67749e9ceb9946)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* update Data API doc link and bump supabase skill to v0.1.1 ([#73](https://github.com/supabase/agent-skills/issues/73)) ([e5f7a7c](https://github.com/supabase/agent-skills/commit/e5f7a7cfd697765848ffd6a4505f3c02e1ee17ee)) + +## [0.1.5](https://github.com/supabase/agent-skills/compare/v0.1.4...v0.1.5) (2026-07-10) + + +### Features + +* add declarative schema section to schema management ([#120](https://github.com/supabase/agent-skills/issues/120)) ([94cf44f](https://github.com/supabase/agent-skills/commit/94cf44ff3a123edcf54a9af373929798cddefed8)) +* add instructions to check changelog ([#74](https://github.com/supabase/agent-skills/issues/74)) ([4bb13d8](https://github.com/supabase/agent-skills/commit/4bb13d858d19f1f848505a66f46fc9603fdcde95)) +* add npm supply-chain security guidance to supabase skill ([#94](https://github.com/supabase/agent-skills/issues/94)) ([82df90a](https://github.com/supabase/agent-skills/commit/82df90a5de1cd84386d8bc192746e50343b86dc0)) +* instructions on exposing tables to the data api ([#71](https://github.com/supabase/agent-skills/issues/71)) ([f15a5a4](https://github.com/supabase/agent-skills/commit/f15a5a40779072a530c9e53c3f14ec4131118ea6)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* bump supabase skill to v0.1.1 and fix Data API broken link ([#72](https://github.com/supabase/agent-skills/issues/72)) ([5a6542e](https://github.com/supabase/agent-skills/commit/5a6542e08fc026d90c9a6a0f5a67749e9ceb9946)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* update Data API doc link and bump supabase skill to v0.1.1 ([#73](https://github.com/supabase/agent-skills/issues/73)) ([e5f7a7c](https://github.com/supabase/agent-skills/commit/e5f7a7cfd697765848ffd6a4505f3c02e1ee17ee)) + +## [0.1.4](https://github.com/supabase/agent-skills/compare/v0.1.3...v0.1.4) (2026-06-05) + + +### Features + +* add instructions to check changelog ([#74](https://github.com/supabase/agent-skills/issues/74)) ([4bb13d8](https://github.com/supabase/agent-skills/commit/4bb13d858d19f1f848505a66f46fc9603fdcde95)) +* add npm supply-chain security guidance to supabase skill ([#94](https://github.com/supabase/agent-skills/issues/94)) ([82df90a](https://github.com/supabase/agent-skills/commit/82df90a5de1cd84386d8bc192746e50343b86dc0)) +* instructions on exposing tables to the data api ([#71](https://github.com/supabase/agent-skills/issues/71)) ([f15a5a4](https://github.com/supabase/agent-skills/commit/f15a5a40779072a530c9e53c3f14ec4131118ea6)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* bump supabase skill to v0.1.1 and fix Data API broken link ([#72](https://github.com/supabase/agent-skills/issues/72)) ([5a6542e](https://github.com/supabase/agent-skills/commit/5a6542e08fc026d90c9a6a0f5a67749e9ceb9946)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* update Data API doc link and bump supabase skill to v0.1.1 ([#73](https://github.com/supabase/agent-skills/issues/73)) ([e5f7a7c](https://github.com/supabase/agent-skills/commit/e5f7a7cfd697765848ffd6a4505f3c02e1ee17ee)) + +## [0.1.3](https://github.com/supabase/agent-skills/compare/v0.1.2...v0.1.3) (2026-06-02) + + +### Features + +* add instructions to check changelog ([#74](https://github.com/supabase/agent-skills/issues/74)) ([4bb13d8](https://github.com/supabase/agent-skills/commit/4bb13d858d19f1f848505a66f46fc9603fdcde95)) +* add npm supply-chain security guidance to supabase skill ([#94](https://github.com/supabase/agent-skills/issues/94)) ([82df90a](https://github.com/supabase/agent-skills/commit/82df90a5de1cd84386d8bc192746e50343b86dc0)) +* instructions on exposing tables to the data api ([#71](https://github.com/supabase/agent-skills/issues/71)) ([f15a5a4](https://github.com/supabase/agent-skills/commit/f15a5a40779072a530c9e53c3f14ec4131118ea6)) +* using Supabase agent skills ([#12](https://github.com/supabase/agent-skills/issues/12)) ([7c2e389](https://github.com/supabase/agent-skills/commit/7c2e3894fddfde8eb6c77d2a8921904543b9be7a)) + + +### Bug Fixes + +* bump supabase skill to v0.1.1 and fix Data API broken link ([#72](https://github.com/supabase/agent-skills/issues/72)) ([5a6542e](https://github.com/supabase/agent-skills/commit/5a6542e08fc026d90c9a6a0f5a67749e9ceb9946)) +* cover SECURITY DEFINER, auth.role() deprecation, and BOLA in security checklist ([#85](https://github.com/supabase/agent-skills/issues/85)) ([133f43e](https://github.com/supabase/agent-skills/commit/133f43e8c2ffc48823ff0630c692cabecea3e3a3)) +* update Data API doc link and bump supabase skill to v0.1.1 ([#73](https://github.com/supabase/agent-skills/issues/73)) ([e5f7a7c](https://github.com/supabase/agent-skills/commit/e5f7a7cfd697765848ffd6a4505f3c02e1ee17ee)) diff --git a/.agents/skills/supabase/SKILL.md b/.agents/skills/supabase/SKILL.md new file mode 100644 index 0000000..66093e0 --- /dev/null +++ b/.agents/skills/supabase/SKILL.md @@ -0,0 +1,155 @@ +--- +name: supabase +description: "Use when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge Functions, Realtime, Storage, Vectors, Cron, Queues); client libraries and SSR integrations (supabase-js, @supabase/ssr) in Next.js, React, SvelteKit, Astro, Remix; auth issues (login, logout, sessions, JWT, cookies, getSession, getUser, getClaims, RLS); Supabase CLI or MCP server; schema changes, migrations, declarative schemas, security audits, Postgres extensions (pg_graphql, pg_cron, pg_vector); debugging and troubleshooting errors or unexpected behavior on Supabase projects (HTTP errors, Postgres errors, RLS surprises, permission denied, schema cache issues, timeouts, Edge Function crashes, Realtime drops, Storage failures) and reading or querying logs (Logs Explorer, ClickHouse)." +metadata: + author: supabase + version: "0.1.2" +--- + +# Supabase + +## Core Principles + +**1. Supabase changes frequently — verify against changelog and current docs before implementing.** +Do not rely on training data for Supabase features. Function signatures, config.toml settings, and API conventions change between versions. + +First, fetch `https://supabase.com/changelog.md` (a lightweight summary index — not a heavy pull), scan for `breaking-change` tags relevant to your task, and follow the linked page for any that apply. Then look up the relevant topic using the documentation access methods below. + +**2. Verify your work.** +After implementing any fix, run a test query to confirm the change works. A fix without verification is incomplete. + +**3. Recover from errors, don't loop.** +If an approach fails after 2-3 attempts, stop and reconsider. Try a different method, check documentation, inspect the error more carefully, and review relevant logs when available. Supabase issues are not always solved by retrying the same command, and the answer is not always in the logs, but logs are often worth checking before proceeding. + +**4. Exposing tables to the Data API:** Depending on the user's [Data API settings](https://supabase.com/dashboard/project//integrations/data_api/settings), newly created tables may not be automatically exposed via the Data (REST) API. If this is the case, `anon` and `authenticated` roles will need to be explicitly granted access. + +> Note that this is separate from RLS, which controls which _rows_ are visible once a table is accessible, not whether the table is accessible at all. + +When a user reports a SQL-created table is unexpectedly inaccessible, check their Data API settings and whether the roles have been granted access via explicit `GRANT` SQL. When granting public (`anon`/`authenticated`) access, always enable RLS too. See [Exposing a Table to the Data API](https://supabase.com/docs/guides/api/securing-your-api.md) for the full setup workflow. + +**5. RLS in exposed schemas.** +Enable RLS on every table in any exposed schema, which includes `public` by default. This is critical in Supabase because tables in exposed schemas can be reachable through the Data API when the `anon`/`authenticated` roles have access (see [Exposing a Table to the Data API](https://supabase.com/docs/guides/api/securing-your-api.md)). For private schemas, prefer RLS as defense in depth. After enabling RLS, create policies that match the actual access model rather than defaulting every table to the same `auth.uid()` pattern. + +**6. Security checklist.** +When working on any Supabase task that touches auth, RLS, views, storage, or user data, run through this checklist. These are Supabase-specific security traps that silently create vulnerabilities: + +- **Auth and session security** + - **Never use `user_metadata` claims in JWT-based authorization decisions.** In Supabase, `raw_user_meta_data` is user-editable and can appear in `auth.jwt()`, so it is unsafe for RLS policies or any other authorization logic. Store authorization data in `raw_app_meta_data` / `app_metadata` instead. + - **Deleting a user does not invalidate existing access tokens.** Sign out or revoke sessions first, keep JWT expiry short for sensitive apps, and for strict guarantees validate `session_id` against `auth.sessions` on sensitive operations. + - **If you use `app_metadata` or `auth.jwt()` for authorization, remember JWT claims are not always fresh until the user's token is refreshed.** + +- **API key and client exposure** + - **Never expose the `service_role` or secret key in public clients.** Prefer publishable keys for frontend code. Legacy `anon` keys are only for compatibility. In Next.js, any `NEXT_PUBLIC_` env var is sent to the browser. + - **Use scoped personal access tokens for the Management API, CLI, and MCP server.** A classic personal access token carries the user's full account access, on every organization and project. For scripts, CI, and agents, have the user create a scoped token limited to the organizations, projects, and permissions the task needs. The [personal access tokens guide](https://supabase.com/docs/guides/platform/personal-access-tokens.md) lists the permission each Management API endpoint and MCP tool requires. Look permissions up there rather than guessing. + +- **RLS, views, and privileged database code** + - **Views bypass RLS by default.** In Postgres 15 and above, use `CREATE VIEW ... WITH (security_invoker = true)`. In older versions of Postgres, protect your views by revoking access from the `anon` and `authenticated` roles, or by putting them in an unexposed schema. + - **UPDATE requires a SELECT policy.** In Postgres RLS, an UPDATE needs to first SELECT the row. Without a SELECT policy, updates silently return 0 rows — no error, just no change. + - **`auth.role()` is deprecated — use the `TO` clause instead.** Supabase has deprecated `auth.role()` in favour of specifying the target role directly on the policy with `TO authenticated` or `TO anon`. Beyond deprecation, `auth.role() = 'authenticated'` breaks silently when anonymous sign-ins are enabled, because anonymous users carry the `authenticated` Postgres role and pass the check regardless of whether the user is genuinely signed in. + ```sql + -- Deprecated (do not use) + create policy "example" on table_name for select + using ( auth.role() = 'authenticated' ); + ``` + - **`TO authenticated` alone is authentication without authorization (BOLA / IDOR).** Using `TO authenticated` only checks the role — it does not restrict which rows a user can access. The correct pattern combines `TO authenticated` with an ownership predicate in `USING`: + ```sql + create policy "example" on table_name for select + to authenticated + using ( (select auth.uid()) = user_id ); + ``` + - **UPDATE policies require both `USING` and `WITH CHECK`.** Without `WITH CHECK`, a user can reassign a row's `user_id` to another user: + ```sql + create policy "example" on table_name for update + to authenticated + using ( (select auth.uid()) = user_id ) + with check ( (select auth.uid()) = user_id ); + ``` + - **`SECURITY DEFINER` functions bypass RLS.** A `SECURITY DEFINER` function runs with its creator's privileges — typically a role with `bypassrls` (e.g., `postgres`). Never add `SECURITY DEFINER` to resolve a permission error; it silently removes access control without fixing the underlying cause. Prefer `SECURITY INVOKER`. + - **`SECURITY DEFINER` functions in `public` are callable by all roles.** Postgres grants `EXECUTE` to `PUBLIC` by default for every new function, so any `SECURITY DEFINER` function in `public` is a public API endpoint callable by `anon` and `authenticated` (which inherit from `PUBLIC`) without any additional grant. When `SECURITY DEFINER` is genuinely needed (e.g., bypassing RLS on an internal lookup table), keep the function in a non-exposed schema, always include an `auth.uid()` check in the function body, and run `supabase db advisors` after making changes. + +- **Storage access control** + - **Storage upsert requires INSERT + SELECT + UPDATE.** Granting only INSERT allows new uploads but file replacement (upsert) silently fails. You need all three. + +- **Dependency and supply-chain security** + - **Always pin package versions and commit lockfiles** when installing Supabase packages (`supabase-js`, `@supabase/ssr`, `supabase-py`, etc.). See the [npm security guide](https://supabase.com/docs/guides/security/npm-security.md) for the full checklist. + +For any security concern not covered above, fetch the Supabase product security index: `https://supabase.com/docs/guides/security/product-security.md` + +## Supabase CLI + +Always discover commands via `--help` — never guess. The CLI structure changes between versions. + +```bash +supabase --help # All top-level commands +supabase --help # Subcommands (e.g., supabase db --help) +supabase --help # Flags for a specific command +``` + +**Supabase CLI Known gotchas:** + +- `supabase db query` requires **CLI v2.79.0+** → use MCP `execute_sql` or `psql` as fallback +- `supabase db advisors` requires **CLI v2.81.3+** → use MCP `get_advisors` as fallback +- The browser flow of `supabase login` creates a classic token with full account access. In CI, set `SUPABASE_ACCESS_TOKEN` to a scoped personal access token instead. It takes precedence over any saved login. Commands that connect with the database password (`--password` or `SUPABASE_DB_PASSWORD`, for example `supabase db push`) aren't limited by the token's permissions. +- In imperative migration projects, create new hand-authored migration files with `supabase migration new ` first. Never invent a migration filename or rely on memory for the expected format. Declarative schema projects generate migrations from `supabase/schemas/`; see "Making and Committing Schema Changes" below. + +**Version check and upgrade:** Run `supabase --version` to check. For CLI changelogs and version-specific features, consult the [CLI documentation](https://supabase.com/docs/reference/cli/introduction) or [GitHub releases](https://github.com/supabase/cli/releases). + +## Supabase MCP Server + +For setup instructions, server URL, and configuration, see the [MCP setup guide](https://supabase.com/docs/guides/getting-started/mcp). + +**Troubleshooting connection issues** — follow these steps in order: + +1. **Check if the server is reachable:** + `curl -so /dev/null -w "%{http_code}" https://mcp.supabase.com/mcp` + A `401` is expected (no token) and means the server is up. Timeout or "connection refused" means it may be down. + +2. **Check `.mcp.json` configuration:** + Verify the project root has a valid `.mcp.json` with the correct server URL. If missing, create one pointing to `https://mcp.supabase.com/mcp`. + +3. **Authenticate the MCP server:** + If the server is reachable and `.mcp.json` is correct but tools aren't visible, the user needs to authenticate. The Supabase MCP server uses OAuth 2.1 — tell the user to trigger the auth flow in their agent, complete it in the browser, and reload the session. + In CI or other environments where the browser flow can't run, pass a scoped personal access token in the `Authorization: Bearer` header instead. + +4. **Check scoped token permissions:** + If a tool fails with "You do not have permission to perform this action" while using a scoped personal access token, the token lacks that tool's permission or the project is outside the token's scope. Check the tool's required permission in the [personal access tokens guide](https://supabase.com/docs/guides/platform/personal-access-tokens.md#mcp-tools). + +## Supabase Documentation + +Before implementing any Supabase feature, find the relevant documentation. Use these methods in priority order: + +1. **MCP `search_docs` tool** (preferred — returns relevant snippets directly) +2. **Fetch docs pages as markdown** — any docs page can be fetched by appending `.md` to the URL path. +3. **Web search** for Supabase-specific topics when you don't know which page to look at. + +## Making and Committing Schema Changes + +First decide which schema workflow the project uses. + +### Option A: Declarative schemas + +Use this when `supabase/schemas/` exists or `config.toml` sets `schema_paths`. Edit the desired schema state in those files, then generate and review the migration. Do not start by hand-writing a migration. See the [Declarative database schemas guide](https://supabase.com/docs/guides/local-development/declarative-database-schemas). + +### Option B: Imperative migrations + +Use this when the project does not use declarative schemas. + +**To make schema changes, use `execute_sql` (MCP) or `supabase db query` (CLI).** These run SQL directly on the database without creating migration history entries, so you can iterate freely and generate a clean migration when ready. + +Do NOT use `apply_migration` to change a local database schema — it writes a migration history entry on every call, which means you can't iterate, and `supabase db diff` / `supabase db pull` will produce empty or conflicting diffs. If you use it, you'll be stuck with whatever SQL you passed on the first try. + +**When ready to commit** your changes to a migration file: + +1. **Run advisors** → `supabase db advisors` (CLI v2.81.3+) or MCP `get_advisors`. Fix any issues. +2. **Review the Security Checklist above** if your changes involve views, functions, triggers, or storage. +3. **Generate the migration** → `supabase db pull --local --yes` +4. **Verify** → `supabase migration list --local` + +## Debugging + +When you get an error on a Supabase-related request, for example an error code from the Supabase REST API, Postgres database, or PostgREST, an empty result, getting blocked by RLS unexpectedly, or an error from a Supabase service like Auth, Realtime, Edge Functions, or Storage, you **must** fetch Supabase's [Monitoring and Debugging](https://supabase.com/docs/guides/monitoring-and-debugging.md) documentation before diagnosing or proposing a fix, rather than working from memory. The same docs also cover performance optimizations, such as slow queries and missing indexes. + +## Reference Guides + +- **Skill Feedback** → [references/skill-feedback.md](references/skill-feedback.md) + **MUST read when** the user reports that this skill gave incorrect guidance or is missing information. diff --git a/.agents/skills/supabase/assets/feedback-issue-template.md b/.agents/skills/supabase/assets/feedback-issue-template.md new file mode 100644 index 0000000..e810825 --- /dev/null +++ b/.agents/skills/supabase/assets/feedback-issue-template.md @@ -0,0 +1,17 @@ +## What happened + +**Task:** + +**Skill said:** + +**Expected:** + +## Source + +**File:** + +**Section:** + +## Fix suggestion + + diff --git a/.agents/skills/supabase/references/skill-feedback.md b/.agents/skills/supabase/references/skill-feedback.md new file mode 100644 index 0000000..9c047d5 --- /dev/null +++ b/.agents/skills/supabase/references/skill-feedback.md @@ -0,0 +1,17 @@ +# Skill Feedback + +Use this when the user reports that the skill gave incorrect guidance, is missing information, or could be improved. This is about the skill (agent instructions), not about Supabase the product. + +## Steps + +1. **Ask permission** — Ask the user if they'd like to submit feedback to the skill maintainers. If they decline, move on. + +2. **Draft the issue** — Use the template at [assets/feedback-issue-template.md](../assets/feedback-issue-template.md) to structure the feedback. Fill in the fields based on the conversation. Always identify which specific reference file and section caused the problem. + +3. **Submit** — Create a GitHub Issue on the `supabase/agent-skills` repository using the draft as the issue body. The title must follow this format: `user-feedback: `. + +4. **Share the result** — Share the issue URL with the user after submission. If submission fails, give the user this link to create the issue manually: + +``` +https://github.com/supabase/agent-skills/issues/new +``` diff --git a/skills-lock.json b/skills-lock.json new file mode 100644 index 0000000..ec1c036 --- /dev/null +++ b/skills-lock.json @@ -0,0 +1,17 @@ +{ + "version": 1, + "skills": { + "supabase": { + "source": "supabase/agent-skills", + "sourceType": "github", + "skillPath": "skills/supabase/SKILL.md", + "computedHash": "af1844ade632808fc0c15cf2db87daf3b2431c5262dc8a0c3ea7d70880fadf91" + }, + "supabase-postgres-best-practices": { + "source": "supabase/agent-skills", + "sourceType": "github", + "skillPath": "skills/supabase-postgres-best-practices/SKILL.md", + "computedHash": "128fac78002d916c8ca908245d398e634f540d8bcf20915b2b2359aeb18eba59" + } + } +} From 98b03310ac8d75959c329e0d4323e2083fa08f4a Mon Sep 17 00:00:00 2001 From: regeloapp-coder Date: Mon, 26 Oct 2026 09:36:36 +0100 Subject: [PATCH 2/3] Harden reading state and privacy flows Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- README.md | 8 ++ .../java/hu/regelo/app/data/AuthRepository.kt | 3 +- .../java/hu/regelo/app/data/BookRepository.kt | 2 +- .../hu/regelo/app/data/CommunityRepository.kt | 3 + .../hu/regelo/app/data/GdprPrivacyManager.kt | 62 +------------ app/src/main/java/hu/regelo/app/data/Local.kt | 3 +- .../hu/regelo/app/data/ReadingRepository.kt | 41 +++----- .../regelo/app/data/SecureSessionManager.kt | 79 +++++++++++----- .../hu/regelo/app/ui/screens/LibraryScreen.kt | 2 +- .../hu/regelo/app/ui/screens/ReaderScreen.kt | 4 +- supabase/2026-10-26_app_v1_4.sql | 93 +++++++++++++++++++ supabase/tests/reading_state_v1_4.sql | 78 ++++++++++++++++ 12 files changed, 264 insertions(+), 114 deletions(-) create mode 100644 supabase/2026-10-26_app_v1_4.sql create mode 100644 supabase/tests/reading_state_v1_4.sql diff --git a/README.md b/README.md index 0aa4126..749f51d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ Az APK: `app/build/outputs/apk/debug/app-debug.apk` ## Adatbázis A `supabase/` mappában lévő SQL fájlok idempotensek (többször is futtathatók) a Supabase SQL Editorban. +A kliens frissítésének kiadása előtt futtasd a `supabase/2026-10-26_app_v1_4.sql` migrációt a v1.3 után; +az idempotens olvasásbefejezés RPC-t igényli. A hozzá tartozó adatbázis-tesztsor: +`supabase/tests/reading_state_v1_4.sql`. ## Mentés Ez a mappa a teljes forráskód. Készíts róla rendszeresen másolatot (pl. OneDrive vagy GitHub privát tároló), @@ -22,6 +25,11 @@ hogy egy véletlen törlés ne okozzon gondot. Hivatalos e-mail: regeloapp@gmail.com · Hivatalos profil az appban: @regelohivatalos (moderátor, hírei minden felhasználónak mennek). ## Változások +- **v1.4 backend-kiegészítés** – A könyv befejezésének mentése szerveroldali, idempotens művelet, + amely a budapesti naptári évet és az adatbázisban szereplő publikált/befejezett állapotot használja. + A rate limit párhuzamos kéréseknél is atomikusan érvényesül. A kliens nem ment tokent titkosítatlanul, + az adat-export a teljes, szerveroldali GDPR-exportot használja, és a Room frissítés nem törli csendben + az ismeretlen sémájú helyi adatokat. - **1.3.0** – Hivatalos kiadványok, adatvédelem és biztonság: a Regélő négy, folyamatosan bővülő hivatalos „könyve” (Hírek, Kihívások, Heti válogatás, Kávéház) – az új részeket a szerver automatikusan teszi közzé (hírből, kihívásból, heti válogatásból, beszélgetésindítóból); „A Regélőtől” sáv a Könyvtárban diff --git a/app/src/main/java/hu/regelo/app/data/AuthRepository.kt b/app/src/main/java/hu/regelo/app/data/AuthRepository.kt index df9df70..0db177e 100644 --- a/app/src/main/java/hu/regelo/app/data/AuthRepository.kt +++ b/app/src/main/java/hu/regelo/app/data/AuthRepository.kt @@ -182,7 +182,7 @@ class AuthRepository { */ suspend fun exportMyData(): String { val raw = AppGraph.supabase.postgrest.rpc("regelo_export_my_data").data - return runCatching { prettyJson.encodeToString(JsonElement.serializer(), Json.parseToJsonElement(raw)) }.getOrDefault(raw) + return prettyJson.encodeToString(JsonElement.serializer(), Json.parseToJsonElement(raw)) } /** @@ -216,6 +216,7 @@ class AuthRepository { AppGraph.db.versions().clear() AppGraph.db.dailyWords().clear() AppGraph.settings.setLastUserId(null) + AppGraph.settings.setLastPushToken(null) // A 18+ megerősítés személyhez kötött: másik fiókkal újra meg kell erősíteni. runCatching { AppGraph.settings.setShowAdult(false) } AppGraph.profiles.clear() diff --git a/app/src/main/java/hu/regelo/app/data/BookRepository.kt b/app/src/main/java/hu/regelo/app/data/BookRepository.kt index 98a6134..bf100d3 100644 --- a/app/src/main/java/hu/regelo/app/data/BookRepository.kt +++ b/app/src/main/java/hu/regelo/app/data/BookRepository.kt @@ -52,7 +52,7 @@ class BookRepository { val books = AppGraph.supabase.from("books").select { filter { eq("publish_status", PublishStatus.PUBLISHED) - if (official.isNotEmpty()) notIn("id", filterValues(official)) + if (official.isNotEmpty()) filterNot("id", FilterOperator.IN, filterValues(official)) // 18+ művek csak életkor-megerősítés után jelennek meg. if (!adult) neq("age_rating", "18+") if (q.isNotEmpty()) { diff --git a/app/src/main/java/hu/regelo/app/data/CommunityRepository.kt b/app/src/main/java/hu/regelo/app/data/CommunityRepository.kt index 56b0a7b..3d7f19b 100644 --- a/app/src/main/java/hu/regelo/app/data/CommunityRepository.kt +++ b/app/src/main/java/hu/regelo/app/data/CommunityRepository.kt @@ -196,6 +196,7 @@ class CommunityRepository { } suspend fun challenges(): List { + hu.regelo.app.util.ServerClock.sync() val list = db.from("writing_challenges").select { order("voting_deadline", Order.DESCENDING) limit(100) @@ -213,6 +214,7 @@ class CommunityRepository { /** A most nevezhető kihívások (az Írás fül felhívásához). */ suspend fun openForSubmission(): List { + hu.regelo.app.util.ServerClock.sync() val now = java.time.Instant.ofEpochMilli(hu.regelo.app.util.ServerClock.now()).toString() return db.from("writing_challenges").select { filter { @@ -224,6 +226,7 @@ class CommunityRepository { } suspend fun challenge(id: String): ChallengeDetail { + hu.regelo.app.util.ServerClock.sync() val c = db.from("writing_challenges").select { filter { eq("id", id) } }.decodeSingleOrNull() ?: error("Ez a kihívás már nem létezik.") val me = AppGraph.auth.userId diff --git a/app/src/main/java/hu/regelo/app/data/GdprPrivacyManager.kt b/app/src/main/java/hu/regelo/app/data/GdprPrivacyManager.kt index 06f053d..e78a5c5 100644 --- a/app/src/main/java/hu/regelo/app/data/GdprPrivacyManager.kt +++ b/app/src/main/java/hu/regelo/app/data/GdprPrivacyManager.kt @@ -1,30 +1,6 @@ package hu.regelo.app.data import hu.regelo.app.AppGraph -import hu.regelo.app.util.nowMs -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.withContext -import kotlinx.serialization.Serializable - -/** GDPR felhasználói adat-exportálási DTO. */ -@Serializable -data class GdprUserDataExportDto( - val exportedAtMs: Long, - val userId: String?, - val displayName: String?, - val bio: String?, - val notesCount: Int, - val notes: List, -) - -@Serializable -data class ReaderNoteExportDto( - val bookId: String, - val chapterTitle: String, - val quote: String, - val note: String, - val updatedAt: Long -) /** * Adatvédelmi kezelő (GDPR Art. 17 & Art. 20): @@ -33,39 +9,9 @@ data class ReaderNoteExportDto( */ class GdprPrivacyManager { - /** Összesíti és kiexportálja a bejelentkezett felhasználó személyes adatait. */ - suspend fun exportUserData(): String = withContext(Dispatchers.IO) { - val uid = AppGraph.auth.userId ?: error("Nincs bejelentkezett felhasználó.") - val profile = runCatching { AppGraph.profiles.get(uid) }.getOrNull() - val allNotes = runCatching { AppGraph.reading.allNotes() }.getOrDefault(emptyList()) - - val export = GdprUserDataExportDto( - exportedAtMs = nowMs(), - userId = uid, - displayName = profile?.displayName, - bio = profile?.bio, - notesCount = allNotes.size, - notes = allNotes.map { n -> - ReaderNoteExportDto( - bookId = n.bookId, - chapterTitle = n.chapterTitle, - quote = n.quote, - note = n.note, - updatedAt = n.updatedAt - ) - } - ) - AppGraph.json.encodeToString(GdprUserDataExportDto.serializer(), export) - } + /** Az exportot a szerver állítja össze, hogy a teljes fiókadat-készletet tartalmazza. */ + suspend fun exportUserData(): String = AppGraph.auth.exportMyData() - /** Törli a helyi adatbázist, munkamenet-kulcsokat, és kijelentkezteti a felhasználót. */ - suspend fun purgeLocalDataAndSignOut() = withContext(Dispatchers.IO) { - // 1. Töröljük a helyi adatbázis összes tábláját - runCatching { AppGraph.db.clearAllTables() } - // 2. Töröljük a gyorsítótárakat - AppGraph.reading.clear() - AppGraph.official.clear() - // 3. Kijelentkezés és munkamenet törlése - AppGraph.auth.signOut() - } + /** A közös kijelentkezési útvonal a helyi táblákat és az összes fiókhoz kötött cache-t törli. */ + suspend fun purgeLocalDataAndSignOut() = AppGraph.auth.signOut() } diff --git a/app/src/main/java/hu/regelo/app/data/Local.kt b/app/src/main/java/hu/regelo/app/data/Local.kt index ae63e4b..1a4176f 100644 --- a/app/src/main/java/hu/regelo/app/data/Local.kt +++ b/app/src/main/java/hu/regelo/app/data/Local.kt @@ -259,9 +259,8 @@ abstract class RegeloDatabase : RoomDatabase() { fun create(context: Context): RegeloDatabase = Room.databaseBuilder(context, RegeloDatabase::class.java, "regelo-v1.db") - // Kézi migráció: a feltöltetlen piszkozatok soha nem vesznek el sémaváltáskor. + // Kézi migráció: ismeretlen sémaváltásnál inkább hibázzunk, mint hogy töröljük a piszkozatokat. .addMigrations(MIGRATION_1_2) - .fallbackToDestructiveMigration(dropAllTables = true) .build() } } diff --git a/app/src/main/java/hu/regelo/app/data/ReadingRepository.kt b/app/src/main/java/hu/regelo/app/data/ReadingRepository.kt index 30c5e67..0124ec0 100644 --- a/app/src/main/java/hu/regelo/app/data/ReadingRepository.kt +++ b/app/src/main/java/hu/regelo/app/data/ReadingRepository.kt @@ -3,6 +3,7 @@ package hu.regelo.app.data import hu.regelo.app.AppGraph import hu.regelo.app.util.nowMs import io.github.jan.supabase.postgrest.from +import io.github.jan.supabase.postgrest.postgrest import io.github.jan.supabase.postgrest.query.Order import kotlinx.serialization.json.JsonObject import kotlinx.serialization.json.buildJsonObject @@ -26,9 +27,9 @@ class ReadingRepository { /** Könyvenkénti gyorsítótár, hogy az olvasó lapozáskor ne kérdezze le újra. */ private val notesCache = java.util.concurrent.ConcurrentHashMap>() - private val finishedThisSession: MutableSet = java.util.concurrent.ConcurrentHashMap.newKeySet() + private val finishing: MutableSet = java.util.concurrent.ConcurrentHashMap.newKeySet() - fun clear() { notesCache.clear(); finishedThisSession.clear() } + fun clear() { notesCache.clear(); finishing.clear() } // ---------- Jegyzetek és kiemelések ---------- @@ -115,36 +116,23 @@ class ReadingRepository { // ---------- Végigolvasott könyvek és éves cél ---------- - private fun yearOf(ms: Long): Int = Instant.ofEpochMilli(ms).atZone(ZoneId.systemDefault()).year + private fun yearOf(ms: Long): Int = Instant.ofEpochMilli(ms).atZone(ZoneId.of("Europe/Budapest")).year /** * Végigolvasás azonosítója: „év:könyv”, így egy újraolvasás a következő évben külön számít, * és nem írja felül a tavalyi bejegyzést. (A régi, csak könyvazonosítós bejegyzéseket is olvassuk.) */ - private fun finishedKey(year: Int, bookId: String) = "$year:$bookId" - /** A könyv végére érve egyszer rögzítjük (évenként számít bele a kihívásba). */ - suspend fun markFinished(bookId: String, title: String): Boolean { - val year = LocalDate.now().year - val key = finishedKey(year, bookId) - if (!finishedThisSession.add(key)) return false - val uid = AppGraph.auth.userId ?: run { finishedThisSession -= key; return false } + suspend fun markFinished(bookId: String): Boolean { + if (AppGraph.auth.userId == null) return false + if (!finishing.add(bookId)) return false try { - val thisYear = finishedBooks().any { it.bookId == bookId && yearOf(it.finishedAt) == year } - if (thisYear) return false - val now = nowMs() - db.from(table).upsert( - LibraryItemDto(uid, "FINISHED", key, buildJsonObject { - put("book_id", bookId) - put("title", title.take(200)) - put("finished_at", now) - put("year", year) - }, false, now) - ) { onConflict = "user_id,kind,item_id" } - return true - } catch (e: Exception) { - finishedThisSession -= key // hiba esetén később újra próbálhatjuk - throw e + return db.postgrest.rpc( + "regelo_mark_book_finished", + buildJsonObject { put("p_book_id", bookId) }, + ).decodeAs() + } finally { + finishing -= bookId } } @@ -168,10 +156,9 @@ class ReadingRepository { db.from(table).upsert(LibraryItemDto(uid, "FINISHED", item.itemId, JsonObject(emptyMap()), true, nowMs())) { onConflict = "user_id,kind,item_id" } - finishedThisSession -= finishedKey(yearOf(item.finishedAt), item.bookId) } - suspend fun challenge(year: Int = LocalDate.now().year): ReadingChallenge { + suspend fun challenge(year: Int = java.time.LocalDate.now(ZoneId.of("Europe/Budapest")).year): ReadingChallenge { val uid = AppGraph.auth.userId ?: return ReadingChallenge(year, 0, emptyList()) val goal = db.from(table).select { filter { diff --git a/app/src/main/java/hu/regelo/app/data/SecureSessionManager.kt b/app/src/main/java/hu/regelo/app/data/SecureSessionManager.kt index 865ac83..2e5e237 100644 --- a/app/src/main/java/hu/regelo/app/data/SecureSessionManager.kt +++ b/app/src/main/java/hu/regelo/app/data/SecureSessionManager.kt @@ -8,6 +8,7 @@ import androidx.core.content.edit import io.github.jan.supabase.auth.SessionManager import io.github.jan.supabase.auth.SettingsSessionManager import io.github.jan.supabase.auth.user.UserSession +import kotlinx.coroutines.CancellationException import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.withLock @@ -26,26 +27,32 @@ import javax.crypto.spec.GCMParameterSpec * * - Első indításkor a korábbi, titkosítatlan munkamenetet átveszi és törli (nem kell újra bejelentkezni). * - Ha a titkosított adat nem olvasható (pl. visszaállított telefonon), tiszta kijelentkezett állapot lesz. - * - Ha a Keystore ezen a készüléken nem működik, a régi tárolóra esik vissza, hogy a bejelentkezés megmaradjon. + * - Ha a Keystore nem működik, a munkamenet mentése meghiúsul; tokenek soha nem kerülnek vissza sima szövegbe. */ class SecureSessionManager(context: Context) : SessionManager { private val prefs = context.applicationContext.getSharedPreferences(PREFS, Context.MODE_PRIVATE) private val legacy = SettingsSessionManager() private val json = Json { encodeDefaults = true; ignoreUnknownKeys = true } private val lock = Mutex() - @Volatile private var keystoreBroken = false override suspend fun saveSession(session: UserSession) { lock.withLock { withContext(Dispatchers.IO) { val plain = json.encodeToString(UserSession.serializer(), session) - val stored = if (keystoreBroken) null else runCatching { encrypt(plain) }.onFailure { report(it, "save") }.getOrNull() - if (stored != null) { + val stored = try { + encrypt(plain) + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "save") + throw IllegalStateException("A munkamenet biztonságos mentése nem sikerült.", e) + } + try { prefs.edit { putString(KEY, stored) } - runCatching { legacy.deleteSession() } - } else { - keystoreBroken = true - legacy.saveSession(session) + legacy.deleteSession() + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "save") + throw IllegalStateException("A munkamenet biztonságos mentése nem sikerült.", e) } } } @@ -54,20 +61,39 @@ class SecureSessionManager(context: Context) : SessionManager { override suspend fun loadSession(): UserSession? = lock.withLock { withContext(Dispatchers.IO) { prefs.getString(KEY, null)?.let { stored -> - runCatching { json.decodeFromString(UserSession.serializer(), decrypt(stored)) } - .onSuccess { return@withContext it } - .onFailure { - report(it, "load") - prefs.edit { remove(KEY) } - } + try { + val session = json.decodeFromString(UserSession.serializer(), decrypt(stored)) + discardLegacySession() + return@withContext session + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "load") + prefs.edit { remove(KEY) } + discardLegacySession() + return@withContext null + } + } + + // A régi, titkosítatlan munkamenetet egyszer titkosítva átvesszük, majd eltávolítjuk. + val old = try { + legacy.loadSession() + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "legacy-load") + discardLegacySession() + return@withContext null + } ?: return@withContext null + try { + val encrypted = encrypt(json.encodeToString(UserSession.serializer(), old)) + prefs.edit { putString(KEY, encrypted) } + discardLegacySession() + old + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "migrate") + discardLegacySession() + null } - // Régi (titkosítatlan) munkamenet átvétele. - val old = runCatching { legacy.loadSession() }.getOrNull() ?: return@withContext null - val moved = !keystoreBroken && runCatching { - prefs.edit { putString(KEY, encrypt(json.encodeToString(UserSession.serializer(), old))) } - }.isSuccess - if (moved) runCatching { legacy.deleteSession() } - old } } @@ -75,11 +101,20 @@ class SecureSessionManager(context: Context) : SessionManager { lock.withLock { withContext(Dispatchers.IO) { prefs.edit { remove(KEY) } - runCatching { legacy.deleteSession() } + legacy.deleteSession() } } } + private suspend fun discardLegacySession() { + try { + legacy.deleteSession() + } catch (e: Exception) { + if (e is CancellationException) throw e + report(e, "legacy-delete") + } + } + private fun key(): SecretKey { val ks = KeyStore.getInstance(KEYSTORE).apply { load(null) } (ks.getKey(ALIAS, null) as? SecretKey)?.let { return it } diff --git a/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt index 670985a..860d769 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt @@ -120,7 +120,7 @@ fun LibraryScreen(nav: Navigator) { lists = runCatching { AppGraph.library.myLists() }.orReport("LibraryScreen", emptyList()), challenge = runCatching { AppGraph.reading.challenge() }.orReport("LibraryScreen", null), // A hivatalos sáv hibája soha nem akadályozza a Könyvtár többi részét. - official = runCatching { AppGraph.official.overview() }.getOrDefault(emptyList()), + official = runCatching { AppGraph.official.overview() }.orReport("LibraryScreen.official", emptyList()), ) } // Visszatéréskor (pl. olvasás után vagy az app újbóli megnyitásakor) frissül a Folytatás és a hivatalos sáv. diff --git a/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt index 080c946..a15c2ca 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt @@ -458,14 +458,14 @@ private fun ReaderContent( return@LaunchedEffect } runCatching { - if (AppGraph.reading.markFinished(b.id, b.title)) { + if (AppGraph.reading.markFinished(b.id)) { val c = AppGraph.reading.challenge() snackbar.notify( if (c.goal > 0) "Kiolvastad! 🎉 Idei olvasási kihívás: ${c.count}/${c.goal}." else "Kiolvastad! 🎉 Ez az idei ${c.count}. elolvasott könyved." ) } - } + }.onFailure { hu.regelo.app.util.ErrorReporter.report(it, "ReaderScreen.markFinished") } } // Kétoszlopos módban nincs görgetési pozíció: a fejezet megnyitását mentjük. LaunchedEffect(chapter?.id, twoColumns, gated) { diff --git a/supabase/2026-10-26_app_v1_4.sql b/supabase/2026-10-26_app_v1_4.sql new file mode 100644 index 0000000..f50aa44 --- /dev/null +++ b/supabase/2026-10-26_app_v1_4.sql @@ -0,0 +1,93 @@ +-- Regélő app v1.4 – atomikus olvasásbefejezés és versenyhelyzet-biztos rate limit. +-- Előbb futtasd az éles Supabase adatbázison, majd csak ezután add ki az ezt használó appot. + +-- A számlálás és az esemény beszúrása egyazon felhasználó/művelet párra sorosítva történjen, +-- hogy párhuzamos kérések ne tudják megkerülni a limitet. +create or replace function public.regelo_rate_limit(p_action text, p_max integer, p_window interval) +returns void +language plpgsql +security definer +set search_path = public +as $function$ +declare + v_uid uuid := auth.uid(); + v_n int; +begin + if v_uid is null then return; end if; + if p_action is null or char_length(p_action) not between 1 and 64 + or p_max is null or p_max < 1 or p_window is null or p_window <= interval '0' then + raise exception 'Invalid rate-limit configuration.' using errcode = '22023'; + end if; + if exists (select 1 from public.regelo_official_accounts o where o.user_id = v_uid) then return; end if; + + perform pg_advisory_xact_lock(hashtextextended(v_uid::text || ':' || p_action, 0)); + select count(*) into v_n + from public.regelo_rate_events + where action = p_action and user_id = v_uid and at > now() - p_window; + if v_n >= p_max then + raise exception 'Túl sok művelet rövid idő alatt. Várj egy kicsit, és próbáld újra.' using errcode = 'P0429'; + end if; + insert into public.regelo_rate_events (user_id, action) values (v_uid, p_action); +end +$function$; + +-- A befejezés szerveridőt és egyedi (felhasználó, könyv, év) kulcsot használ. +-- Az ismételt hívás false-t ad, a korábban eltávolított bejegyzés biztonságosan visszaállítható. +create or replace function public.regelo_mark_book_finished(p_book_id uuid) +returns boolean +language plpgsql +security definer +set search_path = public +as $function$ +declare + v_uid uuid := auth.uid(); + v_title text; + v_finished_at timestamptz := now(); + v_year integer; + v_finished_ms bigint; + v_inserted boolean := false; +begin + if v_uid is null then + raise exception 'Bejelentkezés szükséges.' using errcode = '28000'; + end if; + + select b.title into v_title + from public.books b + where b.id = p_book_id + and b.publish_status = 'PUBLISHED' + and b.is_completed = true; + if not found then + raise exception 'A könyv nem található vagy még nincs befejezve.' using errcode = '22023'; + end if; + + v_year := extract(year from v_finished_at at time zone 'Europe/Budapest')::integer; + v_finished_ms := floor(extract(epoch from v_finished_at) * 1000)::bigint; + + insert into public.reader_library_items as existing + (user_id, kind, item_id, payload, is_deleted, updated_at) + values ( + v_uid, + 'FINISHED', + v_year::text || ':' || p_book_id::text, + jsonb_build_object( + 'book_id', p_book_id::text, + 'title', left(v_title, 200), + 'finished_at', v_finished_ms, + 'year', v_year + ), + false, + v_finished_ms + ) + on conflict (user_id, kind, item_id) do update + set payload = excluded.payload, + is_deleted = false, + updated_at = excluded.updated_at + where existing.is_deleted = true + returning true into v_inserted; + + return coalesce(v_inserted, false); +end +$function$; + +revoke all on function public.regelo_mark_book_finished(uuid) from public, anon; +grant execute on function public.regelo_mark_book_finished(uuid) to authenticated; diff --git a/supabase/tests/reading_state_v1_4.sql b/supabase/tests/reading_state_v1_4.sql new file mode 100644 index 0000000..2d26ba2 --- /dev/null +++ b/supabase/tests/reading_state_v1_4.sql @@ -0,0 +1,78 @@ +-- v1.4 olvasásbefejezés RPC: idempotens, saját fiókhoz kötött, csak befejezett publikált könyvre. +-- Futtatás Supabase SQL Editorban postgres szerepkörrel; a tranzakció a tesztadatokat visszagörgeti. +begin; + +create temp table t_result(ok boolean not null, message text not null) on commit drop; +grant all on t_result to authenticated; + +do $$ +declare + v_user uuid; + v_book uuid := gen_random_uuid(); + v_open_book uuid := gen_random_uuid(); +begin + select p.id into v_user + from public.profiles p + where not exists ( + select 1 from public.regelo_official_accounts o where o.user_id = p.id + ) + limit 1; + if v_user is null then + raise exception 'A teszthez legalább egy nem hivatalos profil szükséges.'; + end if; + + insert into public.books (id, author_id, title, is_completed, publish_status) + values (v_book, v_user, 'v1.4 test complete book', true, 'PUBLISHED'); + insert into public.books (id, author_id, title, is_completed, publish_status) + values (v_open_book, v_user, 'v1.4 test ongoing book', false, 'PUBLISHED'); + perform set_config('t.v1_4_user', v_user::text, true); + perform set_config('t.v1_4_book', v_book::text, true); + perform set_config('t.v1_4_open_book', v_open_book::text, true); +end $$; + +select set_config( + 'request.jwt.claims', + json_build_object('sub', current_setting('t.v1_4_user'), 'role', 'authenticated')::text, + true +); +set local role authenticated; + +do $$ +declare + v_first boolean; + v_second boolean; + v_restored boolean; + v_count integer; + v_key text; +begin + v_first := public.regelo_mark_book_finished(current_setting('t.v1_4_book')::uuid); + v_second := public.regelo_mark_book_finished(current_setting('t.v1_4_book')::uuid); + v_key := to_char(now() at time zone 'Europe/Budapest', 'YYYY') || ':' || current_setting('t.v1_4_book'); + select count(*) into v_count + from public.reader_library_items + where user_id = (select auth.uid()) and kind = 'FINISHED' and item_id = v_key and not is_deleted; + insert into t_result + values (v_first and not v_second and v_count = 1, + 'First completion inserts once; duplicate call is a no-op; active records=' || v_count); + + update public.reader_library_items + set is_deleted = true + where user_id = (select auth.uid()) and kind = 'FINISHED' and item_id = v_key; + v_restored := public.regelo_mark_book_finished(current_setting('t.v1_4_book')::uuid); + select count(*) into v_count + from public.reader_library_items + where user_id = (select auth.uid()) and kind = 'FINISHED' and item_id = v_key and not is_deleted; + insert into t_result + values (v_restored and v_count = 1, 'Removing and rereading restores one active completion'); + + begin + perform public.regelo_mark_book_finished(current_setting('t.v1_4_open_book')::uuid); + insert into t_result values (false, 'An unfinished book was accepted'); + exception when sqlstate '22023' then + insert into t_result values (true, 'An unfinished book was rejected'); + end; +end $$; + +reset role; +select * from t_result; +rollback; From 030c13b84a22aaedda25b72ddcda7b8a186295b7 Mon Sep 17 00:00:00 2001 From: regeloapp-coder Date: Mon, 26 Oct 2026 09:55:50 +0100 Subject: [PATCH 3/3] Improve discovery and authoring flows Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .gitignore | 4 ++ README.md | 38 +++++++++++++++++++ app/build.gradle.kts | 26 ++++++++++++- .../hu/regelo/app/data/WritingRepository.kt | 8 +++- .../regelo/app/ui/screens/BookDetailScreen.kt | 31 +++++++++++++++ .../regelo/app/ui/screens/BookEditorScreen.kt | 29 +++++++++++++- .../hu/regelo/app/ui/screens/LibraryScreen.kt | 29 +++++++++++++- .../hu/regelo/app/ui/screens/ReaderScreen.kt | 31 ++++++++++++++- .../hu/regelo/app/ui/screens/WriteScreen.kt | 4 +- .../hu/regelo/app/ReaderNavigationTest.kt | 21 ++++++++++ 10 files changed, 214 insertions(+), 7 deletions(-) create mode 100644 app/src/test/java/hu/regelo/app/ReaderNavigationTest.kt diff --git a/.gitignore b/.gitignore index 3d4b0bd..08aecd8 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,7 @@ .cxx .kotlin local.properties +*.jks +*.keystore +keystore.properties +supabase/.temp/ diff --git a/README.md b/README.md index 749f51d..16236fa 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,44 @@ Magyar írói és olvasói platform (Wattpad / Inkitt jellegű), Kotlin + Jetpac Android Studio › Open › ez a mappa › (Gradle sync) › Build › Build App Bundle(s) / APK(s) › Build APK(s). Az APK: `app/build/outputs/apk/debug/app-debug.apk` +## Android-kiadás és aláírás +Ez a repository natív Android/Jetpack Compose alkalmazás; iOS-, Expo-, Capacitor-, React Native- vagy Flutter-projekt nincs benne. +Google Playre aláírt Android App Bundle-t (AAB) tölts fel, ne fejlesztői debug APK-t. + +### Aláírt AAB Android Studióval +1. Nyisd meg a repository gyökérmappáját Android Studióban, várd meg a Gradle szinkronizálását, és futtasd a teszteket. +2. A **Build › Generate Signed Bundle / APK… › Android App Bundle** útvonalon válaszd a `release` build variantot. +3. Első kiadáskor hozz létre külön feltöltési (upload) kulcsot és keystore-t. A fájl, a jelszavak és az alias + biztonságos, Git-en kívüli helyre kerüljenek; a Google Play App Signing bekapcsolása ajánlott. +4. Készítsd el az AAB-t, ellenőrizd a Play Console belső tesztcsatornáján, majd csak sikeres ellenőrzés után + indítsd a szélesebb körű kiadást. +5. Minden új feltöltés előtt növeld az `app/build.gradle.kts` fájlban a `versionCode` értékét. Jelenlegi értéke + `130`; ez azonos vagy kisebb értékkel nem tölthető fel frissítésként. + +### Parancssoros/CI aláírás +Biztonságos build/CI titokként add meg mind a négy környezeti változót: +`REGELO_STORE_FILE`, `REGELO_STORE_PASSWORD`, `REGELO_KEY_ALIAS`, `REGELO_KEY_PASSWORD`. Például a fájl elérési +útja `C:\secure\regelo-upload.jks` lehet. A jelszavakat ne írd parancssorba, scriptbe vagy repository-fájlba. +Ezután futtasd: + +```powershell +.\gradlew.bat :app:bundleRelease +``` + +A kimenet helye: `app\build\outputs\bundle\release\app-release.aab`. Vagy mind a négy változó legyen beállítva, +vagy egyik sem; részleges beállításnál a Gradle szándékosan hibával leáll. Változók nélkül az `assembleRelease` +ellenőrző build lefut, de nem állít elő Playre feltölthető, a saját kiadási kulcsoddal aláírt csomagot. +Az Android Gradle build nem használ `.env` fájlt. A Supabase URL és publishable klienskulcs nem titok; adatvédelmüket +a szerveroldali hitelesítés és RLS-szabályok adják. Service-role kulcsot tilos a mobilalkalmazásba tenni. + +### Play Console kiadás előtti kapu +- Ellenőrizd és publikáld az adatkezelési tájékoztató és támogatás URL-jét, valamint a Data safety adatlapot. +- Adj meg működő, alkalmazáson kívüli webes fióktörlési kérelem URL-t is. Az alkalmazáson belüli törlőgomb önmagában + nem teljesíti ezt a Play-követelményt; ilyen publikus URL jelenleg nincs azonosítva. +- Az alkalmazás API 37-et céloz. A `versionCode` frissítése és az aláírt bundle ellenőrzése még szükséges a kiadáshoz. +- A completion RPC-t használó kliens kiadása előtt a cél Supabase-környezeten legyen alkalmazva a + `supabase/2026-10-26_app_v1_4.sql` migráció. + ## Adatbázis A `supabase/` mappában lévő SQL fájlok idempotensek (többször is futtathatók) a Supabase SQL Editorban. A kliens frissítésének kiadása előtt futtasd a `supabase/2026-10-26_app_v1_4.sql` migrációt a v1.3 után; diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 3aa2a33..bd68aaa 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -5,6 +5,17 @@ plugins { alias(libs.plugins.kotlin.serialization) } +val releaseSigningValues = listOf( + "REGELO_STORE_FILE", + "REGELO_STORE_PASSWORD", + "REGELO_KEY_ALIAS", + "REGELO_KEY_PASSWORD", +).map { providers.environmentVariable(it).orNull?.takeIf(String::isNotBlank) } +val releaseSigningConfigured = releaseSigningValues.all { it != null } +require(releaseSigningConfigured || releaseSigningValues.all { it == null }) { + "Release signing requires REGELO_STORE_FILE, REGELO_STORE_PASSWORD, REGELO_KEY_ALIAS, and REGELO_KEY_PASSWORD." +} + android { namespace = "hu.regelo.app" compileSdk { @@ -23,11 +34,22 @@ android { buildConfigField("String", "SUPABASE_KEY", "\"sb_publishable_vtSi7ZP9AiR0bYYlT_WErQ_ltqX6ZBF\"") } + signingConfigs { + if (releaseSigningConfigured) { + create("release") { + storeFile = file(requireNotNull(releaseSigningValues[0])) + storePassword = requireNotNull(releaseSigningValues[1]) + keyAlias = requireNotNull(releaseSigningValues[2]) + keyPassword = requireNotNull(releaseSigningValues[3]) + } + } + } + buildTypes { release { isMinifyEnabled = false - // Oldalról telepíthető kiadás: a gép saját debug-kulcsával aláírva. - signingConfig = signingConfigs.getByName("debug") + // Store key is injected via environment; never sign release builds with the debug key. + if (releaseSigningConfigured) signingConfig = signingConfigs.getByName("release") } } compileOptions { diff --git a/app/src/main/java/hu/regelo/app/data/WritingRepository.kt b/app/src/main/java/hu/regelo/app/data/WritingRepository.kt index 121fa35..69de23f 100644 --- a/app/src/main/java/hu/regelo/app/data/WritingRepository.kt +++ b/app/src/main/java/hu/regelo/app/data/WritingRepository.kt @@ -95,7 +95,13 @@ class WritingRepository { } suspend fun deleteBook(id: String) { - val b = books.get(id) ?: return + val uid = AppGraph.auth.requireUserId() + val local = books.get(id) + val b = local?.takeIf { it.isMine } ?: AppGraph.books.getBook(id)?.let { remote -> + check(remote.authorId == uid) { "Csak a saját történetedet törölheted." } + remote.toLocal(isMine = true, existing = local).also { books.upsert(it) } + } ?: error("A történet nem található.") + check(b.authorId == uid) { "Csak a saját történetedet törölheted." } books.upsert(b.copy(deleted = true, dirty = true, updatedAt = nowMs())) requestSync(immediate = true) } diff --git a/app/src/main/java/hu/regelo/app/ui/screens/BookDetailScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/BookDetailScreen.kt index 99da94a..843906a 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/BookDetailScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/BookDetailScreen.kt @@ -28,6 +28,7 @@ import androidx.compose.material.icons.filled.Bookmark import androidx.compose.material.icons.filled.BookmarkBorder import androidx.compose.material.icons.filled.Download import androidx.compose.material.icons.filled.DownloadDone +import androidx.compose.material.icons.filled.Delete import androidx.compose.material.icons.filled.Edit import androidx.compose.material.icons.filled.Favorite import androidx.compose.material.icons.filled.FavoriteBorder @@ -82,6 +83,7 @@ import hu.regelo.app.data.SeriesDto import hu.regelo.app.ui.components.Avatar import hu.regelo.app.ui.components.BackTopBar import hu.regelo.app.ui.components.BookCover +import hu.regelo.app.ui.components.ConfirmDialog import hu.regelo.app.ui.components.LoadContent import hu.regelo.app.ui.components.LocalSnackbar import hu.regelo.app.ui.components.Pill @@ -90,13 +92,16 @@ import hu.regelo.app.ui.components.ReportDialog import hu.regelo.app.ui.components.authorLabel import hu.regelo.app.ui.components.rememberLoader import hu.regelo.app.ui.components.runAction +import hu.regelo.app.ui.components.notify import hu.regelo.app.ui.nav.Navigator import hu.regelo.app.ui.nav.Route import hu.regelo.app.util.compactNumber +import hu.regelo.app.util.friendlyMessage import hu.regelo.app.util.readingTimeLabel import hu.regelo.app.util.relativeTime import java.util.Locale import hu.regelo.app.util.openSafe +import kotlinx.coroutines.launch private data class DetailData( val book: BookDto, @@ -130,6 +135,7 @@ fun BookDetailScreen(nav: Navigator, bookId: String) { var rateDialog by remember { mutableStateOf(false) } var listsDialog by remember { mutableStateOf(false) } var tipDialog by remember { mutableStateOf(false) } + var deleteBookConfirm by remember { mutableStateOf(false) } val localBook by AppGraph.books.observeLocalBook(bookId).collectAsState(initial = null) val loader = rememberLoader(bookId) { @@ -171,6 +177,11 @@ fun BookDetailScreen(nav: Navigator, bookId: String) { val text = "„${d.book.title}” – ${d.book.authorLabel(d.author?.displayName)}\nOlvasd a Regélőn!" context.startActivity(Intent.createChooser(Intent(Intent.ACTION_SEND).apply { type = "text/plain"; putExtra(Intent.EXTRA_TEXT, text) }, "Megosztás")) }) { Icon(Icons.Default.Share, "Megosztás") } + if (d.book.authorId == me && !d.isOfficial) { + IconButton(onClick = { deleteBookConfirm = true }) { + Icon(Icons.Default.Delete, "Történet törlése", tint = MaterialTheme.colorScheme.error) + } + } IconButton(onClick = { menu = true }) { Icon(Icons.Default.MoreVert, "Továbbiak") } DropdownMenu(expanded = menu, onDismissRequest = { menu = false }) { DropdownMenuItem(text = { Text("Hozzáadás listához") }, leadingIcon = { Icon(Icons.AutoMirrored.Filled.PlaylistAdd, null) }, onClick = { menu = false; listsDialog = true }) @@ -369,6 +380,26 @@ fun BookDetailScreen(nav: Navigator, bookId: String) { scope.runAction(snackbar, "Köszönjük, a moderátorok átnézik.") { AppGraph.social.reportContent("BOOK", b.id, reason, note) } }, onDismiss = { report = false }) if (listsDialog) AddToListDialog(b.id) { listsDialog = false } + if (deleteBookConfirm) ConfirmDialog( + title = "Történet törlése", + text = "„${b.title}” és minden fejezete véglegesen törlődik a telefonról és a felhőből. Ez nem vonható vissza.", + confirm = "Végleges törlés", + destructive = true, + onConfirm = { + scope.launch { + try { + AppGraph.writing.deleteBook(b.id) + snackbar.notify("Történet törölve.") + nav.back() + } catch (e: Exception) { + snackbar.showSnackbar(e.friendlyMessage().also { + hu.regelo.app.util.ErrorReporter.report(e, "BookDetailScreen.deleteBook") + }) + } + } + }, + onDismiss = { deleteBookConfirm = false }, + ) if (tipDialog) TipDialog(d.author?.displayName ?: b.penName, d.author?.paypalMe ?: "") { tipDialog = false } } } } diff --git a/app/src/main/java/hu/regelo/app/ui/screens/BookEditorScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/BookEditorScreen.kt index 354ad58..4388056 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/BookEditorScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/BookEditorScreen.kt @@ -93,8 +93,10 @@ import hu.regelo.app.ui.components.runAction import hu.regelo.app.ui.nav.Navigator import hu.regelo.app.ui.nav.Route import hu.regelo.app.util.Images +import hu.regelo.app.util.friendlyMessage import hu.regelo.app.util.readingTimeLabel import hu.regelo.app.util.relativeTime +import hu.regelo.app.ui.components.notify import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.delay import kotlinx.coroutines.launch @@ -114,6 +116,7 @@ fun BookEditorScreen(nav: Navigator, bookId: String) { var tagsText by remember { mutableStateOf("") } var cropSource by remember { mutableStateOf(null) } var deleteChapter by remember { mutableStateOf(null) } + var deleteBookConfirm by remember { mutableStateOf(false) } var announce by remember { mutableStateOf(false) } var publishConfirm by remember { mutableStateOf(false) } var series by remember { mutableStateOf>(emptyList()) } @@ -158,6 +161,9 @@ fun BookEditorScreen(nav: Navigator, bookId: String) { BackTopBar("Történet szerkesztése", onBack = { nav.back() }) { SyncBadge(sync.syncing, sync.pending, sync.offline, sync.error) { AppGraph.writing.requestSync(immediate = true) } IconButton(onClick = { nav.push(Route.Reader(bookId)) }) { Icon(Icons.AutoMirrored.Filled.MenuBook, "Előnézet") } + IconButton(onClick = { deleteBookConfirm = true }) { + Icon(Icons.Default.Delete, "Történet törlése", tint = MaterialTheme.colorScheme.error) + } } val d = draft if (d == null) { LoadingBox(); return@Column } @@ -314,6 +320,28 @@ fun BookEditorScreen(nav: Navigator, bookId: String) { onDismiss = { deleteChapter = null }, ) } + if (deleteBookConfirm) { + ConfirmDialog( + title = "Történet törlése", + text = "A történet és minden fejezete véglegesen törlődik a telefonról és a felhőből. Ez nem vonható vissza.", + confirm = "Végleges törlés", + destructive = true, + onConfirm = { + scope.launch { + try { + AppGraph.writing.deleteBook(bookId) + snackbar.notify("Történet törölve.") + nav.back() + } catch (e: Exception) { + snackbar.showSnackbar(e.friendlyMessage().also { + hu.regelo.app.util.ErrorReporter.report(e, "BookEditorScreen.deleteBook") + }) + } + } + }, + onDismiss = { deleteBookConfirm = false }, + ) + } if (publishConfirm) { val d = draft ConfirmDialog( @@ -396,4 +424,3 @@ private fun ChapterRow(ch: LocalChapter, isFirst: Boolean, isLast: Boolean, onOp } HorizontalDivider(Modifier.padding(start = 48.dp), color = MaterialTheme.colorScheme.outlineVariant) } - diff --git a/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt index 860d769..56fd27d 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/LibraryScreen.kt @@ -53,6 +53,8 @@ import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.dp import hu.regelo.app.AppGraph import hu.regelo.app.data.BookCard +import hu.regelo.app.data.DiscoverFilter +import hu.regelo.app.data.DiscoverSort import hu.regelo.app.data.ContinueItem import hu.regelo.app.data.ReadingList import hu.regelo.app.ui.components.BookCover @@ -70,6 +72,7 @@ import hu.regelo.app.ui.nav.Tab import hu.regelo.app.ui.theme.Lora import hu.regelo.app.util.relativeTime import hu.regelo.app.data.OfficialOverviewDto +import hu.regelo.app.data.ProfileDto import androidx.compose.animation.AnimatedVisibility import androidx.compose.foundation.combinedClickable import androidx.compose.material.icons.filled.ExpandLess @@ -94,6 +97,9 @@ private data class LibraryData( val lists: List, val challenge: hu.regelo.app.data.ReadingChallenge?, val official: List = emptyList(), + val newest: List = emptyList(), + val popular: List = emptyList(), + val recentAuthors: List = emptyList(), ) @Composable @@ -113,6 +119,10 @@ fun LibraryScreen(nav: Navigator) { val savedIds = runCatching { AppGraph.library.savedBookIds() }.orReport("LibraryScreen", emptyList()) val likedIds = runCatching { AppGraph.social.likedBookIds() }.orReport("LibraryScreen", emptyList()) val all = runCatching { AppGraph.books.toCards(AppGraph.books.byIds((savedIds + likedIds).distinct())) }.orReport("LibraryScreen", emptyList()).associateBy { it.book.id } + val newest = runCatching { AppGraph.books.discover(DiscoverFilter(), 0, 12).items } + .orReport("LibraryScreen.newest", emptyList()) + val popular = runCatching { AppGraph.books.discover(DiscoverFilter(sort = DiscoverSort.POPULAR), 0, 12).items } + .orReport("LibraryScreen.popular", emptyList()) LibraryData( continueItems = cont, saved = savedIds.mapNotNull { all[it] }, @@ -121,6 +131,9 @@ fun LibraryScreen(nav: Navigator) { challenge = runCatching { AppGraph.reading.challenge() }.orReport("LibraryScreen", null), // A hivatalos sáv hibája soha nem akadályozza a Könyvtár többi részét. official = runCatching { AppGraph.official.overview() }.orReport("LibraryScreen.official", emptyList()), + newest = newest, + popular = popular, + recentAuthors = newest.mapNotNull { it.author }.distinctBy { it.userId }.take(6), ) } // Visszatéréskor (pl. olvasás után vagy az app újbóli megnyitásakor) frissül a Folytatás és a hivatalos sáv. @@ -132,7 +145,7 @@ fun LibraryScreen(nav: Navigator) { TopAppBar( title = { Column { - Text("Könyvtár", style = MaterialTheme.typography.headlineSmall) + Text("Kezdőlap", style = MaterialTheme.typography.headlineSmall) me?.let { Text("Szia, ${it.displayName.substringBefore(' ')}!", style = MaterialTheme.typography.bodySmall, color = MaterialTheme.colorScheme.onSurfaceVariant) } } }, @@ -148,6 +161,20 @@ fun LibraryScreen(nav: Navigator) { if (data == null) { item { hu.regelo.app.ui.components.LoadingBox(Modifier.height(240.dp)) } } else { + if (data.newest.isNotEmpty()) { + item { SectionTitle("Új történetek", action = "Felfedezés", onAction = { nav.select(Tab.DISCOVER) }) } + item { Shelf(data.newest) { nav.push(Route.BookDetail(it)) } } + } + if (data.recentAuthors.isNotEmpty()) { + item { SectionTitle("Friss szerzők", action = "Keresés", onAction = { nav.open(Tab.DISCOVER, Route.Search(people = true)) }) } + items(data.recentAuthors, key = { "home-author-${it.userId}" }) { author -> + hu.regelo.app.ui.components.PersonRow(author, onClick = { nav.push(Route.Profile(author.userId)) }) + } + } + if (data.popular.isNotEmpty()) { + item { SectionTitle("Felkapott történetek", action = "Mind", onAction = { nav.select(Tab.DISCOVER) }) } + item { Shelf(data.popular) { nav.push(Route.BookDetail(it)) } } + } // Olvasási kihívás (éves cél) data.challenge?.let { ch -> item { Spacer(Modifier.height(4.dp)); hu.regelo.app.ui.components.ReadingChallengeCard(ch, onClick = { challengeDialog = true }) } diff --git a/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt index a15c2ca..70cd8ae 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/ReaderScreen.kt @@ -14,6 +14,7 @@ import androidx.compose.foundation.background import androidx.compose.foundation.border import androidx.compose.foundation.clickable import androidx.compose.foundation.combinedClickable +import androidx.compose.foundation.gestures.detectHorizontalDragGestures import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.BoxWithConstraints @@ -99,8 +100,10 @@ import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.draw.clip import androidx.compose.ui.graphics.Color +import androidx.compose.ui.input.pointer.pointerInput import androidx.compose.ui.layout.ContentScale import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.platform.LocalDensity import androidx.compose.ui.platform.LocalView import androidx.compose.ui.text.TextStyle import androidx.compose.ui.text.font.FontStyle @@ -189,6 +192,14 @@ private sealed interface TtsEvent { private val ttsRates = listOf(0.8f, 1.0f, 1.25f, 1.5f) +internal fun chapterIndexAfterSwipe(currentIndex: Int, chapterCount: Int, dragPx: Float, thresholdPx: Float): Int { + if (chapterCount <= 0 || kotlin.math.abs(dragPx) < thresholdPx) return currentIndex + return when { + dragPx < 0 -> (currentIndex + 1).coerceAtMost(chapterCount - 1) + else -> (currentIndex - 1).coerceAtLeast(0) + } +} + private tailrec fun Context.findActivity(): Activity? = when (this) { is Activity -> this is ContextWrapper -> baseContext.findActivity() @@ -434,6 +445,7 @@ private fun ReaderContent( } val twoColumns = wide && rs.twoColumns + val swipeThresholdPx = with(LocalDensity.current) { 72.dp.toPx() } // Végigolvasás rögzítése (olvasási kihívás): az utolsó fejezet végén, egy kis olvasási idő után. val atEndNow by remember(blocks) { @@ -572,7 +584,24 @@ private fun ReaderContent( val progress by remember(blocks) { androidx.compose.runtime.derivedStateOf { if (blocks.isEmpty()) 0f else (listState.firstVisibleItemIndex.toFloat() / (blocks.size + 1)).coerceIn(0f, 1f) } } LinearProgressIndicator(progress = { ((index.coerceAtLeast(0) + progress) / totalChapters).coerceIn(0f, 1f) }, modifier = Modifier.fillMaxWidth().height(2.dp), color = colors.accent, trackColor = colors.muted.copy(alpha = 0.2f)) - Box(Modifier.weight(1f)) { + Box( + Modifier.weight(1f).pointerInput(index, totalChapters, twoColumns, swipeThresholdPx) { + if (!twoColumns) { + var horizontalDrag = 0f + detectHorizontalDragGestures( + onHorizontalDrag = { change, amount -> + horizontalDrag += amount + change.consume() + }, + onDragEnd = { + index = chapterIndexAfterSwipe(index, totalChapters, horizontalDrag, swipeThresholdPx) + horizontalDrag = 0f + }, + onDragCancel = { horizontalDrag = 0f }, + ) + } + }, + ) { val mErr = metaError val cErr = chapterError val ch = chapter diff --git a/app/src/main/java/hu/regelo/app/ui/screens/WriteScreen.kt b/app/src/main/java/hu/regelo/app/ui/screens/WriteScreen.kt index 8316572..7bd6e2d 100644 --- a/app/src/main/java/hu/regelo/app/ui/screens/WriteScreen.kt +++ b/app/src/main/java/hu/regelo/app/ui/screens/WriteScreen.kt @@ -196,7 +196,9 @@ fun WriteScreen(nav: Navigator) { scope.launch { try { val b = AppGraph.writing.createBook(title, genre, description) - nav.push(Route.BookEditor(b.id)) + val firstChapter = AppGraph.writing.chapterList(b.id).firstOrNull() + if (firstChapter != null) nav.push(Route.ChapterEditor(b.id, firstChapter.id)) + else nav.push(Route.BookEditor(b.id)) } catch (e: Exception) { snackbar.showSnackbar(e.friendlyMessage()) } } } diff --git a/app/src/test/java/hu/regelo/app/ReaderNavigationTest.kt b/app/src/test/java/hu/regelo/app/ReaderNavigationTest.kt new file mode 100644 index 0000000..6dc7c2e --- /dev/null +++ b/app/src/test/java/hu/regelo/app/ReaderNavigationTest.kt @@ -0,0 +1,21 @@ +package hu.regelo.app + +import hu.regelo.app.ui.screens.chapterIndexAfterSwipe +import org.junit.Assert.assertEquals +import org.junit.Test + +class ReaderNavigationTest { + @Test + fun swipingLeftAdvancesAndRightGoesBack() { + assertEquals(2, chapterIndexAfterSwipe(1, 4, -100f, 72f)) + assertEquals(0, chapterIndexAfterSwipe(1, 4, 100f, 72f)) + } + + @Test + fun smallSwipesAndEndBoundariesDoNotChangeChapter() { + assertEquals(1, chapterIndexAfterSwipe(1, 4, -50f, 72f)) + assertEquals(3, chapterIndexAfterSwipe(3, 4, -100f, 72f)) + assertEquals(0, chapterIndexAfterSwipe(0, 4, 100f, 72f)) + assertEquals(0, chapterIndexAfterSwipe(0, 0, 100f, 72f)) + } +}