Expand parent directories of opened projects #11947

somebody1234 · 2024-12-30T07:50:20Z

Pull Request Description

https://github.com/enso-org/cloud-v2/issues/1499
- Expand parent directories of opened projects when switching to directories

Important Notes

None

Testing Instructions

Open a project on each backend (cloud and local) and test that it works for both
Open a project and make sure it's expanded on a different category (team category and root, user category and root, add subdirectory of enso/ to local favorites and open project)

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,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
~~Unit tests have been written where possible.~~
If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
or the Snowflake database integration, a run of the Extra Tests has been scheduled.
- ~~If applicable, it is suggested to paste a link to a successful run of the Extra Tests.~~

github-actions · 2024-12-30T07:53:19Z

🧪 Storybook is successfully deployed!

📊 Dashboard:

👀 Review changes: https://www.chromatic.com/build?appId=673738989fc3e8430364197e&number=896
👨‍🎨 Preview storybook: https://673738989fc3e8430364197e-dypnjeyatv.chromatic.com/

app/gui/src/dashboard/pages/dashboard/Dashboard.tsx

MrFlashAccount · 2025-01-06T09:43:52Z

app/gui/src/dashboard/components/dashboard/DirectoryNameColumn.tsx

  const { getText } = textProvider.useText()
  const driveStore = useDriveStore()
  const toggleDirectoryExpansion = useToggleDirectoryExpansion()
