Skip to content
Merged
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
20 changes: 10 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/cli", "crates/diagnostics", "crates/project-resolver", "crates/ts-transform", "crates/bundler", "crates/template-compiler", "crates/npm-resolver", "crates/linker", "crates/watch", "crates/dev-server"]

[workspace.package]
version = "0.10.14"
version = "0.10.15"
edition = "2021"
license = "MIT OR Apache-2.0"
authors = ["lukekania"]
Expand Down
89 changes: 89 additions & 0 deletions crates/cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,16 @@ enum Commands {
/// (`*.localhost`, `app.local`).
#[arg(long = "allowed-hosts", value_delimiter = ',', num_args = 0..)]
allowed_hosts: Vec<String>,
/// Custom HTTP response headers to emit on every served response,
/// as a JSON object of header name → string value (e.g.
/// `--headers '{"Cross-Origin-Opener-Policy":"same-origin"}'`).
/// Mirrors the `headers` option of `@angular/build:dev-server`,
/// for serving production-like security headers (CSP, COOP),
/// CORS headers, or cache-control overrides in dev. Headers the
/// server sets itself (`Content-Type`, `Cache-Control`) are not
/// overridden by these.
#[arg(long = "headers")]
headers: Option<String>,
},
/// Extract translatable messages from every component template in the
/// project and emit a translation file (XLIFF 2.0 by default; XLIFF 1.2
Expand Down Expand Up @@ -300,6 +310,32 @@ enum ExtractFormat {
Arb,
}

/// Parse the `serve --headers` JSON object into ordered name/value pairs.
///
/// Accepts a JSON object whose values are all strings, e.g.
/// `{"Cross-Origin-Opener-Policy":"same-origin"}`. `None` (flag omitted)
/// yields an empty list. A non-object, malformed JSON, or a non-string
/// value is a hard error so a typo in `angular.json`'s `headers` surfaces
/// immediately rather than being silently dropped.
fn parse_header_overrides(raw: Option<&str>) -> Result<Vec<(String, String)>, String> {
let Some(raw) = raw else {
return Ok(Vec::new());
};
let value: serde_json::Value =
serde_json::from_str(raw).map_err(|e| format!("--headers is not valid JSON: {e}"))?;
let serde_json::Value::Object(map) = value else {
return Err("--headers must be a JSON object of header name to string value".to_string());
};
let mut out = Vec::with_capacity(map.len());
for (name, val) in map {
match val {
serde_json::Value::String(s) => out.push((name, s)),
_ => return Err(format!("--headers value for \"{name}\" must be a string")),
}
}
Ok(out)
}

fn main() {
init_tracing();
let cli = Cli::parse();
Expand Down Expand Up @@ -353,7 +389,15 @@ fn main() {
open,
serve_path,
allowed_hosts,
headers,
} => {
let parsed_headers = match parse_header_overrides(headers.as_deref()) {
Ok(h) => h,
Err(e) => {
eprintln!("{} {e}", "Error:".red().bold());
process::exit(1);
}
};
if let Err(e) = serve_cmd::run(
&project,
Some(&configuration),
Expand All @@ -362,6 +406,7 @@ fn main() {
open,
serve_path.as_deref(),
&allowed_hosts,
&parsed_headers,
) {
eprintln!("{} {e}", "Error:".red().bold());
process::exit(1);
Expand Down Expand Up @@ -3791,4 +3836,48 @@ mod tests {
"translated bundle must hash differently per locale"
);
}

#[test]
fn parse_header_overrides_none_yields_empty() {
assert_eq!(parse_header_overrides(None).unwrap(), Vec::new());
}

#[test]
fn parse_header_overrides_parses_a_json_object() {
let parsed = parse_header_overrides(Some(
r#"{"Cross-Origin-Opener-Policy":"same-origin","X-Frame-Options":"DENY"}"#,
))
.unwrap();
// serde_json's Map iterates keys in sorted order.
assert_eq!(
parsed,
vec![
(
"Cross-Origin-Opener-Policy".to_string(),
"same-origin".to_string()
),
("X-Frame-Options".to_string(), "DENY".to_string()),
]
);
}

#[test]
fn parse_header_overrides_rejects_malformed_json() {
assert!(parse_header_overrides(Some("{not json")).is_err());
}

#[test]
fn parse_header_overrides_rejects_non_object_json() {
let err = parse_header_overrides(Some(r#"["X-Foo"]"#)).unwrap_err();
assert!(err.contains("JSON object"), "got: {err}");
}

#[test]
fn parse_header_overrides_rejects_non_string_values() {
let err = parse_header_overrides(Some(r#"{"X-Foo":123}"#)).unwrap_err();
assert!(
err.contains("X-Foo") && err.contains("string"),
"got: {err}"
);
}
}
7 changes: 6 additions & 1 deletion crates/cli/src/serve_cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ use crate::watch_cmd::{is_ts_path, watch_root};

/// Run the `serve` subcommand: bring up the dev server, drive the watcher,
/// and block until Ctrl+C.
#[allow(clippy::too_many_arguments)]
pub fn run(
project: &Path,
configuration: Option<&str>,
Expand All @@ -35,6 +36,7 @@ pub fn run(
open: bool,
serve_path: Option<&str>,
allowed_hosts: &[String],
headers: &[(String, String)],
) -> NgcResult<()> {
run_with_stop(
project,
Expand All @@ -44,6 +46,7 @@ pub fn run(
open,
serve_path,
allowed_hosts,
headers,
install_ctrlc,
)
}
Expand All @@ -61,6 +64,7 @@ pub(crate) fn run_with_stop(
open: bool,
serve_path: Option<&str>,
allowed_hosts: &[String],
headers: &[(String, String)],
install_stop: impl FnOnce(Arc<AtomicBool>),
) -> NgcResult<()> {
let out_dir = crate::resolve_out_dir(project, None, configuration)?;
Expand Down Expand Up @@ -95,7 +99,8 @@ pub(crate) fn run_with_stop(
.with_host(host.to_string())
.with_port(port)
.with_serve_path(normalized_serve_path.as_deref())
.with_allowed_hosts(allowed_hosts.iter().cloned());
.with_allowed_hosts(allowed_hosts.iter().cloned())
.with_headers(headers.iter().cloned());
let server = DevServer::start(cfg, event_rx)?;
let url = match server.serve_path() {
Some(prefix) => format!("http://{}{}", server.addr(), prefix),
Expand Down
Loading