fine tune and improve comments

Author: wxiaoguang

routers/web/repo/issue.go

@@ -881,7 +881,7 @@ type issueSidebarLabelsData struct {
 	SelectedLabelIDs string
 }
 
-func findSelectedIDs[KeyType, ItemType comparable](
+func makeSelectedStringIDs[KeyType, ItemType comparable](
 	allLabels []*issues_model.Label, candidateKey func(candidate *issues_model.Label) KeyType,
 	selectedItems []ItemType, selectedKey func(selected ItemType) KeyType,
 ) string {
@@ -902,29 +902,23 @@ func findSelectedIDs[KeyType, ItemType comparable](
 }
 
 func (d *issueSidebarLabelsData) SetSelectedLabels(labels []*issues_model.Label) {
-	d.SelectedLabelIDs = findSelectedIDs(
-		d.AllLabels,
-		func(label *issues_model.Label) int64 { return label.ID },
-		labels,
-		func(label *issues_model.Label) int64 { return label.ID },
+	d.SelectedLabelIDs = makeSelectedStringIDs(
+		d.AllLabels, func(label *issues_model.Label) int64 { return label.ID },
+		labels, func(label *issues_model.Label) int64 { return label.ID },
 	)
 }
 
 func (d *issueSidebarLabelsData) SetSelectedLabelNames(labelNames []string) {
-	d.SelectedLabelIDs = findSelectedIDs(
-		d.AllLabels,
-		func(label *issues_model.Label) string { return strings.ToLower(label.Name) },
-		labelNames,
-		strings.ToLower,
+	d.SelectedLabelIDs = makeSelectedStringIDs(
+		d.AllLabels, func(label *issues_model.Label) string { return strings.ToLower(label.Name) },
+		labelNames, strings.ToLower,
 	)
 }
 
 func (d *issueSidebarLabelsData) SetSelectedLabelIDs(labelIDs []int64) {
-	d.SelectedLabelIDs = findSelectedIDs(
-		d.AllLabels,
-		func(label *issues_model.Label) int64 { return label.ID },
-		labelIDs,
-		func(labelID int64) int64 { return labelID },
+	d.SelectedLabelIDs = makeSelectedStringIDs(
+		d.AllLabels, func(label *issues_model.Label) int64 { return label.ID },
+		labelIDs, func(labelID int64) int64 { return labelID },
 	)
 }
 

routers/web/repo/issue_label.go

@@ -53,7 +53,7 @@ func InitializeLabels(ctx *context.Context) {
 	ctx.Redirect(ctx.Repo.RepoLink + "/labels")
 }
 
-// RetrieveLabelsForList find all the labels of a repository and organization
+// RetrieveLabelsForList find all the labels of a repository and organization, it is only used by "/labels" page to list all labels
 func RetrieveLabelsForList(ctx *context.Context) {
 	labels, err := issues_model.GetLabelsByRepoID(ctx, ctx.Repo.Repository.ID, ctx.FormString("sort"), db.ListOptions{})
 	if err != nil {

templates/repo/issue/new_form.tmpl

@@ -49,7 +49,7 @@
 	<div class="issue-content-right ui segment">
 		{{template "repo/issue/branch_selector_field" $}}
 		{{if .PageIsComparePull}}
-			{{template "repo/issue/sidebar/reviewer_list" dict "IssueSidebarReviewersData" $.IssueSidebarReviewersData}}
+			{{template "repo/issue/sidebar/reviewer_list" $.IssueSidebarReviewersData}}
 			<div class="divider"></div>
 		{{end}}
 

web_src/js/features/repo-issue-sidebar-combolist.ts

@@ -31,7 +31,7 @@ export function initIssueSidebarComboList(container: HTMLElement) {
   const elDropdown = container.querySelector<HTMLElement>(':scope > .ui.dropdown');
   const elList = container.querySelector<HTMLElement>(':scope > .ui.list');
   const elComboValue = container.querySelector<HTMLInputElement>(':scope > .combo-value');
-  const initialValues = collectCheckedValues(elDropdown);
+  let initialValues = collectCheckedValues(elDropdown);
 
   elDropdown.addEventListener('click', (e) => {
     const elItem = (e.target as HTMLElement).closest('.item');
@@ -78,7 +78,7 @@ export function initIssueSidebarComboList(container: HTMLElement) {
     if (changed) issueSidebarReloadConfirmDraftComment();
   };
 
-  const syncList = (changedValues) => {
+  const syncUiList = (changedValues) => {
     const elEmptyTip = elList.querySelector('.item.empty-list');
     queryElemChildren(elList, '.item:not(.empty-list)', (el) => el.remove());
     for (const value of changedValues) {
@@ -95,12 +95,11 @@ export function initIssueSidebarComboList(container: HTMLElement) {
     action: 'nothing', // do not hide the menu if user presses Enter
     fullTextSearch: 'exact',
     async onHide() {
+      // TODO: support "Esc" to cancel the selection. Use partial page loading to avoid losing inputs.
       const changedValues = collectCheckedValues(elDropdown);
-      if (updateUrl) {
-        await updateToBackend(changedValues); // send requests to backend and reload the page
-      } else {
-        syncList(changedValues); // only update the list in the sidebar
-      }
+      syncUiList(changedValues);
+      if (updateUrl) await updateToBackend(changedValues);
+      initialValues = changedValues;
     },
   });
 }