Running Sidebar Extension API #6895

Queuecumber · 2019-07-25T14:31:22Z

References

Takeover of PR #6002

Code changes

This PR adds an API for extensions to add their own sessions into the running sidebar

Note

Please look this over carefully as the merge was rather messy and I am not familiar with all package versions. Additionally I am currently getting hit with bug #4619 so I'm unable to run the tests locally, I am going to try to work around that though

jupyterlab-dev-mode · 2019-07-25T14:31:33Z

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link:

Queuecumber · 2019-07-25T15:35:42Z

Does anyone know why that windows test is failing? It doesn't look like something I changed but I'm not sure how to interpret it

telamonian · 2019-07-25T17:10:18Z

Does anyone know why that windows test is failing

There's ongoing issues with the JS CI tests. Don't worry about it. I restarted the failed test

Queuecumber · 2019-07-25T17:16:06Z

Ok, in the future is there a way for me to restart it from here so I don't have to bother you guys?

telamonian · 2019-07-25T17:21:16Z

You can close and then immediately reopen the PR. You may also be able to directly restart the test by clicking on Details and then restarting the failed tests.

Queuecumber · 2019-07-25T18:09:44Z

OK thanks it looks like all the checks are passing now

Queuecumber · 2019-07-26T18:43:29Z

I think this is good to go if we can get a review

jasongrout

This looks really nice to me. Thanks @recamshak and @Queuecumber!

I've added a few inline notes for some small changes.

packages/running/src/index.tsx

jasongrout · 2019-08-02T22:02:42Z

packages/running/src/index.tsx

-   */
-  name: string;
-
+  add(manager: IRunningSessions.IManager): void;


How do we remove things we've added? One common pattern we have in the code is to return a disposable, and when you dispose it, it removes the item from the registry. A simpler way might be to just have a remove method.

Disposable sounds like the right way, if not the easy way, can you point me at an example?

Although its possible that the intention was that this would be add-only

Sorry for the delayed reply. A good example of this pattern is

jupyterlab/packages/apputils-extension/src/palette.ts

Lines 63 to 68 in 1f59d9c

addItem(options: IPaletteItem): IDisposable {

let item = this._palette.addItem(options as CommandPalette.IItemOptions);

return new DisposableDelegate(() => {

this._palette.removeItem(item);

});

}

packages/running-extension/src/index.ts

Queuecumber · 2019-08-06T13:47:23Z

Not sure what just happened to the build but I'm unable to reproduce the error locally

vidartf · 2019-08-12T14:04:12Z

This failure seems relevant:

./terminal-extension/src/index.ts(26,10): error TS2305: Module '"../node_modules/@jupyterlab/running/lib"' has no exported member 'IRunningSessionManagers'.
../terminal-extension/src/index.ts(26,35): error TS2724: Module '"../node_modules/@jupyterlab/running/lib"' has no exported member 'IRunningSessions'. Did you mean 'RunningSessions'?

You need to update the version dependencies in the package.json files. Try running

jlpm run integrity

in the repo folder.

jasongrout · 2019-08-12T15:19:44Z

Sorry, that was confusing. I would say make whatever changes are needed to bring it in line with what is in master now, which I think would be accepting the change.

jasongrout · 2019-08-12T15:20:52Z

Oh, never mind. I didn't catch it was the linter adding an extra line. I would accept the change from the linter.

Queuecumber · 2019-08-12T15:22:24Z

OK I pushed the lint changes

Queuecumber · 2019-08-19T12:45:14Z

@jasongrout How are we doing with this?

jasongrout · 2019-08-19T17:27:29Z

Thanks for the ping. I've added it back to my review queue.

jasongrout · 2019-09-12T19:45:15Z

packages/running/src/index.tsx

-        Dialog.warnButton({ label: 'Shut Down All' })
-      ]
+      title: `Shut Down All ${props.manager.name} Sessions?`,
+      buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'SHUTDOWN' })]


