Skip to content

Commit a425f0b

Browse files
k33gk33g
committed
📦 updates HDK for v0.0.2
1 parent 7105616 commit a425f0b

27 files changed

+646
-90
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ host
33
simple-host
44
simple-hello-host
55
simple-talk-host
6+
cracke/cracker
67
*.wasm
78
site

‎Taskfile.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ tasks:
2121
release:
2222
env:
2323
#TAG: "v0.0.1"
24-
TAG: "v0.0.2" # next release
24+
TAG: "v0.0.2"
25+
#TAG: "v0.0.3" # next release
2526
cmds:
2627
- echo "📦 Generating release..."
2728
- git add .

‎capsule.dk.go

+30-23
Original file line numberDiff line numberDiff line change
@@ -10,52 +10,59 @@ import (
1010
const isFailure = rune('F')
1111
const isSuccess = rune('S')
1212

13-
/*
14-
func main() {
15-
panic("not implemented")
16-
}
17-
18-
func success(buffer []byte) uint64 {
19-
return copyBufferToMemory(append([]byte(string(isSuccess)), buffer...))
20-
}
21-
22-
func failure(buffer []byte) uint64 {
23-
return copyBufferToMemory(append([]byte(string(isFailure)), buffer...))
24-
}
25-
*/
26-
13+
// success appends the isSuccess byte to the beginning of the input buffer and returns the result.
14+
//
15+
// buffer: byte slice to append isSuccess byte to.
16+
// []byte: byte slice with the appended isSuccess byte.
2717
func success(buffer []byte) []byte {
2818
return append([]byte(string(isSuccess)), buffer...)
2919
}
3020

21+
// failure appends a string "isFailure" to the given byte slice buffer and returns the new slice.
22+
//
23+
// buffer: the byte slice to which "isFailure" is appended.
24+
// Returns the new byte slice with the string "isFailure" appended to it.
3125
func failure(buffer []byte) []byte {
3226
return append([]byte(string(isFailure)), buffer...)
3327
}
3428

35-
36-
37-
38-
// Result function
29+
// Result returns the data without the first byte if the first byte is isSuccess.
30+
// Otherwise, it returns nil and an error with the data starting from the second byte.
31+
//
32+
// data: A byte slice containing the data to check.
33+
// []byte: The data without the first byte if the first byte is isSuccess.
34+
// error: If the first byte is not isSuccess, it returns an error with the data starting from the second byte.
3935
func Result(data []byte,) ([]byte, error) {
4036
if data[0] == byte(isSuccess) {
4137
return data[1:], nil
4238
}
4339
return nil, errors.New(string(data[1:]))
4440
}
4541

46-
// GetHandle returns the handle function
42+
// GetHandle returns an exported function named "callHandle" from the given module.
43+
//
44+
// mod: The module to retrieve the function from.
45+
//
46+
// Returns: An exported function with the name "callHandle".
4747
func GetHandle(mod api.Module) api.Function {
4848
return mod.ExportedFunction("callHandle")
4949
}
5050

51-
// GetHandleJSON returns the handle function
51+
// GetHandleJSON returns the exported "callHandleJSON" function from the given module.
52+
//
53+
// mod: the module to retrieve the function from.
54+
//
55+
// returns: the exported "callHandleJSON" function.
5256
func GetHandleJSON(mod api.Module) api.Function {
5357
return mod.ExportedFunction("callHandleJSON")
5458
}
5559

56-
// GetHandleHTTP returns the handle function
60+
// GetHandleHTTP returns the exported 'callHandleHTTP' function from a given module.
61+
//
62+
// mod: The module containing the exported function.
63+
//
64+
// returns:
65+
// - api.Function: the exported 'callHandleHTTP' function.
5766
func GetHandleHTTP(mod api.Module) api.Function {
5867
return mod.ExportedFunction("callHandleHTTP")
5968
}
60-
61-
// TODO: handle the other handles

‎docs/getting-started.md

-17
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,3 @@
44
55
## Create a Capsule application
66

7-
Create a directory `say-hello`
8-
9-
```bash
10-
mkdir say-hello
11-
cd say-hello
12-
```
13-
14-
Initialize a new project in `say-hello`:
15-
16-
```bash
17-
go mod init say-hello
18-
```
19-
20-
Install the Capsule **HDK** dependencies:
21-
```bash
22-
go get github.com/bots-garden/capsule-host-sdk
23-
```

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Capsule Host SDK
22

33
!!! info "What's new?"
4+
- `v0.0.2`: ✨ Redis support
45
- `v0.0.1`: 🎉 first release
56

67
## What is the Capsule Host SDK alias **Capsule HDK**?

‎go.mod

+6-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,9 @@ require (
77
github.com/tetratelabs/wazero v1.1.0
88
)
99

10-
require golang.org/x/net v0.0.0-20211029224645-99673261e6eb // indirect
10+
require (
11+
github.com/cespare/xxhash/v2 v2.2.0 // indirect
12+
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
13+
github.com/redis/go-redis/v9 v9.0.4 // indirect
14+
golang.org/x/net v0.0.0-20211029224645-99673261e6eb // indirect
15+
)

‎go.sum

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
2+
github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
3+
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
4+
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
15
github.com/go-resty/resty/v2 v2.7.0 h1:me+K9p3uhSmXtrBZ4k9jcEAfJmuC8IivWHwaLZwPrFY=
26
github.com/go-resty/resty/v2 v2.7.0/go.mod h1:9PWDzw47qPphMRFfhsyk0NnSgvluHcljSMVIq3w7q0I=
7+
github.com/redis/go-redis/v9 v9.0.4 h1:FC82T+CHJ/Q/PdyLW++GeCO+Ol59Y4T7R4jbgjvktgc=
8+
github.com/redis/go-redis/v9 v9.0.4/go.mod h1:WqMKv5vnQbRuZstUwxQI195wHy+t4PuXDOjzMvcuQHk=
39
github.com/tetratelabs/wazero v1.1.0 h1:EByoAhC+QcYpwSZJSs/aV0uokxPwBgKxfiokSUwAknQ=
410
github.com/tetratelabs/wazero v1.1.0/go.mod h1:wYx2gNRg8/WihJfSDxA1TIL8H+GkfLYm+bIfbblu9VQ=
511
golang.org/x/net v0.0.0-20211029224645-99673261e6eb h1:pirldcYWx7rx7kE5r+9WsOXPXK0+WH5+uZ7uPmJ44uM=

‎go.work

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ use (
44
./samples/simple
55
./samples/simple-hello
66
./samples/simple-talk
7+
./samples/cracker
78
)

‎go.work.sum

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
2+
github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
3+
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
4+
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
5+
github.com/redis/go-redis/v9 v9.0.4 h1:FC82T+CHJ/Q/PdyLW++GeCO+Ol59Y4T7R4jbgjvktgc=
6+
github.com/redis/go-redis/v9 v9.0.4/go.mod h1:WqMKv5vnQbRuZstUwxQI195wHy+t4PuXDOjzMvcuQHk=
17
github.com/tetratelabs/wazero v1.0.1 h1:xyWBoGyMjYekG3mEQ/W7xm9E05S89kJ/at696d/9yuc=
28
github.com/tetratelabs/wazero v1.0.1/go.mod h1:wYx2gNRg8/WihJfSDxA1TIL8H+GkfLYm+bIfbblu9VQ=
3-
github.com/tetratelabs/wazero v1.1.0 h1:EByoAhC+QcYpwSZJSs/aV0uokxPwBgKxfiokSUwAknQ=
4-
github.com/tetratelabs/wazero v1.1.0/go.mod h1:wYx2gNRg8/WihJfSDxA1TIL8H+GkfLYm+bIfbblu9VQ=
59
github.com/valyala/fastjson v1.6.4/go.mod h1:CLCAqky6SMuOcxStkYQvblddUtoRxhYMGLrsQns1aXY=

‎hostfunc.envvar.go

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package capsule
22

3-
// this hostfunction is a template for the other host functions
43
import (
54
"context"
65
"log"
@@ -10,7 +9,12 @@ import (
109
"github.com/tetratelabs/wazero/api"
1110
)
1211

13-
// DefineHostFuncGetEnv defines a host function allowing the wasm guest to get an environment variable by name
12+
// DefineHostFuncGetEnv defines a new host function to get the environment variable value.
13+
//
14+
// Parameters:
15+
// - builder: the HostModuleBuilder to add the function to.
16+
//
17+
// Returns: nothing.
1418
func DefineHostFuncGetEnv(builder wazero.HostModuleBuilder) {
1519
builder.NewFunctionBuilder().
1620
WithGoModuleFunction(getEnv,

‎hostfunc.fileread.go

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package capsule
22

3-
// this hostfunction is a template for the other host functions
43
import (
54
"context"
65
"log"
@@ -10,7 +9,14 @@ import (
109
"github.com/tetratelabs/wazero/api"
1110
)
1211

13-
// DefineHostFuncReadFile defines a host function
12+
// DefineHostFuncReadFile defines a function that reads a file from the host file system
13+
// and returns its content as a string. The function takes in four parameters:
14+
// - filePath: the pointer to the string representing the file path
15+
// - filePathLen: the length of the file path string
16+
// - returned: a pointer to the string where the file content will be stored
17+
// - returnedLen: the length of the returned string
18+
//
19+
// The function returns an integer representing whether the operation was successful.
1420
func DefineHostFuncReadFile(builder wazero.HostModuleBuilder) {
1521
builder.NewFunctionBuilder().
1622
WithGoModuleFunction(readFile,
@@ -57,7 +63,3 @@ var readFile = api.GoModuleFunc(func(ctx context.Context, module api.Module, par
5763
params[0] = 0
5864

5965
})
60-
61-
/* Documentation:
62-
63-
*/

‎hostfunc.filewrite.go

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package capsule
22

3-
// this hostfunction is a template for the other host functions
43
import (
54
"context"
65
"log"
@@ -10,7 +9,15 @@ import (
109
"github.com/tetratelabs/wazero/api"
1110
)
1211

13-
// DefineHostFuncWriteFile defines a host function
12+
// DefineHostFuncWriteFile creates a new function called hostWriteFile in the
13+
// HostModuleBuilder. It accepts the following parameters:
14+
// - filePath (int32): position
15+
// - filePath (int32): length
16+
// - content (int32): position
17+
// - content (int32): length
18+
// - returned (int32): position
19+
// - returned (int32): length
20+
// The function returns an int32.
1421
func DefineHostFuncWriteFile(builder wazero.HostModuleBuilder) {
1522
builder.NewFunctionBuilder().
1623
WithGoModuleFunction(writeFile,
@@ -66,8 +73,3 @@ var writeFile = api.GoModuleFunc(func(ctx context.Context, module api.Module, pa
6673
params[0] = 0
6774

6875
})
69-
70-
/* Documentation:
71-
! concurrent are not managed
72-
? don't use it with the capsule-http runner
73-
*/

‎hostfunc.http.go

+11-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@ type request struct {
2525
Headers map[string]string `json:"Headers"`
2626
}
2727

28-
// DefineHostFuncHTTP defines a host function
28+
// DefineHostFuncHTTP defines the host module function for handling HTTP requests.
29+
//
30+
// Parameter(s):
31+
// builder: the wazero.HostModuleBuilder used to define the function.
32+
//
33+
// Return(s):
34+
// None.
2935
func DefineHostFuncHTTP(builder wazero.HostModuleBuilder) {
3036
builder.NewFunctionBuilder().
3137
WithGoModuleFunction(http,
@@ -170,6 +176,10 @@ var http = api.GoModuleFunc(func(ctx context.Context, module api.Module, params
170176

171177
})
172178

179+
// buildResponseJSONString takes a resty.Response pointer as input and returns a JSON string and an error.
180+
// The function builds a JSON string of the response headers and response body. If the response is in JSON format,
181+
// the function includes the JSON body in the JSON string; otherwise, the function includes the text body in the JSON
182+
// string with double quotes. The function also includes the status code in the JSON string.
173183
func buildResponseJSONString(resp *resty.Response) (string, error) {
174184
// build headers JSON string
175185
// ! ATTENTION resp.Header() return a map[string]string[] (instead of map[string]string)
@@ -205,7 +215,3 @@ func buildResponseJSONString(resp *resty.Response) (string, error) {
205215

206216
return jsonHTTPResponse, err
207217
}
208-
209-
/* Documentation:
210-
211-
*/

‎hostfunc.log.go

+5-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ var logString = api.GoModuleFunc(func(ctx context.Context, module api.Module, pa
3030
params[0] = 0 // return 0
3131
})
3232

33-
34-
// DefineHostFuncLog defines a host function
33+
// DefineHostFuncLog defines and exports a host module function called hostLogString.
34+
// This function takes two parameters:
35+
// - string position (i32)
36+
// - string length (i32)
37+
// It returns an i32 value.
3538
func DefineHostFuncLog(builder wazero.HostModuleBuilder) {
3639
// hostLogString
3740
builder.NewFunctionBuilder().

‎hostfunc.memorycache.go

+23-8
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,15 @@ import (
2323

2424
var memCache sync.Map
2525

26-
// DefineHostFuncCacheSet defines a host function
26+
// DefineHostFuncCacheSet defines a new Go module function for setting values in
27+
// the cache. It takes in 6 parameters:
28+
// - key position (int32)
29+
// - key length (int32)
30+
// - value string position (int32)
31+
// - value string length (int32)
32+
// - returned position (int32)
33+
// - returned length (int32)
34+
// It returns an int32 value.
2735
func DefineHostFuncCacheSet(builder wazero.HostModuleBuilder) {
2836
builder.NewFunctionBuilder().
2937
WithGoModuleFunction(cacheSet,
@@ -83,7 +91,11 @@ var cacheSet = api.GoModuleFunc(func(ctx context.Context, module api.Module, par
8391
})
8492

8593

86-
// DefineHostFuncCacheGet defines a host function
94+
// DefineHostFuncCacheGet defines the Go function that calls the cacheGet function
95+
// to get the value of a given key. The function takes in four parameters: the
96+
// position of the key, the length of the key, the position of the returned value,
97+
// and the length of the returned value. It returns an integer that represents
98+
// the success or failure of the function call.
8799
func DefineHostFuncCacheGet(builder wazero.HostModuleBuilder) {
88100
builder.NewFunctionBuilder().
89101
WithGoModuleFunction(cacheGet,
@@ -136,8 +148,12 @@ var cacheGet = api.GoModuleFunc(func(ctx context.Context, module api.Module, par
136148

137149
})
138150

139-
140-
// DefineHostFuncCacheDel defines a host function
151+
// DefineHostFuncCacheDel defines a Go function that deletes a cache entry.
152+
//
153+
// Parameters:
154+
// - builder: a wazero.HostModuleBuilder object.
155+
//
156+
// Returns: nothing.
141157
func DefineHostFuncCacheDel(builder wazero.HostModuleBuilder) {
142158
builder.NewFunctionBuilder().
143159
WithGoModuleFunction(cacheDel,
@@ -186,10 +202,9 @@ var cacheDel = api.GoModuleFunc(func(ctx context.Context, module api.Module, par
186202

187203
})
188204

189-
190-
191-
192-
// DefineHostFuncCacheKeys defines a host function
205+
// DefineHostFuncCacheKeys defines the host function hostCacheKeys which takes in
206+
// filter position, filter length, returned position, and returned length as
207+
// parameters of type i32 and returns an i32.
193208
func DefineHostFuncCacheKeys(builder wazero.HostModuleBuilder) {
194209
builder.NewFunctionBuilder().
195210
WithGoModuleFunction(cacheKeys,

‎hostfunc.print.go

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ var printString = api.GoModuleFunc(func(ctx context.Context, module api.Module,
2828
})
2929

3030

31-
// DefineHostFuncPrint defines a host function
31+
// DefineHostFuncPrint defines the hostPrintString function which takes in a
32+
// string position and string length as parameters, and returns an integer.
33+
//
34+
// builder: The HostModuleBuilder object.
35+
//
36+
// Returns: None.
3237
func DefineHostFuncPrint(builder wazero.HostModuleBuilder) {
3338
// hostPrintString
3439
builder.NewFunctionBuilder().
@@ -40,3 +45,4 @@ func DefineHostFuncPrint(builder wazero.HostModuleBuilder) {
4045
[]api.ValueType{api.ValueTypeI32}).
4146
Export("hostPrintString")
4247
}
48+
// DefineHostFuncPrint defines a host function

0 commit comments

Comments
 (0)