issue-205:

added comments for menu handlers methods and changed function name to better fit function workings.

internal/handlers/handlerservice.go

@@ -111,7 +111,7 @@ func (ls *LocalHandlerService) GetHandler(accountService remote.AccountServiceIn
 	ls.DbRs.AddLocalFunc("set_voucher", ussdHandlers.SetVoucher)
 	ls.DbRs.AddLocalFunc("get_voucher_details", ussdHandlers.GetVoucherDetails)
 	ls.DbRs.AddLocalFunc("reset_valid_pin", ussdHandlers.ResetValidPin)
-	ls.DbRs.AddLocalFunc("check_pin_mismatch", ussdHandlers.CheckPinMisMatch)
+	ls.DbRs.AddLocalFunc("check_pin_mismatch", ussdHandlers.CheckBlockedNumPinMisMatch)
 	ls.DbRs.AddLocalFunc("validate_blocked_number", ussdHandlers.ValidateBlockedNumber)
 	ls.DbRs.AddLocalFunc("retrieve_blocked_number", ussdHandlers.RetrieveBlockedNumber)
 	ls.DbRs.AddLocalFunc("reset_unregistered_number", ussdHandlers.ResetUnregisteredNumber)

internal/handlers/ussd/menuhandler.go

@@ -39,7 +39,7 @@ const (
 	pinPattern = `^\d{4}$`
 )
 
-// isValidPIN checks whether the given input is a 4 digit number
+// checks whether the given input is a 4 digit number
 func isValidPIN(pin string) bool {
 	match, _ := regexp.MatchString(pinPattern, pin)
 	return match
@@ -80,6 +80,7 @@ type Handlers struct {
 	profile        *models.Profile
 }
 
+// NewHandlers creates a new instance of the Handlers struct with the provided dependencies.
 func NewHandlers(appFlags *asm.FlagParser, userdataStore db.Db, adminstore *utils.AdminStore, accountService remote.AccountServiceInterface) (*Handlers, error) {
 	if userdataStore == nil {
 		return nil, fmt.Errorf("cannot create handler with nil userdata store")
@@ -103,6 +104,7 @@ func NewHandlers(appFlags *asm.FlagParser, userdataStore db.Db, adminstore *util
 	return h, nil
 }
 
+// WithPersister sets persister instance to the handlers.
 func (h *Handlers) WithPersister(pe *persist.Persister) *Handlers {
 	if h.pe != nil {
 		panic("persister already set")
@@ -111,6 +113,7 @@ func (h *Handlers) WithPersister(pe *persist.Persister) *Handlers {
 	return h
 }
 
+// Init initializes the handler for a new session.
 func (h *Handlers) Init(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var r resource.Result
 	if h.pe == nil {
@@ -149,7 +152,7 @@ func (h *Handlers) Exit() {
 	h.pe = nil
 }
 
-// SetLanguage sets the language across the menu
+// SetLanguage sets the language across the menu.
 func (h *Handlers) SetLanguage(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -173,6 +176,7 @@ func (h *Handlers) SetLanguage(ctx context.Context, sym string, input []byte) (r
 	return res, nil
 }
 
+// createAccountNoExist handles the account creation when no existing account is present for the session and stores associated data in the user data store.
 func (h *Handlers) createAccountNoExist(ctx context.Context, sessionId string, res *resource.Result) error {
 	flag_account_created, _ := h.flagManager.GetFlag("flag_account_created")
 	r, err := h.accountService.CreateAccount(ctx)
@@ -205,9 +209,9 @@ func (h *Handlers) createAccountNoExist(ctx context.Context, sessionId string, r
 	return nil
 }
 
-// CreateAccount checks if any account exists on the JSON data file, and if not
+// CreateAccount checks if any account exists on the JSON data file, and if not,
 // creates an account on the API,
-// sets the default values and flags
+// sets the default values and flags.
 func (h *Handlers) CreateAccount(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -231,19 +235,22 @@ func (h *Handlers) CreateAccount(ctx context.Context, sym string, input []byte)
 	return res, nil
 }
 
-func (h *Handlers) CheckPinMisMatch(ctx context.Context, sym string, input []byte) (resource.Result, error) {
+// CheckBlockedNumPinMisMatch checks if the provided PIN matches a temporary PIN stored for a blocked number.
+func (h *Handlers) CheckBlockedNumPinMisMatch(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	res := resource.Result{}
 	flag_pin_mismatch, _ := h.flagManager.GetFlag("flag_pin_mismatch")
 	sessionId, ok := ctx.Value("SessionId").(string)
 	if !ok {
 		return res, fmt.Errorf("missing session")
 	}
+	// Get blocked number from storage.
 	store := h.userdataStore
 	blockedNumber, err := store.ReadEntry(ctx, sessionId, common.DATA_BLOCKED_NUMBER)
 	if err != nil {
 		logg.ErrorCtxf(ctx, "failed to read blockedNumber entry with", "key", common.DATA_BLOCKED_NUMBER, "error", err)
 		return res, err
 	}
+	// Get temporary PIN for the blocked number.
 	temporaryPin, err := store.ReadEntry(ctx, string(blockedNumber), common.DATA_TEMPORARY_VALUE)
 	if err != nil {
 		logg.ErrorCtxf(ctx, "failed to read temporaryPin entry with", "key", common.DATA_TEMPORARY_VALUE, "error", err)
@@ -257,6 +264,7 @@ func (h *Handlers) CheckPinMisMatch(ctx context.Context, sym string, input []byt
 	return res, nil
 }
 
+// VerifyNewPin checks if a new PIN meets the required format criteria.
 func (h *Handlers) VerifyNewPin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	res := resource.Result{}
 	_, ok := ctx.Value("SessionId").(string)
@@ -265,7 +273,7 @@ func (h *Handlers) VerifyNewPin(ctx context.Context, sym string, input []byte) (
 	}
 	flag_valid_pin, _ := h.flagManager.GetFlag("flag_valid_pin")
 	pinInput := string(input)
-	// Validate that the PIN is a 4-digit number
+	// Validate that the PIN is a 4-digit number.
 	if isValidPIN(pinInput) {
 		res.FlagSet = append(res.FlagSet, flag_valid_pin)
 	} else {
@@ -275,9 +283,9 @@ func (h *Handlers) VerifyNewPin(ctx context.Context, sym string, input []byte) (
 	return res, nil
 }
 
-// SaveTemporaryPin saves the valid PIN input to the DATA_TEMPORARY_VALUE
+// SaveTemporaryPin saves the valid PIN input to the DATA_TEMPORARY_VALUE,
 // during the account creation process
-// and during the change PIN process
+// and during the change PIN process.
 func (h *Handlers) SaveTemporaryPin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -290,7 +298,7 @@ func (h *Handlers) SaveTemporaryPin(ctx context.Context, sym string, input []byt
 	flag_incorrect_pin, _ := h.flagManager.GetFlag("flag_incorrect_pin")
 	accountPIN := string(input)
 
-	// Validate that the PIN is a 4-digit number
+	// Validate that the PIN is a 4-digit number.
 	if !isValidPIN(accountPIN) {
 		res.FlagSet = append(res.FlagSet, flag_incorrect_pin)
 		return res, nil
@@ -306,6 +314,7 @@ func (h *Handlers) SaveTemporaryPin(ctx context.Context, sym string, input []byt
 	return res, nil
 }
 
+// SaveOthersTemporaryPin allows authorized users to set temporary PINs for blocked numbers.
 func (h *Handlers) SaveOthersTemporaryPin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -316,12 +325,14 @@ func (h *Handlers) SaveOthersTemporaryPin(ctx context.Context, sym string, input
 		return res, fmt.Errorf("missing session")
 	}
 	temporaryPin := string(input)
+	// First, we retrieve the blocked number associated with this session
 	blockedNumber, err := store.ReadEntry(ctx, sessionId, common.DATA_BLOCKED_NUMBER)
 	if err != nil {
 		logg.ErrorCtxf(ctx, "failed to read blockedNumber entry with", "key", common.DATA_BLOCKED_NUMBER, "error", err)
 		return res, err
 	}
 
+	// Then we save the temporary PIN for that blocked number
 	err = store.WriteEntry(ctx, string(blockedNumber), common.DATA_TEMPORARY_VALUE, []byte(temporaryPin))
 	if err != nil {
 		logg.ErrorCtxf(ctx, "failed to write temporaryPin entry with", "key", common.DATA_TEMPORARY_VALUE, "value", temporaryPin, "error", err)
@@ -331,6 +342,7 @@ func (h *Handlers) SaveOthersTemporaryPin(ctx context.Context, sym string, input
 	return res, nil
 }
 
+// ConfirmPinChange validates user's new PIN. If input matches the temporary PIN, saves it as the new account PIN.
 func (h *Handlers) ConfirmPinChange(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -350,6 +362,7 @@ func (h *Handlers) ConfirmPinChange(ctx context.Context, sym string, input []byt
 	} else {
 		res.FlagSet = append(res.FlagSet, flag_pin_mismatch)
 	}
+	// If matched, save the confirmed PIN as the new account PIN
 	err = store.WriteEntry(ctx, sessionId, common.DATA_ACCOUNT_PIN, []byte(temporaryPin))
 	if err != nil {
 		logg.ErrorCtxf(ctx, "failed to write temporaryPin entry with", "key", common.DATA_ACCOUNT_PIN, "value", temporaryPin, "error", err)
@@ -360,7 +373,7 @@ func (h *Handlers) ConfirmPinChange(ctx context.Context, sym string, input []byt
 
 // VerifyCreatePin checks whether the confirmation PIN is similar to the temporary PIN
 // If similar, it sets the USERFLAG_PIN_SET flag and writes the account PIN allowing the user
-// to access the main menu
+// to access the main menu.
 func (h *Handlers) VerifyCreatePin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -395,7 +408,7 @@ func (h *Handlers) VerifyCreatePin(ctx context.Context, sym string, input []byte
 	return res, nil
 }
 
-// codeFromCtx retrieves language codes from the context that can be used for handling translations
+// retrieves language codes from the context that can be used for handling translations.
 func codeFromCtx(ctx context.Context) string {
 	var code string
 	if ctx.Value("Language") != nil {
@@ -729,7 +742,7 @@ func (h *Handlers) ResetIncorrectPin(ctx context.Context, sym string, input []by
 	return res, nil
 }
 
-// Setback sets the flag_back_set flag when the navigation is back
+// Setback sets the flag_back_set flag when the navigation is back.
 func (h *Handlers) SetBack(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	//TODO:
@@ -742,7 +755,7 @@ func (h *Handlers) SetBack(ctx context.Context, sym string, input []byte) (resou
 }
 
 // CheckAccountStatus queries the API using the TrackingId and sets flags
-// based on the account status
+// based on the account status.
 func (h *Handlers) CheckAccountStatus(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -782,7 +795,7 @@ func (h *Handlers) CheckAccountStatus(ctx context.Context, sym string, input []b
 	return res, nil
 }
 
-// Quit displays the Thank you message and exits the menu
+// Quit displays the Thank you message and exits the menu.
 func (h *Handlers) Quit(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -797,7 +810,7 @@ func (h *Handlers) Quit(ctx context.Context, sym string, input []byte) (resource
 	return res, nil
 }
 
-// QuitWithHelp displays helpline information then exits the menu
+// QuitWithHelp displays helpline information then exits the menu.
 func (h *Handlers) QuitWithHelp(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -812,7 +825,7 @@ func (h *Handlers) QuitWithHelp(ctx context.Context, sym string, input []byte) (
 	return res, nil
 }
 
-// VerifyYob verifies the length of the given input
+// VerifyYob verifies the length of the given input.
 func (h *Handlers) VerifyYob(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -834,7 +847,7 @@ func (h *Handlers) VerifyYob(ctx context.Context, sym string, input []byte) (res
 	return res, nil
 }
 
-// ResetIncorrectYob resets the incorrect date format flag after a new attempt
+// ResetIncorrectYob resets the incorrect date format flag after a new attempt.
 func (h *Handlers) ResetIncorrectYob(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -844,7 +857,7 @@ func (h *Handlers) ResetIncorrectYob(ctx context.Context, sym string, input []by
 }
 
 // CheckBalance retrieves the balance of the active voucher and sets
-// the balance as the result content
+// the balance as the result content.
 func (h *Handlers) CheckBalance(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -894,9 +907,12 @@ func (h *Handlers) CheckBalance(ctx context.Context, sym string, input []byte) (
 	return res, nil
 }
 
+// FetchCommunityBalance retrieves and displays the balance for community accounts in user's preferred language.
 func (h *Handlers) FetchCommunityBalance(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
+	// retrieve the language code from the context
 	code := codeFromCtx(ctx)
+	// Initialize the localization system with the appropriate translation directory
 	l := gotext.NewLocale(translationDir, code)
 	l.AddDomain("default")
 	//TODO:
@@ -905,6 +921,10 @@ func (h *Handlers) FetchCommunityBalance(ctx context.Context, sym string, input
 	return res, nil
 }
 
+// ResetOthersPin handles the PIN reset process for other users' accounts by:
+// 1. Retrieving the blocked phone number from the session
+// 2. Fetching the temporary PIN associated with that number
+// 3. Updating the account PIN with the temporary PIN
 func (h *Handlers) ResetOthersPin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	store := h.userdataStore
@@ -930,6 +950,8 @@ func (h *Handlers) ResetOthersPin(ctx context.Context, sym string, input []byte)
 	return res, nil
 }
 
+// ResetUnregisteredNumber clears the unregistered number flag in the system,
+// indicating that a number's registration status should no longer be marked as unregistered.
 func (h *Handlers) ResetUnregisteredNumber(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	flag_unregistered_number, _ := h.flagManager.GetFlag("flag_unregistered_number")
@@ -937,6 +959,8 @@ func (h *Handlers) ResetUnregisteredNumber(ctx context.Context, sym string, inpu
 	return res, nil
 }
 
+// ValidateBlockedNumber performs validation of phone numbers, specifically for blocked numbers in the system.
+// It checks phone number format and verifies registration status.
 func (h *Handlers) ValidateBlockedNumber(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -1065,7 +1089,7 @@ func (h *Handlers) ValidateRecipient(ctx context.Context, sym string, input []by
 }
 
 // TransactionReset resets the previous transaction data (Recipient and Amount)
-// as well as the invalid flags
+// as well as the invalid flags.
 func (h *Handlers) TransactionReset(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -1118,7 +1142,7 @@ func (h *Handlers) InviteValidRecipient(ctx context.Context, sym string, input [
 	return res, nil
 }
 
-// ResetTransactionAmount resets the transaction amount and invalid flag
+// ResetTransactionAmount resets the transaction amount and invalid flag.
 func (h *Handlers) ResetTransactionAmount(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -1248,7 +1272,7 @@ func (h *Handlers) RetrieveBlockedNumber(ctx context.Context, sym string, input
 	return res, nil
 }
 
-// GetSender returns the sessionId (phoneNumber)
+// GetSender returns the sessionId (phoneNumber).
 func (h *Handlers) GetSender(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -1262,7 +1286,7 @@ func (h *Handlers) GetSender(ctx context.Context, sym string, input []byte) (res
 	return res, nil
 }
 
-// GetAmount retrieves the amount from teh Gdbm Db
+// GetAmount retrieves the amount from teh Gdbm Db.
 func (h *Handlers) GetAmount(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -1286,7 +1310,7 @@ func (h *Handlers) GetAmount(ctx context.Context, sym string, input []byte) (res
 	return res, nil
 }
 
-// InitiateTransaction calls the TokenTransfer and returns a confirmation based on the result
+// InitiateTransaction calls the TokenTransfer and returns a confirmation based on the result.
 func (h *Handlers) InitiateTransaction(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -1336,6 +1360,8 @@ func (h *Handlers) InitiateTransaction(ctx context.Context, sym string, input []
 	return res, nil
 }
 
+// GetCurrentProfileInfo retrieves specific profile fields based on the current state of the USSD session.
+// Uses flag management system to track profile field status and handle menu navigation.
 func (h *Handlers) GetCurrentProfileInfo(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var profileInfo []byte
@@ -1355,6 +1381,7 @@ func (h *Handlers) GetCurrentProfileInfo(ctx context.Context, sym string, input
 	if !ok {
 		return res, fmt.Errorf("missing session")
 	}
+	// Extract the field name from the state machine position.
 	sm, _ := h.st.Where()
 	parts := strings.SplitN(sm, "_", 2)
 	filename := parts[1]
@@ -1447,6 +1474,7 @@ func (h *Handlers) GetCurrentProfileInfo(ctx context.Context, sym string, input
 	return res, nil
 }
 
+// GetProfileInfo provides a comprehensive view of a user's profile.
 func (h *Handlers) GetProfileInfo(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var defaultValue string
@@ -1515,7 +1543,7 @@ func (h *Handlers) GetProfileInfo(ctx context.Context, sym string, input []byte)
 }
 
 // SetDefaultVoucher retrieves the current vouchers
-// and sets the first as the default voucher, if no active voucher is set
+// and sets the first as the default voucher, if no active voucher is set.
 func (h *Handlers) SetDefaultVoucher(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	var err error
@@ -1600,7 +1628,7 @@ func (h *Handlers) SetDefaultVoucher(ctx context.Context, sym string, input []by
 }
 
 // CheckVouchers retrieves the token holdings from the API using the "PublicKey" and stores
-// them to gdbm
+// them to gdbm.
 func (h *Handlers) CheckVouchers(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -1672,7 +1700,7 @@ func (h *Handlers) CheckVouchers(ctx context.Context, sym string, input []byte)
 	return res, nil
 }
 
-// GetVoucherList fetches the list of vouchers and formats them
+// GetVoucherList fetches the list of vouchers and formats them.
 func (h *Handlers) GetVoucherList(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -1689,7 +1717,7 @@ func (h *Handlers) GetVoucherList(ctx context.Context, sym string, input []byte)
 }
 
 // ViewVoucher retrieves the token holding and balance from the subprefixDB
-// and displays it to the user for them to select it
+// and displays it to the user for them to select it.
 func (h *Handlers) ViewVoucher(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -1730,7 +1758,7 @@ func (h *Handlers) ViewVoucher(ctx context.Context, sym string, input []byte) (r
 	return res, nil
 }
 
-// SetVoucher retrieves the temp voucher data and sets it as the active data
+// SetVoucher retrieves the temp voucher data and sets it as the active data.
 func (h *Handlers) SetVoucher(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 
@@ -1756,7 +1784,7 @@ func (h *Handlers) SetVoucher(ctx context.Context, sym string, input []byte) (re
 	return res, nil
 }
 
-// GetVoucherDetails retrieves the voucher details
+// GetVoucherDetails retrieves the voucher details.
 func (h *Handlers) GetVoucherDetails(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	store := h.userdataStore
@@ -1788,7 +1816,7 @@ func (h *Handlers) GetVoucherDetails(ctx context.Context, sym string, input []by
 	return res, nil
 }
 
-// CheckTransactions retrieves the transactions from the API using the "PublicKey" and stores to prefixDb
+// CheckTransactions retrieves the transactions from the API using the "PublicKey" and stores to prefixDb.
 func (h *Handlers) CheckTransactions(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -1846,7 +1874,7 @@ func (h *Handlers) CheckTransactions(ctx context.Context, sym string, input []by
 	return res, nil
 }
 
-// GetTransactionsList fetches the list of transactions and formats them
+// GetTransactionsList fetches the list of transactions and formats them.
 func (h *Handlers) GetTransactionsList(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -1909,7 +1937,7 @@ func (h *Handlers) GetTransactionsList(ctx context.Context, sym string, input []
 }
 
 // ViewTransactionStatement retrieves the transaction statement
-// and displays it to the user
+// and displays it to the user.
 func (h *Handlers) ViewTransactionStatement(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)
@@ -1957,6 +1985,7 @@ func (h *Handlers) ViewTransactionStatement(ctx context.Context, sym string, inp
 	return res, nil
 }
 
+// handles bulk updates of profile information.
 func (h *Handlers) insertProfileItems(ctx context.Context, sessionId string, res *resource.Result) error {
 	var err error
 	store := h.userdataStore
@@ -1993,7 +2022,7 @@ func (h *Handlers) insertProfileItems(ctx context.Context, sessionId string, res
 	return nil
 }
 
-// UpdateAllProfileItems  is used to persist all the  new profile information and setup  the required profile flags
+// UpdateAllProfileItems  is used to persist all the  new profile information and setup  the required profile flags.
 func (h *Handlers) UpdateAllProfileItems(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
 	sessionId, ok := ctx.Value("SessionId").(string)