Sorry, I meant to suggest adding a space: "SHUT DOWN"

Suggested change

buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'SHUTDOWN' })]

buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'SHUT DOWN' })]

jasongrout · 2019-09-12T19:46:30Z

Sorry for the late reply. The only two outstanding things for me are #6895 (comment) and #6895 (review)

jasongrout · 2019-09-12T20:23:34Z

FYI, I merged master in and resolved the conflicts.

Queuecumber · 2019-09-15T21:49:50Z

@jasongrout thanks for the help there, I've actually never had that happen before, how do I incorporate your merge into my repository to continue development?

Queuecumber · 2019-09-15T22:21:42Z

OK this should take care of the outstanding requests. I strongly suggest taking a close look at the packaging and things because I've never worked with yarn or typescript before. And sorry for the delay we have a new baby in the house so spare time is very limited right now

jasongrout · 2019-09-16T15:41:14Z

And sorry for the delay we have a new baby in the house so spare time is very limited right now

I understand! Congratulations!

jasongrout · 2019-09-16T16:57:41Z

I noticed that the staging directory had some changes since the last published version, so I reverted it. It should only be changed at release time. This isn't anything you did, but we might as well take care of it here.

jasongrout · 2019-09-16T17:35:47Z

Thank you again @recamshak and @Queuecumber for contributing!

vidartf · 2019-09-17T08:54:53Z

packages/running/src/index.tsx

@@ -323,56 +228,54 @@ export class RunningSessions extends ReactWidget {
  /**
   * Construct a new running widget.
   */
-  constructor(options: RunningSessions.IOptions) {
+  constructor(managers: IRunningSessionManagers) {


Note: This change seems to require a major version bump of the owning package.

I think you're right. I've opened #7219 to track this.

recamshak added 4 commits February 19, 2019 10:52

Expose a running session registry

52b8698

Register the running kernel manager

43c5cd4

Register the running terminal manager

55ea6da

Update packages dependencies

3435924

Merge onto latest master

ed8bea1

Queuecumber force-pushed the master branch from 7fe4a19 to ed8bea1 Compare July 25, 2019 15:03

Queuecumber mentioned this pull request Jul 25, 2019

Modular running extension #6002

Closed

Queuecumber changed the title ~~[WIP] Running Sidebar Extension API~~ Running Sidebar Extension API Jul 26, 2019

jasongrout self-requested a review July 29, 2019 20:11

jasongrout self-assigned this Jul 31, 2019

Queuecumber added 2 commits August 2, 2019 09:11

Merge branch 'master' of https://github.com/jupyterlab/jupyterlab

1b4517a

Package integrity updates

f7b98b2

Queuecumber force-pushed the master branch from 5fead93 to f7b98b2 Compare August 2, 2019 13:14

Queuecumber closed this Aug 2, 2019

Queuecumber reopened this Aug 2, 2019

jasongrout requested changes Aug 2, 2019

View reviewed changes

Queuecumber added 2 commits August 6, 2019 09:05

Incorporating review feedback

66d521c

Merge branch 'master' of https://github.com/jupyterlab/jupyterlab

2c2e41b

Queuecumber force-pushed the master branch from 4fb1cdf to 2c2e41b Compare August 6, 2019 13:09

Queuecumber closed this Aug 12, 2019

Queuecumber reopened this Aug 12, 2019

Lint on contributing.md

41d1e84

jasongrout reviewed Sep 12, 2019

View reviewed changes

Merge branch 'master' into master

f03f71a

Queuecumber added 3 commits September 15, 2019 18:13

Use disposable to remove running managers

adcb33e

Fix shut down wording

fbc7af3

Package integrity updates

6029e47

Revert staging back to the published version from df6e99c

38efb83

jasongrout approved these changes Sep 16, 2019

View reviewed changes

jasongrout merged commit 37984a7 into jupyterlab:master Sep 16, 2019

jasongrout added this to the 1.2 milestone Sep 16, 2019

jasongrout mentioned this pull request Sep 16, 2019

Make running extension support third-party sessions #5728

Closed

vidartf reviewed Sep 17, 2019

View reviewed changes

jasongrout mentioned this pull request Sep 17, 2019

Fix backwards compatibility for Running extension api in #6895 #7219

Closed

jasongrout modified the milestones: 1.2, 2.0 Sep 19, 2019

Queuecumber mentioned this pull request Oct 16, 2019

Couple of UI Inconsistencies chesterli29/jupyterlab_tensorboard#13

Closed

lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Oct 19, 2019

lock bot locked as resolved and limited conversation to collaborators Oct 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Running Sidebar Extension API #6895

Running Sidebar Extension API #6895

Queuecumber commented Jul 25, 2019

jupyterlab-dev-mode bot commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

telamonian commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

telamonian commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

Queuecumber commented Jul 26, 2019

jasongrout left a comment

jasongrout Aug 2, 2019

Queuecumber Aug 6, 2019

Queuecumber Aug 6, 2019

jasongrout Sep 12, 2019

Queuecumber commented Aug 6, 2019

vidartf commented Aug 12, 2019 •

edited

jasongrout commented Aug 12, 2019

jasongrout commented Aug 12, 2019

Queuecumber commented Aug 12, 2019

Queuecumber commented Aug 19, 2019

jasongrout commented Aug 19, 2019

jasongrout Sep 12, 2019 •

edited

jasongrout commented Sep 12, 2019

jasongrout commented Sep 12, 2019

Queuecumber commented Sep 15, 2019

Queuecumber commented Sep 15, 2019

jasongrout commented Sep 16, 2019

jasongrout commented Sep 16, 2019

jasongrout commented Sep 16, 2019

vidartf Sep 17, 2019

jasongrout Sep 17, 2019

	addItem(options: IPaletteItem): IDisposable {
	let item = this._palette.addItem(options as CommandPalette.IItemOptions);
	return new DisposableDelegate(() => {
	this._palette.removeItem(item);
	});
	}

	buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'SHUTDOWN' })]
	buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: 'SHUT DOWN' })]

