Allow users to give a project other than Upper_Snake_Case name #7397

4e6 · 2023-07-25T13:54:14Z

Pull Request Description

close #6356

Allow arbitrary names for user projects.

Important Notes

enso-rename-project-arbitrary-name.mp4

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.

4e6 · 2023-07-25T13:56:02Z

One question is, whether the IDE, when started, should show the module name or the display name of the project

somebody1234

the changes to JS code are minimal, so there shouldn't be any problems

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

farmaazon

I've checked the rust part. Looks ok, but see my comment about displaying project name.

farmaazon · 2023-07-26T12:57:21Z

app/gui/controller/engine-protocol/src/project_manager.rs

@@ -111,8 +111,7 @@ pub struct ProjectName(String);
 impl ProjectName {
    /// Create new ProjectName without any validation.
    ///
-    /// The caller is responsible for making sure that provided string is a valid project name
-    /// (e.g. not empty and starts with a capital letter).
+    /// The caller is responsible for making sure that provided string is a valid project name.


Are there invalid project names yet? If not, this ProjectName struct could be just replaced with string.

Technically there are some restrictions. It cannot be empty i.e. should contain at least one non-whitespace character. I would keep this newtype just to not confuse it with the module name or other strings.

farmaazon · 2023-07-26T13:18:59Z

app/gui/src/model/project/synchronized.rs

@@ -422,13 +422,13 @@ impl Project {
        let action = MissingComponentAction::Install;
        let opened = project_manager.open_project(&id, &action).await?;
        let namespace = opened.project_namespace;
-        let name = opened.project_name;
+        let module = opened.project_module;


We need to keep also the "real name" of the project, because now the "module" name will be displayed in GUI (in the left-top corner).

This should be fairy easy. We can also do that as a follow-up of this PR, depending on priorities.

I tried to update the IDE today, but it very quickly unfolded in a quite large change. I created an issue to fix it later #7409

JaroslavTulach

Few questions. For example I am not sure why should we use moduleName terminology?

engine/runtime/src/test/resources/Test_Simple_Imports/package.yaml

engine/runtime/src/test/resources/Test_Submodules/src/A/B.enso

lib/scala/pkg/src/main/scala/org/enso/pkg/Config.scala

lib/scala/pkg/src/main/scala/org/enso/pkg/Package.scala

...project-manager/src/main/scala/org/enso/projectmanager/service/MonadicProjectValidator.scala

JaroslavTulach · 2023-07-27T07:51:28Z

...-manager/src/main/scala/org/enso/projectmanager/service/validation/ModuleNameValidator.scala

+object ModuleNameValidator {
+
+  /** Base trait for validations failures. */
+  sealed trait ValidationFailure


Why do we have two ValidationFailure traits? One here and another in ProjectNameValidator?

...manager/src/main/scala/org/enso/projectmanager/service/validation/ProjectNameValidator.scala

JaroslavTulach · 2023-07-27T07:55:36Z

lib/scala/project-manager/src/test/scala/org/enso/projectmanager/ProjectManagementOps.scala

+      binHost       <- binAddr.downField("host").as[String]
+      binPort       <- binAddr.downField("port").as[Int]
+      projectName   <- result.downField("projectName").as[String]
+      projectModule <- result.downField("projectModule").as[String]


Is this changing content of package.yaml file? If so, then update /docs/distribution/packaging.md as that seems to contain the specification of the content of that file.

No, it just parses the JSON-RPC response. But I should update the packaging.md to include optional module field 👍

4e6 · 2023-07-28T08:30:03Z

We decided to use normalized_name instead of a module during the meeting today

hubertp

Minus Jaroslav's comments and the s/moduleName/normalizedName, the rest looks OK

hubertp · 2023-07-28T09:12:48Z

lib/scala/pkg/src/test/scala/org/enso/pkg/NameSanitizationSpec.scala

+      normalizeName("\uD83D\uDE80") shouldEqual "Project"
+      normalizeName("\uD83D\uDE80_\uD83D\uDE0A") shouldEqual "Project"
+      normalizeName("\uD83D\uDE80_\uD83D\uDE0A__") shouldEqual "Project"
+      normalizeName("_\uD83D\uDE80_\uD83D\uDE0A_") shouldEqual "Project"


so a project name like $$$ would also end up being named Project?

Yes, if the name does not have any legal (alphanumeric) characters, it defaults to Project

Followup to #7397. When started this refactoring I only changed the config types and forgot to change the API. Changelog: - refactor: rename `projectModule` to `projectNormalizedName` in the API # Important Notes https://github.com/enso-org/enso/assets/357683/a840dc90-15f8-4b6d-bbfb-571c53cd2f7d

4e6 added 6 commits July 25, 2023 14:44

update: s/name/module

49f6622

add: display name

be67462

update: rename handler

41aef4a

feat: create project specifying module name

331e252

misc: update ide validation

d697b83

misc: cleanup

63cbfd5

4e6 self-assigned this Jul 25, 2023

4e6 requested review from PabloBuchu, indiv0, somebody1234, JaroslavTulach, hubertp and Akirathan as code owners July 25, 2023 13:54

misc: update changelog

98589b7

somebody1234 approved these changes Jul 25, 2023

View reviewed changes

app/ide-desktop/lib/dashboard/src/authentication/src/dashboard/validation.ts Outdated Show resolved Hide resolved

4e6 added 5 commits July 25, 2023 17:30

misc: scalafmt

a6a2a79

refactor: pkg module

bd6adcf

fix: return package name

a8acb6f

fix: opening the project

9b4673a

fix: creating the project

132e341

4e6 requested review from MichaelMauderer, farmaazon, mwu-tow, kazcw, vitvakatu and Frizi as code owners July 25, 2023 16:46

4e6 added 3 commits July 26, 2023 15:15

update: remove pattern anchors

18a55d8

fix: project-manager tests compilation

172190d

fix: language server tests

7a8d3c0

4e6 added 5 commits July 26, 2023 16:01

fix: project-manager tests

665731f

Merge branch 'develop' into wip/db/6356-allow-users-to-name-the-project

12ccaad

fix: after merge

c6a02c5

misc: typo

62601a9

misc: simplify validation regex

a3f8bf9

farmaazon approved these changes Jul 26, 2023

View reviewed changes

fix: pkg tests

4ecdc93

4e6 mentioned this pull request Jul 26, 2023

IDE should display project name instead of a module name #7409

Closed

4e6 added 2 commits July 26, 2023 20:24

fix: gui test

d072d58

update: skip module name when creating project

d421bf8

JaroslavTulach reviewed Jul 27, 2023

View reviewed changes

doc: packaging

8ed0fea

enso-bot bot mentioned this pull request Jul 28, 2023

PanicSentinel value isn't propagated via Vector & co. #7245

Closed

hubertp approved these changes Jul 28, 2023

View reviewed changes

4e6 added 3 commits July 28, 2023 13:45

test: name normalization

da89b20

refactor: module/normalizedName

c263d27

refactor: normalized-name cli parameter

36bff0a

4e6 added the CI: Ready to merge This PR is eligible for automatic merge label Jul 28, 2023

mergify bot merged commit 80c4b1c into develop Jul 28, 2023
24 of 25 checks passed

mergify bot deleted the wip/db/6356-allow-users-to-name-the-project branch July 28, 2023 13:44

4e6 mentioned this pull request Jul 31, 2023

Refactor project normalized name #7444

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow users to give a project other than Upper_Snake_Case name #7397

Allow users to give a project other than Upper_Snake_Case name #7397

4e6 commented Jul 25, 2023

4e6 commented Jul 25, 2023

somebody1234 left a comment

farmaazon left a comment

farmaazon Jul 26, 2023

4e6 Jul 26, 2023 •

edited

Loading

farmaazon Jul 26, 2023

4e6 Jul 26, 2023

JaroslavTulach left a comment

JaroslavTulach Jul 27, 2023

JaroslavTulach Jul 27, 2023

4e6 Jul 27, 2023

4e6 commented Jul 28, 2023

hubertp left a comment

hubertp Jul 28, 2023

4e6 Jul 28, 2023

Allow users to give a project other than Upper_Snake_Case name #7397

Allow users to give a project other than Upper_Snake_Case name #7397

Conversation

4e6 commented Jul 25, 2023

Pull Request Description

Important Notes

Checklist

4e6 commented Jul 25, 2023

somebody1234 left a comment

Choose a reason for hiding this comment

farmaazon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

4e6 Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaroslavTulach 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

4e6 commented Jul 28, 2023

hubertp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

4e6 Jul 26, 2023 •

edited

Loading