-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ResolveDatasetRef): new action for resolving dataset references
feeling pretty pumped about this method rn. Our code has needed a clearly-defined name resolution system for a while now, and I think this method gets such a system in place. Not _finished_, just, in place.
- Loading branch information
Showing
5 changed files
with
83 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package actions | ||
|
||
import ( | ||
"github.com/qri-io/qri/p2p" | ||
"github.com/qri-io/qri/repo" | ||
) | ||
|
||
// ResolveDatasetRef uses a node to complete the missing pieces of a dataset | ||
// reference. The most typical example is completing a human ref like | ||
// peername/dataset_name with content-addressed identifiers | ||
// It will first attempt to use the local repo to Canonicalize the reference, | ||
// falling back to a network call if one isn't found | ||
// TODO - consider reinforcing p2p network with registry lookups | ||
func ResolveDatasetRef(n *p2p.QriNode, ref *repo.DatasetRef) error { | ||
if err := repo.CanonicalizeDatasetRef(n.Repo, ref); err == nil && ref.Path != "" { | ||
return nil | ||
} | ||
|
||
return n.ResolveDatasetRef(ref) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package actions | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/qri-io/qri/p2p" | ||
"github.com/qri-io/qri/p2p/test" | ||
"github.com/qri-io/qri/repo" | ||
) | ||
|
||
func TestResolveDatasetRef(t *testing.T) { | ||
ctx := context.Background() | ||
factory := p2ptest.NewTestNodeFactory(p2p.NewTestableQriNode) | ||
testPeers, err := p2ptest.NewTestNetwork(ctx, factory, 3) | ||
if err != nil { | ||
t.Fatalf("error creating network: %s", err.Error()) | ||
} | ||
if err := p2ptest.ConnectNodes(ctx, testPeers); err != nil { | ||
t.Fatalf("error connecting peers: %s", err.Error()) | ||
} | ||
|
||
// Convert from test nodes to non-test nodes. | ||
peers := make([]*p2p.QriNode, len(testPeers)) | ||
for i, node := range testPeers { | ||
peers[i] = node.(*p2p.QriNode) | ||
} | ||
|
||
// give peer 1 a ref that others don't have | ||
p, err := peers[1].Repo.Profile() | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
ref := repo.DatasetRef{Peername: p.Peername, Name: "bar", ProfileID: p.ID, Path: "/ipfs/QmXSGsgt8Bn8jepw7beXibYUfWSJVU2SzP3TpkioQVUrmM"} | ||
if err = peers[1].Repo.PutRef(ref); err != nil { | ||
t.Fatalf("error putting ref in repo: %s", err.Error()) | ||
} | ||
expect := "test-repo-1/bar@QmWYgD49r9HnuXEppQEq1a7SUUryja4QNs9E6XCH2PayCD/ipfs/QmXSGsgt8Bn8jepw7beXibYUfWSJVU2SzP3TpkioQVUrmM" | ||
in := &repo.DatasetRef{Peername: "test-repo-1", Name: "bar"} | ||
|
||
// TODO - fix this lie | ||
peers[2].Online = false | ||
if err := ResolveDatasetRef(peers[2], in); err == nil { | ||
t.Error("expected offline node to not be able to resolve non-local ref") | ||
} | ||
|
||
if err := ResolveDatasetRef(peers[0], in); err != nil { | ||
t.Error(err.Error()) | ||
} | ||
if in.String() != expect { | ||
t.Errorf("returned ref mismatch. expected: %s, got: %s", expect, in.String()) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters