1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-22 11:45:59 +01:00

[PM-10381] Fix waiting for last sync - Browser Refresh (#10438)

* [PM-10381] Add activeUserLastSync$ to SyncService

* [PM-10381] Introduce waitUtil operator

* [PM-10381] Use new activeUserLastSync$ observable to wait until a sync completes before attempting to get decrypted ciphers

* [PM-10381] Fix failing test

---------

Co-authored-by: bnagawiecki <107435978+bnagawiecki@users.noreply.github.com>
This commit is contained in:
Shane Melton 2024-08-21 14:54:09 -07:00 committed by GitHub
parent bbe64f4ae6
commit a8edce2cc1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 63 additions and 5 deletions

View File

@ -30,6 +30,7 @@ describe("VaultPopupItemsService", () => {
let mockOrg: Organization; let mockOrg: Organization;
let mockCollections: CollectionView[]; let mockCollections: CollectionView[];
let activeUserLastSync$: BehaviorSubject<Date>;
const cipherServiceMock = mock<CipherService>(); const cipherServiceMock = mock<CipherService>();
const vaultSettingsServiceMock = mock<VaultSettingsService>(); const vaultSettingsServiceMock = mock<VaultSettingsService>();
@ -92,7 +93,8 @@ describe("VaultPopupItemsService", () => {
organizationServiceMock.organizations$ = new BehaviorSubject([mockOrg]); organizationServiceMock.organizations$ = new BehaviorSubject([mockOrg]);
collectionService.decryptedCollections$ = new BehaviorSubject(mockCollections); collectionService.decryptedCollections$ = new BehaviorSubject(mockCollections);
syncServiceMock.getLastSync.mockResolvedValue(new Date()); activeUserLastSync$ = new BehaviorSubject(new Date());
syncServiceMock.activeUserLastSync$.mockReturnValue(activeUserLastSync$);
testBed = TestBed.configureTestingModule({ testBed = TestBed.configureTestingModule({
providers: [ providers: [
@ -161,7 +163,7 @@ describe("VaultPopupItemsService", () => {
}); });
it("should not emit cipher list if syncService.getLastSync returns null", async () => { it("should not emit cipher list if syncService.getLastSync returns null", async () => {
syncServiceMock.getLastSync.mockResolvedValue(null); activeUserLastSync$.next(null);
const obs$ = service.autoFillCiphers$.pipe(timeout(50)); const obs$ = service.autoFillCiphers$.pipe(timeout(50));

View File

@ -9,6 +9,7 @@ import {
from, from,
map, map,
merge, merge,
MonoTypeOperatorFunction,
Observable, Observable,
of, of,
shareReplay, shareReplay,
@ -31,6 +32,7 @@ import { CipherType } from "@bitwarden/common/vault/enums";
import { CipherView } from "@bitwarden/common/vault/models/view/cipher.view"; import { CipherView } from "@bitwarden/common/vault/models/view/cipher.view";
import { runInsideAngular } from "../../../platform/browser/run-inside-angular.operator"; import { runInsideAngular } from "../../../platform/browser/run-inside-angular.operator";
import { waitUntil } from "../../util";
import { PopupCipherView } from "../views/popup-cipher.view"; import { PopupCipherView } from "../views/popup-cipher.view";
import { VaultPopupAutofillService } from "./vault-popup-autofill.service"; import { VaultPopupAutofillService } from "./vault-popup-autofill.service";
@ -80,8 +82,7 @@ export class VaultPopupItemsService {
).pipe( ).pipe(
runInsideAngular(inject(NgZone)), // Workaround to ensure cipher$ state provider emissions are run inside Angular runInsideAngular(inject(NgZone)), // Workaround to ensure cipher$ state provider emissions are run inside Angular
tap(() => this._ciphersLoading$.next()), tap(() => this._ciphersLoading$.next()),
switchMap(() => Utils.asyncToObservable(() => this.syncService.getLastSync())), waitUntilSync(this.syncService),
filter((lastSync) => lastSync !== null), // Only attempt to load ciphers if we performed a sync
switchMap(() => Utils.asyncToObservable(() => this.cipherService.getAllDecrypted())), switchMap(() => Utils.asyncToObservable(() => this.cipherService.getAllDecrypted())),
switchMap((ciphers) => switchMap((ciphers) =>
combineLatest([ combineLatest([
@ -270,3 +271,11 @@ export class VaultPopupItemsService {
return this.cipherService.sortCiphersByLastUsedThenName(a, b); return this.cipherService.sortCiphersByLastUsedThenName(a, b);
} }
} }
/**
* Operator that waits until the active account has synced at least once before allowing the source to continue emission.
* @param syncService
*/
const waitUntilSync = <T>(syncService: SyncService): MonoTypeOperatorFunction<T> => {
return waitUntil(syncService.activeUserLastSync$().pipe(filter((lastSync) => lastSync != null)));
};

View File

@ -0,0 +1,30 @@
import {
merge,
MonoTypeOperatorFunction,
Observable,
ObservableInput,
sample,
share,
skipUntil,
take,
} from "rxjs";
/**
* Operator that waits until the trigger observable emits before allowing the source to continue emission.
* @param trigger$ The observable that will trigger the source to continue emission.
*
* ```
* source$ a-----b-----c-----d-----e
* trigger$ ---------------X---------
* output$ ---------------c--d-----e
* ```
*/
export const waitUntil = <T>(trigger$: ObservableInput<any>): MonoTypeOperatorFunction<T> => {
return (source: Observable<T>) => {
const sharedSource$ = source.pipe(share());
return merge(
sharedSource$.pipe(sample(trigger$), take(1)),
sharedSource$.pipe(skipUntil(trigger$)),
);
};
};

View File

@ -1,4 +1,4 @@
import { firstValueFrom, map, of, switchMap } from "rxjs"; import { firstValueFrom, map, Observable, of, switchMap } from "rxjs";
import { ApiService } from "../../abstractions/api.service"; import { ApiService } from "../../abstractions/api.service";
import { AccountService } from "../../auth/abstractions/account.service"; import { AccountService } from "../../auth/abstractions/account.service";
@ -67,6 +67,17 @@ export abstract class CoreSyncService implements SyncService {
return this.stateProvider.getUser(userId, LAST_SYNC_DATE).state$; return this.stateProvider.getUser(userId, LAST_SYNC_DATE).state$;
} }
activeUserLastSync$(): Observable<Date | null> {
return this.accountService.activeAccount$.pipe(
switchMap((a) => {
if (a == null) {
return of(null);
}
return this.lastSync$(a.id);
}),
);
}
async setLastSync(date: Date, userId: UserId): Promise<void> { async setLastSync(date: Date, userId: UserId): Promise<void> {
await this.stateProvider.getUser(userId, LAST_SYNC_DATE).update(() => date); await this.stateProvider.getUser(userId, LAST_SYNC_DATE).update(() => date);
} }

View File

@ -34,6 +34,12 @@ export abstract class SyncService {
*/ */
abstract lastSync$(userId: UserId): Observable<Date | null>; abstract lastSync$(userId: UserId): Observable<Date | null>;
/**
* Retrieves a stream of the currently active user's last sync date.
* Or null if there is no current active user or the active user has not synced before.
*/
abstract activeUserLastSync$(): Observable<Date | null>;
/** /**
* Optionally does a full sync operation including going to the server to gather the source * Optionally does a full sync operation including going to the server to gather the source
* of truth and set that data to state. * of truth and set that data to state.