lux-lib 0.67.1

Library for the lux package manager for Lua
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

use bon::Builder;
use tracing::Instrument;

use crate::{
    build::{BuildBehaviour, BuildError, Deploy, RemotePackageSourceSpec},
    config::Config,
    hash::HasIntegrity,
    lockfile::{LockConstraint, LockedPackage, LockedPackageSpec, OptState, PinnedState},
    lua_installation::LuaInstallation,
    remote_package_source::RemotePackageSource,
    rockspec::{LuaVersionCompatibility, Rockspec},
    tree::{EntryType, InstallTree},
};

use super::materialise::fetch_and_hash_source;

/// A rocks package builder, providing fine-grained control
/// over how a local package should be built.
#[derive(Builder)]
#[builder(start_fn = new, finish_fn(name = _build, vis = ""))]
pub struct Build<'a, R: Rockspec + HasIntegrity, T: InstallTree> {
    rockspec: &'a R,
    tree: &'a T,
    entry_type: EntryType,
    config: &'a Config,
    lua: &'a LuaInstallation,

    #[builder(default)]
    pin: PinnedState,
    #[builder(default)]
    opt: OptState,
    #[builder(default)]
    constraint: LockConstraint,
    behaviour: BuildBehaviour,

    #[builder(setters(vis = "pub(crate)"))]
    source_spec: Option<RemotePackageSourceSpec>,

    // TODO(vhyrro): Remove this and enforce that this is provided at a type level.
    #[builder(setters(vis = "pub(crate)"))]
    source: Option<RemotePackageSource>,
}

impl<R: Rockspec + HasIntegrity, T: InstallTree + Sync, State> BuildBuilder<'_, R, T, State>
where
    State: build_builder::State + build_builder::IsComplete,
{
    pub async fn build(self) -> Result<LockedPackage, BuildError> {
        let build = self._build();
        let span = tracing::info_span!(
            "Building",
            package = build.rockspec.package().to_string(),
            version = build.rockspec.version().to_string(),
        );
        do_build(build).instrument(span).await
    }
}

#[tracing::instrument(level = "trace", skip_all)]
async fn do_build<R, T>(build: Build<'_, R, T>) -> Result<LockedPackage, BuildError>
where
    R: Rockspec + HasIntegrity,
    T: InstallTree + Sync,
{
    let rockspec = build.rockspec;
    let lua = build.lua;

    rockspec.validate_lua_version(&lua.version)?;

    let spec = LockedPackageSpec::new(
        rockspec.package(),
        rockspec.version(),
        build.constraint,
        Vec::new(),
        Vec::new(),
        &build.pin,
        &build.opt,
    );
    // Pin the futures otherwise they fill up the stack quite a bit
    let (package, temp_dir) = Box::pin(fetch_and_hash_source(
        rockspec,
        spec,
        build.source_spec,
        build.source,
        build.config,
    ))
    .await?;

    Box::pin(
        Deploy::new(rockspec, build.tree)
            .package(package)
            .lua(lua)
            .source_root(temp_dir.path())
            .entry_type(build.entry_type)
            .config(build.config)
            .behaviour(build.behaviour)
            .deploy(),
    )
    .await
}