Implement a more robust way of locating rust-analyzer

When bundled, we will retrieve it out of the `Resources` folder.
Locally, we're expected to run `script/download-rust-analyzer` and
put `vendor/bin` in our $PATH.
This commit is contained in:
Antonio Scandurra 2021-10-25 11:02:35 +02:00
parent 715faaaceb
commit 59ed535cdf
13 changed files with 97 additions and 52 deletions

View file

@ -32,6 +32,11 @@ jobs:
with: with:
clean: false clean: false
- name: Download rust-analyzer
run: |
script/download-rust-analyzer
echo "$PWD/vendor/bin" >> $GITHUB_PATH
- name: Run tests - name: Run tests
run: cargo test --workspace --no-fail-fast run: cargo test --workspace --no-fail-fast
@ -63,6 +68,9 @@ jobs:
with: with:
clean: false clean: false
- name: Download rust-analyzer
run: script/download-rust-analyzer
- name: Create app bundle - name: Create app bundle
run: script/bundle run: script/bundle

1
.gitignore vendored
View file

@ -4,3 +4,4 @@
/script/node_modules /script/node_modules
/server/.env.toml /server/.env.toml
/server/static/styles.css /server/static/styles.css
/vendor/bin

View file

@ -53,6 +53,8 @@ pub trait Platform: Send + Sync {
fn set_cursor_style(&self, style: CursorStyle); fn set_cursor_style(&self, style: CursorStyle);
fn local_timezone(&self) -> UtcOffset; fn local_timezone(&self) -> UtcOffset;
fn path_for_resource(&self, name: Option<&str>, extension: Option<&str>) -> Result<PathBuf>;
} }
pub(crate) trait ForegroundPlatform { pub(crate) trait ForegroundPlatform {

View file

@ -14,7 +14,9 @@ use cocoa::{
NSPasteboardTypeString, NSSavePanel, NSWindow, NSPasteboardTypeString, NSSavePanel, NSWindow,
}, },
base::{id, nil, selector, YES}, base::{id, nil, selector, YES},
foundation::{NSArray, NSAutoreleasePool, NSData, NSInteger, NSString, NSURL}, foundation::{
NSArray, NSAutoreleasePool, NSBundle, NSData, NSInteger, NSString, NSUInteger, NSURL,
},
}; };
use core_foundation::{ use core_foundation::{
base::{CFType, CFTypeRef, OSStatus, TCFType as _}, base::{CFType, CFTypeRef, OSStatus, TCFType as _},
@ -45,6 +47,9 @@ use std::{
}; };
use time::UtcOffset; use time::UtcOffset;
#[allow(non_upper_case_globals)]
const NSUTF8StringEncoding: NSUInteger = 4;
const MAC_PLATFORM_IVAR: &'static str = "platform"; const MAC_PLATFORM_IVAR: &'static str = "platform";
static mut APP_CLASS: *const Class = ptr::null(); static mut APP_CLASS: *const Class = ptr::null();
static mut APP_DELEGATE_CLASS: *const Class = ptr::null(); static mut APP_DELEGATE_CLASS: *const Class = ptr::null();
@ -588,6 +593,27 @@ impl platform::Platform for MacPlatform {
UtcOffset::from_whole_seconds(seconds_from_gmt.try_into().unwrap()).unwrap() UtcOffset::from_whole_seconds(seconds_from_gmt.try_into().unwrap()).unwrap()
} }
} }
fn path_for_resource(&self, name: Option<&str>, extension: Option<&str>) -> Result<PathBuf> {
unsafe {
let bundle: id = NSBundle::mainBundle();
if bundle.is_null() {
Err(anyhow!("app is not running inside a bundle"))
} else {
let name = name.map_or(nil, |name| ns_string(name));
let extension = extension.map_or(nil, |extension| ns_string(extension));
let path: id = msg_send![bundle, pathForResource: name ofType: extension];
if path.is_null() {
Err(anyhow!("resource could not be found"))
} else {
let len = msg_send![path, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
let bytes = path.UTF8String() as *const u8;
let path = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
Ok(PathBuf::from(path))
}
}
}
}
} }
unsafe fn get_foreground_platform(object: &mut Object) -> &MacForegroundPlatform { unsafe fn get_foreground_platform(object: &mut Object) -> &MacForegroundPlatform {

View file

@ -1,6 +1,6 @@
use super::CursorStyle; use super::CursorStyle;
use crate::{AnyAction, ClipboardItem}; use crate::{AnyAction, ClipboardItem};
use anyhow::Result; use anyhow::{anyhow, Result};
use parking_lot::Mutex; use parking_lot::Mutex;
use pathfinder_geometry::vector::Vector2F; use pathfinder_geometry::vector::Vector2F;
use std::{ use std::{
@ -148,6 +148,10 @@ impl super::Platform for Platform {
fn local_timezone(&self) -> UtcOffset { fn local_timezone(&self) -> UtcOffset {
UtcOffset::UTC UtcOffset::UTC
} }
fn path_for_resource(&self, _name: Option<&str>, _extension: Option<&str>) -> Result<PathBuf> {
Err(anyhow!("app not running inside a bundle"))
}
} }
impl Window { impl Window {

View file

@ -13,3 +13,6 @@ parking_lot = "0.11"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
serde_json = { version = "1.0", features = ["raw_value"] } serde_json = { version = "1.0", features = ["raw_value"] }
smol = "1.2" smol = "1.2"
[dev-dependencies]
gpui = { path = "../gpui", features = ["test-support"] }

View file

@ -1,36 +1,10 @@
use std::{ use std::env;
env,
fs::{self, Permissions},
os::unix::prelude::PermissionsExt,
process::Command,
};
fn main() { fn main() {
let target = env::var("TARGET").unwrap(); let target = env::var("TARGET").unwrap();
let rust_analyzer_filename = format!("rust-analyzer-{}", target); println!("cargo:rustc-env=TARGET={}", target);
let rust_analyzer_url = format!(
"https://github.com/rust-analyzer/rust-analyzer/releases/download/2021-10-18/{}.gz",
rust_analyzer_filename
);
println!(
"cargo:rustc-env=RUST_ANALYZER_FILENAME={}",
rust_analyzer_filename
);
let target_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); if let Ok(bundled) = env::var("BUNDLE") {
let rust_analyzer_target_path = format!("{}/{}", target_dir, rust_analyzer_filename); println!("cargo:rustc-env=BUNDLE={}", bundled);
assert!( }
Command::new("/bin/sh")
.arg("-c")
.arg(format!(
"curl -L {} | gunzip > {}",
rust_analyzer_url, rust_analyzer_target_path
))
.status()
.unwrap()
.success(),
"failed to download rust-analyzer"
);
fs::set_permissions(rust_analyzer_target_path, Permissions::from_mode(0x755))
.expect("failed to make rust-analyzer executable");
} }

View file

@ -1,5 +1,5 @@
use anyhow::{anyhow, Context, Result}; use anyhow::{anyhow, Context, Result};
use gpui::{executor, Task}; use gpui::{executor, AppContext, Task};
use parking_lot::Mutex; use parking_lot::Mutex;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use serde_json::value::RawValue; use serde_json::value::RawValue;
@ -71,6 +71,21 @@ struct Error {
} }
impl LanguageServer { impl LanguageServer {
pub fn rust(cx: &AppContext) -> Result<Arc<Self>> {
const BUNDLE: Option<&'static str> = option_env!("BUNDLE");
const TARGET: &'static str = env!("TARGET");
let rust_analyzer_name = format!("rust-analyzer-{}", TARGET);
if BUNDLE.map_or(Ok(false), |b| b.parse())? {
let rust_analyzer_path = cx
.platform()
.path_for_resource(Some(&rust_analyzer_name), None)?;
Self::new(&rust_analyzer_path, cx.background())
} else {
Self::new(Path::new(&rust_analyzer_name), cx.background())
}
}
pub fn new(path: &Path, background: &executor::Background) -> Result<Arc<Self>> { pub fn new(path: &Path, background: &executor::Background) -> Result<Arc<Self>> {
let mut server = Command::new(path) let mut server = Command::new(path)
.stdin(Stdio::piped()) .stdin(Stdio::piped())
@ -143,12 +158,7 @@ impl LanguageServer {
_input_task, _input_task,
_output_task, _output_task,
}); });
let init = this.clone().init(); background.spawn(this.clone().init().log_err()).detach();
background
.spawn(async move {
init.log_err().await;
})
.detach();
Ok(this) Ok(this)
} }
@ -229,6 +239,6 @@ mod tests {
#[gpui::test] #[gpui::test]
async fn test_basic(cx: TestAppContext) { async fn test_basic(cx: TestAppContext) {
let server = LanguageServer::new(); let server = cx.read(|cx| LanguageServer::rust(cx).unwrap());
} }
} }

View file

@ -49,7 +49,7 @@ impl Project {
languages: Arc<LanguageRegistry>, languages: Arc<LanguageRegistry>,
rpc: Arc<Client>, rpc: Arc<Client>,
fs: Arc<dyn Fs>, fs: Arc<dyn Fs>,
background: &executor::Background, cx: &AppContext,
) -> Self { ) -> Self {
Self { Self {
worktrees: Default::default(), worktrees: Default::default(),
@ -57,11 +57,7 @@ impl Project {
languages, languages,
client: rpc, client: rpc,
fs, fs,
language_server: LanguageServer::new( language_server: LanguageServer::rust(cx).unwrap(),
Path::new("/Users/as-cii/Downloads/rust-analyzer-x86_64-apple-darwin"),
background,
)
.unwrap(),
} }
} }
@ -420,6 +416,6 @@ mod tests {
let languages = Arc::new(LanguageRegistry::new()); let languages = Arc::new(LanguageRegistry::new());
let fs = Arc::new(RealFs); let fs = Arc::new(RealFs);
let rpc = client::Client::new(); let rpc = client::Client::new();
cx.add_model(|cx| Project::new(languages, rpc, fs, cx.background())) cx.add_model(|cx| Project::new(languages, rpc, fs, cx))
} }
} }

