Add CWA_ENABLED to run Bindery without CWA

With CWA_ENABLED=false, Bindery ignores the CWA settings, makes no request
to CWA, and shows nothing about CWA in the log and the web interface. A
set INGEST_DIR still gets each changed book as a plain epub.

Without it, the log names each CWA function that a missing setting turns
off.

tests/js/flows.test.mjs

@@ -14,7 +14,7 @@ const { setUnauthorizedHandler } = await import('../../bindery/static/js/lib.js'
 let api, main, details, cleanups;
 const config = {
   metadata_fields: { title: 'Title', authors: 'Authors', comments: 'Description', series: 'Series', pubdate: 'Published', tags: 'Tags', languages: 'Language' },
-  mode_labels: { new: 'New chapters' }, library_available: true, update_interval: 2,
+  mode_labels: { new: 'New chapters' }, library_available: true, cwa_enabled: true, update_interval: 2,
   job_list_max_hours: 720, job_list_max_count: 500,
 };
 const rule = { pattern: 'before', replacement: 'after', flags: 'i', note: '', enabled: true };
@@ -641,3 +641,25 @@ test('chapter titles show the entities that FanFicFare keeps as text', async ()
   render([{ id: 'j', status: 'done', story_id: 1, result: { changed: [{ chapter_id: 2, title: 'A & B' }] } }]);
   assert.ok(find(el, 'a', 'A & B'));
 });
+
+test('with CWA off, the pages show nothing about CWA', async () => {
+  await mountStory();
+  assert.ok(section(main, 'Library link'));
+  const off = { ...config, cwa_enabled: false, library_available: false };
+  // Values that show a notice with CWA on.
+  Object.assign(details, { uploads_paused: true, ingest_available: false, link_books: false });
+  details.story.upload_held = true;
+  await mountStory(off);
+  assert.ok(section(main, 'Metadata'));
+  assert.equal(section(main, 'Library link'), undefined);
+  assert.doesNotMatch(main.textContent, /CWA|INGEST_DIR|library/i);
+  await mountStories(off);
+  assert.ok(section(main, 'Add stories'));
+  assert.equal(section(main, 'Import from the library'), undefined);
+  assert.doesNotMatch(main.textContent, /CWA|INGEST_DIR|library/i);
+  settingsPage(main, {}, off);
+  await settle();
+  assert.ok(section(main, 'Jobs list'));
+  assert.equal(section(main, 'Uploads to CWA'), undefined);
+  assert.doesNotMatch(main.textContent, /CWA|INGEST_DIR|library/i);
+});

tests/js/frontend.test.mjs

