Tickets/dm 46955 #36

athornton · 2024-11-26T23:44:58Z

No description provided.

athornton · 2024-11-26T23:50:41Z

Run on IDF as Experimental Weekly 2024_47_tut_exp

I've left an awful lot of console logging in here that I will delete before I merge, but you may find it helpful if you play with the extension in the RSP, because it lets you trace the construction of the hierarchy and the menu from it.

athornton · 2024-11-27T16:40:44Z

~~Now I don't know what to do~~. jlpm lint:check runs fine locally. I installed on Amazon Linux, and it showed me that some lines were too long. I don't know why MacOS and Linux differ in this regard.

stvoutsin

Looks great and also looks like a lot of work!
I've only reviewed the Typescript side, and only have some small suggestions based on my somewhat limited JS/Typescript experience so take with a grain of salt

stvoutsin · 2024-11-27T21:03:47Z

rsp_jupyter_extensions/handlers/query.py

        super().initialize()
        self._client = RSPClient(base_path="times-square/api/v1/")

    @property
    def rubinquery(self) -> dict[str, str]:
+        """Rubin query parms."""


Suggested change

"""Rubin query parms."""

"""Rubin query params."""

stvoutsin · 2024-11-27T22:54:53Z

src/tutorials.ts

+    if (name === null) {
+      name = '<unnamed>';
+    }
+    console.log(`Building hierarchy ${name}`);


Since there is a lot of logging which you may or may not want to display depending on if you are in prod or dev, you could setup a custom logger (or reuse something already out there like Pino).

Example:

function logMessage(level: 'info' | 'warn' | 'error', message: string, ...optionalParams: any[]): void { const logLevel = process.env.LOG_LEVEL || 'info'; const levels = { info: 1, warn: 2, error: 3, }; if (levels[level] >= levels[logLevel]) { if (level === 'info') { console.info(message, ...optionalParams); } else if (level === 'warn') { console.warn(message, ...optionalParams); } else if (level === 'error') { console.error(message, ...optionalParams); } } }

Which you could then use as:

logMessage('info', 'Building hierarchy ${name}');

Also just noticed your message that logging would be removed so you may want to skip this, although perhaps you may still want to leave some logging in there that you can turn it off/on via an env var?

May be useful in case things break and you won't have to add logging again from the start.

Yeah, sort of. But I don't have process.env in a useful fashion where the UI is running. But that's why I have the environment extension...but I need to refactor the loading so I can load the environment before initializing the other extensions, and then figure out a way to stash it so they can get to it.

That feels like the big tech-debt refactor I'm putting off, though. For the time being I'll probably get it debugged and then throw away a bunch of the console.log statements.

stvoutsin · 2024-11-27T23:20:17Z

src/tutorials.ts

+function overwriteDialog(
+  dest: string,
+  manager: IDocumentManager
+): Promise<any> {
+  const options = {
+    title: 'Target file exists',
+    body: `Overwrite file '${dest}' ?`,
+    buttons: [Dialog.cancelButton(), Dialog.okButton({ label: 'OVERWRITE' })]
+  };
+  console.log('Showing overwrite dialog');
+  return showDialog(options).then(result => {
+    if (!result) {
+      console.log('No result from queryDialog');
+      return new Promise((res, rej) => {
+        /* Nothing */
+      });
+    }
+    console.log('Result from overwriteDialog: ', result);
+    if (!result.button) {
+      console.log('No result.button from overwriteDialog');
+      return new Promise((res, rej) => {
+        /* Nothing */
+      });
+    }
+    if (result.button.label === 'OVERWRITE') {
+      console.log(
+        'Got result ',
+        result.button.label,
+        ' from overwriteDialog: OVERWRITE'
+      );
+      return Promise.resolve(result.button.label);
+    }
+    console.log('Did not get overwriteDialog: OVERWRITE');
+    return new Promise((res, rej) => {
+      /* Nothing */
+    });
+  });
+}


Suggested change

