SugarDB/sugardb/modules.go

// Copyright 2024 Kelvin Clement Mwinuka
//
// 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 sugardb

import (
	"context"
	"errors"
	"fmt"
	"io"
	"net"
	"strings"

	"github.com/echovault/sugardb/internal"
	"github.com/echovault/sugardb/internal/clock"
	"github.com/echovault/sugardb/internal/constants"
)

func (server *SugarDB) getCommand(cmd string) (internal.Command, error) {
	server.commandsRWMut.RLock()
	defer server.commandsRWMut.RUnlock()
	for _, command := range server.commands {
		if strings.EqualFold(command.Command, cmd) {
			return command, nil
		}
	}
	return internal.Command{}, fmt.Errorf("command %s not supported", cmd)
}

func (server *SugarDB) getHandlerFuncParams(ctx context.Context, cmd []string, conn *net.Conn) internal.HandlerFuncParams {
	return internal.HandlerFuncParams{
		Context:               ctx,
		Command:               cmd,
		Connection:            conn,
		KeysExist:             server.keysExist,
		GetKeys:               server.getKeys,
		GetExpiry:             server.getExpiry,
		GetHashExpiry:         server.getHashExpiry,
		GetValues:             server.getValues,
		SetValues:             server.setValues,
		SetExpiry:             server.setExpiry,
		SetHashExpiry:         server.setHashExpiry,
		TakeSnapshot:          server.takeSnapshot,
		GetLatestSnapshotTime: server.getLatestSnapshotTime,
		RewriteAOF:            server.rewriteAOF,
		LoadModule:            server.LoadModule,
		UnloadModule:          server.UnloadModule,
		ListModules:           server.ListModules,
		GetPubSub:             server.getPubSub,
		GetACL:                server.getACL,
		GetAllCommands:        server.getCommands,
		GetClock:              server.getClock,
		Flush:                 server.Flush,
		RandomKey:             server.randomKey,
		DBSize:                server.dbSize,
		TouchKey:              server.updateKeysInCache,
		GetObjectFrequency:    server.getObjectFreq,
		GetObjectIdleTime:     server.getObjectIdleTime,
		SwapDBs:               server.SwapDBs,
		GetServerInfo:         server.GetServerInfo,
		AddScript:             server.AddScript,
		DeleteKey: func(ctx context.Context, key string) error {
			server.storeLock.Lock()
			defer server.storeLock.Unlock()
			return server.deleteKey(ctx, key)
		},
		GetConnectionInfo: func(conn *net.Conn) internal.ConnectionInfo {
			server.connInfo.mut.RLock()
			defer server.connInfo.mut.RUnlock()
			return server.connInfo.tcpClients[conn]
		},
		SetConnectionInfo: func(conn *net.Conn, clientname string, protocol int, database int) {
			server.connInfo.mut.Lock()
			defer server.connInfo.mut.Unlock()

			info := server.connInfo.tcpClients[conn]

			// Set protocol.
			info.Protocol = protocol

			// Set connection name.
			if clientname != "" {
				info.Name = clientname
			}

			// If the database index does not exist, create the new database.
			server.storeLock.Lock()
			if server.store[database] == nil {
				server.createDatabase(database)
			}
			server.storeLock.Unlock()

			// Set database index for the current connection.
			info.Database = database

			server.connInfo.tcpClients[conn] = info
		},
	}
}

func (server *SugarDB) handleCommand(ctx context.Context, message []byte, conn *net.Conn, replay bool, embedded bool) ([]byte, error) {
	// Prepare context before processing the command.
	server.connInfo.mut.RLock()
	if embedded && !replay {
		// The call is triggered via the embedded API.
		// Add embedded connection info to the context of the request.
		ctx = context.WithValue(ctx, "ConnectionName", server.connInfo.embedded.Name)
		ctx = context.WithValue(ctx, "Protocol", server.connInfo.embedded.Protocol)
		ctx = context.WithValue(ctx, "Database", server.connInfo.embedded.Database)
	} else {
		// The call is triggered by a TCP connection.
		// Add TCP connection info to the context of the request.
		ctx = context.WithValue(ctx, "ConnectionName", server.connInfo.tcpClients[conn].Name)
		ctx = context.WithValue(ctx, "Protocol", server.connInfo.tcpClients[conn].Protocol)
		ctx = context.WithValue(ctx, "Database", server.connInfo.tcpClients[conn].Database)
	}
	server.connInfo.mut.RUnlock()

	cmd, err := internal.Decode(message)
	if err != nil {
		return nil, err
	}

	if len(cmd) == 0 {
		return nil, errors.New("empty command")
	}

	// If quit command is passed, EOF error.
	if strings.EqualFold(cmd[0], "quit") {
		return nil, io.EOF
	}

	command, err := server.getCommand(cmd[0])
	if err != nil {
		return nil, err
	}

	synchronize := command.Sync
	handler := command.HandlerFunc

	sc, err := internal.GetSubCommand(command, cmd)
	if err != nil {
		return nil, err
	}
	subCommand, ok := sc.(internal.SubCommand)
	if ok {
		synchronize = subCommand.Sync
		handler = subCommand.HandlerFunc
	}

	if conn != nil && server.acl != nil && !embedded {
		// Authorize connection if it's provided and if ACL module is present and the embedded parameter is false.
		// Skip the authorization if the command is being executed from embedded mode.
		if err = server.acl.AuthorizeConnection(conn, cmd, command, subCommand); err != nil {
			return nil, err
		}
	}

	// If the command is a write command, wait for state copy to finish.
	if internal.IsWriteCommand(command, subCommand) {
		for {
			if !server.stateCopyInProgress.Load() {
				server.stateMutationInProgress.Store(true)
				break
			}
		}
	}

	if !server.isInCluster() || !synchronize {
		res, err := handler(server.getHandlerFuncParams(ctx, cmd, conn))
		if err != nil {
			return nil, err
		}

		if internal.IsWriteCommand(command, subCommand) && !replay {
			server.connInfo.mut.RLock()
			server.aofEngine.LogCommand(server.connInfo.tcpClients[conn].Database, message)
			server.connInfo.mut.RUnlock()
		}

		server.stateMutationInProgress.Store(false)

		return res, err
	}

	// Handle other commands that need to be synced across the cluster
	if server.raft.IsRaftLeader() {
		var res []byte
		res, err = server.raftApplyCommand(ctx, cmd)
		if err != nil {
			return nil, err
		}
		return res, err
	}

	// Forward message to leader and return immediate OK response
	if server.config.ForwardCommand {
		server.memberList.ForwardDataMutation(ctx, message)
		return []byte(constants.OkResponse), nil
	}

	return nil, errors.New("not cluster leader, cannot carry out command")
}

func (server *SugarDB) getCommands() []internal.Command {
	return server.commands
}

func (server *SugarDB) getACL() interface{} {
	return server.acl
}

func (server *SugarDB) getPubSub() interface{} {
	return server.pubSub
}

func (server *SugarDB) getClock() clock.Clock {
	return server.clock
}