Running Sidebar Extension API #6895

Running Sidebar Extension API #6895

Conversation

Queuecumber commented Jul 25, 2019

References

Code changes

Note

jupyterlab-dev-mode bot commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

telamonian commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

telamonian commented Jul 25, 2019

Queuecumber commented Jul 25, 2019

Queuecumber commented Jul 26, 2019

jasongrout left a comment

Choose a reason for hiding this comment

jasongrout Aug 2, 2019

Choose a reason for hiding this comment

Queuecumber Aug 6, 2019

Choose a reason for hiding this comment

Queuecumber Aug 6, 2019

Choose a reason for hiding this comment

jasongrout Sep 12, 2019

Choose a reason for hiding this comment

Queuecumber commented Aug 6, 2019

vidartf commented Aug 12, 2019 • edited

jasongrout commented Aug 12, 2019

jasongrout commented Aug 12, 2019

Queuecumber commented Aug 12, 2019

Queuecumber commented Aug 19, 2019

jasongrout commented Aug 19, 2019

jasongrout Sep 12, 2019 • edited

Choose a reason for hiding this comment

jasongrout commented Sep 12, 2019

jasongrout commented Sep 12, 2019

Queuecumber commented Sep 15, 2019

Queuecumber commented Sep 15, 2019

jasongrout commented Sep 16, 2019

jasongrout commented Sep 16, 2019

jasongrout commented Sep 16, 2019

vidartf Sep 17, 2019

Choose a reason for hiding this comment

jasongrout Sep 17, 2019

Choose a reason for hiding this comment

vidartf commented Aug 12, 2019 •

edited

jasongrout Sep 12, 2019 •

edited