Skip to content

Commit 87b3656

Browse files
authored
Cleanup: rename globalSettings to persistentSettings (#6390)
The current action name "globalSettingsLoaded" is actually about persistent settings, rename to make it clear.
1 parent 6d8d2be commit 87b3656

File tree

8 files changed

+28
-21
lines changed

8 files changed

+28
-21
lines changed

tensorboard/webapp/core/store/core_reducers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ limitations under the License.
1414
==============================================================================*/
1515
import {Action, createReducer, on} from '@ngrx/store';
1616
import {createNamespaceContextedState} from '../../app_routing/namespaced_state_reducer_helper';
17-
import {globalSettingsLoaded} from '../../persistent_settings';
17+
import {persistentSettingsLoaded} from '../../persistent_settings';
1818
import {DataLoadState} from '../../types/data';
1919
import {composeReducers} from '../../util/ngrx';
2020
import * as actions from '../actions';
@@ -154,7 +154,7 @@ const reducer = createReducer(
154154
sideBarWidthInPercent: Math.min(Math.max(0, widthInPercent), 100),
155155
};
156156
}),
157-
on(globalSettingsLoaded, (state, {partialSettings}) => {
157+
on(persistentSettingsLoaded, (state, {partialSettings}) => {
158158
const nextState = {...state};
159159

160160
const sideBarWidthInPercent = partialSettings.sideBarWidthInPercent;

tensorboard/webapp/feature_flag/store/feature_flag_reducers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ See the License for the specific language governing permissions and
1313
limitations under the License.
1414
==============================================================================*/
1515
import {Action, createReducer, on} from '@ngrx/store';
16-
import {globalSettingsLoaded, ThemeValue} from '../../persistent_settings';
16+
import {persistentSettingsLoaded, ThemeValue} from '../../persistent_settings';
1717
import * as actions from '../actions/feature_flag_actions';
1818
import {FeatureFlags} from '../types';
1919
import {initialState} from './feature_flag_store_config_provider';
@@ -72,7 +72,7 @@ const reducer = createReducer<FeatureFlagState>(
7272
flagOverrides: {},
7373
};
7474
}),
75-
on(globalSettingsLoaded, (state, {partialSettings}) => {
75+
on(persistentSettingsLoaded, (state, {partialSettings}) => {
7676
if (!partialSettings.themeOverride) {
7777
return state;
7878
}

tensorboard/webapp/metrics/store/metrics_reducers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {stateRehydratedFromUrl} from '../../app_routing/actions';
1818
import {createNamespaceContextedState} from '../../app_routing/namespaced_state_reducer_helper';
1919
import {RouteKind} from '../../app_routing/types';
2020
import * as coreActions from '../../core/actions';
21-
import {globalSettingsLoaded} from '../../persistent_settings';
21+
import {persistentSettingsLoaded} from '../../persistent_settings';
2222
import {DataLoadState} from '../../types/data';
2323
import {ElementId} from '../../util/dom';
2424
import {mapObjectValues} from '../../util/lang';
@@ -526,7 +526,7 @@ const reducer = createReducer(
526526
}
527527
return newState;
528528
}),
529-
on(globalSettingsLoaded, (state, {partialSettings}) => {
529+
on(persistentSettingsLoaded, (state, {partialSettings}) => {
530530
const metricsSettings: Partial<MetricsSettings> = {};
531531
if (
532532
partialSettings.tooltipSort &&

tensorboard/webapp/notification_center/_redux/notification_center_reducers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ See the License for the specific language governing permissions and
1313
limitations under the License.
1414
==============================================================================*/
1515
import {Action, createReducer, on} from '@ngrx/store';
16-
import {globalSettingsLoaded} from '../../persistent_settings';
16+
import {persistentSettingsLoaded} from '../../persistent_settings';
1717
import * as actions from './notification_center_actions';
1818
import {Notification, NotificationState} from './notification_center_types';
1919

@@ -43,7 +43,7 @@ const reducer = createReducer(
4343
}
4444
),
4545
on(
46-
globalSettingsLoaded,
46+
persistentSettingsLoaded,
4747
(state: NotificationState, {partialSettings}): NotificationState => {
4848
if (
4949
typeof partialSettings.notificationLastReadTimeInMs === 'undefined' ||

tensorboard/webapp/persistent_settings/_redux/persistent_settings_actions.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,12 @@ import {PersistableSettings} from '../_data_source/types';
1919
* Describes settings loaded from a global settings storage. Dispatched once
2020
* when the application bootstraps.
2121
*/
22-
export const globalSettingsLoaded = createAction(
22+
export const persistentSettingsLoaded = createAction(
2323
'[Persistent Settings] Global Settings Loaded',
2424
props<{
2525
partialSettings: Partial<PersistableSettings>;
2626
}>()
2727
);
28+
29+
// TODO(b/279035032): Removes this function once internal import are renamed.
30+
export const globalSettingsLoaded = persistentSettingsLoaded;

tensorboard/webapp/persistent_settings/_redux/persistent_settings_effects.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ See the License for the specific language governing permissions and
1313
limitations under the License.
1414
==============================================================================*/
1515
import {Injectable} from '@angular/core';
16-
import {Actions, createEffect, ofType, OnInitEffects} from '@ngrx/effects';
17-
import {Action, createAction, Store} from '@ngrx/store';
18-
import {EMPTY, merge, Observable} from 'rxjs';
16+
import {Actions, createEffect, ofType} from '@ngrx/effects';
17+
import {Store} from '@ngrx/store';
18+
import {EMPTY, Observable, merge} from 'rxjs';
1919
import {
2020
buffer,
2121
debounceTime,
@@ -29,12 +29,12 @@ import {
2929
tap,
3030
withLatestFrom,
3131
} from 'rxjs/operators';
32-
import {PersistentSettingsConfigModule} from '../persistent_settings_config_module';
32+
import * as appRoutingActions from '../../app_routing/actions';
3333
import {PersistentSettingsDataSource} from '../_data_source/persistent_settings_data_source';
3434
import {PersistableSettings} from '../_data_source/types';
35-
import {globalSettingsLoaded} from './persistent_settings_actions';
35+
import {PersistentSettingsConfigModule} from '../persistent_settings_config_module';
36+
import {persistentSettingsLoaded} from './persistent_settings_actions';
3637
import {getShouldPersistSettings} from './persistent_settings_selectors';
37-
import * as appRoutingActions from '../../app_routing/actions';
3838

3939
const DEBOUNCE_PERIOD_IN_MS = 500;
4040

@@ -55,7 +55,7 @@ export class PersistentSettingsEffects {
5555
filter(([, shouldPersistSettings]) => shouldPersistSettings),
5656
mergeMap(() => this.dataSource.getSettings()),
5757
tap((partialSettings) => {
58-
this.store.dispatch(globalSettingsLoaded({partialSettings}));
58+
this.store.dispatch(persistentSettingsLoaded({partialSettings}));
5959
}),
6060
// Give time for reducers to react to the action in a microtask.
6161
delay(0),

tensorboard/webapp/persistent_settings/index.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ See the License for the specific language governing permissions and
1313
limitations under the License.
1414
==============================================================================*/
1515

16+
export {PersistableSettings, ThemeValue} from './_data_source/types';
17+
// TODO(b/279035032): Removes globalSettingsLoaded export after internal import are renamed.
18+
export {
19+
persistentSettingsLoaded,
20+
globalSettingsLoaded,
21+
} from './_redux/persistent_settings_actions';
1622
export {PersistentSettingsConfigModule} from './persistent_settings_config_module';
1723
export {PersistentSettingsModule} from './persistent_settings_module';
18-
export {PersistableSettings, ThemeValue} from './_data_source/types';
19-
export {globalSettingsLoaded} from './_redux/persistent_settings_actions';

tensorboard/webapp/settings/_redux/settings_reducers.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ See the License for the specific language governing permissions and
1313
limitations under the License.
1414
==============================================================================*/
1515
import {Action, createReducer, on} from '@ngrx/store';
16-
import {globalSettingsLoaded} from '../../persistent_settings';
16+
import {persistentSettingsLoaded} from '../../persistent_settings';
1717
import {DataLoadState} from '../../types/data';
1818
import * as actions from './settings_actions';
19-
import {initialState, Settings, SettingsState} from './settings_types';
19+
import {Settings, SettingsState, initialState} from './settings_types';
2020

2121
/**
2222
* Check if settings are ready to modify. We want to reject modifications to
@@ -82,7 +82,7 @@ const reducer = createReducer(
8282
},
8383
};
8484
}),
85-
on(globalSettingsLoaded, (state, {partialSettings}) => {
85+
on(persistentSettingsLoaded, (state, {partialSettings}) => {
8686
const nextSettings: Partial<Settings> = {};
8787

8888
if (

0 commit comments

Comments
 (0)