Add savingPinsEnabled to PersistableSettings

Author: roseayeon

tensorboard/webapp/metrics/metrics_module.ts

@@ -35,6 +35,7 @@ import {
   getMetricsScalarSmoothing,
   getMetricsStepSelectorEnabled,
   getMetricsTooltipSort,
+  getMetricsSavingPinsEnabled,
   getRangeSelectionHeaders,
   getSingleSelectionHeaders,
   isMetricsSettingsPaneOpen,
@@ -125,6 +126,12 @@ export function getMetricsTimeSeriesLinkedTimeEnabled() {
   });
 }
 
+export function getMetricsTimeSeriesSavingPinsEnabled() {
+  return createSelector(getMetricsSavingPinsEnabled, (isEnabled) => {
+    return {savingPinsEnabled: isEnabled};
+  });
+}
+
 export function getSingleSelectionHeadersFactory() {
   return createSelector(getSingleSelectionHeaders, (singleSelectionHeaders) => {
     return {singleSelectionHeaders};
@@ -188,6 +195,9 @@ export function getRangeSelectionHeadersFactory() {
     PersistentSettingsConfigModule.defineGlobalSetting(
       getRangeSelectionHeadersFactory
     ),
+    PersistentSettingsConfigModule.defineGlobalSetting(
+      getMetricsTimeSeriesSavingPinsEnabled
+    ),
   ],
   providers: [
     {

tensorboard/webapp/metrics/store/metrics_reducers.ts

@@ -608,6 +608,9 @@ const reducer = createReducer(
     if (typeof partialSettings.scalarSmoothing === 'number') {
       metricsSettings.scalarSmoothing = partialSettings.scalarSmoothing;
     }
+    if (typeof partialSettings.savingPinsEnabled === 'boolean') {
+      metricsSettings.savingPinsEnabled = partialSettings.savingPinsEnabled;
+    }
 
     const isSettingsPaneOpen =
       partialSettings.timeSeriesSettingsPaneOpened ?? state.isSettingsPaneOpen;

tensorboard/webapp/metrics/store/metrics_reducers_test.ts

@@ -3157,6 +3157,7 @@ describe('metrics reducers', () => {
           scalarSmoothing: 0.3,
           ignoreOutliers: false,
           tooltipSort: TooltipSort.ASCENDING,
+          savingPinsEnabled: true,
         }),
         settingOverrides: {
           scalarSmoothing: 0.5,
@@ -3170,13 +3171,15 @@ describe('metrics reducers', () => {
           partialSettings: {
             ignoreOutliers: true,
             tooltipSort: TooltipSort.DESCENDING,
+            savingPinsEnabled: false,
           },
         })
       );
 
       expect(nextState.settings.scalarSmoothing).toBe(0.3);
       expect(nextState.settings.ignoreOutliers).toBe(true);
       expect(nextState.settings.tooltipSort).toBe(TooltipSort.DESCENDING);
+      expect(nextState.settings.savingPinsEnabled).toBe(false);
       expect(nextState.settingOverrides.scalarSmoothing).toBe(0.5);
       expect(nextState.settingOverrides.tooltipSort).toBe(
         TooltipSort.ALPHABETICAL

tensorboard/webapp/persistent_settings/_data_source/persistent_settings_data_source.ts

@@ -125,6 +125,9 @@ export class OSSSettingsConverter extends SettingsConverter<
       serializableSettings.dashboardDisplayedHparamColumns =
         settings.dashboardDisplayedHparamColumns;
     }
+    if (settings.savingPinsEnabled !== undefined) {
+      serializableSettings.savingPinsEnabled = settings.savingPinsEnabled;
+    }
     return serializableSettings;
   }
 
@@ -256,6 +259,13 @@ export class OSSSettingsConverter extends SettingsConverter<
         backendSettings.dashboardDisplayedHparamColumns;
     }
 
+    if (
+      backendSettings.hasOwnProperty('savingPinsEnabled') &&
+      typeof backendSettings.savingPinsEnabled === 'boolean'
+    ) {
+      settings.savingPinsEnabled = backendSettings.savingPinsEnabled;
+    }
+
     return settings;
   }
 }

tensorboard/webapp/persistent_settings/_data_source/persistent_settings_data_source_test.ts

@@ -398,6 +398,20 @@ describe('persistent_settings data_source test', () => {
           ],
         });
       });
+
+      it('properly converts savingPinsEnabled', async () => {
+        getItemSpy.withArgs(TEST_ONLY.GLOBAL_LOCAL_STORAGE_KEY).and.returnValue(
+          JSON.stringify({
+            savingPinsEnabled: false,
+          })
+        );
+
+        const actual = await firstValueFrom(dataSource.getSettings());
+
+        expect(actual).toEqual({
+          savingPinsEnabled: false,
+        });
+      });
     });
 
     describe('#setSettings', () => {
@@ -526,6 +540,25 @@ describe('persistent_settings data_source test', () => {
           })
         );
       });
+
+      it('properly converts savingPinsEnabled', async () => {
+        getItemSpy
+          .withArgs(TEST_ONLY.GLOBAL_LOCAL_STORAGE_KEY)
+          .and.returnValue(null);
+
+        await firstValueFrom(
+          dataSource.setSettings({
+            savingPinsEnabled: false,
+          })
+        );
+
+        expect(setItemSpy).toHaveBeenCalledOnceWith(
+          TEST_ONLY.GLOBAL_LOCAL_STORAGE_KEY,
+          JSON.stringify({
+            savingPinsEnabled: false,
+          })
+        );
+      });
     });
 
     describe('settings migration', () => {

tensorboard/webapp/persistent_settings/_data_source/types.ts

@@ -47,6 +47,7 @@ export declare interface BackendSettings {
   singleSelectionHeaders?: ColumnHeader[];
   rangeSelectionHeaders?: ColumnHeader[];
   dashboardDisplayedHparamColumns?: ColumnHeader[];
+  savingPinsEnabled?: boolean;
 }
 
 /**
@@ -72,4 +73,5 @@ export interface PersistableSettings {
   singleSelectionHeaders?: ColumnHeader[];
   rangeSelectionHeaders?: ColumnHeader[];
   dashboardDisplayedHparamColumns?: ColumnHeader[];
+  savingPinsEnabled?: boolean;
 }