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

feat(copy): support advanced copy configuration with custom target paths #1711

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion crates/binding/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ pub struct BuildParams {
};
}
>;
copy?: string[];
copy?: (string | { from: string; to: string })[];
codeSplitting?:
| false
| {
Expand Down
9 changes: 8 additions & 1 deletion crates/mako/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,13 @@ pub enum Platform {
Node,
}

#[derive(Deserialize, Serialize, Debug)]
#[serde(untagged)]
pub enum CopyConfig {
Basic(String),
Advanced { from: String, to: String },
}

Comment on lines +126 to +132
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

CopyConfig添加配置验证

CopyConfig中的fromto字段直接来自用户配置,可能包含非法或不安全的路径。建议在配置解析时添加路径验证,确保路径不存在注入风险并且指向合法的位置。

#[derive(Deserialize, Serialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct Config {
Expand All @@ -137,7 +144,7 @@ pub struct Config {
pub devtool: Option<DevtoolConfig>,
pub externals: HashMap<String, ExternalConfig>,
pub providers: Providers,
pub copy: Vec<String>,
pub copy: Vec<CopyConfig>,
pub public_path: String,
pub inline_limit: usize,
pub inline_excludes_extensions: Vec<String>,
Expand Down
41 changes: 34 additions & 7 deletions crates/mako/src/plugins/copy.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use std::fs;
use std::path::Path;
use std::sync::Arc;

use anyhow::Result;
use anyhow::{anyhow, Result};
use fs_extra;
use glob::glob;
use notify::event::{CreateKind, DataChange, ModifyKind, RenameMode};
Expand All @@ -11,6 +12,7 @@ use tracing::debug;

use crate::ast::file::win_path;
use crate::compiler::Context;
use crate::config::CopyConfig;
use crate::plugin::Plugin;
use crate::stats::StatsJsonMap;
use crate::utils::tokio_runtime;
Expand All @@ -29,8 +31,12 @@ impl CopyPlugin {
notify::Config::default(),
)
.unwrap();
for src in context.config.copy.iter() {
let src = context.root.join(src);
for config in context.config.copy.iter() {
let src = match config {
CopyConfig::Basic(src) => context.root.join(src),
CopyConfig::Advanced { from, .. } => context.root.join(from),
};

Comment on lines +34 to +39
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

建议检查源路径是否存在

当前代码在处理src之前未检查其是否存在,可能会在源路径不存在时引发错误。建议在处理之前添加对src存在性的验证,并在不存在时进行适当的错误处理或日志记录。

示例修改:

for config in context.config.copy.iter() {
    let src = match config {
        CopyConfig::Basic(src) => context.root.join(src),
        CopyConfig::Advanced { from, .. } => context.root.join(from),
    };

+   if !src.exists() {
+       eprintln!("Source path {:?} does not exist", src);
+       continue;
+   }

    if src.exists() {
        debug!("watch {:?}", src);
        // ...
    }
}

Committable suggestion skipped: line range outside the PR's diff.

if src.exists() {
debug!("watch {:?}", src);
let mode = if src.is_dir() {
Expand Down Expand Up @@ -62,10 +68,31 @@ impl CopyPlugin {
fn copy(context: &Arc<Context>) -> Result<()> {
debug!("copy");
let dest = context.config.output.path.as_path();
for src in context.config.copy.iter() {
let src = context.root.join(src);
debug!("copy {:?} to {:?}", src, dest);
copy(src.as_path(), dest)?;
for config in context.config.copy.iter() {
match config {
CopyConfig::Basic(src) => {
let src = context.root.join(src);
debug!("copy {:?} to {:?}", src, dest);
copy(&src, dest)?;
}

CopyConfig::Advanced { from, to } => {
let src = context.root.join(from);
let target = dest.join(to.trim_start_matches("/"));

let dest_path = dest.to_path_buf();
if !target.starts_with(&dest_path) {
return Err(anyhow!("Invalid target path: {:?}", target));
}

if !target.exists() {
fs::create_dir_all(&target)?;
}

debug!("copy {:?} to {:?}", src, target);
copy(&src, &target)?;
}
}
}
Ok(())
}
Expand Down
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Specify the code splitting strategy. Use `auto` or `granular` strategy for SPA,

### copy

- Type: `string[]`
- Type: `(string | { from: string; to: string })[]`
- Default: `["public"]`

Specify the files or directories to be copied. By default, the files under the `public` directory will be copied to the output directory.
Expand Down
2 changes: 1 addition & 1 deletion docs/config.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@

### copy

- 类型:`string[]`
- 类型:`(string | { from: string; to: string })[]`
- 默认值:`["public"]`

指定需要复制的文件或目录。默认情况下,会将 `public` 目录下的文件复制到输出目录。
Expand Down
6 changes: 5 additions & 1 deletion e2e/fixtures/config.copy/expect.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@ const assert = require("assert");
const { parseBuildResult } = require("../../../scripts/test-utils");
const { files } = parseBuildResult(__dirname);

assert("foo.js" in files, "assets files not copy");
// Test original string pattern (copies to root)
assert("foo.js" in files, "assets files not copied (string pattern)");

// Test new from/to pattern (copies to assets-from-to directory)
assert("assets-from-to/foo.js" in files, "assets files not copied to correct location (from/to pattern)");
10 changes: 8 additions & 2 deletions e2e/fixtures/config.copy/mako.config.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
{
"copy": ["src/assets"]
}
"copy": [
"src/assets",
{
"from": "src/assets",
"to": "assets-from-to"
}
]
}
6 changes: 3 additions & 3 deletions packages/bundler-mako/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,13 @@ function checkConfig(opts) {
`umi config mako.${key} is not supported`,
);
});
// 暂不支持 { from, to } 格式
const { copy } = opts.config;
if (copy) {
for (const item of copy) {
assert(
typeof item === 'string',
`copy config item must be string in Mako bundler, but got ${item}`,
typeof item === 'string' ||
(typeof item === 'object' && item.from && item.to),
`copy config item must be string or { from: string, to: string } in Mako bundler, but got ${JSON.stringify(item)}`,
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/mako/binding.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export interface BuildParams {
};
}
>;
copy?: string[];
copy?: (string | { from: string; to: string })[];
codeSplitting?:
| false
| {
Expand Down