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

fix(web): Broken anchor page links in search #15583

Merged
merged 1 commit into from
Aug 2, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Aug 2, 2024

Broken anchor page links in search

What

  • Digital Iceland community pages were linking to a 404 page due to the search link resolution code not handling all anchor page types

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates to the Search component in Search.tsx enhance how AnchorPage items are processed. A new utility function, extractAnchorPageLinkType, is incorporated to streamline link type resolution, replacing the previous hardcoded checks based on pageType. This change improves code maintainability and flexibility, allowing for easier expansion and modifications in the future.

Changes

Files Change Summary
apps/web/screens/Search/Search.tsx Updated getItemLink to use extractAnchorPageLinkType for link type resolution, simplifying logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Search
    participant LinkTypeExtractor

    User->>Search: Initiate search
    Search->>LinkTypeExtractor: Call extractAnchorPageLinkType(item)
    LinkTypeExtractor-->>Search: Return link type
    Search-->>User: Display results with appropriate links
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@datadog-island-is
Copy link

Datadog Report

Branch report: fix/web-broken-search-links
Commit report: 5de9b62
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 29.37s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link

codecov bot commented Aug 2, 2024

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 37.00%. Comparing base (db89852) to head (09af8e6).

Files Patch % Lines
apps/web/screens/Search/Search.tsx 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #15583   +/-   ##
=======================================
  Coverage   37.00%   37.00%           
=======================================
  Files        6558     6558           
  Lines      134117   134115    -2     
  Branches    38390    38388    -2     
=======================================
  Hits        49633    49633           
+ Misses      84484    84482    -2     
Flag Coverage Δ
web 1.89% <0.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
apps/web/screens/Search/Search.tsx 0.00% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db89852...09af8e6. Read the comment docs.

@RunarVestmann RunarVestmann marked this pull request as ready for review August 2, 2024 10:39
@RunarVestmann RunarVestmann requested review from a team as code owners August 2, 2024 10:39
@RunarVestmann RunarVestmann changed the title fix(web): Broken links in search fix(web): Broken anchor page links in search Aug 2, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between db89852 and 09af8e6.

Files selected for processing (1)
  • apps/web/screens/Search/Search.tsx (2 hunks)
Additional context used
Path-based instructions (1)
apps/web/screens/Search/Search.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Additional comments not posted (2)
apps/web/screens/Search/Search.tsx (2)

69-72: Import statement changes approved.

The import statement correctly includes the new utility function extractAnchorPageLinkType.


320-321: Function logic changes approved.

The getItemLink function's logic is simplified by using the extractAnchorPageLinkType utility function.

However, ensure that the extractAnchorPageLinkType function is correctly used throughout the codebase.

Verification successful

Verification successful.

The extractAnchorPageLinkType function is correctly used throughout the codebase.

  • apps/web/components/SearchInput/SearchInput.tsx
  • apps/web/components/Organization/Slice/AnchorPageListSlice/AnchorPageListSlice.tsx
  • apps/web/screens/Search/Search.tsx
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `extractAnchorPageLinkType` in the codebase.

# Test: Search for the function usage. Expect: Proper usage across the codebase.
rg --type ts -A 5 $'extractAnchorPageLinkType'

Length of output: 4261

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Aug 2, 2024
@kodiakhq kodiakhq bot merged commit 6221627 into main Aug 2, 2024
45 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-broken-search-links branch August 2, 2024 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants