SnapOtterandGitHub
d10d0f544f
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
11 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version
| description | i18n_source_hash | i18n_provenance | i18n_output_hash | i18n_hash_version |
|---|---|---|---|---|
| مخطط قاعدة بيانات PostgreSQL، والجداول، وعمليات الترحيل، وإجراءات النسخ الاحتياطي في SnapOtter. | a68264552836 | machine | 2ee3b1bee0e9 | 2 |
قاعدة البيانات
يستخدم SnapOtter قاعدة بيانات PostgreSQL 17 مع Drizzle ORM (pg-core / node-postgres) لاستمرارية البيانات. المخطط معرَّف في apps/api/src/db/schema.ts.
يُضبَط الاتصال عبر متغير البيئة DATABASE_URL (القيمة الافتراضية postgres://snapotter:snapotter@postgres:5432/snapotter). في Docker Compose، تخزّن حاوية Postgres بياناتها في وحدة التخزين المسماة SnapOtter-pgdata.
الجداول
users
يخزّن حسابات المستخدمين. يُنشأ تلقائيًا عند التشغيل الأول من DEFAULT_USERNAME و DEFAULT_PASSWORD.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
username |
varchar | فريد، مطلوب |
passwordHash |
varchar | تجزئة scrypt |
role |
varchar | admin، أو editor، أو user |
mustChangePassword |
boolean | علامة إعادة تعيين كلمة المرور القسرية |
createdAt |
timestamp | وقت الإنشاء |
updatedAt |
timestamp | وقت آخر تحديث |
sessions
جلسات تسجيل الدخول النشطة. يربط كل صف رمز جلسة بمستخدم.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
varchar | المفتاح الأساسي (رمز الجلسة) |
userId |
uuid | مفتاح خارجي إلى users.id |
expiresAt |
timestamp | وقت انتهاء الصلاحية |
createdAt |
timestamp | وقت الإنشاء |
teams
مجموعات لتنظيم المستخدمين. يمكن للمسؤولين إسناد المستخدمين إلى فرق.
| العمود | النوع | الوصف |
|---|---|---|
id |
uuid | المفتاح الأساسي |
name |
varchar (فريد، بحد أقصى 50 حرفًا) | اسم الفريق |
createdAt |
timestamp | وقت الإنشاء |
api_keys
مفاتيح API للوصول البرمجي. يُعرَض المفتاح الخام مرة واحدة عند الإنشاء؛ ولا يُخزَّن سوى التجزئة (hash).
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
userId |
uuid | مفتاح خارجي إلى users.id |
keyHash |
varchar | تجزئة scrypt للمفتاح |
name |
varchar | تسمية يوفّرها المستخدم |
createdAt |
timestamp | وقت الإنشاء |
lastUsedAt |
timestamp | يُحدَّث عند كل طلب مصادَق عليه |
تُسبَق المفاتيح بـ si_ متبوعًا بـ 96 حرفًا ست عشريًا (48 بايتًا عشوائيًا).
pipelines
سلاسل الأدوات المحفوظة التي ينشئها المستخدمون في الواجهة.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
name |
varchar | اسم خط المعالجة |
description |
varchar | وصف اختياري |
steps |
jsonb | مصفوفة من كائنات { toolId, settings } |
createdAt |
timestamp | وقت الإنشاء |
user_files
مكتبة ملفات دائمة. يُدرَج التعديل المحفوظ افتراضيًا كصف جذري مستقل ("الحفظ كملف جديد": version يساوي 1، وparentId يساوي null، بحيث يظل الأصل مدرجًا)، أو كإصدار مرتبط بالأب عند الكتابة فوق الأصل (يُضبَط parentId، ويُزاد version، ليَحُلّ محل الأصل). يسجّل العمود toolChain الأدوات المطبَّقة.
| العمود | النوع | الوصف |
|---|---|---|
id |
uuid | المفتاح الأساسي |
userId |
uuid | مفتاح خارجي إلى users (حذف متتالٍ CASCADE DELETE) |
originalName |
varchar | اسم ملف الرفع الأصلي |
storedName |
varchar | اسم الملف على القرص |
mimeType |
varchar | نوع MIME |
size |
integer | حجم الملف بالبايت |
width |
integer | عرض الصورة بالبكسل |
height |
integer | ارتفاع الصورة بالبكسل |
version |
integer | رقم الإصدار (1 = الأصل) |
parentId |
uuid أو null | مفتاح خارجي إلى user_files (الإصدار الأب) |
toolChain |
jsonb | معرّفات الأدوات المطبَّقة بالترتيب لإنتاج هذا الإصدار |
createdAt |
timestamp | وقت الإنشاء |
jobs
يتتبّع مهام المعالجة لإعداد تقارير التقدم والتنظيف.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
type |
varchar | معرّف الأداة أو خط المعالجة |
status |
varchar | queued، أو processing، أو completed، أو failed |
progress |
real | كسر من 0.0 إلى 1.0 |
inputFiles |
jsonb | مصفوفة من مسارات ملفات الإدخال |
outputPath |
varchar | مسار ملف النتيجة |
settings |
jsonb | إعدادات الأداة المستخدمة |
error |
varchar | رسالة الخطأ في حال الفشل |
createdAt |
timestamp | وقت الإنشاء |
completedAt |
timestamp | وقت الاكتمال |
settings
مخزن مفتاح-قيمة للإعدادات على مستوى الخادم التي يمكن للمسؤولين تغييرها من الواجهة.
| العمود | النوع | ملاحظات |
|---|---|---|
key |
varchar | المفتاح الأساسي |
value |
varchar | قيمة الإعداد |
updatedAt |
timestamp | وقت آخر تحديث |
roles
أدوار مخصّصة بصلاحيات دقيقة.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
name |
varchar | اسم دور فريد |
description |
varchar | وصف اختياري |
permissions |
jsonb | مصفوفة من سلاسل الصلاحيات |
createdAt |
timestamp | وقت الإنشاء |
audit_log
سجل الإجراءات ذات الصلة بالأمان.
| العمود | النوع | ملاحظات |
|---|---|---|
id |
uuid | المفتاح الأساسي |
userId |
uuid | مفتاح خارجي إلى users |
action |
varchar | نوع الإجراء |
details |
jsonb | بيانات خاصة بالإجراء |
createdAt |
timestamp | وقت الإجراء |
user_preferences
حالة الواجهة لكل مستخدم، مفهرسة باسم التفضيل. تخزن الأدوات المثبّتة في الصفحة الرئيسية، وتُكتب عبر PUT /api/v1/preferences.
| العمود | النوع | ملاحظات |
|---|---|---|
userId |
text | مفتاح خارجي إلى users، مع حذف متتالٍ. جزء من المفتاح الأساسي مع key |
key |
text | اسم التفضيل. جزء من المفتاح الأساسي مع userId |
value |
jsonb | محتوى التفضيل |
updatedAt |
timestamp | وقت آخر كتابة |
عمليات الترحيل
يتولى Drizzle ترحيلات المخطط. تقع ملفات الترحيل في apps/api/drizzle/. أثناء التطوير:
cd apps/api
npx drizzle-kit generate # generate a migration from schema changes
npx drizzle-kit migrate # apply pending migrations
في بيئة الإنتاج، تُطبَّق عمليات الترحيل المعلَّقة تلقائيًا عند بدء التشغيل.
النسخ الاحتياطي واستعادة
توجد قاعدة البيانات العلائقية في حجم SnapOtter-pgdata الخاص بحاوية Postgres، وليس في حجم /data الخاص بالتطبيق.
** النسخ الاحتياطي المنطقي مع التحقق من الصحة (مستحسن) **
# Dump into PostgreSQL's portable custom archive format
docker exec SnapOtter-postgres \
pg_dump --format=custom --no-owner -U snapotter snapotter > snapotter.dump
test -s snapotter.dump
docker exec -i SnapOtter-postgres pg_restore --list < snapotter.dump >/dev/null
# Restore into a fresh/disposable target first and fail on the first SQL error
docker exec -i SnapOtter-postgres \
pg_restore --exit-on-error --clean --if-exists --no-owner \
-U snapotter -d snapotter < snapotter.dump
لا يحتوي تفريغ قاعدة البيانات على كائنات المكتبة المحفوظة في /data/files أو حالة BullMQ الدائمة في Redis. قم بعمل نسخة احتياطية من تلك العناصر واستعادتها باستخدام الإجراء المنسق في الأمان والتقوية.
لقطة من الحجم البارد
# Stop every service first, then use your storage platform to snapshot the
# PostgreSQL, app-data, and Redis volumes as one crash-consistent set.
docker compose -f docker/docker-compose.yml stop
لا تقم بنسخ دليل بيانات PostgreSQL المباشر باستخدام tar. أنشئ أسماء وحدات التخزين البادئة حسب المشروع، لذا قم بحل معرفات وحدات التخزين المحملة من docker inspect أو منصة التخزين الخاصة بك بدلاً من افتراض التسمية الحرفية SnapOtter-pgdata.
الترحيل من 1.x (SQLite)
للترقية من SnapOtter 1.x دليل خاص بها: انظر الترقية من 1.x إلى 2.0. باختصار، أعد استخدام وحدة تخزين /data الموجودة لديك، وسيكتشف الإصدار 2.0 تلقائيًا /data/snapotter.db ويستوردها عند التشغيل الأول (أو اضبط SQLITE_MIGRATE_PATH للإشارة إليها بشكل صريح). انسخ وحدة تخزين /data بأكملها احتياطيًا أولًا، وليس snapotter.db فقط: يستخدم الإصدار 1.x وضع SQLite WAL، لذا كثيرًا ما تترك الحاوية المتوقفة معظم بياناتها في snapotter.db-wal بجوار snapotter.db شبه الفارغ.