function overwriteDialog(

dest: string,

manager: IDocumentManager

): Promise<any> {

const options = {

title: 'Target file exists',

body: `Overwrite file '${dest}' ?`,

buttons: [Dialog.cancelButton(), Dialog.okButton({ label: 'OVERWRITE' })]

};

console.log('Showing overwrite dialog');

return showDialog(options).then(result => {

if (!result) {

console.log('No result from queryDialog');

return new Promise((res, rej) => {

/* Nothing */

});

}

console.log('Result from overwriteDialog: ', result);

if (!result.button) {

console.log('No result.button from overwriteDialog');

return new Promise((res, rej) => {

/* Nothing */

});

}

if (result.button.label === 'OVERWRITE') {

console.log(

'Got result ',

result.button.label,

' from overwriteDialog: OVERWRITE'

);

return Promise.resolve(result.button.label);

}

console.log('Did not get overwriteDialog: OVERWRITE');

return new Promise((res, rej) => {

/* Nothing */

});

});

}

interface DialogResult {

button?: {

label: string;

};

}

async function overwriteDialog(dest: string, manager: IDocumentManager): Promise<string | void> {

const dialogOptions = {

title: 'Target file exists',

body: `Overwrite file '${dest}' ?`,

buttons: [

Dialog.cancelButton(),

Dialog.okButton({ label: 'OVERWRITE' })

]

};

try {

console.log('Showing overwrite dialog');

const result: DialogResult = await showDialog(dialogOptions);

if (!result) {

console.log('No result from queryDialog');

return;

}

console.log('Result from overwriteDialog: ', result);

if (!result.button) {

console.log('No result.button from overwriteDialog');

return;

}

if (result.button.label === 'OVERWRITE') {

console.log(

'Got result ',

result.button.label,

' from overwriteDialog: OVERWRITE'

);

return result.button.label;

}

console.log('Did not get overwriteDialog: OVERWRITE');

return;

} catch (error) {

console.error('Error showing overwrite dialog:', error);

throw new Error(`Failed to show overwrite dialog: ${error.message}`);

}

}

I think simply returning (void) may be better here then promises that don't resolve.
You could also use Promise.resolve() or even a Promise.reject() if you want your function to return a promise, but I don't think it's needed?

Note: I have not tested this

stvoutsin · 2024-11-27T23:24:39Z

src/tutorials.ts

+      const tutorialsmenu = new Menu({ commands });
+      tutorialsmenu.title.label = 'Tutorials';
+      parentmenu = tutorialsmenu;
+      console.log('set up top level Tutorials menu');


I think debug may be better for these types of messages, which some browser will hide in the console by default

stvoutsin · 2024-11-27T23:27:43Z

src/tutorials.ts

+enum Dispositions {
+  PROMPT = 'prompt',
+  OVERWRITE = 'overwrite',
+  ABORT = 'abort'


It doesn't look like ABORT is used atm, but may be in future versions in which case it's fine?

Yeah, at the moment there's no notion of a server-side cleanup if the user cancels, but there could be. I think in the current design we don't persist anything into the user's file space unless we have confirmed (or confirmation wasn't needed). But I can see that changing, especially as I figure out the ancillary-file stuff.

stvoutsin · 2024-11-27T23:42:50Z

src/tutorials.ts

+      console.log(`Response: ${JSON.stringify(data, undefined, 2)}`);
+      const h_i = data as ITutorialsHierarchyResponse;
+      const tut = new TutorialsHierarchy(h_i);
+      console.log('Created TutorialsHierary from response');


Suggested change

console.log('Created TutorialsHierary from response');

console.log('Created TutorialsHierarchy from response');

stvoutsin · 2024-11-27T23:46:34Z

src/tutorials.ts

