sds-go-bindings/sds/sds.go

package sds

/*
	#cgo LDFLAGS: -L../third_party/nim-sds/build/ -lsds
	#cgo LDFLAGS: -L../third_party/nim-sds -Wl,-rpath,../third_party/nim-sds/build/

	#include "../third_party/nim-sds/library/libsds.h"
	#include <stdio.h>
	#include <stdlib.h>

	extern void globalEventCallback(int ret, char* msg, size_t len, void* userData);

	typedef struct {
		int ret;
		char* msg;
		size_t len;
		void* ffiWg;
	} Resp;

	static void* allocResp(void* wg) {
		Resp* r = calloc(1, sizeof(Resp));
		r->ffiWg = wg;
		return r;
	}

	static void freeResp(void* resp) {
		if (resp != NULL) {
			free(resp);
		}
	}

	static char* getMyCharPtr(void* resp) {
		if (resp == NULL) {
			return NULL;
		}
		Resp* m = (Resp*) resp;
		return m->msg;
	}

	static size_t getMyCharLen(void* resp) {
		if (resp == NULL) {
			return 0;
		}
		Resp* m = (Resp*) resp;
		return m->len;
	}

	static int getRet(void* resp) {
		if (resp == NULL) {
			return 0;
		}
		Resp* m = (Resp*) resp;
		return m->ret;
	}

	// resp must be set != NULL in case interest on retrieving data from the callback
	void GoCallback(int ret, char* msg, size_t len, void* resp);

	static void* cGoNewReliabilityManager(const char* channelId, void* resp) {
		// We pass NULL because we are not interested in retrieving data from this callback
		void* ret = NewReliabilityManager(channelId, (SdsCallBack) GoCallback, resp);
		return ret;
	}

	static void cGoSetEventCallback(void* rmCtx) {
		// The 'globalEventCallback' Go function is shared amongst all possible Reliability Manager instances.

		// Given that the 'globalEventCallback' is shared, we pass again the
		// rmCtx instance but in this case is needed to pick up the correct method
		// that will handle the event.

		// In other words, for every call libsds makes to globalEventCallback,
		// the 'userData' parameter will bring the context of the rm that registered
		// that globalEventCallback.

		// This technique is needed because cgo only allows to export Go functions and not methods.

		SetEventCallback(rmCtx, (SdsCallBack) globalEventCallback, rmCtx);
	}

	static void cGoCleanupReliabilityManager(void* rmCtx, void* resp) {
		CleanupReliabilityManager(rmCtx, (SdsCallBack) GoCallback, resp);
	}

	static void cGoResetReliabilityManager(void* rmCtx, void* resp) {
		ResetReliabilityManager(rmCtx, (SdsCallBack) GoCallback, resp);
	}

	static void cGoWrapOutgoingMessage(void* rmCtx,
									void* message,
                    				size_t messageLen,
                    				const char* messageId,
									void* resp) {
		WrapOutgoingMessage(rmCtx,
						message,
						messageLen,
						messageId,
						(SdsCallBack) GoCallback,
						resp);
	}
	static void cGoUnwrapReceivedMessage(void* rmCtx,
									void* message,
                    				size_t messageLen,
									void* resp) {
		UnwrapReceivedMessage(rmCtx,
						message,
						messageLen,
						(SdsCallBack) GoCallback,
						resp);
	}

	static void cGoMarkDependenciesMet(void* rmCtx,
									char** messageIDs,
                    				size_t count,
									void* resp) {
		UnwrapReceivedMessage(rmCtx,
						messageIDs,
						count,
						(SdsCallBack) GoCallback,
						resp);
	}

*/
import "C"
import (
	"encoding/json"
	"errors"
	"fmt"
	"strconv"
	"strings"
	"sync"
	"time"
	"unsafe"
)

const requestTimeout = 30 * time.Second

//export GoCallback
func GoCallback(ret C.int, msg *C.char, len C.size_t, resp unsafe.Pointer) {
	if resp != nil {
		m := (*C.Resp)(resp)
		m.ret = ret
		m.msg = msg
		m.len = len
		wg := (*sync.WaitGroup)(m.ffiWg)
		wg.Done()
	}
}

// ReliabilityManager represents an instance of a nim-sds ReliabilityManager
type ReliabilityManager struct {
	rmCtx     unsafe.Pointer
	channelId string
}

