Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 262 additions & 0 deletions packages/taro-cli/src/__tests__/create-page.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
import * as os from 'node:os'
import * as path from 'node:path'

import { babelKit, fs } from '@tarojs/helper'

import Page, { ConfigModificationState } from '../create/page'
import { modifyPagesOrSubPackages } from '../util/createPage'

// Config updates do not use the native template generator.
jest.mock('@tarojs/binding', () => ({
CompilerType: { Webpack5: 'webpack5' },
CSSType: { None: 'none' },
FrameworkType: { React: 'react' }
}))

function updateConfig (source: string, subPkgRootPath?: string) {
const ast = babelKit.parse(source, { sourceType: 'module' })!
const originalCode = babelKit.generate(ast, { compact: true }).code
const callback = jest.fn()
babelKit.traverse(ast, {
ExportDefaultDeclaration (path) {
modifyPagesOrSubPackages({
path,
fullPagePath: subPkgRootPath ? `${subPkgRootPath}/new/index` : 'pages/new/index',
subPkgRootPath,
callback
})
}
})
expect(callback).toHaveBeenCalledTimes(1)
return {
state: callback.mock.calls[0][0],
code: babelKit.generate(ast, { compact: true }).code,
originalCode
}
}

describe.each(['object', 'defineAppConfig'])('create page config: %s', (format) => {
const wrap = (config: string) => `export default ${format === 'object' ? config : `defineAppConfig(${config})`}`

it.each([
'pages: ["pages/home/index"]',
'"pages": ["pages/home/index"]',
'...baseConfig, pages: ["pages/home/index"]',
'...baseConfig, "pages": ["pages/home/index"]',
'get pages() { return [] }, "pages": ["pages/home/index"]',
'[pages]: [], "pages": ["pages/home/index"]'
])('appends to explicit pages: %s', (properties) => {
const result = updateConfig(wrap(`{ ${properties} }`))
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('["pages/home/index","pages/new/index"]')
if (properties.includes('...baseConfig')) expect(result.code).toContain('...baseConfig')
if (properties.includes('[pages]')) expect(result.code).toContain('[pages]:[]')
})

it.each(['pages', '"pages"'])('does not duplicate an existing page: %s', (key) => {
const result = updateConfig(wrap(`{ ${key}: ["pages/new/index"] }`))
expect(result.state).toBe(ConfigModificationState.NeedLess)
expect(result.code).toBe(result.originalCode)
})

it.each([
['"pages"', 'pages'],
['pages', '"pages"'],
['pages', 'pages'],
['"pages"', '"pages"']
])('updates the last pages property: %s followed by %s', (firstKey, lastKey) => {
const result = updateConfig(wrap(`{ ${firstKey}: ["ignored"], ${lastKey}: ["pages/home/index"] }`))
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain(`${firstKey}:["ignored"]`)
expect(result.code).toContain(`${lastKey}:["pages/home/index","pages/new/index"]`)
})

it('checks duplicates in the last pages property', () => {
const result = updateConfig(wrap('{ "pages": [], pages: ["pages/new/index"] }'))
expect(result.state).toBe(ConfigModificationState.NeedLess)
expect(result.code).toBe(result.originalCode)
})

it('leaves a nonliteral last pages property unchanged', () => {
const result = updateConfig(wrap('{ "pages": [], pages: pageList }'))
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})

it.each([
'{}',
'{ ...baseConfig }',
'{ pages: pageList }',
'{ [pages]: [] }',
'{ ["pages"]: [] }',
'{ pages() { return [] } }'
])('leaves unsupported pages config unchanged: %s', (config) => {
const result = updateConfig(wrap(config))
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})

it.each([
'subPackages: [{ root: "pkg/", pages: ["home/index"] }]',
'"subPackages": [{ "root": "pkg/", "pages": ["home/index"] }]',
'...baseConfig, "subPackages": [{ ...subConfig, "root": "pkg/", "pages": ["home/index"] }]',
'subPackages: [{ root() {}, root: "pkg/", pages() {}, pages: ["home/index"] }]'
])('updates an existing subpackage: %s', (properties) => {
const result = updateConfig(wrap(`{ ${properties} }`), 'pkg')
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('["home/index","new/index"]')
expect(result.code.match(/"pkg\/"/g)).toHaveLength(1)
})

it('does not duplicate a page in a quoted subpackage config', () => {
const result = updateConfig(wrap('{ "subPackages": [{ "root": "pkg/", "pages": ["new/index"] }] }'), 'pkg')
expect(result.state).toBe(ConfigModificationState.NeedLess)
expect(result.code).toBe(result.originalCode)
})

it.each([
'{ "subPackages": [{ root: "ignored/", pages: [] }], subPackages: [{ root: "pkg/", pages: ["home/index"] }] }',
'{ subPackages: [{ "root": "ignored/", root: "pkg/", pages: ["home/index"] }] }',
'{ subPackages: [{ root: "pkg/", "pages": ["ignored"], pages: ["home/index"] }] }'
])('updates the effective subpackage properties: %s', (config) => {
const result = updateConfig(wrap(config), 'pkg')
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('pages:["home/index","new/index"]')
expect(result.code).toContain('"ignored')
expect(result.code.match(/"pkg\/"/g)).toHaveLength(1)
})

it('matches the root property instead of an unrelated string value', () => {
const result = updateConfig(wrap('{ subPackages: [{ name: "pkg/", root: "other/", pages: [] }, { "root": "pkg/", "pages": ["home/index"] }] }'), 'pkg')
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('root:"other/",pages:[]')
expect(result.code).toContain('"root":"pkg/","pages":["home/index","new/index"]')
})

it('adds a missing subPackages property', () => {
const result = updateConfig(wrap('{ pages: [] }'), 'pkg')
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('subPackages:[{root:"pkg/",pages:["new/index"]}]')
})

it.each([
'pages() {}',
'get pages() { return [] }',
'set pages(value) {}',
'[key]: []',
'...baseConfig'
])('does not update pages shadowed by %s', (member) => {
const result = updateConfig(wrap(`{ pages: [], ${member} }`))
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})

it.each([
'subPackages() {}',
'get subPackages() { return [] }',
'set subPackages(value) {}',
'[key]: []',
'...baseConfig'
])('does not update or add subPackages shadowed by %s', (member) => {
for (const properties of [member, `subPackages: [], ${member}`]) {
const result = updateConfig(wrap(`{ ${properties} }`), 'pkg')
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
}
})

it.each([
'root() {}',
'get root() { return "pkg/" }',
'set root(value) {}',
'[key]: "pkg/"',
'...subConfig'
])('does not update or add a subpackage with root shadowed by %s', (member) => {
for (const properties of [`${member}, pages: []`, `root: "pkg/", ${member}, pages: []`]) {
const result = updateConfig(wrap(`{ subPackages: [{ ${properties} }] }`), 'pkg')
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
}
})

it.each([
'pages() {}',
'get pages() { return [] }',
'set pages(value) {}',
'[key]: []',
'...subConfig'
])('does not update subpackage pages shadowed by %s', (member) => {
const result = updateConfig(wrap(`{ subPackages: [{ root: "pkg/", pages: [], ${member} }] }`), 'pkg')
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})

it.each([
'{ pages() {}, pages: [] }',
'{ get pages() { return [] }, pages: [] }',
'{ set pages(value) {}, pages: [] }',
'{ [key]: [], pages: [] }',
'{ ...baseConfig, pages: [] }'
])('updates pages when an explicit array overrides earlier members: %s', (config) => {
const result = updateConfig(wrap(config))
expect(result.state).toBe(ConfigModificationState.Success)
expect(result.code).toContain('pages:["pages/new/index"]')
})

it('does not add a subpackage when an existing root is dynamic', () => {
const result = updateConfig(wrap('{ subPackages: [{ root: packageRoot, pages: [] }] }'), 'pkg')
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})

it.each([
'{ "subPackages": subPackages }',
'{ "subPackages": [{ "root": "pkg/", "pages": pageList }] }'
])('leaves nonliteral subpackage configs unchanged: %s', (config) => {
const result = updateConfig(wrap(config), 'pkg')
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
})
})

