Artwork search optimalization

blackfyre commented 8 months ago

This PR has one major objective: make the artwork search better!

A couple of steps for achieving this:

[x] Rename Search to Artworks
[x] Delay initial search results loading

Summary by CodeRabbit

New Features
- Updated the Artworks search page to include query parameters for enhanced search functionality.
- Introduced a new display structure for search results with pagination support.
- Navigation bar updated to reflect the change from "Search" to "Artworks."
Enhancements
- Added a sequence diagram in the documentation to illustrate the Artwork search process.
- Improved artwork filtering capabilities with new methods for filter management.
Bug Fixes
- Adjusted pagination logic to correctly handle empty search results and ensure seamless user navigation.
Refactor
- Renamed the "search" package to "artworks" to better align with its functionality.
- Refactored artwork handler functions to support new filtering and pagination features.
Style
- Enhanced styles for the Artworks search results display for a more user-friendly interface.

coderabbitai[bot] commented 8 months ago

[!WARNING]

Rate Limit Exceeded

@blackfyre has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 7 minutes and 31 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between aac3c3ca7e66d0f6401ef545d578e2b40908570d and 2465c591b50e554d1aea326df298dec1eb04ca06.

Walkthrough

The overall change involves a rework of the artwork search functionality in a web application. The updates include modifications to the HTML templates, the addition of new backend handlers for artwork filtering and pagination, and updates to the navigation bar to reflect the focus on artworks. The changes suggest an enhancement of the user interface for artwork discovery and an improvement in the backend logic to support advanced search and filtering capabilities.

Changes

File Path	Change Summary
`assets/views/pages/artworks.html`	Updated form action URL, block names, and search results structure.
`assets/views/partials/artworks_results.html` `handlers/artworks/main.go` `handlers/artworks/filters.go`	Added HTML template code for displaying search results with pagination. Introduced `artworks` package with new structures and methods for filtering and search logic. Modified `searchPage` and `search` functions to incorporate new logic and control flow.
`assets/views/partials/nav.html` `handlers/main.go`	Updated navigation bar link label from "Search" to "Artworks". Changed import path and function call to register new artwork handlers.
`docs/searchpage.md`	Introduced sequence diagram for Artwork search page interaction.
`handlers/artists.go`	Modified `registerArtists` function to include an additional argument in `NewPagination`.
`utils/pagination.go`	Updated `Pagination` struct and methods to support additional `htmxBaseUrl` field and parameters.

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`

what-the-diff[bot] commented 8 months ago

PR Summary

Changes to Navigation Interface Updated the navigation, changing the link previously labelled 'Search' to now be labelled as 'Artworks'.
Registration Function Rename and Endpoint Path Change The function formerly referred to as RegisterSearchHandlers is now named RegisterArtworksHandlers. The API endpoint path has updated to reflect this change, from /search to /artworks.
Package Renaming The previously termed search package now bears the name artworks. This applies to numerous files including filters.go, getters.go, and main.go.
Main Handlers Update Reflective of the above changes, the RegisterHandlers function now makes use of artworks.RegisterArtworksHandlers in place of its previous counterpart, search.RegisterSearchHandlers. Import statements have been updated accordingly to use the artworks package.

blackfyre / wga