Update Luau dependency to 0.671 to remove require-by-string hacks (#242)

This PR removes several of the hacks involved in implementing support
for Luau.Require in Lute, as release 0.671 of Luau.Require added various
helpful functions like `luarequire_pushproxyrequire` and
`luarequire_registermodule`.

Author: vrn-sn

cli/main.cpp

@@ -60,6 +60,29 @@ static void* createCliRequireContext(lua_State* L)
     return ctx;
 }
 
+static void luteopen_libs(lua_State* L)
+{
+    std::vector<std::pair<const char*, lua_CFunction>> libs = {{
+        {"@lute/crypto", luteopen_crypto},
+        {"@lute/fs", luteopen_fs},
+        {"@lute/luau", luteopen_luau},
+        {"@lute/net", luteopen_net},
+        {"@lute/process", luteopen_process},
+        {"@lute/task", luteopen_task},
+        {"@lute/vm", luteopen_vm},
+        {"@lute/system", luteopen_system},
+        {"@lute/time", luteopen_time},
+    }};
+
+    for (const auto& [name, func] : libs)
+    {
+        lua_pushcfunction(L, luarequire_registermodule, nullptr);
+        lua_pushstring(L, name);
+        func(L);
+        lua_call(L, 2, 0);
+    }
+}
+
 lua_State* setupState(Runtime& runtime)
 {
     // Separate VM for data copies
@@ -80,38 +103,8 @@ lua_State* setupState(Runtime& runtime)
     // register the builtin tables
     luaL_openlibs(L);
 
-    luaL_findtable(L, LUA_REGISTRYINDEX, "_MODULES", 1);
-
-    luteopen_crypto(L);
-    lua_setfield(L, -2, "@lute/crypto");
-
-    luteopen_fs(L);
-    lua_setfield(L, -2, "@lute/fs");
-
-    luteopen_luau(L);
-    lua_setfield(L, -2, "@lute/luau");
-
-    luteopen_net(L);
-    lua_setfield(L, -2, "@lute/net");
-
-    luteopen_process(L);
-    lua_setfield(L, -2, "@lute/process");
-
-    luteopen_task(L);
-    lua_setfield(L, -2, "@lute/task");
-
-    luteopen_vm(L);
-    lua_setfield(L, -2, "@lute/vm");
-
-    luteopen_system(L);
-    lua_setfield(L, -2, "@lute/system");
-
-    luteopen_time(L);
-    lua_setfield(L, -2, "@lute/time");
-
-    lua_pop(L, 1);
-
     luaopen_require(L, requireConfigInit, createCliRequireContext(L));
+    luteopen_libs(L);
 
     lua_pushnil(L);
     lua_setglobal(L, "setfenv");

extern/luau.tune

@@ -1,5 +1,5 @@
 [dependency]
 name = "luau"
 remote = "https://github.com/luau-lang/luau.git"
-branch = "0.670"
-revision = "a2303a6ae68c53035eccf230c4450b9f068536af"
+branch = "0.671"
+revision = "c51743268bcbe5c5af1bd78bcacaefe7f6fe3391"

luau/src/luau.cpp

@@ -1420,7 +1420,7 @@ struct AstSerialize : public Luau::AstVisitor
         // TODO: declarations
     }
 
-    void serializeStat(Luau::AstStatDeclareClass* node)
+    void serializeStat(Luau::AstStatDeclareExternType* node)
     {
         // TODO: declarations
     }
@@ -1845,7 +1845,7 @@ struct AstSerialize : public Luau::AstVisitor
         return false;
     }
 
