feat(metadata): add CivitAI AutoV3 hash support across all storage layers

- Three-state autov3 field (not-checked / checked-unavailable / 12-hex value)
  in .metadata.json sidecars, in-memory ModelHashIndex, and SQLite
  (models.autov3 column + autov3_index table) with column-presence migration
- Background self-terminating backfill for legacy rows: per-model-type
  concurrency guard, executor-offloaded I/O, Civitai-first resolution
  (SHA256-matched version file) falling back to the embedded safetensors
  header hash
- Civitai-first propagation on metadata refresh, scan, and download paths;
  reject the empty-string SHA256 placeholder and strip OneTrainer 0x prefix
- List API hash filters and hash index lookups accept 12-char AutoV3
- Cap safetensors header reads at 64 MiB to prevent crafted-file allocation
- Prevent stale AutoV3 mappings on file replacement while preserving them on
  same-file re-registration (lazy-hash completion)
This commit is contained in:
Will Miao
2026-08-08 14:30:34 +08:00
parent 4bf9a4b640
commit 97b9b1f62b
23 changed files with 1918 additions and 50 deletions

View File

@@ -1,15 +1,26 @@
import hashlib
import json
import os
import struct
import pytest
from py.utils.constants import MAX_SAFETENSORS_HEADER_BYTES
from py.utils.file_utils import (
calculate_autov3,
calculate_sha256,
find_preview_file,
get_preview_extension,
)
def _write_safetensors(path, metadata, payload=b"payload-bytes"):
"""Write a minimal real safetensors file: 8-byte little-endian header
length, a JSON header containing ``__metadata__``, then arbitrary payload."""
header = json.dumps({"__metadata__": metadata}).encode("utf-8")
path.write_bytes(struct.pack("<Q", len(header)) + header + payload)
@pytest.mark.asyncio
async def test_calculate_sha256(tmp_path):
file_path = tmp_path / "sample.bin"
@@ -49,3 +60,126 @@ def test_find_preview_file_supports_example_extension(tmp_path):
)
def test_get_preview_extension(preview_name, expected):
assert get_preview_extension(preview_name) == expected
class TestCalculateAutov3:
def test_returns_first_12_chars_from_sshs_model_hash(self, tmp_path):
file_path = tmp_path / "lora.safetensors"
_write_safetensors(file_path, {"sshs_model_hash": "abcdef1234567890abcdef"})
assert calculate_autov3(str(file_path)) == "abcdef123456"
def test_lowercases_uppercase_embedded_hash(self, tmp_path):
file_path = tmp_path / "upper.safetensors"
_write_safetensors(file_path, {"sshs_model_hash": "ABCDEF1234567890ABCDEF"})
assert calculate_autov3(str(file_path)) == "abcdef123456"
def test_returns_first_12_chars_from_modelspec_hash_sha256(self, tmp_path):
file_path = tmp_path / "model.safetensors"
_write_safetensors(file_path, {"modelspec.hash_sha256": "00112233445566778899aabb"})
assert calculate_autov3(str(file_path)) == "001122334455"
def test_prefers_sshs_model_hash_over_modelspec_hash(self, tmp_path):
file_path = tmp_path / "model.safetensors"
_write_safetensors(
file_path,
{
"sshs_model_hash": "aaaaaaaaaaaaaaaaaaaaaaaa",
"modelspec.hash_sha256": "bbbbbbbbbbbbbbbbbbbbbbbb",
},
)
assert calculate_autov3(str(file_path)) == "aaaaaaaaaaaa"
def test_returns_none_for_non_safetensors_file(self, tmp_path):
file_path = tmp_path / "plain.bin"
file_path.write_bytes(b"just some plain bytes, not a safetensors file")
assert calculate_autov3(str(file_path)) is None
def test_returns_none_for_empty_file(self, tmp_path):
file_path = tmp_path / "empty.safetensors"
file_path.write_bytes(b"")
assert calculate_autov3(str(file_path)) is None
def test_returns_none_for_header_length_shorter_than_8_bytes(self, tmp_path):
file_path = tmp_path / "short.safetensors"
file_path.write_bytes(b"\x10\x00")
assert calculate_autov3(str(file_path)) is None
def test_returns_none_for_truncated_json_header(self, tmp_path):
file_path = tmp_path / "truncated.safetensors"
file_path.write_bytes(struct.pack("<Q", 100) + b'{"__metadata__":')
assert calculate_autov3(str(file_path)) is None
def test_returns_none_when_metadata_lacks_recognized_hash(self, tmp_path):
file_path = tmp_path / "model.safetensors"
_write_safetensors(file_path, {"ss_model_name": "something-else"})
assert calculate_autov3(str(file_path)) is None
def test_returns_none_when_embedded_hash_is_too_short(self, tmp_path):
file_path = tmp_path / "model.safetensors"
_write_safetensors(file_path, {"sshs_model_hash": "abc123"})
assert calculate_autov3(str(file_path)) is None
def test_returns_none_when_embedded_hash_is_not_a_string(self, tmp_path):
file_path = tmp_path / "model.safetensors"
_write_safetensors(file_path, {"sshs_model_hash": 123456})
assert calculate_autov3(str(file_path)) is None
def test_strips_0x_prefix_from_modelspec_hash(self, tmp_path):
# OneTrainer writes modelspec.hash_sha256 with a "0x" prefix.
file_path = tmp_path / "onetrainer.safetensors"
_write_safetensors(
file_path, {"modelspec.hash_sha256": "0x1585b50b9d7d66778899aabb"}
)
assert calculate_autov3(str(file_path)) == "1585b50b9d7d"
def test_returns_none_for_empty_string_sha256_placeholder(self, tmp_path):
# Repackaging tools sometimes write the SHA256-of-empty placeholder
# instead of a real hash; it must not be treated as a valid AutoV3.
file_path = tmp_path / "broken.safetensors"
_write_safetensors(
file_path,
{"sshs_model_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},
)
assert calculate_autov3(str(file_path)) is None
def test_strips_0x_prefix_from_empty_hash_placeholder(self, tmp_path):
file_path = tmp_path / "onetrainer_broken.safetensors"
_write_safetensors(
file_path,
{"modelspec.hash_sha256": "0xe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},
)
assert calculate_autov3(str(file_path)) is None
def test_returns_none_for_header_length_over_limit(self, tmp_path):
# A crafted file whose 64-bit header length exceeds the cap must not
# trigger a giant allocation; it is rejected before any read.
file_path = tmp_path / "huge_header.safetensors"
file_path.write_bytes(
struct.pack("<Q", MAX_SAFETENSORS_HEADER_BYTES + 1) + b'{"__metadata__": {}}'
)
assert calculate_autov3(str(file_path)) is None
def test_reads_header_at_exact_limit_boundary(self, tmp_path):
# A header length exactly at the cap is still valid.
file_path = tmp_path / "at_limit.safetensors"
file_path.write_bytes(
struct.pack("<Q", MAX_SAFETENSORS_HEADER_BYTES) + b'{"__metadata__": {"sshs_model_hash": "abcdef1234567890abcdef"}}'
)
# The read returns {} because the actual bytes are shorter than the
# claimed length (short-read guard), without allocating anything huge.
assert calculate_autov3(str(file_path)) is None