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: adjust the preview of the current page to schema data #1095

Open
wants to merge 3 commits into
base: refactor/develop
Choose a base branch
from

Conversation

lichunn
Copy link
Contributor

@lichunn lichunn commented Feb 6, 2025

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

页面预览显示内容为上一次保存的内容

Issue Number: N/A

What is the new behavior?

预览逻辑调整为当前页面获取schema数据,保持以前不需要保存就可以预览的逻辑

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Refactor
    • Improved page detail processing to ensure content displays accurately by incorporating the current page context.
    • Enhanced preview functionality by refining how related page information is retrieved and presented for a more accurate view.

Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Walkthrough

The pull request updates function signatures in the page composable. In usePage.js, the handlePageDetail function now accepts an additional currentPage parameter. Similarly, the getFamily function now requires a complete page object instead of just an ID, and it subsequently passes the updated parameter to handlePageDetail. In Main.vue, the invocation of getFamily has been updated to pass the entire parameter object rather than just the page ID, ensuring that the page context is properly maintained throughout the process.

Changes

File Path Change Summary
packages/plugins/page/src/.../usePage.js Updated handlePageDetail to accept an extra currentPage parameter; modified getFamily to take a page object instead of an ID, and adjusted its call.
packages/toolbars/preview/src/.../Main.vue Changed the call to getFamily to pass the complete params object instead of just params.id in the preview function.

Sequence Diagram(s)

sequenceDiagram
    participant M as Main.vue (preview)
    participant U as usePage.js (getFamily)
    participant H as usePage.js (handlePageDetail)

    M->>U: Call getFamily(params)
    U->>H: Call handlePageDetail(familyPages, params)
    H-->>U: Return updated family pages
    U-->>M: Return ancestors based on updated details
Loading

Possibly related PRs

Suggested labels

ready_for_review, enhancement

Suggested reviewers

  • rhlin
  • hexqi

Poem

I’m a hopping rabbit, full of cheer,
New page details now crystal clear.
With getFamily updated, the code does sing,
Handling ancestors like a magical spring.
Hop along, my coder friend, let joy appear!
🐇🌟

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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.

@github-actions github-actions bot added bug Something isn't working refactor-main refactor/develop branch feature labels Feb 6, 2025
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: 2

🧹 Nitpick comments (1)
packages/plugins/page/src/composable/usePage.js (1)

398-403: Add defensive programming for schema access.

The schema access could be more defensive to prevent potential runtime errors.

-  if (currentPage.id && currentPage.pageInfo?.schema && page.id === currentPage.id) {
-    page.page_content = currentPage.pageInfo?.schema
+  if (currentPage?.id && currentPage?.pageInfo?.schema && page?.id === currentPage.id) {
+    page.page_content = currentPage.pageInfo.schema
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a9d5abb and 781f1f7.

📒 Files selected for processing (1)
  • packages/plugins/page/src/composable/usePage.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (1)
packages/plugins/page/src/composable/usePage.js (1)

435-447: Improve parameter naming for better clarity.

The parameter name previewParams is not descriptive enough of its structure. Based on the previous review comments, this parameter contains framework, platform, and pageInfo.

-const getFamily = async (previewParams) => {
+const getFamily = async (pageContext) => {
   if (pageSettingState.pages.length === 0) {
     await getPageList()
   }
 
-  const familyPages = getAncestorsRecursively(previewParams.id)
+  const familyPages = getAncestorsRecursively(pageContext.id)
     .filter((item) => item.isPage)
     .reverse()
 
-  await handlePageDetail(familyPages, previewParams)
+  await handlePageDetail(familyPages, pageContext)
 
   return familyPages
 }

packages/plugins/page/src/composable/usePage.js Outdated Show resolved Hide resolved
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

🧹 Nitpick comments (2)
packages/plugins/page/src/composable/usePage.js (2)

417-421: Rename function for better clarity.

The function name updateParentId doesn't fully convey that it's fixing invalid parent references.

-const updateParentId = (page, pages, index, ROOT_ID) => {
+const fixInvalidParentReference = (page, pages, index, ROOT_ID) => {

439-451: Improve parameter naming for better clarity.

The parameter name previewParams is too generic. Based on its usage, it represents the current page's context.

-const getFamily = async (previewParams) => {
+const getFamily = async (currentPageContext) => {
   if (pageSettingState.pages.length === 0) {
     await getPageList()
   }
 
-  const familyPages = getAncestorsRecursively(previewParams.id)
+  const familyPages = getAncestorsRecursively(currentPageContext.id)
     .filter((item) => item.isPage)
     .reverse()
 
-  await handlePageDetail(familyPages, previewParams)
+  await handlePageDetail(familyPages, currentPageContext)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 781f1f7 and 806ee47.

📒 Files selected for processing (1)
  • packages/plugins/page/src/composable/usePage.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (3)
packages/plugins/page/src/composable/usePage.js (3)

423-437: 🛠️ Refactor suggestion

Add error handling for Promise.all operation.

The concurrent execution could fail silently if any of the promises reject.

   if (pages.length > 0) {
+    try {
       pages = await Promise.all(
         pages.map(async (page, index) => {
           page = updatePageContent(page, currentPage)
           page = await fetchPageDetailIfNeeded(page)
-          page = updateParentId(page, pages, index, ROOT_ID)
+          page = fixInvalidParentReference(page, pages, index, ROOT_ID)
 
           return page
         })
       )
+    } catch (error) {
+      console.error('Failed to process page details:', error)
+      throw error // Re-throw to allow caller to handle the error
+    }
   }

Likely invalid or redundant comment.


398-403: 🛠️ Refactor suggestion

Add optional chaining for safer property access.

The deep property access could throw if pageInfo is undefined.

-  if (currentPage.id && currentPage.pageInfo?.schema && page.id === currentPage.id) {
-    page.page_content = currentPage.pageInfo?.schema
+  if (currentPage?.id && currentPage.pageInfo?.schema && page.id === currentPage.id) {
+    page.page_content = currentPage.pageInfo.schema

Likely invalid or redundant comment.


405-415: 🛠️ Refactor suggestion

Improve error handling in fetchPageDetailIfNeeded.

The function silently swallows errors and sets an empty object. This could hide issues and make debugging difficult.

   try {
     const pageDetail = await http.fetchPageDetail(page.id)
     page.page_content = pageDetail.page_content
   } catch (error) {
+    console.error(`Failed to fetch page detail for page ${page.id}:`, error)
     page.page_content = {}
   }

Likely invalid or redundant comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants