Getting project back on track 🏗️👨‍🏭

[lidel]

This project was not actively maintained and is behind with both infra and IPFS.

Below is a high level overview of absolute minimum that needs to happen to get it back on track cc @autonome @jessicaschilling

The CI

Right now this repo uses Jenkins, which was deprecated and replaced by Travis/CircleCI ✨

• remove Jenkins config (ci/) and set up CircleCI
  Tip: cid.ipfs.io website config can be used as a template: multiformats/cid-utils-website/.circleci/config.yml
• update #deploy instructions in readme
• (digression) If we want to keep dev.share.ipfs.io then it should be backed by master, and a new production branch should represent share.ipfs.io. This way development cycle on GitHub would not impact production.
  • Update: done: fix: automated deploy to IPFS with CircleCI #76

The app

Covered with spider webs 🕸️

• update all dependencies to latest versions, refactor if needed
• ensure latest js-ipfs and js-ipfs-http-client are used
  • this means some code needs to be refactored because programmatic JS API changed: https://blog.ipfs.io/2020-02-13-js-ipfs-0-41/
• ensure it works with ipfs-companion enabled
• ensure it loads fine from subdomain gateways at $cid.ipfs.dweb.link and share.ipfs.io.ipns.localhost:8080
  • small error about service worker, but does not impact the app
• ensure it loads fine from ipns:// in Brave (ipns://dev.share.ipfs.io)
  • there was Bug: ipfs:// drops query and hash parts  brave/brave-browser#13722 but it won't impact users, as we copy univeral http URL

The above is a bare minimum needed to keep website up to date and useful.

[jessicaschilling]

@lidel -- thanks so much for getting this on paper. What's the next step for getting the CI and infra part of this on someone's radar within the core IFPS team? Once that's done, the remaining parts would make an excellent bounty issue.

[lidel]

Switched CI setup to CircleCI in #76 and checked off CI part.

Right now the build fails but that may be due to old dependencies. I did not dig into it, as the next item in the list, "update all dependencies to latest versions" may fix it.

[jessicaschilling]

@lidel @rafaelramalho19 re hackathon priorities - can we maybe start with this issue, and specifically just initially getting dependencies etc up to date as quickly as possible? I can't even build this locally, but once I can that unblocks me to working on some of the visual stuff in other issues. Thanks!

[lidel]

Agree, this is the blocker of entire endeavor (I'm unable to build current codebase in node 14).

I've looked at the current codebase, and it won't be easy to just swap js-ipfs to the latest version :(
The project initializes js-ipfs via the deprecated ipfs-redux-bundle:

ipfs-share-files/src/bundles/index.js

Lines 2 to 13 in 2e099d8

	import ipfsBundle from 'ipfs-redux-bundle'
	import appIdle from './app-idle'
	import routesBundle from './routes'
	import redirectsBundle from './redirects'
	import filesBundle from './files'
	export default composeBundles(
	appIdle({idleTimeout: 5000}),
	ipfsBundle({
	tryJsIpfs: true,
	getJsIpfs: () => import('ipfs')
	}),

Potential path for unblocking:

1. Update to the latest ipfs and is-ipfs
2. Remove ipfs-redux-bundle and replace it with custom one that implements the same API but initializes js-ipfs directly
   • We already removed ipfs-redux-bundle a while ago from ipfs-desktop and replaced it with bundle that internally uses ipfs-provider (feat: replace redux-bundle with ipfs-provider ipfs/ipfs-webui#1563)
   • For MVP there is no need for supporting other backends than js-ipfs (ipfs), so drop-in replacement bundle can initialize js-ipfs directly, if that's easier/faster
3. Go over places that operate on ipfs API and refactor where necessary (various IPFS APIs and tooling like ipfsd-ctl moved from clalbacks to async/away)

@rafaelramalho19 are you willing to give it a try? If you write a drop-in replacement bundle that implements the same API as ipfs-redux-bundle, I can help with the remaining API and tests refactor, where needed.

[jessicaschilling]

@lidel Can you please look through this checklist again and for things that don't look like they'll get done during hack week, break into separate labeled issues? Thanks 🙏

[lidel]

All good!