Merge branch 'master' of linonetwo/ipfs-browser-gateway

.eslintrc

@@ -0,0 +1,64 @@
+{
+  "parser": "babel-eslint",
+  "extends": [
+    "airbnb",
+    "plugin:flowtype/recommended",
+    "plugin:jest/recommended",
+    "prettier",
+    "prettier/flowtype",
+    "prettier/react",
+    "prettier/standard"
+  ],
+  "plugins": ["flowtype", "prettier", "jest"],
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "env": {
+    "es6": true,
+    "node": true,
+    "jest/globals": true
+  },
+  "rules": {
+    "comma-dangle": 1,
+    "arrow-parens": ["off"],
+    "consistent-return": "off",
+    "no-underscore-dangle": "off",
+    "no-unused-expressions": "off",
+    "flowtype/define-flow-type": 1,
+    "flowtype/use-flow-type": 1,
+    "generator-star-spacing": "off",
+    "import/no-unresolved": "error",
+    "import/no-extraneous-dependencies": "off",
+    "no-console": "off",
+    "promise/no-native": "off",
+    "no-loop-func": "off",
+    "guard-for-in": "off",
+    "react/sort-comp": [
+      "error",
+      {
+        "order": ["type-annotations", "static-methods", "lifecycle", "everything-else", "render"]
+      }
+    ],
+    "react/no-multi-comp": "off",
+    "no-param-reassign": "off",
+    "no-restricted-syntax": "off",
+    "max-len": "off",
+    "react/jsx-no-bind": "off",
+    "react/jsx-filename-extension": ["error", { "extensions": [".js", ".jsx"] }],
+    "jsx-a11y/anchor-is-valid": [
+      "error",
+      {
+        "components": [],
+        "specialLink": ["hrefLeft", "hrefRight"],
+        "aspects": ["noHref", "invalidHref", "preferButton"]
+      }
+    ]
+  },
+  "globals": {
+    "window": true,
+    "document": true
+  }
+}

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -1,59 +1,21 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
+# See https://help.github.com/ignore-files/ for more about ignoring files.
 
-# node-waf configuration
-.lock-wscript
+# dependencies
+/node_modules
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
+# testing
+/coverage
 
-# Dependency directories
-node_modules/
-jspm_packages/
+# production
+/build
 
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
 
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 IPFS Shipyard
+Copyright (c) 2018 lindongwu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,2 +1,28 @@
-# service-worker-gateway
-A IPFS gateway fully running on a Service Worker
+# ipfs-browser-gateway
+
+Given an IPFS multihash, print the content and try to render web page if the content is HTML.
+
+## Development
+
+This is a "create-react-app" app, so just:
+
+`yarn && yarn start`
+
+## Drawback
+
+1. The first visit is way slower than traditional HTTP page. Though ```http://ipfs.io/ipfs``` is slow too.
+1. Can't promise long-term cache, compared to a gateway running on a server, who can pin a file for a longer time.
+1. Large folders like [QmRoYXgYMfcP7YQR4sCuSeJy9afgA5XDJ78JzWntpRhmcu](http://ipfs.io/ipfs/QmRoYXgYMfcP7YQR4sCuSeJy9afgA5XDJ78JzWntpRhmcu) may destroy service worker (maybe due to my using ```files.get```), so it's more suitable to just load HTML pages in this way.
+1. Don't work with AJAX likes fetch API.
+1. May break service worker inside page delivered by ipfs (untested).
+1. Loading dependencies by importScripts synchronously are slow (10s).
+
+## Road Map
+
+- Bundle all dependencies.
+
+## Reference
+
+- [Discussion](https://github.com/ipfs/ipfs-service-worker/issues/11)
+- [JS-IPFS-Gateway](https://github.com/ipfs/js-ipfs/tree/master/src/http/gateway)
+- [readable-stream in SW](https://developers.google.com/web/updates/2016/06/sw-readablestreams)

config-overrides.js

@@ -0,0 +1,26 @@
+const { injectBabelPlugin } = require('react-app-rewired');
+
+module.exports = function override(config, env) {
+  config = injectBabelPlugin(
+    [
+      'flow-runtime',
+      {
+        assert: true,
+        annotate: true,
+      },
+    ],
+    config,
+  );
+
+  if (env === 'production') {
+    console.log('⚡ Production build with optimization ⚡');
+    config = injectBabelPlugin('closure-elimination', config);
+    config = injectBabelPlugin('transform-react-inline-elements', config);
+    config = injectBabelPlugin('transform-react-constant-elements', config);
+  }
+
+  // remove eslint in eslint, we only need it on VSCode
+  config.module.rules.splice(1, 1);
+
+  return config;
+};

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "ipfs-browser-gateway",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "history": "^4.7.2",
+    "ipfs": "^0.28.2",
+    "react": "^16.3.2",
+    "react-dom": "^16.3.2",
+    "react-router": "^4.2.0",
+    "react-router-dom": "^4.2.2",
+    "react-scripts": "1.1.4",
+    "styled-components": "^3.2.6",
+    "styled-flex-component": "^2.2.2"
+  },
+  "devDependencies": {
+    "babel-eslint": "^8.2.3",
+    "babel-plugin-closure-elimination": "^1.3.0",
+    "babel-plugin-flow-runtime": "^0.17.0",
+    "babel-plugin-transform-react-constant-elements": "^6.23.0",
+    "babel-plugin-transform-react-inline-elements": "^6.22.0",
+    "eslint": "^4.19.1",
+    "eslint-config-airbnb": "^16.1.0",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-flowtype": "^2.46.3",
+    "eslint-plugin-import": "^2.11.0",
+    "eslint-plugin-jest": "^21.15.1",
+    "eslint-plugin-jsx-a11y": "^6.0.3",
+    "eslint-plugin-prettier": "^2.6.0",
+    "eslint-plugin-react": "^7.7.0",
+    "flow-typed": "^2.4.0",
+    "react-app-rewired": "^1.5.2"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test --env=jsdom",
+    "eject": "react-scripts eject"
+  }
+}

public/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <!--
+      manifest.json provides metadata used when your web app is added to the
+      homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json">
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>
+      You need to enable JavaScript to run this app.
+    </noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

public/manifest.json

@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": "./index.html",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

public/pathUtil.js

@@ -0,0 +1,38 @@
+/* eslint-disable no-unused-vars */
+function splitPath(path) {
+  if (path[path.length - 1] === '/') {
+    path = path.substring(0, path.length - 1);
+  }
+
+  return path.split('/');
+}
+
+function removeLeadingSlash(url) {
+  if (url[0] === '/') {
+    url = url.substring(1);
+  }
+
+  return url;
+}
+
+function removeTrailingSlash(url) {
+  if (url.endsWith('/')) {
+    url = url.substring(0, url.length - 1);
+  }
+
+  return url;
+}
+
+function removeSlashFromBothEnds(url) {
+  url = removeLeadingSlash(url);
+  url = removeTrailingSlash(url);
+
+  return url;
+}
+
+function joinURLParts(...urls) {
+  urls = urls.filter(url => url.length > 0);
+  urls = [].concat(urls.map(url => removeSlashFromBothEnds(url)));
+
+  return urls.join('/');
+}