feat(db-sqlite): initial implementation — database/sql SQLite with lifecycle and UnitOfWork (v1.0.0)
Introduces code.nochebuena.dev/einherjar/db-sqlite — the SQLite database starter for the Einherjar framework. Absorbs the sqlite package from micro-lib using the pure-Go modernc.org/sqlite driver (no CGO, cross-compilation compatible). Interfaces (CT-6: one TypeSpec per file): - Executor — ExecContext, QueryContext, QueryRowContext (database/sql types) - Tx — Executor + Commit(), Rollback() — no ctx; honest database/sql contract - Provider — GetExecutor, Begin, Ping, HandleError - Component — lifecycle.Component + observability.Checkable + Provider - UnitOfWork — Do(ctx, fn) Implementation: - New(logger, cfg) Component — pool not created until OnInit - OnInit: sql.Open with DSN (Path + Pragmas); sets MaxOpenConns, MaxIdleConns - OnStart: Ping with 5s timeout; logs "sqlite: connected" - OnStop: db.Close(); logs "sqlite: closing pool" - GetExecutor: returns active Tx from context (ctxTxKey) or *sql.DB; explicit nil return when db uninitialized to avoid typed-nil interface pitfall - Begin: wraps db.BeginTx; wrapped in xerrors on error - HealthCheck: delegates to Ping; Priority LevelDegraded (file DB; absence is non-fatal on a server restart — file always present if configured) - NewUnitOfWork(logger, provider) UnitOfWork — acquires writeMu before Begin to prevent SQLITE_BUSY under concurrent goroutines (SQLite single-writer model) - writeMu: extracted from *sqliteImpl via type assertion in NewUnitOfWork; gracefully skipped when provider is a mock (nil mu) - HandleError: sql.ErrNoRows→ErrNotFound, unique/pk constraint→ErrAlreadyExists, foreign key→ErrInvalidInput, all others→ErrInternal Config (EINHERJAR_SQLITE_* env vars): Path(required), MaxOpenConns(1), MaxIdleConns(1), Pragmas(?_journal=WAL&_timeout=5000&_fk=true) - Component interface embeds observability.Identifiable; identifiable.go implements ModulePath and ModuleVersion via runtime/debug.ReadBuildInfo() — prints in launcher banner
This commit is contained in:
1
.gitea/CODEOWNERS
Normal file
1
.gitea/CODEOWNERS
Normal file
@@ -0,0 +1 @@
|
|||||||
|
* @einherjar/CoreDevelopers @einherjar/Agents
|
||||||
70
.gitea/pull_request_template.md
Normal file
70
.gitea/pull_request_template.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- One or two sentences: what does this PR do and why? -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
- [ ] Bug fix — non-breaking change that resolves an issue
|
||||||
|
- [ ] New feature — non-breaking addition of functionality
|
||||||
|
- [ ] Breaking change — alters existing behavior or public API
|
||||||
|
- [ ] Documentation update
|
||||||
|
- [ ] Refactor — no functional change, no new API surface
|
||||||
|
- [ ] Test improvement
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Provide enough context for a reviewer who was not in the room:
|
||||||
|
- What problem does this solve?
|
||||||
|
- What approach did you choose, and why?
|
||||||
|
- Were there alternatives you considered and rejected?
|
||||||
|
- Any known limitations or follow-up work?
|
||||||
|
-->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
- [ ] I added or updated tests that cover my changes
|
||||||
|
- [ ] All tests pass locally — `go test ./...`
|
||||||
|
- [ ] No formatting issues — `gofmt -l .` produces no output
|
||||||
|
- [ ] No vet warnings — `go vet ./...` is clean
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] At most one exported type per non-test `.go` file (CT-6)
|
||||||
|
- [ ] No new external dependencies added without prior discussion in an issue
|
||||||
|
- [ ] Public API changes are reflected in `CHANGELOG.md`
|
||||||
|
- [ ] Breaking changes include a migration note in the PR description above
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
> **This PR will not be merged until the CLA comment is present.**
|
||||||
|
|
||||||
|
Before a Maintainer reviews your code, you must post the following text **as a comment on this PR** — not here in the description. PR description checkboxes can be silently toggled by anyone; a comment is a timestamped, author-attributed record that cannot be quietly removed.
|
||||||
|
|
||||||
|
**Copy and post this exact text as a PR comment:**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> I have read the Einherjar Contributor License Agreement (CLA.md) and I agree to all its terms.
|
||||||
|
> I confirm this Contribution is my original work. I grant the Maintainers the rights described
|
||||||
|
> therein, including the right to relicense, and I retain ownership of my copyright.
|
||||||
|
> This agreement covers all future Contributions I submit to any Einherjar repository under
|
||||||
|
> this account.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
First time contributing? Read [CLA.md](../CLA.md) for the full agreement before posting the comment.
|
||||||
|
|
||||||
|
If you are contributing on behalf of a company, an authorized representative of that company must post the comment.
|
||||||
|
|
||||||
|
<!-- Thank you for contributing to Einherjar. For those who come after. -->
|
||||||
38
.gitignore
vendored
Normal file
38
.gitignore
vendored
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# ── Release workflow helpers ──────────────────────────────────────────────────
|
||||||
|
COMMIT.md
|
||||||
|
PR.md
|
||||||
|
RELEASE.md
|
||||||
|
|
||||||
|
# ── Go build artifacts ────────────────────────────────────────────────────────
|
||||||
|
*.exe
|
||||||
|
*.exe~
|
||||||
|
*.dll
|
||||||
|
*.so
|
||||||
|
*.dylib
|
||||||
|
*.test
|
||||||
|
*.out
|
||||||
|
/dist/
|
||||||
|
/bin/
|
||||||
|
|
||||||
|
# ── Go workspace (local development only) ────────────────────────────────────
|
||||||
|
go.work
|
||||||
|
go.work.sum
|
||||||
|
|
||||||
|
# ── Dependency vendor directory ───────────────────────────────────────────────
|
||||||
|
vendor/
|
||||||
|
|
||||||
|
# ── Coverage output ───────────────────────────────────────────────────────────
|
||||||
|
coverage.out
|
||||||
|
coverage.html
|
||||||
|
*.coverprofile
|
||||||
|
|
||||||
|
# ── OS artifacts ─────────────────────────────────────────────────────────────
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# ── Editor artifacts ──────────────────────────────────────────────────────────
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
90
CLA.md
Normal file
90
CLA.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
# Contributor License Agreement
|
||||||
|
|
||||||
|
By contributing to any Einherjar repository, you agree to the terms of this Contributor License Agreement ("Agreement"). Please read it carefully before submitting your first Pull Request.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Definitions
|
||||||
|
|
||||||
|
| Term | Meaning |
|
||||||
|
|---|---|
|
||||||
|
| **You** | The individual or legal entity submitting a Contribution |
|
||||||
|
| **Contribution** | Any original work — source code, documentation, tests, configuration — submitted to an Einherjar repository |
|
||||||
|
| **Project** | The Einherjar framework and all repositories under `code.nochebuena.dev/einherjar/` |
|
||||||
|
| **Maintainers** | The individuals responsible for maintaining the Project |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. You Retain Ownership
|
||||||
|
|
||||||
|
This Agreement does **not** transfer your copyright to the Maintainers. You remain the legal owner of your Contribution. What you grant here is a broad license to use it — not ownership of it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Copyright License Grant
|
||||||
|
|
||||||
|
You grant the Maintainers and all recipients of the Project a **perpetual, worldwide, non-exclusive, royalty-free, irrevocable** license to:
|
||||||
|
|
||||||
|
- Reproduce, modify, and create derivative works of your Contribution
|
||||||
|
- Publicly display and perform your Contribution
|
||||||
|
- Distribute your Contribution and derivative works, in source or compiled form, under any terms
|
||||||
|
- Sublicense the above rights to third parties
|
||||||
|
- **Relicense** your Contribution under a different open-source or commercial license at the Maintainers' sole discretion
|
||||||
|
|
||||||
|
The Maintainers commit to keeping the Project available under at least one OSI-approved open-source license at all times.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Patent License Grant
|
||||||
|
|
||||||
|
You grant the Maintainers and all recipients of the Project a **perpetual, worldwide, non-exclusive, royalty-free, irrevocable** patent license to make, use, sell, offer for sale, import, and distribute your Contribution — limited to patent claims you own or control that are necessarily infringed by your Contribution alone, or in combination with the Project to which you submitted it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Your Representations
|
||||||
|
|
||||||
|
By submitting a Contribution, you confirm that:
|
||||||
|
|
||||||
|
1. **Original work.** The Contribution is your original work, or you have the legal right to submit it under these terms.
|
||||||
|
2. **No infringement.** To your knowledge, the Contribution does not infringe any third-party intellectual property rights, including patents, copyrights, and trade secrets.
|
||||||
|
3. **Employer rights.** If your employer holds rights over intellectual property you create, you have obtained written permission to submit the Contribution on behalf of that employer, or your employer has explicitly waived such rights for contributions to open-source projects.
|
||||||
|
4. **No warranty implied.** You understand that your Contribution may or may not be included in the Project, and the Maintainers are under no obligation to use it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. No Support Obligation
|
||||||
|
|
||||||
|
You are not required to provide maintenance, support, or updates for your Contributions. They are accepted **"as-is"**, without any warranty of fitness for a particular purpose or correctness.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. How to Sign
|
||||||
|
|
||||||
|
Consent is given by **posting a comment** on your Pull Request with the following exact text:
|
||||||
|
|
||||||
|
```
|
||||||
|
I have read the Einherjar Contributor License Agreement (CLA.md) and I agree to all its terms.
|
||||||
|
I confirm this Contribution is my original work. I grant the Maintainers the rights described
|
||||||
|
therein, including the right to relicense, and I retain ownership of my copyright.
|
||||||
|
This agreement covers all future Contributions I submit to any Einherjar repository under
|
||||||
|
this account.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Why a comment and not a checkbox?**
|
||||||
|
PR description checkboxes can be silently toggled on and off by anyone with write access to the branch at any time. A comment creates a timestamped, author-attributed record in the PR activity log — it cannot be quietly retracted. If a comment is deleted, the deletion itself is visible in the activity log.
|
||||||
|
|
||||||
|
No handwritten or electronic signature is required beyond the comment above. A Maintainer will verify the comment before merging. PRs without the comment will not be merged.
|
||||||
|
|
||||||
|
If you are contributing on behalf of a company or organization, ensure that an authorized representative of that entity has reviewed and accepted these terms before submitting. The comment must be posted by the account that owns the Contribution.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. Governing Terms
|
||||||
|
|
||||||
|
This Agreement is intended to be simple and broadly fair. It follows the model established by widely adopted CLAs from the Apache Software Foundation, Google, and MongoDB — granting the Project the flexibility to evolve while fully preserving your ownership of what you wrote.
|
||||||
|
|
||||||
|
If any provision of this Agreement is found unenforceable, the remaining provisions continue in full effect.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*For those who come after. — The Einherjar Maintainers*
|
||||||
247
CONTRIBUTING.md
Normal file
247
CONTRIBUTING.md
Normal file
@@ -0,0 +1,247 @@
|
|||||||
|
# Contributing to Einherjar
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to Einherjar. This document explains everything you need to know before sending your first Pull Request.
|
||||||
|
|
||||||
|
Einherjar is developed and maintained by **NOCHEBUENADEV**, the trade name of its founder operating as a *Persona Física con Actividad Empresarial* (PFAE) under Mexican law. Contributions are welcome and valued — but they are accepted under the terms described here, so please read this document fully before you begin.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
1. [Before You Start](#1-before-you-start)
|
||||||
|
2. [Legal: CLA and Copyright](#2-legal-cla-and-copyright)
|
||||||
|
3. [Development Setup](#3-development-setup)
|
||||||
|
4. [Code Standards](#4-code-standards)
|
||||||
|
5. [Commit Messages](#5-commit-messages)
|
||||||
|
6. [Submitting a Pull Request](#6-submitting-a-pull-request)
|
||||||
|
7. [Reporting Bugs](#7-reporting-bugs)
|
||||||
|
8. [Requesting Features](#8-requesting-features)
|
||||||
|
9. [What Gets Accepted](#9-what-gets-accepted)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Before You Start
|
||||||
|
|
||||||
|
**Open an issue first for anything non-trivial.**
|
||||||
|
|
||||||
|
Before you write a line of code, open an issue describing what you want to change and why. This protects your time: a change that seems straightforward may conflict with a planned refactor, an architectural decision, or the project's direction. Getting alignment before coding means your PR will not be rejected for reasons unrelated to its quality.
|
||||||
|
|
||||||
|
Exceptions where you can skip the issue:
|
||||||
|
- Typo or documentation-only fix
|
||||||
|
- Test coverage improvement for existing behavior
|
||||||
|
- Trivially obvious bug with a clear, contained fix
|
||||||
|
|
||||||
|
**Do not submit a PR that changes the public API of any module without prior discussion.** Every Einherjar module has a stability contract. Breaking changes require a major version bump and coordinated updates across dependent modules.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Legal: CLA and Copyright
|
||||||
|
|
||||||
|
### Contributor License Agreement
|
||||||
|
|
||||||
|
Before your first PR can be merged, you must sign the Contributor License Agreement by **posting a specific comment** on your Pull Request. The required comment text and full instructions are in [CLA.md](CLA.md).
|
||||||
|
|
||||||
|
> Checkboxes in PR descriptions are not used for CLA consent — they can be silently toggled by anyone. A comment is a timestamped, author-attributed record.
|
||||||
|
|
||||||
|
### Copyright
|
||||||
|
|
||||||
|
All original code in Einherjar is copyright **NOCHEBUENADEV**. NOCHEBUENADEV is the registered trade name of its founder, a natural person operating under the Mexican *Persona Física con Actividad Empresarial* (PFAE) regime.
|
||||||
|
|
||||||
|
When you contribute, you retain ownership of what you wrote. By signing the CLA you grant NOCHEBUENADEV a perpetual, irrevocable, worldwide license to use, modify, sublicense, and redistribute your Contribution — including the right to relicense it. See [CLA.md](CLA.md) for the full terms.
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
Einherjar is licensed under the **GNU Affero General Public License v3.0** (AGPL-3.0). Your Contributions will be distributed under the same license unless the Maintainers exercise their relicensing rights under the CLA.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Development Setup
|
||||||
|
|
||||||
|
Einherjar uses a Go workspace (`go.work`) that spans all modules. You do not need to `go get` anything — local replacements are wired automatically.
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Go 1.26+
|
||||||
|
- Git
|
||||||
|
|
||||||
|
### Clone and initialize
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://code.nochebuena.dev/einherjar/<module-name>
|
||||||
|
cd <module-name>
|
||||||
|
|
||||||
|
# If working across multiple modules, clone the workspace root instead
|
||||||
|
# and all modules will resolve from disk via go.work.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Verify your setup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go build ./... # must compile clean
|
||||||
|
go vet ./... # no warnings
|
||||||
|
go test ./... # all tests pass
|
||||||
|
gofmt -l . # no output (no unformatted files)
|
||||||
|
```
|
||||||
|
|
||||||
|
All four commands must produce clean output before a PR will be reviewed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Code Standards
|
||||||
|
|
||||||
|
These are non-negotiable. Every PR is checked against them.
|
||||||
|
|
||||||
|
### One exported type per file (CT-6)
|
||||||
|
|
||||||
|
Each non-test `.go` file may contain **at most one exported TypeSpec** (type, struct, or interface declaration). Unexported helpers, constants, and functions may coexist in the same file. `_test.go` files are exempt.
|
||||||
|
|
||||||
|
This rule exists to keep the codebase navigable: a developer who knows the type name can immediately predict the file name.
|
||||||
|
|
||||||
|
```
|
||||||
|
provider.go ← type Provider interface { ... } ✓ one exported type
|
||||||
|
component.go ← type Component interface { ... } ✓ one exported type
|
||||||
|
new.go ← func New(...) + unexported impl ✓ zero exported types
|
||||||
|
```
|
||||||
|
|
||||||
|
### Formatting
|
||||||
|
|
||||||
|
All code must be formatted with `gofmt`. No exceptions. If `gofmt -l .` produces output, the PR will not be merged.
|
||||||
|
|
||||||
|
Do not configure your editor to use `goimports` as a replacement — it may add import groups that diverge from the project style. Use `gofmt` + manual import management.
|
||||||
|
|
||||||
|
### Naming conventions
|
||||||
|
|
||||||
|
- Follow standard Go naming: `CamelCase` for exported, `camelCase` for unexported.
|
||||||
|
- Interfaces that represent a capability are named with an agent noun: `Provider`, `Sender`, `Checkable`.
|
||||||
|
- Interfaces that represent a full component are named `Component`.
|
||||||
|
- Config structs are named `Config`. One config struct per module root.
|
||||||
|
- Constructors are named `New` (main) or `NewXxx` (adapters and variants).
|
||||||
|
|
||||||
|
### Error handling
|
||||||
|
|
||||||
|
- Use `core/xerrors` for all errors returned from public API. Never return raw `errors.New` or `fmt.Errorf` from exported functions.
|
||||||
|
- Error codes must map to the gRPC canonical set defined in `xerrors`. If you need a new code, open an issue first.
|
||||||
|
- Do not swallow errors silently. Log at the appropriate level or return them.
|
||||||
|
|
||||||
|
### No comments unless necessary
|
||||||
|
|
||||||
|
Do not add comments that restate what the code already says. Only add a comment when the **why** is non-obvious: a hidden constraint, a subtle invariant, a workaround for a known upstream bug. If removing the comment would not confuse a future reader, do not write it.
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
Do not add new external dependencies without opening an issue and getting explicit approval first. Einherjar modules are deliberately lean. Every new dependency increases the blast radius for downstream consumers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Commit Messages
|
||||||
|
|
||||||
|
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>(<scope>): <short description>
|
||||||
|
|
||||||
|
[optional body]
|
||||||
|
```
|
||||||
|
|
||||||
|
| Type | When to use |
|
||||||
|
|---|---|
|
||||||
|
| `feat` | New exported function, type, or behavior |
|
||||||
|
| `fix` | Bug fix in existing behavior |
|
||||||
|
| `docs` | Documentation only |
|
||||||
|
| `test` | Tests only, no production code change |
|
||||||
|
| `refactor` | Code restructure with no behavior change |
|
||||||
|
| `chore` | Build system, CI, dependency updates |
|
||||||
|
|
||||||
|
**Scope** is the module name without the `einherjar/` prefix: `core`, `web`, `db-postgres`, `cache-valkey`, etc.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
```
|
||||||
|
feat(cache-valkey): add IncrWithTTL for atomic fixed-window counters
|
||||||
|
fix(db-postgres): handle pgconn deadline exceeded as ErrDeadlineExceeded
|
||||||
|
docs(web): document rate limiter fail-open behavior
|
||||||
|
```
|
||||||
|
|
||||||
|
Keep the subject line under 72 characters. Write in the imperative mood ("add", "fix", "remove" — not "added", "fixes", "removed").
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. Submitting a Pull Request
|
||||||
|
|
||||||
|
1. **Open an issue first** (see §1) unless the change is trivial.
|
||||||
|
2. Fork the repository and create a branch from `main`:
|
||||||
|
```bash
|
||||||
|
git checkout -b feat/your-feature-name
|
||||||
|
```
|
||||||
|
3. Make your changes following the standards in §4.
|
||||||
|
4. Ensure all verification commands pass (§3).
|
||||||
|
5. Open the PR against `main` using the provided PR template.
|
||||||
|
6. **Post the CLA comment** on the PR before requesting review (see §2 and [CLA.md](CLA.md)).
|
||||||
|
7. Respond to review feedback. Keep the review cycle short by addressing all comments before re-requesting review.
|
||||||
|
|
||||||
|
### Branch naming
|
||||||
|
|
||||||
|
| Prefix | Use for |
|
||||||
|
|---|---|
|
||||||
|
| `feat/` | New features |
|
||||||
|
| `fix/` | Bug fixes |
|
||||||
|
| `docs/` | Documentation changes |
|
||||||
|
| `test/` | Test additions or improvements |
|
||||||
|
| `refactor/` | Refactors without behavior change |
|
||||||
|
|
||||||
|
### PR size
|
||||||
|
|
||||||
|
Keep PRs focused. A PR that does one thing is easier to review, faster to merge, and safer to revert if needed. If your change naturally spans multiple concerns, split it into multiple PRs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. Reporting Bugs
|
||||||
|
|
||||||
|
Open an issue with the following information:
|
||||||
|
|
||||||
|
- **Module** affected (`einherjar/db-postgres`, `einherjar/web`, etc.)
|
||||||
|
- **Go version** (`go version`)
|
||||||
|
- **Minimal reproduction** — the smallest code snippet that demonstrates the problem
|
||||||
|
- **Expected behavior** vs **actual behavior**
|
||||||
|
- **Error output** if applicable (sanitize any credentials or sensitive data)
|
||||||
|
|
||||||
|
Do not open a PR to fix a bug without first opening an issue. The bug may be intentional behavior, already fixed on `main`, or caused by something outside the module.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. Requesting Features
|
||||||
|
|
||||||
|
Open an issue with:
|
||||||
|
|
||||||
|
- **What** you want to add and **why** it belongs in the framework (not in application code)
|
||||||
|
- **Which module** it affects, or whether it requires a new module
|
||||||
|
- **API sketch** — what the interface, function signature, or config field would look like
|
||||||
|
- **Alternative approaches** you considered
|
||||||
|
|
||||||
|
Feature requests that add a new external dependency, change a public interface, or cross module boundaries require longer discussion before approval.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. What Gets Accepted
|
||||||
|
|
||||||
|
Einherjar is a **focused framework**. It covers a specific, well-defined set of infrastructure concerns. Contributions that fall outside that scope — however well-written — will not be merged.
|
||||||
|
|
||||||
|
What fits:
|
||||||
|
- Bug fixes in existing behavior
|
||||||
|
- Performance improvements with benchmarks
|
||||||
|
- Missing error mappings for existing drivers
|
||||||
|
- Documentation improvements and example corrections
|
||||||
|
- Test coverage for untested edge cases
|
||||||
|
|
||||||
|
What does not fit without prior architectural agreement:
|
||||||
|
- New modules (open an issue first)
|
||||||
|
- New external dependencies
|
||||||
|
- Changes to public interfaces in any module
|
||||||
|
- Features that belong in application code rather than the framework
|
||||||
|
|
||||||
|
If you are unsure, open an issue and ask. It costs nothing and saves everyone time.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Einherjar was built for those who come after. Contributions that hold to that standard — clear, documented, tested, designed for the developer who was never in the room — are always welcome.*
|
||||||
|
|
||||||
|
— **NOCHEBUENADEV**
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published
|
||||||
|
by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
129
README.md
Normal file
129
README.md
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
# einherjar/db-sqlite
|
||||||
|
|
||||||
|
[](https://code.nochebuena.dev/einherjar/db-sqlite)
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://go.dev)
|
||||||
|
[]()
|
||||||
|
|
||||||
|
> Not every hall needs pillars that reach the sky. Sometimes what matters fits in a single room, carried wherever the warrior goes.
|
||||||
|
|
||||||
|
`code.nochebuena.dev/einherjar/db-sqlite` is the SQLite database component of the Einherjar framework. It uses the pure-Go `modernc.org/sqlite` driver (no CGO, cross-compilation works without a C toolchain), wraps `database/sql` behind a lifecycle-aware `Component`, and serializes writes through a mutex to prevent `SQLITE_BUSY` under concurrent goroutines. WAL mode is enabled by default.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
```go
|
||||||
|
import dbsqlite "code.nochebuena.dev/einherjar/db-sqlite"
|
||||||
|
|
||||||
|
db := dbsqlite.New(logger, dbsqlite.DefaultConfig())
|
||||||
|
launcher.Append(db) // OnInit opens database; OnStop closes it
|
||||||
|
health.Register(db) // BucketExists-style check; LevelDegraded
|
||||||
|
```
|
||||||
|
|
||||||
|
### Querying
|
||||||
|
|
||||||
|
```go
|
||||||
|
// GetExecutor returns the pool when called outside a UnitOfWork.
|
||||||
|
rows, err := db.GetExecutor(ctx).QueryContext(ctx, "SELECT id, name FROM users WHERE active = ?", true)
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var name string
|
||||||
|
err := db.GetExecutor(ctx).QueryRowContext(ctx, "SELECT name FROM users WHERE id = ?", id).Scan(&name)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Manual transaction
|
||||||
|
|
||||||
|
```go
|
||||||
|
tx, err := db.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer tx.Rollback()
|
||||||
|
|
||||||
|
_, err = tx.ExecContext(ctx, "UPDATE accounts SET balance = balance - ? WHERE id = ?", amount, fromID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return tx.Commit()
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: `Commit` and `Rollback` do not accept a context — this is a `database/sql` limitation.
|
||||||
|
|
||||||
|
### Unit of work (recommended)
|
||||||
|
|
||||||
|
`UnitOfWork` wraps the transaction in context so every call to `GetExecutor` inside `uow.Do` automatically returns the active transaction. The internal write mutex prevents concurrent `SQLITE_BUSY` errors; only one goroutine can write at a time.
|
||||||
|
|
||||||
|
```go
|
||||||
|
uow := dbsqlite.NewUnitOfWork(logger, db)
|
||||||
|
|
||||||
|
err := uow.Do(ctx, func(ctx context.Context) error {
|
||||||
|
_, err := db.GetExecutor(ctx).ExecContext(ctx, "INSERT INTO orders (...) VALUES (...)", ...)
|
||||||
|
return err
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
If the function returns an error, the transaction is rolled back. If it returns nil, the transaction is committed.
|
||||||
|
|
||||||
|
### Error handling
|
||||||
|
|
||||||
|
```go
|
||||||
|
if err := db.HandleError(someErr); err != nil {
|
||||||
|
// SQLite error codes mapped to xerrors:
|
||||||
|
// UNIQUE constraint failed → ErrAlreadyExists
|
||||||
|
// FOREIGN KEY constraint → ErrPreconditionFailed
|
||||||
|
// NOT NULL constraint → ErrInvalidInput
|
||||||
|
// context.Canceled → ErrCancelled
|
||||||
|
// context.DeadlineExceeded → ErrDeadlineExceeded
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`HandleError` is also available as a package-level function: `dbsqlite.HandleError(err)`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Environment variables
|
||||||
|
|
||||||
|
| Variable | Required | Default | Description |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `EINHERJAR_SQLITE_PATH` | Yes | — | Path to the SQLite database file |
|
||||||
|
| `EINHERJAR_SQLITE_MAX_OPEN_CONNS` | No | `1` | Maximum open connections (keep at 1 for writes) |
|
||||||
|
| `EINHERJAR_SQLITE_MAX_IDLE_CONNS` | No | `1` | Maximum idle connections |
|
||||||
|
| `EINHERJAR_SQLITE_PRAGMAS` | No | `?_journal=WAL&_timeout=5000&_fk=true` | DSN pragma string |
|
||||||
|
|
||||||
|
The default pragma string enables WAL mode (better concurrent reads), a 5-second busy timeout, and foreign key enforcement.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Dependency graph
|
||||||
|
|
||||||
|
```
|
||||||
|
contracts (zero dependencies)
|
||||||
|
↑
|
||||||
|
core
|
||||||
|
↑
|
||||||
|
db-sqlite (contracts, core, modernc.org/sqlite)
|
||||||
|
↑
|
||||||
|
your app
|
||||||
|
```
|
||||||
|
|
||||||
|
No CGO. Cross-compiles to any GOOS/GOARCH without a C toolchain.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd db-sqlite/
|
||||||
|
go build ./...
|
||||||
|
go vet ./...
|
||||||
|
go test ./...
|
||||||
|
gofmt -l .
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> *The hall is built before the warriors arrive.*
|
||||||
|
> *That is the only guarantee worth making.*
|
||||||
280
compliance_test.go
Normal file
280
compliance_test.go
Normal file
@@ -0,0 +1,280 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"go/ast"
|
||||||
|
"go/parser"
|
||||||
|
"go/token"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/lifecycle"
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/logging"
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/observability"
|
||||||
|
"code.nochebuena.dev/einherjar/core/xerrors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compile-time interface checks (CT-5 / I-8).
|
||||||
|
var _ lifecycle.Component = (Component)(nil)
|
||||||
|
var _ observability.Checkable = (Component)(nil)
|
||||||
|
var _ Provider = (Component)(nil)
|
||||||
|
|
||||||
|
// --- CT-6: at most one exported TypeSpec per non-test, non-doc file ---
|
||||||
|
|
||||||
|
func TestAtMostOneExportedTypePerFile(t *testing.T) {
|
||||||
|
fset := token.NewFileSet()
|
||||||
|
pkgs, err := parser.ParseDir(fset, ".", func(fi os.FileInfo) bool {
|
||||||
|
name := fi.Name()
|
||||||
|
return !strings.HasSuffix(name, "_test.go") && name != "doc.go"
|
||||||
|
}, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("parse: %v", err)
|
||||||
|
}
|
||||||
|
for _, pkg := range pkgs {
|
||||||
|
for path, file := range pkg.Files {
|
||||||
|
base := filepath.Base(path)
|
||||||
|
count := 0
|
||||||
|
for _, decl := range file.Decls {
|
||||||
|
gd, ok := decl.(*ast.GenDecl)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, spec := range gd.Specs {
|
||||||
|
ts, ok := spec.(*ast.TypeSpec)
|
||||||
|
if ok && ts.Name.IsExported() {
|
||||||
|
count++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if count > 1 {
|
||||||
|
t.Errorf("%s: %d exported TypeSpecs (max 1)", base, count)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Config defaults (S-4) ---
|
||||||
|
|
||||||
|
func TestDefaultConfig_OptionalFields(t *testing.T) {
|
||||||
|
cfg := DefaultConfig()
|
||||||
|
if cfg.MaxOpenConns == 0 {
|
||||||
|
t.Error("MaxOpenConns must have a default")
|
||||||
|
}
|
||||||
|
if cfg.MaxIdleConns == 0 {
|
||||||
|
t.Error("MaxIdleConns must have a default")
|
||||||
|
}
|
||||||
|
if cfg.Pragmas == "" {
|
||||||
|
t.Error("Pragmas must have a default")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Config.DSN ---
|
||||||
|
|
||||||
|
func TestConfig_DSN(t *testing.T) {
|
||||||
|
cfg := Config{Path: "test.db", Pragmas: "?_journal=WAL"}
|
||||||
|
dsn := cfg.DSN()
|
||||||
|
if !strings.Contains(dsn, "test.db") {
|
||||||
|
t.Errorf("DSN %q missing path", dsn)
|
||||||
|
}
|
||||||
|
if !strings.Contains(dsn, "?_journal=WAL") {
|
||||||
|
t.Errorf("DSN %q missing pragmas", dsn)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- HandleError ---
|
||||||
|
|
||||||
|
func TestHandleError_Nil(t *testing.T) {
|
||||||
|
if err := HandleError(nil); err != nil {
|
||||||
|
t.Errorf("want nil, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleError_NoRows(t *testing.T) {
|
||||||
|
assertXCode(t, HandleError(sql.ErrNoRows), xerrors.ErrNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleError_UniqueConstraint(t *testing.T) {
|
||||||
|
assertXCode(t, HandleError(&fakeSQLiteErr{code: sqliteConstraintUnique}), xerrors.ErrAlreadyExists)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleError_PrimaryKey(t *testing.T) {
|
||||||
|
assertXCode(t, HandleError(&fakeSQLiteErr{code: sqliteConstraintPrimaryKey}), xerrors.ErrAlreadyExists)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleError_ForeignKey(t *testing.T) {
|
||||||
|
assertXCode(t, HandleError(&fakeSQLiteErr{code: sqliteConstraintForeignKey}), xerrors.ErrInvalidInput)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleError_Generic(t *testing.T) {
|
||||||
|
assertXCode(t, HandleError(errors.New("boom")), xerrors.ErrInternal)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- New ---
|
||||||
|
|
||||||
|
func TestNew_NotNil(t *testing.T) {
|
||||||
|
if New(newLogger(), Config{}) == nil {
|
||||||
|
t.Fatal("New returned nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Component metadata ---
|
||||||
|
|
||||||
|
func TestComponent_Name(t *testing.T) {
|
||||||
|
c := New(newLogger(), Config{})
|
||||||
|
if c.Name() != "sqlite" {
|
||||||
|
t.Errorf("Name() = %q, want %q", c.Name(), "sqlite")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComponent_Priority(t *testing.T) {
|
||||||
|
c := New(newLogger(), Config{})
|
||||||
|
if c.Priority() != observability.LevelCritical {
|
||||||
|
t.Error("Priority() != LevelCritical")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComponent_OnStop_NilDB(t *testing.T) {
|
||||||
|
c := &sqliteImpl{logger: newLogger()}
|
||||||
|
if err := c.OnStop(); err != nil {
|
||||||
|
t.Errorf("OnStop with nil db: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComponent_Begin_NilDB(t *testing.T) {
|
||||||
|
c := &sqliteImpl{logger: newLogger()}
|
||||||
|
_, err := c.Begin(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Error("expected error for nil db")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComponent_GetExecutor_ReturnsDB(t *testing.T) {
|
||||||
|
c := &sqliteImpl{logger: newLogger()}
|
||||||
|
exec := c.GetExecutor(context.Background())
|
||||||
|
if exec != nil {
|
||||||
|
t.Error("expected nil executor when db is nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComponent_GetExecutor_ReturnsTx(t *testing.T) {
|
||||||
|
tx := &mockTx{}
|
||||||
|
ctx := context.WithValue(context.Background(), ctxTxKey{}, tx)
|
||||||
|
c := &sqliteImpl{logger: newLogger()}
|
||||||
|
got := c.GetExecutor(ctx)
|
||||||
|
if got != tx {
|
||||||
|
t.Error("GetExecutor should return injected Tx from context")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- UnitOfWork ---
|
||||||
|
|
||||||
|
func TestUnitOfWork_Commit(t *testing.T) {
|
||||||
|
tx := &mockTx{}
|
||||||
|
uow := NewUnitOfWork(newLogger(), &mockProvider{tx: tx})
|
||||||
|
if err := uow.Do(context.Background(), func(ctx context.Context) error { return nil }); err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if !tx.committed {
|
||||||
|
t.Error("expected Commit to be called")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnitOfWork_Rollback(t *testing.T) {
|
||||||
|
tx := &mockTx{}
|
||||||
|
uow := NewUnitOfWork(newLogger(), &mockProvider{tx: tx})
|
||||||
|
_ = uow.Do(context.Background(), func(ctx context.Context) error { return errors.New("fail") })
|
||||||
|
if !tx.rolledBack {
|
||||||
|
t.Error("expected Rollback to be called")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnitOfWork_InjectsExecutor(t *testing.T) {
|
||||||
|
tx := &mockTx{}
|
||||||
|
client := &mockProvider{tx: tx}
|
||||||
|
uow := NewUnitOfWork(newLogger(), client)
|
||||||
|
var got Executor
|
||||||
|
_ = uow.Do(context.Background(), func(ctx context.Context) error {
|
||||||
|
got = client.GetExecutor(ctx)
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if got != tx {
|
||||||
|
t.Error("GetExecutor should return the injected Tx inside Do")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnitOfWork_ReturnsBeginError(t *testing.T) {
|
||||||
|
client := &mockProvider{beginErr: errors.New("connection lost")}
|
||||||
|
uow := NewUnitOfWork(newLogger(), client)
|
||||||
|
if err := uow.Do(context.Background(), func(ctx context.Context) error { return nil }); err == nil {
|
||||||
|
t.Error("expected error when Begin fails")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- helpers ---
|
||||||
|
|
||||||
|
func assertXCode(t *testing.T, err error, want xerrors.Code) {
|
||||||
|
t.Helper()
|
||||||
|
var xe *xerrors.Err
|
||||||
|
if !errors.As(err, &xe) {
|
||||||
|
t.Fatalf("expected *xerrors.Err, got %T: %v", err, err)
|
||||||
|
}
|
||||||
|
if xe.Code() != want {
|
||||||
|
t.Errorf("want code %s, got %s", want, xe.Code())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// fakeSQLiteErr implements the coder interface for error mapping tests.
|
||||||
|
type fakeSQLiteErr struct{ code int }
|
||||||
|
|
||||||
|
func (e *fakeSQLiteErr) Error() string { return fmt.Sprintf("sqlite error %d", e.code) }
|
||||||
|
func (e *fakeSQLiteErr) Code() int { return e.code }
|
||||||
|
|
||||||
|
// --- stubs ---
|
||||||
|
|
||||||
|
type stubLogger struct{}
|
||||||
|
|
||||||
|
func newLogger() *stubLogger { return &stubLogger{} }
|
||||||
|
|
||||||
|
func (s *stubLogger) Debug(msg string, args ...any) {}
|
||||||
|
func (s *stubLogger) Info(msg string, args ...any) {}
|
||||||
|
func (s *stubLogger) Warn(msg string, args ...any) {}
|
||||||
|
func (s *stubLogger) Error(msg string, err error, args ...any) {}
|
||||||
|
func (s *stubLogger) With(args ...any) logging.Logger { return s }
|
||||||
|
func (s *stubLogger) WithContext(ctx context.Context) logging.Logger { return s }
|
||||||
|
|
||||||
|
type mockTx struct{ committed, rolledBack bool }
|
||||||
|
|
||||||
|
func (m *mockTx) ExecContext(ctx context.Context, q string, args ...any) (sql.Result, error) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
func (m *mockTx) QueryContext(ctx context.Context, q string, args ...any) (*sql.Rows, error) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
func (m *mockTx) QueryRowContext(ctx context.Context, q string, args ...any) *sql.Row { return nil }
|
||||||
|
func (m *mockTx) Commit() error { m.committed = true; return nil }
|
||||||
|
func (m *mockTx) Rollback() error { m.rolledBack = true; return nil }
|
||||||
|
|
||||||
|
type mockProvider struct {
|
||||||
|
tx *mockTx
|
||||||
|
beginErr error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockProvider) Begin(ctx context.Context) (Tx, error) {
|
||||||
|
if m.beginErr != nil {
|
||||||
|
return nil, m.beginErr
|
||||||
|
}
|
||||||
|
return m.tx, nil
|
||||||
|
}
|
||||||
|
func (m *mockProvider) Ping(ctx context.Context) error { return nil }
|
||||||
|
func (m *mockProvider) HandleError(err error) error { return HandleError(err) }
|
||||||
|
func (m *mockProvider) GetExecutor(ctx context.Context) Executor {
|
||||||
|
if tx, ok := ctx.Value(ctxTxKey{}).(Executor); ok {
|
||||||
|
return tx
|
||||||
|
}
|
||||||
|
return m.tx
|
||||||
|
}
|
||||||
16
component.go
Normal file
16
component.go
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/lifecycle"
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/observability"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Component bundles the full sqlite capability: lifecycle management,
|
||||||
|
// health reporting, and the database [Provider] interface.
|
||||||
|
// Register with launcher and health before starting.
|
||||||
|
type Component interface {
|
||||||
|
lifecycle.Component
|
||||||
|
observability.Checkable
|
||||||
|
observability.Identifiable
|
||||||
|
Provider
|
||||||
|
}
|
||||||
28
config.go
Normal file
28
config.go
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
// Config holds SQLite connection settings. Path is required; all other fields
|
||||||
|
// have production-safe defaults via [DefaultConfig].
|
||||||
|
type Config struct {
|
||||||
|
// Path is the SQLite file path. Use ":memory:" for in-memory databases.
|
||||||
|
Path string `env:"EINHERJAR_SQLITE_PATH,required"`
|
||||||
|
MaxOpenConns int `env:"EINHERJAR_SQLITE_MAX_OPEN_CONNS" envDefault:"1"`
|
||||||
|
MaxIdleConns int `env:"EINHERJAR_SQLITE_MAX_IDLE_CONNS" envDefault:"1"`
|
||||||
|
// Pragmas are appended to the DSN as query parameters.
|
||||||
|
// Default enables WAL journal mode, 5-second busy timeout, and FK enforcement.
|
||||||
|
Pragmas string `env:"EINHERJAR_SQLITE_PRAGMAS" envDefault:"?_journal=WAL&_timeout=5000&_fk=true"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultConfig returns a Config with all optional fields set to production-safe
|
||||||
|
// defaults. Callers must supply Path.
|
||||||
|
func DefaultConfig() Config {
|
||||||
|
return Config{
|
||||||
|
MaxOpenConns: 1,
|
||||||
|
MaxIdleConns: 1,
|
||||||
|
Pragmas: "?_journal=WAL&_timeout=5000&_fk=true",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DSN constructs the SQLite connection string from the configuration.
|
||||||
|
func (c Config) DSN() string {
|
||||||
|
return c.Path + c.Pragmas
|
||||||
|
}
|
||||||
69
doc.go
Normal file
69
doc.go
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
// Package sqlite provides a pure-Go SQLite client with lifecycle management,
|
||||||
|
// health checks, and unit-of-work transaction support for Einherjar applications.
|
||||||
|
//
|
||||||
|
// # Overview
|
||||||
|
//
|
||||||
|
// [New] returns a [Component] that manages a [database/sql] connection pool,
|
||||||
|
// satisfies the [lifecycle.Component] lifecycle hooks (OnInit, OnStart, OnStop),
|
||||||
|
// and implements [observability.Checkable] with critical priority.
|
||||||
|
//
|
||||||
|
// [NewUnitOfWork] wraps multiple repository operations in a single serialized
|
||||||
|
// transaction via context injection — no transaction object is passed between
|
||||||
|
// functions. Write transactions are serialized through an internal mutex to
|
||||||
|
// prevent SQLITE_BUSY errors under concurrent goroutines.
|
||||||
|
//
|
||||||
|
// # Lifecycle Registration
|
||||||
|
//
|
||||||
|
// db := sqlite.New(logger, cfg)
|
||||||
|
// launcher.Register(db)
|
||||||
|
// health.Register(db)
|
||||||
|
//
|
||||||
|
// # Querying
|
||||||
|
//
|
||||||
|
// Repository code receives a [Provider] or [Executor] and calls [Provider.GetExecutor]
|
||||||
|
// to obtain the active transaction (if inside a [UnitOfWork]) or the connection pool:
|
||||||
|
//
|
||||||
|
// exec := db.GetExecutor(ctx)
|
||||||
|
// row := exec.QueryRowContext(ctx, "SELECT id FROM users WHERE email = ?", email)
|
||||||
|
// if err := row.Scan(&id); err != nil {
|
||||||
|
// return db.HandleError(err) // maps sql.ErrNoRows → ErrNotFound, etc.
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// # Unit of Work
|
||||||
|
//
|
||||||
|
// [NewUnitOfWork] wraps operations in a single serialized write transaction.
|
||||||
|
// The transaction is injected into the context; [Provider.GetExecutor] returns
|
||||||
|
// it automatically.
|
||||||
|
//
|
||||||
|
// uow := sqlite.NewUnitOfWork(logger, db)
|
||||||
|
// err := uow.Do(ctx, func(ctx context.Context) error {
|
||||||
|
// exec := db.GetExecutor(ctx) // returns active Tx
|
||||||
|
// _, err := exec.ExecContext(ctx, "INSERT INTO orders ...")
|
||||||
|
// return err
|
||||||
|
// })
|
||||||
|
//
|
||||||
|
// # Error Handling
|
||||||
|
//
|
||||||
|
// [HandleError] translates database/sql and SQLite error codes into typed
|
||||||
|
// [xerrors] values. Call it at every point where a database error is first observed:
|
||||||
|
//
|
||||||
|
// if err := row.Scan(&out); err != nil {
|
||||||
|
// return db.HandleError(err)
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Mapped codes:
|
||||||
|
// - sql.ErrNoRows → ErrNotFound
|
||||||
|
// - SQLITE_CONSTRAINT_UNIQUE (2067) → ErrAlreadyExists
|
||||||
|
// - SQLITE_CONSTRAINT_PRIMARYKEY (1555) → ErrAlreadyExists
|
||||||
|
// - SQLITE_CONSTRAINT_FOREIGNKEY (787) → ErrInvalidInput
|
||||||
|
// - all others → ErrInternal
|
||||||
|
//
|
||||||
|
// # Configuration
|
||||||
|
//
|
||||||
|
// All fields are read from environment variables with the EINHERJAR_SQLITE_* prefix:
|
||||||
|
//
|
||||||
|
// - EINHERJAR_SQLITE_PATH (required) — file path or ":memory:"
|
||||||
|
// - EINHERJAR_SQLITE_MAX_OPEN_CONNS — default: 1
|
||||||
|
// - EINHERJAR_SQLITE_MAX_IDLE_CONNS — default: 1
|
||||||
|
// - EINHERJAR_SQLITE_PRAGMAS — default: "?_journal=WAL&_timeout=5000&_fk=true"
|
||||||
|
package sqlite
|
||||||
46
errors.go
Normal file
46
errors.go
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
|
||||||
|
"code.nochebuena.dev/einherjar/core/xerrors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// coder is the duck-type interface for SQLite extended error codes.
|
||||||
|
// modernc.org/sqlite errors implement this interface.
|
||||||
|
type coder interface{ Code() int }
|
||||||
|
|
||||||
|
const (
|
||||||
|
sqliteConstraintPrimaryKey = 1555
|
||||||
|
sqliteConstraintUnique = 2067
|
||||||
|
sqliteConstraintForeignKey = 787
|
||||||
|
)
|
||||||
|
|
||||||
|
// HandleError maps database/sql and SQLite errors to typed [xerrors] values.
|
||||||
|
// Returns nil when err is nil. Also available as [Provider.HandleError].
|
||||||
|
//
|
||||||
|
// Mapped codes:
|
||||||
|
// - sql.ErrNoRows → ErrNotFound
|
||||||
|
// - SQLITE_CONSTRAINT_UNIQUE (2067) → ErrAlreadyExists
|
||||||
|
// - SQLITE_CONSTRAINT_PRIMARYKEY (1555)→ ErrAlreadyExists
|
||||||
|
// - SQLITE_CONSTRAINT_FOREIGNKEY (787) → ErrInvalidInput
|
||||||
|
// - all others → ErrInternal
|
||||||
|
func HandleError(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return xerrors.New(xerrors.ErrNotFound, "record not found").WithError(err)
|
||||||
|
}
|
||||||
|
var ce coder
|
||||||
|
if errors.As(err, &ce) {
|
||||||
|
switch ce.Code() {
|
||||||
|
case sqliteConstraintUnique, sqliteConstraintPrimaryKey:
|
||||||
|
return xerrors.New(xerrors.ErrAlreadyExists, "record already exists").WithError(err)
|
||||||
|
case sqliteConstraintForeignKey:
|
||||||
|
return xerrors.New(xerrors.ErrInvalidInput, "data integrity violation").WithError(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return xerrors.New(xerrors.ErrInternal, "unexpected database error").WithError(err)
|
||||||
|
}
|
||||||
18
executor.go
Normal file
18
executor.go
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Executor is the shared query interface for both the connection pool and
|
||||||
|
// an active transaction. Repository code accepts Executor so it works
|
||||||
|
// identically inside and outside a [UnitOfWork].
|
||||||
|
type Executor interface {
|
||||||
|
// ExecContext executes a query that returns no rows.
|
||||||
|
ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
|
||||||
|
// QueryContext executes a query that returns rows.
|
||||||
|
QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
|
||||||
|
// QueryRowContext executes a query that returns at most one row.
|
||||||
|
QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row
|
||||||
|
}
|
||||||
22
go.mod
Normal file
22
go.mod
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
module code.nochebuena.dev/einherjar/db-sqlite
|
||||||
|
|
||||||
|
go 1.26
|
||||||
|
|
||||||
|
require (
|
||||||
|
code.nochebuena.dev/einherjar/contracts v1.0.0
|
||||||
|
code.nochebuena.dev/einherjar/core v1.0.0
|
||||||
|
modernc.org/sqlite v1.37.1
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/dustin/go-humanize v1.0.1 // indirect
|
||||||
|
github.com/google/uuid v1.6.0 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||||
|
github.com/ncruces/go-strftime v0.1.9 // indirect
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
||||||
|
golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0 // indirect
|
||||||
|
golang.org/x/sys v0.39.0 // indirect
|
||||||
|
modernc.org/libc v1.65.7 // indirect
|
||||||
|
modernc.org/mathutil v1.7.1 // indirect
|
||||||
|
modernc.org/memory v1.11.0 // indirect
|
||||||
|
)
|
||||||
51
go.sum
Normal file
51
go.sum
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
code.nochebuena.dev/einherjar/contracts v1.0.0 h1:hRudEtOIqU7vwedYLsCh8+9q5dCnKb61qX+zibqImRU=
|
||||||
|
code.nochebuena.dev/einherjar/contracts v1.0.0/go.mod h1:ccltUtrFb5+MEJdkx2VVEUL+xC5pupVlVVsMM8AlCWI=
|
||||||
|
code.nochebuena.dev/einherjar/core v1.0.0 h1:AueZgfjp3+rQmDKOxmJQ945TTh+sqC1l/xJdTOdbr9w=
|
||||||
|
code.nochebuena.dev/einherjar/core v1.0.0/go.mod h1:0IywfRnJXX9xXQO6iPVaq2QDlXbbpXrB8A4T7gO8nE4=
|
||||||
|
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
||||||
|
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
||||||
|
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e h1:ijClszYn+mADRFY17kjQEVQ1XRhq2/JR1M3sGqeJoxs=
|
||||||
|
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
|
||||||
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
|
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||||
|
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||||
|
github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
|
||||||
|
github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
|
||||||
|
golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0 h1:R84qjqJb5nVJMxqWYb3np9L5ZsaDtB+a39EqjV0JSUM=
|
||||||
|
golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0/go.mod h1:S9Xr4PYopiDyqSyp5NjCrhFrqg6A5zA2E/iPHPhqnS8=
|
||||||
|
golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
|
||||||
|
golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
|
||||||
|
golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ=
|
||||||
|
golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
|
||||||
|
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
|
||||||
|
golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||||
|
golang.org/x/tools v0.33.0 h1:4qz2S3zmRxbGIhDIAgjxvFutSvH5EfnsYrRBj0UI0bc=
|
||||||
|
golang.org/x/tools v0.33.0/go.mod h1:CIJMaWEY88juyUfo7UbgPqbC8rU2OqfAV1h2Qp0oMYI=
|
||||||
|
modernc.org/cc/v4 v4.26.1 h1:+X5NtzVBn0KgsBCBe+xkDC7twLb/jNVj9FPgiwSQO3s=
|
||||||
|
modernc.org/cc/v4 v4.26.1/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0=
|
||||||
|
modernc.org/ccgo/v4 v4.28.0 h1:rjznn6WWehKq7dG4JtLRKxb52Ecv8OUGah8+Z/SfpNU=
|
||||||
|
modernc.org/ccgo/v4 v4.28.0/go.mod h1:JygV3+9AV6SmPhDasu4JgquwU81XAKLd3OKTUDNOiKE=
|
||||||
|
modernc.org/fileutil v1.3.1 h1:8vq5fe7jdtEvoCf3Zf9Nm0Q05sH6kGx0Op2CPx1wTC8=
|
||||||
|
modernc.org/fileutil v1.3.1/go.mod h1:HxmghZSZVAz/LXcMNwZPA/DRrQZEVP9VX0V4LQGQFOc=
|
||||||
|
modernc.org/gc/v2 v2.6.5 h1:nyqdV8q46KvTpZlsw66kWqwXRHdjIlJOhG6kxiV/9xI=
|
||||||
|
modernc.org/gc/v2 v2.6.5/go.mod h1:YgIahr1ypgfe7chRuJi2gD7DBQiKSLMPgBQe9oIiito=
|
||||||
|
modernc.org/libc v1.65.7 h1:Ia9Z4yzZtWNtUIuiPuQ7Qf7kxYrxP1/jeHZzG8bFu00=
|
||||||
|
modernc.org/libc v1.65.7/go.mod h1:011EQibzzio/VX3ygj1qGFt5kMjP0lHb0qCW5/D/pQU=
|
||||||
|
modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
|
||||||
|
modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
|
||||||
|
modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI=
|
||||||
|
modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
|
||||||
|
modernc.org/opt v0.1.4 h1:2kNGMRiUjrp4LcaPuLY2PzUfqM/w9N23quVwhKt5Qm8=
|
||||||
|
modernc.org/opt v0.1.4/go.mod h1:03fq9lsNfvkYSfxrfUhZCWPk1lm4cq4N+Bh//bEtgns=
|
||||||
|
modernc.org/sortutil v1.2.1 h1:+xyoGf15mM3NMlPDnFqrteY07klSFxLElE2PVuWIJ7w=
|
||||||
|
modernc.org/sortutil v1.2.1/go.mod h1:7ZI3a3REbai7gzCLcotuw9AC4VZVpYMjDzETGsSMqJE=
|
||||||
|
modernc.org/sqlite v1.37.1 h1:EgHJK/FPoqC+q2YBXg7fUmES37pCHFc97sI7zSayBEs=
|
||||||
|
modernc.org/sqlite v1.37.1/go.mod h1:XwdRtsE1MpiBcL54+MbKcaDvcuej+IYSMfLN6gSKV8g=
|
||||||
|
modernc.org/strutil v1.2.1 h1:UneZBkQA+DX2Rp35KcM69cSsNES9ly8mQWD71HKlOA0=
|
||||||
|
modernc.org/strutil v1.2.1/go.mod h1:EHkiggD70koQxjVdSBM3JKM7k6L0FbGE5eymy9i3B9A=
|
||||||
|
modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
|
||||||
|
modernc.org/token v1.1.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM=
|
||||||
21
identifiable.go
Normal file
21
identifiable.go
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import "runtime/debug"
|
||||||
|
|
||||||
|
const modulePath = "code.nochebuena.dev/einherjar/db-sqlite"
|
||||||
|
|
||||||
|
func (c *sqliteImpl) ModulePath() string { return modulePath }
|
||||||
|
|
||||||
|
func (c *sqliteImpl) ModuleVersion() string {
|
||||||
|
if info, ok := debug.ReadBuildInfo(); ok {
|
||||||
|
for _, dep := range info.Deps {
|
||||||
|
if dep.Path == modulePath {
|
||||||
|
return dep.Version
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if info.Main.Path == modulePath {
|
||||||
|
return info.Main.Version
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "(devel)"
|
||||||
|
}
|
||||||
203
new.go
Normal file
203
new.go
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
_ "modernc.org/sqlite" // register sqlite driver
|
||||||
|
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/logging"
|
||||||
|
"code.nochebuena.dev/einherjar/contracts/observability"
|
||||||
|
"code.nochebuena.dev/einherjar/core/xerrors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compile-time interface verification (I-8 / CT-5).
|
||||||
|
var _ Component = (*sqliteImpl)(nil)
|
||||||
|
var _ observability.Identifiable = (*sqliteImpl)(nil)
|
||||||
|
var _ Tx = (*sqliteTx)(nil)
|
||||||
|
var _ UnitOfWork = (*unitOfWork)(nil)
|
||||||
|
|
||||||
|
// New returns a Component backed by the given configuration.
|
||||||
|
// The database is not opened until OnInit is called.
|
||||||
|
func New(logger logging.Logger, cfg Config) Component {
|
||||||
|
return &sqliteImpl{logger: logger, cfg: cfg}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUnitOfWork returns a UnitOfWork backed by the given client.
|
||||||
|
// When client is the result of [New], write transactions are serialized
|
||||||
|
// through an internal mutex to prevent SQLITE_BUSY errors.
|
||||||
|
func NewUnitOfWork(logger logging.Logger, client Provider) UnitOfWork {
|
||||||
|
var mu *sync.Mutex
|
||||||
|
if sc, ok := client.(*sqliteImpl); ok {
|
||||||
|
mu = &sc.writeMu
|
||||||
|
}
|
||||||
|
return &unitOfWork{logger: logger, client: client, writeMu: mu}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ctxTxKey is the context key for the active transaction.
|
||||||
|
type ctxTxKey struct{}
|
||||||
|
|
||||||
|
// --- sqliteImpl ---
|
||||||
|
|
||||||
|
type sqliteImpl struct {
|
||||||
|
logger logging.Logger
|
||||||
|
cfg Config
|
||||||
|
db *sql.DB
|
||||||
|
mu sync.RWMutex
|
||||||
|
writeMu sync.Mutex // serializes writes to prevent SQLITE_BUSY
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) OnInit() error {
|
||||||
|
db, err := sql.Open("sqlite", c.cfg.DSN())
|
||||||
|
if err != nil {
|
||||||
|
return xerrors.New(xerrors.ErrInternal, "sqlite: open").WithError(err)
|
||||||
|
}
|
||||||
|
maxOpen := c.cfg.MaxOpenConns
|
||||||
|
if maxOpen == 0 {
|
||||||
|
maxOpen = 1
|
||||||
|
}
|
||||||
|
db.SetMaxOpenConns(maxOpen)
|
||||||
|
db.SetMaxIdleConns(c.cfg.MaxIdleConns)
|
||||||
|
// Enforce foreign keys per-connection (SQLite disables them by default).
|
||||||
|
if _, err := db.Exec("PRAGMA foreign_keys = ON"); err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
return xerrors.New(xerrors.ErrInternal, "sqlite: enable foreign keys").WithError(err)
|
||||||
|
}
|
||||||
|
c.mu.Lock()
|
||||||
|
c.db = db
|
||||||
|
c.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) OnStart() error {
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := c.Ping(ctx); err != nil {
|
||||||
|
return xerrors.New(xerrors.ErrUnavailable, "sqlite: ping failed").WithError(err)
|
||||||
|
}
|
||||||
|
c.logger.Info("sqlite: connected", "path", c.cfg.Path)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) OnStop() error {
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
if c.db != nil {
|
||||||
|
c.logger.Info("sqlite: closing")
|
||||||
|
_ = c.db.Close()
|
||||||
|
c.db = nil
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) Ping(ctx context.Context) error {
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
if db == nil {
|
||||||
|
return xerrors.New(xerrors.ErrInternal, "sqlite: not initialized")
|
||||||
|
}
|
||||||
|
return db.PingContext(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) GetExecutor(ctx context.Context) Executor {
|
||||||
|
if tx, ok := ctx.Value(ctxTxKey{}).(Executor); ok {
|
||||||
|
return tx
|
||||||
|
}
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
if db == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) Begin(ctx context.Context) (Tx, error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
if db == nil {
|
||||||
|
return nil, xerrors.New(xerrors.ErrInternal, "sqlite: not initialized")
|
||||||
|
}
|
||||||
|
tx, err := db.BeginTx(ctx, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, xerrors.New(xerrors.ErrInternal, "sqlite: begin transaction").WithError(err)
|
||||||
|
}
|
||||||
|
return &sqliteTx{Tx: tx}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
return db.ExecContext(ctx, query, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
return db.QueryContext(ctx, query, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row {
|
||||||
|
c.mu.RLock()
|
||||||
|
db := c.db
|
||||||
|
c.mu.RUnlock()
|
||||||
|
return db.QueryRowContext(ctx, query, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *sqliteImpl) HandleError(err error) error { return HandleError(err) }
|
||||||
|
|
||||||
|
func (c *sqliteImpl) HealthCheck(ctx context.Context) error { return c.Ping(ctx) }
|
||||||
|
func (c *sqliteImpl) Name() string { return "sqlite" }
|
||||||
|
func (c *sqliteImpl) Priority() observability.Level { return observability.LevelCritical }
|
||||||
|
|
||||||
|
// --- sqliteTx ---
|
||||||
|
|
||||||
|
type sqliteTx struct{ *sql.Tx }
|
||||||
|
|
||||||
|
func (t *sqliteTx) ExecContext(ctx context.Context, q string, args ...any) (sql.Result, error) {
|
||||||
|
return t.Tx.ExecContext(ctx, q, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *sqliteTx) QueryContext(ctx context.Context, q string, args ...any) (*sql.Rows, error) {
|
||||||
|
return t.Tx.QueryContext(ctx, q, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *sqliteTx) QueryRowContext(ctx context.Context, q string, args ...any) *sql.Row {
|
||||||
|
return t.Tx.QueryRowContext(ctx, q, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *sqliteTx) Commit() error { return t.Tx.Commit() }
|
||||||
|
func (t *sqliteTx) Rollback() error { return t.Tx.Rollback() }
|
||||||
|
|
||||||
|
// --- unitOfWork ---
|
||||||
|
|
||||||
|
type unitOfWork struct {
|
||||||
|
logger logging.Logger
|
||||||
|
client Provider
|
||||||
|
writeMu *sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *unitOfWork) Do(ctx context.Context, fn func(ctx context.Context) error) error {
|
||||||
|
if u.writeMu != nil {
|
||||||
|
u.writeMu.Lock()
|
||||||
|
defer u.writeMu.Unlock()
|
||||||
|
}
|
||||||
|
tx, err := u.client.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return xerrors.New(xerrors.ErrInternal, "sqlite: begin transaction").WithError(err)
|
||||||
|
}
|
||||||
|
ctx = context.WithValue(ctx, ctxTxKey{}, tx)
|
||||||
|
if err := fn(ctx); err != nil {
|
||||||
|
if rbErr := tx.Rollback(); rbErr != nil {
|
||||||
|
u.logger.Error("sqlite: rollback failed", rbErr)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return tx.Commit()
|
||||||
|
}
|
||||||
18
provider.go
Normal file
18
provider.go
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// Provider is the database access interface consumed by repositories and services.
|
||||||
|
// All methods are safe for concurrent use.
|
||||||
|
type Provider interface {
|
||||||
|
// GetExecutor returns the active transaction injected by [UnitOfWork] if one
|
||||||
|
// is present in ctx, otherwise returns the connection pool.
|
||||||
|
GetExecutor(ctx context.Context) Executor
|
||||||
|
// Begin starts a new transaction.
|
||||||
|
Begin(ctx context.Context) (Tx, error)
|
||||||
|
// Ping verifies that the database connection is alive.
|
||||||
|
Ping(ctx context.Context) error
|
||||||
|
// HandleError maps a database/sql or SQLite error to a typed [xerrors] value.
|
||||||
|
// Call this at every point where a database error is first observed.
|
||||||
|
HandleError(err error) error
|
||||||
|
}
|
||||||
16
tx.go
Normal file
16
tx.go
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
// Tx extends [Executor] with commit and rollback. Obtained via [Provider.Begin]
|
||||||
|
// when manual transaction control is needed.
|
||||||
|
// Prefer [UnitOfWork] for the common case of a single transactional unit.
|
||||||
|
//
|
||||||
|
// Note: Commit and Rollback accept no context argument — this matches the
|
||||||
|
// database/sql limitation. The underlying *sql.Tx does not support context
|
||||||
|
// cancellation on Commit or Rollback.
|
||||||
|
type Tx interface {
|
||||||
|
Executor
|
||||||
|
// Commit commits the transaction.
|
||||||
|
Commit() error
|
||||||
|
// Rollback rolls back the transaction. Safe to call after Commit.
|
||||||
|
Rollback() error
|
||||||
|
}
|
||||||
17
unit_of_work.go
Normal file
17
unit_of_work.go
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// UnitOfWork wraps a set of repository operations in a single serialized
|
||||||
|
// database transaction. The transaction is injected into the context;
|
||||||
|
// [Provider.GetExecutor] returns it automatically so repository code requires
|
||||||
|
// no changes to participate.
|
||||||
|
//
|
||||||
|
// Write transactions are serialized through a mutex to prevent SQLITE_BUSY
|
||||||
|
// errors. Pass the result of [New] to [NewUnitOfWork] to enable serialization.
|
||||||
|
type UnitOfWork interface {
|
||||||
|
// Do begins a transaction, calls fn with the enriched context, and commits
|
||||||
|
// on success or rolls back on error. The original fn error is always returned
|
||||||
|
// when fn fails, regardless of the rollback outcome.
|
||||||
|
Do(ctx context.Context, fn func(ctx context.Context) error) error
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user