func NewReliabilityManager(channelId string) (*ReliabilityManager, error) {
	Debug("Creating new Reliability Manager")
	rm := &ReliabilityManager{
		channelId: channelId,
	}

	wg := sync.WaitGroup{}

	var cChannelId = C.CString(string(channelId))
	var resp = C.allocResp(unsafe.Pointer(&wg))

	defer C.free(unsafe.Pointer(cChannelId))
	defer C.freeResp(resp)

	if C.getRet(resp) != C.RET_OK {
		errMsg := C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
		Error("error NewReliabilityManager: %v", errMsg)
		return nil, errors.New(errMsg)
	}

	wg.Add(1)
	rm.rmCtx = C.cGoNewReliabilityManager(cChannelId, resp)
	wg.Wait()

	C.cGoSetEventCallback(rm.rmCtx)
	registerReliabilityManager(rm)

	Debug("Successfully created Reliability Manager")
	return rm, nil
}

// The event callback sends back the rm ctx to know to which
// rm is the event being emited for. Since we only have a global
// callback in the go side, We register all the rm's that we create
// so we can later obtain which instance of `ReliabilityManager` it should
// be invoked depending on the ctx received

var rmRegistry map[unsafe.Pointer]*ReliabilityManager

func init() {
	rmRegistry = make(map[unsafe.Pointer]*ReliabilityManager)
}

func registerReliabilityManager(rm *ReliabilityManager) {
	_, ok := rmRegistry[rm.rmCtx]
	if !ok {
		rmRegistry[rm.rmCtx] = rm
	}
}

func unregisterReliabilityManager(rm *ReliabilityManager) {
	delete(rmRegistry, rm.rmCtx)
}

//export globalEventCallback
func globalEventCallback(callerRet C.int, msg *C.char, len C.size_t, userData unsafe.Pointer) {
	if callerRet == C.RET_OK {
		eventStr := C.GoStringN(msg, C.int(len))
		rm, ok := rmRegistry[userData] // userData contains rm's ctx
		if ok {
			rm.OnEvent(eventStr)
		}
	} else {
		if len != 0 {
			errMsg := C.GoStringN(msg, C.int(len))
			Error("globalEventCallback retCode not ok, retCode: %v: %v", callerRet, errMsg)
		} else {
			Error("globalEventCallback retCode not ok, retCode: %v", callerRet)
		}
	}
}

type jsonEvent struct {
	EventType string `json:"eventType"`
}

func (rm *ReliabilityManager) OnEvent(eventStr string) {
	jsonEvent := jsonEvent{}
	err := json.Unmarshal([]byte(eventStr), &jsonEvent)
	if err != nil {
		Error("could not unmarshal sds event string: %v", err)

		return
	}

	switch jsonEvent.EventType {
	case "event 1":
		fmt.Println("-------- received event 1")
	case "event 2":
		fmt.Println("-------- received event 1")
	}
}

func (rm *ReliabilityManager) Cleanup() error {
	if rm == nil {
		err := errors.New("reliability manager is nil")
		Error("Failed to cleanup %v", err)
		return err
	}

	Debug("Cleaning up reliability manager")

	wg := sync.WaitGroup{}
	var resp = C.allocResp(unsafe.Pointer(&wg))
	defer C.freeResp(resp)

	wg.Add(1)
	C.cGoCleanupReliabilityManager(rm.rmCtx, resp)
	wg.Wait()

	if C.getRet(resp) == C.RET_OK {
		unregisterReliabilityManager(rm)
		Debug("Successfully cleaned up reliability manager")
		return nil
	}

	errMsg := "error CleanupReliabilityManager: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
	Error("Failed to cleanup reliability manager: %v", errMsg)

	return errors.New(errMsg)
}

func (rm *ReliabilityManager) Reset() error {
	if rm == nil {
		err := errors.New("reliability manager is nil")
		Error("Failed to reset %v", err)
		return err
	}

	Debug("Resetting reliability manager")

	wg := sync.WaitGroup{}
	var resp = C.allocResp(unsafe.Pointer(&wg))
	defer C.freeResp(resp)

	wg.Add(1)
	C.cGoResetReliabilityManager(rm.rmCtx, resp)
	wg.Wait()

	if C.getRet(resp) == C.RET_OK {
		Debug("Successfully resetted reliability manager")
		return nil
	}

	errMsg := "error ResetReliabilityManager: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
	Error("Failed to reset reliability manager: %v", errMsg)

	return errors.New(errMsg)
}

