Cloud/desktop mode switcher #6448

somebody1234 · 2023-04-27T08:01:17Z

Pull Request Description

This is a re-creation of #6308.
Creates buttons to switch between cloud and local backends for listing directories, opening projects etc.

Important Notes

The desktop backend currently uses a hardcoded list of templates, mostly because they look better because they have background images. However, it can easily be changed to use listSamples endpoint and switched to the default grey background.

Screenshots

The switcher is on the top left. UI is a placeholder and so it is subject to change.
Cloud backend:

Desktop backend:

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
All code has been tested:
- Unit tests have been written where possible.
- If GUI codebase was changed, the GUI was tested when built using ./run ide build.

This reverts commit d0e1dd5.

…desktop backend IDEs

PabloBuchu · 2023-04-27T08:38:58Z

QA 🟢 : I QAed yestarday the part of running local/cloud projects, switching between them and doing a bookclubs.

Problems with project manager connection I can see was solved today with lazy initialisation. Debug scences are also working but one bug remains.

When you run: ./dist/ide/mac-arm64/Enso.app/Contents/MacOS/Enso -debug.dev-tools -startup.entry=text_area the options still reports that startup.entry is ide which in fact should be set to test_area. This resulted in initialisating the project manager connection by dashboard components even if they were not in use

cc @wdanilo

somebody1234 · 2023-04-27T09:32:52Z

marking as draft to do a major refactor
(edit: or not, it's probably better for a major refactor to be another PR...)

app/ide-desktop/lib/content/src/index.ts

PabloBuchu · 2023-04-27T09:48:27Z

app/ide-desktop/lib/dashboard/src/serviceWorker.ts

+// =================
+
+const IDE_CDN_URL = 'https://ensocdn.s3.us-west-1.amazonaws.com/ide'
+const FALLBACK_VERSION = '2023.1.1-nightly.2023.4.13'


since for now cloud always is sure that it is ran on desktop we should I think fallback to IDE provided with the desktop..

i think this code shouldn't ever be executed on desktop - the service worker should only be registered when doing npm run watch-dashboard, see:

enso/app/ide-desktop/lib/dashboard/esbuild-config.ts

Line 120 in ae94a9f

IS_DEV_MODE: JSON.stringify(args.devMode),

enso/app/ide-desktop/lib/dashboard/src/index.tsx

Lines 22 to 27 in ae94a9f

if (IS_DEV_MODE) {

new EventSource(ESBUILD_PATH).addEventListener(ESBUILD_EVENT_NAME, () => {

location.reload()

})

void navigator.serviceWorker.register(SERVICE_WORKER_PATH)

}

content does have IS_DEV_MODE as well, but it shouldn't affect this one as dashboard build happens in a separate esbuild instance

if you think it's a good idea to remove it though (since cloud frontend isn't the focus) that's easy enough too

There is no documentation what FALLBACK_VERSION is, so I can't really tell what to do with it until I understand what it is and how it is meant to be used.

If something is cloud-release-specific, it should have that written in the name explicitly.

cloud release is not our focus, but we can't break it. We need to test it constantly and be sure it works.

it's not possible to make opening the IDE work with cloud frontend because no index.js.gz has runApp (partly since it's not merged in yet). maybe we can do something like (window.runApp ?? window.enso.main) instead?

(or we can just leave it as-is and just stop supporting old versions, which to be fair isn't a bad idea since it won't be possible for new users to create the old versions anyway)

so assuming runApp polluting the window is the main issue, the current solution i'd assume would be something like this:

const runApp = platform === platformModule.Platform.desktop ? appRunner.runApp : window.enso.main;

thoughts/suggestions?

isn't a problem for cloud, but assuming window.enso.main is the way to go here, something else must used for the de

I don't understand these points.

window.enso.main was intended to work and was working fine for long time.

What is the problem with authentication flow on the desktop version?

Your last sentence states "something else must used for the desktop backend" - why? I do not understand why we can't have one single entry point here. Inside of this entry point you are checking whether the app is run in cloud or not, so why we can't have just one entry point to start the app?

so assuming runApp polluting the window is the main issue, the current solution i'd assume would be something like this:

const runApp = platform === platformModule.Platform.desktop ? appRunner.runApp : window.enso.main;

thoughts/suggestions?

What is appRunner? Is it another global thing? Why can't we just have window.enso.main or window.enso.run (which would be even better than main).

it does still work, but not on desktop IDE (which is why i changed it to how it is currently)

sorry, bad wording - there is no problem with the authentication flow, the issue on the desktop IDE is that calling window.enso.main from the IDE React component runs the authentication flow instead of the actual IDE

window.enso.main is the entry point into the entire application, so i don't think the component that starts up the IDE should be running the application entry point

