perf: cache Available results to reduce network io

[aooohan]

• Wrap the Available hook in the plugin with a layer of cache so that the cache can be used regardless of vfox calls or calls within the plugin.
• Allows configurable cache duration, defaults to 12 hours.

see #227 (comment)

[Chance-fyi]

• We should be able to refresh the cache manually.

• Should the cache be invalidated for the following operation?

  vfox config cache.availableHookDuration 12h
  # Cache and sleep
  vfox config cache.availableHookDuration 1s

[aooohan]

• We should be able to refresh the cache manually.

Agreed, but this can be enhanced later, for now it can be done with the config command.

• Should the cache be invalidated for the following operation?

The cache is invalidated only in the following cases:

vfox config cache.availableHookDuration 0

vfox config cache.availableHookDuration -1

In addition, there seems to be an issue with config command. I cannot directly assign 1s to availableHookDuration that is a field of type time.Duration by command.

[bytemain]

and we also can provide a cache library for the plugins, let them can store some data.

local cache = require("vfox/cache")

local key = "nodejs-index-json"
local hit = cache.has(key)
if (!hit) then
  local data = -- fetch --
  cache.set(key, data, 12 * 60 * 60 * 1000)
end

---

Sorry, I accidentally clicked the close button.

[aooohan]

and we also can provide a cache library for the plugins, let them can store some data.

Sure. I have this plan.

[Chance-fyi]

In addition, there seems to be an issue with config command. I cannot directly assign 1s to availableHookDuration that is a field of type time.Duration by command.

I've added support for time.Duration type, but haven't pushed yet.

I noticed that YAML parsing fails if there's no type.

[aooohan]

I noticed that YAML parsing fails if there's no type.

Oops, thanks for point out. Let me think about how to deal with it.

[jan-bar]

I noticed that YAML parsing fails if there's no type.

You can try adding the following code

func (c *Cache) UnmarshalYAML(node *yaml.Node) error {
	var data map[string]any
	err := node.Decode(&data)
	if err != nil {
		return err
	}

	if v, ok := data["availableHookDuration"]; ok {
		switch va := v.(type) {
		case int:
			c.AvailableHookDuration = time.Duration(va)
		case string:
			c.AvailableHookDuration, err = time.ParseDuration(va)
			if err != nil {
				return err
			}
		}
	}
	return nil
}

Or

type Cache struct {
	AvailableHookDuration VfoxDuration `yaml:"availableHookDuration"` // Available hook result cache time
}

type VfoxDuration time.Duration

func (c *VfoxDuration) UnmarshalYAML(node *yaml.Node) error {
	var data any
	err := node.Decode(&data)
	if err != nil {
		return err
	}

	switch va := data.(type) {
	case int:
		*c = VfoxDuration(va)
	case string:
		pd, err := time.ParseDuration(va)
		if err != nil {
			return err
		}
		*c = VfoxDuration(pd)
	}
	return nil
}

The second option adds a new type
The first option also needs to modify this part of the code when adding fields to the Cache later

[aooohan]

The second option adds a new type

I took your second option. ; )

[bytemain]

看起来可以把这个 hook 的能力做到 LuaVM 里，

一个初始的想法是这样的：

vm.DecorateFunction(func, func () int {})

[aooohan]

好主意! 可以放到下一版本去做. 目前先保证功能优先.

[aooohan]

I've added support for time.Duration type, but haven't pushed yet.

Hi, Can you push your changes?