add spaces context to operators

app/packages/operators/src/CustomPanel.tsx

@@ -115,6 +115,8 @@ export function defineCustomPanel({
   on_change_selected_labels,
   on_change_extended_selection,
   on_change_group_slice,
+  on_change_spaces,
+  on_change_workspace,
   panel_name,
   panel_label,
 }) {
@@ -132,6 +134,8 @@ export function defineCustomPanel({
       onChangeSelectedLabels={on_change_selected_labels}
       onChangeExtendedSelection={on_change_extended_selection}
       onChangeGroupSlice={on_change_group_slice}
+      onChangeSpaces={on_change_spaces}
+      onChangeWorkspace={on_change_workspace}
       dimensions={dimensions}
       panelName={panel_name}
       panelLabel={panel_label}

app/packages/operators/src/hooks.ts

@@ -28,6 +28,8 @@ function useOperatorThrottledContextSetter() {
   const groupSlice = useRecoilValue(fos.groupSlice);
   const currentSample = useCurrentSample();
   const setContext = useSetRecoilState(operatorThrottledContext);
+  const spaces = useRecoilValue(fos.sessionSpaces);
+  const workspaceName = spaces._name;
   const setThrottledContext = useMemo(() => {
     return debounce(
       (context) => {
@@ -49,6 +51,8 @@ function useOperatorThrottledContextSetter() {
       currentSample,
       viewName,
       groupSlice,
+      spaces,
+      workspaceName,
     });
   }, [
     setThrottledContext,
@@ -61,6 +65,8 @@ function useOperatorThrottledContextSetter() {
     currentSample,
     viewName,
     groupSlice,
+    spaces,
+    workspaceName,
   ]);
 }
 

app/packages/operators/src/operators.ts

@@ -1,5 +1,6 @@
 import { AnalyticsInfo, usingAnalytics } from "@fiftyone/analytics";
-import { ServerError, getFetchFunction, isNullish } from "@fiftyone/utilities";
+import { SpaceNode, spaceNodeFromJSON, SpaceNodeJSON } from "@fiftyone/spaces";
+import { getFetchFunction, isNullish, ServerError } from "@fiftyone/utilities";
 import { CallbackInterface } from "recoil";
 import { QueueItemStatus } from "./constants";
 import * as types from "./types";
@@ -92,6 +93,8 @@ export type RawContext = {
   };
   groupSlice: string;
   queryPerformance?: boolean;
+  spaces: SpaceNodeJSON;
+  workspaceName: string;
 };
 
 export class ExecutionContext {
@@ -140,6 +143,12 @@ export class ExecutionContext {
   public get queryPerformance(): boolean {
     return Boolean(this._currentContext.queryPerformance);
   }
+  public get spaces(): SpaceNode {
+    return spaceNodeFromJSON(this._currentContext.spaces);
+  }
+  public get workspaceName(): string {
+    return this._currentContext.workspaceName;
+  }
 
   getCurrentPanelId(): string | null {
     return this.params.panel_id || this.currentPanel?.id || null;
@@ -548,6 +557,8 @@ async function executeOperatorAsGenerator(
       view: currentContext.view,
       view_name: currentContext.viewName,
       group_slice: currentContext.groupSlice,
+      spaces: currentContext.spaces,
+      workspace_name: currentContext.workspaceName,
     },
     "json-stream"
   );
@@ -712,6 +723,8 @@ export async function executeOperatorWithContext(
           view_name: currentContext.viewName,
           group_slice: currentContext.groupSlice,
           query_performance: currentContext.queryPerformance,
+          spaces: currentContext.spaces,
+          workspace_name: currentContext.workspaceName,
         }
       );
       result = serverResult.result;
@@ -815,6 +828,8 @@ export async function resolveRemoteType(
       view: currentContext.view,
       view_name: currentContext.viewName,
       group_slice: currentContext.groupSlice,
+      spaces: currentContext.spaces,
+      workspace_name: currentContext.workspaceName,
     }
   );
 
@@ -889,6 +904,8 @@ export async function resolveExecutionOptions(
       view: currentContext.view,
       view_name: currentContext.viewName,
       group_slice: currentContext.groupSlice,
+      spaces: currentContext.spaces,
+      workspace_name: currentContext.workspaceName,
     }
   );
 
@@ -920,6 +937,8 @@ export async function fetchRemotePlacements(ctx: ExecutionContext) {
       current_sample: currentContext.currentSample,
       view_name: currentContext.viewName,
       group_slice: currentContext.groupSlice,
+      spaces: currentContext.spaces,
+      workspace_name: currentContext.workspaceName,
     }
   );
   if (result && result.error) {

app/packages/operators/src/state.ts

@@ -95,6 +95,8 @@ const globalContextSelector = selector({
     const extendedSelection = get(fos.extendedSelection);
     const groupSlice = get(fos.groupSlice);
     const queryPerformance = typeof get(fos.lightningThreshold) === "number";
+    const spaces = get(fos.sessionSpaces);
+    const workspaceName = spaces?._name;
 
     return {
       datasetName,
@@ -107,6 +109,8 @@ const globalContextSelector = selector({
       extendedSelection,
       groupSlice,
       queryPerformance,
+      spaces,
+      workspaceName,
     };
   },
 });
@@ -148,6 +152,8 @@ const useExecutionContext = (operatorName, hooks = {}) => {
     extendedSelection,
     groupSlice,
     queryPerformance,
+    spaces,
+    workspaceName,
   } = curCtx;
   const [analyticsInfo] = useAnalyticsInfo();
   const ctx = useMemo(() => {
@@ -166,6 +172,8 @@ const useExecutionContext = (operatorName, hooks = {}) => {
         analyticsInfo,
         groupSlice,
         queryPerformance,
+        spaces,
+        workspaceName,
       },
       hooks
     );
@@ -182,6 +190,8 @@ const useExecutionContext = (operatorName, hooks = {}) => {
     currentSample,
     groupSlice,
     queryPerformance,
+    spaces,
+    workspaceName,
   ]);
 
   return ctx;

app/packages/operators/src/useCustomPanelHooks.ts

@@ -26,6 +26,8 @@ export interface CustomPanelProps {
   onChangeSelectedLabels?: string;
   onChangeExtendedSelection?: string;
   onChangeGroupSlice?: string;
+  onChangeSpaces?: string;
+  onChangeWorkspace?: string;
   dimensions: DimensionsType | null;
   panelName?: string;
   panelLabel?: string;
@@ -136,6 +138,13 @@ export function useCustomPanelHooks(props: CustomPanelProps): CustomPanelHooks {
     ctx.groupSlice,
     props.onChangeGroupSlice
   );
+  useCtxChangePanelEvent(isLoaded, panelId, ctx.spaces, props.onChangeSpaces);
+  useCtxChangePanelEvent(
+    isLoaded,
+    panelId,
+    ctx.workspaceName,
+    props.onChangeWorkspace
+  );
 
   useEffect(() => {
     onLoad();

docs/source/plugins/developing_plugins.rst

@@ -2060,6 +2060,32 @@ subsequent sections.
             ctx.panel.set_state("event", "on_change_group_slice")
             ctx.panel.set_data("event_data", event)
 
+        def on_change_spaces(self, ctx):
+            """Implement this method to set panel state/data when the current
+            state of spaces changes in the app.
+
+            The current state of spaces will be available via ``ctx.spaces``.
+            """
+            event = {
+                "data": ctx.spaces,
+                "description": "the current state of spaces",
+            }
+            ctx.panel.set_state("event", "on_change_spaces")
+            ctx.panel.set_data("event_data", event)
+
+        def on_change_workspace(self, ctx):
+            """Implement this method to set panel state/data when the current
+            workspace changes in the app.
+
+            The current workspace will be available via ``ctx.workspace``.
+            """
+            event = {
+                "data": ctx.workspace,
+                "description": "the current workspace",
+            }
+            ctx.panel.set_state("event", "on_change_workspace")
+            ctx.panel.set_data("event_data", event)
+
         #######################################################################
         # Custom events
         # These events are defined by user code above and, just like builtin

fiftyone/operators/executor.py

@@ -718,6 +718,22 @@ def query_performance(self):
         """Whether query performance is enabled."""
         return self.request_params.get("query_performance", None)
 
+    @property
+    def spaces(self):
+        """The current state of spaces in the app."""
+        spaces_dict = self.request_params.get("spaces", None)
+        if spaces_dict is None:
+            return None
+        return fo.Space.from_dict(spaces_dict)
+
+    @property
+    def workspace(self):
+        """The current workspace state in the app."""
+        workspace_name = self.request_params.get("workspace_name", None)
+        if workspace_name is None:
+            return None
+        return self.dataset.get_workspace_info(workspace_name)
+
     def prompt(
         self,
         operator_uri,

fiftyone/operators/operations.py

@@ -356,6 +356,8 @@ def register_panel(
                 current extended selection changes
             on_change_group_slice (None): an operator to invoke when the group
                 slice changes
+            on_change_spaces (None): an operator to invoke when the current spaces changes
+            on_change_workspace (None): an operator to invoke when the current workspace changes
             allow_duplicates (False): whether to allow multiple instances of
                 the panel to the opened
         """

fiftyone/operators/panel.py

@@ -126,6 +126,8 @@ def on_startup(self, ctx):
             "on_change_selected_labels",
             "on_change_extended_selection",
             "on_change_group_slice",
+            "on_change_spaces",
+            "on_change_workspace",
         ]
         for method in methods + ctx_change_events:
             if hasattr(self, method) and callable(getattr(self, method)):