0 ||
+ deleteKeys.length > 0 ||
+ this.renameFile
+ );
+ },
buildPatch() {
// Returns { patch, deleteKeys }. A merge write can only add or replace
// values — comicbox prunes empty patch values on schema load — so
@@ -2575,6 +2711,11 @@ export default {
const { patch, deleteKeys } = this.hasChanges
? this.buildPatch()
: { patch: {}, deleteKeys: [] };
+ if (!this.writesFiles(patch, deleteKeys)) {
+ // Only database-only series attributes changed: nothing to preflight.
+ await this.doSave();
+ return;
+ }
try {
const response = await HTTP.post("/admin/tag-write/preflight", {
collection: this.book.collection,
@@ -2615,27 +2756,40 @@ export default {
const { patch, deleteKeys } = this.hasChanges
? this.buildPatch()
: { patch: {}, deleteKeys: [] };
+ const seriesAttrs = this.hasChanges ? this.buildSeriesAttrs() : {};
+ const target = { collection: this.book.collection, pks: pks.map(String) };
try {
- const payload = {
- collection: this.book.collection,
- pks: pks.map(String),
- patch: JSON.stringify(patch),
- deleteKeys,
- mode: "update",
- formats,
- rename: this.renameFile,
- };
- if (this.confirmInfo.needConversion > 0) {
- payload.deleteOriginal = this.confirmDeleteOriginal;
+ const messages = [];
+ if (Object.keys(seriesAttrs).length > 0) {
+ await HTTP.post("/admin/series-attrs", { ...target, ...seriesAttrs });
+ messages.push("Series details saved.");
+ if (this.$route?.name === "browser") {
+ // The title shows the series years; no librarian event follows.
+ useBrowserStore().loadBrowserPage(getTimestamp());
+ }
}
- const response = await HTTP.post("/admin/tag-write", payload);
- const skipped = response.data?.skipped || 0;
- let message = "Tag write queued.";
- if (skipped > 0) {
- message += ` ${skipped} comic${skipped === 1 ? "" : "s"} in read-only libraries skipped.`;
+ if (this.writesFiles(patch, deleteKeys)) {
+ const payload = {
+ ...target,
+ patch: JSON.stringify(patch),
+ deleteKeys,
+ mode: "update",
+ formats,
+ rename: this.renameFile,
+ };
+ if (this.confirmInfo.needConversion > 0) {
+ payload.deleteOriginal = this.confirmDeleteOriginal;
+ }
+ const response = await HTTP.post("/admin/tag-write", payload);
+ const skipped = response.data?.skipped || 0;
+ let message = "Tag write queued.";
+ if (skipped > 0) {
+ message += ` ${skipped} comic${skipped === 1 ? "" : "s"} in read-only libraries skipped.`;
+ }
+ messages.push(message);
}
- useCommonStore().setSuccess(message);
+ useCommonStore().setSuccess(messages.join(" "));
this.$emit("saved");
} catch (error) {
useCommonStore().setErrors(error);
diff --git a/frontend/tests/unit/edit-panel-series-attrs.test.js b/frontend/tests/unit/edit-panel-series-attrs.test.js
new file mode 100644
index 000000000..810ab3b4b
--- /dev/null
+++ b/frontend/tests/unit/edit-panel-series-attrs.test.js
@@ -0,0 +1,175 @@
+/*
+ * Tests for the tag editor's database-only series attributes.
+ *
+ * No format codex writes can hold a series' end year, status or summary,
+ * so the editor saves them straight to the database:
+ * - They seed from the series, under any write format.
+ * - They lock, with a visible reason, unless exactly one series is being
+ * edited and its name is unchanged.
+ * - A visible hint warns they are not written to the comic files.
+ * - Only changed ones are sent, to /admin/series-attrs, and never ride
+ * the comicbox patch; a save with nothing else skips the tag write.
+ */
+import { createTestingPinia } from "@pinia/testing";
+import { flushPromises, mount } from "@vue/test-utils";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+vi.mock("@/api/v4/base", () => ({
+ HTTP: { get: vi.fn(), post: vi.fn(), delete: vi.fn() },
+}));
+
+import { HTTP } from "@/api/v4/base";
+import EditPanel from "@/components/metadata/edit-mode/edit-panel.vue";
+import vuetify from "@/plugins/vuetify";
+import { useBrowserStore } from "@/stores/browser";
+
+const ONE_SERIES = Object.freeze([{ name: "S", ids: [1] }]);
+const SERIES_MD = Object.freeze({
+ seriesList: ONE_SERIES,
+ seriesStartYear: 1963,
+ seriesEndYear: 1996,
+ seriesStatus: "Completed",
+ seriesSummary: "A run.",
+});
+const WARNING =
+ "End year, status and series summary are saved in Codex only, " +
+ "not written to the comic files.";
+
+async function mountPanel({
+ formats = ["COMIC_INFO"],
+ md = SERIES_MD,
+ routeName = "reader",
+} = {}) {
+ const pinia = createTestingPinia({
+ initialState: {
+ metadata: { md: { ...md } },
+ admin: { taggingDefaults: { defaultFormats: formats } },
+ browser: { settings: { twentyFourHourTime: false } },
+ },
+ });
+ const wrapper = mount(EditPanel, {
+ props: { book: { pk: 1, collection: "series", ids: [1] } },
+ global: {
+ plugins: [pinia, vuetify],
+ mocks: { $route: { name: routeName } },
+ },
+ });
+ await flushPromises();
+ return wrapper;
+}
+
+async function setField(wrapper, field, value) {
+ wrapper.vm.patch[field] = value;
+ wrapper.vm.onFieldInput(field);
+ await flushPromises();
+}
+
+const postedUrls = () => vi.mocked(HTTP.post).mock.calls.map(([url]) => url);
+
+beforeEach(() => {
+ vi.mocked(HTTP.post).mockReset();
+ vi.mocked(HTTP.post).mockResolvedValue({ data: {} });
+});
+
+describe("EditPanel — series attributes seed and render", () => {
+ test("they seed from the series and render their own inputs", async () => {
+ const wrapper = await mountPanel();
+ expect(wrapper.vm.patch.end_year).toBe(1996);
+ expect(wrapper.vm.patch.series_status).toBe("Completed");
+ expect(wrapper.vm.patch.series_summary).toBe("A run.");
+ const labels = wrapper.findAll("label").map((el) => el.text());
+ expect(labels).toEqual(
+ expect.arrayContaining(["End Year", "Status", "Series Summary"]),
+ );
+ });
+
+ test("no write format gates them", async () => {
+ const wrapper = await mountPanel({ formats: ["COMIC_INFO"] });
+ for (const field of ["end_year", "series_status", "series_summary"]) {
+ expect(wrapper.vm.isFieldDisabled(field)).toBe(false);
+ }
+ });
+
+ test("the hint warns they stay out of the comic files", async () => {
+ const wrapper = await mountPanel();
+ expect(wrapper.vm.seriesAttrsHint).toBe(WARNING);
+ expect(wrapper.text()).toContain(WARNING);
+ });
+});
+
+describe("EditPanel — series attributes lock", () => {
+ test("two series lock them and say why", async () => {
+ const wrapper = await mountPanel({
+ md: {
+ seriesList: [
+ { name: "S", ids: [1] },
+ { name: "T", ids: [2] },
+ ],
+ },
+ });
+ expect(wrapper.vm.isFieldDisabled("end_year")).toBe(true);
+ expect(wrapper.vm.seriesAttrsHint).toBe(
+ `Edit one series at a time. ${WARNING}`,
+ );
+ });
+
+ test("renaming the series locks them until it is saved", async () => {
+ const wrapper = await mountPanel();
+ await setField(wrapper, "series", "Renamed");
+ expect(wrapper.vm.isFieldDisabled("series_status")).toBe(true);
+ expect(wrapper.vm.seriesAttrsLockReason).toBe(
+ "Save the series change first.",
+ );
+ });
+});
+
+describe("EditPanel — series attributes save", () => {
+ test("only changed attributes are sent, never in the patch", async () => {
+ const wrapper = await mountPanel();
+ await setField(wrapper, "end_year", "1998");
+ expect(wrapper.vm.buildSeriesAttrs()).toEqual({ endYear: 1998 });
+ const { patch, deleteKeys } = wrapper.vm.buildPatch();
+ expect(patch).toEqual({});
+ expect(deleteKeys).toEqual([]);
+ });
+
+ test("clears send empty values", async () => {
+ const wrapper = await mountPanel();
+ for (const field of ["end_year", "series_status", "series_summary"]) {
+ wrapper.vm.toggleClear(field);
+ }
+ await flushPromises();
+ expect(wrapper.vm.buildSeriesAttrs()).toEqual({
+ endYear: null,
+ status: "",
+ summary: "",
+ });
+ });
+
+ test("a database-only save skips the preflight and the tag write", async () => {
+ const wrapper = await mountPanel();
+ await setField(wrapper, "series_status", "Ongoing");
+ await wrapper.vm.preSave();
+ expect(postedUrls()).toEqual(["/admin/series-attrs"]);
+ expect(HTTP.post).toHaveBeenCalledWith("/admin/series-attrs", {
+ collection: "series",
+ pks: ["1"],
+ status: "Ongoing",
+ });
+ });
+
+ test("a save with tag edits too posts both", async () => {
+ const wrapper = await mountPanel({ md: { ...SERIES_MD, summary: "x" } });
+ await setField(wrapper, "series_summary", "A longer run.");
+ await setField(wrapper, "summary", "y");
+ await wrapper.vm.doSave();
+ expect(postedUrls()).toEqual(["/admin/series-attrs", "/admin/tag-write"]);
+ });
+
+ test("the browser page reloads so the title years refresh", async () => {
+ const wrapper = await mountPanel({ routeName: "browser" });
+ await setField(wrapper, "end_year", "1998");
+ await wrapper.vm.doSave();
+ expect(useBrowserStore().loadBrowserPage).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/tests/importer/test_series_attrs.py b/tests/importer/test_series_attrs.py
index 260356f53..465c0a1e4 100644
--- a/tests/importer/test_series_attrs.py
+++ b/tests/importer/test_series_attrs.py
@@ -188,3 +188,16 @@ def test_later_batch_updates_stored_series(self) -> None:
assert series.end_year == _LATE
assert series.status == _COMPLETED
assert series.summary == _SUMMARY_B
+
+ def test_reimport_keeps_database_only_attrs(self) -> None:
+ """Values the tag editor saved to the database survive a re-import."""
+ self._import(_md({"start_year": _EARLY}))
+ Series.objects.filter(name="S").update(
+ end_year=_LATE, status=_COMPLETED, summary=_SUMMARY_C
+ )
+ self._import(_md({"start_year": _EARLY}))
+
+ series = Series.objects.get(name="S")
+ assert series.end_year == _LATE
+ assert series.status == _COMPLETED
+ assert series.summary == _SUMMARY_C
diff --git a/tests/test_admin_series_attrs.py b/tests/test_admin_series_attrs.py
new file mode 100644
index 000000000..09cf7cdf1
--- /dev/null
+++ b/tests/test_admin_series_attrs.py
@@ -0,0 +1,150 @@
+"""The tag editor saves a series' end year, status and summary to the database."""
+
+import shutil
+from typing import Final, override
+
+from django.contrib.auth.models import User
+from django.test import Client, TestCase
+
+from codex.models import Comic, Imprint, Library, Publisher, Series, Volume
+from codex.startup import init_admin_flags
+from tests.tmp_dirs import tmp_dir
+
+TMP_DIR = tmp_dir("codex.tests.admin_series_attrs")
+_URL: Final = "/api/v4/admin/series-attrs"
+_TEST_PASSWORD: Final = "test-pw-hush-S106" # noqa: S105
+_HTTP_OK: Final = 200
+_HTTP_BAD_REQUEST: Final = 400
+_HTTP_FORBIDDEN: Final = 403
+_START_YEAR: Final = 1963
+_END_YEAR: Final = 1996
+_NEW_END_YEAR: Final = 1998
+_SUMMARY: Final = "A friendly neighborhood series."
+
+
+class AdminSeriesAttrsTestCase(TestCase):
+ """POST /admin/series-attrs updates the one series the comics share."""
+
+ @override
+ def setUp(self) -> None:
+ """Seed two series with one comic each."""
+ init_admin_flags()
+ TMP_DIR.mkdir(exist_ok=True, parents=True)
+ self.library = Library.objects.create(path=str(TMP_DIR)) # pyright: ignore[reportUninitializedInstanceVariable]
+ self.publisher = Publisher.objects.create(name="Pub") # pyright: ignore[reportUninitializedInstanceVariable]
+ self.imprint = Imprint.objects.create(name="Imp", publisher=self.publisher) # pyright: ignore[reportUninitializedInstanceVariable]
+ self.series = self._series("Ser", start_year=_START_YEAR, end_year=_END_YEAR) # pyright: ignore[reportUninitializedInstanceVariable]
+ self.other = self._series("Other") # pyright: ignore[reportUninitializedInstanceVariable]
+ self.comic = self._comic(self.series, "c1.cbz") # pyright: ignore[reportUninitializedInstanceVariable]
+ self.other_comic = self._comic(self.other, "c2.cbz") # pyright: ignore[reportUninitializedInstanceVariable]
+ admin = User.objects.create_user(
+ username="series_admin", password=_TEST_PASSWORD, is_staff=True
+ )
+ self.client = Client()
+ self.client.force_login(admin)
+
+ @override
+ def tearDown(self) -> None:
+ """Remove the temp comic tree."""
+ shutil.rmtree(TMP_DIR, ignore_errors=True)
+
+ def _series(self, name: str, **attrs) -> Series:
+ return Series.objects.create(
+ name=name, imprint=self.imprint, publisher=self.publisher, **attrs
+ )
+
+ def _comic(self, series: Series, filename: str) -> Comic:
+ volume = Volume.objects.create(
+ name="1963", series=series, imprint=self.imprint, publisher=self.publisher
+ )
+ path = TMP_DIR / filename
+ path.touch()
+ return Comic.objects.create(
+ library=self.library,
+ path=path,
+ issue_number=1,
+ name=filename,
+ publisher=self.publisher,
+ imprint=self.imprint,
+ series=series,
+ volume=volume,
+ size=42,
+ )
+
+ def _post(self, collection: str, pks, **attrs):
+ data = {"collection": collection, "pks": [str(pk) for pk in pks], **attrs}
+ return self.client.post(_URL, data, content_type="application/json")
+
+ def test_sets_attrs_on_a_comics_series(self) -> None:
+ before = Series.objects.get(pk=self.series.pk).updated_at
+ response = self._post(
+ "comics",
+ [self.comic.pk],
+ endYear=_NEW_END_YEAR,
+ status="Completed",
+ summary=_SUMMARY,
+ )
+ assert response.status_code == _HTTP_OK, response.content
+ series = Series.objects.get(pk=self.series.pk)
+ assert series.end_year == _NEW_END_YEAR
+ assert series.status == "Completed"
+ assert series.summary == _SUMMARY
+ assert series.start_year == _START_YEAR
+ assert series.updated_at > before
+ assert Series.objects.get(pk=self.other.pk).status == ""
+
+ def test_series_collection_targets_its_own_row(self) -> None:
+ response = self._post("series", [self.series.pk], status="Hiatus")
+ assert response.status_code == _HTTP_OK, response.content
+ assert Series.objects.get(pk=self.series.pk).status == "Hiatus"
+
+ def test_only_sent_attrs_change(self) -> None:
+ Series.objects.filter(pk=self.series.pk).update(
+ status="Ongoing", summary=_SUMMARY
+ )
+ response = self._post("comics", [self.comic.pk], status="Completed")
+ assert response.status_code == _HTTP_OK, response.content
+ series = Series.objects.get(pk=self.series.pk)
+ assert series.status == "Completed"
+ assert series.summary == _SUMMARY
+ assert series.end_year == _END_YEAR
+
+ def test_empty_values_clear(self) -> None:
+ Series.objects.filter(pk=self.series.pk).update(
+ status="Ongoing", summary=_SUMMARY
+ )
+ response = self._post(
+ "comics", [self.comic.pk], endYear=None, status="", summary=""
+ )
+ assert response.status_code == _HTTP_OK, response.content
+ series = Series.objects.get(pk=self.series.pk)
+ assert series.end_year is None
+ assert series.status == ""
+ assert series.summary == ""
+
+ def test_two_series_are_refused(self) -> None:
+ response = self._post(
+ "comics", [self.comic.pk, self.other_comic.pk], status="Completed"
+ )
+ assert response.status_code == _HTTP_BAD_REQUEST
+ assert Series.objects.get(pk=self.series.pk).status == ""
+
+ def test_nothing_to_save_is_refused(self) -> None:
+ response = self._post("comics", [self.comic.pk])
+ assert response.status_code == _HTTP_BAD_REQUEST
+
+ def test_unknown_status_is_refused(self) -> None:
+ response = self._post("comics", [self.comic.pk], status="Finished")
+ assert response.status_code == _HTTP_BAD_REQUEST
+ assert Series.objects.get(pk=self.series.pk).status == ""
+
+ def test_out_of_range_year_is_refused(self) -> None:
+ response = self._post("comics", [self.comic.pk], endYear=99)
+ assert response.status_code == _HTTP_BAD_REQUEST
+
+ def test_non_admin_is_forbidden(self) -> None:
+ user = User.objects.create_user(username="reader", password=_TEST_PASSWORD)
+ self.client.force_login(user)
+ response = self._post("comics", [self.comic.pk], status="Completed")
+ assert response.status_code == _HTTP_FORBIDDEN
+ assert Series.objects.get(pk=self.series.pk).status == ""
diff --git a/tests/test_tag_write_date.py b/tests/test_tag_write_date.py
index adb323d24..17351f1a1 100644
--- a/tests/test_tag_write_date.py
+++ b/tests/test_tag_write_date.py
@@ -26,10 +26,11 @@
from django.test import TestCase
from loguru import logger
-from codex.choices.tagging import FORMAT_FIELD_SUPPORT
+from codex.choices.tagging import FORMAT_FIELD_SUPPORT, SERIES_STATUSES
from codex.librarian.scribe.tag_writer import TagWriter
from codex.librarian.scribe.tasks import BulkTagWriteTask
from codex.models import Comic, Imprint, Library, Publisher, Series, Volume
+from codex.models.choices import SeriesStatusChoices
from tests.tmp_dirs import tmp_dir
_TMP_DIR: Final = tmp_dir("codex.tests.tagwritedate")
@@ -118,6 +119,15 @@ def test_format_exclusive_fields(self) -> None:
# its own.
assert "reading_direction" in comic_info
+ def test_database_only_series_fields_are_no_format_field(self) -> None:
+ # No format holds them; the editor saves them to the database.
+ for fields in FORMAT_FIELD_SUPPORT.values():
+ assert not {"end_year", "series_status", "series_summary"} & set(fields)
+
+ def test_series_statuses_follow_the_model_choices(self) -> None:
+ values = [choice["value"] for choice in SERIES_STATUSES]
+ assert values == list(SeriesStatusChoices.values)
+
class TagWriteDateTestCase(TestCase):
"""Composite tag-editor keys write through to the archive."""