fix: Block Preview Error by 1degrees · Pull Request #1343 · opentiny/tiny-engine

1degrees · 2025-04-27T11:35:45Z

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?

Background and solution

What is the current behavior?

Issue Number: #1342

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

Summary by CodeRabbit

Bug Fixes
- Improved reliability when fetching page ancestors, ensuring the feature works correctly even if ancestor data is missing.
- Enhanced block generation in preview mode by preventing errors when ancestor information is not provided.

coderabbitai · 2025-04-27T11:35:51Z

Walkthrough

This update introduces defensive programming improvements to two functions in separate modules. In the canvas rendering module, the getPageAncestors function now ensures it always operates on an array by defaulting to an empty array if the underlying controller returns a falsy value. In the design preview module, the genAllBlocks function is updated to provide a default empty array for its ancestors parameter, preventing errors when called without arguments. Additionally, a function signature formatting change was made in the page plugin module to improve readability without affecting functionality. No public API changes or signature modifications are made except for the addition of the default parameter value.

Changes

File(s)	Change Summary
packages/canvas/render/src/material-function/page-getter.ts	Updated `getPageAncestors` to default to an empty array if the controller returns a falsy value.
packages/design-core/src/preview/src/preview/Preview.vue	Updated `genAllBlocks` to use a default empty array for the `ancestors` parameter.
packages/plugins/page/src/composable/usePage.ts	Reformatted `updatePageContent` function parameters from single-line to multi-line for readability.

Poem

A bunny hopped through lines of code,
With arrays in paw, a safe new mode.
No more errors when things are null,
Now defaults keep the logic full.
Hopping forward, bugs at bay—
Defensive code saves the day! 🐇✨

📜 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 3bb81a5 and 6270321.

📒 Files selected for processing (1)

packages/plugins/page/src/composable/usePage.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

packages/plugins/page/src/composable/usePage.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: push-check

✨ Finishing Touches

📝 Generate Docstrings

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.
- 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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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.

chilingling · 2025-04-28T01:09:38Z

packages/design-core/src/preview/src/preview/Preview.vue

+import { defineComponent, computed, defineAsyncComponent } from 'vue'
 import { Repl, ReplStore } from '@vue/repl'
-import { getMergeMeta } from '@opentiny/tiny-engine-meta-register'
+import vueJsx from '@vue/babel-plugin-jsx'
+import { transformSync } from '@babel/core'
+import { getMetaApi } from '@opentiny/tiny-engine-meta-register'
+import { getImportMap as getInitImportMap } from './importMap'
+import srcFiles from './srcFiles'
+import generateMetaFiles, { processAppJsCode } from './generate'
+import { getSearchParams, fetchMetaData, fetchImportMap, fetchAppSchema, fetchBlockSchema } from './http'
+import { PanelType, PreviewTips } from '../constant'


冲突可能解决的有点问题：

在 #1261 中，我这边合入了 preview 的新特性，将处理预览出码相关的放置到了：

tiny-engine/packages/design-core/src/preview/src/preview/usePreviewData.ts

Lines 329 to 383 in b87d90c

