make compat by AI

Author: sumneko

.vscode/settings.json

@@ -8,4 +8,7 @@
         //"--shownode",
         //"--lazy",
     ],
+    "files.associations": {
+        "thread": "cpp"
+    },
 }

COMPAT_FIXES.md

@@ -0,0 +1,64 @@
+# bee.lua API 兼容性修复总结
+
+## 修复的问题
+
+### 1. `exe_path` API 变更
+- **问题**: `fs.exe_path()` 从 `bee.filesystem` 模块移除
+- **解决方案**: 现在使用 `bee.sys.exe_path()`
+- **修改文件**: 
+  - `test.lua` - 更新为使用 `sys.exe_path()`
+  - `script/meta/bee/filesystem.lua` - 添加 deprecated 标记
+  - `script/meta/bee/sys.lua` - 新增元数据
+
+### 2. Channel API 变更
+- **问题**: `thread.newchannel()` 和 `thread.channel()` 不再存在
+- **新 API**: `bee.channel.create()` 和 `bee.channel.query()`
+- **解决方案**: 创建兼容层 `script/bee-compat.lua`
+- **修改文件**:
+  - `script/bee-compat.lua` - 新增兼容层
+  - `script/pub/pub.lua` - 使用兼容层
+  - `script/brave/brave.lua` - 使用兼容层
+  - `script/meta/bee/channel.lua` - 新增元数据
+  - `script/meta/bee/thread.lua` - 更新元数据
+
+### 3. Thread API 变更
+- **问题**: `thread.thread()` 改名为 `thread.create()`
+- **解决方案**: 在兼容层中添加别名
+- **修改文件**: `script/bee-compat.lua`
+
+### 4. Channel bpop() 实现
+- **问题**: 新版 channel 不支持阻塞 pop
+- **解决方案**: 使用 `bee.select` 模块实现阻塞等待
+- **实现**: 在兼容层的 metatable 中添加 `bpop()` 方法
+
+## 兼容层功能
+
+`script/bee-compat.lua` 提供以下功能：
+
+1. **thread.newchannel(name)** - 创建 channel 并注册到 selector
+2. **thread.channel(name)** - 查询现有 channel
+3. **thread.thread(script)** - thread.create() 的别名
+4. **channel:bpop()** - 阻塞式 pop，使用 select 等待
+5. **errlog 特殊处理** - 包装 thread.errlog() 为 channel 接口
+
+## 测试
+
+- ✓ 基本兼容性测试通过 (`test_compat.lua`)
+- ✓ 主测试套件运行正常 (`test.lua`)
+- ✓ channel 创建、查询、push/pop 功能正常
+- ✓ errlog channel 工作正常
+- ✓ sys.exe_path() 正常工作
+
+## 使用方法
+
+在需要使用旧 API 的模块中，使用：
+```lua
+local thread = require 'bee-compat'
+```
+
+而不是：
+```lua
+local thread = require 'bee.thread'
+```
+
+这样就能自动获得兼容性支持。

script/bee-compat.lua

@@ -0,0 +1,85 @@
+-- Compatibility layer for bee.lua API changes
+local thread = require 'bee.thread'
+local channel_mod = require 'bee.channel'
+local select_mod = require 'bee.select'
+
+-- Store original thread.create
+local original_create = thread.create
+
+-- Add thread.thread as alias for backward compatibility
+thread.thread = original_create
+
+-- Store channels globally
+local channels = {}
+local selector = select_mod.create()
+
+-- Create a wrapper for errlog to make it compatible with channel interface
+local errlog_channel = setmetatable({}, {
+    __index = {
+        pop = function()
+            local err = thread.errlog()
+            if err then
+                return true, err
+            else
+                return false
+            end
+        end,
+        bpop = function()
+            while true do
+                local err = thread.errlog()
+                if err then
+                    return err
+                end
+                thread.sleep(10)
+            end
+        end,
+    }
+})
+
+-- Create a new channel
+function thread.newchannel(name)
+    if name == 'errlog' then
+        return errlog_channel
+    end
+    if channels[name] then
+        error("Channel already exists: " .. name)
+    end
+    local ch = channel_mod.create(name)
+    channels[name] = ch
+    -- Add to selector for blocking operations
+    selector:event_add(ch:fd(), select_mod.SELECT_READ)
+    return ch
+end
+
+-- Get an existing channel
+function thread.channel(name)
+    if name == 'errlog' then
+        return errlog_channel
+    end
+    local ch = channels[name]
+    if not ch then
+        ch = channel_mod.query(name)
+        if ch then
+            channels[name] = ch
+            selector:event_add(ch:fd(), select_mod.SELECT_READ)
+        end
+    end
+    return ch
+end
+
+-- Add blocking pop support to channels
+local channel_mt = debug.getregistry()['bee::channel']
+if channel_mt and not channel_mt.bpop then
+    function channel_mt:bpop()
+        while true do
+            local results = table.pack(self:pop())
+            if results[1] then
+                return table.unpack(results, 2, results.n)
+            end
+            -- Wait for data with a timeout
+            selector:wait(100)
+        end
+    end
+end
+
+return thread

