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

Jump to bottom

Move EventSource to SharedWorker #12095

Merged
merged 22 commits into from
Jul 3, 2020
Merged

Move EventSource to SharedWorker #12095

merged 22 commits into from
Jul 3, 2020

Conversation

zeripath
Copy link
Contributor

@zeripath zeripath commented Jun 30, 2020 •
edited
Loading

Move EventSource to use a SharedWorker. This prevents issues with HTTP/1.1
open browser connections from preventing gitea from opening multiple tabs.
Also adds several options to control this.

Fix #11978

Signed-off-by: Andrew Thornton art27@cantab.net

@zeripath
Move EventSource to SharedWorker
b875eb8 
Move EventSource to use a SharedWorker. This prevents issues with HTTP/1.1
open browser connections from preventing gitea from opening multiple tabs.
Also adds several options to control this.

Fix go-gitea#11978

Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath zeripath added this to the 1.13.0 milestone Jun 30, 2020
@zeripath
Copy link
Contributor Author

The question is whether we need to provide a polyfill for EventSource - Firefox started providing EventSource in SharedWorker from FF 53 - which I think is below our minimum.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jun 30, 2020
zeripath
zeripath commented Jun 30, 2020
View reviewed changes
web_src/js/index.js
@@ -2491,6 +2490,7 @@ $(document).ready(async () => {
initClipboard(),
initUserHeatmap(),
initServiceWorker(),
initNotificationCount(),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This change is not strictly necessary but as it is technically async this seems reasonable to do so.

@zeripath
Also allow setting EVENT_SOURCE_UPDATE_TIME to disable EventSource up…
4c27b3f 
…dating

Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath zeripath mentioned this pull request Jun 30, 2020
Closed
7 tasks
@silverwind silverwind mentioned this pull request Jun 30, 2020
Merged
zeripath and others added 2 commits June 30, 2020 18:28
@zeripath @silverwind
as per @silverwind
261e401 
Co-authored-by: silverwind <me@silverwind.io>
@zeripath @silverwind
as per @silverwind
eca09df 
Co-authored-by: silverwind <me@silverwind.io>
@silverwind
Copy link
Member

silverwind commented Jun 30, 2020 •
edited
Loading

Safari seems to not have SharedWorker in recent versions, so I guess it would need a fallback and be affected by the connection limit?

I guess we don't want a fallback at all to prevent hitting the connection limit.

@zeripath
Copy link
Contributor Author

@silverwind we could always just fall back to polling?

@silverwind
Copy link
Member

I'd say fallback to polling if SharedWorker is unavailable. As I understand it, EventSource will always hog a connection so we can't open one on every tab. Whether this is done in a regular worker or on the main thread should not matter because the connection limit could be enforced by the server or a proxy between.

@zeripath
Remove the plain Worker and EventSource fallbacks
4033888 
Signed-off-by: Andrew Thornton <art27@cantab.net>
zeripath
zeripath commented Jun 30, 2020
View reviewed changes
custom/conf/app.example.ini Outdated Show resolved Hide resolved
zeripath and others added 3 commits June 30, 2020 20:36
@zeripath
as per @silverwind
7c83c21 
Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath
as per @silverwind
11e1638 
Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath @silverwind
as per @silverwind
e4bab08 
Co-authored-by: silverwind <me@silverwind.io>
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 2, 2020
@silverwind
Copy link
Member

Suggestion to set correct linter config for *worker.js files:

diff --git a/.eslintrc b/.eslintrc
index 1a7551aee..c430a34ff 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -27,9 +27,9 @@ globals:
   u2fApi: false
   Tribute: false

 overrides:
-  - files: ["web_src/**/*.worker.js", "web_src/js/serviceworker.js"]
+  - files: ["**/*worker.js"]
     env:
       worker: true

 rules:

techknowlogick
techknowlogick approved these changes Jul 2, 2020
View reviewed changes
Copy link
Member

@techknowlogick techknowlogick left a comment

Choose a reason for hiding this comment

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

the tiniest of nits, otherwise lgtm.

+1 for silverwinds recent comment too.

docs/content/doc/advanced/config-cheat-sheet.en-us.md Outdated Show resolved Hide resolved
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jul 2, 2020
@zeripath
As per @silverwind, @lafriks and @techknowlogick
e362de1 
Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath
Copy link
Contributor Author

zeripath commented Jul 3, 2020

make lg-tm work

@zeripath zeripath merged commit ae56411 into go-gitea:master Jul 3, 2020
@zeripath zeripath deleted the notification-shared-worker branch July 3, 2020 09:55
@zeripath zeripath mentioned this pull request Jul 3, 2020
Merged
zeripath added a commit to zeripath/gitea that referenced this pull request Jul 3, 2020
@zeripath @silverwind @techknowlogick
Move EventSource to SharedWorker (go-gitea#12095)
1bc7334 
Backport go-gitea#12095

Move EventSource to use a SharedWorker. This prevents issues with HTTP/1.1
open browser connections from preventing gitea from opening multiple tabs.

Also allow setting EVENT_SOURCE_UPDATE_TIME to disable EventSource updating

Fix go-gitea#11978

Signed-off-by: Andrew Thornton <art27@cantab.net>

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
@zeripath zeripath mentioned this pull request Jul 3, 2020
Merged
zeripath added a commit to zeripath/gitea that referenced this pull request Jul 4, 2020
@zeripath
Re-fix go-gitea#12095 again
d7ba7d9 
Unfortunately some of the suggested changes to go-gitea#12095 introduced
bugs which due to caching behaviour of sharedworkers were not caught
on simple tests.

These are as follows:

* Changing from simple for loop to use includes here:

```js
  register(port) {
    if (!this.clients.includes(port)) return;

    this.clients.push(port);

    port.postMessage({
      type: 'status',
      message: `registered to ${this.url}`,
    });
  }
```

The additional `!` prevents any clients from being added and should
read:

```js
    if (this.clients.includes(port)) return;
```

* Dropping the use of jQuery `$(...)` selection and using DOM
`querySelector` here:

```js
async function receiveUpdateCount(event) {
  try {
    const data = JSON.parse(event.data);

    const notificationCount = document.querySelector('.notification_count');
    if (data.Count > 0) {
      notificationCount.classList.remove('hidden');
    } else {
      notificationCount.classList.add('hidden');
    }

    notificationCount.text() = `${data.Count}`;
    await updateNotificationTable();
  } catch (error) {
    console.error(error, event);
  }
}
```

Requires that `notificationCount.text()` be changed to use `textContent`
instead.

Signed-off-by: Andrew Thornton <art27@cantab.net>
zeripath added a commit to zeripath/gitea that referenced this pull request Jul 4, 2020
@zeripath
Re-fix go-gitea#12095 again
ff80872 
Unfortunately some of the suggested changes to go-gitea#12095 introduced
bugs which due to caching behaviour of sharedworkers were not caught
on simple tests.

These are as follows:

* Changing from simple for loop to use includes here:

```js
  register(port) {
    if (!this.clients.includes(port)) return;

    this.clients.push(port);

    port.postMessage({
      type: 'status',
      message: `registered to ${this.url}`,
    });
  }
```

The additional `!` prevents any clients from being added and should
read:

```js
    if (this.clients.includes(port)) return;
```

* Dropping the use of jQuery `$(...)` selection and using DOM
`querySelector` here:

```js
async function receiveUpdateCount(event) {
  try {
    const data = JSON.parse(event.data);

    const notificationCount = document.querySelector('.notification_count');
    if (data.Count > 0) {
      notificationCount.classList.remove('hidden');
    } else {
      notificationCount.classList.add('hidden');
    }

    notificationCount.text() = `${data.Count}`;
    await updateNotificationTable();
  } catch (error) {
    console.error(error, event);
  }
}
```

Requires that `notificationCount.text()` be changed to use `textContent`
instead.

Signed-off-by: Andrew Thornton <art27@cantab.net>
@zeripath zeripath mentioned this pull request Jul 4, 2020
Merged
lafriks pushed a commit that referenced this pull request Jul 4, 2020
@zeripath
Re-fix #12095 again (#12138)
3c4388f 
Unfortunately some of the suggested changes to #12095 introduced
bugs which due to caching behaviour of sharedworkers were not caught
on simple tests.

These are as follows:

* Changing from simple for loop to use includes here:

```js
  register(port) {
    if (!this.clients.includes(port)) return;

    this.clients.push(port);

    port.postMessage({
      type: 'status',
      message: `registered to ${this.url}`,
    });
  }
```

The additional `!` prevents any clients from being added and should
read:

```js
    if (this.clients.includes(port)) return;
```

* Dropping the use of jQuery `$(...)` selection and using DOM
`querySelector` here:

```js
async function receiveUpdateCount(event) {
  try {
    const data = JSON.parse(event.data);

    const notificationCount = document.querySelector('.notification_count');
    if (data.Count > 0) {
      notificationCount.classList.remove('hidden');
    } else {
      notificationCount.classList.add('hidden');
    }

    notificationCount.text() = `${data.Count}`;
    await updateNotificationTable();
  } catch (error) {
    console.error(error, event);
  }
}
```

Requires that `notificationCount.text()` be changed to use `textContent`
instead.

Signed-off-by: Andrew Thornton <art27@cantab.net>
@lafriks lafriks added the backport/done All backports for this PR have been created label Jul 4, 2020
lafriks pushed a commit that referenced this pull request Jul 4, 2020
@zeripath @silverwind @techknowlogick
Move EventSource to SharedWorker (#12095) (#12130)
e46dbec 
* Move EventSource to SharedWorker (#12095)

Backport #12095

Move EventSource to use a SharedWorker. This prevents issues with HTTP/1.1
open browser connections from preventing gitea from opening multiple tabs.

Also allow setting EVENT_SOURCE_UPDATE_TIME to disable EventSource updating

Fix #11978

Signed-off-by: Andrew Thornton <art27@cantab.net>

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>

* Bugfix for shared event source

For some reason our eslint configuration is not working correctly
and a bug has become apparent when trying to backport this to 1.12.

Signed-off-by: Andrew Thornton <art27@cantab.net>

* Re-fix #12095 again

Unfortunately some of the suggested changes to #12095 introduced
bugs which due to caching behaviour of sharedworkers were not caught
on simple tests.

These are as follows:

* Changing from simple for loop to use includes here:

```js
  register(port) {
    if (!this.clients.includes(port)) return;

    this.clients.push(port);

    port.postMessage({
      type: 'status',
      message: `registered to ${this.url}`,
    });
  }
```

The additional `!` prevents any clients from being added and should
read:

```js
    if (this.clients.includes(port)) return;
```

* Dropping the use of jQuery `$(...)` selection and using DOM
`querySelector` here:

```js
async function receiveUpdateCount(event) {
  try {
    const data = JSON.parse(event.data);

    const notificationCount = document.querySelector('.notification_count');
    if (data.Count > 0) {
      notificationCount.classList.remove('hidden');
    } else {
      notificationCount.classList.add('hidden');
    }

    notificationCount.text() = `${data.Count}`;
    await updateNotificationTable();
  } catch (error) {
    console.error(error, event);
  }
}
```

Requires that `notificationCount.text()` be changed to use `textContent`
instead.

Signed-off-by: Andrew Thornton <art27@cantab.net>

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
ydelafollye pushed a commit to ydelafollye/gitea that referenced this pull request Jul 31, 2020
@zeripath @silverwind @techknowlogick
Move EventSource to SharedWorker (go-gitea#12095)
cf4bdb1 
Move EventSource to use a SharedWorker. This prevents issues with HTTP/1.1
open browser connections from preventing gitea from opening multiple tabs.

Also allow setting EVENT_SOURCE_UPDATE_TIME to disable EventSource updating

Fix go-gitea#11978

Signed-off-by: Andrew Thornton <art27@cantab.net>

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
ydelafollye pushed a commit to ydelafollye/gitea that referenced this pull request Jul 31, 2020
@zeripath
Re-fix go-gitea#12095 again (go-gitea#12138)
fb2723c 
Unfortunately some of the suggested changes to go-gitea#12095 introduced
bugs which due to caching behaviour of sharedworkers were not caught
on simple tests.

These are as follows:

* Changing from simple for loop to use includes here:

```js
  register(port) {
    if (!this.clients.includes(port)) return;

    this.clients.push(port);

    port.postMessage({
      type: 'status',
      message: `registered to ${this.url}`,
    });
  }
```

The additional `!` prevents any clients from being added and should
read:

```js
    if (this.clients.includes(port)) return;
```

* Dropping the use of jQuery `$(...)` selection and using DOM
`querySelector` here:

```js
async function receiveUpdateCount(event) {
  try {
    const data = JSON.parse(event.data);

    const notificationCount = document.querySelector('.notification_count');
    if (data.Count > 0) {
      notificationCount.classList.remove('hidden');
    } else {
      notificationCount.classList.add('hidden');
    }

    notificationCount.text() = `${data.Count}`;
    await updateNotificationTable();
  } catch (error) {
    console.error(error, event);
  }
}
```

Requires that `notificationCount.text()` be changed to use `textContent`
instead.

Signed-off-by: Andrew Thornton <art27@cantab.net>
@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lafriks lafriks lafriks approved these changes

@silverwind silverwind silverwind left review comments

@techknowlogick techknowlogick techknowlogick approved these changes

Assignees
No one assigned
Labels
backport/done All backports for this PR have been created lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/bug
Projects
None yet
Milestone
1.13.0
Development

Successfully merging this pull request may close these issues.

Gitea doesn't open more than 5 tabs in browser
5 participants
@zeripath @silverwind @techknowlogick @lafriks @GiteaBot