Add configuration to exclude paths (jupyterlab#1163)

* Add configuration to exclude paths

* Update help message

* Fix failing test

* Add test

* Updated README.md

* Update README.md

Co-authored-by: Frédéric Collonval <[email protected]>

* Update jupyterlab_git/git.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Update jupyterlab_git/handlers.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Update jupyterlab_git/tests/test_handlers.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Update conftest.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Update jupyterlab_git/handlers.py

Co-authored-by: Frédéric Collonval <[email protected]>

* Run lint

Co-authored-by: Frédéric Collonval <[email protected]>

Author: divyansshhh

README.md

@@ -112,6 +112,7 @@ Once installed, extension behavior can be modified via the following settings wh
   It is possible to provide a list of commands to be executed in a folder after it is initialized as Git repository.
 - `JupyterLabGit.credential_helper`: Git credential helper to set to cache the credentials.
   The default value is `cache --timeout=3600` to cache the credentials for an hour. If you want to cache them for 10 hours, set `cache --timeout=36000`.
+- `JupyterLabGit.excluded_paths`: Set path patterns to exclude from this extension. You can use wildcard and interrogation mark for respectively everything or any single character in the pattern.
 
 <details>
 <summary><b>How to set server settings?</b></summary>

conftest.py

@@ -4,5 +4,8 @@
 
 
 @pytest.fixture
-def jp_server_config(jp_server_config):
-    return {"ServerApp": {"jpserver_extensions": {"jupyterlab_git": True}}}
+def jp_server_config(jp_server_config, jp_root_dir):
+    return {
+        "ServerApp": {"jpserver_extensions": {"jupyterlab_git": True}},
+        "JupyterLabGit": {"excluded_paths": ["/ignored-path/*"]},
+    }

jupyterlab_git/__init__.py

@@ -37,6 +37,8 @@ class JupyterLabGit(Configurable):
         # TODO Validate
     )
 
+    excluded_paths = List(help="Paths to be excluded", config=True, trait=Unicode())
+
     credential_helper = Unicode(
         help="""
             The value of Git credential helper will be set to this value when the Git credential caching mechanism is activated by this extension.

jupyterlab_git/git.py

@@ -1750,3 +1750,11 @@ def ensure_git_credential_cache_daemon(
 
         elif self._GIT_CREDENTIAL_CACHE_DAEMON_PROCESS.poll():
             self.ensure_git_credential_cache_daemon(socket, debug, True, cwd, env)
+
+    @property
+    def excluded_paths(self) -> List[str]:
+        """Wildcard-style path patterns that do not support git commands.
+
+        You can use ``*`` to match everything or ``?`` to match any single character.
+        """
+        return self._config.excluded_paths

jupyterlab_git/handlers.py

@@ -12,6 +12,7 @@
 from jupyter_server.services.contents.manager import ContentsManager
 from jupyter_server.utils import url2path, url_path_join
 from packaging.version import parse
+import fnmatch
 
 try:
     import hybridcontents
@@ -37,6 +38,18 @@ class GitHandler(APIHandler):
     def git(self) -> Git:
         return self.settings["git"]
 
+    def prepare(self):
+        """Check if the path should be skipped"""
+        super().prepare()
+        path = self.path_kwargs.get("path")
+        if path is not None:
+            excluded_paths = self.git.excluded_paths
+            for excluded_path in excluded_paths:
+                if fnmatch.fnmatchcase(path, excluded_path):
+                    self.set_status(404)
+                    self.finish()
+                    break
+
     @functools.lru_cache()
     def url2localpath(
         self, path: str, with_contents_manager: bool = False

jupyterlab_git/tests/test_handlers.py

@@ -8,6 +8,7 @@
 from jupyterlab_git.handlers import NAMESPACE, setup_handlers, GitHandler
 
 from .testutils import assert_http_error, maybe_future
+from tornado.httpclient import HTTPClientError
 
 
 def test_mapping_added():
@@ -106,6 +107,23 @@ async def test_git_show_prefix(mock_execute, jp_fetch, jp_root_dir):
     )
 
 
+async def test_git_show_prefix_for_excluded_path(
+    jp_fetch, jp_server_config, jp_root_dir
+):
+    local_path = jp_root_dir / "ignored-path"
+
+    try:
+        response = await jp_fetch(
+            NAMESPACE,
+            local_path.name + "/subdir",
+            "show_prefix",
+            body="{}",
+            method="POST",
+        )
+    except HTTPClientError as e:
+        assert e.code == 404
+
+
 @patch("jupyterlab_git.git.execute")
 async def test_git_show_prefix_not_a_git_repo(mock_execute, jp_fetch, jp_root_dir):
     # Given