appRunner is passed into authentication.run() (the React frontend which includes authentication and the dashboard), in order to avoid needing a global.

the React entrypoint (App) then passes it down to the Ide component where it is needed

somebody1234 · 2023-04-27T10:14:32Z

just tried gui watch - http://localhost:8080/?startup.entry=grid_view doesn't output errors; not sure if that's the normal way to test different scenes though

unfurl | built with Probot

wdanilo · 2023-04-27T12:42:04Z

app/ide-desktop/lib/content/src/index.ts

+    const rootElement = document.getElementById(IDE_ELEMENT_ID)
+    if (!rootElement) {
+        logger.error(`The root element (the element with ID '${IDE_ELEMENT_ID}') was not found.`)
+    } else {
+        while (rootElement.firstChild) {
+            rootElement.removeChild(rootElement.firstChild)
+        }
+    }


There is not explanation why this is being done. It looks like we are removing all children from root - why? Please refactor that to a well-named function and provide in the code explanation what cases does it cover. Otherwise, it would be easy to refactor that in the future and break it not knowing the cases.

wdanilo · 2023-04-27T12:45:22Z

app/ide-desktop/lib/content/src/index.ts

+let currentAppInstance: app.App | null = new app.App({
+    config: {
+        loader: {
+            wasmUrl: 'pkg-opt.wasm',
+            jsUrl: 'pkg.js',
+            assetsUrl: 'dynamic-assets',
+        },
+    },
+    configOptions: contentConfig.OPTIONS,
+    packageInfo: {
+        version: BUILD_INFO.version,
+        engineVersion: BUILD_INFO.engineVersion,
+    },
+})


earlier we've been creating new App in the main function. This was done on purpose, as creating global variables in the initialization time is rather a bad design. I'd like to get back to how it was done. Also, the comment above this line brings more questions than answers:

Content is a cloud/desktop entry point, so what are command line arguments here?

What does it mean that it "must be run at least once"? Why it must be? What will happen if its not?

Why this comment even matter here? It tells that something must be done, but does not explain what is the purpose.

This refactor really helped us with running new Enso App instance on openning project and dropping old thigns. If you would like I could jump on a call to talk about keeping new state.

As for 1-3 points please @somebody1234 as I am also not sure why we create a global here

the IDE appears to get configuration options from the URL query parameters; i believe neither content nor the frontend control this?

new app.App mutates contentConfig.OPTIONS, which is required otherwise we cannot check whether to open the authentication ui and whether to show the dashboard

the comment explains why this is needed
(note that this isn't actually a global variable accessible to the window because it is a module script. however, i think we can leave it alone and just not assign it to a variable, since it never runs the IDE so we don't have to do any cleanup)

That's right. So these are not "command line arguments", as there is no "command line" when it is run in the cloud :)

So the arguments must be parsed, the whole application does not have to be run, right? Running the whole app just to get arguments seems like an overkill.

I did not understand the comment, tbh.

Regarding global variables - I understand that these are not window-global variables, but they are module-level global variables and we are trying not to use them this way. Everything should be part of a function and in a module we can call a function to start the evaluation, but everything else should be just nicely refactored to functions.

Anyway, I believe we should refactor it. Keeping the code well-organized is really important to be able to maintain it. If there will be any problems with its refactoring, I'd love to jump on a call.

wdanilo · 2023-04-27T12:46:05Z

app/ide-desktop/lib/content/src/index.ts

+function tryStopEnso() {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+    currentAppInstance?.wasm?.drop?.()
+}


We are not hardcoding product name in function names.

If this is "try stopping" then when it can fail? There are no docs nor explanation about it.

wdanilo · 2023-04-27T12:47:02Z

app/ide-desktop/lib/content/src/index.ts

+    const config = Object.assign(
+        {
+            loader: {
+                wasmUrl: 'pkg-opt.wasm',
+                jsUrl: 'pkg.js',
+                assetsUrl: 'dynamic-assets',
            },
-        })
+        },


Exactly the same code is above.

These are the defaults, right? If you don't provide them, they should be the same, am I correct?

okay, i can extract it out to a function

seems like they aren't the defaults - defaults are below:

enso/lib/rust/ensogl/pack/js/src/runner/config.json

Lines 17 to 31 in 9a0f739

"wasmUrl": {

"value": "pkg.wasm",

"description": "The URL of the WASM pkg file generated by ensogl-pack.",

"primary": false

},

"jsUrl": {

"value": "pkg.js",

"description": "The URL of the JS pkg file generated by ensogl-pack.",

"primary": false

},

"assetsUrl": {

"value": "assets",

"description": "The URL of the dynamic assets directory.",

"primary": false

},