const updatePreview = async (params: { currentPage: IPage; ancestors: IPage[] }) => {

const { appData, metaData, importMapData } = await getBasicData(basicFiles)

previewState.currentPage = params.currentPage

previewState.ancestors = params.ancestors

// importMap 发生变化才更新 importMap

if (JSON.stringify(previewState.importMap) !== JSON.stringify(importMapData)) {

store.setImportMap(importMapData)

previewState.importMap = importMapData

}

const blockSet = new Set()

let blocks = []

const { getAllNestedBlocksSchema, generatePageCode } = getMetaApi('engine.service.generateCode')

if (params.ancestors?.length) {

const promises = params.ancestors.map((item) =>

getAllNestedBlocksSchema(item.page_content, fetchBlockSchema, blockSet)

)

blocks = (await Promise.all(promises)).flat()

}

const currentPageBlocks = await getAllNestedBlocksSchema(

params.currentPage?.page_content || {},

fetchBlockSchema,

blockSet

)

blocks = blocks.concat(currentPageBlocks)

const pageCode = [

...getPageAncestryFiles(appData, params),

...(blocks || []).map((blockSchema) => {

return {

panelName: `${blockSchema.fileName}.vue`,

panelValue: generatePageCode(blockSchema, appData?.componentsMap || [], { blockRelativePath: './' }) || '',

panelType: 'vue'

}

})

]

const newFiles = store.getFiles()

const searchParams = new URLSearchParams(location.search)

const appJsCode = processAppJsCode(newFiles['app.js'], JSON.parse(searchParams.get('styles') || '[]'))

newFiles['app.js'] = appJsCode

pageCode.map(fixScriptLang).forEach((item) => assignFiles(item, newFiles))

const metaFiles = generateMetaFiles(metaData)

Object.assign(newFiles, metaFiles)

setFiles(newFiles)

}

可以验证下有没有解决预览侧的问题
（可能重新拉个分支更快，你变更的代码不会很多）

fix: Block Preview Error

3bb81a5

github-actions bot added the bug Something isn't working label Apr 27, 2025

chilingling previously approved these changes Apr 27, 2025

View reviewed changes

Merge branch 'develop' into fix-BlockPreviewBug

6270321

1degrees dismissed chilingling’s stale review via 6270321 April 28, 2025 01:02

chilingling reviewed Apr 28, 2025

View reviewed changes

1degrees closed this Apr 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Block Preview Error#1343

fix: Block Preview Error#1343
1degrees wants to merge 2 commits intoopentiny:developfrom
1degrees:fix-BlockPreviewBug

1degrees commented Apr 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 27, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

chilingling Apr 28, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	const updatePreview = async (params: { currentPage: IPage; ancestors: IPage[] }) => {
	const { appData, metaData, importMapData } = await getBasicData(basicFiles)

	previewState.currentPage = params.currentPage
	previewState.ancestors = params.ancestors

	// importMap 发生变化才更新 importMap
	if (JSON.stringify(previewState.importMap) !== JSON.stringify(importMapData)) {
	store.setImportMap(importMapData)
	previewState.importMap = importMapData
	}

	const blockSet = new Set()

	let blocks = []
	const { getAllNestedBlocksSchema, generatePageCode } = getMetaApi('engine.service.generateCode')

	if (params.ancestors?.length) {
	const promises = params.ancestors.map((item) =>
	getAllNestedBlocksSchema(item.page_content, fetchBlockSchema, blockSet)
	)
	blocks = (await Promise.all(promises)).flat()
	}

	const currentPageBlocks = await getAllNestedBlocksSchema(
	params.currentPage?.page_content \|\| {},
	fetchBlockSchema,
	blockSet
	)
	blocks = blocks.concat(currentPageBlocks)

	const pageCode = [
	...getPageAncestryFiles(appData, params),
	...(blocks \|\| []).map((blockSchema) => {
	return {
	panelName: `${blockSchema.fileName}.vue`,
	panelValue: generatePageCode(blockSchema, appData?.componentsMap \|\| [], { blockRelativePath: './' }) \|\| '',
	panelType: 'vue'
	}
	})
	]

	const newFiles = store.getFiles()
	const searchParams = new URLSearchParams(location.search)
	const appJsCode = processAppJsCode(newFiles['app.js'], JSON.parse(searchParams.get('styles') \|\| '[]'))

	newFiles['app.js'] = appJsCode

	pageCode.map(fixScriptLang).forEach((item) => assignFiles(item, newFiles))

	const metaFiles = generateMetaFiles(metaData)
	Object.assign(newFiles, metaFiles)

	setFiles(newFiles)
	}

Conversation

1degrees commented Apr 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR

PR Checklist

PR Type

Background and solution

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

chilingling Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

1degrees commented Apr 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

chilingling Apr 28, 2025 •

edited

Loading