Migrate data. Update changelog.

Author: brocaar

cmd/loraserver/main.go

@@ -28,6 +28,7 @@ import (
 	"github.com/brocaar/loraserver/internal/backend/controller"
 	"github.com/brocaar/loraserver/internal/backend/gateway"
 	"github.com/brocaar/loraserver/internal/common"
+	"github.com/brocaar/loraserver/internal/migration"
 	"github.com/brocaar/loraserver/internal/uplink"
 	"github.com/brocaar/lorawan"
 	"github.com/brocaar/lorawan/band"
@@ -83,6 +84,11 @@ func run(c *cli.Context) error {
 
 	lsCtx := mustGetContext(netID, c)
 
+	// migrate old node-session keys to new layout
+	if err = migration.MigrateNodeSessionDevAddrDevEUI(lsCtx.RedisPool); err != nil {
+		log.Fatalf("node-session migration error: %s", err)
+	}
+
 	// start the api server
 	log.WithFields(log.Fields{
 		"bind":     c.String("bind"),

docs/changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.15.0
+
+**Features:**
+
+* Node-sessions are now stored by `DevEUI`. Before the node-sessions were stored
+  by `DevAddr`. In case a single `DevAddr` is used by multiple nodes, the
+  `NwkSKey` is used for retrieving the corresponding node-session.
+
+*Note:* Data will be automatically migrated into the new format. As this process
+is not reversible it is recommended to make a backup of the Redis database before
+upgrading.
+
 ## 0.14.1
 
 **Bugfixes:**

internal/migration/node_session.go

@@ -0,0 +1,69 @@
+package migration
+
+import (
+	"bytes"
+	"encoding/gob"
+	"fmt"
+
+	log "github.com/Sirupsen/logrus"
+	"github.com/brocaar/loraserver/internal/session"
+	"github.com/garyburd/redigo/redis"
+)
+
+// MigrateNodeSessionDevAddrDevEUI migrates the node-sessions from DevAddr to
+// DevEUI identifier.
+func MigrateNodeSessionDevAddrDevEUI(p *redis.Pool) error {
+	c := p.Get()
+	defer c.Close()
+
+	keys, err := redis.Strings(c.Do("KEYS", "node_session_????????")) // only match DevAddr (e.g. 01020304)
+	if err != nil {
+		return fmt.Errorf("get keys error: %s", err)
+	}
+
+	var errCount int
+
+	for _, key := range keys {
+		if err := migrateNodeSession(p, key); err != nil {
+			log.WithField("key", key).Errorf("migrate node-session error: %s", err)
+			errCount++
+		}
+	}
+
+	log.WithFields(log.Fields{
+		"migrated": len(keys) - errCount,
+		"errors":   errCount,
+	}).Infof("migrated node-sessions to new format")
+	return nil
+}
+
+func migrateNodeSession(p *redis.Pool, key string) error {
+	var ns session.NodeSession
+
+	c := p.Get()
+	defer c.Close()
+
+	// get node-session from old key
+	val, err := redis.Bytes(c.Do("GET", key))
+	if err != nil {
+		return fmt.Errorf("get key error: %s", err)
+	}
+	err = gob.NewDecoder(bytes.NewReader(val)).Decode(&ns)
+	if err != nil {
+		return fmt.Errorf("decode node-session error: %s", err)
+	}
+
+	// save node-session (using new key layout)
+	err = session.SaveNodeSession(p, ns)
+	if err != nil {
+		return fmt.Errorf("save node-session error: %s", err)
+	}
+
+	// delete the old key
+	_, err = redis.Int(c.Do("DEL", key))
+	if err != nil {
+		return fmt.Errorf("delete key error: %s", err)
+	}
+
+	return nil
+}

mkdocs.yml

@@ -14,7 +14,7 @@ pages:
   - changelog.md
 
 extra:
-  version: '0.14.1'
+  version: '0.15.0'
   github:
     download_release: true