actually re: 1. the first has been somewhat changed, can be changed even further but as of now "exactly the same code" no longer applies so i'm counting this as done, if something else should be done about this then it can always be brought up in a next review?

Hmmm, these names are very similar, but a little bit different. This is surprising to me - are we using defaults anywhere? I remember that when I was coding that part, defaults were used in the Electron app. If the names changed, in the Electron app, the defaults should change as well.

wdanilo · 2023-04-27T12:47:35Z

app/ide-desktop/lib/content/src/index.ts

+    currentAppInstance = new app.App({
+        config,
+        configOptions: contentConfig.OPTIONS,
+        packageInfo: {
+            version: BUILD_INFO.version,
+            engineVersion: BUILD_INFO.engineVersion,
+        },
+    })


We are creating the app again here. Earlier it was created as a global variable. This looks like a really bad design and something logically is broken here.

This method runEnso is used when we open projects from the list. We then need to drop old one and reinitialise the new one with different options (like project name and it case of cloud with different loader options. This is why we need to make a new App here

Paweł, I was talking about the fact that in the code we have 2 places where the app is created. There is never need to copy-paste the same code multiple times. After the recent E-Hern changes, this is no longer the case, but we are still using new app.App({...}) to load configuration, which is extremely hacky.

wdanilo · 2023-04-27T12:57:51Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/projectManager.ts

+                setTimeout(() => {
+                    clearInterval(handle)
+                    reject()
+                }, STOP_TRYING_AFTER)
+            })


Is this affecting debug scenes performance? We need to have baremetal performance there without any background checks / connections. If not, how it is done and where in the code we have information about it / checks that for sure debug scenes are not affected by it?

ProjectManager is (now) lazily initialized so it shouldn't be loaded if the dashboard isn't loaded

what this does is try to open a websocket once per second for up to 10 seconds until it succeeds. not sure how long it takes for new WebSocket to run but it shouldn't take more than a few ms of cpu time (so not counting io time)

debug scenes uses bare enso app without any interaction with react code. previously there was a bug that overrided the startup.entry option resulting in calling websocket connection and this retry iinterval. Its now been fixed

@somebody1234 10 seconds seems like a long time. If the engine started, I understand there might be 10 seconds delay before we try to connect to it, is that correct? If so, this should be 1 second max.

@wdanilo no, its trying to reconnect every 1s for 10 seconds.. meaing it will fail after 10 tries of reconnecting

wdanilo · 2023-04-27T12:58:08Z

app/ide-desktop/lib/dashboard/src/authentication/src/providers/backend.tsx

@@ -0,0 +1,43 @@
+/** @file  */


no documentation

wdanilo · 2023-04-27T12:58:12Z

app/ide-desktop/lib/dashboard/src/authentication/src/providers/backend.tsx

+
+import * as cloudService from '../dashboard/cloudService'
+import * as localService from '../dashboard/localService'
+


no sections

wdanilo · 2023-04-27T13:00:43Z

app/ide-desktop/lib/dashboard/src/authentication/src/providers/backend.tsx

