From 141d782c1abd4fcaadbdff453aecb1969d8c3f0d Mon Sep 17 00:00:00 2001 From: silverwind Date: Thu, 19 Dec 2024 09:37:12 +0100 Subject: [PATCH] Refactor repo-projects.ts (#32892) - Remove jQuery - Add types to all functions - Tested all modified functionality --------- Co-authored-by: Giteabot Co-authored-by: wxiaoguang --- routers/web/web.go | 10 +- templates/projects/view.tmpl | 164 ++++++--------- .../repo/issue/labels/label_edit_modal.tmpl | 2 +- web_src/css/features/projects.css | 4 - web_src/js/features/common-fetch-action.ts | 2 +- web_src/js/features/repo-projects.ts | 190 +++++++----------- .../features/repo-settings-branches.test.ts | 8 +- web_src/js/modules/sortable.ts | 3 +- 8 files changed, 148 insertions(+), 235 deletions(-) diff --git a/routers/web/web.go b/routers/web/web.go index 72ee47bb4c..aa37d4dc10 100644 --- a/routers/web/web.go +++ b/routers/web/web.go @@ -1020,14 +1020,15 @@ func registerRoutes(m *web.Router) { m.Get("/new", org.RenderNewProject) m.Post("/new", web.Bind(forms.CreateProjectForm{}), org.NewProjectPost) m.Group("/{id}", func() { - m.Post("", web.Bind(forms.EditProjectColumnForm{}), org.AddColumnToProjectPost) - m.Post("/move", project.MoveColumns) m.Post("/delete", org.DeleteProject) m.Get("/edit", org.RenderEditProject) m.Post("/edit", web.Bind(forms.CreateProjectForm{}), org.EditProjectPost) m.Post("/{action:open|close}", org.ChangeProjectStatus) + // TODO: improper name. Others are "delete project", "edit project", but this one is "move columns" + m.Post("/move", project.MoveColumns) + m.Post("/columns/new", web.Bind(forms.EditProjectColumnForm{}), org.AddColumnToProjectPost) m.Group("/{columnID}", func() { m.Put("", web.Bind(forms.EditProjectColumnForm{}), org.EditProjectColumn) m.Delete("", org.DeleteProjectColumn) @@ -1387,14 +1388,15 @@ func registerRoutes(m *web.Router) { m.Get("/new", repo.RenderNewProject) m.Post("/new", web.Bind(forms.CreateProjectForm{}), repo.NewProjectPost) m.Group("/{id}", func() { - m.Post("", web.Bind(forms.EditProjectColumnForm{}), repo.AddColumnToProjectPost) - m.Post("/move", project.MoveColumns) m.Post("/delete", repo.DeleteProject) m.Get("/edit", repo.RenderEditProject) m.Post("/edit", web.Bind(forms.CreateProjectForm{}), repo.EditProjectPost) m.Post("/{action:open|close}", repo.ChangeProjectStatus) + // TODO: improper name. Others are "delete project", "edit project", but this one is "move columns" + m.Post("/move", project.MoveColumns) + m.Post("/columns/new", web.Bind(forms.EditProjectColumnForm{}), repo.AddColumnToProjectPost) m.Group("/{columnID}", func() { m.Put("", web.Bind(forms.EditProjectColumnForm{}), repo.EditProjectColumn) m.Delete("", repo.DeleteProjectColumn) diff --git a/templates/projects/view.tmpl b/templates/projects/view.tmpl index 966d3bf604..2550cae69c 100644 --- a/templates/projects/view.tmpl +++ b/templates/projects/view.tmpl @@ -37,41 +37,25 @@ {{ctx.Locale.Tr "repo.projects.close"}} {{end}} - - - {{end}} @@ -80,88 +64,43 @@
-
-
+
+
{{range .Columns}} -
+
{{.NumIssues ctx}}
-
{{.Title}}
+
{{.Title}}
{{if $canWriteProject}}
{{svg "octicon-kebab-horizontal"}}
- - {{svg "octicon-pencil"}} - {{ctx.Locale.Tr "repo.projects.column.edit"}} + + {{svg "octicon-pencil"}} {{ctx.Locale.Tr "repo.projects.column.edit"}} {{if not .Default}} - - {{svg "octicon-pin"}} - {{ctx.Locale.Tr "repo.projects.column.set_default"}} + + {{svg "octicon-pin"}} {{ctx.Locale.Tr "repo.projects.column.set_default"}} - - {{svg "octicon-trash"}} - {{ctx.Locale.Tr "repo.projects.column.delete"}} + + {{svg "octicon-trash"}} {{ctx.Locale.Tr "repo.projects.column.delete"}} {{end}} - - - - - -
{{end}} @@ -179,15 +118,28 @@
-{{if .CanWriteProjects}} -
-
- {{svg "octicon-trash"}} - {{ctx.Locale.Tr "repo.projects.deletion"}} -
-
-

{{ctx.Locale.Tr "repo.projects.deletion_desc"}}

-
- {{template "base/modal_actions_confirm" .}} +{{if $canWriteProject}} + {{end}} diff --git a/templates/repo/issue/labels/label_edit_modal.tmpl b/templates/repo/issue/labels/label_edit_modal.tmpl index f04d499737..527b7ff900 100644 --- a/templates/repo/issue/labels/label_edit_modal.tmpl +++ b/templates/repo/issue/labels/label_edit_modal.tmpl @@ -41,7 +41,7 @@
-
+
diff --git a/web_src/css/features/projects.css b/web_src/css/features/projects.css index 9d462c4c4a..8763d3684e 100644 --- a/web_src/css/features/projects.css +++ b/web_src/css/features/projects.css @@ -51,10 +51,6 @@ color: inherit; } -.project-column-title-label { - flex: 1; -} - .project-column > .cards { flex: 1; display: flex; diff --git a/web_src/js/features/common-fetch-action.ts b/web_src/js/features/common-fetch-action.ts index a6901756f6..1a5b38e3e5 100644 --- a/web_src/js/features/common-fetch-action.ts +++ b/web_src/js/features/common-fetch-action.ts @@ -100,7 +100,7 @@ async function linkAction(el: HTMLElement, e: Event) { const url = el.getAttribute('data-url'); const doRequest = async () => { if ('disabled' in el) el.disabled = true; // el could be A or BUTTON, but A doesn't have disabled attribute - await fetchActionDoRequest(el, url, {method: 'POST'}); + await fetchActionDoRequest(el, url, {method: el.getAttribute('data-link-action-method') || 'POST'}); if ('disabled' in el) el.disabled = false; }; diff --git a/web_src/js/features/repo-projects.ts b/web_src/js/features/repo-projects.ts index d1f0d17c44..11f5c19c8d 100644 --- a/web_src/js/features/repo-projects.ts +++ b/web_src/js/features/repo-projects.ts @@ -1,31 +1,17 @@ -import $ from 'jquery'; import {contrastColor} from '../utils/color.ts'; import {createSortable} from '../modules/sortable.ts'; -import {POST, DELETE, PUT} from '../modules/fetch.ts'; +import {POST, request} from '../modules/fetch.ts'; +import {fomanticQuery} from '../modules/fomantic/base.ts'; +import {queryElemChildren, queryElems} from '../utils/dom.ts'; +import type {SortableEvent} from 'sortablejs'; -function updateIssueCount(cards) { - const parent = cards.parentElement; - const cnt = parent.querySelectorAll('.issue-card').length; - parent.querySelectorAll('.project-column-issue-count')[0].textContent = cnt; +function updateIssueCount(card: HTMLElement): void { + const parent = card.parentElement; + const count = parent.querySelectorAll('.issue-card').length; + parent.querySelector('.project-column-issue-count').textContent = String(count); } -async function createNewColumn(url, columnTitle, projectColorInput) { - try { - await POST(url, { - data: { - title: columnTitle.val(), - color: projectColorInput.val(), - }, - }); - } catch (error) { - console.error(error); - } finally { - columnTitle.closest('form').removeClass('dirty'); - window.location.reload(); - } -} - -async function moveIssue({item, from, to, oldIndex}: {item: HTMLElement, from: HTMLElement, to: HTMLElement, oldIndex: number}) { +async function moveIssue({item, from, to, oldIndex}: SortableEvent): Promise { const columnCards = to.querySelectorAll('.issue-card'); updateIssueCount(from); updateIssueCount(to); @@ -47,13 +33,10 @@ async function moveIssue({item, from, to, oldIndex}: {item: HTMLElement, from: H } } -async function initRepoProjectSortable() { - const els = document.querySelectorAll('#project-board > .board.sortable'); - if (!els.length) return; - +async function initRepoProjectSortable(): Promise { // the HTML layout is: #project-board > .board > .project-column .cards > .issue-card - const mainBoard = els[0]; - let boardColumns = mainBoard.querySelectorAll('.project-column'); + const mainBoard = document.querySelector('#project-board > .board.sortable'); + let boardColumns = mainBoard.querySelectorAll('.project-column'); createSortable(mainBoard, { group: 'project-column', draggable: '.project-column', @@ -61,7 +44,7 @@ async function initRepoProjectSortable() { delayOnTouchOnly: true, delay: 500, onSort: async () => { // eslint-disable-line @typescript-eslint/no-misused-promises - boardColumns = mainBoard.querySelectorAll('.project-column'); + boardColumns = mainBoard.querySelectorAll('.project-column'); const columnSorting = { columns: Array.from(boardColumns, (column, i) => ({ @@ -81,7 +64,7 @@ async function initRepoProjectSortable() { }); for (const boardColumn of boardColumns) { - const boardCardList = boardColumn.querySelectorAll('.cards')[0]; + const boardCardList = boardColumn.querySelector('.cards'); createSortable(boardCardList, { group: 'shared', onAdd: moveIssue, // eslint-disable-line @typescript-eslint/no-misused-promises @@ -92,97 +75,74 @@ async function initRepoProjectSortable() { } } -export function initRepoProject() { - if (!document.querySelector('.repository.projects')) { - return; - } +function initRepoProjectColumnEdit(writableProjectBoard: Element): void { + const elModal = document.querySelector('.ui.modal#project-column-modal-edit'); + const elForm = elModal.querySelector('form'); - initRepoProjectSortable(); // no await + const elColumnId = elForm.querySelector('input[name="id"]'); + const elColumnTitle = elForm.querySelector('input[name="title"]'); + const elColumnColor = elForm.querySelector('input[name="color"]'); - for (const modal of document.querySelectorAll('.edit-project-column-modal')) { - const projectHeader = modal.closest('.project-column-header'); - const projectTitleLabel = projectHeader?.querySelector('.project-column-title-label'); - const projectTitleInput = modal.querySelector('.project-column-title-input'); - const projectColorInput = modal.querySelector('#new_project_column_color'); - const boardColumn = modal.closest('.project-column'); - modal.querySelector('.edit-project-column-button')?.addEventListener('click', async function (e) { - e.preventDefault(); - try { - await PUT(this.getAttribute('data-url'), { - data: { - title: projectTitleInput?.value, - color: projectColorInput?.value, - }, - }); - } catch (error) { - console.error(error); - } finally { - projectTitleLabel.textContent = projectTitleInput?.value; - projectTitleInput.closest('form')?.classList.remove('dirty'); - const dividers = boardColumn.querySelectorAll(':scope > .divider'); - if (projectColorInput.value) { - const color = contrastColor(projectColorInput.value); - boardColumn.style.setProperty('background', projectColorInput.value, 'important'); - boardColumn.style.setProperty('color', color, 'important'); - for (const divider of dividers) { - divider.style.setProperty('color', color); - } - } else { - boardColumn.style.removeProperty('background'); - boardColumn.style.removeProperty('color'); - for (const divider of dividers) { - divider.style.removeProperty('color'); - } - } - $('.ui.modal').modal('hide'); - } - }); - } + const attrDataColumnId = 'data-modal-project-column-id'; + const attrDataColumnTitle = 'data-modal-project-column-title-input'; + const attrDataColumnColor = 'data-modal-project-column-color-input'; - $('.default-project-column-modal').each(function () { - const $boardColumn = $(this).closest('.project-column'); - const $showButton = $($boardColumn).find('.default-project-column-show'); - const $commitButton = $(this).find('.actions > .ok.button'); - - $($commitButton).on('click', async (e) => { - e.preventDefault(); - - try { - await POST($($showButton).data('url')); - } catch (error) { - console.error(error); - } finally { - window.location.reload(); - } + // the "new" button is not in project board, so need to query from document + queryElems(document, '.show-project-column-modal-edit', (el) => { + el.addEventListener('click', () => { + elColumnId.value = el.getAttribute(attrDataColumnId); + elColumnTitle.value = el.getAttribute(attrDataColumnTitle); + elColumnColor.value = el.getAttribute(attrDataColumnColor); + elColumnColor.dispatchEvent(new Event('input', {bubbles: true})); // trigger the color picker }); }); - $('.show-delete-project-column-modal').each(function () { - const $deleteColumnModal = $(`${this.getAttribute('data-modal')}`); - const $deleteColumnButton = $deleteColumnModal.find('.actions > .ok.button'); - const deleteUrl = this.getAttribute('data-url'); - - $deleteColumnButton.on('click', async (e) => { - e.preventDefault(); - - try { - await DELETE(deleteUrl); - } catch (error) { - console.error(error); - } finally { - window.location.reload(); - } - }); - }); - - $('#new_project_column_submit').on('click', (e) => { + elForm.addEventListener('submit', async (e) => { e.preventDefault(); - const $columnTitle = $('#new_project_column'); - const $projectColorInput = $('#new_project_column_color_picker'); - if (!$columnTitle.val()) { - return; + const columnId = elColumnId.value; + const actionBaseLink = elForm.getAttribute('data-action-base-link'); + + const formData = new FormData(elForm); + const formLink = columnId ? `${actionBaseLink}/${columnId}` : `${actionBaseLink}/columns/new`; + const formMethod = columnId ? 'PUT' : 'POST'; + + try { + elForm.classList.add('is-loading'); + await request(formLink, {method: formMethod, data: formData}); + if (!columnId) { + window.location.reload(); // newly added column, need to reload the page + return; + } + fomanticQuery(elModal).modal('hide'); + + // update the newly saved column title and color in the project board (to avoid reload) + const elEditButton = writableProjectBoard.querySelector(`.show-project-column-modal-edit[${attrDataColumnId}="${columnId}"]`); + elEditButton.setAttribute(attrDataColumnTitle, elColumnTitle.value); + elEditButton.setAttribute(attrDataColumnColor, elColumnColor.value); + + const elBoardColumn = writableProjectBoard.querySelector(`.project-column[data-id="${columnId}"]`); + const elBoardColumnTitle = elBoardColumn.querySelector(`.project-column-title-text`); + elBoardColumnTitle.textContent = elColumnTitle.value; + if (elColumnColor.value) { + const textColor = contrastColor(elColumnColor.value); + elBoardColumn.style.setProperty('background', elColumnColor.value, 'important'); + elBoardColumn.style.setProperty('color', textColor, 'important'); + queryElemChildren(elBoardColumn, '.divider', (divider) => divider.style.color = textColor); + } else { + elBoardColumn.style.removeProperty('background'); + elBoardColumn.style.removeProperty('color'); + queryElemChildren(elBoardColumn, '.divider', (divider) => divider.style.removeProperty('color')); + } + } finally { + elForm.classList.remove('is-loading'); } - const url = e.target.getAttribute('data-url'); - createNewColumn(url, $columnTitle, $projectColorInput); }); } + +export function initRepoProject(): void { + const writableProjectBoard = document.querySelector('#project-board[data-project-borad-writable="true"]'); + if (!writableProjectBoard) return; + + initRepoProjectSortable(); // no await + initRepoProjectColumnEdit(writableProjectBoard); +} diff --git a/web_src/js/features/repo-settings-branches.test.ts b/web_src/js/features/repo-settings-branches.test.ts index 32ab54e4c2..526e279723 100644 --- a/web_src/js/features/repo-settings-branches.test.ts +++ b/web_src/js/features/repo-settings-branches.test.ts @@ -2,7 +2,8 @@ import {beforeEach, describe, expect, test, vi} from 'vitest'; import {initRepoSettingsBranchesDrag} from './repo-settings-branches.ts'; import {POST} from '../modules/fetch.ts'; import {createSortable} from '../modules/sortable.ts'; -import type {SortableEvent} from 'sortablejs'; +import type {SortableEvent, SortableOptions} from 'sortablejs'; +import type Sortable from 'sortablejs'; vi.mock('../modules/fetch.ts', () => ({ POST: vi.fn(), @@ -55,9 +56,10 @@ describe('Repository Branch Settings', () => { vi.mocked(POST).mockResolvedValue({ok: true} as Response); // Mock createSortable to capture and execute the onEnd callback - vi.mocked(createSortable).mockImplementation(async (_el: Element, options) => { + vi.mocked(createSortable).mockImplementation(async (_el: Element, options: SortableOptions) => { options.onEnd(new Event('SortableEvent') as SortableEvent); - return {destroy: vi.fn()}; + // @ts-expect-error: mock is incomplete + return {destroy: vi.fn()} as Sortable; }); initRepoSettingsBranchesDrag(); diff --git a/web_src/js/modules/sortable.ts b/web_src/js/modules/sortable.ts index b318386d08..b700633cbb 100644 --- a/web_src/js/modules/sortable.ts +++ b/web_src/js/modules/sortable.ts @@ -1,6 +1,7 @@ import type {SortableOptions, SortableEvent} from 'sortablejs'; +import type SortableType from 'sortablejs'; -export async function createSortable(el: Element, opts: {handle?: string} & SortableOptions = {}) { +export async function createSortable(el: Element, opts: {handle?: string} & SortableOptions = {}): Promise { // @ts-expect-error: wrong type derived by typescript const {Sortable} = await import(/* webpackChunkName: "sortablejs" */'sortablejs');