Support downloading a git repository snapshot (#1177)

* updt git.py file to upload git repo with depth

* setting a metaDataChecked boolean flag upon git cloning a repository

* clone based on metaDataChecked flag

* clone with metadata if flag unchecked

* resolved PR comments with styling and .git file issues

* refactor git.py and resolve css bugs

* fix translation & starter test

* clone the repo in the test

* fix imports

* fix build failures

* .

* fix pR build fixes

* update var name to 'not_versioning'

* fix naming issues

* fix var name inconsistency

* .

* .

* .'

* Make versioning optional to be API backward compatible

* Lint the code

* Reorder `Git.clone` args

Fix unit tests

* Update jupyterlab_git/tests/test_clone.py

Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com>

* fix bugs

* .

* .

* add abs path

* .

Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com>

Author: sheezaaziz

jupyterlab_git/git.py

@@ -6,6 +6,7 @@
 import pathlib
 import re
 import shlex
+import shutil
 import subprocess
 import traceback
 from typing import Dict, List, Optional
@@ -271,23 +272,31 @@ async def changed_files(self, path, base=None, remote=None, single_commit=None):
 
         return response
 
-    async def clone(self, path, repo_url, auth=None):
+    async def clone(self, path, repo_url, auth=None, versioning=True):
         """
         Execute `git clone`.
         When no auth is provided, disables prompts for the password to avoid the terminal hanging.
         When auth is provided, await prompts for username/passwords and sends them
         :param path: the directory where the clone will be performed.
         :param repo_url: the URL of the repository to be cloned.
         :param auth: OPTIONAL dictionary with 'username' and 'password' fields
+        :param versioning: OPTIONAL whether to clone or download a snapshot of the remote repository; default clone
         :return: response with status code and error message.
         """
         env = os.environ.copy()
+        cmd = ["git", "clone"]
+        if not versioning:
+            cmd.append("--depth=1")
+            current_content = set(os.listdir(path))
+        cmd.append(unquote(repo_url))
+
         if auth:
             if auth.get("cache_credentials"):
                 await self.ensure_credential_helper(path)
             env["GIT_TERMINAL_PROMPT"] = "1"
+            cmd.append("-q")
             code, output, error = await execute(
-                ["git", "clone", unquote(repo_url), "-q"],
+                cmd,
                 username=auth["username"],
                 password=auth["password"],
                 cwd=path,
@@ -296,11 +305,16 @@ async def clone(self, path, repo_url, auth=None):
         else:
             env["GIT_TERMINAL_PROMPT"] = "0"
             code, output, error = await execute(
-                ["git", "clone", unquote(repo_url)],
+                cmd,
                 cwd=path,
                 env=env,
             )
 
+        if not versioning:
+            new_content = set(os.listdir(path))
+            directory = (new_content - current_content).pop()
+            shutil.rmtree(f"{path}/{directory}/.git")
+
         response = {"code": code, "message": output.strip()}
 
         if code != 0:

jupyterlab_git/handlers.py

@@ -88,6 +88,7 @@ async def post(self, path: str = ""):
             self.url2localpath(path),
             data["clone_url"],
             data.get("auth", None),
+            data["versioning"],
         )
 
         if response["code"] != 0:

jupyterlab_git/tests/test_clone.py

@@ -32,6 +32,38 @@ async def test_git_clone_success():
             assert {"code": 0, "message": output} == actual_response
 
 
+@pytest.mark.asyncio
+async def test_git_download_success(tmp_path):
+    with patch("os.environ", {"TEST": "test"}):
+        with patch("jupyterlab_git.git.execute") as mock_execute:
+            # Given
+            output = "output"
+            git_folder = tmp_path / "dummy-repo" / ".git"
+
+            def create_fake_git_repo(*args, **kwargs):
+                git_folder.mkdir(parents=True)
+                return maybe_future((0, output, "error"))
+
+            mock_execute.side_effect = create_fake_git_repo
+
+            # When
+            await Git().clone(
+                path=str(tmp_path), repo_url="ghjkhjkl", auth=None, versioning=False
+            )
+
+            # Then
+            mock_execute.assert_called_once_with(
+                ["git", "clone", "--depth=1", "ghjkhjkl"],  # to be update
+                cwd=str(tmp_path),  # to be udpated
+                env={"TEST": "test", "GIT_TERMINAL_PROMPT": "0"},
+            )
+
+            # Check the repository folder has been created
+            assert git_folder.parent.exists()
+            # Check the `.git` folder has been removed.
+            assert not git_folder.exists()
+
+
 @pytest.mark.asyncio
 async def test_git_clone_failure_from_git():
     """

src/cloneCommand.ts

@@ -46,7 +46,7 @@ export const gitCloneCommandPlugin: JupyterFrontEndPlugin<void> = {
           ]
         });
 
-        if (result.button.accept && result.value) {
+        if (result.button.accept && result.value.url) {
           logger.log({
             level: Level.RUNNING,
             message: trans.__('Cloning…')
@@ -56,7 +56,11 @@ export const gitCloneCommandPlugin: JupyterFrontEndPlugin<void> = {
               gitModel as GitExtension,
               Operation.Clone,
               trans,
-              { path: fileBrowserModel.path, url: result.value }
+              {
+                path: fileBrowserModel.path,
+                url: result.value.url,
+                versioning: result.value.versioning
+              }
             );
             logger.log({
               message: trans.__('Successfully cloned'),

src/commandsAndMenu.tsx

@@ -60,6 +60,11 @@ export interface IGitCloneArgs {
    * Git repository url
    */
   url: string;
+  /**
+   * Whether to activate git versioning in the clone or not.
+   * If false, this will remove the .git folder after cloning.
+   */
+  versioning?: boolean;
 }
 
 /**
@@ -1538,8 +1543,13 @@ export async function showGitOperationDialog<T>(
     switch (operation) {
       case Operation.Clone:
         // eslint-disable-next-line no-case-declarations
-        const { path, url } = args as any as IGitCloneArgs;
-        result = await model.clone(path, url, authentication);
+        const { path, url, versioning } = args as any as IGitCloneArgs;
+        result = await model.clone(
+          path,
+          url,
+          authentication,
+          versioning ?? true
+        );
         break;
       case Operation.Pull:
         result = await model.pull(authentication);

src/model.ts

@@ -619,6 +619,7 @@ export class GitExtension implements IGitExtension {
    * @param path - local path into which the repository will be cloned
    * @param url - Git repository URL
    * @param auth - remote repository authentication information
+   * @param versioning - boolean flag of Git metadata (default true)
    * @returns promise which resolves upon cloning a repository
    *
    * @throws {Git.GitResponseError} If the server response is not ok
@@ -627,7 +628,8 @@ export class GitExtension implements IGitExtension {
   async clone(
     path: string,
     url: string,
-    auth?: Git.IAuth
+    auth?: Git.IAuth,
+    versioning = true
   ): Promise<Git.IResultWithMessage> {
     return await this._taskHandler.execute<Git.IResultWithMessage>(
       'git:clone',
@@ -637,6 +639,7 @@ export class GitExtension implements IGitExtension {
           'POST',
           {
             clone_url: url,
+            versioning: versioning,
             auth: auth as any
           }
         );

src/tokens.ts

@@ -232,6 +232,7 @@ export interface IGitExtension extends IDisposable {
    * @param path - local path into which the repository will be cloned
    * @param url - Git repository URL
    * @param auth - remote repository authentication information
+   * @param versioning - Whether to clone or download the Git repository
    * @returns promise which resolves upon cloning a repository
    *
    * @throws {Git.GitResponseError} If the server response is not ok
@@ -240,7 +241,8 @@ export interface IGitExtension extends IDisposable {
   clone(
     path: string,
     url: string,
-    auth?: Git.IAuth
+    auth?: Git.IAuth,
+    versioning?: boolean
   ): Promise<Git.IResultWithMessage>;
 
   /**

src/widgets/GitCloneForm.ts

@@ -16,23 +16,59 @@ export class GitCloneForm extends Widget {
   /**
    * Returns the input value.
    */
-  getValue(): string {
-    return encodeURIComponent(this.node.querySelector('input').value.trim());
+  getValue(): { url: string; versioning: boolean } {
+    return {
+      url: encodeURIComponent(
+        (
+          this.node.querySelector('#input-link') as HTMLInputElement
+        ).value.trim()
+      ),
+      versioning: Boolean(
+        encodeURIComponent(
+          (this.node.querySelector('#checkbox') as HTMLInputElement).checked
+        )
+      )
+    };
   }
 
   private static createFormNode(trans: TranslationBundle): HTMLElement {
     const node = document.createElement('div');
-    const label = document.createElement('label');
-    const input = document.createElement('input');
-    const text = document.createElement('span');
+    const inputWrapper = document.createElement('div');
+    const inputLinkLabel = document.createElement('label');
+    const inputLink = document.createElement('input');
+    const linkText = document.createElement('span');
+    const checkboxWrapper = document.createElement('div');
+    const checkboxLabel = document.createElement('label');
+    const checkbox = document.createElement('input');
 
-    node.className = 'jp-RedirectForm';
-    text.textContent = trans.__('Enter the Clone URI of the repository');
-    input.placeholder = 'https://host.com/org/repo.git';
+    node.className = 'jp-CredentialsBox';
+    inputWrapper.className = 'jp-RedirectForm';
+    checkboxWrapper.className = 'jp-CredentialsBox-wrapper';
+    checkboxLabel.className = 'jp-CredentialsBox-label-checkbox';
+    checkbox.id = 'checkbox';
+    inputLink.id = 'input-link';
+
+    linkText.textContent = trans.__(
+      'Enter the URI of the remote Git repository'
+    );
+    inputLink.placeholder = 'https://host.com/org/repo.git';
+    checkboxLabel.textContent = trans.__('Download the repository');
+    checkboxLabel.title = trans.__(
+      'If checked, the remote repository default branch will be downloaded instead of cloned'
+    );
+    checkbox.setAttribute('type', 'checkbox');
+
+    inputLinkLabel.appendChild(linkText);
+    inputLinkLabel.appendChild(inputLink);
+
+    inputWrapper.append(inputLinkLabel);
+
+    checkboxLabel.prepend(checkbox);
+    checkboxWrapper.appendChild(checkboxLabel);
+
+    node.appendChild(inputWrapper);
+    node.appendChild(checkboxWrapper);
 
-    label.appendChild(text);
-    label.appendChild(input);
-    node.appendChild(label);
     return node;
   }
 }

style/credentials-box.css

@@ -18,3 +18,7 @@
   display: flex;
   align-items: center;
 }
+
+.jp-CredentialsBox-wrapper {
+  margin-top: 10px;
+}