From c8a8b851d8e0622559f71843a206a0e6e601cd83 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 13 Mar 2018 18:06:02 -0700 Subject: Consolidate all console.log into the @0xproject/utils package --- packages/0x.js/src/utils/utils.ts | 4 ---- packages/abi-gen/src/index.ts | 17 +++++++++-------- packages/abi-gen/src/utils.ts | 3 --- packages/deployer/src/compiler.ts | 20 ++++++++++---------- packages/deployer/src/deployer.ts | 5 +++-- packages/deployer/src/utils/utils.ts | 5 ----- packages/monorepo-scripts/package.json | 1 + packages/monorepo-scripts/src/deps_versions.ts | 9 +++------ packages/monorepo-scripts/tsconfig.json | 2 +- packages/react-docs/package.json | 1 + .../react-docs/src/ts/components/custom_enum.tsx | 3 ++- packages/react-docs/src/ts/utils/utils.ts | 5 ----- packages/react-docs/tsconfig.json | 2 +- packages/sra-report/src/index.ts | 11 +++++------ .../sra-report/src/postman_environment_factory.ts | 4 ++-- packages/sra-report/src/utils.ts | 5 ----- packages/testnet-faucets/src/ts/dispatch_queue.ts | 5 ++--- .../testnet-faucets/src/ts/dispense_asset_tasks.ts | 15 +++++++-------- packages/testnet-faucets/src/ts/error_reporter.ts | 6 +++--- packages/testnet-faucets/src/ts/handler.ts | 7 +++---- .../testnet-faucets/src/ts/parameter_transformer.ts | 1 - packages/testnet-faucets/src/ts/utils.ts | 7 ------- packages/testnet-faucets/tsconfig.json | 1 + packages/utils/src/index.ts | 1 + packages/utils/src/log_utils.ts | 5 +++++ packages/website/ts/blockchain.ts | 8 ++++---- packages/website/ts/blockchain_watcher.ts | 4 ++-- .../ts/components/dialogs/ledger_config_dialog.tsx | 6 +++--- .../ts/components/eth_weth_conversion_button.tsx | 6 +++--- packages/website/ts/components/fill_order.tsx | 10 +++++----- .../generate_order/generate_order_form.tsx | 8 ++++---- .../ts/components/inputs/allowance_toggle.tsx | 6 +++--- packages/website/ts/components/order_json.tsx | 4 ++-- packages/website/ts/components/portal.tsx | 4 ++-- packages/website/ts/components/send_button.tsx | 6 +++--- packages/website/ts/components/token_balances.tsx | 8 ++++---- packages/website/ts/pages/wiki/wiki.tsx | 3 ++- packages/website/ts/utils/doc_utils.ts | 5 +++-- packages/website/ts/utils/error_reporter.ts | 3 ++- packages/website/ts/utils/utils.ts | 5 ----- 40 files changed, 102 insertions(+), 129 deletions(-) delete mode 100644 packages/sra-report/src/utils.ts delete mode 100644 packages/testnet-faucets/src/ts/utils.ts create mode 100644 packages/utils/src/log_utils.ts diff --git a/packages/0x.js/src/utils/utils.ts b/packages/0x.js/src/utils/utils.ts index 74f2c5995..3e98de84f 100644 --- a/packages/0x.js/src/utils/utils.ts +++ b/packages/0x.js/src/utils/utils.ts @@ -17,10 +17,6 @@ export const utils = { bigNumberToBN(value: BigNumber) { return new BN(value.toString(), 10); }, - consoleLog(message: string): void { - // tslint:disable-next-line: no-console - console.log(message); - }, spawnSwitchErr(name: string, value: any): Error { return new Error(`Unexpected switch value: ${value} encountered for ${name}`); }, diff --git a/packages/abi-gen/src/index.ts b/packages/abi-gen/src/index.ts index 7c29f7d1d..8932e4045 100644 --- a/packages/abi-gen/src/index.ts +++ b/packages/abi-gen/src/index.ts @@ -1,5 +1,6 @@ #!/usr/bin/env node +import { logUtils } from '@0xproject/utils'; import chalk from 'chalk'; import * as fs from 'fs'; import { sync as globSync } from 'glob'; @@ -62,7 +63,7 @@ const args = yargs function registerPartials(partialsGlob: string) { const partialTemplateFileNames = globSync(partialsGlob); - utils.log(`Found ${chalk.green(`${partialTemplateFileNames.length}`)} ${chalk.bold('partial')} templates`); + logUtils.log(`Found ${chalk.green(`${partialTemplateFileNames.length}`)} ${chalk.bold('partial')} templates`); for (const partialTemplateFileName of partialTemplateFileNames) { const namedContent = utils.getNamedContent(partialTemplateFileName); Handlebars.registerPartial(namedContent.name, namedContent.content); @@ -77,7 +78,7 @@ function writeOutputFile(name: string, renderedTsCode: string): void { } const filePath = `${args.output}/${fileName}.ts`; fs.writeFileSync(filePath, renderedTsCode); - utils.log(`Created: ${chalk.bold(filePath)}`); + logUtils.log(`Created: ${chalk.bold(filePath)}`); } Handlebars.registerHelper('parameterType', utils.solTypeToTsType.bind(utils, ParamKind.Input, args.backend)); @@ -91,17 +92,17 @@ const template = Handlebars.compile(mainTemplate.content); const abiFileNames = globSync(args.abis); if (_.isEmpty(abiFileNames)) { - utils.log(`${chalk.red(`No ABI files found.`)}`); - utils.log(`Please make sure you've passed the correct folder name and that the files have + logUtils.log(`${chalk.red(`No ABI files found.`)}`); + logUtils.log(`Please make sure you've passed the correct folder name and that the files have ${chalk.bold('*.json')} extensions`); process.exit(1); } else { - utils.log(`Found ${chalk.green(`${abiFileNames.length}`)} ${chalk.bold('ABI')} files`); + logUtils.log(`Found ${chalk.green(`${abiFileNames.length}`)} ${chalk.bold('ABI')} files`); mkdirp.sync(args.output); } for (const abiFileName of abiFileNames) { const namedContent = utils.getNamedContent(abiFileName); - utils.log(`Processing: ${chalk.bold(namedContent.name)}...`); + logUtils.log(`Processing: ${chalk.bold(namedContent.name)}...`); const parsedContent = JSON.parse(namedContent.content); let ABI; if (_.isArray(parsedContent)) { @@ -112,8 +113,8 @@ for (const abiFileName of abiFileNames) { ABI = parsedContent.networks[args.networkId].abi; // 0x contracts package artifact } if (_.isUndefined(ABI)) { - utils.log(`${chalk.red(`ABI not found in ${abiFileName}.`)}`); - utils.log( + logUtils.log(`${chalk.red(`ABI not found in ${abiFileName}.`)}`); + logUtils.log( `Please make sure your ABI file is either an array with ABI entries or a truffle artifact or 0x deployer artifact`, ); process.exit(1); diff --git a/packages/abi-gen/src/utils.ts b/packages/abi-gen/src/utils.ts index 3e4ff619a..c4520ade0 100644 --- a/packages/abi-gen/src/utils.ts +++ b/packages/abi-gen/src/utils.ts @@ -73,9 +73,6 @@ export const utils = { isObjectType(tsType: string): boolean { return /^{.*}$/.test(tsType); }, - log(...args: any[]): void { - console.log(...args); // tslint:disable-line:no-console - }, getPartialNameFromFileName(filename: string): string { const name = path.parse(filename).name; return name; diff --git a/packages/deployer/src/compiler.ts b/packages/deployer/src/compiler.ts index ced8063db..83977709b 100644 --- a/packages/deployer/src/compiler.ts +++ b/packages/deployer/src/compiler.ts @@ -1,4 +1,4 @@ -import { promisify } from '@0xproject/utils'; +import { logUtils, promisify } from '@0xproject/utils'; import * as ethUtil from 'ethereumjs-util'; import * as fs from 'fs'; import 'isomorphic-fetch'; @@ -59,9 +59,9 @@ export class Compiler { }; const source = await fsWrapper.readFileAsync(contentPath, opts); sources[fileName] = source; - utils.consoleLog(`Reading ${fileName} source...`); + logUtils.log(`Reading ${fileName} source...`); } catch (err) { - utils.consoleLog(`Could not find file at ${contentPath}`); + logUtils.log(`Could not find file at ${contentPath}`); } } else { try { @@ -71,7 +71,7 @@ export class Compiler { ...nestedSources, }; } catch (err) { - utils.consoleLog(`${contentPath} is not a directory or ${constants.SOLIDITY_FILE_EXTENSION} file`); + logUtils.log(`${contentPath} is not a directory or ${constants.SOLIDITY_FILE_EXTENSION} file`); } } } @@ -164,7 +164,7 @@ export class Compiler { }); await Promise.all(_.map(fileNames, async fileName => this._compileContractAsync(fileName))); this._solcErrors.forEach(errMsg => { - utils.consoleLog(errMsg); + logUtils.log(errMsg); }); } /** @@ -195,7 +195,7 @@ export class Compiler { if (isCompilerAvailableLocally) { solcjs = fs.readFileSync(compilerBinFilename).toString(); } else { - utils.consoleLog(`Downloading ${fullSolcVersion}...`); + logUtils.log(`Downloading ${fullSolcVersion}...`); const url = `${constants.BASE_COMPILER_URL}${fullSolcVersion}`; const response = await fetch(url); if (response.status !== 200) { @@ -206,7 +206,7 @@ export class Compiler { } const solcInstance = solc.setupMethods(requireFromString(solcjs, compilerBinFilename)); - utils.consoleLog(`Compiling ${fileName}...`); + logUtils.log(`Compiling ${fileName}...`); const source = this._contractSources[fileName]; const input = { [fileName]: source, @@ -270,7 +270,7 @@ export class Compiler { const artifactString = utils.stringifyWithFormatting(newArtifact); const currentArtifactPath = `${this._artifactsDir}/${contractName}.json`; await fsWrapper.writeFileAsync(currentArtifactPath, artifactString); - utils.consoleLog(`${fileName} artifact saved!`); + logUtils.log(`${fileName} artifact saved!`); } /** * Sets the source tree hash for a file and its dependencies. @@ -323,7 +323,7 @@ export class Compiler { */ private async _createArtifactsDirIfDoesNotExistAsync(): Promise { if (!fsWrapper.doesPathExistSync(this._artifactsDir)) { - utils.consoleLog('Creating artifacts directory...'); + logUtils.log('Creating artifacts directory...'); await fsWrapper.mkdirAsync(this._artifactsDir); } } @@ -344,7 +344,7 @@ export class Compiler { contractArtifact = JSON.parse(contractArtifactString); return contractArtifact; } catch (err) { - utils.consoleLog(`Artifact for ${fileName} does not exist`); + logUtils.log(`Artifact for ${fileName} does not exist`); return undefined; } } diff --git a/packages/deployer/src/deployer.ts b/packages/deployer/src/deployer.ts index 27c346524..6c247d328 100644 --- a/packages/deployer/src/deployer.ts +++ b/packages/deployer/src/deployer.ts @@ -1,4 +1,5 @@ import { AbiType, TxData } from '@0xproject/types'; +import { logUtils } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as _ from 'lodash'; import * as Web3 from 'web3'; @@ -74,7 +75,7 @@ export class Deployer { ); } const web3ContractInstance = await this._deployFromAbiAsync(abi, args, txData); - utils.consoleLog(`${contractName}.sol successfully deployed at ${web3ContractInstance.address}`); + logUtils.log(`${contractName}.sol successfully deployed at ${web3ContractInstance.address}`); const contractInstance = new Contract(web3ContractInstance, this._defaults); return contractInstance; } @@ -107,7 +108,7 @@ export class Deployer { if (err) { reject(err); } else if (_.isUndefined(res.address) && !_.isUndefined(res.transactionHash)) { - utils.consoleLog(`transactionHash: ${res.transactionHash}`); + logUtils.log(`transactionHash: ${res.transactionHash}`); } else { resolve(res); } diff --git a/packages/deployer/src/utils/utils.ts b/packages/deployer/src/utils/utils.ts index 4390d8813..9b1e59f9d 100644 --- a/packages/deployer/src/utils/utils.ts +++ b/packages/deployer/src/utils/utils.ts @@ -1,9 +1,4 @@ export const utils = { - consoleLog(message: string): void { - /* tslint:disable */ - console.log(message); - /* tslint:enable */ - }, stringifyWithFormatting(obj: any): string { const jsonReplacer: null = null; const numberOfJsonSpaces = 4; diff --git a/packages/monorepo-scripts/package.json b/packages/monorepo-scripts/package.json index c9bbe0c6a..9a4e414e3 100644 --- a/packages/monorepo-scripts/package.json +++ b/packages/monorepo-scripts/package.json @@ -28,6 +28,7 @@ "typescript": "2.7.1" }, "dependencies": { + "@0xproject/utils": "^0.4.1", "chalk": "^2.3.0", "glob": "^7.1.2", "lodash": "^4.17.4" diff --git a/packages/monorepo-scripts/src/deps_versions.ts b/packages/monorepo-scripts/src/deps_versions.ts index 5c9a2d6ff..d8728dade 100644 --- a/packages/monorepo-scripts/src/deps_versions.ts +++ b/packages/monorepo-scripts/src/deps_versions.ts @@ -1,5 +1,6 @@ #!/usr/bin/env node +import { logUtils } from '@0xproject/utils'; import chalk from 'chalk'; import * as fs from 'fs'; import { sync as globSync } from 'glob'; @@ -17,10 +18,6 @@ interface VersionsByDependency { const PACKAGE_JSON_GLOB = '../*/package.json'; -function log(...args: any[]) { - console.log(...args); // tslint:disable-line:no-console -} - function getDependencies(path: string): Dependencies { const file = fs.readFileSync(path).toString(); const parsed = JSON.parse(file); @@ -48,9 +45,9 @@ _.map(versionsByDependency, (versions: Versions, depName: string) => { if (_.uniq(_.values(versions)).length === 1) { delete versionsByDependency[depName]; } else { - log(chalk.bold(depName)); + logUtils.log(chalk.bold(depName)); _.map(versions, (version: string, packageName: string) => { - log(`├── ${packageName} -> ${version}`); + logUtils.log(`├── ${packageName} -> ${version}`); }); } }); diff --git a/packages/monorepo-scripts/tsconfig.json b/packages/monorepo-scripts/tsconfig.json index c56d255d5..3d967d05f 100644 --- a/packages/monorepo-scripts/tsconfig.json +++ b/packages/monorepo-scripts/tsconfig.json @@ -3,5 +3,5 @@ "compilerOptions": { "outDir": "lib" }, - "include": ["./src/**/*"] + "include": ["./src/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"] } diff --git a/packages/react-docs/package.json b/packages/react-docs/package.json index eb76fe47e..5690366d9 100644 --- a/packages/react-docs/package.json +++ b/packages/react-docs/package.json @@ -35,6 +35,7 @@ }, "dependencies": { "@0xproject/react-shared": "^0.0.1", + "@0xproject/utils": "^0.4.1", "basscss": "^8.0.3", "compare-versions": "^3.0.1", "lodash": "^4.17.4", diff --git a/packages/react-docs/src/ts/components/custom_enum.tsx b/packages/react-docs/src/ts/components/custom_enum.tsx index deb33ff1d..1fe55eedc 100644 --- a/packages/react-docs/src/ts/components/custom_enum.tsx +++ b/packages/react-docs/src/ts/components/custom_enum.tsx @@ -1,3 +1,4 @@ +import { logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import * as React from 'react'; @@ -16,7 +17,7 @@ export interface CustomEnumProps { export function CustomEnum(props: CustomEnumProps) { const type = props.type; if (!_.startsWith(type.defaultValue, STRING_ENUM_CODE_PREFIX)) { - utils.consoleLog('We do not yet support `Variable` types that are not strEnums'); + logUtils.log('We do not yet support `Variable` types that are not strEnums'); return null; } // Remove the prefix and postfix, leaving only the strEnum values without quotes. diff --git a/packages/react-docs/src/ts/utils/utils.ts b/packages/react-docs/src/ts/utils/utils.ts index 8e1a80a44..f8c1fefff 100644 --- a/packages/react-docs/src/ts/utils/utils.ts +++ b/packages/react-docs/src/ts/utils/utils.ts @@ -1,9 +1,4 @@ export const utils = { - consoleLog(message: string) { - /* tslint:disable */ - console.log(message); - /* tslint:enable */ - }, spawnSwitchErr(name: string, value: any) { return new Error(`Unexpected switch value: ${value} encountered for ${name}`); }, diff --git a/packages/react-docs/tsconfig.json b/packages/react-docs/tsconfig.json index 44055a037..ee715a452 100644 --- a/packages/react-docs/tsconfig.json +++ b/packages/react-docs/tsconfig.json @@ -9,5 +9,5 @@ "*": ["node_modules/@types/*", "*"] } }, - "include": ["./src/ts/**/*"] + "include": ["./src/ts/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"] } diff --git a/packages/sra-report/src/index.ts b/packages/sra-report/src/index.ts index d23549916..e9d55ab9b 100644 --- a/packages/sra-report/src/index.ts +++ b/packages/sra-report/src/index.ts @@ -1,7 +1,7 @@ #!/usr/bin/env node import { assert } from '@0xproject/assert'; import { Schema, schemas } from '@0xproject/json-schemas'; -import { promisify } from '@0xproject/utils'; +import { logUtils, promisify } from '@0xproject/utils'; import chalk from 'chalk'; import * as _ from 'lodash'; import * as newman from 'newman'; @@ -10,7 +10,6 @@ import * as yargs from 'yargs'; import * as sraReportCollectionJSON from '../postman_configs/collections/sra_report.postman_collection.json'; import { postmanEnvironmentFactory } from './postman_environment_factory'; -import { utils } from './utils'; const newmanRunAsync = promisify(newman.run); const DEFAULT_NETWORK_ID = 1; @@ -66,12 +65,12 @@ const args = yargs try { assert.isWebUri('args', args.endpointUrl); } catch (err) { - utils.log(`${chalk.red(`Invalid url format:`)} ${args.endpointUrl}`); + logUtils.log(`${chalk.red(`Invalid url format:`)} ${args.endpointUrl}`); process.exit(1); } if (!_.includes(SUPPORTED_NETWORK_IDS, args.networkId)) { - utils.log(`${chalk.red(`Unsupported network id:`)} ${args.networkId}`); - utils.log(`${chalk.bold(`Supported network ids:`)} ${SUPPORTED_NETWORK_IDS}`); + logUtils.log(`${chalk.red(`Unsupported network id:`)} ${args.networkId}`); + logUtils.log(`${chalk.bold(`Supported network ids:`)} ${SUPPORTED_NETWORK_IDS}`); process.exit(1); } const mainAsync = async () => { @@ -99,4 +98,4 @@ const mainAsync = async () => { }; await newmanRunAsync(newmanRunOptions); }; -mainAsync().catch(utils.log); +mainAsync().catch(logUtils.log); diff --git a/packages/sra-report/src/postman_environment_factory.ts b/packages/sra-report/src/postman_environment_factory.ts index ffac7ac2e..530cacb07 100644 --- a/packages/sra-report/src/postman_environment_factory.ts +++ b/packages/sra-report/src/postman_environment_factory.ts @@ -1,6 +1,7 @@ import { SignedOrder, ZeroEx } from '0x.js'; import { HttpClient } from '@0xproject/connect'; import { Schema, schemas as schemasByName } from '@0xproject/json-schemas'; +import { logUtils } from '@0xproject/utils'; import chalk from 'chalk'; import * as _ from 'lodash'; @@ -8,7 +9,6 @@ import { addresses as kovanAddresses } from './contract_addresses/kovan_addresse import { addresses as mainnetAddresses } from './contract_addresses/mainnet_addresses'; import { addresses as rinkebyAddresses } from './contract_addresses/rinkeby_addresses'; import { addresses as ropstenAddresses } from './contract_addresses/ropsten_addresses'; -import { utils } from './utils'; const ENVIRONMENT_NAME = 'SRA Report'; @@ -81,7 +81,7 @@ async function createOrderEnvironmentValuesAsync(url: string) { createEnvironmentValue('orderHash', ZeroEx.getOrderHashHex(orderIfExists)), ]; } else { - utils.log(`${chalk.red(`No orders from /orders found`)}`); + logUtils.log(`${chalk.red(`No orders from /orders found`)}`); return [ createEnvironmentValue('order', ''), createEnvironmentValue('orderMaker', ''), diff --git a/packages/sra-report/src/utils.ts b/packages/sra-report/src/utils.ts deleted file mode 100644 index 5423cabd9..000000000 --- a/packages/sra-report/src/utils.ts +++ /dev/null @@ -1,5 +0,0 @@ -export const utils = { - log(...args: any[]): void { - console.log(...args); // tslint:disable-line:no-console - }, -}; diff --git a/packages/testnet-faucets/src/ts/dispatch_queue.ts b/packages/testnet-faucets/src/ts/dispatch_queue.ts index 672511619..2dbeeba7a 100644 --- a/packages/testnet-faucets/src/ts/dispatch_queue.ts +++ b/packages/testnet-faucets/src/ts/dispatch_queue.ts @@ -1,8 +1,7 @@ -import { intervalUtils } from '@0xproject/utils'; +import { intervalUtils, logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import { errorReporter } from './error_reporter'; -import { utils } from './utils'; const MAX_QUEUE_SIZE = 500; const DEFAULT_QUEUE_INTERVAL_MS = 1000; @@ -45,7 +44,7 @@ export class DispatchQueue { }, this._queueIntervalMs, (err: Error) => { - utils.consoleLog(`Unexpected err: ${err} - ${JSON.stringify(err)}`); + logUtils.log(`Unexpected err: ${err} - ${JSON.stringify(err)}`); // tslint:disable-next-line:no-floating-promises errorReporter.reportAsync(err); }, diff --git a/packages/testnet-faucets/src/ts/dispense_asset_tasks.ts b/packages/testnet-faucets/src/ts/dispense_asset_tasks.ts index 56b0a9e45..99f1bad36 100644 --- a/packages/testnet-faucets/src/ts/dispense_asset_tasks.ts +++ b/packages/testnet-faucets/src/ts/dispense_asset_tasks.ts @@ -1,11 +1,10 @@ import { ZeroEx } from '0x.js'; -import { BigNumber, promisify } from '@0xproject/utils'; +import { BigNumber, logUtils, promisify } from '@0xproject/utils'; import * as _ from 'lodash'; import * as Web3 from 'web3'; import { configs } from './configs'; import { errorReporter } from './error_reporter'; -import { utils } from './utils'; const DISPENSE_AMOUNT_ETHER = 0.1; const DISPENSE_AMOUNT_TOKEN = 0.1; @@ -15,11 +14,11 @@ const DISPENSE_MAX_AMOUNT_ETHER = 2; export const dispenseAssetTasks = { dispenseEtherTask(recipientAddress: string, web3: Web3) { return async () => { - utils.consoleLog(`Processing ETH ${recipientAddress}`); + logUtils.log(`Processing ETH ${recipientAddress}`); const userBalance = await promisify(web3.eth.getBalance)(recipientAddress); const maxAmountInWei = new BigNumber(web3.toWei(DISPENSE_MAX_AMOUNT_ETHER, 'ether')); if (userBalance.greaterThanOrEqualTo(maxAmountInWei)) { - utils.consoleLog( + logUtils.log( `User exceeded ETH balance maximum (${maxAmountInWei}) ${recipientAddress} ${userBalance} `, ); return; @@ -30,12 +29,12 @@ export const dispenseAssetTasks = { to: recipientAddress, value: web3.toWei(DISPENSE_AMOUNT_ETHER, 'ether'), }); - utils.consoleLog(`Sent ${DISPENSE_AMOUNT_ETHER} ETH to ${recipientAddress} tx: ${txHash}`); + logUtils.log(`Sent ${DISPENSE_AMOUNT_ETHER} ETH to ${recipientAddress} tx: ${txHash}`); }; }, dispenseTokenTask(recipientAddress: string, tokenSymbol: string, zeroEx: ZeroEx) { return async () => { - utils.consoleLog(`Processing ${tokenSymbol} ${recipientAddress}`); + logUtils.log(`Processing ${tokenSymbol} ${recipientAddress}`); const amountToDispense = new BigNumber(DISPENSE_AMOUNT_TOKEN); const token = await zeroEx.tokenRegistry.getTokenBySymbolIfExistsAsync(tokenSymbol); if (_.isUndefined(token)) { @@ -48,7 +47,7 @@ export const dispenseAssetTasks = { token.decimals, ); if (userBalanceBaseUnits.greaterThanOrEqualTo(maxAmountBaseUnits)) { - utils.consoleLog( + logUtils.log( `User exceeded token balance maximum (${maxAmountBaseUnits}) ${recipientAddress} ${userBalanceBaseUnits} `, ); return; @@ -59,7 +58,7 @@ export const dispenseAssetTasks = { recipientAddress, baseUnitAmount, ); - utils.consoleLog(`Sent ${amountToDispense} ZRX to ${recipientAddress} tx: ${txHash}`); + logUtils.log(`Sent ${amountToDispense} ZRX to ${recipientAddress} tx: ${txHash}`); }; }, }; diff --git a/packages/testnet-faucets/src/ts/error_reporter.ts b/packages/testnet-faucets/src/ts/error_reporter.ts index 7fd76bde5..f0f3ca679 100644 --- a/packages/testnet-faucets/src/ts/error_reporter.ts +++ b/packages/testnet-faucets/src/ts/error_reporter.ts @@ -1,8 +1,8 @@ +import { logUtils } from '@0xproject/utils'; import * as express from 'express'; import rollbar = require('rollbar'); import { configs } from './configs'; -import { utils } from './utils'; export const errorReporter = { setup() { @@ -11,7 +11,7 @@ export const errorReporter = { }); rollbar.handleUncaughtExceptions(configs.ROLLBAR_ACCESS_KEY); process.on('unhandledRejection', async (err: Error) => { - utils.consoleLog(`Uncaught exception ${err}. Stack: ${err.stack}`); + logUtils.log(`Uncaught exception ${err}. Stack: ${err.stack}`); await this.reportAsync(err); process.exit(1); }); @@ -23,7 +23,7 @@ export const errorReporter = { return new Promise((resolve, reject) => { rollbar.handleError(err, req, (rollbarErr: Error) => { if (rollbarErr) { - utils.consoleLog(`Error reporting to rollbar, ignoring: ${rollbarErr}`); + logUtils.log(`Error reporting to rollbar, ignoring: ${rollbarErr}`); reject(rollbarErr); } else { resolve(); diff --git a/packages/testnet-faucets/src/ts/handler.ts b/packages/testnet-faucets/src/ts/handler.ts index 5f6ada186..f9ac484de 100644 --- a/packages/testnet-faucets/src/ts/handler.ts +++ b/packages/testnet-faucets/src/ts/handler.ts @@ -1,5 +1,5 @@ import { Order, SignedOrder, ZeroEx } from '0x.js'; -import { BigNumber } from '@0xproject/utils'; +import { BigNumber, logUtils } from '@0xproject/utils'; import * as express from 'express'; import * as _ from 'lodash'; import * as Web3 from 'web3'; @@ -19,7 +19,6 @@ import { DispatchQueue } from './dispatch_queue'; import { dispenseAssetTasks } from './dispense_asset_tasks'; import { idManagement } from './id_management'; import { rpcUrls } from './rpc_urls'; -import { utils } from './utils'; interface NetworkConfig { dispatchQueue: DispatchQueue; @@ -118,7 +117,7 @@ export class Handler { res.status(503).send('QUEUE_IS_FULL'); return; } - utils.consoleLog(`Added ${recipient} to queue: ${requestedAssetType} networkId: ${networkId}`); + logUtils.log(`Added ${recipient} to queue: ${requestedAssetType} networkId: ${networkId}`); res.status(200).end(); } private async _dispenseOrder(req: express.Request, res: express.Response, requestedAssetType: RequestedAssetType) { @@ -163,7 +162,7 @@ export class Handler { }; const signedOrderHash = ZeroEx.getOrderHashHex(signedOrder); const payload = JSON.stringify(signedOrder); - utils.consoleLog(`Dispensed signed order: ${payload}`); + logUtils.log(`Dispensed signed order: ${payload}`); res.status(200).send(payload); } } diff --git a/packages/testnet-faucets/src/ts/parameter_transformer.ts b/packages/testnet-faucets/src/ts/parameter_transformer.ts index c5711d462..2630a5e0b 100644 --- a/packages/testnet-faucets/src/ts/parameter_transformer.ts +++ b/packages/testnet-faucets/src/ts/parameter_transformer.ts @@ -4,7 +4,6 @@ import * as _ from 'lodash'; import { configs } from './configs'; import { rpcUrls } from './rpc_urls'; -import { utils } from './utils'; const DEFAULT_NETWORK_ID = 42; // kovan diff --git a/packages/testnet-faucets/src/ts/utils.ts b/packages/testnet-faucets/src/ts/utils.ts deleted file mode 100644 index 893f82ca3..000000000 --- a/packages/testnet-faucets/src/ts/utils.ts +++ /dev/null @@ -1,7 +0,0 @@ -export const utils = { - consoleLog(message: string) { - /* tslint:disable */ - console.log(message); - /* tslint:enable */ - }, -}; diff --git a/packages/testnet-faucets/tsconfig.json b/packages/testnet-faucets/tsconfig.json index 5deaaebe6..237f62169 100644 --- a/packages/testnet-faucets/tsconfig.json +++ b/packages/testnet-faucets/tsconfig.json @@ -6,6 +6,7 @@ }, "include": [ "./src/ts/**/*", + "../../node_modules/ethers-typescript-typings/index.d.ts", "../../node_modules/types-bn/index.d.ts", "../../node_modules/types-ethereumjs-util/index.d.ts", "../../node_modules/web3-typescript-typings/index.d.ts" diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts index 39dede41f..debcce746 100644 --- a/packages/utils/src/index.ts +++ b/packages/utils/src/index.ts @@ -4,3 +4,4 @@ export { classUtils } from './class_utils'; export { intervalUtils } from './interval_utils'; export { BigNumber } from './configured_bignumber'; export { AbiDecoder } from './abi_decoder'; +export { logUtils } from './log_utils'; diff --git a/packages/utils/src/log_utils.ts b/packages/utils/src/log_utils.ts new file mode 100644 index 000000000..d0f0e34c9 --- /dev/null +++ b/packages/utils/src/log_utils.ts @@ -0,0 +1,5 @@ +export const logUtils = { + log(...args: any[]): void { + console.log(...args); // tslint:disable-line:no-console + }, +}; diff --git a/packages/website/ts/blockchain.ts b/packages/website/ts/blockchain.ts index c92023541..a3427baee 100644 --- a/packages/website/ts/blockchain.ts +++ b/packages/website/ts/blockchain.ts @@ -23,7 +23,7 @@ import { LedgerWalletSubprovider, RedundantRPCSubprovider, } from '@0xproject/subproviders'; -import { BigNumber, intervalUtils, promisify } from '@0xproject/utils'; +import { BigNumber, intervalUtils, logUtils, promisify } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as _ from 'lodash'; import * as React from 'react'; @@ -405,7 +405,7 @@ export class Blockchain { }, 5000, (err: Error) => { - utils.consoleLog(`Polling tokenBalance failed: ${err}`); + logUtils.log(`Polling tokenBalance failed: ${err}`); intervalUtils.clearAsyncExcludingInterval(tokenPollInterval); reject(err); }, @@ -822,7 +822,7 @@ export class Blockchain { if (!_.isUndefined(contractAddress)) { const doesContractExist = await this.doesContractExistAtAddressAsync(contractAddress); if (!doesContractExist) { - utils.consoleLog(`Contract does not exist: ${artifact.contract_name} at ${contractAddress}`); + logUtils.log(`Contract does not exist: ${artifact.contract_name} at ${contractAddress}`); throw new Error(BlockchainCallErrs.ContractDoesNotExist); } } @@ -832,7 +832,7 @@ export class Blockchain { return contractInstance; } catch (err) { const errMsg = `${err}`; - utils.consoleLog(`Notice: Error encountered: ${err} ${err.stack}`); + logUtils.log(`Notice: Error encountered: ${err} ${err.stack}`); if (_.includes(errMsg, 'not been deployed to detected network')) { throw new Error(BlockchainCallErrs.ContractDoesNotExist); } else { diff --git a/packages/website/ts/blockchain_watcher.ts b/packages/website/ts/blockchain_watcher.ts index d3801cef4..2712b2c04 100644 --- a/packages/website/ts/blockchain_watcher.ts +++ b/packages/website/ts/blockchain_watcher.ts @@ -1,4 +1,4 @@ -import { BigNumber, intervalUtils, promisify } from '@0xproject/utils'; +import { BigNumber, intervalUtils, logUtils, promisify } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as _ from 'lodash'; import { Dispatcher } from 'ts/redux/dispatcher'; @@ -87,7 +87,7 @@ export class BlockchainWatcher { }, 5000, (err: Error) => { - utils.consoleLog(`Watching network and balances failed: ${err.stack}`); + logUtils.log(`Watching network and balances failed: ${err.stack}`); this._stopEmittingNetworkConnectionAndUserBalanceStateAsync(); }, ); diff --git a/packages/website/ts/components/dialogs/ledger_config_dialog.tsx b/packages/website/ts/components/dialogs/ledger_config_dialog.tsx index 87b75ed95..d7190c0bb 100644 --- a/packages/website/ts/components/dialogs/ledger_config_dialog.tsx +++ b/packages/website/ts/components/dialogs/ledger_config_dialog.tsx @@ -1,6 +1,6 @@ import { ZeroEx } from '0x.js'; import { colors, constants as sharedConstants } from '@0xproject/react-shared'; -import { BigNumber } from '@0xproject/utils'; +import { BigNumber, logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import Dialog from 'material-ui/Dialog'; import FlatButton from 'material-ui/FlatButton'; @@ -239,7 +239,7 @@ export class LedgerConfigDialog extends React.Component { const validationResult = validator.validate(order, portalOrderSchema); if (validationResult.errors.length > 0) { orderJSONErrMsg = 'Submitted order JSON is not a valid order'; - utils.consoleLog(`Unexpected order JSON validation error: ${validationResult.errors.join(', ')}`); + logUtils.log(`Unexpected order JSON validation error: ${validationResult.errors.join(', ')}`); return; } parsedOrder = order; @@ -448,7 +448,7 @@ export class FillOrder extends React.Component { this.props.dispatcher.updateUserSuppliedOrderCache(parsedOrder); } } catch (err) { - utils.consoleLog(`Validate order err: ${err}`); + logUtils.log(`Validate order err: ${err}`); if (!_.isEmpty(orderJSON)) { orderJSONErrMsg = 'Submitted order JSON is not valid JSON'; } @@ -564,7 +564,7 @@ export class FillOrder extends React.Component { return; } globalErrMsg = 'Failed to fill order, please refresh and try again'; - utils.consoleLog(`${err}`); + logUtils.log(`${err}`); this.setState({ globalErrMsg, }); @@ -635,7 +635,7 @@ export class FillOrder extends React.Component { } analytics.logEvent('Portal', 'Cancel Order Failure', eventLabel, parsedOrder.signedOrder.makerTokenAmount); globalErrMsg = 'Failed to cancel order, please refresh and try again'; - utils.consoleLog(`${err}`); + logUtils.log(`${err}`); this.setState({ globalErrMsg, }); diff --git a/packages/website/ts/components/generate_order/generate_order_form.tsx b/packages/website/ts/components/generate_order/generate_order_form.tsx index 559acd1d6..eb76cb529 100644 --- a/packages/website/ts/components/generate_order/generate_order_form.tsx +++ b/packages/website/ts/components/generate_order/generate_order_form.tsx @@ -1,6 +1,6 @@ import { ECSignature, Order, ZeroEx } from '0x.js'; import { colors, constants as sharedConstants } from '@0xproject/react-shared'; -import { BigNumber } from '@0xproject/utils'; +import { BigNumber, logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import Dialog from 'material-ui/Dialog'; import Divider from 'material-ui/Divider'; @@ -326,7 +326,7 @@ export class GenerateOrderForm extends React.Component 0) { globalErrMsg = 'Order signing failed. Please refresh and try again'; - utils.consoleLog(`Unexpected error occured: Order validation failed: + logUtils.log(`Unexpected error occured: Order validation failed: ${validationResult.errors}`); } } catch (err) { @@ -335,8 +335,8 @@ export class GenerateOrderForm extends React.Component ${responseBody}`); + logUtils.log(`Unexpected status code: ${response.status} -> ${responseBody}`); await errorReporter.reportAsync(new Error(`Bitly returned non-200: ${JSON.stringify(response)}`)); return ''; } diff --git a/packages/website/ts/components/portal.tsx b/packages/website/ts/components/portal.tsx index 7df340f45..5bdb5bde9 100644 --- a/packages/website/ts/components/portal.tsx +++ b/packages/website/ts/components/portal.tsx @@ -1,5 +1,5 @@ import { colors } from '@0xproject/react-shared'; -import { BigNumber } from '@0xproject/utils'; +import { BigNumber, logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import CircularProgress from 'material-ui/CircularProgress'; import Paper from 'material-ui/Paper'; @@ -374,7 +374,7 @@ export class Portal extends React.Component { const order = JSON.parse(decodeURIComponent(orderPair[1])); const validationResult = validator.validate(order, portalOrderSchema); if (validationResult.errors.length > 0) { - utils.consoleLog(`Invalid shared order: ${validationResult.errors}`); + logUtils.log(`Invalid shared order: ${validationResult.errors}`); return undefined; } return order; diff --git a/packages/website/ts/components/send_button.tsx b/packages/website/ts/components/send_button.tsx index ffa165f60..79c103e05 100644 --- a/packages/website/ts/components/send_button.tsx +++ b/packages/website/ts/components/send_button.tsx @@ -1,4 +1,4 @@ -import { BigNumber } from '@0xproject/utils'; +import { BigNumber, logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import RaisedButton from 'material-ui/RaisedButton'; import * as React from 'react'; @@ -77,8 +77,8 @@ export class SendButton extends React.Component ${responseBody}`); + logUtils.log(`Unexpected status code: ${response.status} -> ${responseBody}`); const errorType = response.status === constants.UNAVAILABLE_STATUS ? BalanceErrs.faucetQueueIsFull diff --git a/packages/website/ts/pages/wiki/wiki.tsx b/packages/website/ts/pages/wiki/wiki.tsx index f6cff51e4..e2dd3a68e 100644 --- a/packages/website/ts/pages/wiki/wiki.tsx +++ b/packages/website/ts/pages/wiki/wiki.tsx @@ -8,6 +8,7 @@ import { Styles, utils as sharedUtils, } from '@0xproject/react-shared'; +import { logUtils } from '@0xproject/utils'; import * as _ from 'lodash'; import CircularProgress from 'material-ui/CircularProgress'; import RaisedButton from 'material-ui/RaisedButton'; @@ -213,7 +214,7 @@ export class Wiki extends React.Component { if (response.status !== 200) { // TODO: Show the user an error message when the wiki fail to load const errMsg = await response.text(); - utils.consoleLog(`Failed to load wiki: ${response.status} ${errMsg}`); + logUtils.log(`Failed to load wiki: ${response.status} ${errMsg}`); return; } const articlesBySection = await response.json(); diff --git a/packages/website/ts/utils/doc_utils.ts b/packages/website/ts/utils/doc_utils.ts index 0686e3e7f..6b3f5f378 100644 --- a/packages/website/ts/utils/doc_utils.ts +++ b/packages/website/ts/utils/doc_utils.ts @@ -1,4 +1,5 @@ import { DoxityDocObj, TypeDocNode } from '@0xproject/react-docs'; +import { logUtils } from '@0xproject/utils'; import findVersions = require('find-versions'); import * as _ from 'lodash'; import { S3FileObject, VersionToFileName } from 'ts/types'; @@ -20,7 +21,7 @@ export const docUtils = { if (response.status !== 200) { // TODO: Show the user an error message when the docs fail to load const errMsg = await response.text(); - utils.consoleLog(`Failed to load JSON file list: ${response.status} ${errMsg}`); + logUtils.log(`Failed to load JSON file list: ${response.status} ${errMsg}`); throw new Error(errMsg); } const responseXML = await response.text(); @@ -43,7 +44,7 @@ export const docUtils = { if (response.status !== 200) { // TODO: Show the user an error message when the docs fail to load const errMsg = await response.text(); - utils.consoleLog(`Failed to load Doc JSON: ${response.status} ${errMsg}`); + logUtils.log(`Failed to load Doc JSON: ${response.status} ${errMsg}`); throw new Error(errMsg); } const jsonDocObj = await response.json(); diff --git a/packages/website/ts/utils/error_reporter.ts b/packages/website/ts/utils/error_reporter.ts index 0bd247c5b..19f563880 100644 --- a/packages/website/ts/utils/error_reporter.ts +++ b/packages/website/ts/utils/error_reporter.ts @@ -1,3 +1,4 @@ +import { logUtils } from '@0xproject/utils'; import { Environments } from 'ts/types'; import { configs } from 'ts/utils/configs'; import { constants } from 'ts/utils/constants'; @@ -40,7 +41,7 @@ export const errorReporter = { return new Promise((resolve, reject) => { rollbar.error(err, (rollbarErr: Error) => { if (rollbarErr) { - utils.consoleLog(`Error reporting to rollbar, ignoring: ${rollbarErr}`); + logUtils.log(`Error reporting to rollbar, ignoring: ${rollbarErr}`); // We never want to reject and cause the app to throw because of rollbar resolve(); } else { diff --git a/packages/website/ts/utils/utils.ts b/packages/website/ts/utils/utils.ts index 5fcd3f8e5..d2ec3e886 100644 --- a/packages/website/ts/utils/utils.ts +++ b/packages/website/ts/utils/utils.ts @@ -95,11 +95,6 @@ export const utils = { }; return order; }, - consoleLog(message: string) { - /* tslint:disable */ - console.log(message); - /* tslint:enable */ - }, async sleepAsync(ms: number) { return new Promise(resolve => setTimeout(resolve, ms)); }, -- cgit v1.2.3 From 6a8c2cb7172be9b0aadb34904d1d9b3348bed0cc Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 13 Mar 2018 18:16:31 -0700 Subject: Update CHANGELOGs --- packages/0x.js/CHANGELOG.md | 4 ++++ packages/abi-gen/CHANGELOG.md | 4 ++++ packages/deployer/CHANGELOG.md | 1 + packages/react-docs/CHANGELOG.md | 3 ++- packages/sra-report/CHANGELOG.md | 4 ++++ packages/utils/CHANGELOG.md | 4 ++++ 6 files changed, 19 insertions(+), 1 deletion(-) diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md index 90d61a30f..78368d89b 100644 --- a/packages/0x.js/CHANGELOG.md +++ b/packages/0x.js/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## v0.33.2 - _TBD, 2018_ + + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) + ## v0.33.1 - _March 8, 2018_ * Add missing EthersJs typescript typings as dependency diff --git a/packages/abi-gen/CHANGELOG.md b/packages/abi-gen/CHANGELOG.md index 90e82c632..e7581fb10 100644 --- a/packages/abi-gen/CHANGELOG.md +++ b/packages/abi-gen/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## v0.2.5 - _TBD, 2018_ + + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) + ## v0.2.4 - _March 4, 2018_ * Add a `backend` parameter that allows you to specify the Ethereum library you use in your templates (`web3` or `ethers`). Ethers auto-converts small ints to numbers whereas Web3 doesn't. Defaults to `web3` (#413) diff --git a/packages/deployer/CHANGELOG.md b/packages/deployer/CHANGELOG.md index 4b4fd76c7..68134b14f 100644 --- a/packages/deployer/CHANGELOG.md +++ b/packages/deployer/CHANGELOG.md @@ -10,6 +10,7 @@ * Add `bytecode`, `runtime_bytecode`, `source_map`, `source_map_runtime` and `sources` fields to artifacts (#426) * Remove 0x-specific `migrate` command (#426) * Allow deployer to accept a provider instead of port and host. This makes it possible to run it with in-process ganache-core (#426) + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) ## v0.2.0 - _March 4, 2018_ diff --git a/packages/react-docs/CHANGELOG.md b/packages/react-docs/CHANGELOG.md index bd459cc77..a90cf19f0 100644 --- a/packages/react-docs/CHANGELOG.md +++ b/packages/react-docs/CHANGELOG.md @@ -1,5 +1,6 @@ # CHANGELOG -## v0.0.2 - _TBD_ +## v0.0.2 - _TBD, 2018_ * Move example out into a separate sub-package + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) diff --git a/packages/sra-report/CHANGELOG.md b/packages/sra-report/CHANGELOG.md index 43b92d58a..ede98a60f 100644 --- a/packages/sra-report/CHANGELOG.md +++ b/packages/sra-report/CHANGELOG.md @@ -1,3 +1,7 @@ # CHANGELOG +## v0.0.2 - _TBD, 2018_ + + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) + ## v0.0.1 - _March 8, 2018_ diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md index bf9cf53b4..5488d4f8c 100644 --- a/packages/utils/CHANGELOG.md +++ b/packages/utils/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## v0.4.1 - _TBD, 2018_ + + * Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452) + ## v0.4.0 - _March 4, 2018_ * Use `ethers-contracts` as a backend to decode event args (#413) -- cgit v1.2.3 From 3b3d5b12bc78b13860504b9699fd5f15ae8813a1 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Wed, 14 Mar 2018 14:58:16 -0700 Subject: Keep console.log in monorepo-scripts --- packages/monorepo-scripts/package.json | 1 - packages/monorepo-scripts/src/deps_versions.ts | 7 ++++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/monorepo-scripts/package.json b/packages/monorepo-scripts/package.json index 3a6fecf6a..e0ca3cd1f 100644 --- a/packages/monorepo-scripts/package.json +++ b/packages/monorepo-scripts/package.json @@ -30,7 +30,6 @@ "typescript": "2.7.1" }, "dependencies": { - "@0xproject/utils": "^0.4.1", "es6-promisify": "^5.0.0", "async-child-process": "^1.1.1", "publish-release": "0xproject/publish-release", diff --git a/packages/monorepo-scripts/src/deps_versions.ts b/packages/monorepo-scripts/src/deps_versions.ts index d8728dade..07292a160 100644 --- a/packages/monorepo-scripts/src/deps_versions.ts +++ b/packages/monorepo-scripts/src/deps_versions.ts @@ -1,11 +1,12 @@ #!/usr/bin/env node -import { logUtils } from '@0xproject/utils'; import chalk from 'chalk'; import * as fs from 'fs'; import { sync as globSync } from 'glob'; import * as _ from 'lodash'; +import { utils } from './utils'; + interface Dependencies { [depName: string]: string; } @@ -45,9 +46,9 @@ _.map(versionsByDependency, (versions: Versions, depName: string) => { if (_.uniq(_.values(versions)).length === 1) { delete versionsByDependency[depName]; } else { - logUtils.log(chalk.bold(depName)); + utils.log(chalk.bold(depName)); _.map(versions, (version: string, packageName: string) => { - logUtils.log(`├── ${packageName} -> ${version}`); + utils.log(`├── ${packageName} -> ${version}`); }); } }); -- cgit v1.2.3