From 3d6d1e3050b8e50fac40ec090672d8a95fa8e06c Mon Sep 17 00:00:00 2001
From: Alex Garcia <alexsebastian.garcia@gmail.com>
Date: Thu, 12 Oct 2023 09:20:50 -0700
Subject: [PATCH] Raise an exception if a "plugins" block exists in
 metadata.json

---
 datasette/app.py            |  8 ++++++--
 datasette/cli.py            |  3 ++-
 datasette/utils/__init__.py | 15 +++++++++++++++
 tests/test_plugins.py       |  8 ++++++++
 4 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/datasette/app.py b/datasette/app.py
index 7dfc63c6c0..f33865e4a4 100644
--- a/datasette/app.py
+++ b/datasette/app.py
@@ -76,6 +76,7 @@
     parse_metadata,
     resolve_env_secrets,
     resolve_routes,
+    fail_if_plugins_in_metadata,
     tilde_decode,
     to_css_class,
     urlsafe_components,
@@ -334,13 +335,16 @@ def __init__(
             ]
         if config_dir and metadata_files and not metadata:
             with metadata_files[0].open() as fp:
-                metadata = parse_metadata(fp.read())
+                metadata = fail_if_plugins_in_metadata(
+                    parse_metadata(fp.read()), metadata_files[0].name
+                )
 
         if config_dir and config_files and not config:
             with config_files[0].open() as fp:
                 config = parse_metadata(fp.read())
 
-        self._metadata_local = metadata or {}
+        self._metadata_local = fail_if_plugins_in_metadata(metadata or {})
+
         self.sqlite_extensions = []
         for extension in sqlite_extensions or []:
             # Resolve spatialite, if requested
diff --git a/datasette/cli.py b/datasette/cli.py
index 1a5a8af34c..91f38f698f 100644
--- a/datasette/cli.py
+++ b/datasette/cli.py
@@ -33,6 +33,7 @@
     initial_path_for_datasette,
     pairs_to_nested_config,
     temporary_docker_directory,
+    fail_if_plugins_in_metadata,
     value_as_boolean,
     SpatialiteNotFound,
     StaticMount,
@@ -542,7 +543,7 @@ def serve(
 
     metadata_data = None
     if metadata:
-        metadata_data = parse_metadata(metadata.read())
+        metadata_data = fail_if_plugins_in_metadata(parse_metadata(metadata.read()))
 
     config_data = None
     if config:
diff --git a/datasette/utils/__init__.py b/datasette/utils/__init__.py
index 18d18641e2..0f449b89a1 100644
--- a/datasette/utils/__init__.py
+++ b/datasette/utils/__init__.py
@@ -1268,3 +1268,18 @@ def pairs_to_nested_config(pairs: typing.List[typing.Tuple[str, typing.Any]]) ->
         parsed_pair = _handle_pair(key, value)
         result = _combine(result, parsed_pair)
     return result
+
+
+def fail_if_plugins_in_metadata(metadata: dict, filename=None):
+    """If plugin config is inside metadata, raise an Exception"""
+    if metadata is not None and metadata.get("plugins") is not None:
+        suggested_extension = (
+            ".yaml"
+            if filename is not None
+            and (filename.endswith(".yaml") or filename.endswith(".yml"))
+            else ".json"
+        )
+        raise Exception(
+            f'Datasette no longer accepts plugin configuration in --metadata. Move your "plugins" configuration blocks to a separate file - we suggest calling that datasette.{suggested_extension} - and start Datasette with datasette -c datasette.{suggested_extension}. See https://docs.datasette.io/en/latest/configuration.html for more details.'
+        )
+    return metadata
diff --git a/tests/test_plugins.py b/tests/test_plugins.py
index 66060bca06..82e2f7f18b 100644
--- a/tests/test_plugins.py
+++ b/tests/test_plugins.py
@@ -879,6 +879,14 @@ def test_hook_forbidden(restore_working_directory):
         )
 
 
+def test_plugin_config_in_metadata():
+    with pytest.raises(
+        Exception,
+        match="Datasette no longer accepts plugin configuration in --metadata",
+    ):
+        Datasette(memory=True, metadata={"plugins": {}})
+
+
 @pytest.mark.asyncio
 async def test_hook_handle_exception(ds_client):
     await ds_client.get("/trigger-error?x=123")