path: root/src/linker.zig

usingnamespace @import("global.zig");
usingnamespace @import("./ast/base.zig");

const std = @import("std");
const lex = @import("js_lexer.zig");
const logger = @import("logger.zig");
const alloc = @import("alloc.zig");
const Options = @import("options.zig");
const js_parser = @import("js_parser.zig");
const json_parser = @import("json_parser.zig");
const js_printer = @import("js_printer.zig");
const js_ast = @import("js_ast.zig");
const panicky = @import("panic_handler.zig");
const Fs = @import("fs.zig");
const Api = @import("api/schema.zig").Api;
const Resolver = @import("./resolver/resolver.zig");
const sync = @import("sync.zig");
const ThreadPool = sync.ThreadPool;
const ThreadSafeHashMap = @import("./thread_safe_hash_map.zig");
const ImportRecord = @import("./import_record.zig").ImportRecord;
const allocators = @import("./allocators.zig");
const MimeType = @import("./http/mime_type.zig");
const resolve_path = @import("./resolver/resolve_path.zig");
const _bundler = @import("./bundler.zig");
const Bundler = _bundler.Bundler;
const ResolveQueue = _bundler.ResolveQueue;
const Runtime = @import("./runtime.zig").Runtime;

pub fn NewLinker(comptime BundlerType: type) type {
    return struct {
        const ThisLinker = @This();
        allocator: *std.mem.Allocator,
        options: *Options.BundleOptions,
        fs: *Fs.FileSystem,
        log: *logger.Log,
        resolve_queue: *ResolveQueue,
        resolver: *BundlerType.Resolver,
        resolve_results: *_bundler.ResolveResults,
        any_needs_runtime: bool = false,
        runtime_import_record: ?ImportRecord = null,
        runtime_source_path: string,

        pub fn init(
            allocator: *std.mem.Allocator,
            log: *logger.Log,
            resolve_queue: *ResolveQueue,
            options: *Options.BundleOptions,
            resolver: *BundlerType.Resolver,
            resolve_results: *_bundler.ResolveResults,
            fs: *Fs.FileSystem,
        ) ThisLinker {
            relative_paths_list = ImportPathsList.init(allocator);

            return ThisLinker{
                .allocator = allocator,
                .options = options,
                .fs = fs,
                .log = log,
                .resolve_queue = resolve_queue,
                .resolver = resolver,
                .resolve_results = resolve_results,
                .runtime_source_path = fs.absAlloc(allocator, &([_]string{"__runtime.js"})) catch unreachable,
            };
        }

        // fs: fs.FileSystem,
        // TODO:
        pub fn requireOrImportMetaForSource(c: ThisLinker, source_index: Ref.Int) RequireOrImportMeta {
            return RequireOrImportMeta{};
        }

        // pub const Scratch = struct {
        //     threadlocal var externals: std.ArrayList(u32) = undefined;
        //     threadlocal var has_externals: std.ArrayList(u32) = undefined;
        //     pub fn externals() {

        //     }
        // };
        // This modifies the Ast in-place!
        // But more importantly, this does the following:
        // - Wrap CommonJS files
        pub fn link(
            linker: *ThisLinker,
            file_path: Fs.Path,
            result: *_bundler.ParseResult,
            comptime import_path_format: Options.BundleOptions.ImportPathFormat,
        ) !void {
            var needs_runtime = result.ast.uses_exports_ref or result.ast.uses_module_ref or result.ast.runtime_imports.hasAny();
            const source_dir = file_path.name.dir;
            var externals = std.ArrayList(u32).init(linker.allocator);
            var needs_bundle = false;

            // Step 1. Resolve imports & requires
            switch (result.loader) {
                .jsx, .js, .ts, .tsx => {
                    for (result.ast.import_records) |*import_record, _record_index| {
                        const record_index = @truncate(u32, _record_index);
                        if (strings.eqlComptime(import_record.path.text, Runtime.Imports.Name)) {
                            // runtime is included in the bundle, so we don't need to dynamically import it
                            if (linker.options.node_modules_bundle) |node_modules_bundle| {
                                import_record.path.text = node_modules_bundle.bundle.import_from_name;
                            } else {
                                import_record.path = try linker.generateImportPath(
                                    source_dir,
                                    linker.runtime_source_path,
                                    Runtime.version(),
                                    import_path_format,
                                );
                                result.ast.runtime_import_record_id = record_index;
                                result.ast.needs_runtime = true;
                            }
                            continue;
                        }

                        if (linker.resolver.resolve(source_dir, import_record.path.text, import_record.kind)) |*_resolved_import| {
                            var resolved_import: *Resolver.Result = _resolved_import;
                            if (resolved_import.is_external) {
                                externals.append(record_index) catch unreachable;
                                continue;
                            }

                            if (resolved_import.package_json) |package_json| {
                                if (linker.options.node_modules_bundle) |node_modules_bundle| {
                                    if (strings.contains(package_json.source.path.name.dirWithTrailingSlash(), "node_modules")) {
                                        if (node_modules_bundle.getPackageIDByName(package_json.name)) |possible_pkg_ids| {
                                            const pkg_id: u32 = brk: {
                                                for (possible_pkg_ids) |pkg_id| {
                                                    const pkg = node_modules_bundle.bundle.packages[pkg_id];
                                                    if (pkg.hash == package_json.hash) {
                                                        break :brk pkg_id;
                                                    }
                                                }

                                                linker.log.addErrorFmt(
                                                    null,
                                                    logger.Loc.Empty,
                                                    linker.allocator,
                                                    "\"{s}\" version changed, we'll need to regenerate the .jsb.\nOld version: \"{s}\"\nNew version: \"{s}\"",
                                                    .{
                                                        package_json.name,
                                                        node_modules_bundle.str(node_modules_bundle.bundle.packages[possible_pkg_ids[0]].version),
                                                        package_json.version,
                                                    },
                                                ) catch {};
                                                return error.RebuildJSB;
                                            };

                                            const package = &node_modules_bundle.bundle.packages[pkg_id];

                                            if (isDebug) {
                                                std.debug.assert(strings.eql(node_modules_bundle.str(package.name), package_json.name));
                                            }

                                            const package_relative_path = linker.fs.relative(
                                                package_json.source.path.name.dirWithTrailingSlash(),
                                                resolved_import.path_pair.primary.text,
                                            );

                                            const found_module = node_modules_bundle.findModuleInPackage(package, package_relative_path) orelse {
                                                linker.log.addErrorFmt(
                                                    null,
                                                    logger.Loc.Empty,
                                                    linker.allocator,
                                                    "New dependency import: \"{s}/{s}\"\nWe'll need to regenerate the .jsb.",
                                                    .{
                                                        package_json.name,
                                                        package_relative_path,
                                                    },
                                                ) catch {};
                                                return error.RebuildJSB;
                                            };

                                            import_record.is_bundled = true;
                                            import_record.path.text = node_modules_bundle.bundle.import_from_name;
                                            import_record.module_id = found_module.id;
                                            needs_bundle = true;
                                            continue;
                                        }
                                    }
                                }
                            }

                            linker.processImportRecord(
                                // Include trailing slash
                                file_path.text[0 .. source_dir.len + 1],
                                resolved_import,
                                import_record,
                                import_path_format,
                            ) catch continue;

                            // If we're importing a CommonJS module as ESM
                            // We need to do the following transform:
                            //      import React from 'react';
                            //      =>
                            //      import {_require} from 'RUNTIME_IMPORTS';
                            //      import * as react_module from 'react';
                            //      var React = _require(react_module).default;
                            // UNLESS it's a namespace import
                            // If it's a namespace import, assume it's safe.
                            // We can do this in the printer instead of creating a bunch of AST nodes here.
                            // But we need to at least tell the printer that this needs to happen.
                            if (import_record.kind == .stmt and resolved_import.shouldAssumeCommonJS(import_record)) {
                                import_record.wrap_with_to_module = true;
                                result.ast.needs_runtime = true;
                            }
                        } else |err| {
                            switch (err) {
                                error.ModuleNotFound => {
                                    if (Resolver.isPackagePath(import_record.path.text)) {
                                        if (linker.options.platform != .node and Options.ExternalModules.isNodeBuiltin(import_record.path.text)) {
                                            try linker.log.addRangeErrorFmt(
                                                &result.source,
                                                import_record.range,
                                                linker.allocator,
                                                "Could not resolve: \"{s}\". Try setting --platform=\"node\"",
                                                .{import_record.path.text},
                                            );
                                        } else {
                                            try linker.log.addRangeErrorFmt(
                                                &result.source,
                                                import_record.range,
                                                linker.allocator,
                                                "Could not resolve: \"{s}\". Maybe you need to \"npm install\" (or yarn/pnpm)?",
                                                .{import_record.path.text},
                                            );
                                        }
                                    } else {
                                        try linker.log.addRangeErrorFmt(
                                            &result.source,
                                            import_record.range,
                                            linker.allocator,
                                            "Could not resolve: \"{s}\"",
                                            .{
                                                import_record.path.text,
                                            },
                                        );
                                        continue;
                                    }
                                },
                                else => {
                                    continue;
                                },
                            }
                        }
                    }
                },
                else => {},
            }
            result.ast.externals = externals.toOwnedSlice();

            if (result.ast.needs_runtime and result.ast.runtime_import_record_id == null) {
                var import_records = try linker.allocator.alloc(ImportRecord, result.ast.import_records.len + 1);
                std.mem.copy(ImportRecord, import_records, result.ast.import_records);
                import_records[import_records.len - 1] = ImportRecord{
                    .kind = .stmt,
                    .path = try linker.generateImportPath(
                        source_dir,
                        linker.runtime_source_path,
                        Runtime.version(),
                        import_path_format,
                    ),
                    .range = logger.Range{ .loc = logger.Loc{ .start = 0 }, .len = 0 },
                };
            }

            const ImportStatementSorter = struct {
                import_records: []ImportRecord,
                pub fn lessThan(ctx: @This(), lhs: js_ast.Stmt, rhs: js_ast.Stmt) bool {
                    switch (lhs.data) {
                        .s_import => |li| {
                            switch (rhs.data) {
                                .s_import => |ri| {
                                    const a = ctx.import_records[li.import_record_index];
                                    const b = ctx.import_records[ri.import_record_index];
                                    if (a.is_bundled and !b.is_bundled) {
                                        return false;
                                    } else {
                                        return true;
                                    }
                                },
                                else => {
                                    return true;
                                },
                            }
                        },
                        else => {
                            switch (rhs.data) {
                                .s_import => |ri| {
                                    const a = ctx.import_records[ri.import_record_index];
                                    if (!a.is_bundled) {
                                        return false;
                                    } else {
                                        return true;
                                    }
                                },
                                else => {
                                    return true;
                                },
                            }
                        },
                    }
                }
            };

            // std.sort.sort(comptime T: type, items: []T, context: anytype, comptime lessThan: fn(context:@TypeOf(context), lhs:T, rhs:T)bool)

            // Change the import order so that any bundled imports appear last
            // This is to make it so the bundle (which should be quite large) is least likely to block rendering
            // if (needs_bundle) {
            //     const sorter = ImportStatementSorter{ .import_records = result.ast.import_records };
            //     for (result.ast.parts) |*part, i| {
            //         std.sort.sort(js_ast.Stmt, part.stmts, sorter, ImportStatementSorter.lessThan);
            //     }
            // }
        }

        const ImportPathsList = allocators.BSSStringList(512, 128);
        pub var relative_paths_list: *ImportPathsList = undefined;

        pub fn generateImportPath(
            linker: *ThisLinker,
            source_dir: string,
            source_path: string,
            package_version: ?string,
            comptime import_path_format: Options.BundleOptions.ImportPathFormat,
        ) !Fs.Path {
            switch (import_path_format) {
                .relative => {
                    var pretty = try linker.allocator.dupe(u8, linker.fs.relative(source_dir, source_path));
                    var pathname = Fs.PathName.init(pretty);
                    return Fs.Path.initWithPretty(pretty, pretty);
                },
                .relative_nodejs => {
                    var pretty = try linker.allocator.dupe(u8, linker.fs.relative(source_dir, source_path));
                    var pathname = Fs.PathName.init(pretty);
                    var path = Fs.Path.initWithPretty(pretty, pretty);
                    path.text = path.text[0 .. path.text.len - path.name.ext.len];
                    return path;
                },

                .absolute_url => {
                    var absolute_pathname = Fs.PathName.init(source_path);

                    if (!linker.options.preserve_extensions) {
                        if (linker.options.out_extensions.get(absolute_pathname.ext)) |ext| {
                            absolute_pathname.ext = ext;
                        }
                    }

                    var base = linker.fs.relativeTo(source_path);
                    if (strings.lastIndexOfChar(base, '.')) |dot| {
                        base = base[0..dot];
                    }

                    if (linker.options.append_package_version_in_query_string and package_version != null) {
                        const absolute_url =
                            try std.fmt.allocPrint(
                            linker.allocator,
                            "{s}{s}{s}?v={s}",
                            .{
                                linker.options.public_url,
                                base,
                                absolute_pathname.ext,
                                package_version.?,
                            },
                        );

                        return Fs.Path.initWithPretty(absolute_url, absolute_url);
                    } else {
                        const absolute_url = try std.fmt.allocPrint(
                            linker.allocator,
                            "{s}{s}{s}",
                            .{
                                linker.options.public_url,
                                base,
                                absolute_pathname.ext,
                            },
                        );

                        return Fs.Path.initWithPretty(absolute_url, absolute_url);
                    }
                },

                else => unreachable,
            }
        }

        pub fn processImportRecord(
            linker: *ThisLinker,
            source_dir: string,
            resolve_result: *Resolver.Result,
            import_record: *ImportRecord,
            comptime import_path_format: Options.BundleOptions.ImportPathFormat,
        ) !void {

            // extremely naive.
            resolve_result.is_from_node_modules = resolve_result.package_json != null or strings.contains(resolve_result.path_pair.primary.text, "/node_modules");

            // lazy means:
            // Run the resolver
            // Don't parse/print automatically.
            if (linker.options.resolve_mode != .lazy) {
                try linker.enqueueResolveResult(resolve_result);
            }

            import_record.path = try linker.generateImportPath(
                source_dir,
                resolve_result.path_pair.primary.text,
                if (resolve_result.package_json) |package_json| package_json.version else "",
                import_path_format,
            );
        }

        pub fn resolveResultHashKey(linker: *ThisLinker, resolve_result: *const Resolver.Result) string {
            var hash_key = resolve_result.path_pair.primary.text;

            // Shorter hash key is faster to hash
            if (strings.startsWith(resolve_result.path_pair.primary.text, linker.fs.top_level_dir)) {
                hash_key = resolve_result.path_pair.primary.text[linker.fs.top_level_dir.len..];
            }

            return hash_key;
        }

        pub fn enqueueResolveResult(linker: *ThisLinker, resolve_result: *const Resolver.Result) !void {
            const hash_key = linker.resolveResultHashKey(resolve_result);

            const get_or_put_entry = try linker.resolve_results.backing.getOrPut(hash_key);

            if (!get_or_put_entry.found_existing) {
                get_or_put_entry.entry.value = resolve_result.*;
                try linker.resolve_queue.writeItem(resolve_result.*);
            }
        }
    };
}

pub const Linker = NewLinker(_bundler.Bundler);
pub const ServeLinker = NewLinker(_bundler.ServeBundler);