Skip to content

refactor(client): use SDK storage helper in AuthenticationProvider.getLoginToken #40482

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

Open
ggazzo wants to merge 2 commits into
base: refactor/drop-unstore-login-token-monkey-patch
Choose a base branch
from
+71 −39
Open

refactor(client): use SDK storage helper in AuthenticationProvider.getLoginToken #40482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eda14b6
refactor(client): use SDK storage helper in AuthenticationProvider.ge…
ggazzo May 11, 2026
addc58e
refactor(client): replace useReactiveValue with useSyncExternalStore …
ggazzo May 13, 2026
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
9 changes: 0 additions & 9 deletions apps/meteor/client/hooks/useReactiveValue.ts
View file
Open in desktop

This file was deleted.

38 changes: 32 additions & 6 deletions apps/meteor/client/providers/AuthenticationProvider/AuthenticationProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ import { AuthenticationContext, useSetting } from '@rocket.chat/ui-contexts';
import { Accounts } from 'meteor/accounts-base';
import { Meteor } from 'meteor/meteor';
import type { ContextType, ReactElement, ReactNode } from 'react';
import { useMemo } from 'react';
import { useMemo, useSyncExternalStore } from 'react';

import { useLDAPAndCrowdCollisionWarning } from './hooks/useLDAPAndCrowdCollisionWarning';
import { capitalize as capitalizeService } from '../../../lib/utils/stringUtils';
import { useReactiveValue } from '../../hooks/useReactiveValue';
import { loginServices } from '../../lib/loginServices';
import { getDdpSdk } from '../../lib/sdk/ddpSdk';
import { STORAGE_KEYS, removeStoredItem } from '../../lib/sdk/storage';
import { STORAGE_KEYS, getStoredItem, removeStoredItem } from '../../lib/sdk/storage';

export type LoginMethods = keyof typeof Meteor extends infer T ? (T extends `loginWith${string}` ? T : never) : never;

Expand All @@ -29,7 +28,34 @@ const callLoginMethod = (
});
};

const getLoggingIn = () => Accounts.loggingIn();
// Bridge Accounts.loggingIn() — Meteor's Tracker-reactive flag — into a
// non-reactive subscribe/getSnapshot pair for useSyncExternalStore. We hook
// `_setLoggingIn` (Meteor's internal flip, also accessed in
// apps/meteor/client/meteor/overrides/killMeteorStream.ts) to fan out
// transitions without entering a Tracker computation.
const loggingInListeners = new Set<() => void>();
let loggingInBridgeInstalled = false;
const installLoggingInBridge = (): void => {
if (loggingInBridgeInstalled) return;
loggingInBridgeInstalled = true;
const wrap = Accounts as unknown as { _setLoggingIn?: (v: boolean) => void };
const original = wrap._setLoggingIn;
if (typeof original !== 'function') return;
wrap._setLoggingIn = function (this: typeof Accounts, v: boolean) {
original.call(this, v);
loggingInListeners.forEach((cb) => cb());
};
};
Comment on lines +41 to +48
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 13, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Silent fallback when _setLoggingIn is unavailable will leave isLoggingIn frozen.

Relying on the internal Accounts._setLoggingIn makes the bridge inherently fragile: if Meteor renames/removes it, typeof original !== 'function' triggers a silent return, useSyncExternalStore never receives notifications, and isLoggingIn stays at whatever Accounts.loggingIn() returned on first mount with no diagnostic. At minimum, log a warning in dev so this regression is observable; consider a Tracker-based fallback subscription if you want resilience without changing the rest of the API.

🛡️ Minimal diagnostic 
 	const original = wrap._setLoggingIn;
