Feature/ Helia React Vite Example (#16)

* example with vite react

* playwright test

* readme and picture

* rm unneed consolelogs

* some clean up

* fs to deps, clearer comment about deps, line spacing for import statements

* codesandbox link

* better comment, gif describing it

* fs thing with onprogress

* remove unneeded gifs

---------

Co-authored-by: Taylorhulsmans <[email protected]>
Co-authored-by: Russell Dempsey <[email protected]>

.github/workflows/ci.yml

@@ -69,6 +69,7 @@ jobs:
           - helia-101
           - helia-cjs
           - helia-webpack
+          - helia-vite-react
     steps:
       - uses: convictional/trigger-workflow-and-wait@f69fa9eedd3c62a599220f4d5745230e237904be
         with:

examples/helia-vite-react/.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+/test-results/

examples/helia-vite-react/README.md

@@ -0,0 +1,116 @@
+<p align="center">
+  <a href="https://github.com/ipfs/helia" title="Helia">
+    <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
+  </a>
+</p>
+
+<h3 align="center"><b>Helia with React+Vite</b></h3>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
+  <br>
+  <a href="https://ipfs.github.io/helia/modules/helia.html">Explore the docs</a>
+  ·
+  <a href="https://codesandbox.io/p/sandbox/infallible-haibt-e3lcd4">View Demo</a>
+  ·
+  <a href="https://github.com/ipfs-examples/helia-examples/issues">Report Bug</a>
+  ·
+  <a href="https://github.com/ipfs-examples/helia-examples/issues">Request Feature/Example</a>
+</p>
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About The Project](#about-the-project)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation and Running example](#installation-and-running-example)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
+
+## About The Project
+
+- Read the [docs](https://ipfs.github.io/helia/modules/helia.html)
+- Look into other [examples](https://github.com/ipfs-examples/helia-examples) to learn how to spawn a Helia node in Node.js and in the Browser
+- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
+- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
+- Check out https://docs.ipfs.io for tips, how-tos and more
+- See https://blog.ipfs.io for news and more
+- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
+
+## Getting Started
+
+### Prerequisites
+
+Make sure you have installed all of the following prerequisites on your development machine:
+
+- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
+- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
+
+### Installation and Running example
+
+```console
+> npm install
+> npm start
+or
+> npm run dev
+```
+To run the test
+
+```console
+npx playwright install
+npm run test
+```
+
+Now open your browser at `http://localhost:3000`
+
+## Usage
+
+In this example, you will find a boilerplate you can use to guide yourself into creating a react+vite app with helia, this provides a pattern to reuse the same client across components with the context API and suggests how to integrate it with custom hooks
+
+You should see the following:
+
+![](./public/hello-helia.gif)
+
+_For more examples, please refer to the [Documentation](#documentation)_
+
+## Documentation
+
+- [IPFS Primer](https://dweb-primer.ipfs.io/)
+- [IPFS Docs](https://docs.ipfs.io/)
+- [Tutorials](https://proto.school)
+- [More examples](https://github.com/ipfs-examples/helia-examples)
+- [API - Helia](https://ipfs.github.io/helia/modules/helia.html)
+- [API - @helia/unixfs](https://ipfs.github.io/helia-unixfs/modules/helia.html)
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the IPFS Project
+2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)
+4. Push to the Branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Want to hack on IPFS?
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
+
+Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).
+
+- **Check out existing issues** The [issue list](https://github.com/ipfs/helia/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
+- **Look at the [Helia Roadmap](https://github.com/ipfs/helia/blob/main/ROADMAP.md)** This are the high priority items being worked on right now
+- **Perform code reviews** More eyes will help
+  a. speed the project along
+  b. ensure quality, and
+  c. reduce possible future bugs
+- **Add tests**. There can never be enough tests
+
+[cid]: https://docs.ipfs.tech/concepts/content-addressing  "Content Identifier"
+[Uint8Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
+[libp2p]: https://libp2p.io

examples/helia-vite-react/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Helia + Vite + React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

examples/helia-vite-react/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "helia-vite",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "dev": "vite",
+    "start": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "test": "npm run build && playwright test tests"
+  },
+  "dependencies": {
+    "@chainsafe/libp2p-noise": "^11.0.1",
+    "@chainsafe/libp2p-yamux": "^3.0.7",
+    "@helia/unixfs": "^1.2.0",
+    "@libp2p/bootstrap": "^6.0.2",
+    "@libp2p/websockets": "^5.0.6",
+    "blockstore-core": "^4.0.1",
+    "datastore-core": "^9.0.3",
+    "helia": "next",
+    "libp2p": "^0.42.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rimraf": "^4.4.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.31.2",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11",
+    "@vitejs/plugin-react": "^3.1.0",
+    "test-util-ipfs-example": "^1.0.2",
+    "vite": "^4.2.0"
+  }
+}

examples/helia-vite-react/src/App.css

@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}

examples/helia-vite-react/src/App.jsx

@@ -0,0 +1,55 @@
+import { useState, useContext } from 'react'
+import './App.css'
+import { useHelia } from '@/hooks/useHelia'
+import { useCommitText } from '@/hooks/useCommitText'
+
+function App() {
+  const [text, setText] = useState("")
+  const { error, starting } = useHelia()
+  const {
+    cidString,
+    commitText,
+    fetchCommitedText,
+    commitedText,
+  } = useCommitText()
+
+  return (
+    <div className="App">
+      <div
+        id="heliaStatus"
+        style={{
+          border: `4px solid ${
+            error ? 'red':
+            starting ? 'yellow' : 'green'
+          }`,
+          paddingBottom: '4px'
+        }}
+      >Helia Status</div> 
+      <input
+        id="textInput"
+        value={text}
+        onChange={(event) => setText(event.target.value)}
+        type="text" />
+      <button
+        id="commitTextButton"
+        onClick={() => commitText(text)}
+      >Add Text To Node</button>
+      <div
+        id="cidOutput"
+      >textCid: {cidString}</div>
+      { cidString && (<>
+        <button
+          id="fetchCommitedTextButton"
+          onClick={() => fetchCommitedText()}
+        >Fetch Commited Text</button>
+          <div
+            id="commitedTextOutput"
+          >Commited Text: {commitedText}</div>
+        </>) 
+      }
+
+    </div>
+  )
+}
+
+export default App

examples/helia-vite-react/src/hooks/useCommitText.jsx

@@ -0,0 +1,51 @@
+import { useState, useEffect, useCallback, useContext } from 'react'
+import { useHelia } from '@/hooks/useHelia'
+
+const encoder = new TextEncoder()
+const decoder = new TextDecoder()
+
+export const useCommitText = () => {
+  const {helia, fs, error, starting } = useHelia()
+  const [cid, setCid] = useState(null)
+  const [cidString, setCidString] = useState("")
+  const [commitedText, setCommitedText] = useState("")
+
+  const commitText = useCallback(async (text) => {
+    if (!error && !starting) {
+      try {
+        const cid = await fs.addBytes(
+          encoder.encode(text),
+          helia.blockstore
+        )
+        setCid(cid)
+        setCidString(cid.toString())
+        console.log('Added file:', cid.toString())
+      } catch (e) {
+        console.error(e)
+      }
+    } else {
+      console.log('please wait for helia to start')
+    }
+  }, [error, starting, helia, fs])
+
+  const fetchCommitedText = useCallback(async () => {
+    let text = ''
+    if (!error && !starting) {
+      try {
+        for await (const chunk of fs.cat(cid)) {
+          text += decoder.decode(chunk, {
+            stream: true
+          })
+        }
+        setCommitedText(text)
+      } catch (e) {
+        console.error(e)
+      }
+    } else {
+      console.log('please wait for helia to start')
+    }
+  }, [error, starting, cid, helia, fs])
+  // If one forgets to add helia in the dependency array in commitText, additions to the blockstore will not be picked up by react, leading to operations on fs to hang indefinitely in the generator <suspend> state. As such it would be good practice to ensure to include helia inside the dependency array of all hooks to tell react that the useCallback needs the most up to date helia state
+
+  return { cidString, commitedText, commitText, fetchCommitedText }
+}

examples/helia-vite-react/src/hooks/useHelia.jsx

@@ -0,0 +1,9 @@
+import { useContext } from 'react'
+import { HeliaContext } from '@/provider/HeliaProvider'
+
+export const useHelia = () => {
+  const { helia, fs, error, starting } = useContext(HeliaContext)
+  return {helia, fs, error, starting}
+}
+
+