View file

@ -622,7 +622,7 @@ mod tests {
params.languages.clone(), params.languages.clone(),
params.client.clone(), params.client.clone(),
params.fs.clone(), params.fs.clone(),
cx.background(), cx,
) )
}); });
let root1 = project let root1 = project

View file

@ -327,7 +327,7 @@ impl Workspace {
params.languages.clone(), params.languages.clone(),
params.client.clone(), params.client.clone(),
params.fs.clone(), params.fs.clone(),
cx.background(), cx,
) )
}); });
cx.observe(&project, |_, _, cx| cx.notify()).detach(); cx.observe(&project, |_, _, cx| cx.notify()).detach();

View file

@ -2,6 +2,8 @@
set -e set -e
export BUNDLE=true
# Install cargo-bundle 0.5.0 if it's not already installed # Install cargo-bundle 0.5.0 if it's not already installed
cargo install cargo-bundle --version 0.5.0 cargo install cargo-bundle --version 0.5.0
@ -11,10 +13,14 @@ cargo bundle --release --target x86_64-apple-darwin
popd > /dev/null popd > /dev/null
# Build the binary for aarch64 (Apple M1) # Build the binary for aarch64 (Apple M1)
cargo build --release --target aarch64-apple-darwin # cargo build --release --target aarch64-apple-darwin
# Replace the bundle's binary with a "fat binary" that combines the two architecture-specific binaries # Replace the bundle's binary with a "fat binary" that combines the two architecture-specific binaries
lipo -create target/x86_64-apple-darwin/release/Zed target/aarch64-apple-darwin/release/Zed -output target/x86_64-apple-darwin/release/bundle/osx/Zed.app/Contents/MacOS/zed # lipo -create target/x86_64-apple-darwin/release/Zed target/aarch64-apple-darwin/release/Zed -output target/x86_64-apple-darwin/release/bundle/osx/Zed.app/Contents/MacOS/zed
# Bundle rust-analyzer
cp vendor/bin/rust-analyzer-x86_64-apple-darwin target/x86_64-apple-darwin/release/bundle/osx/Zed.app/Contents/Resources/
cp vendor/bin/rust-analyzer-aarch64-apple-darwin target/x86_64-apple-darwin/release/bundle/osx/Zed.app/Contents/Resources/
# Sign the app bundle with an ad-hoc signature so it runs on the M1. We need a real certificate but this works for now. # Sign the app bundle with an ad-hoc signature so it runs on the M1. We need a real certificate but this works for now.
if [[ -n $MACOS_CERTIFICATE && -n $MACOS_CERTIFICATE_PASSWORD && -n $APPLE_NOTARIZATION_USERNAME && -n $APPLE_NOTARIZATION_PASSWORD ]]; then if [[ -n $MACOS_CERTIFICATE && -n $MACOS_CERTIFICATE_PASSWORD && -n $APPLE_NOTARIZATION_USERNAME && -n $APPLE_NOTARIZATION_PASSWORD ]]; then

15
script/download-rust-analyzer Executable file
View file

@ -0,0 +1,15 @@
#!/bin/bash
set -e
export RUST_ANALYZER_URL="https://github.com/rust-analyzer/rust-analyzer/releases/download/2021-10-18/"
function download {
local filename="rust-analyzer-$1"
curl -L $RUST_ANALYZER_URL/$filename.gz | gunzip > vendor/bin/$filename
chmod +x vendor/bin/$filename
}
mkdir -p vendor/bin
download "x86_64-apple-darwin"
download "aarch64-apple-darwin"