ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel #644

TheKorpos · 2025-04-30T16:39:33Z

Previously, the REST API base path could be set in the Jupyter kernel only as part of the deployment process: either during the kernel installation by using --api-base-path or by using an environmental variable.

This PR adds a new %repo command that allows users to change the API base path in the running kernel. The usage of this command is:

%repo [<BASE PATH>]

Set the API base path for the repository accessed by the %projects, %publish and %load commands.
<BASE PATH> is a URL (possibly including port number), such as: https://my.domain.com/sysml_repo:9000.
If <BASE PATH> is not given, the current repository base path is printed.
If <BASE PATH> is given, the repository base path is set to this.

seidewitz

%api-base-path is an awkward name for a command. How about something like %repo instead. The help text should then say:

Usage: %repo [<BASE PATH>]

If <BASE PATH> is not given, print the current repository base path.
If <BASE PATH> is given, set the repository base path.

<BASE PATH> is a URL giving the API base path for the repository access by the %projects, %publish and %load commands. 
For example: https://my.domain.com/sysml_repo

- updated help string - fixed '-h' flag

TheKorpos · 2025-05-05T13:12:06Z

%api-base-path is an awkward name for a command. How about something like %repo instead. The help text should then say:

Usage: %repo [<BASE PATH>]

If <BASE PATH> is not given, print the current repository base path.
If <BASE PATH> is given, set the repository base path.

<BASE PATH> is a URL giving the API base path for the repository access by the %projects, %publish and %load commands. 
For example: https://my.domain.com/sysml_repo

Hi @seidewitz,
I've udpated the magic command name and help strings.