+export function useBackend() {
+    const { backend } = react.useContext(BackendContext)
+    return { backend }
+}
+
+export function useSetBackend() {
+    const { setBackend } = react.useContext(BackendContext)
+    return { setBackend }


these functions should either have better names or docs. I do not understand what function useBackend does (it looks like it does not spawn backend). Even more, I don't understand what useSetBakcend does.

wdanilo · 2023-04-27T13:02:34Z

app/ide-desktop/lib/dashboard/src/serviceWorker.ts

+// =================
+
+const IDE_CDN_URL = 'https://ensocdn.s3.us-west-1.amazonaws.com/ide'
+const FALLBACK_VERSION = '2023.1.1-nightly.2023.4.13'


There is no documentation what FALLBACK_VERSION is, so I can't really tell what to do with it until I understand what it is and how it is meant to be used.

If something is cloud-release-specific, it should have that written in the name explicitly.

cloud release is not our focus, but we can't break it. We need to test it constantly and be sure it works.

PabloBuchu · 2023-04-27T13:07:49Z

app/ide-desktop/lib/content/src/index.ts

+    if (!rootElement) {
+        logger.error(`The root element (the element with ID '${IDE_ELEMENT_ID}') was not found.`)
+    } else {
+        while (rootElement.firstChild) {


is it still needed at all? I thought we spoke that #6365 PR will remove div.scene with all elements? What other elements we are cleaning here?

PabloBuchu · 2023-04-27T13:46:35Z

app/ide-desktop/lib/content/src/index.ts

-                engineVersion: BUILD_INFO.engineVersion,
+// `new app.App` must be run at least once so that the command line arguments are applied to
+// `configOptions.OPTIONS`.
+let currentAppInstance: app.App | null = new app.App({


whats the point of this global? I though maybe we are using it to support old IDE with authentication but onAuthenticated uses runEnso. The same if I want to skip auth and new dashboard we also use runEnso so both case reinitialise the App which looks like bit of a waste

I have removed it and looks like build works fine

when i added it back, it was because contentConfig.OPTIONS was never changed from defaults, so the check for whether we should start auth/dashboard doesn't succeed no matter what command line arguments are passed

ok so re-checked.. When this global is removed it seems that authentication and feature-preview.new-dashboard flags have default values even if we pass them in command line..

old IDE and debug scenes works so startup.entry behaves normally, as other flags

@wdanilo this one is tricky.. do you have idea why the contentConfig.OPTIONS is beahving like that? I see the this.config.loadAll([opts?.config, host.urlParams()]) so maybe we should extract this logic from the App?

somebody1234 · 2023-04-27T14:45:41Z

still need to switch new app.App to config.loadAll
(and then test and fix cloud frontend)

somebody1234 · 2023-04-27T14:50:29Z

actually never mind on switching to config.loadAll just yet, it uses urlParams which isn't accessible by content/ (at least, not type-safe-ly)

somebody1234 · 2023-04-27T16:31:16Z

not sure if everything's fixed, but they should all be addressed at least

indiv0 · 2023-04-27T17:37:47Z

Unable to perform QA on M2 Mac:

 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️ > [email protected] build                                                                                                               
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️ > node src/index.js                                                                                                                    
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️ > [email protected] build                                                                                                                 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️ > tsx bundle.ts                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npmℹ️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ /Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/sharp.js:34                                                              
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️   throw new Error(help.join('\n'));                                                                                                    
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️         ^                                                                                                                              
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Error:                                                                                                                                 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Something went wrong installing the "sharp" module                                                                                     
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️                                                                                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Cannot find module '../build/Release/sharp-darwin-arm64v8.node'                                                                        
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Require stack:                                                                                                                         
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - /Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/sharp.js                                                               
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - /Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/constructor.js                                                         
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - /Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/index.js                                                               
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Possible solutions:                                                                                                                    
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - Install with verbose logging and look for errors: "npm install --ignore-scripts=false --foreground-scripts --verbose sharp"          
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - Install for the current darwin-arm64v8 runtime: "npm install --platform=darwin --arch=arm64v8 sharp"                                 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ - Consult the installation documentation: https://sharp.pixelplumbing.com/install                                                      
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Object.<anonymous> (/Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/sharp.js:34:9)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module._compile (node:internal/modules/cjs/loader:1254:14)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module.load (node:internal/modules/cjs/loader:1117:32)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module._load (node:internal/modules/cjs/loader:958:12)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module.require (node:internal/modules/cjs/loader:1141:19)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at require (node:internal/modules/cjs/helpers:110:18)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Object.<anonymous> (/Users/indiv0/src/enso/app/ide-desktop/node_modules/sharp/lib/constructor.js:8:1)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module._compile (node:internal/modules/cjs/loader:1254:14)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ Node.js v18.16.0
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ npm ERR! Lifecycle script `build` failed with error: 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ npm ERR! Error: command failed  
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ npm ERR!   in workspace: [email protected] 
 INFO ide_ci::program::command: runℹ️  INFO ide_ci::program::command: npm⚠️ npm ERR!   at location: /Users/indiv0/src/enso/app/ide-desktop/lib/icons

wdanilo · 2023-04-28T16:56:25Z

app/ide-desktop/lib/content/src/index.ts

+        // The `any` is unavoidable as `App.wasm` is typed as `any`.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call


This comment is not valid anymore. The code below does not access App.wasm. Please check if the lint disabling is needed.

wdanilo · 2023-04-28T16:58:00Z

app/ide-desktop/lib/content/src/index.ts

+    }
+
+    main() {
+        contentConfig.OPTIONS.loadAll([app.urlParams()])


This is just FYI @somebody1234 as you've been writing about it earlier. The fact that loadAll mutates the options rather than returning a new object containing them is wrong and it's so because when I was writing that I was unable to code that correctly in TS. However, some day we shiould change it to an immutable API.

wdanilo · 2023-04-28T16:59:13Z

app/ide-desktop/lib/content/src/index.ts

+        const isOpeningIde =
+            contentConfig.OPTIONS.groups.startup.options.entry.value ===
+            contentConfig.OPTIONS.groups.startup.options.entry.default
+        if ((isUsingAuthentication || isUsingNewDashboard) && isOpeningIde) {


I think we should not use "Ide" word, as it means different things for different people. I think we could change it to isOpeningMainEntryPoint instead.

wdanilo · 2023-04-28T17:00:58Z

app/ide-desktop/lib/content/src/index.ts

+             * and one for the desktop. Once these are merged, we can't hardcode the
+             * platform here, and need to detect it from the environment. */
+            const currentPlatform = contentConfig.OPTIONS.groups.startup.options.platform.value
+            const webPlatform = contentConfig.OPTIONS.groups.startup.options.platform.default


This line is very tricky. It will stop working if we change the default there, which makes the code really hard to refactor. I think it would be better (still far from best solution known from real typed languages) to do if (currentPlatform == 'web'). This will work even if we change defaults.

wdanilo · 2023-04-28T17:01:54Z

app/ide-desktop/lib/content/src/index.ts

-
-// @ts-expect-error `globalConfig.windowAppScopeName` is not known at typecheck time.
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-window[GLOBAL_CONFIG.windowAppScopeName] = API


What happened with this line? We are accessing the JS app from Rust via this variable. Why was it deleted? Was it moved somewhere? Such changes as this should be very clearly explained as they can break a lot of things.

might be good to add a comment about this needing to be exposed to Rust

@wdanilo are you sure that rust uses this global? this assignes Main to window.enso which I can't find any references in code to be used.

App also expose ensoglApp in window https://github.com/enso-org/enso/blob/develop/lib/rust/ensogl/pack/js/src/runner/index.ts#L217 which is widely accessed e.g. in gui/analytics/src/remote_log.js. It also has a comment that rust access it.

oh yeah - the initial commit (the revert commit) already had the global removed so all QAs seemed to work fine without the global.
i added it back because i figured it's safer to have it just in case

Please, never remove lines that you are not 100% sure can be removed. If you want to refactor such a code, the PR description should have a very explicit information about it, so reviewers can be extra careful when checking this place. This removed line was used in Rust in several places, so this change was introducing regression.

wdanilo · 2023-04-28T17:09:23Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/localService.ts

+    project: projectManager.OpenProject
+}
+
+export class Backend implements Partial<Omit<cloudService.Backend, 'platform'>> {


No docs - there should be clear info of what a "backend" is, as this is not a name we are using in all other parts of the project.

wdanilo · 2023-04-28T17:10:25Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/localService.ts

+        this.currentlyOpenProject = null
+    }
+
+    async getProjectDetails(projectId: cloudService.ProjectId): Promise<cloudService.Project> {


If getPtojectDetails returns cloudService.Project, it means that it can't get local projects info, right? This is surprising based on the naming Backend.getProjectDetails - there is no info in these names that it works with cloud projects only. (The same comment applies to other similar functions).

cloudService.Project is just Project, it's defined in cloudService because it mirrors the return type from the cloud API. it's possible to rename the import (to something like types or apiTypes) to make this less confusing, if that's a satisfactory solution?

wdanilo · 2023-04-28T17:11:18Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/localService.ts

+// === createBackend ===
+// =====================
+
+/** Shorthand method for creating a new instance of the backend API. */


Why createBackend() is "shorthand" for new Backend(), while the latter is in fact shorter?

The longer I read this file the more I believe the naming in this file is bad. Are we really creating new backend here? I think we are not spawning backend here.

this file was derived from cloudService.ts, but that's a good point. the "backend" in this case is the project manager, and it's creating a new api wrapper rather than a backend, but it's definitely more than doable to improve naming all around

wdanilo · 2023-04-28T17:12:43Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/projectManager.ts

+/** Duration before the {@link ProjectManager} tries to create a WebSocket again. */
+const RETRY_INTERVAL = 1000
+/** Duration after which the {@link ProjectManager} stops re-trying to create a WebSocket. */
+const STOP_TRYING_AFTER = 10000


constants should either use typed numbers or encode unit in name. If these are milliseconds, these should be named RETRY_INTERVAL_MS.

wdanilo · 2023-04-28T17:13:21Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/projectManager.ts

+// =================
+
+/** The address of the socket for the project manager. */
+const PROJECT_MANAGER_ENDPOINT = 'ws://127.0.0.1:30535'


Is this a hardcoded thing? Is this agreed with backend? If so, docs should mention which other part of the project it should be synchronized with.

should the other side also have a comment pointing to this file?

CC @PabloBuchu - I was chatting with Pawel how to refactor it to a common file.

It should be placed in app/gui/config.yaml so both rust and js can access it

should this be done in this PR?

from our side imho yes. Let's put the const PROJECT_MANAGER_ENDPOINT = 'ws://127.0.0.1:30535' to gui/config.yaml and just use it in projectManager.ts

import GLOBAL_CONFIG from '../../../../gui/config.yaml' assert { type: 'yaml' } ... return (this.instance ??= new ProjectManager(GLOBAL_CONFIG.projectManagerEndpoint))

wdanilo · 2023-04-28T17:14:42Z

lib/rust/ensogl/pack/js/src/runner/index.ts

@@ -189,6 +191,9 @@ export class App {
    mainEntryPoints = new Map<string, wasm.EntryPoint>()
    progressIndicator: wasm.ProgressIndicator | null = null
    initialized = false
+    /** Field indicating that application was stopped and any long running process (like wasm compilation) should be aborted.


somebody1234 · 2023-04-28T19:04:25Z

lots of changes so will almost certainly need to be QA'd again

wdanilo · 2023-05-01T09:23:28Z

app/ide-desktop/lib/types/types.d.ts

@@ -0,0 +1,10 @@
+/** @file Interfaces common to multiple modules. */
+
+interface StringConfig {


no sections

wdanilo · 2023-05-01T09:23:44Z

app/ide-desktop/lib/types/types.d.ts

+    [key: string]: StringConfig | string
+}
+
+interface AppRunner {


no docs - there should be info why we need it and what it is used for.

wdanilo · 2023-05-01T09:28:25Z

app/ide-desktop/lib/content/src/index.ts

-
-// @ts-expect-error `globalConfig.windowAppScopeName` is not known at typecheck time.
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-window[GLOBAL_CONFIG.windowAppScopeName] = API


Please, never remove lines that you are not 100% sure can be removed. If you want to refactor such a code, the PR description should have a very explicit information about it, so reviewers can be extra careful when checking this place. This removed line was used in Rust in several places, so this change was introducing regression.

wdanilo · 2023-05-01T09:32:29Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/components/dashboard.tsx

 // This type annotation is explicit to undo TypeScript narrowing to `false`,
 // which result in errors about unused code.
 // eslint-disable-next-line @typescript-eslint/no-inferrable-types
-const EXPERIMENTAL: boolean = true
+const EXPERIMENTAL: boolean = false


The docs above do not tell the reader what features we are talking about. Thus, it is really hard to review this code, as I don't understand which features we disable. If you want to keep this with explicit info what it enables, you can do similar to what we do in Rust:

const EXPERIMENTAL = { nameOfFeatureOne: true, nameOfFeatureTwo: false, }

wdanilo · 2023-05-01T09:39:00Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/components/dashboard.tsx

-import * as backend from '../service'
+import * as backendApi from '../cloudBackendApi'


Why are we changing the name from backend to backendApi? Every file defines API, so in fact, every file could be named ...Api.

It should be imported as cloudBackend, as it's now confusing with normal Enso's backend.

wdanilo · 2023-05-01T09:44:11Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/projectManagerBackendApi.ts

+/** @file Module containing the API client for the local backend API.
+ *
+ * Each exported function in the {@link ProjectManagerBackendAPI} in this module corresponds to an API endpoint. The
+ * functions are asynchronous and return a `Promise` that resolves to the response from the API. */


I was chatting with Pawel here. Withotu this chat I was totally confused what is this file about and what is the difference between "Project Manager Backend" and "Project Manager". This should be named probably "localBackend", so it will nicely fit the "cloudBackend" name.

Also, please double check if these docs are correct, as I think they refer improper files.

wdanilo · 2023-05-01T09:49:31Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/cloudBackendApi.ts

@@ -1,11 +1,12 @@
 /** @file Module containing the API client for the Cloud backend API.
 *
- * Each exported function in the {@link Backend} in this module corresponds to an API endpoint. The
+ * Each exported function in the {@link CloudBackendAPI} in this module corresponds to an API endpoint. The


Paweł's comment here - if we are changing one of the files to localBackend, this one can be changed to remoteBackend to keep it even more synced

wdanilo · 2023-05-01T09:52:45Z

...de-desktop/lib/dashboard/src/authentication/src/dashboard/components/projectActionButton.tsx

+const CHECK_STATUS_INTERVAL = 10000
+/** The interval between requests checking whether the VM is ready. */
+const CHECK_RESOURCES_INTERVAL = 5000


These values are huge. If I understand correctly, these are 10s between checks for IDE status?

Names should have _MS suffix.

that is correct - i think that is what it was like on the old frontend

will fix asap

re: 1 - it seems like the backend may get overloaded if these are sent too quickly. in particular i tested the CHECK_RESOURCES_INTERVAL and multiple were returning as successful because the old interval was a lot shorter than the response time

also worth noting that instances currently still take ~90s to start up so i think the 10 second interval isn't such a big deal, at least for now

lets check resources every 1second and status interval every 5 seconds

wdanilo · 2023-05-01T09:54:07Z

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/projectManager.ts

+// =================
+
+/** The address of the socket for the project manager. */
+const PROJECT_MANAGER_ENDPOINT = 'ws://127.0.0.1:30535'


CC @PabloBuchu - I was chatting with Pawel how to refactor it to a common file.

somebody1234 · 2023-05-01T10:59:00Z

latest commit introduces a backend.ts file for the types, so other files that are only importing types do not import from cloudBackend, causing confusion. however, the purpose of the backend.ts file may be unclear so please do let me know if the docs can be improved

somebody1234 · 2023-05-01T11:32:48Z

this will definitely need another QA, not sure whether the reviews are more or less done though

sylwiabr · 2023-05-02T07:28:45Z

@somebody1234 is this ready for QA?

somebody1234 · 2023-05-02T07:37:12Z

@sylwiabr i think there are no further reviews for now so yeah, should be

PabloBuchu · 2023-05-02T09:13:13Z

I am doing QA session on mac for this PR. Could @mwu-tow take a look and click through this on windows as well?

Some useful tricks:

to clear local storage and reopen the authentication you open the console and just do localStorage.clear() then reload / reopen
to switch back from graph view to dashboard use shortcut: alt + ctrl + d

somebody1234 · 2023-05-02T09:46:28Z

note re: the shortcut - it's mostly there for debugging and can be changed/removed, especially when #6474 is merged in

(not that this will change QA - just noting this here for posterity)

PabloBuchu · 2023-05-02T10:13:30Z

QA on mac looks 🟢 I created some minor improvements and bugs tickets but nothing blocking this PR. Lets do another QA session on different platform and merge

mwu-tow · 2023-05-02T12:54:36Z

Done testing discussed all the observed issues with @PabloBuchu who will be creating issues to track them.
I don't think there is anything blocking. 🟢

* develop: (34 commits) Continued Execution Context work and some little fixes (#6506) IDE's logging to a file (#6478) Fix application config (#6513) Cloud/desktop mode switcher (#6448) Fix doubled named arguments bug (#6422) Reimplement `enso_project` as a proper builtin (#6352) Fix layer ordering between dropdown and breadcrumbs backgrounds. (#6483) Multiflavor layers (#6477) DataflowAnalysis preserves dependencies order (#6493) Implement `create_database_table` for Database Table (#6467) Limit Dead Letter logging (#6482) More reliable shutdown of the EnsoContext to save resources (#6468) Make execution mode `live` default for CLI (#6496) Finishing Vector Editor (#6470) Proper handling of multiple list views. (#6461) Fix disappearing cached shapes (#6458) Add Execution Context control to Text.write (#6459) Change defaults for `Connection.tables` and ensure that `Connection.query` recognizes all available tables (#6443) Introducing @BuiltinMethod.needsFrame and InlineableNode (#6442) Hide profile button behind a feature flag (#6430) ...

* develop: Fix cut-off in text visualisations (#6421) Infer correct synthetic name for nested modules (#6525) Delete unused websocket dependency (#6535) Run typecheck and eslint on `./run lint` (#6314) Force pending saves if client closes abruptly (#6514) Continued Execution Context work and some little fixes (#6506) IDE's logging to a file (#6478) Fix application config (#6513) Cloud/desktop mode switcher (#6448) Fix doubled named arguments bug (#6422) Reimplement `enso_project` as a proper builtin (#6352) Fix layer ordering between dropdown and breadcrumbs backgrounds. (#6483) Multiflavor layers (#6477) DataflowAnalysis preserves dependencies order (#6493) Implement `create_database_table` for Database Table (#6467) Limit Dead Letter logging (#6482) More reliable shutdown of the EnsoContext to save resources (#6468) Make execution mode `live` default for CLI (#6496)

somebody1234 added 3 commits April 27, 2023 14:15

Revert "Revert "Cloud/desktop mode switcher (#6308)" (#6444)"

3cf7185

This reverts commit d0e1dd5.

Lazily initialize project manager

810615d

Minor bugfix

1970caf

somebody1234 requested review from PabloBuchu and indiv0 as code owners April 27, 2023 08:01

PabloBuchu requested a review from wdanilo April 27, 2023 08:02

somebody1234 added 2 commits April 27, 2023 18:36

Convert backends to a discriminated union; don't remove CLI args for …

4806ff3

…desktop backend IDEs

Rename handleSubmit to onSubmit for consistency

1fce405

PabloBuchu added the CI: No changelog needed Do not require a changelog entry for this PR. label Apr 27, 2023

Remove duplicate UI; disable experimental UI

df4487e

somebody1234 marked this pull request as draft April 27, 2023 09:32

somebody1234 marked this pull request as ready for review April 27, 2023 09:41

PabloBuchu reviewed Apr 27, 2023

View reviewed changes

Address review

efa3e1a

PabloBuchu closed this Apr 27, 2023

PabloBuchu reopened this Apr 27, 2023

wdanilo requested changes Apr 27, 2023

View reviewed changes

PabloBuchu reviewed Apr 27, 2023

View reviewed changes

Address review

d0ddd31

somebody1234 added 2 commits April 28, 2023 01:16

Move new app.App into main

857a36c

Fixes

a967203

somebody1234 requested a review from wdanilo April 27, 2023 16:30

PabloBuchu requested a review from wdanilo April 28, 2023 16:52

PabloBuchu approved these changes Apr 28, 2023

View reviewed changes

wdanilo requested changes Apr 28, 2023

View reviewed changes

wdanilo reviewed Apr 28, 2023

View reviewed changes

Address review

4bc378d

wdanilo approved these changes May 1, 2023

View reviewed changes

Address review

522562c

somebody1234 added 4 commits May 1, 2023 21:02

Adjust backend check intervals

e0fd0b6

Minor bugfix

bb9730b

Fix type error

09ca400

Extract project manager URL into config.yaml

4c56e7d

somebody1234 requested a review from mwu-tow as a code owner May 1, 2023 11:22

somebody1234 added 2 commits May 2, 2023 15:33

Fix dashboard watch

5e1a29d

Finish renaming cloudBackend to remoteBackend

db2aecc

somebody1234 mentioned this pull request May 2, 2023

Fix dashboard issues #6502

Merged

5 tasks

Merge branch 'develop' into wip/sb/cloud-desktop-mode-switcher

bb6530f

PabloBuchu added the CI: Ready to merge This PR is eligible for automatic merge label May 2, 2023

mergify bot merged commit a1d48e7 into develop May 2, 2023

mergify bot deleted the wip/sb/cloud-desktop-mode-switcher branch May 2, 2023 17:48

	if (IS_DEV_MODE) {
	new EventSource(ESBUILD_PATH).addEventListener(ESBUILD_EVENT_NAME, () => {
	location.reload()
	})
	void navigator.serviceWorker.register(SERVICE_WORKER_PATH)
	}

	"wasmUrl": {
	"value": "pkg.wasm",
	"description": "The URL of the WASM pkg file generated by ensogl-pack.",
	"primary": false
	},
	"jsUrl": {
	"value": "pkg.js",
	"description": "The URL of the JS pkg file generated by ensogl-pack.",
	"primary": false
	},
	"assetsUrl": {
	"value": "assets",
	"description": "The URL of the dynamic assets directory.",
	"primary": false
	},


		import * as cloudService from '../dashboard/cloudService'
		import * as localService from '../dashboard/localService'

		// The `any` is unavoidable as `App.wasm` is typed as `any`.
		// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call

		@@ -0,0 +1,10 @@
		/** @file Interfaces common to multiple modules. */

		interface StringConfig {

		import * as backend from '../service'
		import * as backendApi from '../cloudBackendApi'

Cloud/desktop mode switcher #6448

Cloud/desktop mode switcher #6448

Conversation

somebody1234 commented Apr 27, 2023 • edited Loading

Pull Request Description

Important Notes

Screenshots

Checklist

PabloBuchu commented Apr 27, 2023 • edited Loading

somebody1234 commented Apr 27, 2023 • edited Loading

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

somebody1234 Apr 27, 2023 • edited Loading

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

somebody1234 May 1, 2023 • edited Loading

Choose a reason for hiding this comment

somebody1234 May 1, 2023 • edited Loading

Choose a reason for hiding this comment

somebody1234 commented Apr 27, 2023 • edited by unfurl-links bot Loading

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

wdanilo Apr 28, 2023 • edited Loading

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

PabloBuchu Apr 27, 2023 • edited Loading

Choose a reason for hiding this comment

somebody1234 commented Apr 27, 2023

somebody1234 commented Apr 27, 2023

somebody1234 commented Apr 27, 2023

indiv0 commented Apr 27, 2023

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

somebody1234 May 1, 2023 • edited Loading

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

somebody1234 commented Apr 27, 2023 •

edited

Loading

PabloBuchu commented Apr 27, 2023 •

edited

Loading

somebody1234 commented Apr 27, 2023 •

edited

Loading

somebody1234 Apr 27, 2023 •

edited

Loading

somebody1234 May 1, 2023 •

edited

Loading

somebody1234 May 1, 2023 •

edited

Loading

somebody1234 commented Apr 27, 2023 •

edited by unfurl-links bot

Loading

wdanilo Apr 28, 2023 •

edited

Loading

PabloBuchu Apr 27, 2023 •

edited

Loading

somebody1234 May 1, 2023 •

edited

Loading