-	if (typeof original !== 'function') return;
+	if (typeof original !== 'function') {
+		console.warn('[AuthenticationProvider] Accounts._setLoggingIn unavailable; isLoggingIn will not update');
+		return;
+	}
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@apps/meteor/client/providers/AuthenticationProvider/AuthenticationProvider.tsx`
around lines 41 - 48, The current patch silently returns when
Accounts._setLoggingIn is missing which leaves isLoggingIn frozen; update the
hook so that if typeof wrap._setLoggingIn !== 'function' you log a dev-only
warning via console.warn (or process.env.NODE_ENV check) that
Accounts._setLoggingIn is unavailable and the login-state bridge may be broken,
and implement a fallback subscription that notifies loggingInListeners (and thus
useSyncExternalStore) when Tracker or Accounts.loggingIn() changes (e.g., use
Tracker.autorun to watch Accounts.loggingIn() and call each loggingInListeners
callback) so the component remains responsive even if _setLoggingIn is removed.


const subscribeLoggingIn = (cb: () => void): (() => void) => {
installLoggingInBridge();
loggingInListeners.add(cb);
return () => {
loggingInListeners.delete(cb);
};
};

const getLoggingInSnapshot = (): boolean => Accounts.loggingIn();

const AuthenticationProvider = ({ children }: AuthenticationProviderProps): ReactElement => {
const isLdapEnabled = useSetting('LDAP_Enable', false);
Expand All @@ -39,7 +65,7 @@ const AuthenticationProvider = ({ children }: AuthenticationProviderProps): Reac

useLDAPAndCrowdCollisionWarning();

const isLoggingIn = useReactiveValue(getLoggingIn);
const isLoggingIn = useSyncExternalStore(subscribeLoggingIn, getLoggingInSnapshot);

const contextValue = useMemo(
(): ContextType<typeof AuthenticationContext> => ({
Expand Down Expand Up @@ -125,7 +151,7 @@ const AuthenticationProvider = ({ children }: AuthenticationProviderProps): Reac
resolve();
});
}),
getLoginToken: () => Accounts.storageLocation.getItem(Accounts.LOGIN_TOKEN_KEY) ?? null,
getLoginToken: () => getStoredItem(STORAGE_KEYS.LOGIN_TOKEN),
wipeLocalAuth: () => {
removeStoredItem(STORAGE_KEYS.USER_ID);
removeStoredItem(STORAGE_KEYS.LOGIN_TOKEN);
Expand Down
63 changes: 39 additions & 24 deletions apps/meteor/client/providers/ServerProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ import type { Method, PathFor, OperationParams, OperationResult, UrlParams, Path
import type { UploadResult, ServerContextValue } from '@rocket.chat/ui-contexts';
import { ServerContext } from '@rocket.chat/ui-contexts';
import { Meteor } from 'meteor/meteor';
import { Tracker } from 'meteor/tracker';
import { compile } from 'path-to-regexp';
import { useMemo, type ReactNode } from 'react';
import { useMemo, useSyncExternalStore, type ReactNode } from 'react';

import { sdk } from '../../app/utils/client/lib/SDKClient';
import { Info as info } from '../../app/utils/rocketchat.info';
import { useReactiveValue } from '../hooks/useReactiveValue';
import { absoluteUrl } from '../lib/absoluteUrl';
import { ensureConnectedAndAuthenticated, getDdpSdk } from '../lib/sdk/ddpSdk';
import { isSdkTransportEnabled } from '../lib/sdk/sdkTransportEnabled';
Expand Down Expand Up @@ -99,16 +97,6 @@ const reconnect = sdkTransportEnabled
}
: () => Meteor.reconnect();

// With SDK transport on, combine Meteor's DDP status with DDPSDK's so the
// ConnectionStatusBar / idle-connection hooks reflect the worst-case of both
// transports. With the flag off, route status straight through Meteor —
// Meteor.status() is already Tracker-reactive, so adding a second dependency
// via the meteor-backed proxy's emitter would just double-fire the autorun.
const ddpSdkStatusDep = sdkTransportEnabled ? new Tracker.Dependency() : undefined;
if (sdkTransportEnabled) {
getDdpSdk().connection.on('connection', () => ddpSdkStatusDep!.changed());
}

type CombinedStatus = ReturnType<typeof Meteor.status>;

const sdkStatusToMeteor = (sdkStatus: string, meteor: CombinedStatus): CombinedStatus => {
Expand All @@ -132,21 +120,48 @@ const sdkStatusToMeteor = (sdkStatus: string, meteor: CombinedStatus): CombinedS
}
};

const getStatus = sdkTransportEnabled
? () => {
ddpSdkStatusDep!.depend();
return sdkStatusToMeteor(getDdpSdk().connection.status, Meteor.status());
}
: // useReactiveValue stores the snapshot in useSyncExternalStore, which
// compares by identity. Meteor.status() reuses the same internal object
// (mutated in place), so without spreading the snapshot reference never
// changes and ConnectionStatusBar stops re-rendering on connect/drop.
() => ({ ...Meteor.status() });
// With SDK transport on, combine Meteor's DDP status with DDPSDK's so the
// ConnectionStatusBar / idle-connection hooks reflect the worst-case of both
// transports. With the flag off, route status straight through Meteor —
// `meteorBackedSdk` already bridges Meteor's `_stream` events into
// `sdk.connection.on('connection')`, so the same subscription works in both
// modes.
const computeStatus: () => CombinedStatus = sdkTransportEnabled
? () => sdkStatusToMeteor(getDdpSdk().connection.status, Meteor.status())
: () => ({ ...Meteor.status() });

const isStatusEqual = (a: CombinedStatus, b: CombinedStatus): boolean =>
a.status === b.status && a.connected === b.connected && a.retryCount === b.retryCount && a.retryTime === b.retryTime;

let cachedStatus: CombinedStatus = computeStatus();
const statusListeners = new Set<() => void>();
let statusBridgeStarted = false;

const ensureStatusBridge = (): void => {
if (statusBridgeStarted) return;
statusBridgeStarted = true;
getDdpSdk().connection.on('connection', () => {
const next = computeStatus();
if (isStatusEqual(cachedStatus, next)) return;
cachedStatus = next;
statusListeners.forEach((cb) => cb());
});
};

const subscribeStatus = (cb: () => void): (() => void) => {
ensureStatusBridge();
statusListeners.add(cb);
return () => {
statusListeners.delete(cb);
};
};

const getStatusSnapshot = (): CombinedStatus => cachedStatus;

type ServerProviderProps = { children?: ReactNode };

const ServerProvider = ({ children }: ServerProviderProps) => {
const { connected, status, retryCount, retryTime } = useReactiveValue(getStatus);
const { connected, status, retryCount, retryTime } = useSyncExternalStore(subscribeStatus, getStatusSnapshot);

const value = useMemo(
(): ServerContextValue => ({
Expand Down
Loading