-  const isExpanded = useStore(driveStore, (storeState) =>
-    storeState.expandedDirectoryIds.includes(item.id),
+  const isExpanded = useStore(


This is a good candidate for encapsulation behind a hook

MrFlashAccount · 2025-01-06T09:47:32Z

app/gui/src/dashboard/components/dashboard/column/PathColumn.tsx

-      setCategory(categoryId)
-      setExpandedDirectoryIds(pathToDirectory.map(({ id }) => id).concat(targetDirectory))
+      setCategory(rootDirectoryInThePath.categoryId)
+      const expandedDirectories = structuredClone(driveStore.getState().expandedDirectories)


This is not good, this is a common thing to change and instead of encapsulating it behind a function/hook, we expose the internals outside.

Ideally, changing the expanded directories should not affect other components, because the logic should be encapsilated. Otherwise we violate SOLID principles

should not affect other components

wdym?

We're changing the internal structure of the data. If everything is encapsulated correctly, none of the consumers will be affected by this change. Internal change doesn't affect the API

MrFlashAccount · 2025-01-06T09:48:22Z

app/gui/src/dashboard/layouts/Drive/Categories/categoriesHooks.tsx

@@ -219,6 +222,10 @@ export function useLocalCategoryList() {
    type: 'local',
    id: 'local',
    label: getText('localCategory'),
+    /** The root path of this category. */
+    get rootPath() {


I don't get why it's a getter here

the root path of the local backend may change, and currently there's no way to reactively subscribe to it

getter doesn't make it reactive either

true, but we don't need it to be reactive afaik, we just need it to be correct at time of access, and this should (theoretically) do that

Theoretically? Do we use the path somewhere, except

enso/app/gui/src/dashboard/layouts/Drive/directoryIdsHooks.tsx

Line 57 in 21b3489

[category.rootPath, privateExpandedDirectoryIds, rootDirectoryId],

?

here is the main place where it is used:

enso/app/gui/src/dashboard/pages/dashboard/Dashboard.tsx

Line 350 in 21b3489

for (const [rootPath, directoriesInCategory] of unsafeEntries(expandedDirectories)) {

I also don't understand why it's so complex. Why don't we store what we need in the localstorage? Why we have to do these... manipulations. We don't do anything like that when we expand folders.

And in both places you don't need the getter

why it's so complex

because we need to traverse all ancestors here, not just the direct parent

afaict this is pretty difficult on the local backend because we don't have a real parentsPath - and it'd be a bit difficult to do this without making changes because currently directory ids on the cloud backend include slashes which conflicts with the slash delimiter used in parentsPath

Can we move this logic to LocalBackend and RemoteBackend? so we'll just call a method in related backend. Also I didn't see the unification with the Path column (AFAIR it does the same but for the cloud)

MrFlashAccount · 2025-01-06T09:50:21Z

app/gui/src/dashboard/pages/dashboard/Dashboard.tsx

+    setExpandedDirectories(expandedDirectories)
+  })
+
+  React.useEffect(() => {


Why we use useEffect here, instead of setting default values in the store?

as mentioned on discord a couple days ago: we can do that but this code depends on a couple of other stores (see the start of the function)

i feel like putting this code in the store will make the store too tightly coupled to the other stores, but if you think that's fine then i'm happy to make the change

We can pass the stores as props and keep them decoupled

Your code couples stores but in unobvious way

setting default values in the store

small problem: fetching parent directories for cloud projects is async

small problem: fetching parent directories for cloud projects is async

We have suspense for that, haven't we?

MrFlashAccount · 2025-01-06T09:53:43Z

app/gui/src/dashboard/pages/dashboard/Dashboard.tsx

+    const cloudProjects = launchedProjects.filter(
+      (project) => project.type === backendModule.BackendType.remote,
+    )
+    const promises = cloudProjects.map((project) =>


I remember we came to conclusion to get the data from a project asset? and add a ts lambda for that.

Also, This should be a suspense query, otherwise the tree will expand unexpectedly.

and add a ts lambda for that

sure, but adding a ts lambda is out of scope for this PR imo

MrFlashAccount

I'm not satisfied with the implementation

MrFlashAccount · 2025-01-06T10:53:10Z

🚫 Also, We need integration tests for this feature

MrFlashAccount · 2025-01-06T11:02:30Z

app/gui/src/dashboard/providers/__test__/DriveProvider.test.tsx

@@ -1,83 +0,0 @@
-import { DirectoryId } from '#/services/Backend'


Why did we remove the tests?

behavior has been changed so these tests are no longer relevant

we can write a new test in the same style if that works?

Yes for sure. Unrelevant tests can be removed, but we need to add new ones if we add a new behavior. Coverage shouldn't decrease

MrFlashAccount · 2025-01-06T11:14:48Z

app/gui/src/dashboard/providers/DriveProvider.tsx

@@ -41,8 +42,8 @@ interface DriveStore {
  readonly setCanDownload: (canDownload: boolean) => void
  readonly pasteData: PasteData<DrivePastePayload> | null
  readonly setPasteData: (pasteData: PasteData<DrivePastePayload> | null) => void
-  readonly expandedDirectoryIds: readonly DirectoryId[]
-  readonly setExpandedDirectoryIds: (selectedKeys: readonly DirectoryId[]) => void
+  readonly expandedDirectories: Record<Path, readonly DirectoryId[]>


Btw, why is it Path instead of CategoryId?

we want to expand parents of the current asset on all categories this asset appears in (so all categories whose path matches the path of the current asset)

How many categories can we have with the same asset ?

cloud: 2 (root + user or root + team)
local: unlimited (all parent directories of the asset, if multiple are favorited)

AFAIR for local projects id ~~~ path,
Root will be removed soon (no need to think about) as part of simplification

*local categories? yeah, fair enough. so, what's the verdict? switch to CategoryId now?

Yeah, if possible it's better to use ids instead

MrFlashAccount · 2025-01-06T11:17:40Z

app/gui/src/dashboard/providers/DriveProvider.tsx

-    const isExpanded = expandedDirectoryIds.includes(directoryId)
+  return useEventCallback((id: DirectoryId, override?: boolean) => {
+    const expandedDirectories = driveStore.getState().expandedDirectories
+    const isExpanded = expandedDirectories[category.rootPath]?.includes(id) ?? false


good candidate for encapsulation

somebody1234 added 2 commits December 26, 2024 18:52

Expand parent directories of opened projects

4c5729f

Fix expanding local directories

edddae0

somebody1234 added CI: No changelog needed Do not require a changelog entry for this PR. x-new-feature Type: new feature request g-dashboard labels Dec 30, 2024

somebody1234 requested review from PabloBuchu, indiv0 and MrFlashAccount as code owners December 30, 2024 07:50

somebody1234 added 2 commits December 30, 2024 18:03

Automatically expand "Users" or "Teams" root directory as appropriate

8269f4e

Fix errors

e5259d5

somebody1234 commented Dec 30, 2024

View reviewed changes

app/gui/src/dashboard/pages/dashboard/Dashboard.tsx Outdated Show resolved Hide resolved

somebody1234 added 4 commits December 31, 2024 00:17

Merge branch 'develop' into wip/sb/expand-parent-directories

7b96344

Only expand ancestors of initially launched projects once

b2b361b

WIP: Separate ancestor lists for each Drive sidebar category

e943fe1

Fix errors

2cee8ea

PabloBuchu approved these changes Jan 2, 2025

View reviewed changes

somebody1234 added 3 commits January 3, 2025 18:22

Merge branch 'develop' into wip/sb/expand-parent-directories

68000a7

Fix errors

364c3af

Fix bugs

1df6478

somebody1234 requested review from Frizi, farmaazon, vitvakatu, kazcw and AdRiley as code owners January 3, 2025 09:00

Remove obsolete test

21b3489

MrFlashAccount reviewed Jan 6, 2025

View reviewed changes

MrFlashAccount requested changes Jan 6, 2025

View reviewed changes

MrFlashAccount reviewed Jan 6, 2025

View reviewed changes

		@@ -1,83 +0,0 @@
		import { DirectoryId } from '#/services/Backend'

Expand parent directories of opened projects #11947

Are you sure you want to change the base?

Expand parent directories of opened projects #11947

Conversation

somebody1234 commented Dec 30, 2024

Pull Request Description

Important Notes

Testing Instructions

Checklist

github-actions bot commented Dec 30, 2024 • edited Loading

🧪 Storybook is successfully deployed!

📊 Dashboard:

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

MrFlashAccount Jan 6, 2025 • 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

MrFlashAccount Jan 6, 2025 • 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

MrFlashAccount left a comment

Choose a reason for hiding this comment

MrFlashAccount commented Jan 6, 2025 • 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

MrFlashAccount Jan 6, 2025 • 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

github-actions bot commented Dec 30, 2024 •

edited

Loading

MrFlashAccount Jan 6, 2025 •

edited

Loading

MrFlashAccount Jan 6, 2025 •

edited

Loading

MrFlashAccount commented Jan 6, 2025 •

edited

Loading

MrFlashAccount Jan 6, 2025 •

edited

Loading