it.each(['defineAppConfig()', 'defineAppConfig(config)', 'defineAppConfig(null)'])(
'leaves a non-object config unchanged: %s', (config) => {
for (const subPkgRootPath of [undefined, 'pkg']) {
const result = updateConfig(`export default ${config}`, subPkgRootPath)
expect(result.state).toBe(ConfigModificationState.Fail)
expect(result.code).toBe(result.originalCode)
}
}
)

describe('create page config file updates', () => {
let projectDir: string

beforeEach(() => {
projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'taro-create-page-'))
jest.spyOn(console, 'log').mockImplementation(() => {})
})

afterEach(() => {
fs.removeSync(projectDir)
jest.restoreAllMocks()
})

it.each(['js', 'ts'])('writes the new page to app.config.%s', (extension) => {
const configPath = path.join(projectDir, 'src', `app.config.${extension}`)
const baseConfig = extension === 'ts' ? 'const baseConfig: { window?: object } = {}' : 'const baseConfig = {}'
fs.outputFileSync(configPath, `${baseConfig}\nexport default defineAppConfig({ ...baseConfig, "pages": ["pages/home/index"] })`)
const page = Object.create(Page.prototype)
page.conf = { projectDir, typescript: extension === 'ts' }
page.pageEntryPath = '/src/pages/new/index'

page.updateAppConfig()
const updated = fs.readFileSync(configPath, 'utf8')
expect(updated).toContain('pages/home/index')
expect(updated).toContain('pages/new/index')
expect(updated).toContain('...baseConfig')

page.updateAppConfig()
expect(fs.readFileSync(configPath, 'utf8')).toBe(updated)
})
})
41 changes: 32 additions & 9 deletions packages/taro-cli/src/util/createPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@ import { babelKit } from '@tarojs/helper'

