@univerjs-pro/collaboration-client 0.4.0 → 0.4.1-experimental.20241023-bbb123f

package/lib/types/controllers/collaboration/collaboration-entity.d.ts

@@ -1,7 +1,6 @@
-import { IDisposable, IMutationInfo, ICommandService, ILogService, Injector, IPermissionService, LocaleService, RxDisposable } from '@univerjs/core';
+import { IDisposable, IMutationInfo, Nullable, ICommandService, ILogService, Injector, IPermissionService, LocaleService, RxDisposable } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
 import { Observable, BehaviorSubject } from 'rxjs';
-import { Nullable } from 'vitest';
 import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
 import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
 import { DocStateChangeManagerService } from '@univerjs/docs-ui';
@@ -60,6 +59,7 @@ export declare abstract class CollaborationEntity extends RxDisposable {
     private _applyRemoteChangeset;
     private _onRemoteACK;
     private _onRemoteRejected;
+    private _onRemoteRetry;
     private _onFetchMissResult;
     private _toggleOffline;
     private _toggleOnline;

package/lib/types/controllers/collaboration/collaboration-state.d.ts

@@ -1,5 +1,6 @@
 import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, Injector, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
+import { Observable } from 'rxjs';
 import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
 import { UniverType } from '@univerjs/protocol';
@@ -80,6 +81,10 @@ export declare abstract class CollaborationState {
     abstract onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    /**
+     * Received a retry message from the server, meaning that some unexpected error occurred in server.
+     */
+    abstract onRemoteRetry(changeset: IChangeset): CollaborationState;
     abstract toggleOffline(): CollaborationState;
     abstract toggleOnline(): CollaborationState;
     /**
@@ -117,6 +122,7 @@ export declare class SyncedState extends CollaborationState {
     private _onConflict;
     onRemoteAck(): never;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -142,6 +148,7 @@ export declare class PendingState extends CollaborationState {
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     /**
@@ -163,6 +170,9 @@ export declare class AwaitingState extends CollaborationState {
     private readonly _logService;
     private readonly _transformService;
     readonly status = CollaborationStatus.AWAITING;
+    private _resendTimeout;
+    private _resendTimer;
+    private _sender;
     constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, handler: ICollaborationStateHandler, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
@@ -170,10 +180,13 @@ export declare class AwaitingState extends CollaborationState {
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(changeset: IChangeset): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
     private _onConflict;
+    private _resendWithTimeout;
+    private _clearScheduledTask;
 }
 /**
  * Some local mutations are sent to the server and waiting for acknowledgement, yet still some local mutations
@@ -184,17 +197,26 @@ export declare class AwaitingWithPendingState extends CollaborationState {
     private readonly _logService;
     private readonly _transformService;
     readonly status = CollaborationStatus.AWAITING_WITH_PENDING;
-    constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
+    private _resendTimeout;
+    private _resendTimer;
+    private _sender;
+    constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, timer: Observable<{
+        timeout: number;
+        reqId: number;
+    }> | undefined, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(changeset: IAcknowledgedChangeset): CollaborationState;
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(changeset: IChangeset): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
     private _onConflict;
+    private _resendWithTimeout;
+    private _clearScheduledTask;
 }
 /**
  * This state is special for handling collaboration conflicts.
@@ -213,6 +235,7 @@ export declare class ConflictState extends CollaborationState {
     onRemoteChangeset(): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -228,6 +251,7 @@ export declare class OfflineState extends CollaborationState {
     onRemoteChangeset(_changeset: IChangeset): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -265,6 +289,7 @@ export declare class FetchingMissState extends CollaborationState {
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     private _onConflict;

package/lib/types/controllers/collaboration/utils/changeset-utils.d.ts

@@ -1,5 +1,6 @@
 import { IMutationInfo, IUniverInstanceService } from '@univerjs/core';
 import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
+import { Observable } from 'rxjs';
 import { MemberService } from '../../../services/member/member.service';
 export interface IAssembledChangeset {
     changeset: IChangeset;
@@ -14,3 +15,4 @@ export declare const SINGLE_CHANGESET_MUTATIONS: Set<string>;
  */
 export declare function assembleSheetChangeset(pendingMutations: IMutationInfo[], unitID: string, univerInstanceService: IUniverInstanceService, revisionService: RevisionService, memberService: MemberService): IAssembledChangeset;
 export declare function assembleDocChangeset(pendingMutations: IMutationInfo[], unitID: string, univerInstanceService: IUniverInstanceService, revisionService: RevisionService, memberService: MemberService): IAssembledChangeset;
+export declare function createTimerObservable$<T>(ms: number, options: T): Observable<T>;

package/lib/types/services/collaboration-session/collaboration-session.d.ts

@@ -1,11 +1,11 @@
-import { IConfigService, ILogService, LocaleService, RxDisposable, IDisposable, Nullable } from '@univerjs/core';
-import { ITelemetryService } from '@univerjs/telemetry';
-import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
+import { IDisposable, Nullable, IConfigService, ILogService, LocaleService, RxDisposable } from '@univerjs/core';
 import { ICollaborationEvent } from '@univerjs-pro/collaboration';
 import { Observable } from 'rxjs';
+import { ICollaborationSocket } from '../socket/collaboration-socket.service';
+import { ITelemetryService } from '@univerjs/telemetry';
+import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
 import { CommentService } from '../comment/comment.service';
 import { MemberService } from '../member/member.service';
-import { ICollaborationSocket } from '../socket/collaboration-socket.service';
 export declare enum SessionStatus {
     IDLE = 0,
     JOINING = 1,