feat: load mapping file

Author: gsanchietti

README.md

@@ -17,6 +17,7 @@ The proxy is configured via environment variables. Minimal required env:
 - `PROXY_PORT` (optional): port to listen on (default: `8080`)
 - `AS_USER_ID` (optional): the user ID of the Application Service bot (default: `@_acrobits_proxy:matrix.example`)
 - `LOGLEVEL` (optional): logging verbosity level - `DEBUG`, `INFO`, `WARNING`, `CRITICAL` (default: `INFO`)
+- `MAPPING_FILE` (optional): path to a JSON file containing SMS-to-Matrix mappings to load at startup
 
 Building and running
 
@@ -44,6 +45,36 @@ The `LOGLEVEL` environment variable controls the verbosity of application logs:
 
 For debugging mapping and API issues, set `LOGLEVEL=DEBUG` to see detailed trace information.
 
+### Loading Mappings from File
+
+You can pre-load SMS-to-Matrix mappings at startup by providing a `MAPPING_FILE` environment variable pointing to a JSON file. This is useful for initializing the proxy with a set of known mappings.
+
+The JSON file should be an array of mapping objects:
+
+```json
+[
+  {
+    "sms_number": "91201",
+    "matrix_id": "@giacomo:synapse.gs.nethserver.net",
+    "room_id": "!giacomo-room:synapse.gs.nethserver.net"
+  },
+  {
+    "sms_number": "91202",
+    "matrix_id": "@mario:synapse.gs.nethserver.net",
+    "room_id": "!mario-room:synapse.gs.nethserver.net"
+  }
+]
+```
+
+Usage:
+
+```bash
+export MAPPING_FILE="/path/to/mappings.json"
+./matrix2acrobits
+```
+
+The loaded mappings will be logged at startup with the message: `mappings loaded from file count=N file=/path/to/mappings.json`
+
 ## Extra info
 
 - [Deploying with NS8](docs/DEPLOY_NS8.md)

docs/DEPLOY_NS8.md

@@ -103,6 +103,21 @@ Run the container:
 podman run --rm --replace --name matrix2acrobits --network host -e MATRIX_HOMESERVER_URL=https://synapse.gs.nethserver.net -e SUPER_ADMIN_TOKEN=secret -e PROXY_PORT=8080 -e AS_USER_ID=@_acrobits_proxy:synapse.gs.nethserver.net ghcr.io/nethesis/matrix2acrobits
 ```
 
+
+Then run the container with the mapping file mounted:
+```
+podman run --rm --replace --name matrix2acrobits --network host \
+  -v /etc/matrix2acrobits/mappings.json:/mappings.json:ro \
+  -e MATRIX_HOMESERVER_URL=https://synapse.gs.nethserver.net \
+  -e SUPER_ADMIN_TOKEN=secret \
+  -e PROXY_PORT=8080 \
+  -e AS_USER_ID=@_acrobits_proxy:synapse.gs.nethserver.net \
+  -e MAPPING_FILE=/mappings.json \
+  ghcr.io/nethesis/matrix2acrobits
+```
+
+The container will log the loaded mappings at startup: `mappings loaded from file count=N file=/mappings.json`
+
 Configure traefik to route /m2a to the proxy:
 ```
 api-cli run set-route  --agent module/traefik1 --data '{"instance": "matrix1-m2a", "name":"synapse-m2a","host":"synapse.gs.nethserver.net","path":"/m2a","url":"http://localhost:8080","lets_encrypt":true, "strip_prefix": true}'
@@ -138,19 +153,19 @@ curl -s -X POST   https://synapse.gs.nethserver.net/m2a/api/client/send_message
 ```
 
 
-Map SMS number (201) to Matrix user (giacomo):
+Map SMS number (91201) to Matrix user (giacomo):
 ```
-curl -v -X POST "http://127.0.0.1:8080/api/internal/map_sms_to_matrix"   -H "Content-Type: application/json"   -H "X-Super-Admin-Token: secret"   -d '{
-  "sms_number": "201",
+curl "http://127.0.0.1:8080/api/internal/map_sms_to_matrix"   -H "Content-Type: application/json"   -H "X-Super-Admin-Token: secret"   -d '{
+  "sms_number": "91201",
   "matrix_id": "@giacomo:synapse.gs.nethserver.net",
   "room_id": "!giacomo-room:synapse.gs.nethserver.net"
 }'
 ```
 
-Map SMS number (202) to Matrix user (mario):
+Map SMS number (91202) to Matrix user (mario):
 ```
