fix: use ipfs peerId as pin location #966

olizilla · 2022-02-08T12:49:56Z

Cluster now provides the peerId for the underlying ipfs node in pin status response, so we fix things to use that as our pin location peer id. Previously we used the cluster peerId which should only be used for internal cluster admin. With this change users will be able to use the peerId in the /status response to connect to the ipfs node that has their stuff via
ipfs swarm connect <peerId>

Fix toPin to use ipfsPeerId
Update tests to verify that status response for new content has a peerId of the ipfs node for one of the cluster nodes.
Update ipfs-cluster client to 4.0.0
Update ipfs-cluster in docker-compose to 0.14.5-rc1
Tweak test hooks to not wait for things to shut down before printing the test results overview, to reduce debugging friction.

Fixes: #414

TODO:

db migration script to update PinLocation peerIds
verify cluster infra is updated to ipfs-cluster >= 0.14.5-rc1
schedule read-only maintenance

License: (Apache-2.0 AND MIT)
Signed-off-by: Oli Evans oli@tableflip.io

Cluster now provides the peerId for the underlying ipfs node in pin status response, so we fix things to use that as our pin location peer id. Previously we used the cluster peerId which should only be used for internal cluster admin. With this change users will be able to use the peerId in the /status response to connect to the ipfs node that has their stuff via `ipfs swarm connect <peerId>` - Fix toPin to use ipfsPeerId - Update tests to verify that status response for new content has a peerId of the ipfs node for one of the cluster nodes. - Update ipfs-cluster client to [4.0.0](https://github.com/nftstorage/ipfs-cluster/releases/tag/v4.0.0) - Update ipfs-cluster in docker-compose to [0.14.5-rc1](https://github.com/ipfs/ipfs-cluster/releases/tag/v0.14.5-rc1) - Tweak test hooks to not wait for things to shut down before printing the test results overview, to reduce debugging friction. Fixes: #414 TODO: - [] db migration script to update PinLocation peerIds - [] verify cluster infra is updated to >= ipfs-cluster >= 0.14.5-rc1 - [] schedule read-only maintenance License: (Apache-2.0 AND MIT) Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla · 2022-02-08T14:43:08Z

PeerId map

Cluster peer	IPFS peer
12D3KooWF6uxxqZf4sXpQEbNE4BfbVJWAKWrFSKamxmWm4E9vyzd	12D3KooWPySxxWQjBgX9Jp6uAHQfVmdq8HG1gVvS1fRawHNSrmqW
12D3KooWFe387JFDpgNEVCP5ARut7gRkX7YuJCXMStpkq714ziK6	12D3KooWR19qPPiZH4khepNjS3CLXiB7AbrbAD4ZcDjN1UjGUNE1
12D3KooWHdBjmicdXu5X57mQ65oBpfy4p3ca5p31kfJT9FSUFu3P	12D3KooWKytRAd2ujxhGzaLHKJuje8sVrHXvjGNvHXovpar5KaKQ
12D3KooWJeRQfPbiv5U2RqQ9yK3qijbNxKarKEGLMkGrfXJuZ2Bo	12D3KooWEDMw7oRqQkdCJbyeqS5mUmWGwTp8JJ2tjCzTkHboF6wK
12D3KooWLWFUri36dmTkki6o9PwfQNwGb2gsHuKD5FdcwzCXYnwc	12D3KooWNuoVEfVLJvU3jWY2zLYjGUaathsecwT19jhByjnbQvkj
12D3KooWMbibcXHwkSjgV7VZ8TMfDKi6pZvmi97P83ZwHm9LEsvV	12D3KooWSnniGsyAF663gvHdqhyfJMCjWJv54cGSzcPiEMAfanvU

extracted from ipfs-cluster-ctl --host /dnsaddr/web3.storage.ipfscluster.io peers ls output

olizilla · 2022-02-08T15:04:19Z

Looks like the pin_location.peer_name field is not being set correctly in staging and prod. It's currently being set to the peerId. I will fix that as part of this PR.

olizilla · 2022-02-10T11:14:33Z

The thrashing of the peer_name is coming from cluster; it returns either the peer name or the peerId for a node depending on the pin status. see: ipfs-cluster/ipfs-cluster#1569

I think ideally that'd be something we fix on cluster. Either way, it's not really in scope for this PR, so I'll raise a seperate issue to follow it up.

License: (Apache-2.0 AND MIT) Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla · 2022-02-11T12:50:24Z

Tested locally. new pin locations created with ipfs peerId. Next steps are

verify with hsanjuan what the plan is for rolling out cluster update... will we roll out the rc or wait till the next stable release

once that is done, test it out on staging:

deploy to staging with api in read-only mode
run sql migration
enable write on staging api
upload content to staging api
verify the Pin Locations table has the expected number of cluster peers in and each one still has the ipfs peer id in the peerId column
celebrate then do it again on prod.

vasco-santos

Awesome, this is looking good! 👍🏼

We just need to figure out the remaining dependencies to move forward with release + maintenance window

vasco-santos · 2022-02-11T13:50:57Z

packages/db/postgres/fix-peer_location.peer_id.sql

@@ -0,0 +1,6 @@
+UPDATE pin_location SET peer_id='12D3KooWPySxxWQjBgX9Jp6uAHQfVmdq8HG1gVvS1fRawHNSrmqW' WHERE peer_id='12D3KooWF6uxxqZf4sXpQEbNE4BfbVJWAKWrFSKamxmWm4E9vyzd';


We sadly don't have yet a migration mechanism out of the box. Perhaps, we can just create a migrations folder here, and prepend name of the sql script with date. What do you think?

vasco-santos · 2022-02-11T13:54:19Z

packages/api/test/hooks.js

@@ -53,18 +53,19 @@ export const mochaHooks = () => {
      await delay(2000)
    },
    async afterAll () {
+      // Note: not awaiting promises here so we see the test results overview sooner.


This is fine for me. But one question first. Running consecutively the tests is "safe", or can we easily start the tests while the containers are still being stopped/clenned?

I think no, we might have to revert this if we ever need that.

olizilla · 2022-02-15T14:28:54Z

@hsanjuan do you have a rough estimate for when you'll release v0.14.5 of ipfs-cluster? No rush, it's just to know when we could schedule landing this PR.

hsanjuan · 2022-02-16T15:19:06Z

@olizilla today

olizilla · 2022-02-18T09:43:30Z

Verified, cluster is ready for us to roll this out

ipfs-cluster-ctl --host /dnsaddr/web3.storage.ipfscluster.io version
0.14.5

vasco-santos · 2022-02-18T13:39:15Z

@olizilla let's schedule a maintenance window for next week

alanshaw · 2022-02-21T14:43:32Z

Scheduled for 2022-02-24 @ 14:30 UTC

…n-location

olizilla · 2022-02-24T09:52:01Z

packages/tools/docker/cluster/docker-compose.yml

@@ -47,7 +47,7 @@ services:

    cluster0:
      container_name: cluster0
-      image: ipfs/ipfs-cluster:latest
+      image: ipfs/ipfs-cluster:v0.14.5-rc1


@alanshaw I'm going to revert this change to the docker-compose to as the latest is now v0.14.5 https://github.com/ipfs/ipfs-cluster/releases

License: (Apache-2.0 AND MIT) Signed-off-by: Oli Evans <oli@tableflip.io>

alanshaw

LGTM

alanshaw · 2022-02-24T13:46:05Z

packages/api/test/hooks.js

@@ -53,18 +53,19 @@ export const mochaHooks = () => {
      await delay(2000)
    },
    async afterAll () {
+      // Note: not awaiting promises here so we see the test results overview sooner.


I think no, we might have to revert this if we ever need that.

Reverts #966 and instead stores the IPFS peer ID in the `pin_location` table.

chore: add sql migration to update cluster peerIds to ipfs peerIds

736610f

License: (Apache-2.0 AND MIT) Signed-off-by: Oli Evans <oli@tableflip.io>

olizilla requested a review from vasco-santos February 11, 2022 12:51

vasco-santos approved these changes Feb 11, 2022

View reviewed changes

Merge remote-tracking branch 'origin/main' into use-ipfs-peerid-in-pi…

b1ff664

…n-location

olizilla commented Feb 24, 2022

View reviewed changes

chore: use latest cluster in docker-compose

2344402

License: (Apache-2.0 AND MIT) Signed-off-by: Oli Evans <oli@tableflip.io>

alanshaw approved these changes Feb 24, 2022

View reviewed changes

alanshaw merged commit 5ae212d into main Feb 24, 2022

alanshaw deleted the use-ipfs-peerid-in-pin-location branch February 24, 2022 13:51

github-actions bot mentioned this pull request Feb 24, 2022

chore(main): release api 5.3.0 #1027

Merged

alanshaw mentioned this pull request Mar 9, 2022

fix: store IPFS peer IDs #1093

Merged

alanshaw pushed a commit that referenced this pull request Mar 10, 2022

fix: store IPFS peer IDs (#1093)

1f2dcda

Reverts #966 and instead stores the IPFS peer ID in the `pin_location` table.

github-actions bot mentioned this pull request May 16, 2022

chore(main): release cron 1.0.0 #1328

Merged

github-actions bot mentioned this pull request Jun 27, 2022

chore(main): release db 1.0.0 #1578

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: use ipfs peerId as pin location #966

fix: use ipfs peerId as pin location #966

olizilla commented Feb 8, 2022 •

edited

Loading

olizilla commented Feb 8, 2022

olizilla commented Feb 8, 2022

olizilla commented Feb 10, 2022

olizilla commented Feb 11, 2022 •

edited

Loading

vasco-santos left a comment

vasco-santos Feb 11, 2022

vasco-santos Feb 11, 2022

alanshaw Feb 24, 2022

olizilla commented Feb 15, 2022

hsanjuan commented Feb 16, 2022

olizilla commented Feb 18, 2022

vasco-santos commented Feb 18, 2022

alanshaw commented Feb 21, 2022

olizilla Feb 24, 2022

alanshaw left a comment

alanshaw Feb 24, 2022

		@@ -0,0 +1,6 @@
		UPDATE pin_location SET peer_id='12D3KooWPySxxWQjBgX9Jp6uAHQfVmdq8HG1gVvS1fRawHNSrmqW' WHERE peer_id='12D3KooWF6uxxqZf4sXpQEbNE4BfbVJWAKWrFSKamxmWm4E9vyzd';

fix: use ipfs peerId as pin location #966

fix: use ipfs peerId as pin location #966

Conversation

olizilla commented Feb 8, 2022 • edited Loading

olizilla commented Feb 8, 2022

olizilla commented Feb 8, 2022

olizilla commented Feb 10, 2022

olizilla commented Feb 11, 2022 • edited Loading

vasco-santos left a comment

Choose a reason for hiding this comment

vasco-santos Feb 11, 2022

Choose a reason for hiding this comment

vasco-santos Feb 11, 2022

Choose a reason for hiding this comment

alanshaw Feb 24, 2022

Choose a reason for hiding this comment

olizilla commented Feb 15, 2022

hsanjuan commented Feb 16, 2022

olizilla commented Feb 18, 2022

vasco-santos commented Feb 18, 2022

alanshaw commented Feb 21, 2022

olizilla Feb 24, 2022

Choose a reason for hiding this comment

alanshaw left a comment

Choose a reason for hiding this comment

alanshaw Feb 24, 2022

Choose a reason for hiding this comment

olizilla commented Feb 8, 2022 •

edited

Loading

olizilla commented Feb 11, 2022 •

edited

Loading