import { ConfigModificationState, ModifyCallback } from '../create/page'

import type { ArrayExpression, ExportDefaultDeclaration, ObjectExpression, ObjectProperty } from '@babel/types'
import type { ArrayExpression, ExportDefaultDeclaration, Node, ObjectExpression, ObjectProperty } from '@babel/types'
import type { NodePath } from 'babel__traverse'

const t = babelKit.types

// undefined means absent; null means the effective property cannot be safely resolved.
const getObjectProperty = (node: Node | null | undefined, name: string): ObjectProperty | null | undefined => {
if (node?.type !== 'ObjectExpression') return null
for (let index = node.properties.length - 1; index >= 0; index--) {
const property = node.properties[index]
if (property.type === 'SpreadElement' || property.computed) return null
if (t.isIdentifier(property.key, { name }) || t.isStringLiteral(property.key, { value: name })) {
return property.type === 'ObjectProperty' ? property : null
}
}
}

const generateNewSubPackageItem = (subPackage: string) => {
const pageObject = t.objectProperty(t.identifier('pages'), t.arrayExpression([]))
const subPkgRootObject = t.objectProperty(t.identifier('root'), t.stringLiteral(subPackage))
Expand All @@ -15,16 +27,17 @@ const generateNewSubPackageItem = (subPackage: string) => {
}

const isValidSubPkgObject = (subPkgObject: ObjectExpression) => {
const properties = subPkgObject?.properties || {}
const rootProperty = properties.find((property: ObjectProperty) => (property.key as any)?.name === 'root') as ObjectProperty
const pagesProperty = properties.find((property: ObjectProperty) => (property.key as any)?.name === 'pages') as ObjectProperty
const rootProperty = getObjectProperty(subPkgObject, 'root')
const pagesProperty = getObjectProperty(subPkgObject, 'pages')
const rootPropertyValueType = rootProperty?.value?.type
const pagesPropertyValueType = pagesProperty?.value?.type
return rootPropertyValueType === 'StringLiteral' && pagesPropertyValueType === 'ArrayExpression'
}

const addNewSubPackage = (node: ObjectExpression, page: string, subPackage: string): ConfigModificationState => {
let subPackages = node?.properties.find(node => (node as any).key.name === 'subPackages') as ObjectProperty
if (!t.isObjectExpression(node)) return ConfigModificationState.Fail
let subPackages = getObjectProperty(node, 'subPackages')
if (subPackages === null) return ConfigModificationState.Fail
if (!subPackages) {
// config 文件不存在 subPackages 字段的情况,给该字段赋予默认值
const subPkgObject = t.objectProperty(t.identifier('subPackages'), t.arrayExpression([]))
Expand All @@ -35,7 +48,17 @@ const addNewSubPackage = (node: ObjectExpression, page: string, subPackage: stri

// 文件格式不对的情况
if (!value || value?.type !== 'ArrayExpression') return ConfigModificationState.Fail
let targetSubPkgObject: ObjectExpression = value.elements.find(node => (node as any)?.properties?.find(property => (property as any)?.value?.value === subPackage)) as ObjectExpression
let targetSubPkgObject: ObjectExpression | undefined
for (const element of value.elements) {
const rootProperty = getObjectProperty(element, 'root')
if (rootProperty === null) return ConfigModificationState.Fail

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

这里遇到一个无法确定 root 的分包配置时就直接返回了,后面的分包不会再继续检查。

比如:

subPackages: [
  { root: rootVar, pages: [] },
  { root: 'pkg/', pages: [] }
]

这时 pkg/ 其实是能确定的,应该可以正常添加页面,但现在会因为前面的 rootVar 直接失败。之前的逻辑会继续查找,不会受这个无关配置影响。

建议先继续检查后面的分包;如果找到了明确匹配的 root 就更新它。只有找不到匹配项、又存在无法判断的配置时,再返回失败。最好补一个对应的测试。

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

感谢指出,这里确实不应该在遇到无法确定 root 的分包项时直接结束查找。已在 f71dfca 中修改:

  • 遇到动态 root、getter、计算属性或展开项时,记录不确定状态并继续查找;找到明确匹配的 root 后,按现有校验更新该分包。
  • 只有未找到明确匹配项且存在不确定项时才返回 Fail,避免贸然新增分包;所有现有 root 均可确定且不匹配时,仍正常新增。
  • 保留同一对象内部的后置成员覆盖判断。

新增 22 个回归用例,覆盖普通对象和 defineAppConfig 两种形式、不确定项位于明确目标之前或之后、未匹配时拒绝新增,以及全部 root 已知时正常新增;同时检查其他配置保持原样。修复前该测试集 10 个失败、133 个通过,修复后 143 个全部通过。CLI 的 tsc 构建、修改文件 ESLint 和 git diff --check 均通过。本轮未重跑 CLI 全量测试。

烦请复查。

if (!rootProperty) continue
if (rootProperty.value.type !== 'StringLiteral') return ConfigModificationState.Fail
if (rootProperty.value.value === subPackage && element?.type === 'ObjectExpression') {
targetSubPkgObject = element
break
}
}

if (!targetSubPkgObject) {
// 不存在 当前分包配置对象的情况
Expand All @@ -44,8 +67,8 @@ const addNewSubPackage = (node: ObjectExpression, page: string, subPackage: stri
value.elements.push(subPkgItemObject)
}

if (targetSubPkgObject.type !== 'ObjectExpression' || !isValidSubPkgObject(targetSubPkgObject)) return ConfigModificationState.Fail
const pagesProperty: ObjectProperty = targetSubPkgObject.properties.find((property: ObjectProperty) => (property.key as any)?.name === 'pages') as ObjectProperty
if (!targetSubPkgObject || targetSubPkgObject.type !== 'ObjectExpression' || !isValidSubPkgObject(targetSubPkgObject)) return ConfigModificationState.Fail
const pagesProperty = getObjectProperty(targetSubPkgObject, 'pages')!
const currentPages = (pagesProperty.value as ArrayExpression).elements
const isPageExists = Boolean(currentPages.find(node => (node as any).value === page))

Expand All @@ -56,7 +79,7 @@ const addNewSubPackage = (node: ObjectExpression, page: string, subPackage: stri
}

const addNewPage = (node: ObjectExpression, page: string): ConfigModificationState => {
const pages = node?.properties.find(node => (node as any).key.name === 'pages') as ObjectProperty
const pages = getObjectProperty(node, 'pages')
if (!pages) return ConfigModificationState.Fail

const value = pages?.value
Expand Down
Loading