Project Sharing #6077

mwu-tow · 2023-03-25T21:10:08Z

Pull Request Description

Enso will now associate with two file extensions:

.enso — Enso source file.
- If the source file belongs to a project under the Project Manager-managed directory, it will be opened.
- If the source file belongs to a project located elsewhere, it will be imported into the PM-managed directory and opened;
- otherwise, opening the .enseo file will fail. (e.g, loose source file without any project)
.enso-project — Enso project bundle, i.e. tar.gz archive containing a compressed Enso project directory.
- it will be imported under PM-managed directory, if needed a unique directory name shall be generated.

Important Notes

On Windows the NSIS installer is expected to handle the file associations.
On macOS the file associations are expected to be set up after the first time Enso is started,
On Linux, the file associations are not supported yet.

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.

# Conflicts: # app/ide-desktop/lib/client/src/config/parser.ts # app/ide-desktop/lib/client/src/index.ts # app/ide-desktop/lib/client/src/paths.ts

…aring

kazcw · 2023-03-27T16:02:43Z

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

+        // We parse only "client arguments", so we don't have to worry about the Electron-Dev vs
+        // Electron-Proper distinction.
+        let openedFile = attemptingToOpenFile(paths.clientArguments)
+        // If we are opening a file (i.e. we weere spawned with just a path of the file to open as


kazcw · 2023-03-27T16:22:15Z

app/ide-desktop/lib/client/src/projectManagement.ts

+
+/** Update project's metadata. If the provided updater does not return anything, the metadata file is left intact.
+ *
+ *  The updater function-returned metadata is passed over.


I don't understand this line, could you elaborate?

wdanilo · 2023-03-27T18:06:53Z

CHANGELOG.md

@@ -126,6 +126,7 @@
  shortened labels for entries with long module paths. When an option is
  selected from the dropdown, the necessary module imports are inserted,
  eliminating the need for fully qualified names.
+- [File associations on Windows and macOS][6077]


Make it a sentence (dot missing).

Please add here a little bit more words as this is user facing - it should explain in nice words what it enables :)

wdanilo · 2023-03-27T19:20:17Z

app/ide-desktop/lib/client/paths.ts

+export const SOURCE_FILE_EXTENSION = '.enso'
+
+export const BUNDLED_PROJECT_EXTENSION = '.enso-project'


I don't think this is a good place to keep these constants. As described, "This module defines paths within the client distribution's resources.". I'd keep these in a separate module dedicated to opening URLs functionality.

I will move this to the other project management stuff.

wdanilo · 2023-03-27T19:21:18Z

app/ide-desktop/lib/client/src/config/parser.ts

+    console.log(`Chrome options: ${chromeOptions}`)
+    console.log(`Arguments after stripping Chrome options: ${argv}`)


debug logs left in the code

wdanilo · 2023-03-27T19:28:41Z

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

+                extension === `.${paths.BUNDLED_PROJECT_EXTENSION}` ||
+                extension === `.${paths.SOURCE_FILE_EXTENSION}`


this should be a helper function.

wdanilo · 2023-03-27T19:29:21Z

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

+                extension === `.${paths.SOURCE_FILE_EXTENSION}`
+            ) {
+                // Not the file extension we care about, let the default handler handle it.
+                return


we are trying not to use early exists, couldd you just use if without return, please?

I don't understand it. You are checking the extensions and if they are our target extensions we are not handling them? Is the if condition correct? If it is, I need some explanation in the code here.

Good catch, the check must've got inverted when refactoring.

wdanilo · 2023-03-27T19:42:49Z

app/ide-desktop/lib/client/src/projectManagement.ts

+        // Otherwise, we need to install it first.
+        if (rootPath === null) {
+            // Perhaps bundle?
+            let message = `File '${openedPath}' does not belong to the Enso project.`


hardcoded product name

wdanilo · 2023-03-27T19:43:15Z

app/ide-desktop/lib/client/src/projectManagement.ts

+export function getCommonPrefix(a: string, b: string): string {
+    let i = 0
+    while (i < a.length && i < b.length && a[i] === b[i]) {
+        i++
+    }
+    return a.slice(0, i)
+}


this should be extracted to some string utils file

wdanilo · 2023-03-27T19:43:59Z

app/ide-desktop/lib/client/src/projectManagement.ts

+/** If the bundle consists of a single directory, return its name. Otherwise, return null. */
+export function bundleRootDirectory(bundlePath: string): string | null {


Function named bundleRootDirectory returns directory name and it is not bundling the files? Either name of this fn or docs are wrong and it makes it confusing to me.

I've changed the name.

wdanilo · 2023-03-27T19:44:51Z

app/ide-desktop/lib/client/src/projectManagement.ts

+    return updatedMetadata
+}
+
+/** Get the project root path from its subtree. */


