fix: update service worker test to use playwright

examples/browser-service-worker/README.md

@@ -1,11 +1,80 @@
-# Using js-ipfs node in [SharedWorker][] from [ServiceWorker][]
+<p align="center">
+  <a href="https://js.ipfs.io" title="JS IPFS">
+    <img src="https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png" alt="IPFS in JavaScript logo" width="244" />
+  </a>
+</p>
+
+<h3 align="center"><b>js-ipfs node using web workers</b></h3>
+
+<p align="center">
+  <b><i>Using js-ipfs node in [SharedWorker][] from [ServiceWorker][]</i></b>
+  <br />
+  <br />
+  <img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
+  <br>
+  <a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
+  ·
+  <a href="https://codesandbox.io/">View Demo</a>
+  ·
+  <a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
+  ·
+  <a href="https://github.com/ipfs-examples/js-ipfs-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)
+  - [General Overview](#general-overview)
+    - [`src/main.js`](#srcmainjs)
+    - [`src/worker.js`](#srcworkerjs)
+    - [`src/service.js`](#srcservicejs)
+  - [Running example](#running-example)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
+
+## About The Project
+
+- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
+- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
+- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
+- 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
+```
+
+Now open your browser at `http://localhost:3000`
+
+## Usage
 
 > In this example, you will find boilerplate code you can use to set up an IPFS
 > node in a [SharedWorker][] and use it from a [ServiceWorker][].
 
-## General Overview
+### General Overview
 
-### `src/main.js`
+#### `src/main.js`
 
 Module is loaded in the main thread (DOM window) and is responsible for wiring
 all the pieces together:
@@ -16,12 +85,12 @@ all the pieces together:
    back with a [MessagePort][] of the [SharedWorker][], enabling
    it to interact with shaerd IPFS node.
 
-### `src/worker.js`
+#### `src/worker.js`
 
 Module is loaded in the [SharedWorker][]. It demonstrates how to setup the IPFS
 node such that it can be used in other browsing contexts.
 
-### `src/service.js`
+#### `src/service.js`
 
 Module is loaded in the [ServiceWorker][] and responds to all the requests from
 the page. It recognizes four different request routes:
@@ -34,7 +103,7 @@ the page. It recognizes four different request routes:
    /ipfs/Qm...hash/file/name -> /view/Qm...hash/file/name
    ```
   - `src/main.js` script loaded in it.
-  
+
   This way when request from `/view/Qm..hash/file/name` arrives [ServiceWorker][]
   can obtain a [MessagePort][] for the [SharedWorker][] by requesting it from
   the iframe container.
@@ -45,48 +114,60 @@ the page. It recognizes four different request routes:
    [MessagePort][] for the [SharedWorker][] is obtained and used to retrieve
    content from the shared IPFS node and served back.
 
-   > There is a stub for `/view/ipns/...` route, which is left as an excercise
+   > There is a stub for `/view/ipns/...` route, which is left as an exercise
    > for the reader to fill.
 
-3. All other routes are served by fetchging it from the network.
+3. All other routes are served by fetching it from the network.
 
+### Running example
 
-## Before you start
+You should see the following:
 
-First clone this repo, cd into the example directory and install the dependencies
+![Screen Shot](./img/index-view.png)
 
-```bash
-git clone https://github.com/ipfs/js-ipfs.git
-cd js-ipfs/examples/browser-service-worker
-npm install
-```
+If you navigate to the following address `http://localhost:3000/ipfs/bafybeicqzoixu6ivztffjy4bktwxy6lxaxkvnavkya7kfgwyhx4bund2ga/` it should load a
+page from ipfs and appear as:
 
-## Running the example
+![Screen Shot](./img/page-view.png)
 
-Run the following command within this folder:
 
-```bash
-npm start
-```
+[SharedWorker]:https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker
+[ServiceWorker]:https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API
+[MessagePort]:https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
 
-Now open your browser at `http://localhost:3000`
+_For more examples, please refer to the [Documentation](#documentation)_
 
-You should see the following:
+## Documentation
 
-![Screen Shot](./index-view.png)
+- [Config](https://docs.ipfs.io/)
+- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
+- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
+- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
+- [Tutorials](https://proto.school)
 
-If you navigate to the following address `http://localhost:3000/ipfs/bafybeicqzoixu6ivztffjy4bktwxy6lxaxkvnavkya7kfgwyhx4bund2ga/` it should load a
-page from ipfs and appear as:
+## Contributing
 
-![Screen Shot](./page-view.png)
+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**.
 
-### Run tests
+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
 
-```bash
-npm test
-```
+## 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)
 
-[SharedWorker]:https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker
-[ServiceWorker]:https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API
-[MessagePort]:https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
+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/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/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 [IPFS Roadmap](https://github.com/ipfs/roadmap)** 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.
+- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next

examples/browser-service-worker/package.json

@@ -6,11 +6,15 @@
   "keywords": [],
   "license": "MIT",
   "scripts": {
-    "clean": "rm -rf ./dist",
-    "build": "webpack",
-    "start": "webpack-dev-server",
-    "test": "test-ipfs-example"
+    "clean": "rimraf ./dist",
+    "build": "webpack --env production",
+    "serve": "webpack serve --hot-only --mode=development",
+    "start": "npm run serve",
+    "test": "npm run build && playwright test tests"
   },
+  "browserslist": [
+    "last 1 Chrome version"
+  ],
   "dependencies": {
     "ipfs": "^0.58.1",
     "ipfs-message-port-client": "^0.8.3",
@@ -21,11 +25,20 @@
   "devDependencies": {
     "@babel/core": "^7.13.10",
     "@babel/preset-env": "^7.13.12",
+    "@playwright/test": "^1.12.3",
     "babel-loader": "^8.2.2",
     "copy-webpack-plugin": "^9.0.1",
-    "test-ipfs-example": "^3.0.0",
-    "webpack": "^5.28.0",
-    "webpack-cli": "^4.5.0",
-    "webpack-dev-server": "^3.11.2"
+    "css-loader": "^6.2.0",
+    "html-webpack-plugin": "^5.3.2",
+    "node-polyfill-webpack-plugin": "^1.0.4",
+    "playwright": "^1.12.3",
+    "rimraf": "^3.0.2",
+    "stream-browserify": "^3.0.0",
+    "style-loader": "^3.1.0",
+    "test-util-ipfs-example": "^1.0.2",
+    "webpack": "^5.45.1",
+    "webpack-cli": "^4.7.2",
+    "webpack-dev-server": "^3.11.2",
+    "webpack-merge": "^5.8.0"
   }
 }

examples/browser-service-worker/public/index.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+    <title><%= htmlWebpackPlugin.options.title %></title>
+  </head>
+  <body>
+    <article class="vh-100 dt w-100">
+      <div class="dtc v-mid tc ph3 ph4-l">
+        <h1 class="f6 f2-m f-subheadline-l fw6 tc">Load content by adding IPFS path to the URL ⤴</h2>
+          <p>Something like <a
+              href="/ipfs/bafybeicqzoixu6ivztffjy4bktwxy6lxaxkvnavkya7kfgwyhx4bund2ga/">/ipfs/bafybeicqzoixu6ivztffjy4bktwxy6lxaxkvnavkya7kfgwyhx4bund2ga/</a>
+          </p>
+          <p id=debug></p>
+      </div>
+    </article>
+  </body>
+</html>