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.

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

feat: Web UI for auto-indexing #438 #446

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mickol34
Copy link
Collaborator

@mickol34 mickol34 commented Jan 29, 2025

Your checklist for this pull request

  • I've read the contributing guideline.
  • I've tested my changes by building and running mquery, and testing changed functionality (if applicable)
  • I've added automated tests for my change (if applicable, optional)
  • I've updated documentation to reflect my change (if applicable)

What is the current behaviour?
Currently there is no UI to provide data for auto-indexing.

What is the new behaviour?
This PR introduces web UI to API mentioned in #437.

Test plan

Check how everything is looking, if it responds properly, if there are any scenarios in which page should behave differently. Check if data is being parsed properly within endpoints, if there are any edge-cases regarding inputs. Any additional suggestions will be welcome.

Closing issues

fixes #438

@mickol34 mickol34 requested a review from msm-cert January 29, 2025 12:06
@mickol34
Copy link
Collaborator Author

Currently these components operate solely on stub data, which should be later provided from endpoints in #437. For now it is possible to manually test page responsivity by manipulating these stub inputs. Any suggestions regarding visual side of this UI or additional features will be very welcome.

@mickol34 mickol34 changed the title feat: Web UI for auto-indexing #438 Draft: feat: Web UI for auto-indexing #438 Jan 29, 2025
@mickol34 mickol34 changed the title Draft: feat: Web UI for auto-indexing #438 feat: Web UI for auto-indexing #438 Jan 29, 2025
@mickol34 mickol34 marked this pull request as draft January 29, 2025 12:10
@mickol34
Copy link
Collaborator Author

Screencast.from.2025-02-11.10-22-52.webm

This video presents basic use cases for index page, including:

  • going to dedicated indexing page from status page,
  • usage of form inputs (textbox counting non-empty lines as individual inputs and two multiselects),
  • sending requests to API (though currently they fail for obvious reasons),
  • showing progress bar and clear queue buttons (progress percentage depends on allQueuedFilesLength and finishedQueuedFilesLength params, modified live at lines 49:50 in current version of IndexPage.js

@mickol34
Copy link
Collaborator Author

For some reason previous screencast got possessed by demons in the middle of form demo. This video should provide missing feedback.

Screencast.from.2025-02-11.10-32-39.webm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement a web UI to show the queue status
1 participant