Load gitignore file #1273

kentarolim10 · 2023-10-06T19:45:41Z

Description

-Throws a 403 if the user tries to open a .gitignore file but the file is hidden
-Displays a helpful message showing how to enable hidden files
-Adds checkbox to not show helpful message in the feature
-Allow user to open, view and edit the .gitignore file

Temporary fix for the opening the .gitignore file in #1168

welcome · 2023-10-06T19:45:43Z

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 · 2023-10-06T19:45:56Z

👈 Launch a Binder on branch kentarolim10/jupyterlab-git/gitignore-wont-open-if-file-hidden

fcollonval · 2023-10-24T13:32:34Z

@kentarolim10 the main branch has been updated to JupyterLab 4 - to ease the work here, I changed the target to the branch jlab-3 to avoid complex rebasing.

kentarolim10 · 2023-10-24T23:31:30Z

Great, thank you so much. Kentaro

…

On Tue, Oct 24, 2023 at 6:32 AM Frédéric Collonval ***@***.***> wrote: @kentarolim10 <https://github.com/kentarolim10> the main branch has been updated to JupyterLab 4 - to ease the work here, I changed the target to the branch jlab-3 to avoid complex rebasing. — Reply to this email directly, view it on GitHub <#1273 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOXIKUG7DRGS6IOVCUUWERTYA67P3AVCNFSM6AAAAAA5WIXW4SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZXGIYTGOBXG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

fcollonval

Thanks @kentarolim10

This looks really good. I have only one large concern about the detection if .gitignore is accessible and how to get its content; we should try to split the code in more limited feature. Let me know if my proposal for improvement is not clear.

fcollonval · 2023-10-25T14:44:26Z

jupyterlab_git/git.py