@@ -46,7 +46,7 @@ const text = (node) => node instanceof Element ? node.children.map(text).join(''
 const find = (root, tag, label) => elements(root).find((el) => el.tagName === tag && text(el) === label);
 const settle = () => new Promise((resolve) => setImmediate(resolve));
 const config = {
-  metadata_fields: { title: 'Title' }, mode_labels: {}, library_available: true, update_interval: 0,
+  metadata_fields: { title: 'Title' }, mode_labels: {}, library_available: true, cwa_enabled: true, update_interval: 0,
   job_list_max_hours: 720, job_list_max_count: 500,
 };
 const story = {

tests/js/upload-hold.test.mjs

@@ -7,7 +7,7 @@ const { settingsPage } = await import('../../bindery/static/js/settings.js');
 const { storyPage } = await import('../../bindery/static/js/story.js');
 const { storiesPage } = await import('../../bindery/static/js/stories.js');
 
-const config = { job_list_max_hours: 720, job_list_max_count: 500 };
+const config = { cwa_enabled: true, job_list_max_hours: 720, job_list_max_count: 500 };
 const book = { id: 7, uuid: 'book-7', title: 'Library Title', authors: ['Writer'] };
 const details = (story, extra = {}) => ({
   story: { id: 1, title: 'Story', author: 'Writer', url: 'https://example.com/story', site: 'example.com',
@@ -27,7 +27,7 @@ async function renderStory(t, data) {
   backend.on('GET', 'jobs?story_id=1', []);
   backend.on('GET', 'jobs', []);
   const main = new Element('main');
-  const cleanup = storyPage(main, { storyId: '1' }, { metadata_fields: {}, mode_labels: {} });
+  const cleanup = storyPage(main, { storyId: '1' }, { cwa_enabled: true, metadata_fields: {}, mode_labels: {} });
   t.after(() => cleanup?.());
   await settle();
   const summary = nodes(main).find((el) => el.className === 'card story-summary');

tests/test_api_flows.py

@@ -46,6 +46,7 @@ def test_add_list_download_and_cancel_jobs(client, story):
     assert result.json["mode"] == "metadata"
     app_config = client.get("/api/config").json
     assert app_config["metadata_fields"]["title"]
+    assert app_config["cwa_enabled"] is True
     assert (app_config["story_jobs_hours"], app_config["story_jobs_count"]) == (36, 10)
     assert (app_config["main_jobs_hours"], app_config["main_jobs_count"]) == (6, 25)
     assert (app_config["job_list_max_hours"], app_config["job_list_max_count"]) == (720, 500)

tests/test_config.py

@@ -104,6 +104,7 @@ def test_defaults(monkeypatch, reload_config):
         "PROXY_AUTH_TRUSTED_IPS",
         "ALLOWED_HOSTS",
         "BINDERY_ADMIN_USERS",
+        "CWA_ENABLED",
         "SESSION_COOKIE_SECURE",
         "TRUST_PROXY",
         "CWA_DB_PATH",
@@ -131,6 +132,8 @@ def test_defaults(monkeypatch, reload_config):
     ]
     assert config.ALLOWED_HOSTS == []
     assert config.ADMIN_USERS == []
+    assert config.CWA_ENABLED is True
+    assert config.IGNORED_SETTINGS == []
     assert config.SESSION_COOKIE_SECURE is False
     assert config.TRUST_PROXY is False
     assert config.CWA_DB_PATH is None
@@ -147,7 +150,76 @@ def test_empty_ingest_directory_disables_uploads(monkeypatch, reload_config, val
     assert config.INGEST_DIR is None
 
 
+@pytest.mark.parametrize("value", ["false", " No ", "0", "off"])
+def test_cwa_off_ignores_the_cwa_settings_but_not_the_ingest_folder(monkeypatch, reload_config, value):
+    monkeypatch.setenv("CWA_ENABLED", value)
+    monkeypatch.setenv("CWA_URL", "https://cwa.invalid")
+    monkeypatch.setenv("CWA_USERNAME", "bindery")
+    monkeypatch.setenv("CWA_PASSWORD", "secret")
+    monkeypatch.setenv("CWA_DB_PATH", "/cwa/app.db")
+    monkeypatch.setenv("CALIBRE_DB_PATH", "/library/metadata.db")
+    monkeypatch.setenv("INGEST_DIR", "/books")
+    reload_config()
+    assert config.CWA_ENABLED is False
+    assert (config.CWA_URL, config.CWA_USERNAME, config.CWA_PASSWORD) == ("", "", "")
+    assert (config.CWA_DB_PATH, config.CALIBRE_DB_PATH) == (None, None)
+    assert config.IGNORED_SETTINGS == ["CWA_URL", "CWA_USERNAME", "CWA_PASSWORD", "CWA_DB_PATH", "CALIBRE_DB_PATH"]
+    assert str(config.INGEST_DIR) == "/books"
+
+
+@pytest.mark.parametrize("value", ["", "true", "maybe"])
+def test_only_a_clear_false_turns_cwa_off(monkeypatch, reload_config, value):
+    monkeypatch.setenv("CWA_ENABLED", value)
+    monkeypatch.setenv("CWA_URL", "https://cwa.invalid")
+    reload_config()
+    assert config.CWA_ENABLED is True
+    assert config.CWA_URL == "https://cwa.invalid"
+
+
+@pytest.mark.parametrize("ignored", [[], ["CWA_URL", "CALIBRE_DB_PATH"]])
+def test_prepare_with_cwa_off_logs_nothing_about_missing_cwa(monkeypatch, tmp_path, caplog, ignored):
+    monkeypatch.setattr(config, "CWA_ENABLED", False)
+    monkeypatch.setattr(config, "IGNORED_SETTINGS", ignored)
+    monkeypatch.setattr(config, "INGEST_DIR", None)
+    monkeypatch.setattr(config, "CWA_URL", "")
+    monkeypatch.setattr(config, "CALIBRE_DB_PATH", None)
+    for name, folder in [("CONFIG_DIR", "config"), ("UPLOAD_DIR", "uploads"), ("TMP_DIR", "tmp")]:
+        monkeypatch.setattr(config, name, tmp_path / folder)
+    monkeypatch.setattr(config, "PERSONAL_INI", tmp_path / "config" / "personal.ini")
+    with caplog.at_level("INFO"):
+        config.prepare()
+    lines = [r.getMessage() for r in caplog.records]
+    expected = ["CWA_ENABLED is false. Bindery ignores CWA_URL, CALIBRE_DB_PATH."] if ignored else []
+    assert [line for line in lines if "CWA" in line or "INGEST" in line] == expected
+
+
+@pytest.mark.parametrize(
+    ("ingest", "url", "database", "expected"),
+    [
+        (False, "", None, ["INGEST_DIR is not set", "cannot find the library book of a story.", "CWA_ENABLED=false"]),
+        (True, "", None, ["so each update adds a new book to CWA.", "CWA_ENABLED=false"]),
+        (True, "", Path("/library/metadata.db"), ["CWA_URL is not set. Bindery cannot search", "CWA_ENABLED=false"]),
+        (False, "https://cwa.invalid", None, ["INGEST_DIR is not set", "CWA_ENABLED=false"]),
+        (True, "https://cwa.invalid", None, []),
+    ],
+)
+def test_prepare_warns_about_each_missing_cwa_function(monkeypatch, tmp_path, caplog, ingest, url, database, expected):
+    monkeypatch.setattr(config, "CWA_URL", url)
+    monkeypatch.setattr(config, "CALIBRE_DB_PATH", database)
+    monkeypatch.setattr(config, "INGEST_DIR", tmp_path if ingest else None)
+    for name, folder in [("CONFIG_DIR", "config"), ("UPLOAD_DIR", "uploads"), ("TMP_DIR", "tmp")]:
+        monkeypatch.setattr(config, name, tmp_path / folder)
+    monkeypatch.setattr(config, "PERSONAL_INI", tmp_path / "config" / "personal.ini")
+    with caplog.at_level("WARNING"):
+        config.prepare()
+    warnings = [r.getMessage() for r in caplog.records]
+    assert len(warnings) == len(expected)
+    for warning, text in zip(warnings, expected, strict=True):
+        assert text in warning
+
+
 def test_prepare_without_cwa_creates_only_bindery_folders(monkeypatch, tmp_path, caplog):
+    monkeypatch.setattr(config, "CWA_ENABLED", False)
     monkeypatch.setattr(config, "INGEST_DIR", None)
     monkeypatch.setattr(config, "CWA_URL", "")
     monkeypatch.setattr(config, "CALIBRE_DB_PATH", None)

tests/test_optional_cwa.py

@@ -9,11 +9,12 @@ from unittest.mock import Mock
 import pytest
 from test_api import H
 from test_api import client as client
-from test_deliver import STORY_URL, add_story, rebuild, site
+from test_deliver import STORY_URL, add_story, rebuild, site, update
 from test_deliver import jobs as jobs
 
 from bindery import config, orchestrator
 from bindery.cwa import Book
+from bindery.ingest import IngestError
 from bindery.jobs import DownloadMode, Job
 from bindery.store import Store
 
@@ -39,7 +40,8 @@ def library(isolated, monkeypatch):
     monkeypatch.setattr(orchestrator, "_find_book", Mock(return_value=None))
 
 
-def test_app_starts_without_any_cwa_configuration(tmp_path):
+@pytest.mark.parametrize("enabled", [False, True])
+def test_app_starts_without_any_cwa_configuration(tmp_path, enabled):
     env = {
         **os.environ,
         "CONFIG_DIR": str(tmp_path / "standalone"),
@@ -47,6 +49,7 @@ def test_app_starts_without_any_cwa_configuration(tmp_path):
         "AUTH_METHOD": "none",
         "BINDERY_START_THREADS": "false",
         "URL_BASE": "",
+        "CWA_ENABLED": str(enabled),
     }
     for name in ("INGEST_DIR", "CWA_URL", "CWA_DB_PATH", "CALIBRE_DB_PATH"):
         env.pop(name, None)
@@ -69,8 +72,69 @@ def test_app_starts_without_any_cwa_configuration(tmp_path):
         timeout=30,
     )
     assert result.returncode == 0, result.stderr
-    assert "WARNING" not in result.stderr
     assert "ERROR" not in result.stderr
+    # Bindery names what is missing, until the user says that there is no CWA.
+    for text in ("WARNING", "INGEST_DIR is not set", "CWA_URL and CALIBRE_DB_PATH are not set", "CWA_ENABLED=false"):
+        assert (text in result.stderr) is enabled
+    if not enabled:
+        assert "CWA" not in result.stderr and "INGEST" not in result.stderr
+
+
+@pytest.fixture
+def cwa_off(monkeypatch):
+    monkeypatch.setattr(config, "CWA_ENABLED", False)
+
+
+def test_without_cwa_and_an_ingest_folder_a_job_only_builds_a_changed_book(monkeypatch, cwa_off):
+    monkeypatch.setattr(config, "INGEST_DIR", None)
+    site(monkeypatch, [(1, "One", "First chapter")])
+    job = Job(mode=DownloadMode.NEW, url=STORY_URL)
+    assert orchestrator._run_site_job(job).endswith("Built the book")
+    story_id = job.story_id
+    story = orchestrator.store.get_story(story_id)
+    assert (story["status"], story["message"], story["ingested_at"]) == ("ok", "Built the book", None)
+    assert orchestrator.store.get_setting(story_id, "upload_held") is None
+    assert len(list(config.TMP_DIR.glob(f"story-{story_id}-*.epub"))) == 1
+    assert update(story_id).startswith("No changes")
+    assert orchestrator._run_rebuild(Job(mode=DownloadMode.REBUILD, story_id=story_id)) == "No changes"
+    assert rebuild(story_id) == "Built the book"
+    site(monkeypatch, [(1, "One", "First chapter"), (2, "Two", "Second chapter")])
+    assert update(story_id).endswith("Built the book")
+    orchestrator.cwa.assert_not_called()
+
+
+@pytest.mark.parametrize("saved_id", [None, 7])
+def test_without_cwa_the_ingest_folder_gets_each_changed_book_as_a_plain_epub(cwa_off, saved_id):
+    # A pause, a hold and a saved book ID are from a time with CWA. They do not apply.
+    orchestrator.save_settings(pause_uploads=True, hold_new_links=True)
+    story_id = add_story(calibre_id=saved_id, calibre_uuid="saved-uuid" if saved_id else None)
+    orchestrator._link_changed(story_id)
+    orchestrator.store.set_setting(story_id, "upload_held", True)
+    assert rebuild(story_id) == "Sent to ingest folder"
+    assert [p.suffix for p in config.INGEST_DIR.iterdir()] == [".epub"]
+    assert orchestrator.store.get_story(story_id)["ingested_at"] is None
+    assert orchestrator.store.get_setting(story_id, "upload_held") is None
+    assert orchestrator._run_rebuild(Job(mode=DownloadMode.REBUILD, story_id=story_id)) == "No changes"
+    assert len(list(config.INGEST_DIR.iterdir())) == 1
+    orchestrator.cwa.assert_not_called()
+
+
+def test_without_cwa_a_missing_ingest_folder_is_still_an_error(monkeypatch, tmp_path, cwa_off):
+    monkeypatch.setattr(config, "INGEST_DIR", tmp_path / "missing")
+    story_id = add_story()
+    with pytest.raises(IngestError, match="does not exist"):
+        rebuild(story_id)
+    # The book counts as sent only when it is in the folder.
+    assert orchestrator.store.get_setting(story_id, "sent_key") is None
+
+
+def test_cwa_off_shows_in_the_config_and_refuses_cwa_logins(client, monkeypatch, cwa_off):
+    assert client.get("/api/config").json["cwa_enabled"] is False
+    monkeypatch.setattr(config, "AUTH_METHOD", "cwa")
+    monkeypatch.setattr(config, "CWA_DB_PATH", "/cwa/app.db")
+    response = client.get("/api/stories")
+    assert response.status_code == 503
+    assert response.json["error"].startswith("AUTH_METHOD=cwa needs CWA, but CWA_ENABLED is false.")
 
 
 def test_link_setting_defaults_on_and_persists(client, monkeypatch, tmp_path, library):