For the example URL I used the default value (http://sysml2-dev.intercax.com:9000), it's more consistent with the new help strings, and default values we used in ST6RI-178.

Also, I removed the part 'The api base path is:' from the output of this command so now it simply prints the current base path.

seidewitz · 2025-05-05T15:19:59Z

For the example URL I used the default value (http://sysml2-dev.intercax.com:9000), it's more consistent with the new help strings, and default values we used in ST6RI-178.

I specifically do not want to put a real domain in the help text. The Intercax deployment will not be the default forever, and may even change in the near future. And the default should particularly not be the sysml2-dev server. This is for internal development use, and the URL is not supposed to be public.

TheKorpos · 2025-05-05T15:37:47Z

I specifically do not want to put a real domain in the help text. The Intercax deployment will not be the default forever, and may even change in the near future. And the default should particularly not be the sysml2-dev server. This is for internal development use, and the URL is not supposed to be public.

I see. I changed it to the one you wrote.

seidewitz · 2025-05-21T04:00:28Z

This probably has more to do with ST6RI-682 than ST6RI-836, but I didn't notice it until I changed repositories.

After doing %repo "http://sysml2-sst.intercax.com:9000", I got an exception when I tried reading a crtain project that was already in that repository:

%load "Spacecraft project with Element CRUD - 2025-05-07 11:54:28.544540"

API base path: http://sysml2-sst.intercax.com:9000/

Selected branch main (7824e4cc-c649-405b-9871-44ad2ff07e9b)
Downloading model...

---------------------------------------------------------------------------
java.lang.UnsupportedOperationException: Revision has no remote!
	at org.omg.sysml.util.repository.Revision.fetchRemote(Revision.java:84)
	at org.omg.sysml.interactive.SysMLInteractive.load(SysMLInteractive.java:555)
	at org.omg.sysml.interactive.SysMLInteractive.load(SysMLInteractive.java:529)
	at org.omg.sysml.jupyter.kernel.magic.Load.load(Load.java:69)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at io.github.spencerpark.jupyter.kernel.magic.registry.Magics.invoke(Magics.java:89)
	at io.github.spencerpark.jupyter.kernel.magic.registry.Magics.access$000(Magics.java:8)
	at io.github.spencerpark.jupyter.kernel.magic.registry.Magics$LineReflectionMagicFunction.execute(Magics.java:149)
	at io.github.spencerpark.jupyter.kernel.magic.registry.Magics.applyLineMagic(Magics.java:26)
	at org.omg.sysml.jupyter.kernel.SysMLKernel.eval(SysMLKernel.java:95)
	at io.github.spencerpark.jupyter.kernel.BaseKernel.handleExecuteRequest(BaseKernel.java:334)
	at io.github.spencerpark.jupyter.channels.ShellChannel.lambda$bind$0(ShellChannel.java:64)
	at io.github.spencerpark.jupyter.channels.Loop.lambda$new$0(Loop.java:21)
	at io.github.spencerpark.jupyter.channels.Loop.run(Loop.java:78)

Other projects seem to load OK. The name of this particular project is not consistent with the old format for publishing from Jupyter, so I suspect it was added by someone using the API directly and may be ill-formed in some way. However, if that is the case, it would be better if we generated some sort of error message, rather than an exception, if possible

- when trying to query a project by id instead of throwing an exception getProjectById return null. This matches with the logic used in by getProjectByName

TheKorpos · 2025-05-21T13:02:45Z

java.lang.UnsupportedOperationException: Revision has no remote!

When a branch has no head commit the logic creates and returns a local (no remote state) revision. The future head commit of the branch. Once this commit is published (delta between empty remote state and local state) it becomes 'remote'.
The UnsupportedOperation exception happens when fetch is called on a revision that has no remote.

In this case a project is empty (no commits) but %load still tires to fetch the non-existing remote state.

I added a check to prevent this from happening and show the following error for empty branches:

ERROR:Branch has no head commit

I've made another cosmetic change. When %load --id=<PROJECT ID> is used and the project is not found an exception was thrown (informing about error code: 404). I changed that to the message ERROR:Project doesn't exist to match the output with %load --name=<PROJECT NAME>.

Additionally, it might be a good idea to move the printing of repository URL to an earlier stage in %load. Currently it happens after the error messages, so there is no information in case of a Project doesn't exist error about which repository is being used.

- Also added %repo to SysMLInteractive main program, and properly updated counter.

seidewitz · 2025-05-22T13:41:50Z

Additionally, it might be a good idea to move the printing of repository URL to an earlier stage in %load.

Done.

seidewitz · 2025-05-22T15:01:07Z

Note: PR description has been updated per help text changes made in PR #649.

TheKorpos added 2 commits March 26, 2025 16:44

ST6RI-836 Added magic command to change api-base-path

6de0534

Merge remote-tracking branch 'origin/master' into ST6RI-836

9b4a979

TheKorpos requested a review from seidewitz April 30, 2025 16:39

seidewitz changed the title ~~ST6RI-836 Added option that allows changing the API basePath in a running Jupyter kernel~~ ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel Apr 30, 2025

seidewitz self-assigned this Apr 30, 2025

seidewitz added this to the 2025-04 milestone Apr 30, 2025

seidewitz requested changes May 1, 2025

View reviewed changes

ST6RI-836 Changed magic command 'api-base-path' to 'repo'

7e36f12

- updated help string - fixed '-h' flag

ST6RI-836 Changed api base path example in help string

8f6cb35

TheKorpos requested a review from seidewitz May 6, 2025 13:51

ujhelyiz changed the base branch from master to ST6RI-178 May 15, 2025 09:24

ujhelyiz added 3 commits May 15, 2025 11:37

Merge branch 'ST6RI-178' into ST6RI-836

fddd5ef

Merge branch 'ST6RI-178' into ST6RI-836

f6f7329

ST6RI-836 Put back method mistakenly removed during merging

a24f936

ujhelyiz mentioned this pull request May 15, 2025

ST6RI-823 Support extending Jupyter integration with additional magic commands #649

Merged

seidewitz changed the base branch from ST6RI-178 to master May 21, 2025 03:30

Merge branch 'master' into ST6RI-836

28d964d

TheKorpos added 2 commits May 21, 2025 14:26

ST6RI-178 Added error message for empty branch loading

6d6d9d2

ST6RI-836 getProjectById returns null of project doesn't exist

6498b07

- when trying to query a project by id instead of throwing an exception getProjectById return null. This matches with the logic used in by getProjectByName

seidewitz added 2 commits May 22, 2025 09:04

ST6RI-836 Changed name of %repo magic implementation to "Repo".

070a256

- Also added %repo to SysMLInteractive main program, and properly updated counter.

ST6RI-836 Moved printing of API base path earlier in %load command impl.

e46defe

seidewitz approved these changes May 22, 2025

View reviewed changes

seidewitz merged commit 7808b57 into master May 22, 2025
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel #644

ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel #644

Uh oh!

TheKorpos commented Apr 30, 2025 •

edited by seidewitz

Loading

Uh oh!

seidewitz left a comment

Uh oh!

TheKorpos commented May 5, 2025

Uh oh!

seidewitz commented May 5, 2025

Uh oh!

TheKorpos commented May 5, 2025

Uh oh!

seidewitz commented May 21, 2025

Uh oh!

TheKorpos commented May 21, 2025 •

edited

Loading

Uh oh!

seidewitz commented May 22, 2025

Uh oh!

Uh oh!

seidewitz commented May 22, 2025

Uh oh!

Uh oh!

ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel #644

ST6RI-836 Add option that allows changing the API basePath in a running Jupyter kernel #644

Uh oh!

Conversation

TheKorpos commented Apr 30, 2025 • edited by seidewitz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seidewitz left a comment

Choose a reason for hiding this comment

Uh oh!

TheKorpos commented May 5, 2025

Uh oh!

seidewitz commented May 5, 2025

Uh oh!

TheKorpos commented May 5, 2025

Uh oh!

seidewitz commented May 21, 2025

Uh oh!

TheKorpos commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seidewitz commented May 22, 2025

Uh oh!

Uh oh!

seidewitz commented May 22, 2025

Uh oh!

Uh oh!

TheKorpos commented Apr 30, 2025 •

edited by seidewitz

Loading

TheKorpos commented May 21, 2025 •

edited

Loading