Integration of system image generation, JuliaC and refactor (#25)

* refactor package retrieval

* sysimg integration work

* fixing sysimg building bugs

* AppEnv refactor

* add remove_sources flag

* refactoring stage module

* renaming examples

* renaming PkgImage -> JuliaAppBundle

* juliac implementation

* AppEnv config refactor; selective assets

---------

Co-authored-by: Janis Erdmanis <janiserdmanis@protonmail.ch>

Author: JanisErdmanis

AppEnv/Project.toml

@@ -1,7 +1,7 @@
 name = "AppEnv"
 uuid = "9f11263e-cf0d-4932-bae6-807953dbea74"
 authors = ["Janis Erdmanis <janiserdmanis@protonmail.ch>"]
-version = "0.1.0"
+version = "0.2.0"
 
 [compat]
 julia = "1"

AppEnv/src/AppEnv.jl

@@ -5,38 +5,38 @@ import Base: PkgId, PkgOrigin, UUID
 const RUNTIME_MODE_OPTIONS = ["MIN", "INTERACTIVE", "COMPILATION", "SANDBOX"]
 
 # Compilation can be done in one mode
-const DEFAULT_RUNTIME_MODE = get(ENV, "DEFAULT_RUNTIME_MODE", get(ENV, "RUNTIME_MODE", "INTERACTIVE"))
+#const DEFAULT_RUNTIME_MODE = get(ENV, "DEFAULT_RUNTIME_MODE", get(ENV, "RUNTIME_MODE", "INTERACTIVE"))
 
 #get(ENV, "JULIA_RUNTIME_MODE", "INTERACTIVE") # We set it at compilation
 
-const DEFAULT_MODULE_NAME = get(ENV, "MODULE_NAME", "MainEnv")
-const DEFAULT_APP_NAME = get(ENV, "APP_NAME", "")
-const DEFAULT_BUNDLE_IDENTIFIER = get(ENV, "BUNDLE_IDENTIFIER", "")
+#const DEFAULT_MODULE_NAME = get(ENV, "MODULE_NAME", "MainEnv")
+#const DEFAULT_APP_NAME = get(ENV, "APP_NAME", "")
+#const DEFAULT_BUNDLE_IDENTIFIER = get(ENV, "BUNDLE_IDENTIFIER", "")
 
-const DEFAULT_STDLIB = get(ENV, "STDLIB", relpath(Sys.STDLIB, dirname(Sys.BINDIR)))
+#const DEFAULT_STDLIB = get(ENV, "STDLIB", relpath(Sys.STDLIB, dirname(Sys.BINDIR)))
 
-println("Compilation is about to happen with the following parameters:")
-println("\tDEFAULT_RUNTIME_MODE=" * DEFAULT_RUNTIME_MODE)
-println("\tDEFAULT_MODULE_NAME=" * DEFAULT_MODULE_NAME)
-println("\tDEFAULT_APP_NAME=" * DEFAULT_APP_NAME)
-println("\tDEFAULT_BUNDLE_IDENTIFIER=" * DEFAULT_BUNDLE_IDENTIFIER)
+# println("Compilation is about to happen with the following parameters:")
+# println("\tDEFAULT_RUNTIME_MODE=" * DEFAULT_RUNTIME_MODE)
+# println("\tDEFAULT_MODULE_NAME=" * DEFAULT_MODULE_NAME)
+# println("\tDEFAULT_APP_NAME=" * DEFAULT_APP_NAME)
+# println("\tDEFAULT_BUNDLE_IDENTIFIER=" * DEFAULT_BUNDLE_IDENTIFIER)
 
 global USER_DATA::String # This is set by the startup macro itself
 
 
 # Theese constants must be present at compilation time as otherwise it does not make sense
 
-function save_pkgorigins(path, pkgorigins::Dict{PkgId, PkgOrigin}; stdlib_dir = Sys.STDLIB)
+function save_pkgorigins(index_path, pkgorigins::Dict{PkgId, PkgOrigin}; root_dir = nothing)
 
-    file = open(path, "w")
+    file = open(index_path, "w")
 
     try
         for (pkgid, pkgorigin) in pkgorigins
 
             (; name, uuid) = pkgid
             (; path, version) = pkgorigin
 
-            rpath = relpath(path, stdlib_dir)
+            rpath = isnothing(root_dir) ? path : relpath(path, root_dir)
 
             println(file, "$uuid\t$name\t$version\t$rpath")
 
@@ -70,7 +70,7 @@ function parse_version(version_str::AbstractString)
     return VersionNumber(major, minor, patch)
 end
 
-function load_pkgorigins!(pkgorigins, path; stdlib_dir = Sys.STDLIB)
+function load_pkgorigins!(pkgorigins, path; root_dir = dirname(path))
     #pkgorigins = Dict{PkgId, PkgOrigin}()
 
     file = open(path, "r")
@@ -99,11 +99,11 @@ function load_pkgorigins!(pkgorigins, path; stdlib_dir = Sys.STDLIB)
             end
 
             # Reconstruct absolute path
-            abspath = joinpath(stdlib_dir, rpath)
+            _abspath = abspath(joinpath(root_dir, rpath))
 
             # Create PkgId and PkgOrigin
             pkg_id = PkgId(uuid, name)
-            pkg_origin = PkgOrigin(abspath, nothing, version)
+            pkg_origin = PkgOrigin(_abspath, nothing, version)
 
             # Add to dictionary
             pkgorigins[pkg_id] = pkg_origin
@@ -116,17 +116,17 @@ function load_pkgorigins!(pkgorigins, path; stdlib_dir = Sys.STDLIB)
 end
 
 
-function collect_pkgorigins!(pkgorigins::Dict{PkgId, PkgOrigin}; stdlib_dir = Sys.STDLIB)
+function collect_pkgorigins!(pkgorigins::Dict{PkgId, PkgOrigin}; root_dir = Sys.STDLIB)
 
     uuid_regex = r"^uuid\s*=\s*\"([a-f0-9\-]+)\""mi
     version_regex = r"^version\s*=\s*\"([^\"]+)\""mi
 
-    if !isdir(stdlib_dir)
+    if !isdir(root_dir)
         return pkgorigins
     end
 
-    for name in readdir(stdlib_dir)
-        pkg_path = joinpath(stdlib_dir, name)
+    for name in readdir(root_dir)
+        pkg_path = joinpath(root_dir, name)
 
         # Skip if not a directory
         isdir(pkg_path) || continue
@@ -174,18 +174,18 @@ function collect_pkgorigins!(pkgorigins::Dict{PkgId, PkgOrigin}; stdlib_dir = Sy
     return pkgorigins
 end
 
-collect_pkgorigins(; stdlib_dir = Sys.STDLIB) = collect_pkgorigins!(Dict{PkgId, PkgOrigin}(); stdlib_dir)
+collect_pkgorigins(; root_dir = Sys.STDLIB) = collect_pkgorigins!(Dict{PkgId, PkgOrigin}(); root_dir)
 
 
-function set_load_path!(LOAD_PATH; module_name="")
+function set_load_path!(LOAD_PATH; stdlib_project_name)
 
     empty!(LOAD_PATH)
     push!(LOAD_PATH, "@", "@stdlib")
-    push!(LOAD_PATH, joinpath(Sys.STDLIB, module_name))
+    push!(LOAD_PATH, joinpath(Sys.STDLIB, stdlib_project_name))
 
 end
 
-function set_depot_path!(DEPOT_PATH; bundle_identifier, app_name, runtime_mode)
+function set_depot_path!(DEPOT_PATH; bundle_identifier = "", app_name = "", runtime_mode = "MIN")
 
     if runtime_mode == "SANDBOX"
 
@@ -194,24 +194,15 @@ function set_depot_path!(DEPOT_PATH; bundle_identifier, app_name, runtime_mode)
         elseif Sys.isapple()
             set_depot_path_macos!(DEPOT_PATH; app_name)
         elseif Sys.islinux()
-            set_depot_path_snap!(DEPOT_PATH; app_name)
+            set_depot_path_snap!(DEPOT_PATH)
         else
             error("Sandbox runtime mode is only supported for windows, macos and linux")
         end
 
-    elseif runtime_mode == "COMPILATION"
-
-        set_depot_path_min!(DEPOT_PATH)
-        popfirst!(DEPOT_PATH)
-
     elseif runtime_mode == "MIN"
 
         set_depot_path_min!(DEPOT_PATH)
 
-    elseif runtime_mode == "INTERACTIVE"
-
-        global USER_DATA = get(ENV, "USER_DATA", mktempdir())
-
     else
         error("Sandbox mode RUNTIME_MODE=$runtime_mode not supported")
     end
@@ -247,7 +238,7 @@ function set_depot_path_macos!(DEPOT_PATH::Vector{String}; app_name)
     return
 end
 
-function set_depot_path_snap!(DEPOT_PATH::Vector{String})
+function set_depot_path_snap!(DEPOT_PATH)
 
     empty!(DEPOT_PATH)
 
@@ -272,7 +263,7 @@ function set_depot_path_snap!(DEPOT_PATH::Vector{String})
 
     end
 
-    push!(DEPOT_PATH, dirname(dirname(Sys.STDLIB)))
+    push!(DEPOT_PATH, joinpath(dirname(Sys.BINDIR), "share/julia"))
 
     return
 end
@@ -326,29 +317,24 @@ function set_depot_path_msix!(DEPOT_PATH; bundle_identifier)
     return
 end
 
-
-function init(; 
-              runtime_mode::String = get(ENV, "RUNTIME_MODE", DEFAULT_RUNTIME_MODE),
-              module_name::String = get(ENV, "MODULE_NAME", DEFAULT_MODULE_NAME),
-              app_name::String = get(ENV, "APP_NAME", DEFAULT_APP_NAME),
-              bundle_identifier::String = get(ENV, "BUNDLE_IDENTIFIER", DEFAULT_BUNDLE_IDENTIFIER)
-              )
-
-
-    @assert runtime_mode in RUNTIME_MODE_OPTIONS "runtime_mode=$runtime_mode not recognized. Available options are $(join(RUNTIME_MODE_OPTIONS, '|'))"
-
-    if runtime_mode == "INTERACTIVE"
-        global USER_DATA = get(ENV, "USER_DATA", mktempdir())
-        return
+function load_config(config_path)
+    config_dict = Dict{String, String}()
+    
+    for line in eachline(config_path)
+        # Skip empty lines
+        isempty(strip(line)) && continue
+        
+        # Split on the first '=' character
+        key, value = split(line, '=', limit=2)
+        config_dict[strip(key)] = strip(value)
     end
 
-    Sys.STDLIB = joinpath(dirname(Sys.BINDIR), DEFAULT_STDLIB)
+    runtime_mode = config_dict["RUNTIME_MODE"]    
+    stdlib_project_name = config_dict["STDLIB_PROJECT_NAME"]
+    app_name = get(config_dict, "APP_NAME", "")
+    bundle_identifier = get(config_dict, "BUNDLE_IDENTIFIER", "")
 
-    # This is a bit of a hack
-    if isempty(module_name)
-        #error("MODULE_NAME not set")
-        module_name = get(ENV, "MODULE_NAME", DEFAULT_MODULE_NAME)
-    end
+    @assert runtime_mode in RUNTIME_MODE_OPTIONS
 
     if runtime_mode == "SANDBOX"
 
@@ -361,37 +347,77 @@ function init(;
         end
     end
 
-    set_load_path!(Base.LOAD_PATH; module_name)
-    set_depot_path!(Base.DEPOT_PATH; app_name, bundle_identifier, runtime_mode)
+    return (; runtime_mode, stdlib_project_name, app_name, bundle_identifier)
+end
 
-    if runtime_mode == "COMPILATION"
-        popfirst!(Base.LOAD_PATH)
-    else
 
-        index_path = joinpath(Sys.STDLIB, "index")
-        if isfile(index_path)
-            load_pkgorigins!(Base.pkgorigins, index_path)
-        else
-            collect_pkgorigins!(Base.pkgorigins)
-        end
+function save_config(config_path; stdlib_project_name, app_name = "", bundle_identifier = "", runtime_mode = "MIN")
 
-    end
+    @assert runtime_mode in RUNTIME_MODE_OPTIONS
+
+    config = """
+        RUNTIME_MODE=$runtime_mode
+        STDLIB_PROJECT_NAME=$stdlib_project_name
+        APP_NAME=$app_name
+        BUNDLE_IDENTIFIER=$bundle_identifier
+    """
+
+    rm(config_path; force=true)
+    write(config_path, config)
 
     return
 end
 
 
-function reset_cache()
+# function init(; 
+#               runtime_mode::String = get(ENV, "RUNTIME_MODE", DEFAULT_RUNTIME_MODE),
+#               module_name::String = get(ENV, "MODULE_NAME", DEFAULT_MODULE_NAME),
+#               app_name::String = get(ENV, "APP_NAME", DEFAULT_APP_NAME),
+#               bundle_identifier::String = get(ENV, "BUNDLE_IDENTIFIER", DEFAULT_BUNDLE_IDENTIFIER)
+#               )
+
 
-    pkg = Base.PkgId(Base.UUID("9f11263e-cf0d-4932-bae6-807953dbea74"), "AppEnv")
-    cache_dir = Base.compilecache_path(pkg)
+function init(; config_path = joinpath(dirname(Sys.BINDIR), "config"),
+              index_path = joinpath(dirname(Sys.BINDIR), "index"))
 
-    if !isnothing(cache_dir)
-        @info "Removing the cache"
-        rm(cache_dir; recursive=true)
+    # Prevents reinitialization
+    if isdefined(@__MODULE__, :USER_DATA)
+        return
     end
-    
+
+    # If config file is not present we assume it is an interactive mode
+    if !isfile(config_path)
+        global USER_DATA = get(ENV, "USER_DATA", mktempdir())
+        return
+    end
+
+    (; runtime_mode, stdlib_project_name, app_name, bundle_identifier) = load_config(config_path)
+
+    set_load_path!(Base.LOAD_PATH; stdlib_project_name)
+    set_depot_path!(Base.DEPOT_PATH; app_name, bundle_identifier, runtime_mode)
+
+    if isfile(index_path)
+        load_pkgorigins!(Base.pkgorigins, index_path)
+    else
+        @warn "Can't find pkgorigin index at $index_path"
+        #collect_pkgorigins!(Base.pkgorigins)
+    end
+
+    return
 end
 
 
+# function reset_cache()
+
+#     pkg = Base.PkgId(Base.UUID("9f11263e-cf0d-4932-bae6-807953dbea74"), "AppEnv")
+#     cache_dir = Base.compilecache_path(pkg)
+
+#     if !isnothing(cache_dir)
+#         @info "Removing the cache"
+#         rm(cache_dir; recursive=true)
+#     end
+    
+# end
+
+
 end # module AppEnv

AppEnv/test/runtests.jl

@@ -24,3 +24,22 @@ import Base: PkgId, PkgOrigin
 
 end
 
+
+@testset "config" begin
+
+    runtime_mode = "SANDBOX"
+    stdlib_project_name = "MyApp"
+    bundle_identifier = "org.appbundler.myapp"
+    app_name = "MyApp"
+    
+    config_path = tempname()
+
+    AppEnv.save_config(config_path; runtime_mode, stdlib_project_name, bundle_identifier, app_name)
+    loaded = AppEnv.load_config(config_path)
+
+    @test loaded.runtime_mode == runtime_mode
+    @test loaded.stdlib_project_name == stdlib_project_name
+    @test loaded.bundle_identifier == bundle_identifier
+    @test loaded.app_name == app_name
+
+end

Project.toml

@@ -1,10 +1,11 @@
 name = "AppBundler"
 uuid = "40eb83ae-c93a-480c-8f39-f018b568f472"
 authors = ["Janis Erdmanis <janiserdmanis@protonmail.ch>"]
-version = "0.5.1"
+version = "0.6.0"
 
 [deps]
 AppBundlerUtils_jll = "20612f45-4fe6-500a-af5c-19078bfe0d65"
+AppEnv = "9f11263e-cf0d-4932-bae6-807953dbea74"
 Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
@@ -14,10 +15,12 @@ FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534"
 ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19"
 ImageTransformations = "02fcd773-0e25-5acc-982a-7f6622650795"
+Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
 Makemsix_jll = "92e7c7cf-2c17-5ab8-9563-5ab5b2fcee8a"
 Mustache = "ffc61752-8dc7-55ee-8c37-f3e9cdd09e70"
 OpenSSL_jll = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Scratch = "6c6a2e73-6563-6170-7368-637461726353"
@@ -30,6 +33,9 @@ osslsigncode_jll = "5a7615ae-274c-51d1-b5a8-ff30401c2c7e"
 rcodesign_jll = "81561df1-22b2-57e5-9f67-03318e1fa9d9"
 squashfs_tools_jll = "eed32e3e-a7c5-5bf9-9121-5cf3ab653887"
 
+[sources]
+AppEnv = {path = "AppEnv"}
+
 [compat]
 AppBundlerUtils_jll = "=0.4.0"
 Base64 = "1.11.0"
@@ -40,10 +46,12 @@ FileIO = "1.17.0"
 ImageCore = "0.10.5"
 ImageIO = "0.6.9"
 ImageTransformations = "0.10.2"
+Libdl = "1.11.0"
 Makemsix_jll = "1.7.241"
 Mustache = "1"
 OpenSSL_jll = "3.5"
 Pkg = "1.9"
+Printf = "1.11.0"
 PyCall = "1.96.4"
 Random = "1.11.0"
 Scratch = "1.2"
@@ -64,3 +72,4 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
 test = ["Test", "SafeTestsets", "SHA"]
+