Refactor persisted properties scroll into shared hook

Author: 4ian

Core/GDCore/Project/Object.cpp

@@ -147,6 +147,13 @@ Object& Object::ResetPersistentUuid() {
   return *this;
 }
 
+const gd::String& Object::GetPersistentUuid() const {
+  if (persistentUuid.empty()) {
+    persistentUuid = UUID::MakeUuid4();
+  }
+  return persistentUuid;
+}
+
 Object& Object::ClearPersistentUuid() {
   persistentUuid = "";
   objectVariables.ClearPersistentUuid();

Core/GDCore/Project/Object.h

@@ -242,6 +242,12 @@ class GD_CORE_API Object {
    */
   Object& ResetPersistentUuid();
 
+  /**
+   * \brief Return the persistent UUID, used to recognize
+   * the same object between serialization.
+   */
+  const gd::String& GetPersistentUuid() const;
+
   /**
    * \brief Remove the persistent UUID - when the object no
    * longer need to be recognized between serializations.

GDevelop.js/types.d.ts

@@ -789,6 +789,7 @@ export class gdObject extends EmscriptenObject {
   serializeTo(element: SerializerElement): void;
   unserializeFrom(project: Project, element: SerializerElement): void;
   resetPersistentUuid(): gdObject;
+  getPersistentUuid(): string;
   clearPersistentUuid(): gdObject;
 }
 

GDevelop.js/types/gdobject.js

@@ -20,6 +20,7 @@ declare class gdObject {
   serializeTo(element: gdSerializerElement): void;
   unserializeFrom(project: gdProject, element: gdSerializerElement): void;
   resetPersistentUuid(): gdObject;
+  getPersistentUuid(): string;
   clearPersistentUuid(): gdObject;
   delete(): void;
   ptr: number;

newIDE/app/src/AssetStore/InstallAsset.js

@@ -285,6 +285,7 @@ export const addAssetToProject = async ({
     );
     // The name was overwritten after unserialization.
     object.setName(newName);
+    object.resetPersistentUuid();
     object.setAssetStoreId(asset.id);
     if (project.hasEventsBasedObject(object.getType())) {
       const customObjectConfiguration = gd.asCustomObjectConfiguration(

newIDE/app/src/EditorFunctions/index.js

@@ -1084,6 +1084,7 @@ const createOrReplaceObject: EditorFunction = {
         project
       );
       newObject.setName(targetObjectName); // Unserialization has overwritten the name.
+      newObject.resetPersistentUuid();
 
       // Update behaviors shared data for the scene where the object was duplicated.
       if (target_object_scope === 'global') {

newIDE/app/src/InstancesEditor/CompactInstancePropertiesEditor/index.js

@@ -40,6 +40,7 @@ import { IconContainer } from '../../UI/IconContainer';
 import { getHelpLink } from '../../Utils/HelpLink';
 import Window from '../../Utils/Window';
 import { type ResourceManagementProps } from '../../ResourcesList/ResourceSource';
+import { usePersistedScrollPosition } from '../../Utils/UsePersistedScrollPosition';
 import EmptyMessage from '../../UI/EmptyMessage';
 import CompactBehaviorsEditorService from '../../ObjectEditor/CompactObjectPropertiesEditor/CompactBehaviorsEditorService';
 
@@ -165,6 +166,31 @@ export const CompactInstancePropertiesEditor = ({
     }
   }, []);
 
+  const scrollKey = instances
+    .map((instance: gdInitialInstance) => '' + instance.ptr)
+    .join(';');
+
+  const selectedObjectForScroll = React.useMemo(() => {
+    if (!instances.length) return null;
+
+    return getObjectByName(
+      globalObjectsContainer,
+      objectsContainer,
+      instances[0].getObjectName()
+    );
+  }, [globalObjectsContainer, instances, objectsContainer]);
+
+  const persistedScrollId = selectedObjectForScroll
+    ? selectedObjectForScroll.getPersistentUuid()
+    : null;
+
+  const onScroll = usePersistedScrollPosition({
+    project,
+    scrollViewRef,
+    scrollKey,
+    persistedScrollId,
+  });
+
   const { object, instanceSchema, allVisibleBehaviors } = React.useMemo<{|
     object?: gdObject,
     instanceSchema?: Schema,
@@ -313,9 +339,8 @@ export const CompactInstancePropertiesEditor = ({
         ref={scrollViewRef}
         autoHideScrollbar
         style={styles.scrollView}
-        key={instances
-          .map((instance: gdInitialInstance) => '' + instance.ptr)
-          .join(';')}
+        key={scrollKey}
+        onScroll={onScroll}
       >
         <Column expand noMargin id="instance-properties-editor">
           <Column>

newIDE/app/src/MainFrame/EditorTabs/UseEditorTabsStateSaving.js

@@ -96,7 +96,7 @@ const useEditorTabsStateSaving = ({
       setEditorStateForProject(
         currentProjectId,
         editorState.editors.length === 0
-          ? undefined
+          ? { editorTabs: null }
           : { editorTabs: editorState }
       );
     },
@@ -127,7 +127,8 @@ const useEditorTabsStateSaving = ({
   const hasAPreviousSaveForEditorTabsState = React.useCallback(
     (project: gdProject) => {
       const projectId = project.getProjectUuid();
-      return !!getEditorStateForProject(projectId);
+      const editorState = getEditorStateForProject(projectId);
+      return !!(editorState && editorState.editorTabs);
     },
     [getEditorStateForProject]
   );
@@ -136,7 +137,7 @@ const useEditorTabsStateSaving = ({
     (project: gdProject): number => {
       const projectId = project.getProjectUuid();
       const editorState = getEditorStateForProject(projectId);
-      if (!editorState) return 0;
+      if (!editorState || !editorState.editorTabs) return 0;
       let shouldOpenSavedCurrentTab = true;
 
       const editorsOpeningOptions = editorState.editorTabs.editors

newIDE/app/src/MainFrame/Preferences/PreferencesContext.js

@@ -175,6 +175,14 @@ export const allAlertMessages: Array<{
  * type and add a setter into `Preferences` type. Then, update the
  * preference dialog.
  */
+export type EditorStateForProject = {|
+  editorTabs: EditorTabsPersistedState | null,
+  propertiesPanelScroll: { [string]: number },
+|};
+
+// $FlowFixMe[deprecated-utility]
+export type EditorStateForProjectUpdate = $Shape<EditorStateForProject>;
+
 export type PreferencesValues = {|
   language: string,
   autoDownloadUpdates: boolean,
@@ -226,7 +234,7 @@ export type PreferencesValues = {|
     [featureId: string]: {| dates: [number] |},
   },
   displaySaveReminder: {| activated: boolean |}, // Store as object in case we need to add options.
-  editorStateByProject: { [string]: { editorTabs: EditorTabsPersistedState } },
+  editorStateByProject: { [string]: EditorStateForProject },
   fetchPlayerTokenForPreviewAutomatically: boolean,
   previewCrashReportUploadLevel: string,
   gamesDashboardOrderBy: GamesDashboardOrderBy,
@@ -346,10 +354,10 @@ export type Preferences = {|
   setDisplaySaveReminder: ({| activated: boolean |}) => void,
   getEditorStateForProject: (
     projectId: string
-  ) => ?{| editorTabs: EditorTabsPersistedState |},
+  ) => ?EditorStateForProject,
   setEditorStateForProject: (
     projectId: string,
-    editorState?: {| editorTabs: EditorTabsPersistedState |}
+    editorState: EditorStateForProjectUpdate | null
   ) => void,
   setFetchPlayerTokenForPreviewAutomatically: (enabled: boolean) => void,
   setPreviewCrashReportUploadLevel: (level: string) => void,

newIDE/app/src/MainFrame/Preferences/PreferencesProvider.js

@@ -5,6 +5,8 @@ import PreferencesContext, {
   initialPreferences,
   type Preferences,
   type AlertMessageIdentifier,
+  type EditorStateForProject,
+  type EditorStateForProjectUpdate,
 } from './PreferencesContext';
 import optionalRequire from '../../Utils/OptionalRequire';
 import { getIDEVersion } from '../../Version';
@@ -21,7 +23,6 @@ import { type EditorMosaicNode } from '../../UI/EditorMosaic';
 import { type FileMetadataAndStorageProviderName } from '../../ProjectsStorage';
 import defaultShortcuts from '../../KeyboardShortcuts/DefaultShortcuts';
 import { type CommandName } from '../../CommandPalette/CommandsList';
-import { type EditorTabsPersistedState } from '../EditorTabs/EditorTabsHandler';
 import {
   getBrowserLanguageOrLocale,
   setLanguageInDOM,
@@ -1249,24 +1250,54 @@ export default class PreferencesProvider extends React.Component<Props, State> {
   }
 
   _getEditorStateForProject(projectId: string): any {
-    return this.state.values.editorStateByProject[projectId];
+    const editorState = this.state.values.editorStateByProject[projectId];
+    if (!editorState) return null;
+
+    return {
+      editorTabs: editorState.editorTabs == null ? null : editorState.editorTabs,
+      propertiesPanelScroll: editorState.propertiesPanelScroll || {},
+    };
   }
 
   _setEditorStateForProject(
     projectId: string,
-    editorState?: {| editorTabs: EditorTabsPersistedState |}
+    editorState: EditorStateForProjectUpdate | null
   ) {
     this.setState(
-      state => ({
-        values: {
-          ...state.values,
-          editorStateByProject: {
-            ...state.values.editorStateByProject,
-            // $FlowFixMe[incompatible-type]
-            [projectId]: editorState,
+      state => {
+        const nextEditorStateByProject = {
+          ...state.values.editorStateByProject,
+        };
+
+        if (editorState === null) {
+          delete nextEditorStateByProject[projectId];
+        } else {
+          const previousEditorState = state.values.editorStateByProject[projectId] || {
+            editorTabs: null,
+            propertiesPanelScroll: {},
+          };
+          const mergedEditorState: EditorStateForProject = {
+            ...previousEditorState,
+            ...editorState,
+          };
+
+          if (
+            mergedEditorState.editorTabs === null &&
+            Object.keys(mergedEditorState.propertiesPanelScroll).length === 0
+          ) {
+            delete nextEditorStateByProject[projectId];
+          } else {
+            nextEditorStateByProject[projectId] = mergedEditorState;
+          }
+        }
+
+        return {
+          values: {
+            ...state.values,
+            editorStateByProject: nextEditorStateByProject,
           },
-        },
-      }),
+        };
+      },
       () => this._persistValuesToLocalStorage(this.state)
     );
   }