[#1800] Clean all IPNS records from IPFS datastore cache

Author: placer14

repo/migration.go

@@ -46,6 +46,7 @@ var (
 		migrations.Migration023{},
 		migrations.Migration024{},
 		migrations.Migration025{},
+		migrations.Migration026{},
 	}
 )
 

repo/migrations/Migration026.go

@@ -0,0 +1,72 @@
+package migrations
+
+import (
+	"fmt"
+
+	"github.com/ipfs/go-ipfs/repo/fsrepo"
+	ds "gx/ipfs/QmUadX5EcvrBmxAV9sE7wUWtWSqxns5K84qKJBixmcT1w9/go-datastore"
+	dsq "gx/ipfs/QmUadX5EcvrBmxAV9sE7wUWtWSqxns5K84qKJBixmcT1w9/go-datastore/query"
+	ipnspb "gx/ipfs/QmUwMnKKjH3JwGKNVZ3TcP37W93xzqNA4ECFFiMo6sXkkc/go-ipns/pb"
+	"gx/ipfs/QmddjPSGZb3ieihSseFeCfVRpZzcqczPNsD2DvarSwnjJB/gogo-protobuf/proto"
+)
+
+var cleanIPNSMigrationNumber = 26 // should match name
+
+type (
+	cleanIPNSRecordsFromDatastore struct{}
+	Migration026                  struct {
+		cleanIPNSRecordsFromDatastore
+	}
+)
+
+// Should we ever update these packages (which functionally changes their
+// behavior) the migrations should be made into a no-op.
+func (cleanIPNSRecordsFromDatastore) Up(repoPath, databasePassword string, testnetEnabled bool) error {
+	r, err := fsrepo.Open(repoPath)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err := r.Close(); err != nil {
+			log.Errorf("closing repo: %s", err.Error())
+		}
+	}()
+
+	resultCh, err := r.Datastore().Query(dsq.Query{Prefix: "/ipns/"})
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err := resultCh.Close(); err != nil {
+			log.Errorf("closing result channel: %s", err.Error())
+		}
+	}()
+
+	results, err := resultCh.Rest()
+	if err != nil {
+		return err
+	}
+
+	log.Debugf("found %d IPNS records to cull...", len(results))
+	for _, rawResult := range results {
+		rec := new(ipnspb.IpnsEntry)
+		if err = proto.Unmarshal(rawResult.Value, rec); err != nil {
+			log.Warningf("failed unmarshaling record (%s): %s", rawResult.Key, err.Error())
+			if err := r.Datastore().Delete(ds.NewKey(rawResult.Key)); err != nil {
+				log.Errorf("failed dropping cached record (%s): %s", rawResult.Key, err.Error())
+			}
+		}
+	}
+
+	if err := writeRepoVer(repoPath, cleanIPNSMigrationNumber+1); err != nil {
+		return fmt.Errorf("updating repover to %d: %s", cleanIPNSMigrationNumber+1, err.Error())
+	}
+	return nil
+}
+
+func (cleanIPNSRecordsFromDatastore) Down(repoPath, databasePassword string, testnetEnabled bool) error {
+	if err := writeRepoVer(repoPath, cleanIPNSMigrationNumber); err != nil {
+		return fmt.Errorf("updating repover to %d: %s", cleanIPNSMigrationNumber, err.Error())
+	}
+	return nil
+}

repo/migrations/Migration026_test.go

@@ -0,0 +1,84 @@
+package migrations
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/OpenBazaar/openbazaar-go/schema"
+	"github.com/ipfs/go-ipfs/repo/fsrepo"
+
+	ds "gx/ipfs/QmUadX5EcvrBmxAV9sE7wUWtWSqxns5K84qKJBixmcT1w9/go-datastore"
+)
+
+func TestCleanIPNSRecordsMigration(t *testing.T) {
+	var (
+		basePath  = schema.GenerateTempPath()
+		ipnsKey   = "/ipns/shoulddelete"
+		otherKey  = "/ipfs/shouldNOTdelete"
+		migration = cleanIPNSRecordsFromDatastore{}
+
+		testRepoPath, err = schema.OpenbazaarPathTransform(basePath, true)
+	)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	appSchema, err := schema.NewCustomSchemaManager(schema.SchemaContext{DataPath: testRepoPath, TestModeEnabled: true})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if err = appSchema.BuildSchemaDirectories(); err != nil {
+		t.Fatal(err)
+	}
+	defer appSchema.DestroySchemaDirectories()
+
+	if err := fsrepo.Init(appSchema.DataPath(), schema.MustDefaultConfig()); err != nil {
+		t.Fatal(err)
+	}
+
+	r, err := fsrepo.Open(testRepoPath)
+	if err != nil {
+		t.Fatalf("opening repo: %s", err.Error())
+	}
+
+	err = r.Datastore().Put(ds.NewKey(ipnsKey), []byte("randomdata"))
+	if err != nil {
+		t.Fatal("unable to put ipns record")
+	}
+	err = r.Datastore().Put(ds.NewKey(otherKey), []byte("randomdata"))
+	if err != nil {
+		t.Fatal("unable to put other record")
+	}
+
+	// run migration up
+	if err := migration.Up(appSchema.DataPath(), "", true); err != nil {
+		t.Fatal(err)
+	}
+
+	// validate state
+	if _, err := r.Datastore().Get(ds.NewKey(ipnsKey)); err != ds.ErrNotFound {
+		t.Errorf("expected the IPNS record to be removed, but was not")
+	}
+	if val, err := r.Datastore().Get(ds.NewKey(otherKey)); err != nil {
+		t.Errorf("expected the other record to be present, but was not")
+	} else {
+		if !bytes.Equal([]byte("randomdata"), val) {
+			t.Errorf("expected the other record data to be intact, but was not")
+		}
+	}
+
+	if err = appSchema.VerifySchemaVersion("27"); err != nil {
+		t.Fatal(err)
+	}
+
+	// run migration down
+	if err := migration.Down(appSchema.DataPath(), "", true); err != nil {
+		t.Fatal(err)
+	}
+
+	// validate state
+	if err = appSchema.VerifySchemaVersion("26"); err != nil {
+		t.Fatal(err)
+	}
+}

repo/migrations/log.go

@@ -0,0 +1,5 @@
+package migrations
+
+import logging "github.com/op/go-logging"
+
+var log = logging.MustGetLogger("migrations")