+        """
+        try:
+            file = pathlib.Path(path)
+            if file.stat().st_size > 0:


Is there a specific reason for testing this?

I just wanted to check if the file was empty and then return an empty string if it was. I guess since if the file is empty, then it would be an empty string regardless. I will remove it.

fcollonval · 2023-10-25T14:44:53Z

jupyterlab_git/git.py

@@ -1681,6 +1681,22 @@ async def remote_remove(self, path, name):

        return response

+    async def read_file(self, path):


This is actually not asynchronous 😉

Suggested change

async def read_file(self, path):

def read_file(self, path):

fcollonval · 2023-10-25T14:45:59Z

jupyterlab_git/git.py

@@ -1721,6 +1737,32 @@ async def ignore(self, path, file_path):
            return {"code": -1, "message": str(error)}
        return {"code": 0}

+    async def writeGitignore(self, path, content):


Let's be consistent with the naming of Python (even if I find myself often bitten by this one too):

Suggested change

async def writeGitignore(self, path, content):

async def write_gitignore(self, path, content):

fcollonval · 2023-10-25T14:49:06Z

jupyterlab_git/git.py

+            with gitignore.open("a") as f:
+                f.truncate(0)
+                f.seek(0)
+                f.write(content)
+                if content[-1] != "\n":
+                    f.write("\n")


You could write directly the file content:

Suggested change

with gitignore.open("a") as f:

f.truncate(0)

f.seek(0)

f.write(content)

if content[-1] != "\n":

f.write("\n")

if content and content[-1] != "\n":

content += "\n"

gitignore.write_text(content)

See the doc for more info: https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_text

fcollonval · 2023-10-26T10:05:00Z

src/commandsAndMenu.tsx

+    editor.disposed.connect(() => {
+      model.dispose();
+    });
+    const preview = new PreviewMainAreaWidget({


Let's use a MainAreaWidget directly here as the intention is to edit the file content:

Suggested change

const preview = new PreviewMainAreaWidget({

const preview = new MainAreaWidget({

fcollonval · 2023-10-26T10:24:20Z

src/git.ts

+      if (response.status === 403) {
+        throw new Git.HiddenFile(data.content);
+      }


We unfortunately gonna need to change the logic because this is not robust (we may get a 403 code for other reasons).

fcollonval · 2023-10-26T10:30:51Z

src/commandsAndMenu.tsx

+            await showGitignore(error);
+          } else {
+            await showGitignoreHiddenFile(error);


Could you change a bit the signature of showGitignoreHiddenFile to take a second optional argument that will decide if the user should be prompted with a dialog or not? showGitignore will therefore be an implementation detail of showGitignoreHiddenFile; the goal is to reduce the API between the various part of the code.

fcollonval · 2023-10-26T10:33:57Z

jupyterlab_git/handlers.py

+        if not self.serverapp.contents_manager.allow_hidden and not content:
+            self.set_status(403, "hidden files cannot be accessed")
+            body["content"] = await self.git.read_file(local_path + "/.gitignore")


We need to change the logic because that code is increasing the complexity of the endpoint and returns the file content in any case even if the user wants to respect the configuration of not accessing the hidden file.

src/model.ts

fcollonval · 2023-10-26T11:58:21Z

src/tokens.ts

+    content: string;
+    constructor(content: string) {
+      super('File is hidden');
+      this.name = 'hiddenFile';
+      this.message = 'File is hidden and cannot be accessed.';
+      this.content = content;


content will not be needed

Suggested change

content: string;

constructor(content: string) {

super('File is hidden');

this.name = 'hiddenFile';

this.message = 'File is hidden and cannot be accessed.';

this.content = content;

constructor(content: string) {

super('File is hidden');

this.name = 'hiddenFile';

this.message = 'File is hidden and cannot be accessed.';

fcollonval

Almost done; would you mind addressing the new comment and that one?

fcollonval · 2023-11-08T15:49:57Z

src/model.ts

+  async readGitIgnore(): Promise<{ code: number; content: string }> {
+    const path = await this._getPathRepository();
+
+    const res = (await requestAPI(URLExt.join(path, 'ignore'), 'GET')) as {
+      code: number;
+      content: string;
+    };
+    await this.refreshStatus();
+    return res;


Let's make the method more useful by returning directly the content. And we don't need to refresh the status as it does not change the gitignore file.

Suggested change

async readGitIgnore(): Promise<{ code: number; content: string }> {

const path = await this._getPathRepository();

const res = (await requestAPI(URLExt.join(path, 'ignore'), 'GET')) as {

code: number;

content: string;

};

await this.refreshStatus();

return res;

async readGitIgnore(): Promise<string> {

const path = await this._getPathRepository();

return (await requestAPI(URLExt.join(path, 'ignore'), 'GET')).content;

…om/kentarolim10/jupyterlab-git into gitignore-wont-open-if-file-hidden

fcollonval · 2023-11-10T13:32:40Z

almost there @kentarolim10

You only need to fix (it is the consequence of the API returning now directly the gitignore content):

ERROR: src/commandsAndMenu.tsx:329:45 - error TS2339: Property 'content' does not exist on type 'string'.

329     model.sharedModel.setSource(contentData.content ? contentData.content : '');
                                                ~~~~~~~
src/commandsAndMenu.tsx:329:67 - error TS2339: Property 'content' does not exist on type 'string'.

329     model.sharedModel.setSource(contentData.content ? contentData.content : '');

fcollonval

Thanks a lot @kentarolim10

Let's merge 😉

welcome · 2023-11-15T15:47:03Z

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

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

fcollonval · 2023-11-15T15:47:13Z

@meeseeksdev please backport to main

lumberbot-app · 2023-11-15T15:47:21Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout main
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 23fa7648df8ad1b01c5ddae7d4db62b1b9f15337

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #1273: Load gitignore file'

Push to a named branch:

git push YOURFORK main:auto-backport-of-pr-1273-on-main

Create a PR against branch main, I would have named this PR:

"Backport PR #1273 on branch main (Load gitignore file)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

fcollonval · 2023-11-15T15:48:27Z

@all-contributors please add @kentarolim10 for code

allcontributors · 2023-11-15T15:48:36Z

@fcollonval

I've put up a pull request to add @kentarolim10! 🎉

* Throw 403 if file is hidden * Add Helpful GUI message for hidden files * Fetch file contents if hidden file * Show hidden file in widget * Format gitignore file * Show hidden file message when adding file to .gitignore * Add ability to save .gitignore * Fix bug where you can open two .gitignore files * Add option to hide hidden file warning * Fix PR requests for gitignore bug * Fix prettier styles for gitignore * Improve translation * Improve gitignore model and add hiddenFile option to schema * Fix eslint * Fix .gitignore content sending --------- Co-authored-by: Frédéric Collonval <[email protected]> (cherry picked from commit 23fa764)

* Load gitignore file (#1273) * Throw 403 if file is hidden * Add Helpful GUI message for hidden files * Fetch file contents if hidden file * Show hidden file in widget * Format gitignore file * Show hidden file message when adding file to .gitignore * Add ability to save .gitignore * Fix bug where you can open two .gitignore files * Add option to hide hidden file warning * Fix PR requests for gitignore bug * Fix prettier styles for gitignore * Improve translation * Improve gitignore model and add hiddenFile option to schema * Fix eslint * Fix .gitignore content sending --------- Co-authored-by: Frédéric Collonval <[email protected]> (cherry picked from commit 23fa764) * Fix tests --------- Co-authored-by: Kentaro Lim <[email protected]>

Throw 403 if file is hidden

ed1c9d2

Add Helpful GUI message for hidden files

972e6dc

kentarolim10 changed the title ~~[Draft] Load gitignore file~~ Load gitignore file Oct 11, 2023

kentarolim10 added 6 commits October 18, 2023 07:28

Fetch file contents if hidden file

939e9cb

Show hidden file in widget

37e6ee3

Format gitignore file

335a43a

Show hidden file message when adding file to .gitignore

adc74aa

Add ability to save .gitignore

eb6abf2

Fix bug where you can open two .gitignore files

8eb7021

fcollonval changed the base branch from main to jlab-3 October 24, 2023 13:31

Add option to hide hidden file warning

6eac31d

fcollonval requested changes Oct 26, 2023

View reviewed changes

kentarolim10 and others added 3 commits October 30, 2023 10:10

Fix PR requests for gitignore bug

a09953d

Fix prettier styles for gitignore

8a51328

Improve translation

e6c1e9b

fcollonval requested changes Nov 8, 2023

View reviewed changes

kentarolim10 added 3 commits November 9, 2023 14:28

Improve gitignore model and add hiddenFile option to schema

7c73b8c

Merge branch 'gitignore-wont-open-if-file-hidden' of https://github.c…

df62ed6

…om/kentarolim10/jupyterlab-git into gitignore-wont-open-if-file-hidden

Fix eslint

14950b7

Fix .gitignore content sending

78fe0c5

fcollonval approved these changes Nov 15, 2023

View reviewed changes

fcollonval merged commit 23fa764 into jupyterlab:jlab-3 Nov 15, 2023
8 checks passed

lumberbot-app bot added the Still Needs Manual Backport label Nov 15, 2023

allcontributors bot mentioned this pull request Nov 15, 2023

add kentarolim10 as a contributor for code #1297

Merged

fcollonval mentioned this pull request Nov 16, 2023

Load gitignore file (#1273) #1298

Merged

fcollonval removed the Still Needs Manual Backport label Nov 16, 2023

fcollonval mentioned this pull request Nov 16, 2023

File Load Error for .gitignore #1168

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load gitignore file #1273

Load gitignore file #1273

kentarolim10 commented Oct 6, 2023 •

edited

Loading

welcome bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

fcollonval commented Oct 24, 2023

kentarolim10 commented Oct 24, 2023 via email

fcollonval left a comment

fcollonval Oct 25, 2023

kentarolim10 Oct 26, 2023

fcollonval Oct 25, 2023

fcollonval Oct 25, 2023

fcollonval Oct 25, 2023

fcollonval Oct 26, 2023

fcollonval Oct 26, 2023

fcollonval Oct 26, 2023

fcollonval Oct 26, 2023

fcollonval Oct 26, 2023

fcollonval left a comment

fcollonval Nov 8, 2023

fcollonval commented Nov 10, 2023

fcollonval left a comment

welcome bot commented Nov 15, 2023

fcollonval commented Nov 15, 2023

lumberbot-app bot commented Nov 15, 2023

fcollonval commented Nov 15, 2023

allcontributors bot commented Nov 15, 2023

		@@ -1681,6 +1681,22 @@ async def remote_remove(self, path, name):

		return response

		async def read_file(self, path):

	async def writeGitignore(self, path, content):
	async def write_gitignore(self, path, content):

	const preview = new PreviewMainAreaWidget({
	const preview = new MainAreaWidget({

Load gitignore file #1273

Load gitignore file #1273

Conversation

kentarolim10 commented Oct 6, 2023 • edited Loading

Description

welcome bot commented Oct 6, 2023

github-actions bot commented Oct 6, 2023

fcollonval commented Oct 24, 2023

kentarolim10 commented Oct 24, 2023 via email

fcollonval left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcollonval left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcollonval commented Nov 10, 2023

fcollonval left a comment

Choose a reason for hiding this comment

welcome bot commented Nov 15, 2023

fcollonval commented Nov 15, 2023

lumberbot-app bot commented Nov 15, 2023

fcollonval commented Nov 15, 2023

allcontributors bot commented Nov 15, 2023

kentarolim10 commented Oct 6, 2023 •

edited

Loading