Add configuration to exclude paths

[divyansshhh]

Resolves #1162

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.

You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[github-actions]

👈 Launch a binder notebook on branch divyansshhh/jupyterlab-git/feat/exclude_paths

[divyansshhh]

@fcollonval , a few of the tests have failed and it seems because I'm accessing the settings through self.git._config.excluded_paths.

Do you have any other recommendations for this?

The configuration will be accessible from self.git.config.excluded_paths

I tried this as well but this doesn't work because self.git.config is a function and also it returns the git config not JupyterLabGit config.

[krassowski]

One option could be to expose excluded_paths as a property of GitHandler

diff --git a/jupyterlab_git/git.py b/jupyterlab_git/git.py
--- a/jupyterlab_git/git.py
+++ b/jupyterlab_git/git.py
@@ -1750,3 +1750,7 @@ class Git:
 
         elif self._GIT_CREDENTIAL_CACHE_DAEMON_PROCESS.poll():
             self.ensure_git_credential_cache_daemon(socket, debug, True, cwd, env)
+
+    @property
+    def excluded_paths(self):
+        return self._config.excluded_paths
diff --git a/jupyterlab_git/handlers.py b/jupyterlab_git/handlers.py
--- a/jupyterlab_git/handlers.py
+++ b/jupyterlab_git/handlers.py
@@ -43,7 +43,7 @@ class GitHandler(APIHandler):
         super().prepare()
         path = self.path_kwargs.get("path")
         if path is not None:
-            excluded_paths = self.git._config.excluded_paths
+            excluded_paths = self.git.excluded_paths
             for excluded_path in excluded_paths:
                 if re.match(excluded_path, path):
                     self.set_status(404)

[divyansshhh]

I was planning to write a test for this in jupyterlab_git/test/test_handlers.py but I can't figure out how I should pass the excluded paths setting.

Also, another question I have is -
Consider -

jupyterlab-git/jupyterlab_git/tests/test_handlers.py

Line 24 in a08a929

def test_GitHandler_url2localpath(path, with_cm, jp_web_app, jp_root_dir):

Where do jp_web_app and jp_root_dir parameters come from?

[fcollonval]

You can override the default server configuration by overriding the jp_server_config in the test file as done in

jupyterlab-git/conftest.py

Line 7 in a08a929

def jp_server_config(jp_server_config):

The fixture requested are provided by the jupyter Server pytest Plugin (loaded in the file linked above).

This makes it quite convenient to create pytest for Jupyter server.

[fcollonval]

Thanks @divyansshhh

I made some suggestions to improve the code and add some more documentation.

[fcollonval]

Thanks a lot @divyansshhh

[welcome]

Congrats on your first merged pull request in this project! 🎉

Thank you for contributing, we are very proud of you! ❤️