+function apiPostTutorialsEntry(
+  settings: ServerConnection.ISettings,
+  docManager: IDocumentManager,
+  entry: TutorialsEntry
+): void {
+  /**
+   * Make a request to our endpoint to copy a file into place and open it
+   *
+   * @param settings - the settings for the current notebook server
+   *
+   * @param entry - the entry corresponding to the file to work with
+   *
+   * @returns a Promise resolved with the JSON response
+   */


Suggested change

function apiPostTutorialsEntry(

settings: ServerConnection.ISettings,

docManager: IDocumentManager,

entry: TutorialsEntry

): void {

/**

* Make a request to our endpoint to copy a file into place and open it

*

* @param settings - the settings for the current notebook server

*

* @param entry - the entry corresponding to the file to work with

*

* @returns a Promise resolved with the JSON response

*/

/**

* Make a request to our endpoint to copy a file into place and open it.

* Handles file overwrite confirmation if needed and opens the file on success.

*

* @param settings - the settings for the current notebook server

* @param docManager - the document manager instance

* @param entry - the entry corresponding to the file to work with

*/

function apiPostTutorialsEntry(

settings: ServerConnection.ISettings,

docManager: IDocumentManager,

entry: TutorialsEntry

): void {

I think in general the Javascript convention is jsdoc before function

stvoutsin · 2024-11-27T23:55:14Z

src/tutorials.ts

+  const svcManager = app.serviceManager;
+  const settings = svcManager.serverSettings;
+
+  function buildTutorialsMenu(


Perhaps a future improvement but buildTutorialsMenu could potentially be broken down to smaller single-responsibility methods?
Example:

initializeMenu: Menu initialization

buildSubmenus: Submenu creation

addMenuEntries: Menu entry creation

stvoutsin · 2024-11-28T00:12:31Z

src/tutorials.ts

+  entries: { [name: string]: TutorialsEntry } | null = null;
+  subhierarchies: { [name: string]: TutorialsHierarchy } | null = null;
+
+  constructor(inp: ITutorialsHierarchyResponse, name: string | null = null) {


Might be personal preference but I'd use methods outside of the constructor like:

constructor( input: ITutorialsHierarchyResponse, private readonly name: string = '<unnamed>' ) { console.log(`Building hierarchy ${this.name}`); this.processEntries(input.entries); this.processSubhierarchies(input.subhierarchies); console.log(`Hierarchy ${this.name} built`); }

stvoutsin · 2024-11-28T00:16:52Z

src/tutorials.ts

+    }
+    console.log(`Building hierarchy ${name}`);
+    if (inp.entries !== null) {
+      for (const entry in inp.entries) {


Object.entries may be useful for iteration, up to you though:

Example:

private processEntries(entries: Record<string, TutorialsEntry> | null): void { if (!entries) return; for (const [entryName, entry] of Object.entries(entries)) { ... console.log(`Adding entry ${entryName}: ${JSON.stringify(entry, null, 2)}`); ...

athornton added 14 commits November 26, 2024 16:45

Add test for _build_hierarchy()'

4ba18d6

Add some models and validation

9053f2a

Map Tutorials handler into server

ba9fbea

Make typing happy

17bc42e

refactor Hierarchy

941f268

Improve typing and linting

39af93b

Add content copy function to tutorials server extension

bcfb29a

Add menu name and menu path to HierarchyEntry

3105861

Simplify model with non-optional parent

a307fdd

Bump version number

f3bf8c3

Start work on UI side of tutorial extension

ad8d934

Construct menu correctly.

07bdab3

Add junit.xml and package-lock.json

c52abc5

Change interface to return 200 and data rather than 307 redirect

fb819b1

athornton force-pushed the tickets/DM-46955 branch from aa116a2 to fb819b1 Compare November 26, 2024 23:47

athornton requested a review from stvoutsin November 26, 2024 23:49

athornton force-pushed the tickets/DM-46955 branch 3 times, most recently from 8ed4a88 to 13f5afb Compare November 27, 2024 18:58

Appease Github Actions testing.

b974a33

athornton force-pushed the tickets/DM-46955 branch from 13f5afb to b974a33 Compare November 27, 2024 21:54

stvoutsin approved these changes Nov 28, 2024

View reviewed changes

move jsdocs to right place, simplify overwritedialog

2acc57f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tickets/dm 46955 #36

Tickets/dm 46955 #36

athornton commented Nov 26, 2024

athornton commented Nov 26, 2024

athornton commented Nov 27, 2024 •

edited

Loading

stvoutsin left a comment

stvoutsin Nov 27, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 29, 2024

athornton Dec 1, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 27, 2024

athornton Nov 28, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 28, 2024

stvoutsin Nov 27, 2024

stvoutsin Nov 28, 2024

stvoutsin Nov 28, 2024

	console.log('Created TutorialsHierary from response');
	console.log('Created TutorialsHierarchy from response');

Tickets/dm 46955 #36

Are you sure you want to change the base?

Tickets/dm 46955 #36

Conversation

athornton commented Nov 26, 2024

athornton commented Nov 26, 2024

athornton commented Nov 27, 2024 • edited Loading

stvoutsin 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

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

athornton commented Nov 27, 2024 •

edited

Loading