added documentation lines

Reviewed-on: #22

go.mod

@@ -5,7 +5,7 @@ go 1.23.4
 require (
 	git.defalsify.org/vise.git v0.2.3-0.20250205173834-d1f6647211ac
 	git.grassecon.net/grassrootseconomics/common v0.0.0-20250121134736-ba8cbbccea7d
-	git.grassecon.net/grassrootseconomics/sarafu-api v0.0.0-20250123142805-2181388f5bf1
+	git.grassecon.net/grassrootseconomics/sarafu-api v0.9.0-beta.1.0.20250206112944-31eb30de0f69
 	git.grassecon.net/grassrootseconomics/visedriver v0.9.0-beta.1.0.20250204132347-1eb0b1555244
 	git.grassecon.net/grassrootseconomics/visedriver-africastalking v0.0.0-20250129070628-5a539172c694
 	github.com/alecthomas/assert/v2 v2.2.2

go.sum

@@ -2,8 +2,8 @@ git.defalsify.org/vise.git v0.2.3-0.20250205173834-d1f6647211ac h1:f/E0ZTclVfMEn
 git.defalsify.org/vise.git v0.2.3-0.20250205173834-d1f6647211ac/go.mod h1:jyBMe1qTYUz3mmuoC9JQ/TvFeW0vTanCUcPu3H8p4Ck=
 git.grassecon.net/grassrootseconomics/common v0.0.0-20250121134736-ba8cbbccea7d h1:5mzLas+jxTUtusOKx4XvU+n2QvrV/mH17MnJRy46siQ=
 git.grassecon.net/grassrootseconomics/common v0.0.0-20250121134736-ba8cbbccea7d/go.mod h1:wgQJZGIS6QuNLHqDhcsvehsbn5PvgV7aziRebMnJi60=
-git.grassecon.net/grassrootseconomics/sarafu-api v0.0.0-20250123142805-2181388f5bf1 h1:BJHfokTHzrw9QjQ+4s2HmSER0iBPuE7byW5oQC2zLIQ=
-git.grassecon.net/grassrootseconomics/sarafu-api v0.0.0-20250123142805-2181388f5bf1/go.mod h1:gOn89ipaDcDvmQXRMQYKUqcw/sJcwVOPVt2eC6Geip8=
+git.grassecon.net/grassrootseconomics/sarafu-api v0.9.0-beta.1.0.20250206112944-31eb30de0f69 h1:cbBpm9uNJak58MpFpNXJuvgCmz+A8kquXr9har4expg=
+git.grassecon.net/grassrootseconomics/sarafu-api v0.9.0-beta.1.0.20250206112944-31eb30de0f69/go.mod h1:gOn89ipaDcDvmQXRMQYKUqcw/sJcwVOPVt2eC6Geip8=
 git.grassecon.net/grassrootseconomics/visedriver v0.9.0-beta.1.0.20250204132347-1eb0b1555244 h1:BXotWSKg04U97sf/xeWJuUTSVgKk2aEK+5BtBrnafXQ=
 git.grassecon.net/grassrootseconomics/visedriver v0.9.0-beta.1.0.20250204132347-1eb0b1555244/go.mod h1:6B6ByxXOiRY0NR7K02Bf3fEu7z+2c/6q8PFVNjC5G8w=
 git.grassecon.net/grassrootseconomics/visedriver-africastalking v0.0.0-20250129070628-5a539172c694 h1:DjJlBSz0S13acft5XZDWk7ZYnzElym0xLMYEVgyNJ+E=

handlers/application/menuhandler.go

@@ -102,14 +102,12 @@ func NewMenuHandlers(appFlags *FlagManager, userdataStore db.Db, accountService
 	return h, nil
 }
 
-// WithPersister sets persister instance to the handlers.
-// func (h *MenuHandlers) WithPersister(pe *persist.Persister) *MenuHandlers {
+// SetPersister sets persister instance to the handlers.
 func (h *MenuHandlers) SetPersister(pe *persist.Persister) {
 	if h.pe != nil {
 		panic("persister already set")
 	}
 	h.pe = pe
-	//return h
 }
 
 // Init initializes the handler for a new session.
@@ -488,13 +486,6 @@ func (h *MenuHandlers) ConfirmPinChange(ctx context.Context, sym string, input [
 		return res, err
 	}
 
-	// clear the temporary value as it has been used
-	err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-	if err != nil {
-		logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-		return res, err
-	}
-
 	return res, nil
 }
 
@@ -535,13 +526,6 @@ func (h *MenuHandlers) ResetOthersPin(ctx context.Context, sym string, input []b
 		return res, err
 	}
 
-	// clear the temporary value as it has been used
-	err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-	if err != nil {
-		logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-		return res, err
-	}
-
 	return res, nil
 }
 
