Skip to content

Refactor/datasets content#437

Open
Creylay wants to merge 44 commits intodevelopfrom
refactor/datasets-content
Open

Refactor/datasets content#437
Creylay wants to merge 44 commits intodevelopfrom
refactor/datasets-content

Conversation

@Creylay
Copy link
Collaborator

@Creylay Creylay commented Jan 28, 2026

Summary

This PR refactors the DatasetsContent.jsx module, which had grown in complexity by mixing business logic, state management, and UI rendering in a single file. The refactor aims to improve code readability, maintainability, and scalability by separating concerns, extracting reusable and specific components, and preparing the codebase for future extensions and performance improvements.


Type of Change

Check all that apply like this [x]:

  • Backend change
  • Frontend change
  • CI / Workflow change
  • Build / Packaging change
  • Bug fix
  • Documentation

Changes (by file)

  • src/pages/datasets/DatasetsContent.jsx: Refactored to delegate business logic and UI state to specialized hooks, and to use new reusable layout components for a three-panel structure. Central render logic is now encapsulated in a dedicated subcomponent.
  • src/components/threeSectionLayout/panels/LeftPanel.jsx: Reusable left sidebar panel with show/hide and resize logic, using context for state.
  • src/components/threeSectionLayout/panels/RightPanel.jsx: Fully generic right sidebar panel, with customizable toggle button position via the toggleButtonTop prop, and context-driven state.
  • src/components/threeSectionLayout/panels/CenterPanel.jsx: Central panel that dynamically adjusts its width based on the state of the side panels.
  • src/components/notebooks/dataset/DatasetsCenterContent.jsx: New subcomponent that encapsulates all conditional rendering logic for the central panel, improving modularity and readability.
  • src/context/DatasetsAndNotebooksContext.jsx: Introduces a centralized Context Provider that exposes shared state and high-level operations for datasets and notebooks, eliminating prop drilling across the three-panel layout. The provider coordinates data access while delegating entity-specific business logic to dedicated hooks, resulting in a cleaner and more maintainable architecture.
  • src/hooks/datasets/useDatasets.js: Encapsulates all logic related to the Dataset entity (state, lifecycle, CRUD, polling, metadata enrichment).
  • src/hooks/datasets/useNotebooks.js: Manages state and operations for the Notebook entity, including its relationship with datasets.

Testing (optional)

  • Please verify that all dataset and notebook flows work as expected, including creation, editing, deletion, and navigation.
  • Check that the three-panel layout behaves correctly: panels can be shown/hidden and resized, and the toggle button appears in the correct position.
  • Ensure that the central content renders properly in all navigation states.

Notes (optional)

In summary, this refactor contains:

1) Datasets Module Hook Architecture

The Datasets module is now structured using multiple specialized hooks, each with a clearly defined responsibility. This reduces coupling, improves maintainability, and allows each part of the system to evolve independently.

  • useDatasets: Handles all Dataset entity logic (state, CRUD, polling, metadata enrichment).
  • useNotebooks: Manages Notebook entity state and operations, including its relationship with datasets.

2) Centralization of shared state via a Context Provider

**DatasetsAndNotebooksContent: **A Context Provider was introduced to expose shared datasets and notebooks state and actions, eliminating prop drilling and simplifying communication across the component tree.

  1. Introduction of a reusable three-panel layout architecture

3) Three Panel Layout Components

Reusable components were introduced to encapsulate the logic and presentation of a three-section layout (left, center, right):

  • LeftPanel: Manages the left sidebar, including show/hide transitions and dynamic width adjustment.
  • RightPanel: Fully generic right sidebar, with a customizable toggle button position (toggleButtonTop prop).
  • CenterPanel: Central panel that adapts its width based on the state of the side panels.

All panels use context to manage visibility, sizing, and user interaction events, and render their content via children.

4) Central Content Encapsulation

A new subcomponent, DatasetsCenterContent, was implemented to encapsulate and centralize the conditional rendering logic for the central panel of the datasets module. This improves readability, maintainability, and keeps the main file clean and modular.


…s directory and remove unused hooks for improved code structure and maintainability
…ed LeftPanel, CenterPanel, and RightPanel components for improved UI structure and maintainability
…tructure, moving SideBar and CenterBox to panelContainers, and implement DatasetsCenterContent for improved layout management and maintainability
…ate management and update related components for improved functionality
…Bar and removing redundant code from DatasetsContent
…otebook deletion logic and improve component interactions
…tebookEdit prop with editNotebook function for improved code clarity
…NotebookClick function in DatasetsNotebooksLeftBar and remove redundant notebook click handling from DatasetsContent for improved code organization
…ent handleNewSessionButton and handleNotebookCreated functions, removing redundant logic from DatasetsContent for improved code clarity and organization
…otebookFromDataset function to DatasetsCenterContent, removing it from DatasetsContent for improved code organization
…dDatasetFromNotebook prop, improving code clarity and organization by utilizing context for dataset creation
@Creylay Creylay requested a review from Irozuku February 4, 2026 13:21
Comment on lines 32 to 45
const resetUI = useCallback(() => {
setStep(0);
setSelectedOption(null);
}, []);

const goToDatasetFlow = useCallback(() => {
setStep(1);
setSelectedOption("dataset");
}, []);

const goToNotebookFlow = useCallback(() => {
setStep(1);
setSelectedOption("notebook");
}, []);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These useCallback hooks are not doing anything.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These useCallbacks improve the performance of the component avoiding redefining the funcion every render.
Anyways I did a small refactor beacause defining all this funcions is not necesary.

  const goToNextStep = useCallback(
    (option) => {
      if (option === "dataset") {
        setStep(1);
        setSelectedOption("dataset");
      } else {
        setStep(1);
        setSelectedOption("notebook");
      }

      clearSelectedDataset();
      clearSelectedNotebook();

      if (option === "dataset" && tourContext?.run) {
        setTimeout(() => {
          tourContext.nextStep();
        }, 600);
      }
    },
    [tourContext],
  );

setSelectedDatasetId(null);
}
await deleteDataset(id);
};
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should try to delete it from the server first. If it returns a 204, 200, or 202 HTTP status code, then delete it from the local list.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fix it.

  const deleteDatasetById = async (id) => {
    try {
      await deleteDataset(id);
      setDatasets((prev) => prev.filter((d) => d.id !== id));
      if (id === selectedDatasetId) {
        setSelectedDatasetId(null);
      }
      return true;
    } catch (error) {
      enqueueSnackbar(t("datasets:error.failedToDeleteDataset"), {
        variant: "error",
      });
      console.error("Error deleting dataset:", error);
    }
    return false;
  };

Cheking the exact status code is not necesary, beacause if it fails it will raise an exception.

Comment on lines 36 to 39
const deleteNotebookById = async (id) => {
setNotebooks((prev) => prev.filter((n) => n.id !== id));
await deleteNotebook(id);
};
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should try to delete it from the server first, and if it succeeds, delete it locally.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did the same changes that in deleteDatasetById.

  const deleteNotebookById = async (id) => {
    try{
      await deleteNotebook(id);
      setNotebooks((prev) => prev.filter((n) => n.id !== id));
      return true;
    } catch (error) {
      enqueueSnackbar(t("datasets:error.failedToDeleteNotebook"), {
        variant: "error",
      });
      console.error("Error deleting notebook:", error);
    }
    return false;
  };

…ation hook directly, improving code clarity and organization
…olidating step transitions and removing redundant functions, enhancing code clarity and maintainability
…edback, updating related translations for consistency
…eedback, adding translations for failure messages
…mponents, improving code consistency and clarity
…d prop and streamline existing props for clarity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants