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(contentful-apps): Handle org subpage and parent subpage preview link routing #17369

Merged

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 30, 2024

Handle org subpage and parent subpage preview link routing

What

Now org subpages can belong to a so called "parent subpage", so their preview links depend on that

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

Summary by CodeRabbit

  • New Features

    • Enhanced preview link generation for organization subpages
    • Improved URL construction logic for entries with parent subpages
    • Added new method to handle organization parent subpage preview links
  • Performance

    • Implemented concurrent data fetching to reduce retrieval wait times

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Dec 30, 2024
@RunarVestmann RunarVestmann requested a review from a team as a code owner December 30, 2024 13:51
Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request modifies the previewLinkHandler in the PreviewLinkSidebar component, introducing a more efficient approach to fetching organization pages and subpages. The organizationSubpage method now uses Promise.all for concurrent data retrieval, improving performance. A new method organizationParentSubpage has been added to construct URLs based on organization page and entry slugs, enhancing the flexibility of link generation for organization-related content.

Changes

File Change Summary
apps/contentful-apps/pages/sidebars/preview-link.tsx - Refactored organizationSubpage method to use Promise.all for concurrent fetching
- Added new organizationParentSubpage method to handle URL construction for organization parent subpages

Sequence Diagram

sequenceDiagram
    participant Component as PreviewLinkSidebar
    participant Handler as previewLinkHandler
    participant CMA as Contentful Management API
    
    Component->>Handler: organizationSubpage(entry, cma)
    Handler->>CMA: Fetch organization page
    Handler->>CMA: Fetch parent subpages
    CMA-->>Handler: Return page and subpage data
    Handler->>Handler: Construct URL based on retrieved data
    Handler-->>Component: Return preview link
Loading

Possibly related PRs

Suggested reviewers

  • mannipje

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

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

Project coverage is 35.67%. Comparing base (1f091a0) to head (fd52e6f).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ps/contentful-apps/pages/sidebars/preview-link.tsx 0.00% 11 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17369      +/-   ##
==========================================
- Coverage   35.68%   35.67%   -0.01%     
==========================================
  Files        6932     6931       -1     
  Lines      148815   148788      -27     
  Branches    42519    42506      -13     
==========================================
- Hits        53098    53075      -23     
+ Misses      95717    95713       -4     
Flag Coverage Δ
contentful-apps 4.69% <0.00%> (-0.02%) ⬇️
web 2.40% <ø> (ø)

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

Files with missing lines Coverage Δ
...ps/contentful-apps/pages/sidebars/preview-link.tsx 0.00% <0.00%> (ø)

... and 14 files with indirect coverage changes


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 1f091a0...fd52e6f. Read the comment docs.

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: 1

🧹 Nitpick comments (1)
apps/contentful-apps/pages/sidebars/preview-link.tsx (1)

86-100: Refactor to reduce duplicated fetch logic
Both organizationSubpage and organizationParentSubpage share similar steps for retrieving the organization page and building a URL. Consider extracting this logic into a shared helper function to improve maintainability and consistency.

+ // Example shared helper
+ async function fetchOrganizationPage(cma: CMAClient, id: string) {
+   return cma.entry.get({
+     entryId: id,
+     environmentId: CONTENTFUL_ENVIRONMENT,
+     spaceId: CONTENTFUL_SPACE,
+   })
+ }

  organizationParentSubpage: async (entry, cma) => {
    const organizationPageId =
      entry.fields.organizationPage?.[DEFAULT_LOCALE]?.sys?.id
-   const organizationPage = await cma.entry.get({ ... })
+   const organizationPage = await fetchOrganizationPage(cma, organizationPageId)
    ...
  },
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56493cc and 298beef.

📒 Files selected for processing (1)
  • apps/contentful-apps/pages/sidebars/preview-link.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/contentful-apps/pages/sidebars/preview-link.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 (1)
apps/contentful-apps/pages/sidebars/preview-link.tsx (1)

6-6: No significant changes introduced at this line.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 30, 2024

Datadog Report

Branch report: fix/contentful-apps-organization-parent-subpage-preview-link
Commit report: 9851f19
Test service: web

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

@kodiakhq kodiakhq bot merged commit 9f4dbf0 into main Jan 4, 2025
37 checks passed
@kodiakhq kodiakhq bot deleted the fix/contentful-apps-organization-parent-subpage-preview-link branch January 4, 2025 06:53
@coderabbitai coderabbitai bot mentioned this pull request Jan 7, 2025
6 tasks
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.

2 participants