script/brave/brave.lua

@@ -1,4 +1,4 @@
-local thread = require 'bee.thread'
+local thread = require 'bee-compat'
 
 local taskPad = thread.channel('taskpad')
 local waiter  = thread.channel('waiter')

script/meta/bee/channel.lua

@@ -0,0 +1,36 @@
+---@meta
+
+---@class bee.channel
+local channel_mod = {}
+
+---@class bee.channel.object
+local channel = {}
+
+---@param ... any
+function channel:push(...)
+end
+
+---@return boolean success
+---@return ...
+function channel:pop()
+end
+
+---@return userdata
+function channel:fd()
+end
+
+---@param name string
+---@return bee.channel.object
+function channel_mod.create(name)
+end
+
+---@param name string
+function channel_mod.destroy(name)
+end
+
+---@param name string
+---@return bee.channel.object?
+function channel_mod.query(name)
+end
+
+return channel_mod

script/meta/bee/filesystem.lua

@@ -49,6 +49,7 @@ fs.copy_options = copy_options
 function fs.path(path)
 end
 
+---@deprecated Use bee.sys.exe_path() instead
 ---@return fs.path
 function fs.exe_path()
 end

script/meta/bee/sys.lua

@@ -0,0 +1,14 @@
+---@meta
+
+---@class bee.sys
+local sys = {}
+
+---@return fs.path
+function sys.exe_path()
+end
+
+---@return fs.path
+function sys.dll_path()
+end
+
+return sys

script/meta/bee/thread.lua

@@ -6,26 +6,42 @@ local thread = {}
 ---@param time number
 function thread.sleep(time) end
 
+---@deprecated Use bee.channel.create() instead, or use bee-compat module
 ---@param name string
 function thread.newchannel(name) end
 
+---@deprecated Use bee.channel.query() instead, or use bee-compat module
 ---@param name string
 ---@return bee.thread.channel
 function thread.channel(name) end
 
+---@param script string
+---@return userdata
+function thread.create(script) end
+
+---@deprecated Use thread.create() instead
 ---@param script string
 ---@return bee.thread.thread
 function thread.thread(script) end
 
 ---@return string?
 function thread.errlog() end
 
+---@param handle userdata
+function thread.wait(handle) end
+
+---@param name string
+function thread.setname(name) end
+
+---@type integer
+thread.id = 0
+
 ---@class bee.thread.channel
 local channel = {}
 
 function channel:push(...) end
 
----@return ...
+---@return boolean, ...
 function channel:pop() end
 
 ---@return ...

script/pub/pub.lua

@@ -1,4 +1,5 @@
-local thread  = require 'bee.thread'
+local thread  = require 'bee-compat'
+local channel = require 'bee.channel'
 local utility = require 'utility'
 local await   = require 'await'
 

test.lua

@@ -2,7 +2,8 @@ package.path  = package.path
       .. ';./test/?.lua'
       .. ';./test/?/init.lua'
 local fs = require 'bee.filesystem'
-local rootPath = fs.exe_path():parent_path():parent_path():string()
+local sys = require 'bee.sys'
+local rootPath = sys.exe_path():parent_path():parent_path():string()
 ROOT = fs.path(rootPath)
 TEST = true
 DEVELOP = true
@@ -127,6 +128,6 @@ end
 loadAllLibs()
 main()
 
-log.debug('test finish.')
+print('test finish.')
 require 'bee.thread'.sleep(1000)
 os.exit()