@@ -717,12 +701,6 @@ func (h *MenuHandlers) SaveFirstname(ctx context.Context, sym string, input []by
 		if err != nil {
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_firstname_set)
 	} else {
 		if firstNameSet {
@@ -767,12 +745,6 @@ func (h *MenuHandlers) SaveFamilyname(ctx context.Context, sym string, input []b
 			logg.ErrorCtxf(ctx, "failed to write familyName entry with", "key", storedb.DATA_FAMILY_NAME, "value", temporaryFamilyName, "error", err)
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_familyname_set)
 	} else {
 		if familyNameSet {
@@ -847,12 +819,6 @@ func (h *MenuHandlers) SaveYob(ctx context.Context, sym string, input []byte) (r
 			logg.ErrorCtxf(ctx, "failed to write yob entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", temporaryYob, "error", err)
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_yob_set)
 	} else {
 		if yobSet {
@@ -896,12 +862,6 @@ func (h *MenuHandlers) SaveLocation(ctx context.Context, sym string, input []byt
 			logg.ErrorCtxf(ctx, "failed to write location entry with", "key", storedb.DATA_LOCATION, "value", temporaryLocation, "error", err)
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_location_set)
 	} else {
 		if locationSet {
@@ -947,12 +907,6 @@ func (h *MenuHandlers) SaveGender(ctx context.Context, sym string, input []byte)
 			logg.ErrorCtxf(ctx, "failed to write gender entry with", "key", storedb.DATA_GENDER, "value", gender, "error", err)
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_gender_set)
 	} else {
 		if genderSet {
@@ -998,12 +952,6 @@ func (h *MenuHandlers) SaveOfferings(ctx context.Context, sym string, input []by
 			logg.ErrorCtxf(ctx, "failed to write offerings entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", offerings, "error", err)
 			return res, err
 		}
-		// clear the temporary value as it has been used
-		err = store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-		if err != nil {
-			logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-			return res, err
-		}
 		res.FlagSet = append(res.FlagSet, flag_offerings_set)
 	} else {
 		if offeringsSet {
@@ -1684,12 +1632,6 @@ func (h *MenuHandlers) InviteValidRecipient(ctx context.Context, sym string, inp
 	// res.Content = l.Get("Your invitation to %s to join Sarafu Network has been sent.",  string(recipient))
 
 	res.Content = l.Get("Your invite request for %s to Sarafu Network failed. Please try again later.", string(recipient))
-	// clear the temporary value as it has been used
-	err := store.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
-	if err != nil {
-		logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
-		return res, err
-	}
 	return res, nil
 }
 
@@ -2363,6 +2305,7 @@ func (h *MenuHandlers) ViewTransactionStatement(ctx context.Context, sym string,
 	return res, nil
 }
 
+// persistInitialLanguageCode receives an initial language code and persists it to the store
 func (h *MenuHandlers) persistInitialLanguageCode(ctx context.Context, sessionId string, code string) error {
 	store := h.userdataStore
 	_, err := store.ReadEntry(ctx, sessionId, storedb.DATA_INITIAL_LANGUAGE_CODE)
@@ -2395,6 +2338,8 @@ func (h *MenuHandlers) persistLanguageCode(ctx context.Context, code string) err
 	return h.persistInitialLanguageCode(ctx, sessionId, code)
 }
 
+// constructAccountAlias retrieves and alias based on the first and family name
+// and writes the result in DATA_ACCOUNT_ALIAS
 func (h *MenuHandlers) constructAccountAlias(ctx context.Context) error {
 	var alias string
 	store := h.userdataStore
@@ -2438,3 +2383,22 @@ func (h *MenuHandlers) constructAccountAlias(ctx context.Context) error {
 	}
 	return nil
 }
+
+// ClearTemporaryValue empties the DATA_TEMPORARY_VALUE at the main menu to prevent
+// previously stored data from being accessed
+func (h *MenuHandlers) ClearTemporaryValue(ctx context.Context, sym string, input []byte) (resource.Result, error) {
+	var res resource.Result
+	sessionId, ok := ctx.Value("SessionId").(string)
+	if !ok {
+		return res, fmt.Errorf("missing session")
+	}
+	userStore := h.userdataStore
+
+	// clear the temporary value at the start
+	err := userStore.WriteEntry(ctx, sessionId, storedb.DATA_TEMPORARY_VALUE, []byte(""))
+	if err != nil {
+		logg.ErrorCtxf(ctx, "failed to clear DATA_TEMPORARY_VALUE entry with", "key", storedb.DATA_TEMPORARY_VALUE, "value", "empty", "error", err)
+		return res, err
+	}
+	return res, nil
+}

handlers/local.go

@@ -6,12 +6,11 @@ import (
 
 	"git.defalsify.org/vise.git/db"
 	"git.defalsify.org/vise.git/engine"
+	"git.defalsify.org/vise.git/logging"
 	"git.defalsify.org/vise.git/persist"
 	"git.defalsify.org/vise.git/resource"
-	"git.defalsify.org/vise.git/logging"
 
 	"git.grassecon.net/grassrootseconomics/sarafu-api/remote"
-//	sarafu_engine "git.grassecon.net/grassrootseconomics/sarafu-vise/engine"
 	"git.grassecon.net/grassrootseconomics/sarafu-vise/handlers/application"
 )
 
@@ -67,7 +66,6 @@ func (ls *LocalHandlerService) GetHandler(accountService remote.AccountService)
 	if err != nil {
 		return nil, err
 	}
-	//appHandlers = appHandlers.WithPersister(ls.Pe)
 	appHandlers.SetPersister(ls.Pe)
 	ls.DbRs.AddLocalFunc("check_blocked_status", appHandlers.CheckBlockedStatus)
 	ls.DbRs.AddLocalFunc("set_language", appHandlers.SetLanguage)
@@ -125,6 +123,7 @@ func (ls *LocalHandlerService) GetHandler(accountService remote.AccountService)
 	ls.DbRs.AddLocalFunc("update_all_profile_items", appHandlers.UpdateAllProfileItems)
 	ls.DbRs.AddLocalFunc("set_back", appHandlers.SetBack)
 	ls.DbRs.AddLocalFunc("show_blocked_account", appHandlers.ShowBlockedAccount)
+	ls.DbRs.AddLocalFunc("clear_temporary_value", appHandlers.ClearTemporaryValue)
 	ls.first = appHandlers.Init
 
 	return appHandlers, nil

profile/profile_test.go

@@ -0,0 +1,42 @@
+package profile
+
+import (
+	"testing"
+
+	"github.com/alecthomas/assert/v2"
+	"github.com/stretchr/testify/require"
+)
+
+func TestInsertOrShift(t *testing.T) {
+	tests := []struct {
+		name     string
+		profile Profile
+		index   int
+		value   string
+		expected []string
+	}{
+		{
+			name:     "Insert within range",
+			profile:  Profile{ProfileItems: []string{"A", "B", "C"}, Max: 5},
+			index:    1,
+			value:    "X",
+			expected: []string{"A", "X"},
+		},
+		{
+			name:     "Insert beyond range",
+			profile:  Profile{ProfileItems: []string{"A"}, Max: 5},
+			index:    3,
+			value:    "Y",
+			expected: []string{"A", "0", "0", "Y"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			p := tt.profile
+			p.InsertOrShift(tt.index, tt.value)
+			require.NotNil(t, p.ProfileItems)
+			assert.Equal(t, tt.expected, p.ProfileItems)
+		})
+	}
+}

services/registration/main.vis

@@ -1,3 +1,5 @@
+LOAD clear_temporary_value 2
+RELOAD clear_temporary_value
 LOAD set_default_voucher 8
 RELOAD set_default_voucher
 LOAD check_vouchers 10

services/registration/pin_management.vis

@@ -1,4 +1,3 @@
-LOAD confirm_pin_change 7
 LOAD set_back 6
 LOAD authorize_account 5
 LOAD reset_allow_update 4