Add project ids to all projects on open (#7949)

* Add project ids to all projects on open

* Fix id generation on web

* Add two simple project id tests

* make check

* cargo fmt

* Fix cargo test

* Update settings docs

* Fix named view test

* cargo fmt

* Fix named views

* Fix test

* make check

* Update src/lib/settings/initialSettings.tsx

Co-authored-by: Frank Noirot <[email protected]>

* address potential for bad heuristic

* revert

---------

Co-authored-by: Frank Noirot <[email protected]>

Author: lee-at-zoo-corp

docs/kcl-lang/settings/project.md

@@ -31,6 +31,23 @@ base_unit = "in"
 
 
 
+#### meta
+
+Information about the project itself. Choices about how settings are merged have prevent me (lee) from easily moving this out of the settings structure.
+
+
+**Default:** None
+
+This setting has the following nested options:
+
+##### id
+
+
+
+
+**Default:** None
+
+
 #### app
 
 The settings for the Design Studio.

e2e/playwright/fixtures/toolbarFixture.ts

@@ -50,6 +50,8 @@ export class ToolbarFixture {
   loadButton!: Locator
   /** User button for the user sidebar menu */
   userSidebarButton!: Locator
+  /** Project button for the project's settings */
+  projectSidebarToggle!: Locator
   signOutButton!: Locator
   /** Selection indicator text in the status bar */
   selectionStatus!: Locator
@@ -93,6 +95,7 @@ export class ToolbarFixture {
     this.gizmoDisabled = page.getByTestId('gizmo-disabled')
 
     this.userSidebarButton = page.getByTestId('user-sidebar-toggle')
+    this.projectSidebarToggle = page.getByTestId('project-sidebar-toggle')
     this.signOutButton = page.getByTestId('user-sidebar-sign-out')
 
     this.selectionStatus = page.getByTestId('selection-status')

e2e/playwright/named-views.spec.ts

@@ -39,8 +39,9 @@ nameToUuid.set('uuid3', uuid3)
  * Given the project.toml string, overwrite the named views to be the constant uuid
  * values to match the snapshots. The uuids are randomly generated
  */
-function tomlStringOverWriteNamedViewUuids(toml: string): string {
+function tomlStringMakeTestDataNotAsFragile(toml: string): string {
   const settings = tomlToPerProjectSettings(toml)
+  delete settings.settings?.meta
   const namedViews = settings.settings?.app?.named_views
   if (namedViews) {
     const entries = Object.entries(namedViews)
@@ -120,7 +121,7 @@ test.describe('Named view tests', () => {
       let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
 
       // Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
-      tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
+      tomlString = tomlStringMakeTestDataNotAsFragile(tomlString)
 
       // Write the entire tomlString to a snapshot.
       // There are many key/value pairs to check this is a safer match.
@@ -166,7 +167,7 @@ test.describe('Named view tests', () => {
       // Read project.toml into memory
       let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
       // Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
-      tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
+      tomlString = tomlStringMakeTestDataNotAsFragile(tomlString)
 
       // Write the entire tomlString to a snapshot.
       // There are many key/value pairs to check this is a safer match.
@@ -186,7 +187,7 @@ test.describe('Named view tests', () => {
       // Read project.toml into memory again since we deleted a named view
       let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
       // Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
-      tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
+      tomlString = tomlStringMakeTestDataNotAsFragile(tomlString)
 
       // Write the entire tomlString to a snapshot.
       // There are many key/value pairs to check this is a safer match.
@@ -232,7 +233,7 @@ test.describe('Named view tests', () => {
       // Read project.toml into memory
       let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
       // Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
-      tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
+      tomlString = tomlStringMakeTestDataNotAsFragile(tomlString)
 
       // Write the entire tomlString to a snapshot.
       // There are many key/value pairs to check this is a safer match.
@@ -301,7 +302,7 @@ test.describe('Named view tests', () => {
       // Read project.toml into memory
       let tomlString = await fsp.readFile(tempProjectSettingsFilePath, 'utf-8')
       // Rewrite the uuids in the named views to match snapshot otherwise they will be randomly generated from rust and break
-      tomlString = tomlStringOverWriteNamedViewUuids(tomlString)
+      tomlString = tomlStringMakeTestDataNotAsFragile(tomlString)
 
       // Write the entire tomlString to a snapshot.
       // There are many key/value pairs to check this is a safer match.

e2e/playwright/projects.spec.ts

@@ -1,6 +1,7 @@
 import fs from 'fs'
+import { NIL as uuidNIL } from 'uuid'
 import path from 'path'
-import { DEFAULT_PROJECT_KCL_FILE } from '@src/lib/constants'
+import { DEFAULT_PROJECT_KCL_FILE, REGEXP_UUIDV4 } from '@src/lib/constants'
 import fsp from 'fs/promises'
 
 import {
@@ -1799,3 +1800,68 @@ profile001 = startProfile(sketch001, at = [0, 0])
     })
   }
 )
+
+test.describe('Project id', () => {
+  // Should work on both web and desktop.
+  test(
+    'is created on new project',
+    {
+      tag: ['@desktop', '@web'],
+    },
+    async ({ page, toolbar, context, homePage }, testInfo) => {
+      const u = await getUtils(page)
+      await page.setBodyDimensions({ width: 1200, height: 500 })
+      await homePage.goToModelingScene()
+      await u.waitForPageLoad()
+
+      const inputProjectId = page.getByTestId('project-id')
+
+      await test.step('Open the project settings modal', async () => {
+        await toolbar.projectSidebarToggle.click()
+        await page.getByTestId('project-settings').click()
+        // Give time to system for writing to a persistent store
+        await page.waitForTimeout(1000)
+      })
+
+      await test.step('Check project id is not the NIL UUID and not empty', async () => {
+        await expect(inputProjectId).not.toHaveValue(uuidNIL)
+        await expect(inputProjectId).toHaveValue(REGEXP_UUIDV4)
+      })
+    }
+  )
+  test(
+    'is created on existing project without one',
+    { tag: '@desktop' },
+    async ({ page, toolbar, context, homePage }, testInfo) => {
+      const u = await getUtils(page)
+      await context.folderSetupFn(async (rootDir) => {
+        const projectDir = path.join(rootDir, 'hoohee')
+        await fsp.mkdir(projectDir, { recursive: true })
+        await fsp.writeFile(
+          path.join(projectDir, 'project.toml'),
+          `[settings.app]
+themeColor = "255"
+`
+        )
+      })
+
+      await page.setBodyDimensions({ width: 1200, height: 500 })
+      await homePage.goToModelingScene()
+      await u.waitForPageLoad()
+
+      const inputProjectId = page.getByTestId('project-id')
+
+      await test.step('Open the project settings modal', async () => {
+        await toolbar.projectSidebarToggle.click()
+        await page.getByTestId('project-settings').click()
+        // Give time to system for writing to a persistent store
+        await page.waitForTimeout(1000)
+      })
+
+      await test.step('Check project id is not the NIL UUID and not empty', async () => {
+        await expect(inputProjectId).not.toHaveValue(uuidNIL)
+        await expect(inputProjectId).toHaveValue(REGEXP_UUIDV4)
+      })
+    }
+  )
+})

rust/kcl-lib/src/settings/types/project.rs

@@ -41,6 +41,13 @@ impl ProjectConfiguration {
 #[ts(export)]
 #[serde(rename_all = "snake_case")]
 pub struct PerProjectSettings {
+    /// Information about the project itself.
+    /// Choices about how settings are merged have prevent me (lee) from easily
+    /// moving this out of the settings structure.
+    #[serde(default)]
+    #[validate(nested)]
+    pub meta: ProjectMetaSettings,
+
     /// The settings for the Design Studio.
     #[serde(default)]
     #[validate(nested)]
@@ -59,6 +66,15 @@ pub struct PerProjectSettings {
     pub command_bar: CommandBarSettings,
 }
 
+/// Information about the project.
+#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema, ts_rs::TS, PartialEq, Validate)]
+#[ts(export)]
+#[serde(rename_all = "snake_case")]
+pub struct ProjectMetaSettings {
+    #[serde(default, skip_serializing_if = "is_default")]
+    pub id: uuid::Uuid,
+}
+
 /// Project specific application settings.
 // TODO: When we remove backwards compatibility with the old settings file, we can remove the
 // aliases to camelCase (and projects plural) from everywhere.
@@ -167,7 +183,7 @@ mod tests {
 
     use super::{
         CommandBarSettings, NamedView, PerProjectSettings, ProjectAppSettings, ProjectAppearanceSettings,
-        ProjectConfiguration, ProjectModelingSettings, TextEditorSettings,
+        ProjectConfiguration, ProjectMetaSettings, ProjectModelingSettings, TextEditorSettings,
     };
     use crate::settings::types::UnitLength;
 
@@ -182,7 +198,9 @@ mod tests {
         let serialized = toml::to_string(&parsed).unwrap();
         assert_eq!(
             serialized,
-            r#"[settings.app]
+            r#"[settings.meta]
+
+[settings.app]
 
 [settings.modeling]
 
@@ -268,6 +286,7 @@ color = 1567.4"#;
     fn test_project_settings_named_views() {
         let conf = ProjectConfiguration {
             settings: PerProjectSettings {
+                meta: ProjectMetaSettings { id: uuid::Uuid::nil() },
                 app: ProjectAppSettings {
                     appearance: ProjectAppearanceSettings { color: 138.0.into() },
                     onboarding_status: Default::default(),
@@ -323,7 +342,9 @@ color = 1567.4"#;
             },
         };
         let serialized = toml::to_string(&conf).unwrap();
-        let old_project_file = r#"[settings.app]
+        let old_project_file = r#"[settings.meta]
+
+[settings.app]
 show_debug_panel = true
 
 [settings.app.appearance]

src/components/ProjectSidebarMenu.tsx

@@ -123,7 +123,9 @@ function ProjectMenuPopover({
           Element: 'button',
           children: (
             <>
-              <span className="flex-1">Project settings</span>
+              <span className="flex-1" data-testid="project-settings">
+                Project settings
+              </span>
               <kbd className="hotkey">{`${platform === 'macos' ? '⌘' : 'Ctrl'}${
                 isDesktop() ? '' : '⬆'
               },`}</kbd>

src/lib/constants.ts

@@ -248,3 +248,6 @@ export type EnvironmentConfigurationRuntime = {
 export const ENVIRONMENT_CONFIGURATION_FOLDER = 'envs'
 
 export const MAX_PROJECT_NAME_LENGTH = 240
+
+// It's so ugh that `uuid` package doesn't export this.
+export const REGEXP_UUIDV4 = /^[0-9A-F]{8}(-[0-9A-F]{4}){3}-[0-9A-F]{12}$/i

src/lib/routeLoaders.ts

@@ -35,16 +35,25 @@ export const fileLoader: LoaderFunction = async (
   routerData
 ): Promise<FileLoaderData | Response> => {
   const { params } = routerData
-  let { configuration } = await loadAndValidateSettings()
+
+  const isBrowserProject = params.id === decodeURIComponent(BROWSER_PATH)
+
+  const heuristicProjectFilePath =
+    isDesktop() && params.id
+      ? params.id
+          .split(window.electron.sep)
+          .slice(0, -1)
+          .join(window.electron.sep)
+      : undefined
+
+  let settings = await loadAndValidateSettings(heuristicProjectFilePath)
 
   const projectPathData = await getProjectMetaByRouteId(
     readAppSettingsFile,
     readLocalStorageAppSettingsFile,
     params.id,
-    configuration
+    settings.configuration
   )
-  const isBrowserProject = params.id === decodeURIComponent(BROWSER_PATH)
-
   let code = ''
 
   if (!isBrowserProject && projectPathData) {

src/lib/settings/initialSettings.tsx

@@ -5,13 +5,16 @@ import type { CameraProjectionType } from '@rust/kcl-lib/bindings/CameraProjecti
 import type { NamedView } from '@rust/kcl-lib/bindings/NamedView'
 import type { OnboardingStatus } from '@rust/kcl-lib/bindings/OnboardingStatus'
 
+import { NIL as uuidNIL } from 'uuid'
+
 import { CustomIcon } from '@src/components/CustomIcon'
 import Tooltip from '@src/components/Tooltip'
 import type { CameraSystem } from '@src/lib/cameraControls'
 import { cameraMouseDragGuards, cameraSystems } from '@src/lib/cameraControls'
 import {
   DEFAULT_DEFAULT_LENGTH_UNIT,
   DEFAULT_PROJECT_NAME,
+  REGEXP_UUIDV4,
 } from '@src/lib/constants'
 import { isDesktop } from '@src/lib/isDesktop'
 import type {
@@ -127,9 +130,6 @@ const MS_IN_MINUTE = 1000 * 60
 
 export function createSettings() {
   return {
-    /** Settings that affect the behavior of the entire app,
-     *  beyond just modeling or navigating, for example
-     */
     app: {
       /**
        * The overall appearance of the app: light, dark, or system
@@ -653,6 +653,32 @@ export function createSettings() {
         },
       }),
     },
+    /** Settings that affect the behavior of the entire app,
+     *  beyond just modeling or navigating, for example
+     *  NOTE: before using the project id for anything, check it isn't the
+     *  NIL uuid, which is the default value.
+     */
+    meta: {
+      id: new Setting<string>({
+        hideOnLevel: 'user',
+        defaultValue: uuidNIL,
+        description: 'The unique project identifier',
+        // Never allow the user to change the id, only view it.
+        validate: (v) => REGEXP_UUIDV4.test(v),
+        Component: ({ value }) => {
+          return (
+            <div className="flex gap-4 p-1 border rounded-sm border-chalkboard-30">
+              <input
+                className="flex-grow text-xs px-2 bg-chalkboard-30 dark:bg-chalkboard-80 cursor-not-allowed"
+                value={value}
+                disabled
+                data-testid="project-id"
+              />
+            </div>
+          )
+        },
+      }),
+    },
   }
 }