[demo] Lint More Files (#127)

* Add linting files.
* Install an older version of eslint so that it's compatible with the one in the client folder.
* Add some manual testing steps.
* Make minor clean-ups in setup scripts.
* README: Make minor clarifications.

Author: juharris

demo/.eslintignore

@@ -0,0 +1,10 @@
+build/
+node_modules/
+dist/
+coverage/
+
+# Client
+client/build/
+client/node_modules/
+client/dist/
+client/coverage/

demo/.eslintrc.js

@@ -0,0 +1,44 @@
+module.exports = {
+	root: true,
+	env: {
+		browser: true,
+		node: true,
+		es6: true,
+	},
+	parser: '@typescript-eslint/parser',
+	plugins: [
+		'@typescript-eslint',
+	],
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:react/recommended',
+	],
+	rules: {
+		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/no-non-null-assertion': 'off',
+		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: "^_" }],
+		// Messes up .js files.
+		'@typescript-eslint/no-var-requires': 'off',
+		'@typescript-eslint/type-annotation-spacing': ['error'],
+		'array-bracket-spacing': ['error', 'never'],
+		'arrow-spacing': ['error'],
+		'comma-dangle': ['off', 'ignore'],
+		'comma-spacing': ['error', { before: false, after: true }],
+		indent: ['error', 'tab', { SwitchCase: 1 }],
+		'key-spacing': ['error'],
+		'keyword-spacing': ['error'],
+		'no-tabs': 0,
+		'object-curly-spacing': ['error', 'always'],
+		'operator-linebreak': ['off'],
+		quotes: ['off'],
+		semi: ['error', 'never'],
+		'space-before-function-paren': [2, {
+			named: 'never',
+			anonymous: 'always',
+			asyncArrow: 'always'
+		}],
+		'space-in-parens': ['error', 'never'],
+		'space-infix-ops': ['error', { int32Hint: false }],
+	},
+}

demo/README.md

@@ -18,11 +18,25 @@ This section explains how to set up locally on Linux/WSL, alternatively, you can
 The following steps are made for Linux/WSL and require `npm` with `node` version 10.
 Other later versions of node might work too but some node-gyp issues occurred with version 14.
 
+You will need to have `make` installed.
+On Debian (e.g. Ubuntu) you can do:
+```bash
+sudo apt install build-essential
+```
+
 Run
 ```bash
 ./setup.sh
 ```
 
+## Troubleshooting Setup
+If you have problems running the setup steps related to node-gyp, then you might need to set Python 2.7 to be your default (just during the installation).
+Recommendation: Temporarily set up a Python 2.7 Conda environment (just for the installation) and activate it:
+```bash
+conda create --name python2 python=2
+conda activate python2
+```
+
 ## Docker Setup
 1. Clone this repo.
 
@@ -69,9 +83,6 @@ docker push 0xdeca10bcontainerreg.azurecr.io/public/samples/blockchain-ai/0xdeca
 
 (Microsoft Devs) To update the production website, see the instructions at the top of [service.Dockerfile](./service.Dockerfile).
 
-## Troubleshooting Setup
-If you have problems running the setup steps related to node-gyp, then you might need to set Python 2.7 to be your default. Recommendation: Set up a Python 2.7 Conda environment and activate it.
-
 ## Update
 To update dependencies after already setting up:
 ```bash
@@ -82,7 +93,10 @@ To update dependencies after already setting up:
 There is a video example showing how to deploy <a href="https://aka.ms/0xDeCA10B-deploy" target="_blank">here</a>.
 
 ## Blockchain
-Start the blockchain (Ganache) in one terminal.
+Models and data are stored on a local blockchain.
+
+
+Start the blockchain (uses `ganache-cli`) in one terminal.
 Run:
 ```bash
 yarn blockchain
@@ -95,7 +109,9 @@ Do once:
 * Use that private key to create a new account in MetaMask.
 
 ## Server
-This is used by default in development mode but not in production.
+(Optional) The server is used to store model meta-data and original data when for training models.
+
+The server is used by default in development mode but not in production mode.
 
 If you want to store meta-data in a local database file instead of just within the browser, then start the server in one terminal.
 This step allows you to see models listed when you open the dashboard for the first time.
@@ -108,7 +124,9 @@ yarn server
 ```
 
 ## Client
-Then in another terminal.
+The website is the "client", it allows you to interract with the blockchain and optional server.
+
+In another terminal.
 Run:
 ```bash
 yarn client
@@ -156,13 +174,25 @@ If you get the spinning issue again, then also try following the steps above wit
 [truffle-react]: https://truffleframework.com/boxes/react
 
 # Testing
-To simply run all tests:
+To run all automated tests:
 ```bash
 yarn test
 ```
 
 A local blockchain will be started and stopped so it's best not to have a blockchain running at the same address and port (e.g. one running through `yarn blockchain`).
 
