Skip to content

Commit

Permalink
Use a more descriptive User-Agent header in net.request (#186)
Browse files Browse the repository at this point in the history
  • Loading branch information
CompeyDev authored Apr 20, 2024
1 parent f830ce7 commit 66ed1a0
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/lune/builtins/net/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use super::serde::encode_decode::{EncodeDecodeConfig, EncodeDecodeFormat};

pub fn create(lua: &Lua) -> LuaResult<LuaTable> {
NetClientBuilder::new()
.headers(&[("User-Agent", create_user_agent_header())])?
.headers(&[("User-Agent", create_user_agent_header(lua)?)])?
.build()?
.into_registry(lua);
TableBuilder::new(lua)?
Expand Down
19 changes: 13 additions & 6 deletions src/lune/builtins/net/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,19 @@ use mlua::prelude::*;

use crate::lune::util::TableBuilder;

pub fn create_user_agent_header() -> String {
let (github_owner, github_repo) = env!("CARGO_PKG_REPOSITORY")
.trim_start_matches("https://github.com/")
.split_once('/')
.unwrap();
format!("{github_owner}-{github_repo}-cli")
pub fn create_user_agent_header(lua: &Lua) -> LuaResult<String> {
let version_global = lua
.globals()
.get::<_, LuaString>("_VERSION")
.expect("Missing _VERSION global");

let version_global_str = version_global
.to_str()
.context("Invalid utf8 found in _VERSION global")?;

let (package_name, full_version) = version_global_str.split_once(' ').unwrap();

Ok(format!("{}/{}", package_name.to_lowercase(), full_version))
}

pub fn header_map_to_table(
Expand Down
2 changes: 1 addition & 1 deletion src/lune/globals/version.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub fn create(lua: &Lua) -> LuaResult<impl IntoLua<'_>> {

// If this function runs more than once, we
// may get an already formatted lune version.
if luau_version_str.starts_with(&lune_version) {
if luau_version_str.starts_with(lune_version.as_str()) {
return Ok(luau_version_full);
}

Expand Down
9 changes: 9 additions & 0 deletions tests/net/request/user_agent.luau
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
local net = require("@lune/net")

local runtime, version = table.unpack(_VERSION:split(" "))
local expectedUserAgent = runtime:lower() .. "/" .. version

local userAgent: string =
net.jsonDecode(net.request("https://www.whatsmyua.info/api/v1/ua").body)[1].ua.rawUa

assert(userAgent == expectedUserAgent, "Expected user agent to be " .. expectedUserAgent)

0 comments on commit 66ed1a0

Please sign in to comment.