Skip to content

fix: preview ancestor has folder will get plain page#1565

Merged
hexqi merged 2 commits intoopentiny:developfrom
chilingling:fix/previewWithFolderGetEmptyPage
Jul 30, 2025
Merged

fix: preview ancestor has folder will get plain page#1565
hexqi merged 2 commits intoopentiny:developfrom
chilingling:fix/previewWithFolderGetEmptyPage

Conversation

@chilingling
Copy link
Member

@chilingling chilingling commented Jul 29, 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

【问题描述】
使用 url 预览页面时(即非实时预览模式),如果祖先页面有文件夹,则会预览得到空页面。

【问题分析】
如果有文件夹的时候,文件夹出码得到的是空 div。

【问题修复方案】
获取祖先页面的时候,过滤文件夹。

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Improved ancestor filtering to display only actual pages in the ancestors list.
    • Ensured a main page is always designated as the index in ancestry files for better navigation consistency.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 29, 2025

Walkthrough

The IPage interface was updated to include a new boolean property isPage. In the getPageOrBlockByApi function, the logic for collecting ancestor pages now filters the list to only include items where isPage is true, ensuring only actual pages are considered as ancestors. Additionally, the first ancestor’s parentId is set to ROOT_ID if it is not already, to prevent root ID absence issues. In the getPageAncestryFiles function, if no main page with panelName 'Main.vue' and index true exists, the first ancestry file is marked as the index main page.

Changes

Cohort / File(s) Change Summary
IPage interface and ancestor handling
packages/design-core/src/preview/src/preview/usePreviewData.ts
Added isPage: boolean to IPage interface; filtered ancestors by isPage in getPageOrBlockByApi; ensured first ancestor's parentId is ROOT_ID. Updated getPageAncestryFiles to guarantee a main index page exists.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

In the burrows of code where the data flows free,
A new flag called isPage hops in with glee.
Ancestors now filtered, only true pages remain,
Root set to the top, no confusion to gain.
And if no main page shines in the ancestry’s light,
The first takes the crown, making everything right.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc7698e and 5bc18a9.

📒 Files selected for processing (1)
  • packages/design-core/src/preview/src/preview/usePreviewData.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/design-core/src/preview/src/preview/usePreviewData.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: push-check
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

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 the bug Something isn't working label Jul 29, 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2359c09 and bc7698e.

📒 Files selected for processing (1)
  • packages/design-core/src/preview/src/preview/usePreviewData.ts (2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: gene9831
PR: opentiny/tiny-engine#1041
File: packages/plugins/datasource/src/DataSourceList.vue:138-138
Timestamp: 2025-01-14T10:06:25.508Z
Learning: PR #1041 in opentiny/tiny-engine is specifically for reverting Prettier v3 formatting to v2, without any logical code changes or syntax improvements.
Learnt from: rhlin
PR: opentiny/tiny-engine#1011
File: packages/canvas/render/src/RenderMain.ts:82-88
Timestamp: 2025-01-14T08:50:50.226Z
Learning: For PR #1011, the focus is on resolving conflicts and migrating code, with architectural improvements deferred for future PRs.
Learnt from: gene9831
PR: opentiny/tiny-engine#1011
File: packages/plugins/page/src/Tree.vue:80-101
Timestamp: 2025-01-14T06:42:57.361Z
Learning: The page tree structure in tiny-engine does not have deep nesting scenarios, so recursion depth protection is not required in tree traversal functions.
Learnt from: chilingling
PR: opentiny/tiny-engine#1440
File: packages/plugins/materials/src/composable/useResource.ts:82-84
Timestamp: 2025-05-28T03:58:31.212Z
Learning: In the TinyEngine codebase, there are two different data structures for page information:
1. App schema components tree (appSchemaState.pageTree) uses nested meta structure with page.meta?.id
2. API responses from pagePluginApi.getPageById() return flattened structure with pageInfo.id and pageInfo.occupier directly
The code should use page.meta?.id when working with pageTree data and pageInfo.id when working with API response data.
packages/design-core/src/preview/src/preview/usePreviewData.ts (4)

Learnt from: chilingling
PR: #1440
File: packages/plugins/materials/src/composable/useResource.ts:82-84
Timestamp: 2025-05-28T03:58:31.212Z
Learning: In the TinyEngine codebase, there are two different data structures for page information:

  1. App schema components tree (appSchemaState.pageTree) uses nested meta structure with page.meta?.id
  2. API responses from pagePluginApi.getPageById() return flattened structure with pageInfo.id and pageInfo.occupier directly
    The code should use page.meta?.id when working with pageTree data and pageInfo.id when working with API response data.

Learnt from: rhlin
PR: #1011
File: packages/canvas/render/src/page-block-function/methods.ts:9-21
Timestamp: 2025-01-14T06:59:23.602Z
Learning: The code in packages/canvas/render/src/page-block-function/methods.ts is migrated code that should not be modified during the migration phase. Error handling improvements can be addressed in future PRs.

Learnt from: gene9831
PR: #1069
File: packages/plugins/page/src/PageGeneral.vue:107-107
Timestamp: 2025-01-24T07:30:38.528Z
Learning: In PageGeneral.vue, pageParentId.value is only used to initialize the oldParentId ref. After initialization, oldParentId is kept in sync with pageSettingState.oldParentId through a watchEffect.

Learnt from: gene9831
PR: #1011
File: packages/plugins/page/src/PageGeneral.vue:166-178
Timestamp: 2025-01-14T06:40:18.223Z
Learning: The page structure data in PageGeneral.vue cannot have circular dependencies due to design constraints.

🔇 Additional comments (1)
packages/design-core/src/preview/src/preview/usePreviewData.ts (1)

80-80: Approve ancestor filtering in usePreviewData.ts – verify preview API isPage flag

The addition of

(await getPageRecursively(pageId))
  .reverse()
  .filter(item => item.isPage)

correctly preserves the root-to-current order while excluding non-page (folder) entries.

• getPageRecursively (lines 63–70) returns an array of IPage objects each carrying an isPage boolean.
• The pageId branch in usePreviewData.ts (around line 80) rightly applies this filter; the blockId branch is unaffected.

Please confirm with the preview service contract that any folder-type items returned will have isPage: false, ensuring this filter reliably removes them.

@chilingling chilingling added this to the v2.8.0 milestone Jul 29, 2025
@hexqi hexqi merged commit 3042171 into opentiny:develop Jul 30, 2025
2 checks passed
chilingling added a commit to chilingling/tiny-engine that referenced this pull request Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants