From 2d23ad7ded6899703c50096b1a56a482790051d5 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 18:10:58 +0100 Subject: [PATCH 01/16] Use AJAX for notifications table Signed-off-by: Andrew Thornton --- routers/user/notification.go | 29 +++-- templates/user/notification/notification.tmpl | 90 +--------------- .../user/notification/notification_div.tmpl | 102 ++++++++++++++++++ web_src/js/index.js | 46 ++++++++ 4 files changed, 172 insertions(+), 95 deletions(-) create mode 100644 templates/user/notification/notification_div.tmpl diff --git a/routers/user/notification.go b/routers/user/notification.go index 74803f149e95..3d0deb199841 100644 --- a/routers/user/notification.go +++ b/routers/user/notification.go @@ -7,6 +7,7 @@ package user import ( "errors" "fmt" + "net/http" "strconv" "strings" @@ -17,7 +18,8 @@ import ( ) const ( - tplNotification base.TplName = "user/notification/notification" + tplNotification base.TplName = "user/notification/notification" + tplNotificationDiv = "user/notification/notification_div" ) // GetNotificationCount is the middleware that sets the notification count in the context @@ -41,6 +43,14 @@ func GetNotificationCount(c *context.Context) { // Notifications is the notifications page func Notifications(c *context.Context) { + getNotifications(c) + if c.Written() { + return + } + c.HTML(http.StatusOK, tplNotification) +} + +func getNotifications(c *context.Context) { var ( keyword = strings.Trim(c.Query("q"), " ") status models.NotificationStatus @@ -126,8 +136,6 @@ func Notifications(c *context.Context) { pager.SetDefaultParams(c) c.Data["Page"] = pager - - c.HTML(200, tplNotification) } // NotificationStatusPost is a route for changing the status of a notification @@ -155,8 +163,17 @@ func NotificationStatusPost(c *context.Context) { return } - url := fmt.Sprintf("%s/notifications?page=%s", setting.AppSubURL, c.Query("page")) - c.Redirect(url, 303) + if !c.QueryBool("noredirect") { + url := fmt.Sprintf("%s/notifications?page=%s", setting.AppSubURL, c.Query("page")) + c.Redirect(url, http.StatusSeeOther) + } + + getNotifications(c) + if c.Written() { + return + } + + c.HTML(http.StatusOK, tplNotificationDiv) } // NotificationPurgePost is a route for 'purging' the list of notifications - marking all unread as read @@ -168,5 +185,5 @@ func NotificationPurgePost(c *context.Context) { } url := fmt.Sprintf("%s/notifications", setting.AppSubURL) - c.Redirect(url, 303) + c.Redirect(url, http.StatusSeeOther) } diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index c4f744a29173..7bc120688861 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -23,95 +23,7 @@ {{end}} -
- {{if eq (len .Notifications) 0}} - {{if eq .Status 1}} - {{.i18n.Tr "notification.no_unread"}} - {{else}} - {{.i18n.Tr "notification.no_read"}} - {{end}} - {{else}} - - - {{range $notification := .Notifications}} - {{$issue := $notification.Issue}} - {{$repo := $notification.Repository}} - {{$repoOwner := $repo.MustOwner}} - - - - - - - - - {{end}} - -
- {{if eq $notification.Status 3}} - {{svg "octicon-pin" 16}} - {{else if $issue.IsPull}} - {{if $issue.IsClosed}} - {{if $issue.GetPullRequest.HasMerged}} - {{svg "octicon-git-merge" 16}} - {{else}} - {{svg "octicon-git-pull-request" 16}} - {{end}} - {{else}} - {{svg "octicon-git-pull-request" 16}} - {{end}} - {{else}} - {{if $issue.IsClosed}} - {{svg "octicon-issue-closed" 16}} - {{else}} - {{svg "octicon-issue-opened" 16}} - {{end}} - {{end}} - - - #{{$issue.Index}} - {{$issue.Title}} - - - - {{$repoOwner.Name}}/{{$repo.Name}} - - - {{if ne $notification.Status 3}} -
- {{$.CsrfTokenHtml}} - - - -
- {{end}} - 		- {{if or (eq $notification.Status 1) (eq $notification.Status 3)}} -
- {{$.CsrfTokenHtml}} - - - - -
- {{else if eq $notification.Status 2}} -
- {{$.CsrfTokenHtml}} - - - - -
- {{end}} -
- {{end}} -
- + {{template "user/notification/notification_div" .}} {{template "base/paginate" .}} diff --git a/templates/user/notification/notification_div.tmpl b/templates/user/notification/notification_div.tmpl new file mode 100644 index 000000000000..b8bd5ef296d8 --- /dev/null +++ b/templates/user/notification/notification_div.tmpl @@ -0,0 +1,102 @@ +
+ {{if eq (len .Notifications) 0}} + {{if eq .Status 1}} + {{.i18n.Tr "notification.no_unread"}} + {{else}} + {{.i18n.Tr "notification.no_read"}} + {{end}} + {{else}} + + + {{range $notification := .Notifications}} + {{$issue := .Issue}} + {{$repo := .Repository}} + {{$repoOwner := $repo.MustOwner}} + + + + + + + + {{end}} + +
+ {{if eq .Status 3}} + {{svg "octicon-pin" 16}} + {{else if $issue.IsPull}} + {{if $issue.IsClosed}} + {{if $issue.GetPullRequest.HasMerged}} + {{svg "octicon-git-merge" 16}} + {{else}} + {{svg "octicon-git-pull-request" 16}} + {{end}} + {{else}} + {{svg "octicon-git-pull-request" 16}} + {{end}} + {{else}} + {{if $issue.IsClosed}} + {{svg "octicon-issue-closed" 16}} + {{else}} + {{svg "octicon-issue-opened" 16}} + {{end}} + {{end}} + + + #{{$issue.Index}} - {{$issue.Title}} + + + + {{$repoOwner.Name}}/{{$repo.Name}} + + + {{if ne .Status 3}} +
+ {{$.CsrfTokenHtml}} + + + +
+ {{end}} + 		+ {{if or (eq .Status 1) (eq .Status 3)}} +
+ {{$.CsrfTokenHtml}} + + + + +
+ {{else if eq .Status 2}} +
+ {{$.CsrfTokenHtml}} + + + + +
+ {{end}} +
+ {{end}} +
\ No newline at end of file diff --git a/web_src/js/index.js b/web_src/js/index.js index ed747765a00f..050870201a50 100644 --- a/web_src/js/index.js +++ b/web_src/js/index.js @@ -180,6 +180,46 @@ function updateIssuesMeta(url, action, issueIds, elementId, isAdd) { })); } +function initNotificationsTable() { + const $notificationTable = $('#notification_table'); + if ($notificationTable) { + $notificationTable.find('.button').click(function () { + updateNotification( + $(this).data('url'), + $(this).data('status'), + $(this).data('page'), + $(this).data('q'), + $(this).data('notification-id') + ).then((data) => { + $('#notification_div').replaceWith(data); + initNotificationsTable(); + }); + return false; + }); + } +} + +function updateNotification(url, status, page, q, notificationID) { + return new Promise(((resolve) => { + if (status != "pinned") { + $(`#notification_${notificationID}`).remove(); + } + $.ajax({ + type: 'POST', + url, + data: { + _csrf: csrf, + notification_id: notificationID, + status, + page, + q, + noredirect: true, + }, + success: resolve + }); + })); +} + function initRepoStatusChecker() { const migrating = $('#repo_migrating'); $('#repo_migrating_failed').hide(); @@ -2431,6 +2471,11 @@ $(document).ready(async () => { window.location = $(this).data('href'); }); + // make table element clickable like a link + $('td[data-href]').click(function () { + window.location = $(this).data('href'); + }); + // Dropzone const $dropzone = $('#dropzone'); if ($dropzone.length > 0) { @@ -2606,6 +2651,7 @@ $(document).ready(async () => { initRepoStatusChecker(); initTemplateSearch(); initContextPopups(); + initNotificationsTable(); // Repo clone url. if ($('#repo-clone-url').length > 0) { From 345b6e89d063d78eabc72adf85fef868be918b44 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 18:23:53 +0100 Subject: [PATCH 02/16] move to separate js Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 38 ++++++++++++++++++++++++++ web_src/js/index.js | 41 +---------------------------- 2 files changed, 39 insertions(+), 40 deletions(-) create mode 100644 web_src/js/features/notification.js diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js new file mode 100644 index 000000000000..244a289bdf93 --- /dev/null +++ b/web_src/js/features/notification.js @@ -0,0 +1,38 @@ +const {csrf} = window.config; + +export default async function initNotificationsTable() { + $('#notification_table .button').click(function () { + updateNotification( + $(this).data('url'), + $(this).data('status'), + $(this).data('page'), + $(this).data('q'), + $(this).data('notification-id') + ).then((data) => { + $('#notification_div').replaceWith(data); + initNotificationsTable(); + }); + return false; + }); +} + +function updateNotification(url, status, page, q, notificationID) { + return new Promise(((resolve) => { + if (status !== 'pinned') { + $(`#notification_${notificationID}`).remove(); + } + $.ajax({ + type: 'POST', + url, + data: { + _csrf: csrf, + notification_id: notificationID, + status, + page, + q, + noredirect: true, + }, + success: resolve + }); + })); +} diff --git a/web_src/js/index.js b/web_src/js/index.js index 050870201a50..95d626090c1c 100644 --- a/web_src/js/index.js +++ b/web_src/js/index.js @@ -18,6 +18,7 @@ import initDateTimePicker from './features/datetimepicker.js'; import createDropzone from './features/dropzone.js'; import highlight from './features/highlight.js'; import ActivityTopAuthors from './components/ActivityTopAuthors.vue'; +import initNotificationsTable from './features/notification.js'; const {AppSubUrl, StaticUrlPrefix, csrf} = window.config; @@ -180,46 +181,6 @@ function updateIssuesMeta(url, action, issueIds, elementId, isAdd) { })); } -function initNotificationsTable() { - const $notificationTable = $('#notification_table'); - if ($notificationTable) { - $notificationTable.find('.button').click(function () { - updateNotification( - $(this).data('url'), - $(this).data('status'), - $(this).data('page'), - $(this).data('q'), - $(this).data('notification-id') - ).then((data) => { - $('#notification_div').replaceWith(data); - initNotificationsTable(); - }); - return false; - }); - } -} - -function updateNotification(url, status, page, q, notificationID) { - return new Promise(((resolve) => { - if (status != "pinned") { - $(`#notification_${notificationID}`).remove(); - } - $.ajax({ - type: 'POST', - url, - data: { - _csrf: csrf, - notification_id: notificationID, - status, - page, - q, - noredirect: true, - }, - success: resolve - }); - })); -} - function initRepoStatusChecker() { const migrating = $('#repo_migrating'); $('#repo_migrating_failed').hide(); From 7d5fca4e618bb58d27394c0b1a289598b484ea53 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 19:44:49 +0100 Subject: [PATCH 03/16] placate golangci-lint Signed-off-by: Andrew Thornton --- routers/user/notification.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/routers/user/notification.go b/routers/user/notification.go index 3d0deb199841..d03eaab0411f 100644 --- a/routers/user/notification.go +++ b/routers/user/notification.go @@ -19,7 +19,7 @@ import ( const ( tplNotification base.TplName = "user/notification/notification" - tplNotificationDiv = "user/notification/notification_div" + tplNotificationDiv base.TplName = "user/notification/notification_div" ) // GetNotificationCount is the middleware that sets the notification count in the context From 0e6236e99a30608ceb97582b12d7ea93e311b82e Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 20:54:51 +0100 Subject: [PATCH 04/16] Add autoupdating notification count Signed-off-by: Andrew Thornton --- routers/user/notification.go | 6 +--- templates/base/head_navbar.tmpl | 9 ++---- templates/user/notification/notification.tmpl | 4 +-- web_src/js/features/notification.js | 32 +++++++++++++++++-- web_src/js/index.js | 3 +- 5 files changed, 37 insertions(+), 17 deletions(-) diff --git a/routers/user/notification.go b/routers/user/notification.go index d03eaab0411f..7e78ed5a5706 100644 --- a/routers/user/notification.go +++ b/routers/user/notification.go @@ -125,11 +125,7 @@ func getNotifications(c *context.Context) { c.Flash.Error(fmt.Sprintf("ERROR: %d notifications were removed due to missing parts - check the logs", failCount)) } - title := c.Tr("notifications") - if status == models.NotificationStatusUnread && total > 0 { - title = fmt.Sprintf("(%d) %s", total, title) - } - c.Data["Title"] = title + c.Data["Title"] = c.Tr("notifications") c.Data["Keyword"] = keyword c.Data["Status"] = status c.Data["Notifications"] = notifications diff --git a/templates/base/head_navbar.tmpl b/templates/base/head_navbar.tmpl index de02bca1f7c5..e06e26357a30 100644 --- a/templates/base/head_navbar.tmpl +++ b/templates/base/head_navbar.tmpl @@ -46,12 +46,9 @@ {{svg "octicon-bell" 16}} {{.i18n.Tr "notifications"}} - - {{if .NotificationUnreadCount}} - - {{.NotificationUnreadCount}} - - {{end}} + + {{.NotificationUnreadCount}} + diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index 7bc120688861..b9b17dbc3d10 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -7,9 +7,7 @@
{{.i18n.Tr "notification.unread"}} - {{if .NotificationUnreadCount}} -
{{.NotificationUnreadCount}}
- {{end}} +
{{.NotificationUnreadCount}}
 {{.i18n.Tr "notification.read"}} diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 244a289bdf93..acbba72cf5a3 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -1,6 +1,6 @@ -const {csrf} = window.config; +const {AppSubUrl, csrf} = window.config; -export default async function initNotificationsTable() { +export async function initNotificationsTable() { $('#notification_table .button').click(function () { updateNotification( $(this).data('url'), @@ -11,11 +11,39 @@ export default async function initNotificationsTable() { ).then((data) => { $('#notification_div').replaceWith(data); initNotificationsTable(); + updateNotificationCount(); }); return false; }); } +export async function initNotificationCount() { + setInterval(() => { + updateNotificationCount(); + }, 5000); +} + +function updateNotificationCount() { + $.ajax({ + type: 'GET', + url: `${AppSubUrl}/api/v1/notifications/new`, + data: { + _csrf: csrf, + }, + success: (data) => { + const notificationCount = $('.notification_count'); + if (data.new === 0) { + if (!notificationCount.hasClass('hidden')) { + notificationCount.addClass('hidden'); + } + } else if (notificationCount.hasClass('hidden')) { + notificationCount.removeClass('hidden'); + } + notificationCount.text(data.new); + }, + }); +} + function updateNotification(url, status, page, q, notificationID) { return new Promise(((resolve) => { if (status !== 'pinned') { diff --git a/web_src/js/index.js b/web_src/js/index.js index 95d626090c1c..9e699c1a2e84 100644 --- a/web_src/js/index.js +++ b/web_src/js/index.js @@ -18,7 +18,7 @@ import initDateTimePicker from './features/datetimepicker.js'; import createDropzone from './features/dropzone.js'; import highlight from './features/highlight.js'; import ActivityTopAuthors from './components/ActivityTopAuthors.vue'; -import initNotificationsTable from './features/notification.js'; +import {initNotificationsTable, initNotificationCount} from './features/notification.js'; const {AppSubUrl, StaticUrlPrefix, csrf} = window.config; @@ -2613,6 +2613,7 @@ $(document).ready(async () => { initTemplateSearch(); initContextPopups(); initNotificationsTable(); + initNotificationCount(); // Repo clone url. if ($('#repo-clone-url').length > 0) { From 85aef7226cb7ed57a78cb816dd2d246e2ded8996 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 21:39:23 +0100 Subject: [PATCH 05/16] Fix wipeall Signed-off-by: Andrew Thornton --- routers/user/notification.go | 14 ++++++++------ templates/base/head_navbar.tmpl | 5 +++-- templates/user/notification/notification.tmpl | 13 ++++++++----- web_src/js/features/notification.js | 11 ++++++----- 4 files changed, 25 insertions(+), 18 deletions(-) diff --git a/routers/user/notification.go b/routers/user/notification.go index 7e78ed5a5706..4bbb7fd4f22d 100644 --- a/routers/user/notification.go +++ b/routers/user/notification.go @@ -32,13 +32,15 @@ func GetNotificationCount(c *context.Context) { return } - count, err := models.GetNotificationCount(c.User, models.NotificationStatusUnread) - if err != nil { - c.ServerError("GetNotificationCount", err) - return - } + c.Data["NotificationUnreadCount"] = func() int64 { + count, err := models.GetNotificationCount(c.User, models.NotificationStatusUnread) + if err != nil { + c.ServerError("GetNotificationCount", err) + return -1 + } - c.Data["NotificationUnreadCount"] = count + return count + } } // Notifications is the notifications page diff --git a/templates/base/head_navbar.tmpl b/templates/base/head_navbar.tmpl index e06e26357a30..c43bf4e6d1e1 100644 --- a/templates/base/head_navbar.tmpl +++ b/templates/base/head_navbar.tmpl @@ -46,8 +46,9 @@ {{svg "octicon-bell" 16}} {{.i18n.Tr "notifications"}} - - {{.NotificationUnreadCount}} + {{ $notificationUnreadCount := call .NotificationUnreadCount}} + + {{$notificationUnreadCount}} diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index b9b17dbc3d10..44ad80932039 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -5,19 +5,22 @@

{{.i18n.Tr "notification.notifications"}}

+ {{ $notificationUnreadCount := call .NotificationUnreadCount}} {{.i18n.Tr "notification.unread"}} -
{{.NotificationUnreadCount}}
+
{{$notificationUnreadCount}}
 {{.i18n.Tr "notification.read"}} - {{if and (eq .Status 1) (.NotificationUnreadCount)}} + {{if and (eq .Status 1)}}
{{$.CsrfTokenHtml}} - +
+ +
{{end}}
diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index acbba72cf5a3..d7fd5b21dc08 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -32,12 +32,13 @@ function updateNotificationCount() { }, success: (data) => { const notificationCount = $('.notification_count'); + const notificationDependent = $('.notification_dependent'); if (data.new === 0) { - if (!notificationCount.hasClass('hidden')) { - notificationCount.addClass('hidden'); - } - } else if (notificationCount.hasClass('hidden')) { - notificationCount.removeClass('hidden'); + notificationCount.addClass('hide'); + notificationDependent.addClass('hide'); + } else { + notificationCount.removeClass('hide'); + notificationDependent.removeClass('hide'); } notificationCount.text(data.new); }, From 6911132b57bda220aa28f5c2fec904c2c1d8999c Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 22:19:26 +0100 Subject: [PATCH 06/16] placate tests Signed-off-by: Andrew Thornton --- templates/base/head_navbar.tmpl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/templates/base/head_navbar.tmpl b/templates/base/head_navbar.tmpl index c43bf4e6d1e1..51a31e66bc52 100644 --- a/templates/base/head_navbar.tmpl +++ b/templates/base/head_navbar.tmpl @@ -46,7 +46,8 @@ {{svg "octicon-bell" 16}} {{.i18n.Tr "notifications"}} - {{ $notificationUnreadCount := call .NotificationUnreadCount}} + {{$notificationUnreadCount := 0}} + {{if .NotificationUnreadCount}}{{$notificationUnreadCount = call .NotificationUnreadCount}}{{end}} {{$notificationUnreadCount}} From f736bc9a508bd74aca188ad6406fe06b6c82d22e Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 22:25:38 +0100 Subject: [PATCH 07/16] Try hidden Signed-off-by: Andrew Thornton --- templates/base/head_navbar.tmpl | 2 +- templates/user/notification/notification.tmpl | 4 ++-- web_src/js/features/notification.js | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/templates/base/head_navbar.tmpl b/templates/base/head_navbar.tmpl index 51a31e66bc52..cedf29e2e9c6 100644 --- a/templates/base/head_navbar.tmpl +++ b/templates/base/head_navbar.tmpl @@ -48,7 +48,7 @@ {{.i18n.Tr "notifications"}} {{$notificationUnreadCount := 0}} {{if .NotificationUnreadCount}}{{$notificationUnreadCount = call .NotificationUnreadCount}}{{end}} - + {{$notificationUnreadCount}} diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index 44ad80932039..414ca96e2f5c 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -8,7 +8,7 @@ {{ $notificationUnreadCount := call .NotificationUnreadCount}} {{.i18n.Tr "notification.unread"}} -
{{$notificationUnreadCount}}
+
{{$notificationUnreadCount}}
 {{.i18n.Tr "notification.read"}} @@ -16,7 +16,7 @@ {{if and (eq .Status 1)}}
{{$.CsrfTokenHtml}} -
+
diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index d7fd5b21dc08..46090eeacf7f 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -34,11 +34,11 @@ function updateNotificationCount() { const notificationCount = $('.notification_count'); const notificationDependent = $('.notification_dependent'); if (data.new === 0) { - notificationCount.addClass('hide'); - notificationDependent.addClass('hide'); + notificationCount.addClass('hidden'); + notificationDependent.addClass('hidden'); } else { - notificationCount.removeClass('hide'); - notificationDependent.removeClass('hide'); + notificationCount.removeClass('hidden'); + notificationDependent.removeClass('hidden'); } notificationCount.text(data.new); }, From b934e56690362f21e6f3d6ec9c29aaaa97d5ac58 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Tue, 21 Apr 2020 22:38:42 +0100 Subject: [PATCH 08/16] Try hide and hidden Signed-off-by: Andrew Thornton --- templates/user/notification/notification.tmpl | 2 +- web_src/js/features/notification.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index 414ca96e2f5c..ccf751e3a131 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -16,7 +16,7 @@ {{if and (eq .Status 1)}} {{$.CsrfTokenHtml}} -
+
diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 46090eeacf7f..324422a59ced 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -35,10 +35,10 @@ function updateNotificationCount() { const notificationDependent = $('.notification_dependent'); if (data.new === 0) { notificationCount.addClass('hidden'); - notificationDependent.addClass('hidden'); + notificationDependent.addClass('hide'); } else { notificationCount.removeClass('hidden'); - notificationDependent.removeClass('hidden'); + notificationDependent.removeClass('hide'); } notificationCount.text(data.new); }, From 1a02f4bcd369903d97fe962291ca6967f784f8bc Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 16:36:07 +0100 Subject: [PATCH 09/16] More auto-update improvements Only run checker on pages that have a count Change starting checker to 10s with a back-off to 60s if there is no change Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 324422a59ced..2ef7193c4768 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -18,12 +18,18 @@ export async function initNotificationsTable() { } export async function initNotificationCount() { - setInterval(() => { - updateNotificationCount(); - }, 5000); + if ($('.notification_count').length > 0) { + const fn = (callback, timeout) => { + setTimeout(() => { + updateNotificationCount(callback, timeout); + }, timeout); + }; + + fn(fn, 10000); + } } -function updateNotificationCount() { +function updateNotificationCount(callback, timeout) { $.ajax({ type: 'GET', url: `${AppSubUrl}/api/v1/notifications/new`, @@ -40,7 +46,16 @@ function updateNotificationCount() { notificationCount.removeClass('hidden'); notificationDependent.removeClass('hide'); } - notificationCount.text(data.new); + const currentCount = notificationCount.text(); + if (currentCount !== data.new) { + notificationCount.text(data.new); + timeout = 10000; + } else if (timeout < 60000) { + timeout += 10000; + } + if (callback) { + callback(callback, timeout); + } }, }); } From 25ec760b295a58a65402b82c820c69bfeecabd28 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 17:22:51 +0100 Subject: [PATCH 10/16] string comparison! Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 2ef7193c4768..54f63ab41ac5 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -47,7 +47,7 @@ function updateNotificationCount(callback, timeout) { notificationDependent.removeClass('hide'); } const currentCount = notificationCount.text(); - if (currentCount !== data.new) { + if (currentCount !== `${data.new}`) { notificationCount.text(data.new); timeout = 10000; } else if (timeout < 60000) { From 876c1f82d4e6ae78bc57a4f8dcf9418273eb1b43 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 19:08:32 +0100 Subject: [PATCH 11/16] as per @silverwind Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 100 +++++++++++++++------------- 1 file changed, 54 insertions(+), 46 deletions(-) diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 54f63ab41ac5..a288ff801a8f 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -1,6 +1,6 @@ const {AppSubUrl, csrf} = window.config; -export async function initNotificationsTable() { +export function initNotificationsTable() { $('#notification_table .button').click(function () { updateNotification( $(this).data('url'), @@ -17,66 +17,74 @@ export async function initNotificationsTable() { }); } -export async function initNotificationCount() { +export function initNotificationCount() { if ($('.notification_count').length > 0) { - const fn = (callback, timeout) => { + const lastCount = $('.notification_count').text(); + const fn = (callback, timeout, lastCount) => { setTimeout(() => { - updateNotificationCount(callback, timeout); + updateNotificationCount(callback, timeout, lastCount); }, timeout); }; - fn(fn, 10000); + fn(fn, 10000, lastCount); } } -function updateNotificationCount(callback, timeout) { +function updateNotificationCount(callback, timeout, lastCount) { + const currentCount = $('.notification_count').text(); + if (callback && (lastCount !== currentCount)) { + callback(callback, 10000, currentCount); + return; + } $.ajax({ type: 'GET', url: `${AppSubUrl}/api/v1/notifications/new`, data: { _csrf: csrf, }, - success: (data) => { - const notificationCount = $('.notification_count'); - const notificationDependent = $('.notification_dependent'); - if (data.new === 0) { - notificationCount.addClass('hidden'); - notificationDependent.addClass('hide'); - } else { - notificationCount.removeClass('hidden'); - notificationDependent.removeClass('hide'); - } - const currentCount = notificationCount.text(); - if (currentCount !== `${data.new}`) { - notificationCount.text(data.new); - timeout = 10000; - } else if (timeout < 60000) { - timeout += 10000; - } - if (callback) { - callback(callback, timeout); - } - }, + }).then((data) => { + const notificationCount = $('.notification_count'); + const notificationDependent = $('.notification_dependent'); + if (data.new === 0) { + notificationCount.addClass('hidden'); + notificationDependent.addClass('hide'); + } else { + notificationCount.removeClass('hidden'); + notificationDependent.removeClass('hide'); + } + const currentCount = $('.notification_count').text(); + if (lastCount !== `${data.new}` || currentCount !== `${data.new}`) { + notificationCount.text(data.new); + timeout = 10000; + } else if (timeout < 60000) { + timeout += 10000; + } + return { + timeout, + nextCount: `${data.new}`, + }; + }).then((data) => { + if (callback) { + callback(callback, data.timeout, data.nextCount); + } }); } -function updateNotification(url, status, page, q, notificationID) { - return new Promise(((resolve) => { - if (status !== 'pinned') { - $(`#notification_${notificationID}`).remove(); - } - $.ajax({ - type: 'POST', - url, - data: { - _csrf: csrf, - notification_id: notificationID, - status, - page, - q, - noredirect: true, - }, - success: resolve - }); - })); +async function updateNotification(url, status, page, q, notificationID) { + if (status !== 'pinned') { + $(`#notification_${notificationID}`).remove(); + } + + return $.ajax({ + type: 'POST', + url, + data: { + _csrf: csrf, + notification_id: notificationID, + status, + page, + q, + noredirect: true, + }, + }); } From d314b505744734b6772a5492651fa63fd2678e10 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 21:01:20 +0100 Subject: [PATCH 12/16] add configurability as per @6543 Signed-off-by: Andrew Thornton --- modules/setting/setting.go | 15 +++++++++++++++ modules/templates/helper.go | 7 +++++++ templates/base/head.tmpl | 5 +++++ web_src/js/features/notification.js | 16 ++++++++++------ 4 files changed, 37 insertions(+), 6 deletions(-) diff --git a/modules/setting/setting.go b/modules/setting/setting.go index a18b47a7e9ef..83902184c4f4 100644 --- a/modules/setting/setting.go +++ b/modules/setting/setting.go @@ -180,6 +180,12 @@ var ( SearchRepoDescription bool UseServiceWorker bool + Notification struct { + MinTimeout time.Duration + TimeoutStep time.Duration + MaxTimeout time.Duration + } `ini:"ui.notification"` + Admin struct { UserPagingNum int RepoPagingNum int @@ -208,6 +214,15 @@ var ( DefaultTheme: `gitea`, Themes: []string{`gitea`, `arc-green`}, Reactions: []string{`+1`, `-1`, `laugh`, `hooray`, `confused`, `heart`, `rocket`, `eyes`}, + Notification: struct { + MinTimeout time.Duration + TimeoutStep time.Duration + MaxTimeout time.Duration + }{ + MinTimeout: 10 * time.Second, + TimeoutStep: 10 * time.Second, + MaxTimeout: 60 * time.Second, + }, Admin: struct { UserPagingNum int RepoPagingNum int diff --git a/modules/templates/helper.go b/modules/templates/helper.go index b5b49874276d..8112880f4323 100644 --- a/modules/templates/helper.go +++ b/modules/templates/helper.go @@ -278,6 +278,13 @@ func NewFuncMap() []template.FuncMap { return "" } }, + "NotificationSettings": func() map[string]int { + return map[string]int{ + "MinTimeout": int(setting.UI.Notification.MinTimeout / time.Millisecond), + "TimeoutStep": int(setting.UI.Notification.TimeoutStep / time.Millisecond), + "MaxTimeout": int(setting.UI.Notification.MaxTimeout / time.Millisecond), + } + }, "contain": func(s []int64, id int64) bool { for i := 0; i < len(s); i++ { if s[i] == id { diff --git a/templates/base/head.tmpl b/templates/base/head.tmpl index e0765d59d30e..2d7d737a00fa 100644 --- a/templates/base/head.tmpl +++ b/templates/base/head.tmpl @@ -94,6 +94,11 @@ U2F: {{if .RequireU2F}}true{{else}}false{{end}}, Heatmap: {{if .EnableHeatmap}}true{{else}}false{{end}}, heatmapUser: {{if .HeatmapUser}}'{{.HeatmapUser}}'{{else}}null{{end}}, + NotificationSettings: { + MinTimeout: {{NotificationSettings.MinTimeout}}, + TimeoutStep: {{NotificationSettings.TimeoutStep}}, + MaxTimeout: {{NotificationSettings.MaxTimeout}}, + }, }; diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index a288ff801a8f..05bdb96e75c5 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -1,4 +1,4 @@ -const {AppSubUrl, csrf} = window.config; +const {AppSubUrl, csrf, NotificationSettings} = window.config; export function initNotificationsTable() { $('#notification_table .button').click(function () { @@ -18,6 +18,10 @@ export function initNotificationsTable() { } export function initNotificationCount() { + if (NotificationSettings.MinTimeout <= 0) { + return; + } + if ($('.notification_count').length > 0) { const lastCount = $('.notification_count').text(); const fn = (callback, timeout, lastCount) => { @@ -26,14 +30,14 @@ export function initNotificationCount() { }, timeout); }; - fn(fn, 10000, lastCount); + fn(fn, NotificationSettings.MinTimeout, lastCount); } } function updateNotificationCount(callback, timeout, lastCount) { const currentCount = $('.notification_count').text(); if (callback && (lastCount !== currentCount)) { - callback(callback, 10000, currentCount); + callback(callback, NotificationSettings.MinTimeout, currentCount); return; } $.ajax({ @@ -55,9 +59,9 @@ function updateNotificationCount(callback, timeout, lastCount) { const currentCount = $('.notification_count').text(); if (lastCount !== `${data.new}` || currentCount !== `${data.new}`) { notificationCount.text(data.new); - timeout = 10000; - } else if (timeout < 60000) { - timeout += 10000; + timeout = NotificationSettings.MinTimeout; + } else if (timeout < NotificationSettings.MaxTimeout) { + timeout += NotificationSettings.TimeoutStep; } return { timeout, From c55c4c832621837afc66b4afdbb0678d49b56622 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 21:33:50 +0100 Subject: [PATCH 13/16] Add documentation as per @6543 Signed-off-by: Andrew Thornton --- custom/conf/app.ini.sample | 8 ++++++++ docs/content/doc/advanced/config-cheat-sheet.en-us.md | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample index 414cd3f2781d..a9cd53b7fd48 100644 --- a/custom/conf/app.ini.sample +++ b/custom/conf/app.ini.sample @@ -200,6 +200,14 @@ AUTHOR = Gitea - Git with a cup of tea DESCRIPTION = Gitea (Git with a cup of tea) is a painless self-hosted Git service written in Go KEYWORDS = go,git,self-hosted,gitea +[ui.notification] +; Control how often notification is queried to update the notification +; The timeout will increase to MAX_TIMEOUT in TIMEOUT_STEPs if the notification count is unchanged +; Set MIN_TIMEOUT to 0 to turn off +MIN_TIMEOUT = 10s +MAX_TIMEOUT = 60s +TIMEOUT_STEP = 10s + [markdown] ; Render soft line breaks as hard line breaks, which means a single newline character between ; paragraphs will cause a line break and adding trailing whitespace to paragraphs is not diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index 7d59041ec49a..03c82532a29c 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -140,6 +140,13 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. - `NOTICE_PAGING_NUM`: **25**: Number of notices that are shown in one page. - `ORG_PAGING_NUM`: **50**: Number of organizations that are shown in one page. +### UI - Notification (`ui.notification`) + +- `MIN_TIMEOUT`: **10s**: These options control how often notification is queried to update the notification count. On page load the notification count will be checked after `MIN_TIMEOUT`. The timeout will increase to `MAX_TIMEOUT` by `TIMEOUT_STEP` if the notification count is unchanged. Set MIN_TIMEOUT to 0 to turn off. +- `MAX_TIMEOUT`: **60s**. +- `TIMEOUT_STEP`: **10s**. + + ## Markdown (`markdown`) - `ENABLE_HARD_LINE_BREAK`: **true**: Render soft line breaks as hard line breaks, which From f32070d039d245c15636e7b10f74aec80328f0ff Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Wed, 22 Apr 2020 21:58:45 +0100 Subject: [PATCH 14/16] Use CSRF header not query Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 05bdb96e75c5..37369df2ee93 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -43,8 +43,8 @@ function updateNotificationCount(callback, timeout, lastCount) { $.ajax({ type: 'GET', url: `${AppSubUrl}/api/v1/notifications/new`, - data: { - _csrf: csrf, + headers: { + 'X-Csrf-Token': csrf, }, }).then((data) => { const notificationCount = $('.notification_count'); From 5987fc2a32965d6d1ae6b708ba7979684e2ccf92 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Thu, 23 Apr 2020 16:34:36 +0100 Subject: [PATCH 15/16] Further JS improvements Fix @etzelia update notification table request Fix @silverwind comments Co-Authored-By: silverwind Signed-off-by: Andrew Thornton --- .eslintrc | 1 + routers/user/notification.go | 4 + templates/user/notification/notification.tmpl | 31 +-- .../user/notification/notification_div.tmpl | 226 ++++++++++-------- web_src/js/features/notification.js | 86 ++++--- 5 files changed, 180 insertions(+), 168 deletions(-) diff --git a/.eslintrc b/.eslintrc index 8fd53d54a183..a8f7f1ae2069 100644 --- a/.eslintrc +++ b/.eslintrc @@ -55,6 +55,7 @@ rules: no-param-reassign: [0] no-plusplus: [0] no-restricted-syntax: [0] + no-return-await: [0] no-shadow: [0] no-unused-vars: [2, {args: all, argsIgnorePattern: ^_, varsIgnorePattern: ^_, ignoreRestSiblings: true}] no-use-before-define: [0] diff --git a/routers/user/notification.go b/routers/user/notification.go index 4bbb7fd4f22d..9724c8108830 100644 --- a/routers/user/notification.go +++ b/routers/user/notification.go @@ -49,6 +49,10 @@ func Notifications(c *context.Context) { if c.Written() { return } + if c.QueryBool("div-only") { + c.HTML(http.StatusOK, tplNotificationDiv) + return + } c.HTML(http.StatusOK, tplNotification) } diff --git a/templates/user/notification/notification.tmpl b/templates/user/notification/notification.tmpl index ccf751e3a131..b483c15e9573 100644 --- a/templates/user/notification/notification.tmpl +++ b/templates/user/notification/notification.tmpl @@ -1,32 +1,3 @@ {{template "base/head" .}} - -
-
-

{{.i18n.Tr "notification.notifications"}}

- -
- {{ $notificationUnreadCount := call .NotificationUnreadCount}} - - {{.i18n.Tr "notification.unread"}} -
{{$notificationUnreadCount}}
- - - {{.i18n.Tr "notification.read"}} - - {{if and (eq .Status 1)}} - - {{$.CsrfTokenHtml}} -
- -
- - {{end}} -
- {{template "user/notification/notification_div" .}} - {{template "base/paginate" .}} -
-
- +{{template "user/notification/notification_div" .}} {{template "base/footer" .}} diff --git a/templates/user/notification/notification_div.tmpl b/templates/user/notification/notification_div.tmpl index b8bd5ef296d8..18054c479a4b 100644 --- a/templates/user/notification/notification_div.tmpl +++ b/templates/user/notification/notification_div.tmpl @@ -1,102 +1,128 @@ -
- {{if eq (len .Notifications) 0}} - {{if eq .Status 1}} - {{.i18n.Tr "notification.no_unread"}} - {{else}} - {{.i18n.Tr "notification.no_read"}} - {{end}} - {{else}} - - - {{range $notification := .Notifications}} - {{$issue := .Issue}} - {{$repo := .Repository}} - {{$repoOwner := $repo.MustOwner}} - - + + + + + + {{end}} + +
- {{if eq .Status 3}} - {{svg "octicon-pin" 16}} - {{else if $issue.IsPull}} - {{if $issue.IsClosed}} - {{if $issue.GetPullRequest.HasMerged}} - {{svg "octicon-git-merge" 16}} +
+
+

{{.i18n.Tr "notification.notifications"}}

+
+ {{ $notificationUnreadCount := call .NotificationUnreadCount}} + + {{.i18n.Tr "notification.unread"}} +
{{$notificationUnreadCount}}
+ + + {{.i18n.Tr "notification.read"}} + + {{if and (eq .Status 1)}} +
+ {{$.CsrfTokenHtml}} +
+ +
+
+ {{end}} +
+
+ {{if eq (len .Notifications) 0}} + {{if eq .Status 1}} + {{.i18n.Tr "notification.no_unread"}} + {{else}} + {{.i18n.Tr "notification.no_read"}} + {{end}} + {{else}} + + + {{range $notification := .Notifications}} + {{$issue := .Issue}} + {{$repo := .Repository}} + {{$repoOwner := $repo.MustOwner}} + + - - - - - - {{end}} - -
+ {{if eq .Status 3}} + {{svg "octicon-pin" 16}} + {{else if $issue.IsPull}} + {{if $issue.IsClosed}} + {{if $issue.GetPullRequest.HasMerged}} + {{svg "octicon-git-merge" 16}} + {{else}} + {{svg "octicon-git-pull-request" 16}} + {{end}} + {{else}} + {{svg "octicon-git-pull-request" 16}} + {{end}} {{else}} - {{svg "octicon-git-pull-request" 16}} + {{if $issue.IsClosed}} + {{svg "octicon-issue-closed" 16}} + {{else}} + {{svg "octicon-issue-opened" 16}} + {{end}} {{end}} - {{else}} - {{svg "octicon-git-pull-request" 16}} - {{end}} - {{else}} - {{if $issue.IsClosed}} - {{svg "octicon-issue-closed" 16}} - {{else}} - {{svg "octicon-issue-opened" 16}} - {{end}} - {{end}} - - - #{{$issue.Index}} - {{$issue.Title}} - - - - {{$repoOwner.Name}}/{{$repo.Name}} - - - {{if ne .Status 3}} -
- {{$.CsrfTokenHtml}} - - - -
- {{end}} - 		- {{if or (eq .Status 1) (eq .Status 3)}} -
- {{$.CsrfTokenHtml}} - - - - -
- {{else if eq .Status 2}} -
- {{$.CsrfTokenHtml}} - - - - -
- {{end}} -
- {{end}} -
\ No newline at end of file +
+ + #{{$issue.Index}} - {{$issue.Title}} + + + + {{$repoOwner.Name}}/{{$repo.Name}} + + + {{if ne .Status 3}} +
+ {{$.CsrfTokenHtml}} + + + +
+ {{end}} + 		+ {{if or (eq .Status 1) (eq .Status 3)}} +
+ {{$.CsrfTokenHtml}} + + + + +
+ {{else if eq .Status 2}} +
+ {{$.CsrfTokenHtml}} + + + + +
+ {{end}} +
+ {{end}} +
+ {{template "base/paginate" .}} +
+
diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 37369df2ee93..2e0ee30735e4 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -1,18 +1,19 @@ const {AppSubUrl, csrf, NotificationSettings} = window.config; export function initNotificationsTable() { - $('#notification_table .button').click(function () { - updateNotification( + $('#notification_table .button').on('click', async function () { + const data = await updateNotification( $(this).data('url'), $(this).data('status'), $(this).data('page'), $(this).data('q'), - $(this).data('notification-id') - ).then((data) => { - $('#notification_div').replaceWith(data); - initNotificationsTable(); - updateNotificationCount(); - }); + $(this).data('notification-id'), + ); + + $('#notification_div').replaceWith(data); + initNotificationsTable(); + await updateNotificationCount(); + return false; }); } @@ -25,8 +26,8 @@ export function initNotificationCount() { if ($('.notification_count').length > 0) { const lastCount = $('.notification_count').text(); const fn = (callback, timeout, lastCount) => { - setTimeout(() => { - updateNotificationCount(callback, timeout, lastCount); + setTimeout(async () => { + await updateNotificationCount(callback, timeout, lastCount); }, timeout); }; @@ -34,44 +35,53 @@ export function initNotificationCount() { } } -function updateNotificationCount(callback, timeout, lastCount) { - const currentCount = $('.notification_count').text(); +async function updateNotificationCount(callback, timeout, lastCount) { + let currentCount = $('.notification_count').text(); if (callback && (lastCount !== currentCount)) { callback(callback, NotificationSettings.MinTimeout, currentCount); return; } - $.ajax({ + + const data = await $.ajax({ type: 'GET', url: `${AppSubUrl}/api/v1/notifications/new`, headers: { 'X-Csrf-Token': csrf, }, - }).then((data) => { - const notificationCount = $('.notification_count'); - const notificationDependent = $('.notification_dependent'); - if (data.new === 0) { - notificationCount.addClass('hidden'); - notificationDependent.addClass('hide'); - } else { - notificationCount.removeClass('hidden'); - notificationDependent.removeClass('hide'); - } - const currentCount = $('.notification_count').text(); - if (lastCount !== `${data.new}` || currentCount !== `${data.new}`) { - notificationCount.text(data.new); - timeout = NotificationSettings.MinTimeout; - } else if (timeout < NotificationSettings.MaxTimeout) { - timeout += NotificationSettings.TimeoutStep; - } - return { - timeout, - nextCount: `${data.new}`, - }; - }).then((data) => { - if (callback) { - callback(callback, data.timeout, data.nextCount); - } }); + + const notificationCount = $('.notification_count'); + if (data.new === 0) { + notificationCount.addClass('hidden'); + } else { + notificationCount.removeClass('hidden'); + } + + let needsUpdate = false; + currentCount = $('.notification_count').text(); + if (lastCount !== `${data.new}` || currentCount !== `${data.new}`) { + notificationCount.text(data.new); + needsUpdate = true; + timeout = NotificationSettings.MinTimeout; + } else if (timeout < NotificationSettings.MaxTimeout) { + timeout += NotificationSettings.TimeoutStep; + } + + if (callback) { + callback(callback, timeout, `${data.new}`); + const notificationDiv = $('#notification_div'); + if (notificationDiv.length > 0 && needsUpdate) { + const data = await $.ajax({ + type: 'GET', + url: `${AppSubUrl}/notifications?${notificationDiv.data('params')}`, + data: { + 'div-only': true, + } + }); + notificationDiv.replaceWith(data); + initNotificationsTable(); + } + } } async function updateNotification(url, status, page, q, notificationID) { From edc068dd021b55bd2835969a5ee7edd83a1c9f06 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Thu, 23 Apr 2020 18:20:19 +0100 Subject: [PATCH 16/16] Simplify the notification count fns Signed-off-by: Andrew Thornton --- web_src/js/features/notification.js | 72 ++++++++++++++++------------- 1 file changed, 39 insertions(+), 33 deletions(-) diff --git a/web_src/js/features/notification.js b/web_src/js/features/notification.js index 2e0ee30735e4..3f2af4de91a0 100644 --- a/web_src/js/features/notification.js +++ b/web_src/js/features/notification.js @@ -23,25 +23,53 @@ export function initNotificationCount() { return; } - if ($('.notification_count').length > 0) { - const lastCount = $('.notification_count').text(); - const fn = (callback, timeout, lastCount) => { + const notificationCount = $('.notification_count'); + + if (notificationCount.length > 0) { + const fn = (timeout, lastCount) => { setTimeout(async () => { - await updateNotificationCount(callback, timeout, lastCount); + await updateNotificationCountWithCallback(fn, timeout, lastCount); }, timeout); }; - fn(fn, NotificationSettings.MinTimeout, lastCount); + fn(NotificationSettings.MinTimeout, notificationCount.text()); } } -async function updateNotificationCount(callback, timeout, lastCount) { - let currentCount = $('.notification_count').text(); - if (callback && (lastCount !== currentCount)) { - callback(callback, NotificationSettings.MinTimeout, currentCount); +async function updateNotificationCountWithCallback(callback, timeout, lastCount) { + const currentCount = $('.notification_count').text(); + if (lastCount !== currentCount) { + callback(NotificationSettings.MinTimeout, currentCount); return; } + const newCount = await updateNotificationCount(); + let needsUpdate = false; + + if (lastCount !== newCount) { + needsUpdate = true; + timeout = NotificationSettings.MinTimeout; + } else if (timeout < NotificationSettings.MaxTimeout) { + timeout += NotificationSettings.TimeoutStep; + } + + callback(timeout, newCount); + + const notificationDiv = $('#notification_div'); + if (notificationDiv.length > 0 && needsUpdate) { + const data = await $.ajax({ + type: 'GET', + url: `${AppSubUrl}/notifications?${notificationDiv.data('params')}`, + data: { + 'div-only': true, + } + }); + notificationDiv.replaceWith(data); + initNotificationsTable(); + } +} + +async function updateNotificationCount() { const data = await $.ajax({ type: 'GET', url: `${AppSubUrl}/api/v1/notifications/new`, @@ -57,31 +85,9 @@ async function updateNotificationCount(callback, timeout, lastCount) { notificationCount.removeClass('hidden'); } - let needsUpdate = false; - currentCount = $('.notification_count').text(); - if (lastCount !== `${data.new}` || currentCount !== `${data.new}`) { - notificationCount.text(data.new); - needsUpdate = true; - timeout = NotificationSettings.MinTimeout; - } else if (timeout < NotificationSettings.MaxTimeout) { - timeout += NotificationSettings.TimeoutStep; - } + notificationCount.text(`${data.new}`); - if (callback) { - callback(callback, timeout, `${data.new}`); - const notificationDiv = $('#notification_div'); - if (notificationDiv.length > 0 && needsUpdate) { - const data = await $.ajax({ - type: 'GET', - url: `${AppSubUrl}/notifications?${notificationDiv.data('params')}`, - data: { - 'div-only': true, - } - }); - notificationDiv.replaceWith(data); - initNotificationsTable(); - } - } + return `${data.new}`; } async function updateNotification(url, status, page, q, notificationID) {