mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtterandGitHub d10d0f544f fix: release QA hardening across processing, media, security, and CI gates (#649 )

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.

2026-07-27 15:37:30 +08:00

14 KiB

Raw Blame History

description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version

description	i18n_source_hash	i18n_provenance	i18n_output_hash	i18n_hash_version
SnapOtter के लिए PostgreSQL डेटाबेस स्कीमा, टेबल, माइग्रेशन और बैकअप प्रक्रियाएँ।	a68264552836	machine	de28f97f3fab	2

डेटाबेस

SnapOtter डेटा स्थायित्व के लिए Drizzle ORM (pg-core / node-postgres) के साथ PostgreSQL 17 का उपयोग करता है। स्कीमा 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 कुंजियाँ। कच्ची कुंजी निर्माण पर एक बार दिखाई जाती है; केवल हैश संग्रहीत किया जाता है।

कॉलम	प्रकार	नोट्स
`id`	uuid	प्राथमिक कुंजी
`userId`	uuid	`users.id` के लिए फ़ॉरेन कुंजी
`keyHash`	varchar	कुंजी का scrypt हैश
`name`	varchar	उपयोगकर्ता द्वारा दिया गया लेबल
`createdAt`	timestamp	बनाने का समय
`lastUsedAt`	timestamp	प्रत्येक प्रमाणित अनुरोध पर अपडेट किया जाता है

कुंजियाँ si_ से उपसर्गित होती हैं जिसके बाद 96 हेक्स वर्ण होते हैं (48 रैंडम बाइट्स)।

pipelines

सहेजे गए टूल चेन जिन्हें उपयोगकर्ता UI में बनाते हैं।

कॉलम	प्रकार	नोट्स
`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 के लिए FK (CASCADE DELETE)
`originalName`	varchar	मूल अपलोड फ़ाइलनाम
`storedName`	varchar	डिस्क पर फ़ाइलनाम
`mimeType`	varchar	MIME प्रकार
`size`	integer	बाइट्स में फ़ाइल का आकार
`width`	integer	px में छवि की चौड़ाई
`height`	integer	px में छवि की ऊँचाई
`version`	integer	संस्करण संख्या (1 = मूल)
`parentId`	uuid या null	user_files के लिए FK (पैरेंट संस्करण)
`toolChain`	jsonb	इस संस्करण को बनाने के लिए क्रम में लागू किए गए टूल ID
`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

सर्वर-व्यापी सेटिंग्स के लिए की-वैल्यू स्टोर जिन्हें एडमिन UI से बदल सकते हैं।

कॉलम	प्रकार	नोट्स
`key`	varchar	प्राथमिक कुंजी
`value`	varchar	सेटिंग मान
`updatedAt`	timestamp	अंतिम अपडेट समय

roles

सूक्ष्म अनुमतियों वाली कस्टम भूमिकाएँ।

कॉलम	प्रकार	नोट्स
`id`	uuid	प्राथमिक कुंजी
`name`	varchar	अद्वितीय भूमिका नाम
`description`	varchar	वैकल्पिक विवरण
`permissions`	jsonb	अनुमति स्ट्रिंग्स का ऐरे
`createdAt`	timestamp	बनाने का समय

audit_log

सुरक्षा-प्रासंगिक क्रिया लॉग।

कॉलम	प्रकार	नोट्स
`id`	uuid	प्राथमिक कुंजी
`userId`	uuid	users के लिए FK
`action`	varchar	क्रिया प्रकार
`details`	jsonb	क्रिया-विशिष्ट डेटा
`createdAt`	timestamp	क्रिया का समय

user_preferences

प्रति-उपयोगकर्ता UI स्थिति, प्राथमिकता के नाम से कुंजीबद्ध। होम पेज पर पिन किए गए टूल यहीं रखे जाते हैं, जिन्हें PUT /api/v1/preferences के ज़रिए लिखा जाता है।

कॉलम	प्रकार	नोट्स
`userId`	text	users के लिए FK, हटाने पर कैस्केड। `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

प्रोडक्शन में, लंबित माइग्रेशन स्टार्टअप पर स्वचालित रूप से लागू किए जाते हैं।

बैकअप लें और {#backup-and-restore} को पुनर्स्थापित करें

रिलेशनल डेटाबेस पोस्टग्रेज कंटेनर के SnapOtter-pgdata वॉल्यूम में रहता है, ऐप के /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 या Redis में टिकाऊ BullMQ स्थिति में सहेजे गए लाइब्रेरी ऑब्जेक्ट शामिल नहीं हैं। सुरक्षा और हार्डनिंग में समन्वित प्रक्रिया के साथ उनका बैकअप लें और पुनर्स्थापित करें।

कोल्ड वॉल्यूम स्नैपशॉट

# 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

tar के साथ लाइव PostgreSQL डेटा निर्देशिका की प्रतिलिपि न बनाएं। प्रोजेक्ट के अनुसार उपसर्ग वॉल्यूम नाम लिखें, इसलिए शाब्दिक लेबल SnapOtter-pgdata मानने के बजाय docker inspect या अपने स्टोरेज प्लेटफ़ॉर्म से माउंटेड वॉल्यूम आईडी को हल करें।

1.x (SQLite) से माइग्रेट करना

SnapOtter 1.x से अपग्रेड करने की अपनी अलग गाइड है: Upgrading from 1.x to 2.0 देखें। संक्षेप में, अपने मौजूदा /data वॉल्यूम का पुनः उपयोग करें और 2.0 पहले बूट पर /data/snapotter.db का स्वतः पता लगाकर उसे इम्पोर्ट करता है (या इसे स्पष्ट रूप से इंगित करने के लिए SQLITE_MIGRATE_PATH सेट करें)। पहले पूरे /data वॉल्यूम का बैकअप लें, केवल snapotter.db का नहीं: 1.x SQLite WAL मोड का उपयोग करता है, इसलिए एक रुका हुआ कंटेनर अक्सर अपना अधिकांश डेटा एक लगभग-खाली snapotter.db के बगल में snapotter.db-wal में छोड़ देता है।

14 KiB Raw Blame History