Skip to content

[fix](useRecentlySelectedZone): Fix the initialization issue of state #749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2025
Merged

[fix](useRecentlySelectedZone): Fix the initialization issue of state #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/base/src/page/Nav/SideMenu/UserMenu/components/UserNavigate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,7 @@ const UserNavigate: React.FC<Props> = ({
const [open, setOpen] = useState(false);

//# if [ee]
const { clearRecentlySelectedZone } = useRecentlySelectedZone({
manualInit: true
});
const { clearRecentlySelectedZone } = useRecentlySelectedZone();
//# endif

const logout = () => {
Expand Down
1 change: 0 additions & 1 deletion packages/base/src/testUtils/mockHooks/data.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export const mockUseRecentlySelectedZoneData = {
availabilityZone: undefined,
updateRecentlySelectedZone: jest.fn(),
setAvailabilityZone: jest.fn(),
initializeAvailabilityZone: jest.fn(),
verifyRecentlySelectedZoneRecord: jest.fn(),
clearRecentlySelectedZone: jest.fn()
};
18 changes: 1 addition & 17 deletions packages/dms-kit/src/features/useRecentlySelectedZone/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ describe('useRecentlySelectedZone', () => {
localStorage.setItem(StorageKey.DMS_AVAILABILITY_ZONE, JSON.stringify([]));
});

it('should initialize from storage when manualInit is false (default)', () => {
it('should initialize from storage', () => {
const initial: Zone[] = [
{ uid: 'u1', name: 'zone-1' },
{ uid: 'u2', name: 'zone-2' }
Expand All @@ -32,22 +32,6 @@ describe('useRecentlySelectedZone', () => {
expect(result.current.availabilityZone).toEqual(initial[0]);
});

it('should not auto initialize when manualInit is true', () => {
const initial: Zone[] = [{ uid: 'u1', name: 'zone-1' }];
localStorage.setItem(
StorageKey.DMS_AVAILABILITY_ZONE,
JSON.stringify(initial)
);

const { result } = superRenderHook(() =>
useRecentlySelectedZone<Zone>({ manualInit: true })
);
expect(result.current.availabilityZone).toBeUndefined();

act(() => result.current.initializeAvailabilityZone());
expect(result.current.availabilityZone).toEqual(initial[0]);
});

it('should update record: move to front, unique, trim to max, and emit', () => {
const eventEmitterSpy = jest.spyOn(eventEmitter, 'emit');
const { result } = superRenderHook(() => useRecentlySelectedZone<Zone>());
Expand Down
32 changes: 16 additions & 16 deletions packages/dms-kit/src/features/useRecentlySelectedZone/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,22 @@ import { eventEmitter } from '../../utils/EventEmitter';

export const DEFAULT_MAX_SELECTED_ZONE_NUMBER = 3;

const useRecentlySelectedZone = <T extends { uid?: string; name?: string }>({
manualInit = false
}: { manualInit?: boolean } = {}) => {
const [availabilityZone, setAvailabilityZone] = useState<T>();
const useRecentlySelectedZone = <
T extends { uid?: string; name?: string }
>() => {
const [availabilityZone, setAvailabilityZone] = useState<T | undefined>(
() => {
const data = LocalStorageWrapper.get(StorageKey.DMS_AVAILABILITY_ZONE);
try {
const parsedData: T[] = JSON.parse(data || '[]');
return parsedData?.[0] ?? undefined;
} catch (error) {
// eslint-disable-next-line no-console
console.error(error);
return undefined;
}
}
);

const setStorageRecentlySelectedZoneRecord = useCallback((record: T[]) => {
LocalStorageWrapper.set(
Expand Down Expand Up @@ -88,22 +100,11 @@ const useRecentlySelectedZone = <T extends { uid?: string; name?: string }>({
}
};

const initializeAvailabilityZone = useCallback(() => {
const parsedData = getStorageZoneRecord();
setAvailabilityZone(parsedData?.[0] ?? undefined);
}, [getStorageZoneRecord]);

const clearRecentlySelectedZone = useCallback(() => {
setAvailabilityZone(undefined);
setStorageRecentlySelectedZoneRecord([]);
}, [setAvailabilityZone, setStorageRecentlySelectedZoneRecord]);

useEffect(() => {
if (!manualInit) {
initializeAvailabilityZone();
}
}, [initializeAvailabilityZone, manualInit]);

useEffect(() => {
const { unsubscribe } = eventEmitter.subscribe(
EmitterKey.DMS_SYNC_CURRENT_AVAILABILITY_ZONE,
Expand All @@ -115,7 +116,6 @@ const useRecentlySelectedZone = <T extends { uid?: string; name?: string }>({
return {
availabilityZone,
updateRecentlySelectedZone,
initializeAvailabilityZone,
verifyRecentlySelectedZoneRecord,
clearRecentlySelectedZone,
setAvailabilityZone
Expand Down