Could you add here a sentence or two with better explanation what it means, please?

wdanilo · 2023-03-27T19:45:07Z

app/ide-desktop/lib/client/src/projectManagement.ts

+    return crypto.randomUUID()
+}
+
+export function updateId(projectRoot: string): string {


no docs - please check why linter did not catch it, it should

wdanilo · 2023-03-27T20:08:36Z

Btw, I adore how well the code is commented. Amazing job with it ❤️

farmaazon

My two cents. Sorry for late review.

farmaazon · 2023-03-30T13:21:19Z

app/gui/src/config.rs

    /// The project name we want to open on startup.
-    pub project_name:  Option<ProjectName>,
+    pub project_to_open: Option<ProjectToOpen>,


Not sure if you realized (the docs here weren't helpful TBH), but the option not always is "project to open" - in cloud (i.e. when we receive LS endpoints instead of PM endpoint) this is a name of project we connect to - so not project to open (as it is, technically, already opened), but project name.

As discussed on the call, no change needed here,

farmaazon · 2023-03-30T13:28:16Z

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

+ *
+ * @returns The path to the file to open, or `null` if no file was specified.
+ **/
+export function attemptingToOpenFile(clientArgs: string[]): string | null {


Why this function is called attempting instead of attempt or try? We were never using -ing endings in fn names.

Actually, this function does not attempt, only checks if the options say we are attempting, so I'd say the name is good.

farmaazon · 2023-03-30T13:31:11Z

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

@@ -74,6 +140,44 @@ class App {
        }
    }

+    processArguments() {


I think this function name is misleading. It does not only processes arguments, but also tries to open the file.

As my understanding of attemptingToOpenFile goes (see above), the processArguments name is good. The openedFile is the misleading name, actually.

farmaazon · 2023-03-30T13:35:11Z

app/ide-desktop/lib/client/src/projectManagement.ts

@@ -0,0 +1,237 @@
+/** @file This module contains functions for importing projects into the Project Manager.


we already have src/bin/project-manager. Having also src/projectManagement (btw, wring name style), is confusing. Can we somehow merge them or rename this file?

I'd recommend not merging, as there is nice responsibility separation (Project Mana-ger bindings vs Project Mana-gement)

…aring # Conflicts: # CHANGELOG.md

…aring # Conflicts: # CHANGELOG.md # app/ide-desktop/package-lock.json

wdanilo · 2023-04-04T10:51:12Z

app/ide-desktop/lib/client/src/file-associations.ts

+
+export * from '../file-associations'
+
+/* Check if the given path looks like a file that we can open. */


no sections

wdanilo · 2023-04-04T10:51:40Z

app/ide-desktop/lib/client/src/file-associations.ts

@@ -0,0 +1,65 @@
+import pathModule from 'node:path'


no module docs - linter should catch it. I've written about it in my previous code review - could you please check linter config and check why it did not report here?

@wdanilo I failed to find where the linter is invoked. I tried running ./run lint, and it found no issues, though I don't see it linted anything. How is the TS linting supposed to work now?

wdanilo · 2023-04-04T10:52:43Z

app/ide-desktop/lib/client/src/file-associations.ts

+            return handleOpenFile(path)
+        } else {
+            // We need to start another copy of the application, as the first one is already running.
+            logger.log(`We are already initialized, opening '${path}' in a new instance.`)


Very minot We are ... - The app is ... - this is just a little bit more formal.

wdanilo · 2023-04-04T10:54:51Z

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

+ *
+ * @returns The path to the file to open, or `null` if no file was specified.
+ **/
+export function attemptingToOpenFile(clientArgs: string[]): string | null {


Oh, then I'd still rename it to something like isDuringFileOpenAttempt.

TBH, I'd not understand this from the current docs Check if the given arguments show that we've been invoked with a file to open., especially the part we've been invoked with a file to open does not tell me that this function checks whether we are attempting currently to open a file. IT rather suggests me that this function was called with a file to open argument.

wdanilo · 2023-04-04T10:55:09Z

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

+ * @returns The path to the file to open, or `null` if no file was specified.
+ **/
+export function attemptingToOpenFile(clientArgs: string[]): string | null {
+    // If we are invoked with exactly one argument and this argument is a file, we assume that we have been


"if we" -> "if the app" , minor

wdanilo · 2023-04-04T10:55:51Z

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

+    // project containing this file.
+    if (clientArgs.length === 1 && clientArgs[0] !== undefined) {
+        try {
+            fsSync.accessSync(clientArgs[0])


if you extract const arg = cleintArgs[0], then several next lines will be simplified.

wdanilo · 2023-04-04T10:56:51Z

app/ide-desktop/lib/client/src/paths.ts

 import * as path from 'node:path'

 import * as electron from 'electron'
 import electronIsDev from 'electron-is-dev'

-import * as paths from '../paths'
+import * as paths from '../paths.js'


Why this change? I think we do not have any JS sources anymore here, right? So no extension should work.

Not needed anymore. Actually having or not JS files doesn't make a difference, you need to import TS with js extension.
The extension is needed when running this through ts-node, esbuild seems to not care.

wdanilo · 2023-04-04T10:57:59Z

app/ide-desktop/lib/client/src/paths.ts

+/** Decide what are client arguments, @see {@link clientArguments}. */
+function getClientArguments(): string[] {
+    if (electronIsDev) {
+        // Client arguments are separated from the electron dev mode arguments by a '--' argument.
+        const separator = '--'
+        const separatorIndex = process.argv.indexOf(separator)
+        if (separatorIndex === -1) {
+            // If there is no separator, client gets no arguments.
+            return []
+        } else {
+            // Drop everything before the separator.
+            return process.argv.slice(separatorIndex + 1)
+        }
+    } else {
+        // Drop the leading executable name.
+        return process.argv.slice(1)
+    }


I don't think this function suits this module, as it contains "File system paths used by the application.".

Agreed, moved this one.

wdanilo · 2023-04-04T10:58:22Z

app/ide-desktop/lib/client/src/project-management.ts

+// =======================
+// === Project Import ===


lines not aligned (too many = in first and third line).

…aring # Conflicts: # CHANGELOG.md

…aring

…aring # Conflicts: # CHANGELOG.md

* develop: Project Sharing (#6077) Adjust `{Table|Column}.parse` to use `Value_Type` (#6213) Add cloud endpoints for frontend (#6002) Implement `Table.union` for Database backend (#6204) Batch insert suggestions (#6189) Formatter fix to not fail when encountering an invalid symlink. (#6172) Suspended atom fields are evaluated only once (#6151) Text.to_display_text is (shortened) identity (#6174) Engine benchmark visualization tool can compare two bench runs (#6198) Add PRIVATE so function hidden from Component Browser and other tidying... (#6207) Hotfix for #6203. (#6210)

Enso will now associate with two file extensions: * `.enso` — Enso source file. * If the source file belongs to a project under the Project Manager-managed directory, it will be opened. * If the source file belongs to a project located elsewhere, it will be imported into the PM-managed directory and opened; * Otherwise, opening the `.enseo` file will fail. (e.g., loose source file without any project) * `.enso-project` — Enso project bundle, i.e., `tar.gz` archive containing a compressed Enso project directory. * it will be imported under the PM-managed directory; a unique directory name shall be generated if needed. ### Important Notes On Windows, the NSIS installer is expected to handle the file associations. On macOS, the file associations are expected to be set up after the first time Enso is started, On Linux, the file associations are not supported yet.

mwu-tow added 11 commits March 19, 2023 09:01

wip

7585664

Merge remote-tracking branch 'origin/develop' into develop

a2e2437

# Conflicts: # app/ide-desktop/lib/client/src/config/parser.ts # app/ide-desktop/lib/client/src/index.ts # app/ide-desktop/lib/client/src/paths.ts

post merge

9daa667

wip

0a5d279

wip

60c822a

cleanups, edge cases

6ad81ec

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

6a92572

…aring

cleanups

c704dba

respect PYTHON_PATH

550a570

cleanups

c67f912

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

b85c949

…aring

mwu-tow linked an issue Mar 26, 2023 that may be closed by this pull request

Adding easy way to share projects with a single file #5057

Closed

cleanups

5fef3f7

mwu-tow marked this pull request as ready for review March 27, 2023 09:07

mwu-tow requested review from MichaelMauderer, wdanilo, kazcw and farmaazon as code owners March 27, 2023 09:07

kazcw reviewed Mar 27, 2023

View reviewed changes

kazcw approved these changes Mar 27, 2023

View reviewed changes

wdanilo requested changes Mar 27, 2023

View reviewed changes

farmaazon reviewed Mar 30, 2023

View reviewed changes

mwu-tow added 4 commits March 30, 2023 22:29

cleanups

2ed4b97

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

97053fb

…aring # Conflicts: # CHANGELOG.md

fmt / cr

9eab67c

let/const

5c2baed

mwu-tow requested a review from wdanilo April 2, 2023 18:29

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

fdd1257

…aring # Conflicts: # CHANGELOG.md # app/ide-desktop/package-lock.json

wdanilo approved these changes Apr 4, 2023

View reviewed changes

mwu-tow added 6 commits April 5, 2023 22:31

Tons of cleanups

aa1ef2a

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

3ebe069

…aring # Conflicts: # CHANGELOG.md

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

0021056

…aring

Cleanups, CR

ab2c2af

Merge remote-tracking branch 'origin/develop' into wip/mwu/project-sh…

25698b0

…aring # Conflicts: # CHANGELOG.md

Merge branch 'develop' into wip/mwu/project-sharing

1dd6902

mwu-tow merged commit e7668eb into develop Apr 6, 2023

mwu-tow deleted the wip/mwu/project-sharing branch April 6, 2023 13:26

vitvakatu mentioned this pull request Apr 11, 2023

--ide-option does not work for ./run ide watch #6236

Closed

2 tasks

vitvakatu mentioned this pull request Jul 6, 2023

enso-project is not opening properly #7218

Closed

2 tasks

		export const SOURCE_FILE_EXTENSION = '.enso'

		export const BUNDLED_PROJECT_EXTENSION = '.enso-project'

		console.log(`Chrome options: ${chromeOptions}`)
		console.log(`Arguments after stripping Chrome options: ${argv}`)

		extension === `.${paths.BUNDLED_PROJECT_EXTENSION}` \|\|
		extension === `.${paths.SOURCE_FILE_EXTENSION}`

		/** If the bundle consists of a single directory, return its name. Otherwise, return null. */
		export function bundleRootDirectory(bundlePath: string): string \| null {

		@@ -0,0 +1,237 @@
		/** @file This module contains functions for importing projects into the Project Manager.


		export * from '../file-associations'

		/* Check if the given path looks like a file that we can open. */

Project Sharing #6077

Project Sharing #6077

Conversation

mwu-tow commented Mar 25, 2023 • edited Loading

Pull Request Description

Important Notes

Checklist

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

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 commented Mar 27, 2023

farmaazon 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

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

mwu-tow commented Mar 25, 2023 •

edited

Loading