-curl -v -X POST "http://127.0.0.1:8080/api/internal/map_sms_to_matrix"   -H "Content-Type: application/json"   -H "X-Super-Admin-Token: secret"   -d '{
-  "sms_number": "202",
+curl "http://127.0.0.1:8080/api/internal/map_sms_to_matrix"   -H "Content-Type: application/json"   -H "X-Super-Admin-Token: secret"   -d '{
+  "sms_number": "91202",
   "matrix_id": "@mario:synapse.gs.nethserver.net",
   "room_id": "!mario-room:synapse.gs.nethserver.net"
 }'
@@ -161,22 +176,32 @@ Retrieve current mappings:
 curl "http://127.0.0.1:8080/api/internal/map_sms_to_matrix" -H "X-Super-Admin-Token: secret"
 ```
 
-Send message using mapped SMS number (201) - Giacomo to Mario:
+Send message using mapped SMS number (91201) - Giacomo to Mario:
 ```
 curl -s -X POST   https://synapse.gs.nethserver.net/m2a/api/client/send_message   -H "Content-Type: application/json"   -d '{
     "from": "@giacomo:synapse.gs.nethserver.net",
-    "sms_to": "202",
+    "sms_to": "91202",
     "sms_body": "Hello Mario — this is Giacomo (curl test using mapped number)",
     "content_type": "text/plain"
   }'
 ```
 
-Send message using mapped SMS number (202) - Mario to Giacomo:
+Send message using mapped SMS number (91202) - Mario to Giacomo:
 ```
 curl -s -X POST   https://synapse.gs.nethserver.net/m2a/api/client/send_message   -H "Content-Type: application/json"   -d '{
     "from": "@mario:synapse.gs.nethserver.net",
-    "sms_to": "201",
+    "sms_to": "91201",
     "sms_body": "Hello Giacomo — this is Mario reply (curl test using mapped number)",
     "content_type": "text/plain"
   }'
