Split API and WebApp routes

[saneery]

#2364

Motivation

To launch API endpoints separately from the web application.

There are three groups of endpoints:

• Read-only API
• Web app
• Write endpoints

Changelog

• Split API's and WebApp's endpoints into separate routers
• Save old endpoints for backward compatibility
• Update tests
• Add envs:
  • DISABLE_WEBAPP=true
  • DISABLE_READ_API =true
  • DISABLE_INDEXER=true
  • DISABLE_WRITE_API =true
  • WEBAPP_URL=http://host/path
  • API_URL=http://host/path

[coveralls]

Pull Request Test Coverage Report for Build 67d739b8-53c0-4bab-b3c4-225c6512606f

• 33 of 45 (73.33%) changed or added relevant lines in 6 files are covered.
• 2 unchanged lines in 2 files lost coverage.
• Overall coverage increased (+0.03%) to 79.267%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
apps/block_scout_web/lib/block_scout_web/web_router.ex	10	11	90.91%
apps/block_scout_web/lib/block_scout_web/api_router.ex	9	11	81.82%
apps/block_scout_web/lib/block_scout_web/router.ex	5	7	71.43%
apps/block_scout_web/lib/block_scout_web/views/layout_view.ex	3	6	50.0%
apps/indexer/lib/indexer/application.ex	0	4	0.0%

Files with Coverage Reduction	New Missed Lines	%
apps/block_scout_web/lib/block_scout_web/controllers/chain/market_history_chart_controller.ex	1	78.57%
apps/indexer/lib/indexer/application.ex	1	0.0%

Totals
Change from base Build 8058fcb5-b17e-4859-8b4a-a778a384046a:	0.03%
Covered Lines:	5192
Relevant Lines:	6550

---

💛 - Coveralls

[pasqu4le]

It seems you've forgot to add a CHANGELOG entry

[vbaranov]

@saneery

If I set export DISABLE_WEBAPP=true before launch

1. Indexer still works - I see new blocks. It shouldn't
2. I don't see api_docs view on the path. Instead, I see web app main page.

[saneery]

@saneery

If I set export DISABLE_WEBAPP=true before launch

1. Indexer still works - I see new blocks. It shouldn't

@vbaranov Maybe I should add new ENV var DISABLE_INDEXER ?

2. I don't see api_docs view on the path. Instead, I see web app main page.

The router gets ENV vars on compile-time, so you need recompile BS with that vars

$ DISABLE_WEBAPP=true mix compile --force

[vbaranov]

@vbaranov Maybe I should add new ENV var DISABLE_INDEXER ?

@saneery yes, it makes sense in order to increase manageability.

[vbaranov]

@saneery I set these env vars:

DISABLE_READ_API=true
API_URL=https://localhost:3000

I expect, that write API is working in this case on the application side, but when I open http://localhost:4000/api?module=contract&action=verify it gives me 404 error

I confirm that I set those vars before compiling.

[vbaranov]

@saneery

If I don't set any of new env vars, I expect that app should work in a full mode, but when I go to any item in APIs menu the application shows me 404 page instead of (eth) api docs or graphiql

[saneery]

@saneery

If I don't set any of new env vars, I expect that app should work in a full mode, but when I go to any item in APIs menu the application shows me 404 page instead of (eth) api docs or graphiql

@vbaranov 🤔 I don't have 404 on documentation pages

[saneery]

@vbaranov I don't know how to reproduce your issue

[vbaranov]

@saneery yes, I should revoke my last review. I tested all possible combinations of parameters. Seems, it works. Please resolve merging conflicts. And you didn't update docs/env-variables.md with the finalized set of ENV vars.

[vbaranov]

And it is odd that all tests on the real node failed.

[ayrat555]

tests are failing

** (CompileError) test/block_scout_web/controllers/api/v1/health_controller_test.exs:15: undefined function api_v1_health_path/2

[saneery]

@vbaranov @pasqu4le @ayrat555 I've repaired test, could you check the PR?

[pasqu4le]

Just one question