feat: Non-blocking checkout (#2108)

* feat: Non-blocking checkout

* removing console logs; changing dummy repo URL

* removing disabled test and perf time recording

* using isomorphic-git's dummy repo in test

---------

Co-authored-by: aniket.bhosale <aniket.bhosale@servicenow.com>

Author: 2 people

docs/en/checkout.html

@@ -74,6 +74,8 @@
 <tr><td>force</td><td>boolean = false</td><td>If true, conflicts will be ignored and files will be overwritten regardless of local changes.</td></tr>
 <tr><td>track</td><td>boolean = true</td><td>If false, will not set the remote branch tracking information. Defaults to true.</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>If true, will use non-blocking file system operations to allow for better performance in certain environments (For example, in Browsers)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when filesystem operations are complete</td></tr>
 </tbody>
 </table>

docs/en/checkout/index.html

@@ -74,6 +74,8 @@
 <tr><td>force</td><td>boolean = false</td><td>If true, conflicts will be ignored and files will be overwritten regardless of local changes.</td></tr>
 <tr><td>track</td><td>boolean = true</td><td>If false, will not set the remote branch tracking information. Defaults to true.</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>If true, will use non-blocking file system operations to allow for better performance in certain environments (For example, in Browsers)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when filesystem operations are complete</td></tr>
 </tbody>
 </table>

docs/en/clone.html

@@ -83,6 +83,8 @@
 <tr><td>relative</td><td>boolean = false</td><td>Changes the meaning of <code>depth</code> to be measured from the current shallow depth rather than from the branch tip.</td></tr>
 <tr><td><a href="./headers">headers</a></td><td>Object&lt;string, string&gt; = {}</td><td>Additional headers to include in HTTP requests, similar to git's <code>extraHeader</code> config</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>if true, checkout will happen non-blockingly (useful for long-running operations blocking the thread in browser environments)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when clone completes</td></tr>
 </tbody>
 </table>

docs/en/clone/index.html

@@ -83,6 +83,8 @@
 <tr><td>relative</td><td>boolean = false</td><td>Changes the meaning of <code>depth</code> to be measured from the current shallow depth rather than from the branch tip.</td></tr>
 <tr><td><a href="./headers">headers</a></td><td>Object&lt;string, string&gt; = {}</td><td>Additional headers to include in HTTP requests, similar to git's <code>extraHeader</code> config</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>if true, checkout will happen non-blockingly (useful for long-running operations blocking the thread in browser environments)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when clone completes</td></tr>
 </tbody>
 </table>

docs/en/next/checkout.html

@@ -74,6 +74,8 @@
 <tr><td>force</td><td>boolean = false</td><td>If true, conflicts will be ignored and files will be overwritten regardless of local changes.</td></tr>
 <tr><td>track</td><td>boolean = true</td><td>If false, will not set the remote branch tracking information. Defaults to true.</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/next/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>If true, will use non-blocking file system operations to allow for better performance in certain environments (For example, in Browsers)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when filesystem operations are complete</td></tr>
 </tbody>
 </table>

docs/en/next/checkout/index.html

@@ -74,6 +74,8 @@
 <tr><td>force</td><td>boolean = false</td><td>If true, conflicts will be ignored and files will be overwritten regardless of local changes.</td></tr>
 <tr><td>track</td><td>boolean = true</td><td>If false, will not set the remote branch tracking information. Defaults to true.</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/next/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>If true, will use non-blocking file system operations to allow for better performance in certain environments (For example, in Browsers)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when filesystem operations are complete</td></tr>
 </tbody>
 </table>

docs/en/next/clone.html

@@ -83,6 +83,8 @@
 <tr><td>relative</td><td>boolean = false</td><td>Changes the meaning of <code>depth</code> to be measured from the current shallow depth rather than from the branch tip.</td></tr>
 <tr><td><a href="./headers">headers</a></td><td>Object&lt;string, string&gt; = {}</td><td>Additional headers to include in HTTP requests, similar to git's <code>extraHeader</code> config</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/next/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>if true, checkout will happen non-blockingly (useful for long-running operations blocking the thread in browser environments)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when clone completes</td></tr>
 </tbody>
 </table>

docs/en/next/clone/index.html

@@ -83,6 +83,8 @@
 <tr><td>relative</td><td>boolean = false</td><td>Changes the meaning of <code>depth</code> to be measured from the current shallow depth rather than from the branch tip.</td></tr>
 <tr><td><a href="./headers">headers</a></td><td>Object&lt;string, string&gt; = {}</td><td>Additional headers to include in HTTP requests, similar to git's <code>extraHeader</code> config</td></tr>
 <tr><td>cache</td><td>object</td><td>a <a href="/docs/en/next/cache">cache</a> object</td></tr>
+<tr><td>nonBlocking</td><td>boolean = false</td><td>if true, checkout will happen non-blockingly (useful for long-running operations blocking the thread in browser environments)</td></tr>
+<tr><td>batchSize</td><td>number = 100</td><td>If args.nonBlocking is true, batchSize is the number of files to process at a time avoid blocking the executing thread. The default value of 100 is a good starting point.</td></tr>
 <tr><td>return</td><td>Promise&lt;void&gt;</td><td>Resolves successfully when clone completes</td></tr>
 </tbody>
 </table>

js/isomorphic-git/README.md

@@ -388,6 +388,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
     <td align="center"><a href="https://github.com/lukecotter"><img src="https://avatars.githubusercontent.com/u/4013877?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Luke Cotter</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=lukecotter" title="Code">💻</a></td>
     <td align="center"><a href="https://tomlarkworthy.endpointservices.net/"><img src="https://avatars.githubusercontent.com/u/1848162?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Tom Larkworthy</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=tomlarkworthy" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/kofta999"><img src="https://avatars.githubusercontent.com/u/99273340?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Mostafa Mahmoud</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=kofta999" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=kofta999" title="Tests">⚠️</a> <a href="#question-kofta999" title="Answering Questions">💬</a></td>
+    <td align="center"><a href="https://github.com/ARBhosale"><img src="https://avatars.githubusercontent.com/u/26981417?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Aniket Bhosale</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=ARBhosale" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=ARBhosale" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=ARBhosale" title="Tests">⚠️</a></td>
   </tr>
 </table>