1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 12:29:06 +01:00
metamask-extension/development/static-server.js

84 lines
2.3 KiB
JavaScript
Raw Normal View History

Add support for one-click onboarding (#7017) * Add support for one-click onboarding MetaMask now allows sites to register as onboarding the user, so that the user is redirected back to the initiating site after onboarding. This is accomplished through the use of the `metamask-onboarding` library and the MetaMask forwarder. At the end of onboarding, a 'snackbar'-stype component will explain to the user they are about to be moved back to the originating dapp, and it will show the origin of that dapp. This is intended to help prevent phishing attempts, as it highlights that a redirect is taking place to an untrusted third party. If the onboarding initiator tab is closed when onboarding is finished, the user is redirected to the onboarding originator as a fallback. Closes #6161 * Add onboarding button to contract test dapp The `contract-test` dapp (run with `yarn dapp`, used in e2e tests) now uses a `Connect` button instead of connecting automatically. This button also serves as an onboarding button when a MetaMask installation is not detected. * Add new static server for test dapp The `static-server` library we were using for the `contract-test` dapp didn't allow referencing files outside the server root. This should have been possible to work around using symlinks, but there was a bug that resulted in symlinks crashing the server. Instead it has been replaced with a simple static file server that will serve paths starting with `node_modules` from the project root. This will be useful in testing the onboarding library without vendoring it. * Add `@metamask/onboarding` and `@metamask/forwarder` Both libraries used to test onboarding are now included as dev dependencies, to help with testing. A few convenience scripts were added to help with this (`yarn forwarder` and `yarn dapp-forwarder`)
2019-11-22 18:03:51 +01:00
const fs = require('fs')
const path = require('path')
const chalk = require('chalk')
const pify = require('pify')
const createStaticServer = require('./create-static-server')
Add support for one-click onboarding (#7017) * Add support for one-click onboarding MetaMask now allows sites to register as onboarding the user, so that the user is redirected back to the initiating site after onboarding. This is accomplished through the use of the `metamask-onboarding` library and the MetaMask forwarder. At the end of onboarding, a 'snackbar'-stype component will explain to the user they are about to be moved back to the originating dapp, and it will show the origin of that dapp. This is intended to help prevent phishing attempts, as it highlights that a redirect is taking place to an untrusted third party. If the onboarding initiator tab is closed when onboarding is finished, the user is redirected to the onboarding originator as a fallback. Closes #6161 * Add onboarding button to contract test dapp The `contract-test` dapp (run with `yarn dapp`, used in e2e tests) now uses a `Connect` button instead of connecting automatically. This button also serves as an onboarding button when a MetaMask installation is not detected. * Add new static server for test dapp The `static-server` library we were using for the `contract-test` dapp didn't allow referencing files outside the server root. This should have been possible to work around using symlinks, but there was a bug that resulted in symlinks crashing the server. Instead it has been replaced with a simple static file server that will serve paths starting with `node_modules` from the project root. This will be useful in testing the onboarding library without vendoring it. * Add `@metamask/onboarding` and `@metamask/forwarder` Both libraries used to test onboarding are now included as dev dependencies, to help with testing. A few convenience scripts were added to help with this (`yarn forwarder` and `yarn dapp-forwarder`)
2019-11-22 18:03:51 +01:00
const fsStat = pify(fs.stat)
const DEFAULT_PORT = 9080
const onResponse = (request, response) => {
if (response.statusCode >= 400) {
console.log(chalk`{gray '-->'} {red ${response.statusCode}} ${request.url}`)
} else if (response.statusCode >= 200 && response.statusCode < 300) {
console.log(chalk`{gray '-->'} {green ${response.statusCode}} ${request.url}`)
} else {
console.log(chalk`{gray '-->'} {green.dim ${response.statusCode}} ${request.url}`)
}
}
const onRequest = (request, response) => {
console.log(chalk`{gray '<--'} {blue [${request.method}]} ${request.url}`)
response.on('finish', () => onResponse(request, response))
}
const startServer = ({ port, rootDirectory }) => {
const server = createStaticServer(rootDirectory)
Add support for one-click onboarding (#7017) * Add support for one-click onboarding MetaMask now allows sites to register as onboarding the user, so that the user is redirected back to the initiating site after onboarding. This is accomplished through the use of the `metamask-onboarding` library and the MetaMask forwarder. At the end of onboarding, a 'snackbar'-stype component will explain to the user they are about to be moved back to the originating dapp, and it will show the origin of that dapp. This is intended to help prevent phishing attempts, as it highlights that a redirect is taking place to an untrusted third party. If the onboarding initiator tab is closed when onboarding is finished, the user is redirected to the onboarding originator as a fallback. Closes #6161 * Add onboarding button to contract test dapp The `contract-test` dapp (run with `yarn dapp`, used in e2e tests) now uses a `Connect` button instead of connecting automatically. This button also serves as an onboarding button when a MetaMask installation is not detected. * Add new static server for test dapp The `static-server` library we were using for the `contract-test` dapp didn't allow referencing files outside the server root. This should have been possible to work around using symlinks, but there was a bug that resulted in symlinks crashing the server. Instead it has been replaced with a simple static file server that will serve paths starting with `node_modules` from the project root. This will be useful in testing the onboarding library without vendoring it. * Add `@metamask/onboarding` and `@metamask/forwarder` Both libraries used to test onboarding are now included as dev dependencies, to help with testing. A few convenience scripts were added to help with this (`yarn forwarder` and `yarn dapp-forwarder`)
2019-11-22 18:03:51 +01:00
server.on('request', onRequest)
server.listen(port, () => {
console.log(`Running at http://localhost:${port}`)
})
}
const parsePort = (portString) => {
const port = Number(portString)
if (!Number.isInteger(port)) {
throw new Error(`Port '${portString}' is invalid; must be an integer`)
} else if (port < 0 || port > 65535) {
throw new Error(`Port '${portString}' is out of range; must be between 0 and 65535 inclusive`)
}
return port
}
const parseDirectoryArgument = async (pathString) => {
const resolvedPath = path.resolve(pathString)
const directoryStats = await fsStat(resolvedPath)
if (!directoryStats.isDirectory()) {
throw new Error(`Invalid path '${pathString}'; must be a directory`)
}
return resolvedPath
}
const main = async () => {
const args = process.argv.slice(2)
const options = {
port: process.env.port || DEFAULT_PORT,
rootDirectory: path.resolve('.'),
}
while (args.length) {
if ((/^(--port|-p)$/u).test(args[0])) {
Add support for one-click onboarding (#7017) * Add support for one-click onboarding MetaMask now allows sites to register as onboarding the user, so that the user is redirected back to the initiating site after onboarding. This is accomplished through the use of the `metamask-onboarding` library and the MetaMask forwarder. At the end of onboarding, a 'snackbar'-stype component will explain to the user they are about to be moved back to the originating dapp, and it will show the origin of that dapp. This is intended to help prevent phishing attempts, as it highlights that a redirect is taking place to an untrusted third party. If the onboarding initiator tab is closed when onboarding is finished, the user is redirected to the onboarding originator as a fallback. Closes #6161 * Add onboarding button to contract test dapp The `contract-test` dapp (run with `yarn dapp`, used in e2e tests) now uses a `Connect` button instead of connecting automatically. This button also serves as an onboarding button when a MetaMask installation is not detected. * Add new static server for test dapp The `static-server` library we were using for the `contract-test` dapp didn't allow referencing files outside the server root. This should have been possible to work around using symlinks, but there was a bug that resulted in symlinks crashing the server. Instead it has been replaced with a simple static file server that will serve paths starting with `node_modules` from the project root. This will be useful in testing the onboarding library without vendoring it. * Add `@metamask/onboarding` and `@metamask/forwarder` Both libraries used to test onboarding are now included as dev dependencies, to help with testing. A few convenience scripts were added to help with this (`yarn forwarder` and `yarn dapp-forwarder`)
2019-11-22 18:03:51 +01:00
if (args[1] === undefined) {
throw new Error('Missing port argument')
}
options.port = parsePort(args[1])
args.splice(0, 2)
} else {
options.rootDirectory = await parseDirectoryArgument(args[0])
args.splice(0, 1)
}
}
startServer(options)
}
main()
.catch((error) => {
console.error(error)
process.exit(1)
})