The_evening_detective/evening_detective_server
1
0
Fork 0
generated from VLADIMIR/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clear

Browse Source
This commit is contained in:
Владимир Фёдоров
2026-08-21 00:09:32 +07:00
parent 7656100fe6
commit a2cadf6eca
20 changed files with 320 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/modules/scenario_archive/archive.go
+9 -24
View File
@@ -20,12 +20,6 @@ import (
"evening_detective_server/internal/repos"
)
// Имя файла с описанием сценария внутри архива.
const FileName = "scenario.json"
// Текущая версия формата scenario.json.
const Version = 1
// Лимиты на входящие архивы (защита от zip-bomb). Суммарный объём считается
// по фактически распакованным байтам — размеры в заголовках ZIP подделываются.
var (
@@ -36,28 +30,19 @@ var (
maxPackSize = 256 << 20 // 256 МБ — суммарный объём изображений при сборке
)
type scenarioArchive struct{}
// NewScenarioArchive создаёт реализацию IScenarioArchive.
func NewScenarioArchive() IScenarioArchive {
return &scenarioArchive{}
}
// MaxArchiveSize — максимальный размер входящего архива (для проверок
// в хендлере и на HTTP-слое).
func MaxArchiveSize() int {
return maxArchiveSize
}
// ScenarioJSON — описание сценария в архиве; Story — в формате колонки
// scenarios.scenario в БД.
type ScenarioJSON struct {
Version int `json:"version"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Image string `json:"image,omitempty"`
Story *storytelling.Story `json:"story"`
}
// Bundle — результат разбора входящего архива.
type Bundle struct {
Scenario *ScenarioJSON
Files map[string][]byte
}
// ImagePath возвращает путь изображения внутри архива (images/<имя>) и true
// для ссылок нашего хранилища: относительное имя или URL с доменом (legacy).
// Внешние URL и пустые ссылки — ("", false): в архив не кладутся.
@@ -76,7 +61,7 @@ func ImagePath(ref, domain string) (string, bool) {
// Pack собирает ZIP-архив сценария: ссылки на изображения хранилища
// переписываются в images/<имя>, файлы запрашиваются через getFile; внешние
// URL остаются без изменений. Архив детерминирован (порядок записей и метки).
func Pack(
func (a *scenarioArchive) Pack(
ctx context.Context,
scenario *repos.Scenario,
domain string,
@@ -223,7 +208,7 @@ func strPtrValue(p *string) string {
}
// Unpack разбирает входящий архив с проверкой лимитов и путей записей.
func Unpack(data []byte) (*Bundle, error) {
func (a *scenarioArchive) Unpack(data []byte) (*Bundle, error) {
if len(data) == 0 {
return nil, errors.New("архив пуст")
}
internal/modules/scenario_archive/archive_test.go
+31 -28
View File
@@ -16,6 +16,9 @@ import (
const testDomain = "http://storage.test/api/files/"
// testArchive — экземпляр модуля для тестов.
var testArchive = NewScenarioArchive()
// buildScenario собирает сценарий с историей и ссылками на изображения.
func buildScenario() *repos.Scenario {
description := "Детективная история"
@@ -53,12 +56,12 @@ func newMemoryFiles() memoryFiles {
func TestPackUnpackRoundTrip(t *testing.T) {
files := newMemoryFiles()
data, err := Pack(context.Background(), buildScenario(), testDomain, files.get)
data, err := testArchive.Pack(context.Background(), buildScenario(), testDomain, files.get)
if err != nil {
t.Fatalf("Pack: %v", err)
}
bundle, err := Unpack(data)
bundle, err := testArchive.Unpack(data)
if err != nil {
t.Fatalf("Unpack: %v", err)
}
@@ -117,7 +120,7 @@ func TestPackExternalURLsKeptAndNotFetched(t *testing.T) {
return files.get(ctx, name)
}
data, err := Pack(context.Background(), scenario, testDomain, getFile)
data, err := testArchive.Pack(context.Background(), scenario, testDomain, getFile)
if err != nil {
t.Fatalf("Pack: %v", err)
}
@@ -125,7 +128,7 @@ func TestPackExternalURLsKeptAndNotFetched(t *testing.T) {
t.Errorf("getFile вызван для внешних URL: %v", fetched)
}
bundle, err := Unpack(data)
bundle, err := testArchive.Unpack(data)
if err != nil {
t.Fatalf("Unpack: %v", err)
}
@@ -147,11 +150,11 @@ func TestPackLegacyFullURLImage(t *testing.T) {
Image: ptr(testDomain + "cover.png"),
Scenario: `{"places":[]}`,
}
data, err := Pack(context.Background(), scenario, testDomain, newMemoryFiles().get)
data, err := testArchive.Pack(context.Background(), scenario, testDomain, newMemoryFiles().get)
if err != nil {
t.Fatalf("Pack: %v", err)
}
bundle, err := Unpack(data)
bundle, err := testArchive.Unpack(data)
if err != nil {
t.Fatalf("Unpack: %v", err)
}
@@ -164,7 +167,7 @@ func TestPackMissingImage(t *testing.T) {
files := newMemoryFiles()
delete(files, "ticket.jpg")
_, err := Pack(context.Background(), buildScenario(), testDomain, files.get)
_, err := testArchive.Pack(context.Background(), buildScenario(), testDomain, files.get)
if err == nil {
t.Fatal("Pack должен вернуть ошибку при недоступном изображении")
}
@@ -175,12 +178,12 @@ func TestPackMissingImage(t *testing.T) {
func TestPackDeterministic(t *testing.T) {
files := newMemoryFiles()
first, err := Pack(context.Background(), buildScenario(), testDomain, files.get)
first, err := testArchive.Pack(context.Background(), buildScenario(), testDomain, files.get)
if err != nil {
t.Fatalf("Pack: %v", err)
}
time.Sleep(10 * time.Millisecond)
second, err := Pack(context.Background(), buildScenario(), testDomain, files.get)
second, err := testArchive.Pack(context.Background(), buildScenario(), testDomain, files.get)
if err != nil {
t.Fatalf("Pack: %v", err)
}
@@ -190,7 +193,7 @@ func TestPackDeterministic(t *testing.T) {
}
func TestPackNilScenario(t *testing.T) {
_, err := Pack(context.Background(), nil, testDomain, nil)
_, err := testArchive.Pack(context.Background(), nil, testDomain, nil)
if err == nil {
t.Fatal("Pack(nil) должен вернуть ошибку")
}
@@ -207,7 +210,7 @@ func TestPackImageNameCollision(t *testing.T) {
{"code":"b","name":"B","text":"t","image":"dir/a.png"}
]}`,
}
_, err := Pack(context.Background(), scenario, testDomain, newMemoryFiles().get)
_, err := testArchive.Pack(context.Background(), scenario, testDomain, newMemoryFiles().get)
if err == nil {
t.Fatal("Pack должен вернуть ошибку при конфликте имён изображений")
}
@@ -257,7 +260,7 @@ func TestUnpackRejectsBadPaths(t *testing.T) {
"images/x.png": []byte("x"),
name: []byte("evil"),
})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatalf("Unpack должен отклонить путь %q", name)
}
})
@@ -265,30 +268,30 @@ func TestUnpackRejectsBadPaths(t *testing.T) {
}
func TestUnpackEmpty(t *testing.T) {
if _, err := Unpack(nil); err == nil {
if _, err := testArchive.Unpack(nil); err == nil {
t.Fatal("Unpack(nil) должен вернуть ошибку")
}
if _, err := Unpack([]byte{}); err == nil {
t.Fatal("Unpack(пусто) должен вернуть ошибку")
if _, err := testArchive.Unpack([]byte{}); err == nil {
t.Fatal("testArchive.Unpack(пусто) должен вернуть ошибку")
}
}
func TestUnpackNotAZip(t *testing.T) {
if _, err := Unpack([]byte("this is not a zip")); err == nil {
if _, err := testArchive.Unpack([]byte("this is not a zip")); err == nil {
t.Fatal("Unpack должен отклонить не-zip данные")
}
}
func TestUnpackMissingScenarioJSON(t *testing.T) {
data := writeZip(t, map[string][]byte{"images/x.png": []byte("x")})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен требовать scenario.json")
}
}
func TestUnpackInvalidScenarioJSON(t *testing.T) {
data := writeZip(t, map[string][]byte{FileName: []byte("{not json")})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить битый scenario.json")
}
}
@@ -296,7 +299,7 @@ func TestUnpackInvalidScenarioJSON(t *testing.T) {
func TestUnpackBadVersion(t *testing.T) {
b, _ := json.Marshal(ScenarioJSON{Version: 99, Name: "X", Story: &storytelling.Story{}})
data := writeZip(t, map[string][]byte{FileName: b})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить неизвестную версию")
}
}
@@ -304,7 +307,7 @@ func TestUnpackBadVersion(t *testing.T) {
func TestUnpackEmptyName(t *testing.T) {
b, _ := json.Marshal(ScenarioJSON{Version: Version, Name: "", Story: &storytelling.Story{}})
data := writeZip(t, map[string][]byte{FileName: b})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен требовать название")
}
}
@@ -312,7 +315,7 @@ func TestUnpackEmptyName(t *testing.T) {
func TestUnpackNilStory(t *testing.T) {
b, _ := json.Marshal(ScenarioJSON{Version: Version, Name: "X"})
data := writeZip(t, map[string][]byte{FileName: b})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен требовать story")
}
}
@@ -326,7 +329,7 @@ func TestUnpackEntrySizeLimit(t *testing.T) {
FileName: validScenarioJSON(),
"images/big.png": bytes.Repeat([]byte("x"), 8),
})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить запись больше maxEntrySize")
}
}
@@ -341,7 +344,7 @@ func TestUnpackTotalSizeLimit(t *testing.T) {
"images/a.png": []byte("aaa"),
"images/b.png": []byte("bbb"),
})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить суммарный объём больше maxUnpackedSize")
}
}
@@ -352,7 +355,7 @@ func TestUnpackArchiveSizeLimit(t *testing.T) {
defer func() { maxArchiveSize = prev }()
data := writeZip(t, map[string][]byte{FileName: validScenarioJSON()})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить архив больше maxArchiveSize")
}
}
@@ -367,7 +370,7 @@ func TestUnpackEntriesLimit(t *testing.T) {
"images/a.png": []byte("a"),
"images/b.png": []byte("b"),
})
if _, err := Unpack(data); err == nil {
if _, err := testArchive.Unpack(data); err == nil {
t.Fatal("Unpack должен отклонить архив с числом записей больше maxEntries")
}
}
@@ -388,7 +391,7 @@ func TestUnpackRejectsDuplicateScenarioJSON(t *testing.T) {
t.Fatalf("Close: %v", err)
}
if _, err := Unpack(buf.Bytes()); err == nil {
if _, err := testArchive.Unpack(buf.Bytes()); err == nil {
t.Fatal("Unpack должен отклонить дубли scenario.json")
}
}
@@ -420,7 +423,7 @@ func TestUnpackRejectsDuplicateFiles(t *testing.T) {
t.Fatalf("Close: %v", err)
}
if _, err := Unpack(buf.Bytes()); err == nil {
if _, err := testArchive.Unpack(buf.Bytes()); err == nil {
t.Fatal("Unpack должен отклонить дубли файлов")
}
}
@@ -444,7 +447,7 @@ func TestPackTotalSizeLimit(t *testing.T) {
"a.png": bytes.Repeat([]byte("x"), 6),
"b.png": bytes.Repeat([]byte("y"), 6),
}
if _, err := Pack(context.Background(), scenario, testDomain, files.get); err == nil {
if _, err := testArchive.Pack(context.Background(), scenario, testDomain, files.get); err == nil {
t.Fatal("Pack должен отклонить суммарный объём больше maxPackSize")
}
}
internal/modules/scenario_archive/interface.go
+47
View File
@@ -0,0 +1,47 @@
package scenario_archive
import (
"context"
"evening_detective_server/internal/modules/storytelling"
"evening_detective_server/internal/repos"
)
// Имя файла с описанием сценария внутри архива.
const FileName = "scenario.json"
// Текущая версия формата scenario.json.
const Version = 1
// ScenarioJSON — описание сценария в архиве; Story — в формате колонки
// scenarios.scenario в БД.
type ScenarioJSON struct {
Version int `json:"version"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Image string `json:"image,omitempty"`
Story *storytelling.Story `json:"story"`
}
// Bundle — результат разбора входящего архива.
type Bundle struct {
Scenario *ScenarioJSON
Files map[string][]byte
}
// IScenarioArchive — контракт модуля scenario_archive: сборка и разбор
// ZIP-архива сценария.
type IScenarioArchive interface {
// Pack собирает ZIP-архив сценария: ссылки на изображения хранилища
// переписываются в images/<имя>, файлы запрашиваются через getFile;
// внешние URL остаются без изменений.
Pack(
ctx context.Context,
scenario *repos.Scenario,
domain string,
getFile func(ctx context.Context, name string) ([]byte, error),
) ([]byte, error)
// Unpack разбирает входящий архив с проверкой лимитов и путей записей.
Unpack(data []byte) (*Bundle, error)
}