+## Manual Testing
+Not all tests are automated (yet, maybe one we'll automate them all).
+Some things that should be manually tested in the UI after completing the deployment:
+* Pick a model
+* PREDICT: Verify that you can use the model to classify some data
+* TRAIN: Add "incorrect" data as user "Bad"
+* Add "correct" data as user "Good"
+* REFUND: Verify that "Good" can get a refund for the "correct" data
+* REWARD: Verify that "Good" can report "Bad"'s "incorrect" data
+* Add a new model
+
+
 ## Running Specific Tests
 To run specific smart contract tests and save time by not waiting for Truffle migrations:
 * In one terminal, start a blockchain: `yarn blockchain`
@@ -175,12 +205,13 @@ npx truffle test test/contracts/*.js test/contracts/**/*.js --network skipMigrat
 ```
 
 # Linting
-### Solidity Files
+Run `yarn lint`.
+
+Run `yarn lint-fix` to automatically resolve some issues.
+
+## Solidity Files
 We use [Ethlint][ethlint] for linting and enforce it on pull requests.
-To check the contract code run:
-```bash
-yarn lint
-```
+The above `yarn lint` and `yarn lint-fix` commands will also check Solidity files.
 
 [deploy-video]: https://aka.ms/0xDeCA10B-deploy
 [demo-video]: https://aka.ms/0xDeCA10B-demo

demo/client/migrations/1_initial_migration.js

@@ -1,5 +1,5 @@
-var Migrations = artifacts.require("./Migrations.sol");
+var Migrations = artifacts.require("./Migrations.sol")
 
-module.exports = function(deployer) {
-  deployer.deploy(Migrations);
-};
+module.exports = function (deployer) {
+	deployer.deploy(Migrations)
+}

demo/client/migrations/2_deploy_sentiment_classifier.js

@@ -4,95 +4,95 @@ const fs = require('fs')
 const pjson = require('../package.json')
 const { convertData, convertNum } = require('../src/float-utils-node.js')
 
-const CollaborativeTrainer64 = artifacts.require("./CollaborativeTrainer64");
-const DataHandler64 = artifacts.require("./data/DataHandler64");
-const Classifier = artifacts.require("./classification/SparsePerceptron");
-const Stakeable64 = artifacts.require("./incentive/Stakeable64");
+const CollaborativeTrainer64 = artifacts.require("./CollaborativeTrainer64")
+const DataHandler64 = artifacts.require("./data/DataHandler64")
+const Classifier = artifacts.require("./classification/SparsePerceptron")
+const Stakeable64 = artifacts.require("./incentive/Stakeable64")
 
 module.exports = async function (deployer) {
-  if (deployer.network === 'skipMigrations') {
-    return;
-  }
-  // Information to persist to the database.
-  const name = "IMDB Review Sentiment Classifier"
-  const description = "A simple IMDB sentiment analysis model."
-  const encoder = 'IMDB vocab'
-  const modelInfo = {
-    name,
-    description,
-    accuracy: '0.829',
-    modelType: 'Classifier64',
-    encoder,
-  };
+	if (deployer.network === 'skipMigrations') {
+		return
+	}
+	// Information to persist to the database.
+	const name = "IMDB Review Sentiment Classifier"
+	const description = "A simple IMDB sentiment analysis model."
+	const encoder = 'IMDB vocab'
+	const modelInfo = {
+		name,
+		description,
+		accuracy: '0.829',
+		modelType: 'Classifier64',
+		encoder,
+	}
 
-  const toFloat = 1E9;
+	const toFloat = 1E9
 
-  // Low default times for testing.
-  const refundTimeS = 15;
-  const anyAddressClaimWaitTimeS = 20;
-  const ownerClaimWaitTimeS = 20;
-  // Weight for deposit cost in wei.
-  const costWeight = 1E15;
+	// Low default times for testing.
+	const refundTimeS = 15
+	const anyAddressClaimWaitTimeS = 20
+	const ownerClaimWaitTimeS = 20
+	// Weight for deposit cost in wei.
+	const costWeight = 1E15
 
-  const data = fs.readFileSync('./src/ml-models/imdb-sentiment-model.json', 'utf8');
-  const model = JSON.parse(data);
-  const { classifications } = model;
-  const weights = convertData(model.weights, web3, toFloat);
-  const initNumWords = 250;
-  const numWordsPerUpdate = 250;
+	const data = fs.readFileSync('./src/ml-models/imdb-sentiment-model.json', 'utf8')
+	const model = JSON.parse(data)
+	const { classifications } = model
+	const weights = convertData(model.weights, web3, toFloat)
+	const initNumWords = 250
+	const numWordsPerUpdate = 250
 
-  console.log(`Deploying IMDB model with ${weights.length} weights.`);
-  const intercept = convertNum(model.intercept || model.bias, web3, toFloat);
-  const learningRate = convertNum(model.learningRate, web3, toFloat);
+	console.log(`Deploying IMDB model with ${weights.length} weights.`)
+	const intercept = convertNum(model.intercept || model.bias, web3, toFloat)
+	const learningRate = convertNum(model.learningRate, web3, toFloat)
 
-  console.log(`Deploying DataHandler.`);
-  return deployer.deploy(DataHandler64).then(dataHandler => {
-    console.log(`  Deployed data handler to ${dataHandler.address}.`);
-    return deployer.deploy(Stakeable64,
-      refundTimeS,
-      ownerClaimWaitTimeS,
-      anyAddressClaimWaitTimeS,
-      costWeight
-    ).then(incentiveMechanism => {
-      console.log(`  Deployed incentive mechanism to ${incentiveMechanism.address}.`);
-      console.log(`Deploying classifier.`);
-      return deployer.deploy(Classifier,
-        classifications, weights.slice(0, initNumWords), intercept, learningRate,
-        { gas: 7.9E6 }).then(async classifier => {
-          console.log(`  Deployed classifier to ${classifier.address}.`);
-          for (let i = initNumWords; i < weights.length; i += numWordsPerUpdate) {
-            await classifier.initializeWeights(i, weights.slice(i, i + numWordsPerUpdate),
-              { gas: 7.9E6 });
-            console.log(`  Added ${i + numWordsPerUpdate} weights.`);
-          }
+	console.log(`Deploying DataHandler.`)
+	return deployer.deploy(DataHandler64).then(dataHandler => {
+		console.log(`  Deployed data handler to ${dataHandler.address}.`)
+		return deployer.deploy(Stakeable64,
+			refundTimeS,
+			ownerClaimWaitTimeS,
+			anyAddressClaimWaitTimeS,
+			costWeight
+		).then(incentiveMechanism => {
+			console.log(`  Deployed incentive mechanism to ${incentiveMechanism.address}.`)
+			console.log(`Deploying classifier.`)
+			return deployer.deploy(Classifier,
+				classifications, weights.slice(0, initNumWords), intercept, learningRate,
+				{ gas: 7.9E6 }).then(async classifier => {
+				console.log(`  Deployed classifier to ${classifier.address}.`)
+				for (let i = initNumWords; i < weights.length; i += numWordsPerUpdate) {
+					await classifier.initializeWeights(i, weights.slice(i, i + numWordsPerUpdate),
+						{ gas: 7.9E6 })
+					console.log(`  Added ${i + numWordsPerUpdate} weights.`)
+				}
 
-          console.log(`Deploying collaborative trainer contract.`);
-          return deployer.deploy(CollaborativeTrainer64,
-            name, description, encoder,
-            dataHandler.address,
-            incentiveMechanism.address,
-            classifier.address
-          ).then(instance => {
-            console.log(`  Deployed IMDB collaborative classifier to ${instance.address}.`);
-            return Promise.all([
-              dataHandler.transferOwnership(instance.address),
-              incentiveMechanism.transferOwnership(instance.address),
-              classifier.transferOwnership(instance.address),
-            ]).then(() => {
-              modelInfo.address = instance.address;
-              return axios.post(`${pjson.proxy}api/models`, modelInfo).then(() => {
-                console.log("Added model to the database.");
-              }).catch(err => {
-                if (process.env.CI !== "true" && process.env.REACT_APP_ENABLE_SERVICE_DATA_STORE === 'true') {
-                  // It is okay to fail adding the model in CI but otherwise it should work.
-                  console.error("Error adding model to the database.");
-                  console.error(err);
-                  throw err;
-                }
-              });
-            });
-          });
-        });
-    });
-  });
-};
+				console.log(`Deploying collaborative trainer contract.`)
+				return deployer.deploy(CollaborativeTrainer64,
+					name, description, encoder,
+					dataHandler.address,
+					incentiveMechanism.address,
+					classifier.address
+				).then(instance => {
+					console.log(`  Deployed IMDB collaborative classifier to ${instance.address}.`)
+					return Promise.all([
+						dataHandler.transferOwnership(instance.address),
+						incentiveMechanism.transferOwnership(instance.address),
+						classifier.transferOwnership(instance.address),
+					]).then(() => {
+						modelInfo.address = instance.address
+						return axios.post(`${pjson.proxy}api/models`, modelInfo).then(() => {
+							console.log("Added model to the database.")
+						}).catch(err => {
+							if (process.env.CI !== "true" && process.env.REACT_APP_ENABLE_SERVICE_DATA_STORE === 'true') {
+								// It is okay to fail adding the model in CI but otherwise it should work.
+								console.error("Error adding model to the database.")
+								console.error(err)
+								throw err
+							}
+						})
+					})
+				})
+			})
+		})
+	})
+}