-    bool visit(Luau::AstStatDeclareClass* node) override
+    bool visit(Luau::AstStatDeclareExternType* node) override
     {
         serializeStat(node);
         return false;

runtime/include/lute/require.h

@@ -14,12 +14,6 @@ void requireConfigInit(luarequire_Configuration* config);
 struct RequireCtx
 {
     RequireCtx() = default;
-    RequireCtx(std::string sourceOverride)
-        : sourceOverride(std::move(sourceOverride))
-    {
-    }
-
-    std::optional<std::string> sourceOverride = std::nullopt;
 
     std::string absPath;
     std::string relPath;

runtime/include/lute/requireutils.h

@@ -8,10 +8,6 @@ enum class VFSType
 {
     Disk,
     Std,
-
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    Lute,
 };
 
 struct PathResult

runtime/src/require.cpp

@@ -47,22 +47,18 @@ static luarequire_NavigateResult storePathResult(RequireCtx* reqCtx, PathResult
 
 static bool is_require_allowed(lua_State* L, void* ctx, const char* requirer_chunkname)
 {
-    // FIXME: this is a temporary workaround until Luau.Require provides a way
-    // to perform proxy requires.
-    return true;
-
-    // std::string_view chunkname = requirer_chunkname;
-    // bool isStdin = (chunkname == "=stdin");
-    // bool isFile = (!chunkname.empty() && chunkname[0] == '@');
-    // bool isStdLibFile = (chunkname.size() >= 6 && chunkname.substr(0, 6) == "@@std/");
-    // return isStdin || isFile || isStdLibFile;
+    std::string_view chunkname = requirer_chunkname;
+    bool isStdin = (chunkname == "=stdin");
+    bool isFile = (!chunkname.empty() && chunkname[0] == '@');
+    bool isStdLibFile = (chunkname.size() >= 6 && chunkname.substr(0, 6) == "@@std/");
+    return isStdin || isFile || isStdLibFile;
 }
 
 static luarequire_NavigateResult reset(lua_State* L, void* ctx, const char* requirer_chunkname)
 {
     RequireCtx* reqCtx = static_cast<RequireCtx*>(ctx);
 
-    std::string chunkname = reqCtx->sourceOverride ? *reqCtx->sourceOverride : requirer_chunkname;
+    std::string chunkname = requirer_chunkname;
     reqCtx->atFakeRoot = false;
 
     if ((chunkname.size() >= 6 && chunkname.substr(0, 6) == "@@std/"))
@@ -91,18 +87,6 @@ static luarequire_NavigateResult jump_to_alias(lua_State* L, void* ctx, const ch
 {
     RequireCtx* reqCtx = static_cast<RequireCtx*>(ctx);
 
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (std::string_view(path) == "$lute")
-    {
-        reqCtx->atFakeRoot = false;
-        reqCtx->currentVFSType = VFSType::Lute;
-        reqCtx->absPath = "@lute";
-        reqCtx->relPath = "";
-        reqCtx->suffix = "";
-        return NAVIGATE_SUCCESS;
-    }
-
     if (std::string_view(path) == "$std")
     {
         reqCtx->atFakeRoot = false;
@@ -150,36 +134,19 @@ static luarequire_NavigateResult to_child(lua_State* L, void* ctx, const char* n
 static bool is_module_present(lua_State* L, void* ctx)
 {
     RequireCtx* reqCtx = static_cast<RequireCtx*>(ctx);
-
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (reqCtx->currentVFSType == VFSType::Lute)
-        return true;
-
     return isFilePresent(reqCtx->currentVFSType, reqCtx->absPath, reqCtx->suffix);
 }
 
 static luarequire_WriteResult get_contents(lua_State* L, void* ctx, char* buffer, size_t buffer_size, size_t* size_out)
 {
     RequireCtx* reqCtx = static_cast<RequireCtx*>(ctx);
-
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (reqCtx->currentVFSType == VFSType::Lute)
-        return write("", buffer, buffer_size, size_out);
-
     return write(getFileContents(reqCtx->currentVFSType, reqCtx->absPath, reqCtx->suffix), buffer, buffer_size, size_out);
 }
 
 static luarequire_WriteResult get_chunkname(lua_State* L, void* ctx, char* buffer, size_t buffer_size, size_t* size_out)
 {
     RequireCtx* reqCtx = static_cast<RequireCtx*>(ctx);
 
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (reqCtx->currentVFSType == VFSType::Lute)
-        return write("@" + reqCtx->absPath, buffer, buffer_size, size_out);
-
     if (reqCtx->currentVFSType == VFSType::Std)
         return write("@" + reqCtx->absPath, buffer, buffer_size, size_out);
 
@@ -198,11 +165,6 @@ static bool is_config_present(lua_State* L, void* ctx)
     if (reqCtx->atFakeRoot)
         return true;
 
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (reqCtx->currentVFSType == VFSType::Lute)
-        return false;
-
     return isFilePresent(reqCtx->currentVFSType, reqCtx->absPath, "/.luaurc");
 }
 
@@ -214,7 +176,6 @@ static luarequire_WriteResult get_config(lua_State* L, void* ctx, char* buffer,
         std::string globalConfig = "{\n"
                                     "    \"aliases\": {\n"
                                     "        \"std\": \"$std\",\n"
-                                    "        \"lute\": \"$lute\",\n"
                                     "    }\n"
                                     "}\n";
         return write(globalConfig, buffer, buffer_size, size_out);
@@ -223,24 +184,15 @@ static luarequire_WriteResult get_config(lua_State* L, void* ctx, char* buffer,
     return write(getFileContents(reqCtx->currentVFSType, reqCtx->absPath, "/.luaurc"), buffer, buffer_size, size_out);
 }
 
-static int load(lua_State* L, void* ctx, const char* chunkname, const char* contents)
+static int load(lua_State* L, void* ctx, const char* path, const char* chunkname, const char* contents)
 {
-    std::string_view chunknameView = chunkname;
+    std::string_view pathView = path;
 
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (chunknameView.rfind("@@lute/", 0) == 0)
+    if (pathView.rfind("@lute/", 0) == 0)
     {
-        lua_getfield(L, LUA_REGISTRYINDEX, "_MODULES");
-        lua_getfield(L, -1, chunknameView.substr(1).data());
-
-        if (lua_isnil(L, -1))
-        {
-            lua_pop(L, 1);
-            luaL_error(L, "no luau runtime library: %s", &chunkname[1]);
-        }
-
-        return 1;
+        // @lute library tables are registered into require-by-string directly
+        // and are not loaded here.
+        luaL_error(L, "no luau runtime library: %s", path);
     }
 
     // module needs to run in a new thread, isolated from the rest
@@ -266,7 +218,7 @@ static int load(lua_State* L, void* ctx, const char* chunkname, const char* cont
 
         if (status == 0)
         {
-            const std::string prefix = "module " + std::string(chunknameView.substr(1)) + " must";
+            const std::string prefix = "module " + std::string(pathView) + " must";
 
             if (lua_gettop(ML) == 0)
                 lua_pushstring(ML, (prefix + " return a value, if it has no return value, you should explicitly return `nil`\n").c_str());

runtime/src/requireutils.cpp

@@ -76,11 +76,6 @@ static std::pair<PathResult::Status, std::string> getSuffixWithAmbiguityCheck(VF
 
 static PathResult addSuffix(VFSType vfsType, PathResult partialResult)
 {
-    // FIXME: this is a temporary workaround until Luau.Require provides an
-    // API for registering the @lute/* libraries.
-    if (vfsType == VFSType::Lute)
-        return partialResult;
-
     if (partialResult.status != PathResult::Status::SUCCESS)
         return partialResult;
 

vm/src/spawn.cpp

@@ -185,10 +185,11 @@ int lua_spawn(lua_State* L)
     lua_getinfo(L, 1, "s", &ar);
 
     // Require the target module
-    RequireCtx ctx{/* sourceOverride = */ ar.source};
-    lua_pushrequire(child->GL, requireConfigInit, &ctx);
+    RequireCtx ctx{};
+    luarequire_pushproxyrequire(child->GL, requireConfigInit, &ctx);
     lua_pushstring(child->GL, file);
-    int status = lua_pcall(child->GL, 1, 1, 0);
+    lua_pushstring(child->GL, ar.source);
+    int status = lua_pcall(child->GL, 2, 1, 0);
 
     if (status == LUA_ERRRUN && lua_type(child->GL, -1) == LUA_TSTRING)
     {