[WIP] Handle sidebar groups config update

app/packages/state/src/recoil/sidebar.ts → app/packages/state/src/recoil/sidebar/index.ts

@@ -34,17 +34,17 @@ import {
   useRecoilStateLoadable,
   useRecoilValueLoadable,
 } from "recoil";
-import { collapseFields, getCurrentEnvironment } from "../utils";
-import * as atoms from "./atoms";
-import { getBrowserStorageEffectForKey } from "./customEffects";
+import { collapseFields, getCurrentEnvironment } from "../../utils";
+import * as atoms from "../atoms";
+import { getBrowserStorageEffectForKey } from "../customEffects";
 import {
   active3dSlices,
   active3dSlicesToSampleMap,
   activeModalSidebarSample,
   pinned3DSampleSlice,
-} from "./groups";
-import { isLargeVideo } from "./options";
-import { cumulativeValues, values } from "./pathData";
+} from "../groups";
+import { isLargeVideo } from "../options";
+import { cumulativeValues, values } from "../pathData";
 import {
   buildSchema,
   field,
@@ -53,23 +53,24 @@ import {
   filterPaths,
   isOfDocumentFieldList,
   pathIsShown,
-} from "./schema";
-import { isFieldVisibilityActive } from "./schemaSettings.atoms";
+} from "../schema";
+import { isFieldVisibilityActive } from "../schemaSettings.atoms";
 import {
   datasetName,
   disableFrameFiltering,
   isVideoDataset,
   stateSubscription,
-} from "./selectors";
-import { State } from "./types";
+} from "../selectors";
+import { State } from "../types";
 import {
   fieldsMatcher,
   groupFilter,
   labelsMatcher,
   primitivesMatcher,
   unsupportedMatcher,
-} from "./utils";
-import * as viewAtoms from "./view";
+} from "../utils";
+import * as viewAtoms from "../view";
+import { mergeGroups } from "./sidebar-utils";
 
 export enum EntryKind {
   EMPTY = "EMPTY",
@@ -210,6 +211,10 @@ export const resolveGroups = (
     ? DEFAULT_VIDEO_GROUPS
     : DEFAULT_IMAGE_GROUPS;
 
+  if (currentGroups.length && configGroups.length) {
+    groups = mergeGroups(groups, configGroups);
+  }
+
   const expanded = configGroups.reduce((map, { name, expanded }) => {
     map[name] = expanded;
     return map;

app/packages/state/src/recoil/sidebar/sidebar-utils.test.ts

@@ -0,0 +1,37 @@
+import { describe, expect, it, vi } from "vitest";
+
+vi.mock("recoil");
+vi.mock("recoil-relay");
+
+import { merge, mergeGroups } from "./sidebar-utils";
+
+describe("test sidebar groups resolution", () => {
+  it("test list merge", () => {
+    expect(merge([], ["one", "two"])).toStrictEqual(["one", "two"]);
+  });
+
+  it("merges current and config groups", () => {
+    expect(
+      mergeGroups(
+        [
+          { name: "one", paths: ["one.one", "one.three"] },
+          { name: "three", paths: [] },
+        ],
+
+        [
+          { name: "zero", paths: [] },
+          {
+            name: "one",
+            paths: ["one.zero", "one.one", "one.two"],
+          },
+          { name: "two", paths: [] },
+        ]
+      )
+    ).toStrictEqual([
+      { name: "zero", paths: [] },
+      { name: "one", paths: ["one.zero", "one.one", "one.two", "one.three"] },
+      { name: "two", paths: [] },
+      { name: "three", paths: [] },
+    ]);
+  });
+});

app/packages/state/src/recoil/sidebar/sidebar-utils.ts

@@ -0,0 +1,89 @@
+import type { State } from "../types";
+
+const hasNeighbor = (sink: string[], source: string[], key: string) => {
+  const index = source.indexOf(key);
+  const before = source[index - 1];
+  const after = source[index + 1];
+
+  return sink.includes(before) || sink.includes(after);
+};
+
+const insertFromNeighbor = (sink: string[], source: string[], key: string) => {
+  if (sink.includes(key)) {
+    return;
+  }
+
+  const sourceIndex = source.indexOf(key);
+  const before = source[sourceIndex - 1];
+  const beforeIndex = sink.indexOf(before);
+
+  if (beforeIndex >= 0) {
+    sink.splice(beforeIndex + 1, 0, key);
+    return;
+  }
+
+  const after = source[sourceIndex + 1];
+  const afterIndex = sink.indexOf(after);
+
+  if (afterIndex >= 0) {
+    sink.splice(afterIndex, 0, key);
+    return;
+  }
+
+  sink.push(key);
+  return;
+};
+
+export const merge = (sink: string[], source: string[]) => {
+  const missing = new Set(source.filter((key) => !sink.includes(key)));
+
+  while (missing.size) {
+    const force = [...missing].every(
+      (name) => !hasNeighbor(sink, source, name)
+    );
+    for (const name of missing) {
+      if (!force && !hasNeighbor(sink, source, name)) {
+        continue;
+      }
+
+      insertFromNeighbor(sink, source, name);
+
+      missing.delete(name);
+    }
+  }
+
+  return sink;
+};
+
+export const mergeGroups = (
+  sink: State.SidebarGroup[],
+  source: State.SidebarGroup[]
+) => {
+  // make copies, assume readonly
+  const mapping = Object.fromEntries(sink.map((g) => [g.name, { ...g }]));
+  const configMapping = Object.fromEntries(
+    source.map((g) => [g.name, { ...g }])
+  );
+
+  const sinkKeys = sink.map(({ name }) => name);
+  const sourceKeys = source.map(({ name }) => name);
+
+  merge(sinkKeys, sourceKeys);
+
+  for (const key of sinkKeys) {
+    mapping[key] = mapping[key] ?? configMapping[key];
+  }
+  const resolved = sinkKeys.map((g) => mapping[g] ?? configMapping[g]);
+  for (const { name } of resolved) {
+    const i = sourceKeys.indexOf(name);
+    if (i < 0) {
+      continue;
+    }
+
+    // make copies, assume readonly
+    mapping[name].paths = [...(mapping[name].paths ?? [])];
+    merge(mapping[name].paths, [...source[i].paths]);
+  }
+
+  return resolved;
+};

fiftyone/core/singletons.py

@@ -5,6 +5,7 @@
 | `voxel51.com <https://voxel51.com/>`_
 |
 """
+
 from collections import defaultdict
 import weakref
 
@@ -37,7 +38,9 @@ def __call__(cls, name=None, _create=True, *args, **kwargs):
             name = instance.name  # `__init__` may have changed `name`
         else:
             try:
-                instance._update_last_loaded_at()
+                instance._update_last_loaded_at(
+                    force=kwargs.get("_force_load", False)
+                )
             except ValueError:
                 instance._deleted = True
                 return cls.__call__(

fiftyone/core/state.py

@@ -97,7 +97,9 @@ def serialize(self, reflective=True):
 
             if self.dataset is not None:
                 d["dataset"] = self.dataset.name
-                collection = self.dataset
+                collection = fo.Dataset(
+                    self.dataset.name, _create=False, _force_load=True
+                )
                 if self.view is not None:
                     collection = self.view
 

fiftyone/server/query.py

@@ -585,11 +585,7 @@ def run():
         if not fod.dataset_exists(dataset_name):
             return None
 
-        dataset = fod.load_dataset(dataset_name)
-
-        if update_last_loaded_at:
-            dataset._update_last_loaded_at(force=True)
-
+        dataset = fo.Dataset(dataset_name, _create=False, _force_load=True)
         dataset.reload()
         view_name = None
         try: