Merge pull request #4 from poanetwork/master

Updating Springrole blockscout with latest release

Author: 0x-genesys

.circleci/config.yml

@@ -122,6 +122,7 @@ jobs:
             - mix.exs
             - mix.lock
             - appspec.yml
+            - rel
   check_formatted:
     docker:
       # Ensure .tool-versions matches
@@ -279,6 +280,32 @@ jobs:
           name: Jest
           command: ./node_modules/.bin/jest
           working_directory: apps/block_scout_web/assets
+  release:
+    docker:
+      # Ensure .tool-versions matches
+      - image: circleci/elixir:1.7.2
+        environment:
+          MIX_ENV: prod
+
+    working_directory: ~/app
+
+    steps:
+      - attach_workspace:
+          at: .
+
+      - run: mix local.hex --force
+      - run: mix local.rebar --force
+      - run: mix release --verbose --env prod
+      - run:
+          name: Collecting artifacts
+          command: |
+            find -name 'blockscout.tar.gz' -exec sh -c 'mkdir -p ci_artifact && cp "$@" ci_artifact/ci_artifact_blockscout.tar.gz' _ {} +
+          when: always
+
+      - store_artifacts:
+          name: Uploading CI artifacts
+          path: ci_artifact/ci_artifact_blockscout.tar.gz
+          destination: ci_artifact_blockscout.tar.gz
   sobelow:
     docker:
       # Ensure .tool-versions matches
@@ -561,6 +588,9 @@ workflows:
       - jest:
           requires:
             - build
+      - release:
+          requires:
+            - build
       - sobelow:
           requires:
             - build

.credo.exs

@@ -75,8 +75,9 @@
         # Priority values are: `low, normal, high, higher`
         #
         {Credo.Check.Design.AliasUsage,
-         excluded_namespaces: ~w(Block Blocks Import Socket Task),
-         excluded_lastnames: ~w(Address DateTime Exporter Fetcher Full Instrumenter Monitor Name Number Repo Time Unit),
+         excluded_namespaces: ~w(Block Blocks Import Socket SpandexDatadog Task),
+         excluded_lastnames:
+           ~w(Address DateTime Exporter Fetcher Full Instrumenter Logger Monitor Name Number Repo Spec Time Unit),
          priority: :low},
 
         # For some checks, you can also set other parameters

README.md

@@ -7,7 +7,7 @@
 <h1 align="center">BlockScout</h1>
 <p align="center">Blockchain Explorer for inspecting and analyzing EVM Chains.</p>
 <div align="center">
