{
16 | return {
17 | autoClose: false,
18 | actions: [
19 | {
20 | label: trans.__('Show'),
21 | callback: () => {
22 | showErrorMessage(
23 | trans.__('Error'),
24 | {
25 | // Render error in a element to preserve line breaks and
26 | // use a monospace font so e.g. pre-commit errors are readable.
27 | // Ref: https://github.com/jupyterlab/jupyterlab-git/issues/1407
28 | message: (
29 |
30 | {error.message || error.stack || String(error)}
31 |
32 | )
33 | },
34 | [Dialog.warnButton({ label: trans.__('Dismiss') })]
35 | );
36 | },
37 | displayType: 'warn'
38 | } as Notification.IAction
39 | ]
40 | };
41 | }
42 |
43 | /**
44 | * Display additional information in a dialog from a notification
45 | * button.
46 | *
47 | * Note: it will not add a button if the message is empty.
48 | *
49 | * @param message Details to display
50 | * @param trans Translation object
51 | * @returns Notification option to display the message
52 | */
53 | export function showDetails(
54 | message: string,
55 | trans: TranslationBundle
56 | ): Notification.IOptions {
57 | return message
58 | ? {
59 | autoClose: 5000,
60 | actions: [
61 | {
62 | label: trans.__('Details'),
63 | callback: () => {
64 | showErrorMessage(trans.__('Detailed message'), message, [
65 | Dialog.okButton({ label: trans.__('Dismiss') })
66 | ]);
67 | },
68 | displayType: 'warn'
69 | } as Notification.IAction
70 | ]
71 | }
72 | : {};
73 | }
74 |
--------------------------------------------------------------------------------
/src/style/SinglePastCommitInfo.ts:
--------------------------------------------------------------------------------
1 | import { style } from 'typestyle';
2 |
3 | export const commitClass = style({
4 | flex: '0 0 auto',
5 | width: '100%',
6 | fontSize: '12px',
7 | marginBottom: '10px',
8 | marginTop: '5px',
9 | paddingTop: '5px'
10 | });
11 |
12 | export const commitOverviewNumbersClass = style({
13 | fontSize: '13px',
14 | fontWeight: 'bold',
15 | paddingTop: '5px',
16 | $nest: {
17 | '& span': {
18 | alignItems: 'center',
19 | display: 'inline-flex',
20 | marginLeft: '5px'
21 | },
22 | '& span:nth-of-type(1)': {
23 | marginLeft: '0px'
24 | }
25 | }
26 | });
27 |
28 | export const commitDetailClass = style({
29 | flex: '1 1 auto',
30 | margin: '0'
31 | });
32 |
33 | export const commitDetailHeaderClass = style({
34 | paddingBottom: '0.5em',
35 | fontSize: '13px',
36 | fontWeight: 'bold'
37 | });
38 |
39 | export const commitDetailFileClass = style({
40 | userSelect: 'none',
41 | display: 'flex',
42 | flexDirection: 'row',
43 | alignItems: 'center',
44 | color: 'var(--jp-ui-font-color1)',
45 | height: 'var(--jp-private-running-item-height)',
46 | lineHeight: 'var(--jp-private-running-item-height)',
47 | whiteSpace: 'nowrap',
48 |
49 | overflow: 'hidden',
50 |
51 | $nest: {
52 | '&:hover': {
53 | backgroundColor: 'var(--jp-layout-color2)'
54 | },
55 | '&:active': {
56 | backgroundColor: 'var(--jp-layout-color3)'
57 | }
58 | }
59 | });
60 |
61 | export const iconClass = style({
62 | display: 'inline-block',
63 | width: '13px',
64 | height: '13px',
65 | right: '10px'
66 | });
67 |
68 | export const insertionsIconClass = style({
69 | $nest: {
70 | '.jp-icon3': {
71 | fill: 'var(--md-green-500)'
72 | }
73 | }
74 | });
75 |
76 | export const deletionsIconClass = style({
77 | $nest: {
78 | '.jp-icon3': {
79 | fill: 'var(--md-red-500)'
80 | }
81 | }
82 | });
83 |
84 | export const fileListClass = style({
85 | $nest: {
86 | ul: {
87 | paddingLeft: 0,
88 | margin: 0
89 | }
90 | }
91 | });
92 |
93 | export const actionButtonClass = style({
94 | float: 'right'
95 | });
96 |
97 | export const commitBodyClass = style({
98 | paddingTop: '5px',
99 | whiteSpace: 'pre-wrap',
100 | wordWrap: 'break-word',
101 | margin: '0'
102 | });
103 |
--------------------------------------------------------------------------------
/ui-tests/tests/commit-diff.spec.ts:
--------------------------------------------------------------------------------
1 | import { expect, test } from '@jupyterlab/galata';
2 | import path from 'path';
3 | import { extractFile } from './utils';
4 |
5 | const baseRepositoryPath = 'test-repository.tar.gz';
6 | test.use({ autoGoto: false });
7 |
8 | test.describe('Commits diff', () => {
9 | test.beforeEach(async ({ page, request, tmpPath }) => {
10 | await extractFile(
11 | request,
12 | path.resolve(__dirname, 'data', baseRepositoryPath),
13 | path.join(tmpPath, 'repository.tar.gz')
14 | );
15 |
16 | // URL for merge conflict example repository
17 | await page.goto(`tree/${tmpPath}/test-repository`);
18 | });
19 |
20 | test('should display commits diff from history', async ({ page }) => {
21 | await page.sidebar.openTab('jp-git-sessions');
22 | await page.click('button:has-text("History")');
23 | const commits = page.locator('li[title="View commit details"]');
24 |
25 | expect(await commits.count()).toBeGreaterThanOrEqual(2);
26 |
27 | await commits.last().locator('button[title="Select for compare"]').click();
28 |
29 | expect(
30 | await page.waitForSelector('text=No challenger commit selected.')
31 | ).toBeTruthy();
32 | await commits
33 | .first()
34 | .locator('button[title="Compare with selected"]')
35 | .click();
36 |
37 | expect(await page.waitForSelector('text=Changed')).toBeTruthy();
38 | });
39 |
40 | test('should display diff from single file history', async ({ page }) => {
41 | await page.sidebar.openTab('filebrowser');
42 | await page.getByText('example.ipynb').click({
43 | button: 'right'
44 | });
45 | await page.getByRole('menu').getByText('Git').hover();
46 | await page.click('#jp-contextmenu-git >> text=History');
47 |
48 | await page.waitForSelector('#jp-git-sessions >> ol >> text=example.ipynb');
49 |
50 | const commits = page.locator('li[title="View file changes"]');
51 |
52 | expect(await commits.count()).toBeGreaterThanOrEqual(2);
53 |
54 | await commits.last().locator('button[title="Select for compare"]').click();
55 | await commits
56 | .first()
57 | .locator('button[title="Compare with selected"]')
58 | .click();
59 |
60 | await expect(
61 | page.locator('.nbdime-Widget >> .jp-git-diff-banner')
62 | ).toHaveText(
63 | /79fe96219f6eaec1ae607c7c8d21d5b269a6dd29[\n\s]+51fe1f8995113884e943201341a5d5b7a1393e24/
64 | );
65 | });
66 | });
67 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/files/multilevel-test-base.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": 1,
6 | "metadata": {
7 | "collapsed": true
8 | },
9 | "outputs": [],
10 | "source": [
11 | "def f(x):\n",
12 | " return x**2"
13 | ]
14 | },
15 | {
16 | "cell_type": "code",
17 | "execution_count": 2,
18 | "metadata": {
19 | "collapsed": true
20 | },
21 | "outputs": [],
22 | "source": [
23 | "x = 3"
24 | ]
25 | },
26 | {
27 | "cell_type": "code",
28 | "execution_count": 3,
29 | "metadata": {
30 | "collapsed": false
31 | },
32 | "outputs": [
33 | {
34 | "data": {
35 | "text/plain": [
36 | "9"
37 | ]
38 | },
39 | "execution_count": 3,
40 | "metadata": {},
41 | "output_type": "execute_result"
42 | }
43 | ],
44 | "source": [
45 | "f(x)"
46 | ]
47 | },
48 | {
49 | "cell_type": "code",
50 | "execution_count": 4,
51 | "metadata": {
52 | "collapsed": true
53 | },
54 | "outputs": [],
55 | "source": [
56 | "x = 3"
57 | ]
58 | },
59 | {
60 | "cell_type": "code",
61 | "execution_count": 5,
62 | "metadata": {
63 | "collapsed": false
64 | },
65 | "outputs": [
66 | {
67 | "data": {
68 | "text/plain": [
69 | "9"
70 | ]
71 | },
72 | "execution_count": 5,
73 | "metadata": {},
74 | "output_type": "execute_result"
75 | }
76 | ],
77 | "source": [
78 | "f(x)"
79 | ]
80 | },
81 | {
82 | "cell_type": "code",
83 | "execution_count": null,
84 | "metadata": {
85 | "collapsed": true
86 | },
87 | "outputs": [],
88 | "source": []
89 | }
90 | ],
91 | "metadata": {
92 | "kernelspec": {
93 | "display_name": "Python 2",
94 | "language": "python",
95 | "name": "python2"
96 | },
97 | "language_info": {
98 | "codemirror_mode": {
99 | "name": "ipython",
100 | "version": 2
101 | },
102 | "file_extension": ".py",
103 | "mimetype": "text/x-python",
104 | "name": "python",
105 | "nbconvert_exporter": "python",
106 | "pygments_lexer": "ipython2",
107 | "version": "2.7.11"
108 | }
109 | },
110 | "nbformat": 4,
111 | "nbformat_minor": 0
112 | }
113 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/files/multilevel-test-local.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": 1,
6 | "metadata": {
7 | "collapsed": true
8 | },
9 | "outputs": [],
10 | "source": [
11 | "def f(x):\n",
12 | " return x**2"
13 | ]
14 | },
15 | {
16 | "cell_type": "code",
17 | "execution_count": 2,
18 | "metadata": {
19 | "collapsed": true
20 | },
21 | "outputs": [],
22 | "source": [
23 | "x = 5"
24 | ]
25 | },
26 | {
27 | "cell_type": "code",
28 | "execution_count": 3,
29 | "metadata": {
30 | "collapsed": false
31 | },
32 | "outputs": [
33 | {
34 | "data": {
35 | "text/plain": [
36 | "25"
37 | ]
38 | },
39 | "execution_count": 3,
40 | "metadata": {},
41 | "output_type": "execute_result"
42 | }
43 | ],
44 | "source": [
45 | "f(x)"
46 | ]
47 | },
48 | {
49 | "cell_type": "code",
50 | "execution_count": 4,
51 | "metadata": {
52 | "collapsed": true
53 | },
54 | "outputs": [],
55 | "source": [
56 | "x = 3"
57 | ]
58 | },
59 | {
60 | "cell_type": "code",
61 | "execution_count": 5,
62 | "metadata": {
63 | "collapsed": false
64 | },
65 | "outputs": [
66 | {
67 | "data": {
68 | "text/plain": [
69 | "9"
70 | ]
71 | },
72 | "execution_count": 5,
73 | "metadata": {},
74 | "output_type": "execute_result"
75 | }
76 | ],
77 | "source": [
78 | "f(x)"
79 | ]
80 | },
81 | {
82 | "cell_type": "code",
83 | "execution_count": null,
84 | "metadata": {
85 | "collapsed": true
86 | },
87 | "outputs": [],
88 | "source": []
89 | }
90 | ],
91 | "metadata": {
92 | "kernelspec": {
93 | "display_name": "Python 2",
94 | "language": "python",
95 | "name": "python2"
96 | },
97 | "language_info": {
98 | "codemirror_mode": {
99 | "name": "ipython",
100 | "version": 2
101 | },
102 | "file_extension": ".py",
103 | "mimetype": "text/x-python",
104 | "name": "python",
105 | "nbconvert_exporter": "python",
106 | "pygments_lexer": "ipython2",
107 | "version": "2.7.11"
108 | }
109 | },
110 | "nbformat": 4,
111 | "nbformat_minor": 0
112 | }
113 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/files/multilevel-test-remote.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": 1,
6 | "metadata": {
7 | "collapsed": true
8 | },
9 | "outputs": [],
10 | "source": [
11 | "def f(x):\n",
12 | " return x**2"
13 | ]
14 | },
15 | {
16 | "cell_type": "code",
17 | "execution_count": 2,
18 | "metadata": {
19 | "collapsed": true
20 | },
21 | "outputs": [],
22 | "source": [
23 | "x = 3"
24 | ]
25 | },
26 | {
27 | "cell_type": "code",
28 | "execution_count": 3,
29 | "metadata": {
30 | "collapsed": false
31 | },
32 | "outputs": [
33 | {
34 | "data": {
35 | "text/plain": [
36 | "9"
37 | ]
38 | },
39 | "execution_count": 3,
40 | "metadata": {},
41 | "output_type": "execute_result"
42 | }
43 | ],
44 | "source": [
45 | "f(x)"
46 | ]
47 | },
48 | {
49 | "cell_type": "code",
50 | "execution_count": 4,
51 | "metadata": {
52 | "collapsed": true
53 | },
54 | "outputs": [],
55 | "source": [
56 | "x = 7"
57 | ]
58 | },
59 | {
60 | "cell_type": "code",
61 | "execution_count": 5,
62 | "metadata": {
63 | "collapsed": false
64 | },
65 | "outputs": [
66 | {
67 | "data": {
68 | "text/plain": [
69 | "49"
70 | ]
71 | },
72 | "execution_count": 5,
73 | "metadata": {},
74 | "output_type": "execute_result"
75 | }
76 | ],
77 | "source": [
78 | "f(x)"
79 | ]
80 | },
81 | {
82 | "cell_type": "code",
83 | "execution_count": null,
84 | "metadata": {
85 | "collapsed": true
86 | },
87 | "outputs": [],
88 | "source": []
89 | }
90 | ],
91 | "metadata": {
92 | "kernelspec": {
93 | "display_name": "Python 2",
94 | "language": "python",
95 | "name": "python2"
96 | },
97 | "language_info": {
98 | "codemirror_mode": {
99 | "name": "ipython",
100 | "version": 2
101 | },
102 | "file_extension": ".py",
103 | "mimetype": "text/x-python",
104 | "name": "python",
105 | "nbconvert_exporter": "python",
106 | "pygments_lexer": "ipython2",
107 | "version": "2.7.11"
108 | }
109 | },
110 | "nbformat": 4,
111 | "nbformat_minor": 0
112 | }
113 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.bundle.*
2 | lib/
3 | node_modules/
4 | *.log
5 | .eslintcache
6 | .stylelintcache
7 | *.egg-info/
8 | .ipynb_checkpoints
9 | *.tsbuildinfo
10 | jupyterlab_git/labextension
11 | # Version file is handled by hatchling
12 | jupyterlab_git/_version.py
13 | src/version.ts
14 |
15 | # Integration tests
16 | ui-tests/test-results/
17 | ui-tests/playwright-report/
18 |
19 | # Created by https://www.gitignore.io/api/python
20 | # Edit at https://www.gitignore.io/?templates=python
21 |
22 | ### Python ###
23 | # Byte-compiled / optimized / DLL files
24 | __pycache__/
25 | *.py[cod]
26 | *$py.class
27 |
28 | # C extensions
29 | *.so
30 |
31 | # Distribution / packaging
32 | .Python
33 | build/
34 | develop-eggs/
35 | dist/
36 | downloads/
37 | eggs/
38 | .eggs/
39 | lib/
40 | lib64/
41 | parts/
42 | sdist/
43 | var/
44 | wheels/
45 | pip-wheel-metadata/
46 | share/python-wheels/
47 | .installed.cfg
48 | *.egg
49 | MANIFEST
50 |
51 | # PyInstaller
52 | # Usually these files are written by a python script from a template
53 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
54 | *.manifest
55 | *.spec
56 |
57 | # Installer logs
58 | pip-log.txt
59 | pip-delete-this-directory.txt
60 |
61 | # Unit test / coverage reports
62 | htmlcov/
63 | .tox/
64 | .nox/
65 | .coverage
66 | .coverage.*
67 | .cache
68 | nosetests.xml
69 | coverage/
70 | coverage.xml
71 | *.cover
72 | .hypothesis/
73 | .pytest_cache/
74 |
75 | # Translations
76 | *.mo
77 | *.pot
78 |
79 | # Scrapy stuff:
80 | .scrapy
81 |
82 | # Sphinx documentation
83 | docs/_build/
84 |
85 | # PyBuilder
86 | target/
87 |
88 | # pyenv
89 | .python-version
90 |
91 | # celery beat schedule file
92 | celerybeat-schedule
93 |
94 | # SageMath parsed files
95 | *.sage.py
96 |
97 | # Spyder project settings
98 | .spyderproject
99 | .spyproject
100 |
101 | # Rope project settings
102 | .ropeproject
103 |
104 | # Mr Developer
105 | .mr.developer.cfg
106 | .project
107 | .pydevproject
108 |
109 | # mkdocs documentation
110 | /site
111 |
112 | # mypy
113 | .mypy_cache/
114 | .dmypy.json
115 | dmypy.json
116 |
117 | # Pyre type checker
118 | .pyre/
119 |
120 | # End of https://www.gitignore.io/api/python
121 |
122 | # OSX files
123 | .DS_Store
124 |
125 | # Yarn cache
126 | .yarn/
127 |
128 | # JetBrains IDE stuff
129 | *.iml
130 | .idea/
131 |
132 | # vscode ide stuff
133 | *.code-workspace
134 | .history
135 | .vscode
136 |
137 | # vim stuff
138 | *.swp
139 |
140 | # virtual env
141 | venv/
142 |
--------------------------------------------------------------------------------
/src/git.ts:
--------------------------------------------------------------------------------
1 | import { URLExt } from '@jupyterlab/coreutils';
2 | import { ServerConnection } from '@jupyterlab/services';
3 | import { ReadonlyJSONObject } from '@lumino/coreutils';
4 | import { Git } from './tokens';
5 |
6 | /**
7 | * Array of Git Auth Error Messages
8 | */
9 | export const AUTH_ERROR_MESSAGES = [
10 | 'Invalid username or password',
11 | 'could not read Username',
12 | 'could not read Password',
13 | 'Authentication error'
14 | ];
15 |
16 | /**
17 | * Call the API extension
18 | *
19 | * @param endPoint API REST end point for the extension; default ''
20 | * @param method HTML method; default 'GET'
21 | * @param body JSON object to be passed as body or null; default null
22 | * @param namespace API namespace; default 'git'
23 | * @param serverSettings Optional server connection settings; if not provided, uses ServerConnection.makeSettings()
24 | * @returns The response body interpreted as JSON
25 | *
26 | * @throws {Git.GitResponseError} If the server response is not ok
27 | * @throws {ServerConnection.NetworkError} If the request cannot be made
28 | */
29 | export async function requestAPI(
30 | endPoint = '',
31 | method = 'GET',
32 | body: Partial | null = null,
33 | namespace = 'git',
34 | serverSettings?: ServerConnection.ISettings
35 | ): Promise {
36 | // Make request to Jupyter API
37 | const settings = serverSettings ?? ServerConnection.makeSettings();
38 | const requestUrl = URLExt.join(
39 | settings.baseUrl,
40 | namespace, // API Namespace
41 | endPoint
42 | );
43 |
44 | const init: RequestInit = {
45 | method,
46 | body: body ? JSON.stringify(body) : undefined
47 | };
48 |
49 | let response: Response;
50 | try {
51 | response = await ServerConnection.makeRequest(requestUrl, init, settings);
52 | } catch (error: any) {
53 | throw new ServerConnection.NetworkError(error);
54 | }
55 |
56 | let data: any = await response.text();
57 | let isJSON = false;
58 | if (data.length > 0) {
59 | try {
60 | data = JSON.parse(data);
61 | isJSON = true;
62 | } catch (error) {
63 | console.log('Not a JSON response body.', response);
64 | }
65 | }
66 |
67 | if (!response.ok) {
68 | if (isJSON) {
69 | const { message, traceback, ...json } = data;
70 | throw new Git.GitResponseError(
71 | response,
72 | message ||
73 | `Invalid response: ${response.status} ${response.statusText}`,
74 | traceback || '',
75 | json
76 | );
77 | } else {
78 | throw new Git.GitResponseError(response, data);
79 | }
80 | }
81 |
82 | return data;
83 | }
84 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/files/src-and-output--1.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "markdown",
5 | "metadata": {},
6 | "source": [
7 | "### This notebook contains cells that have identical source or output, a notebook-specific challenge for the diff algorithm"
8 | ]
9 | },
10 | {
11 | "cell_type": "code",
12 | "execution_count": 1,
13 | "metadata": {
14 | "collapsed": true
15 | },
16 | "outputs": [],
17 | "source": [
18 | "x = 3"
19 | ]
20 | },
21 | {
22 | "cell_type": "code",
23 | "execution_count": 2,
24 | "metadata": {
25 | "collapsed": false
26 | },
27 | "outputs": [
28 | {
29 | "data": {
30 | "text/plain": [
31 | "3"
32 | ]
33 | },
34 | "execution_count": 2,
35 | "metadata": {},
36 | "output_type": "execute_result"
37 | }
38 | ],
39 | "source": [
40 | "x"
41 | ]
42 | },
43 | {
44 | "cell_type": "code",
45 | "execution_count": null,
46 | "metadata": {
47 | "collapsed": false
48 | },
49 | "outputs": [],
50 | "source": [
51 | "x"
52 | ]
53 | },
54 | {
55 | "cell_type": "code",
56 | "execution_count": 3,
57 | "metadata": {
58 | "collapsed": true
59 | },
60 | "outputs": [],
61 | "source": [
62 | "x = 5"
63 | ]
64 | },
65 | {
66 | "cell_type": "code",
67 | "execution_count": null,
68 | "metadata": {
69 | "collapsed": false
70 | },
71 | "outputs": [],
72 | "source": [
73 | "x"
74 | ]
75 | },
76 | {
77 | "cell_type": "code",
78 | "execution_count": 4,
79 | "metadata": {
80 | "collapsed": false
81 | },
82 | "outputs": [
83 | {
84 | "data": {
85 | "text/plain": [
86 | "5"
87 | ]
88 | },
89 | "execution_count": 4,
90 | "metadata": {},
91 | "output_type": "execute_result"
92 | }
93 | ],
94 | "source": [
95 | "x"
96 | ]
97 | }
98 | ],
99 | "metadata": {
100 | "kernelspec": {
101 | "display_name": "Python 2",
102 | "language": "python",
103 | "name": "python2"
104 | },
105 | "language_info": {
106 | "codemirror_mode": {
107 | "name": "ipython",
108 | "version": 2
109 | },
110 | "file_extension": ".py",
111 | "mimetype": "text/x-python",
112 | "name": "python",
113 | "nbconvert_exporter": "python",
114 | "pygments_lexer": "ipython2",
115 | "version": "2.7.11"
116 | }
117 | },
118 | "nbformat": 4,
119 | "nbformat_minor": 0
120 | }
121 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/files/src-and-output--2.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "markdown",
5 | "metadata": {},
6 | "source": [
7 | "### This notebook contains cells that have identical source or output, a notebook-specific challenge for the diff algorithm"
8 | ]
9 | },
10 | {
11 | "cell_type": "code",
12 | "execution_count": 1,
13 | "metadata": {
14 | "collapsed": true
15 | },
16 | "outputs": [],
17 | "source": [
18 | "x = 3"
19 | ]
20 | },
21 | {
22 | "cell_type": "code",
23 | "execution_count": null,
24 | "metadata": {
25 | "collapsed": false
26 | },
27 | "outputs": [],
28 | "source": [
29 | "x"
30 | ]
31 | },
32 | {
33 | "cell_type": "code",
34 | "execution_count": 2,
35 | "metadata": {
36 | "collapsed": false
37 | },
38 | "outputs": [
39 | {
40 | "data": {
41 | "text/plain": [
42 | "3"
43 | ]
44 | },
45 | "execution_count": 2,
46 | "metadata": {},
47 | "output_type": "execute_result"
48 | }
49 | ],
50 | "source": [
51 | "x"
52 | ]
53 | },
54 | {
55 | "cell_type": "code",
56 | "execution_count": 3,
57 | "metadata": {
58 | "collapsed": true
59 | },
60 | "outputs": [],
61 | "source": [
62 | "x = 5"
63 | ]
64 | },
65 | {
66 | "cell_type": "code",
67 | "execution_count": 4,
68 | "metadata": {
69 | "collapsed": false
70 | },
71 | "outputs": [
72 | {
73 | "data": {
74 | "text/plain": [
75 | "5"
76 | ]
77 | },
78 | "execution_count": 4,
79 | "metadata": {},
80 | "output_type": "execute_result"
81 | }
82 | ],
83 | "source": [
84 | "x"
85 | ]
86 | },
87 | {
88 | "cell_type": "code",
89 | "execution_count": null,
90 | "metadata": {
91 | "collapsed": false
92 | },
93 | "outputs": [],
94 | "source": [
95 | "x"
96 | ]
97 | }
98 | ],
99 | "metadata": {
100 | "kernelspec": {
101 | "display_name": "Python 2",
102 | "language": "python",
103 | "name": "python2"
104 | },
105 | "language_info": {
106 | "codemirror_mode": {
107 | "name": "ipython",
108 | "version": 2
109 | },
110 | "file_extension": ".py",
111 | "mimetype": "text/x-python",
112 | "name": "python",
113 | "nbconvert_exporter": "python",
114 | "pygments_lexer": "ipython2",
115 | "version": "2.7.11"
116 | }
117 | },
118 | "nbformat": 4,
119 | "nbformat_minor": 0
120 | }
121 |
--------------------------------------------------------------------------------
/src/widgets/GitWidget.tsx:
--------------------------------------------------------------------------------
1 | import { ReactWidget } from '@jupyterlab/apputils';
2 | import { FileBrowserModel } from '@jupyterlab/filebrowser';
3 | import { ISettingRegistry } from '@jupyterlab/settingregistry';
4 | import { TranslationBundle } from '@jupyterlab/translation';
5 | import { CommandRegistry } from '@lumino/commands';
6 | import { Message } from '@lumino/messaging';
7 | import { Widget } from '@lumino/widgets';
8 | import * as React from 'react';
9 | import { GitPanel } from '../components/GitPanel';
10 | import { GitExtension } from '../model';
11 | import { gitWidgetStyle } from '../style/GitWidgetStyle';
12 |
13 | /**
14 | * A class that exposes the git plugin Widget.
15 | */
16 | export class GitWidget extends ReactWidget {
17 | constructor(
18 | model: GitExtension,
19 | settings: ISettingRegistry.ISettings,
20 | commands: CommandRegistry,
21 | fileBrowserModel: FileBrowserModel,
22 | trans: TranslationBundle,
23 | options?: Widget.IOptions
24 | ) {
25 | super();
26 | this.node.id = 'GitSession-root';
27 | this.addClass(gitWidgetStyle);
28 |
29 | this._trans = trans;
30 | this._commands = commands;
31 | this._fileBrowserModel = fileBrowserModel;
32 | this._model = model;
33 | this._settings = settings;
34 |
35 | // Add refresh standby condition if this widget is hidden
36 | model.refreshStandbyCondition = (): boolean =>
37 | !this._settings.composite['refreshIfHidden'] && this.isHidden;
38 | }
39 |
40 | /**
41 | * A message handler invoked on a `'before-show'` message.
42 | *
43 | * #### Notes
44 | * The default implementation of this handler is a no-op.
45 | */
46 | onBeforeShow(msg: Message): void {
47 | // Trigger refresh when the widget is displayed
48 | this._model.refresh().catch(error => {
49 | console.error('Fail to refresh model when displaying GitWidget.', error);
50 | });
51 | super.onBeforeShow(msg);
52 | }
53 |
54 | /**
55 | * Render the content of this widget using the virtual DOM.
56 | *
57 | * This method will be called anytime the widget needs to be rendered, which
58 | * includes layout triggered rendering.
59 | */
60 | render(): JSX.Element {
61 | return (
62 |
69 | );
70 | }
71 |
72 | private _commands: CommandRegistry;
73 | private _fileBrowserModel: FileBrowserModel;
74 | private _model: GitExtension;
75 | private _settings: ISettingRegistry.ISettings;
76 | private _trans: TranslationBundle;
77 | }
78 |
--------------------------------------------------------------------------------
/jupyterlab_git/__init__.py:
--------------------------------------------------------------------------------
1 | """Initialize the backend server extension"""
2 |
3 | from traitlets import CFloat, List, Dict, Unicode, default
4 | from traitlets.config import Configurable
5 |
6 | try:
7 | from ._version import __version__
8 | except:
9 | import warnings
10 |
11 | warnings.warn(
12 | "Did you forget to install the extension in editable mode `pip install -e .`?"
13 | )
14 | __version__ = "dev"
15 | from .handlers import setup_handlers
16 | from .git import Git
17 |
18 |
19 | def _jupyter_labextension_paths():
20 | return [{"src": "labextension", "dest": "@jupyterlab/git"}]
21 |
22 |
23 | class JupyterLabGit(Configurable):
24 | """
25 | Config options for jupyterlab_git
26 |
27 | Modeled after: https://github.com/jupyter/jupyter_server/blob/9dd2a9a114c045cfd8fd8748400c6a697041f7fa/jupyter_server/serverapp.py#L1040
28 | """
29 |
30 | actions = Dict(
31 | help="Actions to be taken after a git command. Each action takes a list of commands to execute (strings). Supported actions: post_init",
32 | config=True,
33 | value_trait=List(
34 | trait=Unicode(), help='List of commands to run. E.g. ["touch baz.py"]'
35 | ),
36 | # TODO Validate
37 | )
38 |
39 | excluded_paths = List(help="Paths to be excluded", config=True, trait=Unicode())
40 |
41 | credential_helper = Unicode(
42 | help="""
43 | The value of Git credential helper will be set to this value when the Git credential caching mechanism is activated by this extension.
44 | By default it is an in-memory cache of 3600 seconds (1 hour); `cache --timeout=3600`.
45 | """,
46 | config=True,
47 | )
48 |
49 | git_command_timeout = CFloat(
50 | help="The timeout for executing git operations. By default it is set to 20 seconds.",
51 | config=True,
52 | )
53 |
54 | @default("credential_helper")
55 | def _credential_helper_default(self):
56 | return "cache --timeout=3600"
57 |
58 | @default("git_command_timeout")
59 | def _git_command_timeout_default(self):
60 | return 20.0
61 |
62 |
63 | def _jupyter_server_extension_points():
64 | return [{"module": "jupyterlab_git"}]
65 |
66 |
67 | def _load_jupyter_server_extension(server_app):
68 | """Registers the API handler to receive HTTP requests from the frontend extension.
69 |
70 | Parameters
71 | ----------
72 | server_app: jupyterlab.labapp.LabApp
73 | JupyterLab application instance
74 | """
75 | config = JupyterLabGit(config=server_app.config)
76 | server_app.web_app.settings["git"] = Git(config)
77 | setup_handlers(server_app.web_app)
78 |
79 |
80 | # For backward compatibility
81 | load_jupyter_server_extension = _load_jupyter_server_extension
82 |
--------------------------------------------------------------------------------
/ui-tests/tests/add-tag.spec.ts:
--------------------------------------------------------------------------------
1 | import { expect, galata, test } from '@jupyterlab/galata';
2 | import path from 'path';
3 | import { extractFile } from './utils';
4 |
5 | const baseRepositoryPath = 'test-repository-dirty.tar.gz';
6 | test.use({ autoGoto: false, mockSettings: galata.DEFAULT_SETTINGS });
7 |
8 | test.describe('Add tag', () => {
9 | test.beforeEach(async ({ page, request, tmpPath }) => {
10 | await extractFile(
11 | request,
12 | path.resolve(__dirname, 'data', baseRepositoryPath),
13 | path.join(tmpPath, 'repository.tar.gz')
14 | );
15 |
16 | // URL for merge conflict example repository
17 | await page.goto(`tree/${tmpPath}/test-repository`);
18 |
19 | await page.sidebar.openTab('jp-git-sessions');
20 | });
21 |
22 | test('should show Add Tag command on commit from history sidebar', async ({
23 | page
24 | }) => {
25 | await page.click('button:has-text("History")');
26 |
27 | const commits = page.locator('li[title="View commit details"]');
28 |
29 | expect(await commits.count()).toBeGreaterThanOrEqual(2);
30 |
31 | // Right click the first commit to open the context menu, with the add tag command
32 | await page.getByText('master changes').click({ button: 'right' });
33 |
34 | expect(await page.getByRole('menuitem', { name: 'Add Tag' })).toBeTruthy();
35 | });
36 |
37 | test('should open new tag dialog box', async ({ page }) => {
38 | await page.click('button:has-text("History")');
39 |
40 | const commits = page.locator('li[title="View commit details"]');
41 |
42 | expect(await commits.count()).toBeGreaterThanOrEqual(2);
43 |
44 | // Right click the first commit to open the context menu, with the add tag command
45 | await page.getByText('master changes').click({ button: 'right' });
46 |
47 | // Click on the add tag command
48 | await page.getByRole('menuitem', { name: 'Add Tag' }).click();
49 |
50 | expect(page.getByText('Create a Tag')).toBeTruthy();
51 | });
52 |
53 | test('should create new tag pointing to selected commit', async ({
54 | page
55 | }) => {
56 | await page.click('button:has-text("History")');
57 |
58 | const commits = page.locator('li[title="View commit details"]');
59 | expect(await commits.count()).toBeGreaterThanOrEqual(2);
60 |
61 | // Right click the first commit to open the context menu, with the add tag command
62 | await page.getByText('master changes').click({ button: 'right' });
63 |
64 | // Click on the add tag command
65 | await page.getByRole('menuitem', { name: 'Add Tag' }).click();
66 |
67 | // Create a test tag
68 | await page.getByRole('textbox').fill('testTag');
69 | await page.getByRole('button', { name: 'Create Tag' }).click();
70 |
71 | expect(await page.getByText('testTag')).toBeTruthy();
72 | });
73 | });
74 |
--------------------------------------------------------------------------------
/testutils/jest-setup-files.js:
--------------------------------------------------------------------------------
1 | /* global globalThis */
2 | globalThis.DragEvent = class DragEvent {};
3 | if (
4 | typeof globalThis.TextDecoder === 'undefined' ||
5 | typeof globalThis.TextEncoder === 'undefined'
6 | ) {
7 | const util = require('util');
8 | globalThis.TextDecoder = util.TextDecoder;
9 | globalThis.TextEncoder = util.TextEncoder;
10 | }
11 | const fetchMod = (window.fetch = require('node-fetch'));
12 | window.Request = fetchMod.Request;
13 | window.Headers = fetchMod.Headers;
14 | window.Response = fetchMod.Response;
15 | globalThis.Image = window.Image;
16 | window.focus = () => {
17 | /* JSDom throws "Not Implemented" */
18 | };
19 | window.document.elementFromPoint = (left, top) => document.body;
20 | if (!window.hasOwnProperty('getSelection')) {
21 | // Minimal getSelection() that supports a fake selection
22 | window.getSelection = function getSelection() {
23 | return {
24 | _selection: '',
25 | selectAllChildren: () => {
26 | this._selection = 'foo';
27 | },
28 | toString: () => {
29 | const val = this._selection;
30 | this._selection = '';
31 | return val;
32 | }
33 | };
34 | };
35 | }
36 | // Used by xterm.js
37 | window.matchMedia = function (media) {
38 | return {
39 | matches: false,
40 | media,
41 | onchange: () => {
42 | /* empty */
43 | },
44 | addEventListener: () => {
45 | /* empty */
46 | },
47 | removeEventListener: () => {
48 | /* empty */
49 | },
50 | dispatchEvent: () => {
51 | return true;
52 | },
53 | addListener: () => {
54 | /* empty */
55 | },
56 | removeListener: () => {
57 | /* empty */
58 | }
59 | };
60 | };
61 | process.on('unhandledRejection', (error, promise) => {
62 | console.error('Unhandled promise rejection somewhere in tests');
63 | if (error) {
64 | console.error(error);
65 | const stack = error.stack;
66 | if (stack) {
67 | console.error(stack);
68 | }
69 | }
70 | promise.catch(err => console.error('promise rejected', err));
71 | });
72 | if (window.requestIdleCallback === undefined) {
73 | // On Safari, requestIdleCallback is not available, so we use replacement functions for `idleCallbacks`
74 | // See: https://developer.mozilla.org/en-US/docs/Web/API/Background_Tasks_API#falling_back_to_settimeout
75 | // eslint-disable-next-line @typescript-eslint/ban-types
76 | window.requestIdleCallback = function (handler) {
77 | let startTime = Date.now();
78 | return setTimeout(function () {
79 | handler({
80 | didTimeout: false,
81 | timeRemaining: function () {
82 | return Math.max(0, 50.0 - (Date.now() - startTime));
83 | }
84 | });
85 | }, 1);
86 | };
87 | window.cancelIdleCallback = function (id) {
88 | clearTimeout(id);
89 | };
90 | }
91 |
92 | globalThis.ResizeObserver = require('resize-observer-polyfill');
93 |
--------------------------------------------------------------------------------
/src/components/GitStage.tsx:
--------------------------------------------------------------------------------
1 | import { caretDownIcon, caretRightIcon } from '@jupyterlab/ui-components';
2 | import * as React from 'react';
3 | import { FixedSizeList, ListChildComponentProps } from 'react-window';
4 | import {
5 | changeStageButtonStyle,
6 | sectionAreaStyle,
7 | sectionFileContainerStyle,
8 | sectionHeaderLabelStyle,
9 | sectionHeaderSizeStyle
10 | } from '../style/GitStageStyle';
11 | import { Git } from '../tokens';
12 |
13 | const HEADER_HEIGHT = 34;
14 | const ITEM_HEIGHT = 25;
15 |
16 | /**
17 | * Git stage component properties
18 | */
19 | export interface IGitStageProps {
20 | /**
21 | * Actions component to display at the far right of the stage
22 | */
23 | actions?: React.ReactElement;
24 | /**
25 | * Is this group collapsible
26 | */
27 | collapsible?: boolean;
28 | /**
29 | * Files in the group
30 | */
31 | files: Git.IStatusFile[];
32 | /**
33 | * Group title
34 | */
35 | heading: string;
36 | /**
37 | * HTML element height
38 | */
39 | height: number;
40 | /**
41 | * Row renderer
42 | */
43 | rowRenderer: (props: ListChildComponentProps) => JSX.Element;
44 | /**
45 | * Optional select all element
46 | */
47 | selectAllButton?: React.ReactElement;
48 | }
49 |
50 | export const GitStage: React.FunctionComponent = (
51 | props: IGitStageProps
52 | ) => {
53 | const [showFiles, setShowFiles] = React.useState(true);
54 | const nFiles = props.files.length;
55 |
56 | return (
57 |
58 |
{
61 | if (props.collapsible && nFiles > 0) {
62 | setShowFiles(!showFiles);
63 | }
64 | }}
65 | >
66 | {props.selectAllButton && props.selectAllButton}
67 | {props.collapsible && (
68 |
75 | )}
76 | {props.heading}
77 | {props.actions}
78 | ({nFiles})
79 |
80 | {showFiles && nFiles > 0 && (
81 |
data[index].to}
89 | itemSize={ITEM_HEIGHT}
90 | style={{ overflowX: 'hidden' }}
91 | width={'auto'}
92 | >
93 | {props.rowRenderer}
94 |
95 | )}
96 |
Using PyPI trusted publisher (modern way)
73 |
74 | - Set up your PyPI project by [adding a trusted publisher](https://docs.pypi.org/trusted-publishers/adding-a-publisher/)
75 | - The _workflow name_ is `publish-release.yml` and the _environment_ should be left blank.
76 | - Ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.pypi.org/trusted-publishers/using-a-publisher/))
77 |
78 | {this._renderSubmoduleList()}
;
69 | }
70 |
71 | /**
72 | * Renders list of submodules.
73 | *
74 | * @returns React element
75 | */
76 | private _renderSubmoduleList(): React.ReactElement {
77 | const submodules = this.props.submodules;
78 |
79 | return (
80 | <>
81 | Submodules
82 | data[index].name}
90 | itemSize={ITEM_HEIGHT}
91 | style={{
92 | overflowX: 'hidden',
93 | paddingTop: 0,
94 | paddingBottom: 0
95 | }}
96 | width={'auto'}
97 | >
98 | {this._renderItem}
99 |
100 |
101 | );
102 | }
103 |
104 | /**
105 | * Renders a menu item.
106 | *
107 | * @param props Row properties
108 | * @returns React element
109 | */
110 | private _renderItem = (props: ListChildComponentProps): JSX.Element => {
111 | const { data, index, style } = props;
112 | const submodule = data[index] as Git.ISubmodule;
113 |
114 | return (
115 |
121 |
122 | {submodule.name}
123 |
124 | );
125 | };
126 | }
127 |
--------------------------------------------------------------------------------
/jupyterlab_git/tests/test_single_file_log.py:
--------------------------------------------------------------------------------
1 | from pathlib import Path
2 | from unittest.mock import patch
3 |
4 | import pytest
5 |
6 | from jupyterlab_git.git import Git
7 |
8 | from .testutils import maybe_future
9 |
10 |
11 | @pytest.mark.asyncio
12 | async def test_single_file_log():
13 | with patch("jupyterlab_git.git.execute") as mock_execute:
14 | # Given
15 | process_output = [
16 | "74baf6e1d18dfa004d9b9105ff86746ab78084eb",
17 | "Lazy Senior Developer",
18 | "1 hours ago",
19 | "Something",
20 | "",
21 | "0 0 test.txt\x00\x008852729159bef63d7197f8aa26355b387283cb58",
22 | "Lazy Senior Developer",
23 | "2 hours ago",
24 | "Something Else",
25 | "e6d4eed300811e886cadffb16eeed19588eb5eec",
26 | "0 1 test.txt\x00\x00d19001d71bb928ec9ed6ae3fe1bfc474e1b771d0",
27 | "Lazy Junior Developer",
28 | "5 hours ago",
29 | "Something More",
30 | "263f762e0aad329c3c01bbd9a28f66403e6cfa5f e6d4eed300811e886cadffb16eeed19588eb5eec",
31 | "1 1 test.txt",
32 | ]
33 |
34 | mock_execute.return_value = maybe_future((0, "\n".join(process_output), ""))
35 |
36 | expected_response = {
37 | "code": 0,
38 | "commits": [
39 | {
40 | "commit": "74baf6e1d18dfa004d9b9105ff86746ab78084eb",
41 | "author": "Lazy Senior Developer",
42 | "date": "1 hours ago",
43 | "commit_msg": "Something",
44 | "pre_commits": [],
45 | "is_binary": False,
46 | "file_path": "test.txt",
47 | },
48 | {
49 | "commit": "8852729159bef63d7197f8aa26355b387283cb58",
50 | "author": "Lazy Senior Developer",
51 | "date": "2 hours ago",
52 | "commit_msg": "Something Else",
53 | "pre_commits": ["e6d4eed300811e886cadffb16eeed19588eb5eec"],
54 | "is_binary": False,
55 | "file_path": "test.txt",
56 | },
57 | {
58 | "commit": "d19001d71bb928ec9ed6ae3fe1bfc474e1b771d0",
59 | "author": "Lazy Junior Developer",
60 | "date": "5 hours ago",
61 | "commit_msg": "Something More",
62 | "pre_commits": [
63 | "263f762e0aad329c3c01bbd9a28f66403e6cfa5f",
64 | "e6d4eed300811e886cadffb16eeed19588eb5eec",
65 | ],
66 | "is_binary": False,
67 | "file_path": "test.txt",
68 | },
69 | ],
70 | }
71 |
72 | # When
73 | actual_response = await Git().log(
74 | path=str(Path("/bin/test_curr_path")),
75 | history_count=25,
76 | follow_path="folder/test.txt",
77 | )
78 |
79 | # Then
80 | mock_execute.assert_called_once_with(
81 | [
82 | "git",
83 | "log",
84 | "--pretty=format:%H%n%an%n%ar%n%s%n%P",
85 | "-25",
86 | "-z",
87 | "--numstat",
88 | "--follow",
89 | "--",
90 | "folder/test.txt",
91 | ],
92 | cwd=str(Path("/bin") / "test_curr_path"),
93 | timeout=20,
94 | env=None,
95 | username=None,
96 | password=None,
97 | is_binary=False,
98 | )
99 |
100 | assert expected_response == actual_response
101 |
--------------------------------------------------------------------------------