Support EventRecorder

examples/advanced/main.go

@@ -28,6 +28,7 @@ import (
 	"sigs.k8s.io/kube-scheduler-wasm-extension/examples/advanced/plugin"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/config"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/enqueue"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/klog"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/prescore"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/score"
@@ -41,7 +42,7 @@ func main() {
 	//
 	// The real implementations, such as `config.Get()` use Wasm host functions
 	// (go:wasmimport), which cannot be tested with `tinygo test -target=wasi`.
-	plugin, err := plugin.New(klog.Get(), config.Get())
+	plugin, err := plugin.New(klog.Get(), config.Get(), eventrecorder.Get())
 	if err != nil {
 		panic(err)
 	}

examples/advanced/plugin/plugin.go

@@ -33,6 +33,7 @@ import (
 
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+	eventrecorder "sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder/api"
 	klog "sigs.k8s.io/kube-scheduler-wasm-extension/guest/klog/api"
 )
 
@@ -49,8 +50,9 @@ import (
 //   - The reverse field inverts the score. For example, when `reverse == true`
 //     a numeric match gets a results in a lower score than a match.
 type NodeNumber struct {
-	reverse bool
-	klog    klog.Klog
+	reverse       bool
+	klog          klog.Klog
+	eventrecorder eventrecorder.EventRecorder
 }
 
 const (
@@ -77,9 +79,11 @@ func (pl *NodeNumber) PreScore(state api.CycleState, pod proto.Pod, _ proto.Node
 
 	podnum, ok := lastNumber(pod.Spec().GetNodeName())
 	if !ok {
+		pl.eventrecorder.Eventf(pod, nil, "PreScore", "not match lastNumber", "Skip", "")
 		return nil // return success even if its suffix is non-number.
 	}
 
+	pl.eventrecorder.Eventf(pod, nil, "PreScore", "match lastNumber", "Continue", "")
 	state.Write(preScoreStateKey, &preScoreState{podSuffixNumber: podnum})
 	return nil
 }
@@ -127,15 +131,15 @@ func lastNumber(str string) (uint8, bool) {
 //
 // Note: This accepts config instead of implicitly calling config.Get for
 // testing.
-func New(klog klog.Klog, jsonConfig []byte) (*NodeNumber, error) {
+func New(klog klog.Klog, jsonConfig []byte, eventrecorder eventrecorder.EventRecorder) (*NodeNumber, error) {
 	var args nodeNumberArgs
 	if jsonConfig != nil {
 		if err := json.Unmarshal(jsonConfig, &args); err != nil {
 			return nil, fmt.Errorf("decode arg into NodeNumberArgs: %w", err)
 		}
 		klog.Info("NodeNumberArgs is successfully applied")
 	}
-	return &NodeNumber{klog: klog, reverse: args.Reverse}, nil
+	return &NodeNumber{klog: klog, reverse: args.Reverse, eventrecorder: eventrecorder}, nil
 }
 
 type nodeNumberArgs struct {

examples/advanced/plugin/plugin_test.go

@@ -21,6 +21,7 @@ import (
 
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+	eventrecorderapi "sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder/api"
 	klogapi "sigs.k8s.io/kube-scheduler-wasm-extension/guest/klog/api"
 	protoapi "sigs.k8s.io/kube-scheduler-wasm-extension/kubernetes/proto/api"
 )
@@ -52,7 +53,7 @@ func Test_NodeNumber(t *testing.T) {
 				expectedMatch = !expectedMatch
 			}
 			t.Run(name, func(t *testing.T) {
-				plugin := &NodeNumber{klog: klogapi.UnimplementedKlog{}, reverse: reverse}
+				plugin := &NodeNumber{klog: klogapi.UnimplementedKlog{}, reverse: reverse, eventrecorder: eventrecorderapi.UnimplementedEventRecorder{}}
 				state := testCycleState{}
 
 				status := plugin.PreScore(state, tc.pod, nil)
@@ -144,6 +145,18 @@ func (t testPod) GetNamespace() string {
 	return ""
 }
 
+func (t testPod) GetApiVersion() string {
+	return ""
+}
+
+func (t testPod) GetKind() string {
+	return "pod"
+}
+
+func (t testPod) GetResourceVersion() string {
+	return "v1"
+}
+
 func (t testPod) Spec() *protoapi.PodSpec {
 	nodeName := t.nodeName
 	return &protoapi.PodSpec{NodeName: &nodeName}

examples/nodenumber/main.go

@@ -25,21 +25,31 @@ import (
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/config"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/klog"
+	klogapi "sigs.k8s.io/kube-scheduler-wasm-extension/guest/klog/api"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/plugin"
 )
 
 // main is compiled to a WebAssembly function named "_start", called by the
 // wasm scheduler plugin during initialization.
 func main() {
+	p, err := New(klog.Get(), config.Get())
+	if err != nil {
+		panic(err)
+	}
+	plugin.Set(p)
+}
+
+func New(klog klogapi.Klog, jsonConfig []byte) (api.Plugin, error) {
 	var args nodeNumberArgs
-	if jsonConfig := config.Get(); jsonConfig != nil {
+	if jsonConfig != nil {
 		if err := json.Unmarshal(jsonConfig, &args); err != nil {
 			panic(fmt.Errorf("decode arg into NodeNumberArgs: %w", err))
 		}
 		klog.Info("NodeNumberArgs is successfully applied")
 	}
-	plugin.Set(&NodeNumber{reverse: args.Reverse})
+	return &NodeNumber{reverse: args.Reverse}, nil
 }
 
 // NodeNumber is an example plugin that favors nodes that share a numerical
@@ -82,13 +92,16 @@ func (pl *NodeNumber) EventsToRegister() []api.ClusterEvent {
 
 // PreScore implements api.PreScorePlugin
 func (pl *NodeNumber) PreScore(state api.CycleState, pod proto.Pod, _ proto.NodeList) *api.Status {
+	recorder := eventrecorder.Get()
+
 	klog.InfoS("execute PreScore on NodeNumber plugin", "pod", klog.KObj(pod))
 
 	podnum, ok := lastNumber(pod.Spec().GetNodeName())
 	if !ok {
+		recorder.Eventf(pod, nil, "PreScore", "not match lastNumber", "Skip", "")
 		return nil // return success even if its suffix is non-number.
 	}
-
+	recorder.Eventf(pod, nil, "PreScore", "match lastNumber", "Continue", "")
 	state.Write(preScoreStateKey, &preScoreState{podSuffixNumber: podnum})
 	return nil
 }

examples/nodenumber/main_test.go

@@ -53,7 +53,6 @@ func Test_NodeNumber(t *testing.T) {
 			t.Run(name, func(t *testing.T) {
 				plugin := &NodeNumber{reverse: reverse}
 				state := testCycleState{}
-
 				status := plugin.PreScore(state, tc.pod, nil)
 				if status != nil {
 					t.Fatalf("unexpected status: %v", status)
@@ -143,6 +142,18 @@ func (t testPod) GetNamespace() string {
 	return ""
 }
 
+func (t testPod) GetApiVersion() string {
+	return ""
+}
+
+func (t testPod) GetKind() string {
+	return "pod"
+}
+
+func (t testPod) GetResourceVersion() string {
+	return "v1"
+}
+
 func (t testPod) Spec() *protoapi.PodSpec {
 	nodeName := t.nodeName
 	return &protoapi.PodSpec{NodeName: &nodeName}

guest/api/proto/proto.go

@@ -19,18 +19,28 @@ package proto
 
 import api "sigs.k8s.io/kube-scheduler-wasm-extension/kubernetes/proto/api"
 
+type KObject interface {
+	Metadata
+
+	GetKind() string
+	GetApiVersion() string
+}
+
 // Metadata are fields on top-level types, used for logging and metrics.
 type Metadata interface {
 	GetUid() string
 	GetName() string
 	GetNamespace() string
+	GetResourceVersion() string
 }
 
 type Node interface {
 	Metadata
 
 	Spec() *api.NodeSpec
 	Status() *api.NodeStatus
+	GetKind() string
+	GetApiVersion() string
 }
 
 type NodeList interface {
@@ -42,4 +52,6 @@ type Pod interface {
 
 	Spec() *api.PodSpec
 	Status() *api.PodStatus
+	GetKind() string
+	GetApiVersion() string
 }

guest/eventrecorder/api/eventrecorder.go

@@ -0,0 +1,33 @@
+/*
+   Copyright 2023 The Kubernetes Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package api
+
+import (
+	proto "sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+)
+
+// EventRecorder is a recorder that sends events to the host environment via eventrecorder.eventf.
+type EventRecorder interface {
+	// Eventf calls EventRecorder.Eventf.
+	Eventf(regarding proto.KObject, related proto.KObject, eventtype, reason, action, note string)
+}
+
+type UnimplementedEventRecorder struct{}
+
+// Eventf implements events.EventRecorder.Eventf()
+func (UnimplementedEventRecorder) Eventf(regarding proto.KObject, related proto.KObject, eventtype, reason, action, note string) {
+}

guest/eventrecorder/api/eventrecorder_test.go

@@ -0,0 +1,36 @@
+/*
+   Copyright 2023 The Kubernetes Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package api_test
+
+import (
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder/api"
+)
+
+var (
+	eventrecorder api.EventRecorder = api.UnimplementedEventRecorder{}
+	pod           proto.Pod
+	node          proto.Node
+)
+
+func ExampleEventRecorder() {
+	eventrecorder.Eventf(pod, pod, "event", "reason", "action", "note")
+	eventrecorder.Eventf(node, node, "event", "reason", "action", "note")
+
+	// Output:
+	//
+}

guest/eventrecorder/eventrecorder.go

@@ -0,0 +1,53 @@
+/*
+   Copyright 2023 The Kubernetes Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package eventrecorder
+
+import (
+	"encoding/json"
+	"runtime"
+
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder/api"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder/internal"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/internal/mem"
+)
+
+func Get() api.EventRecorder {
+	return eventRecorderInstance
+}
+
+var eventRecorderInstance api.EventRecorder = &internal.EventRecorder{
+	EventfFn: EventfFn,
+}
+
+func EventfFn(msg internal.EventMessage) {
+	jsonByte, err := json.Marshal(msg)
+	if err != nil {
+		panic(err)
+	}
+	jsonStr := string(jsonByte)
+	ptr, size := mem.StringToPtr(jsonStr)
+	eventf(ptr, size)
+	runtime.KeepAlive(jsonStr)
+}
+
+// Eventf is a convenience that calls the same method documented on api.Eventf.
+//
+// Note: See Info for unit test and benchmarking impact.
+func Eventf(regarding proto.KObject, related proto.KObject, eventtype, reason, action, note string) {
+	eventRecorderInstance.Eventf(regarding, related, eventtype, reason, action, note)
+}

guest/eventrecorder/eventrecorder_test.go

@@ -0,0 +1,31 @@
+/*
+   Copyright 2023 The Kubernetes Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package eventrecorder_test
+
+import (
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/api/proto"
+	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/eventrecorder"
+)
+
+var pod proto.Pod
+
+func ExampleEventf() {
+	eventrecorder.Eventf(pod, pod, "event", "reason", "action", "note")
+
+	// Output:
+	//
+}

guest/eventrecorder/imports.go

@@ -0,0 +1,22 @@
+//go:build tinygo.wasm
+
+/*
+   Copyright 2023 The Kubernetes Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package eventrecorder
+
+//go:wasmimport k8s.io/scheduler handle.eventrecorder.eventf
+func eventf(ptr, size uint32)