+```
+
+Send message using mapped numbers - Giacomo to Mario:
+```
+curl -s -X POST   https://synapse.gs.nethserver.net/m2a/api/client/send_message   -H "Content-Type: application/json"   -d '{
+    "from": "91201",
+    "sms_to": "91202",
+    "sms_body": "Hello Mario — this is Giacomo (curl test using both mapped numbers)",
+    "content_type": "text/plain"
+  }'
 ```

main.go

@@ -68,6 +68,14 @@ func main() {
 	svc := service.NewMessageService(matrixClient)
 	api.RegisterRoutes(e, svc, adminToken)
 
+	// Load mappings from file if MAPPING_FILE env var is set
+	mappingFile := os.Getenv("MAPPING_FILE")
+	if mappingFile != "" {
+		if err := svc.LoadMappingsFromFile(mappingFile); err != nil {
+			logger.Error().Err(err).Str("file", mappingFile).Msg("failed to load mappings from file")
+		}
+	}
+
 	logger.Info().Str("port", port).Msg("starting server")
 	if err := e.Start(":" + port); err != nil {
 		logger.Fatal().Err(err).Msg("server stopped")

service/messages.go

@@ -2,8 +2,10 @@ package service
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 	"sync"
 	"time"
@@ -284,6 +286,43 @@ func (s *MessageService) SaveMapping(req *models.MappingRequest) (*models.Mappin
 	return s.buildMappingResponse(entry), nil
 }
 
+// LoadMappingsFromFile loads mappings from a JSON file in the format:
+//
+//	[
+//	  {"sms_number": "91201", "matrix_id": "@giacomo:synapse.gs.nethserver.net", "room_id": "!giacomo-room:synapse.gs.nethserver.net"},
+//	  {"sms_number": "91202", "matrix_id": "@mario:synapse.gs.nethserver.net", "room_id": "!mario-room:synapse.gs.nethserver.net"}
+//	]
+//
+// This is typically called at startup if MAPPING_FILE environment variable is set.
+func (s *MessageService) LoadMappingsFromFile(filePath string) error {
+	data, err := os.ReadFile(filePath)
+	if err != nil {
+		return fmt.Errorf("failed to read mapping file: %w", err)
+	}
+
+	var mappingArray []models.MappingRequest
+	if err := json.Unmarshal(data, &mappingArray); err != nil {
+		return fmt.Errorf("failed to parse mapping file: %w", err)
+	}
+
+	for _, req := range mappingArray {
+		if req.SMSNumber == "" {
+			logger.Warn().Msg("skipping mapping with empty sms_number")
+			continue
+		}
+		entry := mappingEntry{
+			SMSNumber: req.SMSNumber,
+			MatrixID:  req.MatrixID,
+			RoomID:    id.RoomID(req.RoomID),
+			UpdatedAt: s.now(),
+		}
+		s.setMapping(entry)
+	}
+
+	logger.Info().Int("count", len(mappingArray)).Str("file", filePath).Msg("mappings loaded from file")
+	return nil
+}
+
 func (s *MessageService) buildMappingResponse(entry mappingEntry) *models.MappingResponse {
 	return &models.MappingResponse{
 		SMSNumber: entry.SMSNumber,

service/messages_test.go

@@ -1,6 +1,7 @@
 package service
 
 import (
+	"os"
 	"testing"
 
 	"github.com/nethesis/matrix2acrobits/models"
@@ -265,3 +266,100 @@ func TestIsPhoneNumber(t *testing.T) {
 		})
 	}
 }
+
+func TestLoadMappingsFromFile(t *testing.T) {
+	// Create a temporary JSON file with test mappings in array format
+	tmpFile, err := os.CreateTemp("", "mappings_*.json")
+	assert.NoError(t, err)
+	defer os.Remove(tmpFile.Name())
+
+	// Write test data in array format
+	testData := `[
+  {
+    "sms_number": "91201",
+    "matrix_id": "@giacomo:example.com",
+    "room_id": "!room1:example.com"
+  },
+  {
+    "sms_number": "91202",
+    "matrix_id": "@mario:example.com",
+    "room_id": "!room2:example.com"
+  }
+]`
+	_, err = tmpFile.WriteString(testData)
+	assert.NoError(t, err)
+	tmpFile.Close()
+
+	// Create a message service
+	svc := NewMessageService(nil)
+
+	// Load mappings from file
+	err = svc.LoadMappingsFromFile(tmpFile.Name())
+	assert.NoError(t, err)
+
+	// Verify mappings were loaded
+	mappings, err := svc.ListMappings()
+	assert.NoError(t, err)
+	assert.Len(t, mappings, 2)
+
+	// Check specific mappings
+	mapping1, err := svc.LookupMapping("91201")
+	assert.NoError(t, err)
+	assert.Equal(t, "@giacomo:example.com", mapping1.MatrixID)
+	assert.Equal(t, "!room1:example.com", mapping1.RoomID)
+
+	mapping2, err := svc.LookupMapping("91202")
+	assert.NoError(t, err)
+	assert.Equal(t, "@mario:example.com", mapping2.MatrixID)
+	assert.Equal(t, "!room2:example.com", mapping2.RoomID)
+}
+
+func TestLoadMappingsFromFile_LegacyFormat(t *testing.T) {
+	// Create a temporary JSON file with test mappings in legacy format
+	tmpFile, err := os.CreateTemp("", "mappings_legacy_*.json")
+	assert.NoError(t, err)
+	defer os.Remove(tmpFile.Name())
+
+	// Write test data in legacy format (object with phone numbers as keys)
+	testData := `{
+    "91201": "@giacomo:example.com",
+    "91202": "@mario:example.com"
+}`
+	_, err = tmpFile.WriteString(testData)
+	assert.NoError(t, err)
+	tmpFile.Close()
+
+	// Create a message service
+	svc := NewMessageService(nil)
+
+	// Load mappings from file - should fail since we only support extended format now
+	err = svc.LoadMappingsFromFile(tmpFile.Name())
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "failed to parse mapping file")
+}
+
+func TestLoadMappingsFromFile_FileNotFound(t *testing.T) {
+	svc := NewMessageService(nil)
+
+	err := svc.LoadMappingsFromFile("/nonexistent/file.json")
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "failed to read mapping file")
+}
+
+func TestLoadMappingsFromFile_InvalidJSON(t *testing.T) {
+	// Create a temporary file with invalid JSON
+	tmpFile, err := os.CreateTemp("", "invalid_*.json")
+	assert.NoError(t, err)
+	defer os.Remove(tmpFile.Name())
+
+	// Write invalid JSON
+	_, err = tmpFile.WriteString("{ invalid json }")
+	assert.NoError(t, err)
+	tmpFile.Close()
+
+	svc := NewMessageService(nil)
+
+	err = svc.LoadMappingsFromFile(tmpFile.Name())
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "failed to parse mapping file")
+}