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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
use crate::lockfile::package::PackageColumns as _;
use bun_collections::HashMap;
use bun_core::Output;
use crate::DependencyID;
use crate::ManifestLoad;
use crate::NetworkTask;
use crate::PackageID;
use crate::Resolution;
use crate::invalid_package_id;
// `Task::Id` is a namespaced type in Zig (`PackageManagerTask.Id`); import the
// *module* under the `Task` name so `Task::Id` resolves as a path (matches
// `runTasks.rs` / `PackageManagerEnqueue.rs`).
use super::PackageManager;
use super::enqueue;
use super::run_tasks::{self, RunTasksCallbacks};
use crate::package_manager_task as Task;
use crate::resolution::Tag as ResolutionTag;
#[derive(thiserror::Error, strum::IntoStaticStr, Debug)]
pub(crate) enum StartManifestTaskError {
#[error("OutOfMemory")]
OutOfMemory,
#[error("InvalidURL")]
InvalidURL,
}
bun_core::oom_from_alloc!(StartManifestTaskError);
impl From<crate::network_task::ForManifestError> for StartManifestTaskError {
fn from(e: crate::network_task::ForManifestError) -> Self {
match e {
crate::network_task::ForManifestError::OutOfMemory => Self::OutOfMemory,
crate::network_task::ForManifestError::InvalidURL => Self::InvalidURL,
}
}
}
impl From<StartManifestTaskError> for bun_core::Error {
fn from(e: StartManifestTaskError) -> Self {
match e {
StartManifestTaskError::OutOfMemory => bun_core::err!(OutOfMemory),
StartManifestTaskError::InvalidURL => bun_core::err!(InvalidURL),
}
}
}
/// `is_required`: a failed fetch is logged as an error rather than a warning.
fn start_manifest_task(
manager: &mut PackageManager,
pkg_name: &[u8],
is_required: bool,
needs_extended_manifest: bool,
) -> Result<(), StartManifestTaskError> {
let task_id = Task::Id::for_manifest(pkg_name);
if run_tasks::has_created_network_task(manager, task_id, !is_required) {
return Ok(());
}
manager.start_progress_bar_if_none();
// PORT NOTE: reshaped for borrowck — Zig writes the whole struct via `.* = .{}`
// and reads `manager` again for `scopeForPackageName`. `get_network_task()`
// borrows `&mut manager.preallocated_network_tasks`, so compute everything
// that needs `&manager` *before* taking that borrow, then populate the pool
// slot through a raw pointer (matches `runTasks::generate_network_task_for_tarball`).
let scope = bun_ptr::BackRef::new(manager.scope_for_package_name(pkg_name));
// Backref address only — stored, not dereffed in this function.
// TODO(port): lifetime — BACKREF.
let manager_backref: *mut PackageManager = manager;
// Take the pool slot as a raw pointer so borrowck releases `manager` for the
// `enqueue_network_task` tail.
let net_ptr: *mut NetworkTask = run_tasks::get_network_task(manager);
// Zig: `task.* = .{ .package_manager = manager, .callback = undefined,
// .task_id = task_id, .allocator = manager.allocator };`
// — full struct overwrite that resets every other field to its struct
// default. The slot may be uninitialized (heap fallback) or stale (reused
// hive slot).
// SAFETY: `net_ptr` is the unique handle to a freshly-vended pool slot; no
// other alias exists until we hand it to `enqueue_network_task`.
unsafe { NetworkTask::write_init(net_ptr, task_id, manager_backref, None) };
// SAFETY: `write_init` populated every field with a drop-safe value;
// `unsafe_http_client` is `MaybeUninit` and overwritten by `for_manifest`.
let task = unsafe { &mut *net_ptr };
// `scope` points into `manager.options` which is not mutated by
// `for_manifest` (it only writes the pool slot and `manager.log`).
task.for_manifest(
pkg_name,
scope.get(),
None,
!is_required,
needs_extended_manifest,
)?;
enqueue::enqueue_network_task(manager, net_ptr);
Ok(())
}
#[derive(Clone, Copy)]
pub enum Packages<'a> {
All,
Ids(&'a [PackageID]),
}
/// `RunTasksCallbacks` impl for the void-callback `runTasks` call in
/// `populateManifestCache` (Zig passed an anonymous struct with `void` hooks).
struct ManifestsOnlyCallbacks;
impl RunTasksCallbacks for ManifestsOnlyCallbacks {
type Ctx = ();
const PROGRESS_BAR: bool = true;
const MANIFESTS_ONLY: bool = true;
}
/// Populate the manifest cache for packages included from `root_pkg_ids`. Only manifests of
/// direct dependencies of the `root_pkg_ids` are populated. If `root_pkg_ids` has length 0
/// all packages in the lockfile will have their manifests fetched if necessary.
pub fn populate_manifest_cache(
manager: &mut PackageManager,
packages: Packages<'_>,
) -> Result<(), bun_core::Error> {
// TODO(port): narrow error set
let log_level = manager.options.log_level;
// PORT NOTE: heavy borrowck overlap — Zig holds slices into
// `manager.lockfile` while the loop body calls `&mut`-taking methods on
// `manager`. The lockfile lives in `Box<Lockfile>` (stable address) and is
// not resized by anything below, so derive the slices through a raw
// provenance root and reborrow `manager` per-call.
let cache_ctx = manager.manifest_disk_cache_ctx();
let manager_ptr: *mut PackageManager = manager;
// BACKREF wrapper over the same provenance root for the read-only
// `options` projections in the loop body — collapses four per-site raw
// `(*manager_ptr).options` derefs into safe `Deref` through
// `ParentRef::get()`. Mutation (`manifests`, whole-`&mut PackageManager`)
// still goes through `manager_ptr` directly. Safe `From<NonNull>`
// construction — `manager_ptr` was just derived from `&mut *manager`.
let mgr_ref = bun_ptr::ParentRef::<PackageManager>::from(
core::ptr::NonNull::new(manager_ptr).expect("derived from &mut, non-null"),
);
// SAFETY: `manager_ptr` is the live exclusive borrow's address; we only
// take *shared* projections of `lockfile` here, and the loop body never
// mutates `lockfile.buffers` / `lockfile.packages`.
let lockfile = unsafe { &*core::ptr::addr_of!((*manager_ptr).lockfile) };
let resolutions = lockfile.buffers.resolutions.as_slice();
let dependencies = lockfile.buffers.dependencies.as_slice();
let string_buf = lockfile.buffers.string_bytes.as_slice();
let pkgs = lockfile.packages.slice();
let pkg_resolutions = pkgs.items_resolution();
let pkg_names = pkgs.items_name();
let pkg_dependencies = pkgs.items_dependencies();
match packages {
Packages::All => {
let mut seen_pkg_ids: HashMap<PackageID, ()> = HashMap::new();
for _dep_id in 0..dependencies.len() {
let dep_id: DependencyID = DependencyID::try_from(_dep_id).expect("int cast");
let pkg_id = resolutions[dep_id as usize];
if pkg_id == invalid_package_id {
continue;
}
// `getOrPut(pkg_id).found_existing` — value is `void`, so this is a set insert.
if seen_pkg_ids.insert(pkg_id, ()).is_some() {
continue;
}
let res = &pkg_resolutions[pkg_id as usize];
if res.tag != ResolutionTag::Npm {
continue;
}
let pkg_name = pkg_names[pkg_id as usize];
let pkg_name_slice = pkg_name.slice(string_buf);
// `options` is not mutated between here and the
// `start_manifest_task` call — read via the BACKREF `mgr_ref`.
let needs_extended_manifest = mgr_ref.options.minimum_release_age_ms.is_some();
// `scope_for_package_name` borrows only `options` (via the
// BACKREF `mgr_ref`); `manifests` is a disjoint field projected
// from the same raw provenance root. `by_name`'s `pm`-derived
// reads are hoisted into the by-value `cache_ctx`, so the call
// holds only `&mut manifests`.
let scope =
bun_ptr::BackRef::new(mgr_ref.options.scope_for_package_name(pkg_name_slice));
// SAFETY: `manifests` is disjoint from `options`/`lockfile`;
// `manager_ptr` is the SRW root.
let cached = unsafe { &mut (*manager_ptr).manifests }.by_name(
cache_ctx,
scope.get(),
pkg_name_slice,
ManifestLoad::LoadFromMemoryFallbackToDisk,
needs_extended_manifest,
);
if cached.is_none() {
start_manifest_task(
// SAFETY: `manager_ptr` is the SRW provenance root;
// `start_manifest_task` only touches the network-task
// pool / progress bar / log, never `lockfile.buffers`
// or `lockfile.packages`, so the outstanding shared
// slice (`pkg_name_slice`) stays valid.
unsafe { &mut *manager_ptr },
pkg_name_slice,
false,
needs_extended_manifest,
)?;
}
// SAFETY: SRW root; network-queue flush does not mutate `lockfile`.
run_tasks::flush_network_queue(unsafe { &mut *manager_ptr });
// SAFETY: SRW root; task scheduler does not mutate `lockfile`.
let _ = run_tasks::schedule_tasks(unsafe { &mut *manager_ptr });
}
}
Packages::Ids(ids) => {
for &root_pkg_id in ids {
let pkg_deps = pkg_dependencies[root_pkg_id as usize];
for dep_id in pkg_deps.begin()..pkg_deps.end() {
let dep_id = dep_id as usize;
if dep_id >= dependencies.len() {
continue;
}
let pkg_id = resolutions[dep_id];
if pkg_id == invalid_package_id {
continue;
}
let dep = &dependencies[dep_id];
let resolution: &Resolution = &pkg_resolutions[pkg_id as usize];
if resolution.tag != ResolutionTag::Npm {
continue;
}
// `options` read via BACKREF `mgr_ref` — see provenance-root
// note above.
let needs_extended_manifest = mgr_ref.options.minimum_release_age_ms.is_some();
let package_name = pkg_names[pkg_id as usize].slice(string_buf);
// See disjoint-field note on the `.All` arm above.
let scope =
bun_ptr::BackRef::new(mgr_ref.options.scope_for_package_name(package_name));
// SAFETY: `manifests` is disjoint from `options`/`lockfile`;
// `manager_ptr` is the SRW root.
let cached = unsafe { &mut (*manager_ptr).manifests }.by_name(
cache_ctx,
scope.get(),
package_name,
ManifestLoad::LoadFromMemoryFallbackToDisk,
needs_extended_manifest,
);
if cached.is_none() {
start_manifest_task(
// SAFETY: `manager_ptr` is the SRW provenance
// root; `start_manifest_task` only touches the
// network-task pool / progress bar / log, never
// `lockfile.buffers` or `lockfile.packages`, so
// `package_name` stays valid.
unsafe { &mut *manager_ptr },
package_name,
dep.behavior.is_required(),
needs_extended_manifest,
)?;
// SAFETY: SRW root; network-queue flush does not mutate `lockfile`.
run_tasks::flush_network_queue(unsafe { &mut *manager_ptr });
// SAFETY: SRW root; task scheduler does not mutate `lockfile`.
let _ = run_tasks::schedule_tasks(unsafe { &mut *manager_ptr });
}
}
}
}
}
// SAFETY: provenance root; no live shared borrows of `*manager_ptr` remain.
let manager = unsafe { &mut *manager_ptr };
run_tasks::flush_network_queue(manager);
let _ = run_tasks::schedule_tasks(manager);
if run_tasks::pending_task_count(manager) > 0 {
struct RunClosure {
// PORT NOTE: Zig stores `*PackageManager` non-exclusively;
// `sleep_until` also receives this raw pointer, so storing
// `&mut PackageManager` here would alias under Stacked Borrows.
manager: *mut PackageManager,
err: Option<bun_core::Error>,
}
impl RunClosure {
pub(crate) fn is_done(closure: &mut Self) -> bool {
// SAFETY: `closure.manager` is the raw provenance root set
// below; `sleep_until`/`tick_raw` hold no `&mut` across this
// callback, so this is the unique live borrow.
let manager = unsafe { &mut *closure.manager };
let log_level = manager.options.log_level;
// PORT NOTE: void RunTasksCallbacks — `extract_ctx` is unit. Do NOT pass
// `manager` as both receiver and ctx (aliased &mut). Zig passed
// `(comptime *PackageManager, closure.manager)`; the generic context
// pair collapses to `&mut ()` in Rust.
if let Err(err) = run_tasks::run_tasks::<ManifestsOnlyCallbacks>(
manager,
&mut (),
true,
log_level,
) {
closure.err = Some(err);
return true;
}
run_tasks::pending_task_count(manager) == 0
}
}
// Derive the raw provenance root first so both `sleep_until` and the
// closure body's `&mut *run_closure.manager` share the same SRW tag.
let mgr: *mut PackageManager = manager;
let mut run_closure = RunClosure {
manager: mgr,
err: None,
};
// SAFETY: `mgr` is derived from the live exclusive `manager` borrow;
// `sleep_until` is an associated fn taking `*mut PackageManager` and
// `tick_raw` holds no `&mut event_loop` across `is_done`, so the
// callback's `&mut *run_closure.manager` is the unique live borrow.
unsafe { PackageManager::sleep_until(mgr, &mut run_closure, RunClosure::is_done) };
if log_level.show_progress() {
// SAFETY: `mgr` is still the live provenance root; `sleep_until`
// has returned so no competing borrow exists.
unsafe { (*mgr).end_progress_bar() };
Output::flush();
}
if let Some(err) = run_closure.err {
return Err(err);
}
}
Ok(())
}
// ported from: src/install/PackageManager/PopulateManifestCache.zig