func (rm *ReliabilityManager) WrapOutgoingMessage(message []byte, messageId MessageID) ([]byte, error) {
	if rm == nil {
		err := errors.New("reliability manager is nil")
		Error("Failed to wrap outgoing message %v", err)
		return nil, err
	}

	Debug("Wraping outgoing message %v", messageId)

	wg := sync.WaitGroup{}
	var resp = C.allocResp(unsafe.Pointer(&wg))
	defer C.freeResp(resp)

	cMessageId := C.CString(string(messageId))
	defer C.free(unsafe.Pointer(cMessageId))

	var cMessagePtr unsafe.Pointer
	if len(message) > 0 {
		cMessagePtr = C.CBytes(message) // C.CBytes allocates memory that needs to be freed
		defer C.free(cMessagePtr)
	} else {
		cMessagePtr = nil
	}
	cMessageLen := C.size_t(len(message))

	wg.Add(1)
	C.cGoWrapOutgoingMessage(rm.rmCtx, cMessagePtr, cMessageLen, cMessageId, resp)
	wg.Wait()

	if C.getRet(resp) == C.RET_OK {
		resStr := C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
		if resStr == "" {
			Debug("Received empty res string for messageId: %v", messageId)
			return nil, nil
		}
		Debug("Successfully wrapped message %s", messageId)

		parts := strings.Split(resStr, ",")
		bytes := make([]byte, len(parts))

		for i, part := range parts {
			n, err := strconv.Atoi(strings.TrimSpace(part))
			if err != nil {
				panic(err)
			}
			bytes[i] = byte(n)
		}

		return bytes, nil
	}

	errMsg := "error WrapOutgoingMessage: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
	Error("Failed to wrap message %v: %v", messageId, errMsg)

	return nil, errors.New(errMsg)
}

func (rm *ReliabilityManager) UnwrapReceivedMessage(message []byte) (*UnwrappedMessage, error) {
	if rm == nil {
		err := errors.New("reliability manager is nil")
		Error("Failed to unwrap received message %v", err)
		return nil, err
	}

	wg := sync.WaitGroup{}
	var resp = C.allocResp(unsafe.Pointer(&wg))
	defer C.freeResp(resp)

	var cMessagePtr unsafe.Pointer
	if len(message) > 0 {
		cMessagePtr = C.CBytes(message) // C.CBytes allocates memory that needs to be freed
		defer C.free(cMessagePtr)
	} else {
		cMessagePtr = nil
	}
	cMessageLen := C.size_t(len(message))

	wg.Add(1)
	C.cGoUnwrapReceivedMessage(rm.rmCtx, cMessagePtr, cMessageLen, resp)
	wg.Wait()

	if C.getRet(resp) == C.RET_OK {
		resStr := C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
		if resStr == "" {
			Debug("Received empty res string")
			return nil, nil
		}
		Debug("Successfully unwrapped message")

		unwrappedMessage := UnwrappedMessage{}
		err := json.Unmarshal([]byte(resStr), &unwrappedMessage)
		if err != nil {
			Error("Failed to unmarshal unwrapped message")
			return nil, err
		}

		return &unwrappedMessage, nil
	}

	errMsg := "error UnwrapReceivedMessage: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
	Error("Failed to unwrap message: %v", errMsg)

	return nil, errors.New(errMsg)
}

// MarkDependenciesMet informs the library that dependencies are met
func (rm *ReliabilityManager) MarkDependenciesMet(messageIDs []MessageID) error {
	if rm == nil {
		err := errors.New("reliability manager is nil")
		Error("Failed to mark dependencies met %v", err)
		return err
	}

	if len(messageIDs) == 0 {
		return nil // Nothing to do
	}

	wg := sync.WaitGroup{}
	var resp = C.allocResp(unsafe.Pointer(&wg))
	defer C.freeResp(resp)

	// Convert Go string slice to C array of C strings (char**)
	cMessageIDs := make([]*C.char, len(messageIDs))
	for i, id := range messageIDs {
		cMessageIDs[i] = C.CString(string(id))
		defer C.free(unsafe.Pointer(cMessageIDs[i])) // Ensure each CString is freed
	}

	// Create a pointer (**C.char) to the first element of the slice
	var cMessageIDsPtr **C.char
	if len(cMessageIDs) > 0 {
		cMessageIDsPtr = &cMessageIDs[0]
	} else {
		cMessageIDsPtr = nil // Handle empty slice case
	}

	wg.Add(1)
	// Pass the pointer variable (cMessageIDsPtr) directly, which is of type **C.char
	C.cGoMarkDependenciesMet(rm.rmCtx, cMessageIDsPtr, C.size_t(len(messageIDs)), resp)
	wg.Wait()

	if C.getRet(resp) == C.RET_OK {
		Debug("Successfully marked dependencies as met")
		return nil
	}

	errMsg := "error MarkDependenciesMet: " + C.GoStringN(C.getMyCharPtr(resp), C.int(C.getMyCharLen(resp)))
	Error("Failed to mark dependencies as met: %v", errMsg)

	return errors.New(errMsg)
}