Skip to content
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

Add log about browser tab sleeping #34008

Merged
merged 4 commits into from
Jul 28, 2021
Merged

Add log about browser tab sleeping #34008

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
073b93c
Use a WebLock to prevent browser tab from sleeping
BrennanConroy Jul 1, 2021
bb3649c
fix condition
BrennanConroy Jul 1, 2021
5f5cffd
remove web lock
BrennanConroy Jul 19, 2021
48f49c6
Update src/SignalR/clients/ts/signalr/src/HubConnection.ts
BrennanConroy Jul 28, 2021
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
20 changes: 19 additions & 1 deletion src/SignalR/clients/ts/signalr/src/HubConnection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { ILogger, LogLevel } from "./ILogger";
import { IRetryPolicy } from "./IRetryPolicy";
import { IStreamResult } from "./Stream";
import { Subject } from "./Subject";
import { Arg, getErrorString } from "./Utils";
import { Arg, getErrorString, Platform } from "./Utils";

const DEFAULT_TIMEOUT_IN_MS: number = 30 * 1000;
const DEFAULT_PING_INTERVAL_IN_MS: number = 15 * 1000;
Expand Down Expand Up @@ -65,6 +65,11 @@ export class HubConnection {
private _timeoutHandle?: any;
private _pingServerHandle?: any;

private _freezeEventListener = () =>
{
this._logger.log(LogLevel.Warning, "The page is being frozen, this will likely lead to the connection being closed and messages being lost. For more information see the docs at https://docs.microsoft.com/aspnet/core/signalr/javascript-client#bsleep");
};

/** The server timeout in milliseconds.
*
* If this timeout elapses without receiving any messages from the server, the connection will be terminated with an error.
Expand Down Expand Up @@ -174,6 +179,13 @@ export class HubConnection {
try {
await this._startInternal();

if (Platform.isBrowser) {
if (document) {
// Log when the browser freezes the tab so users know why their connection unexpectedly stopped working
document.addEventListener("freeze", this._freezeEventListener);
}
}

this._connectionState = HubConnectionState.Connected;
this._connectionStarted = true;
this._logger.log(LogLevel.Debug, "HubConnection connected successfully.");
Expand Down Expand Up @@ -721,6 +733,12 @@ export class HubConnection {
this._connectionState = HubConnectionState.Disconnected;
this._connectionStarted = false;

if (Platform.isBrowser) {
if (document) {
document.removeEventListener("freeze", this._freezeEventListener);
}
}

try {
this._closedCallbacks.forEach((c) => c.apply(this, [error]));
} catch (e) {
Expand Down