-  
+
 [![CircleCI](https://circleci.com/gh/poanetwork/blockscout.svg?style=svg&circle-token=f8823a3d0090407c11f87028c73015a331dbf604)](https://circleci.com/gh/poanetwork/blockscout) [![Coverage Status](https://coveralls.io/repos/github/poanetwork/blockscout/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/blockscout?branch=master) [![Join the chat at https://gitter.im/poanetwork/blockscout](https://badges.gitter.im/poanetwork/blockscout.svg)](https://gitter.im/poanetwork/blockscout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 </div>
@@ -245,6 +245,22 @@ To view Modules and API Reference documentation:
 2. View the generated docs.  
 `open doc/index.html`
 
+## Front-end 
+
+### Javascript
+
+All Javascript files are under [apps/block_scout_web/assets/js](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/js) and the main file is [app.js](https://github.com/poanetwork/blockscout/blob/master/apps/block_scout_web/assets/js/app.js). This file imports all javascript used in the application. If you want to create a new JS file consider creating into [/js/pages](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/js/pages) or [/js/lib](https://github.com/poanetwork/blockscout/tree/master/apps/block_scout_web/assets/js/lib), as follows:
+
+#### js/lib
+This folder contains all scripts that can be reused in any page or can be used as a helper to some component.
+
+#### js/pages
+This folder contains the scripts that are specific for some page.
+
+#### Redux
+This project uses Redux to control the state in some pages. There are pages that have things happening in real-time thanks to the Phoenix channels, e.g. Address page, so the page state changes a lot depending on which events it is listening. The redux is also used to load some contents asynchronous, see [async_listing_load.js](https://github.com/poanetwork/blockscout/blob/master/apps/block_scout_web/assets/js/lib/async_listing_load.js).
+
+To understand how to build new pages that need redux in this project, see the [redux_helpers.js](https://github.com/poanetwork/blockscout/blob/master/apps/block_scout_web/assets/js/lib/redux_helpers.js)
 
 ## Internationalization
 
@@ -283,6 +299,33 @@ BlockScout is setup to export [Prometheus](https://prometheus.io/) metrics at `/
    3. Click "Load"
 6. View the dashboards.  (You will need to click-around and use BlockScout for the web-related metrics to show up.)
 
+## Tracing
+
+Blockscout supports tracing via
+[Spandex](http://[email protected]:spandex-project/spandex.git). Each application
+has its own tracer, that is configured internally to that application. In order
+to enable it, visit each application's `config/<env>.ex` and update its tracer
+configuration to change `disabled?: true` to `disabled?: false`. Do this for
+each application you'd like included in your trace data.
+
+Currently, only [Datadog](https://www.datadoghq.com/) is supported as a
+tracing backend, but more will be added soon.
+
+### DataDog
+
+If you would like to use DataDog, after enabling `Spandex`, set
+`"DATADOG_HOST"` and `"DATADOG_PORT"` environment variables to the
+host/port that your Datadog agent is running on. For more information on
+Datadog and the Datadog agent, see their
+[documentation](https://docs.datadoghq.com/).
+
+### Other
+
+If you want to use a different  backend, remove the
+`SpandexDatadog.ApiServer` `Supervisor.child_spec` from
+`Explorer.Application` and follow any instructions provided in `Spandex`
+for setting up that backend.
+
 ## Memory Usage
 
 The work queues for building the index of all blocks, balances (coin and token), and internal transactions can grow quite large.   By default, the soft-limit is 1 GiB, which can be changed in `apps/indexer/config/config.exs`:

apps/block_scout_web/assets/__tests__/lib/async_listing_load.js

@@ -0,0 +1,80 @@
+import { asyncReducer, asyncInitialState } from '../../js/lib/async_listing_load'
+
+describe('ELEMENTS_LOAD', () => {
+  test('sets only nextPagePath and ignores other keys', () => {
+    const state = Object.assign({}, asyncInitialState)
+    const action = { type: 'ELEMENTS_LOAD', nextPagePath: 'set', foo: 1 }
+    const output = asyncReducer(state, action)
+
+    expect(output.foo).not.toEqual(1)
+    expect(output.nextPagePath).toEqual('set')
+  })
+})
+
+describe('ADD_ITEM_KEY', () => {
+  test('sets itemKey to what was passed in the action', () => {
+    const expectedItemKey = 'expected.Key'
+
+    const state = Object.assign({}, asyncInitialState)
+    const action = { type: 'ADD_ITEM_KEY', itemKey: expectedItemKey } 
+    const output = asyncReducer(state, action)
+
+    expect(output.itemKey).toEqual(expectedItemKey)
+  })
+})
+
+describe('START_REQUEST', () => {
+  test('sets loading status to true', () => {
+    const state = Object.assign({}, asyncInitialState, { loading: false })
+    const action = { type: 'START_REQUEST' } 
+    const output = asyncReducer(state, action)
+
+    expect(output.loading).toEqual(true)
+  })
+})
+
+describe('REQUEST_ERROR', () => {
+  test('sets requestError to true', () => {
+    const state = Object.assign({}, asyncInitialState, { requestError: false })
+    const action = { type: 'REQUEST_ERROR' } 
+    const output = asyncReducer(state, action)
+
+    expect(output.requestError).toEqual(true)
+  })
+})
+
+describe('FINISH_REQUEST', () => {
+  test('sets loading status to false', () => {
+    const state = Object.assign({}, asyncInitialState, {
+      loading: true,
+      loadingFirstPage: true
+    })
+    const action = { type: 'FINISH_REQUEST' } 
+    const output = asyncReducer(state, action)
+
+    expect(output.loading).toEqual(false)
+    expect(output.loadingFirstPage).toEqual(false)
+  })
+})
+
+describe('ITEMS_FETCHED', () => {
+  test('sets the items to what was passed in the action', () => {
+    const expectedItems = [1, 2, 3]
+
+    const state = Object.assign({}, asyncInitialState)
+    const action = { type: 'ITEMS_FETCHED', items: expectedItems } 
+    const output = asyncReducer(state, action)
+
+    expect(output.items).toEqual(expectedItems)
+  })
+})
+
+describe('NAVIGATE_TO_OLDER', () => {
+  test('sets beyondPageOne to true', () => {
+    const state = Object.assign({}, asyncInitialState, { beyondPageOne: false })
+    const action = { type: 'NAVIGATE_TO_OLDER' } 
+    const output = asyncReducer(state, action)
+
+    expect(output.beyondPageOne).toEqual(true)
+  })
+})