Merge pull request #2560 from poanetwork/ab-fix-slash-with-not-empty-path

fix slash before not empty path in docs

CHANGELOG.md

@@ -20,6 +20,7 @@
 
 ### Fixes
 - [#2562](https://github.com/poanetwork/blockscout/pull/2562) - Fix dark theme flickering
+- [#2560](https://github.com/poanetwork/blockscout/pull/2560) - fix slash before not empty path in docs
 - [#2559](https://github.com/poanetwork/blockscout/pull/2559) - fix rsk total supply for empty exchange rate
 - [#2553](https://github.com/poanetwork/blockscout/pull/2553) - Dark theme import to the end of sass
 - [#2550](https://github.com/poanetwork/blockscout/pull/2550) - correctly encode decimal values for frontend

apps/block_scout_web/lib/block_scout_web/templates/api_docs/eth_rpc.html.eex

@@ -2,7 +2,7 @@
   <div class="card">
     <div class="card-body">
       <h1 class="card-title margin-bottom-sm"><%= gettext("ETH RPC API Documentation") %></h2>
-      <p class="api-text-monospace" data-endpoint-url="<%= blockscout_url() %>api/eth_rpc">[ <%= gettext "Base URL:" %> <%= blockscout_url() %>api/eth_rpc ]</p>
+      <p class="api-text-monospace" data-endpoint-url="<%= eth_rpc_api_url() %>">[ <%= gettext "Base URL:" %> <%= eth_rpc_api_url()%> ]</p>
       <p class="card-subtitle margin-bottom-0">
         <%= gettext "This API is provided to support some rpc methods in the exact format specified for ethereum nodes, which can be found " %>
 

apps/block_scout_web/lib/block_scout_web/templates/api_docs/index.html.eex

@@ -2,7 +2,7 @@
   <div class="card">
     <div class="card-body">
       <h1 class="card-title margin-bottom-sm"><%= gettext("API Documentation") %></h2>
-      <p class="api-text-monospace" data-endpoint-url="<%= blockscout_url() %>api">[ <%= gettext "Base URL:" %> <%= blockscout_url() %>api ]</p>
+      <p class="api-text-monospace" data-endpoint-url="<%= api_url() %>">[ <%= gettext "Base URL:" %> <%= api_url()%> ]</p>
       <p class="card-subtitle margin-bottom-0"><%= gettext "This API is provided for developers transitioning their applications from Etherscan to BlockScout. It supports GET and POST requests." %></p>
     </div>
     <div class="api-anchors-list">

apps/block_scout_web/lib/block_scout_web/views/api_docs_view.ex

@@ -46,4 +46,18 @@ defmodule BlockScoutWeb.APIDocsView do
       Endpoint.url()
     end
   end
+
+  def api_url do
+    handle_slash("api")
+  end
+
+  def eth_rpc_api_url do
+    handle_slash("api/eth_rpc")
+  end
+
+  defp handle_slash(path) do
+    base_url = blockscout_url()
+
+    Path.join(base_url, path)
+  end
 end

apps/block_scout_web/test/block_scout_web/views/api_docs_view_test.exs

@@ -28,4 +28,40 @@ defmodule BlockScoutWeb.ApiDocsViewTest do
       assert APIDocsView.blockscout_url() == "https://blockscout.com/chain/dog"
     end
   end
+
+  describe "api_url/1" do
+    test "adds slash before path" do
+      Application.put_env(:block_scout_web, BlockScoutWeb.Endpoint,
+        url: [scheme: "https", host: "blockscout.com", port: 9999, path: "/chain/dog"]
+      )
+
+      assert APIDocsView.api_url() == "https://blockscout.com/chain/dog/api"
+    end
+
+    test "does not add slash to empty path" do
+      Application.put_env(:block_scout_web, BlockScoutWeb.Endpoint,
+        url: [scheme: "https", host: "blockscout.com", port: 9999, path: ""]
+      )
+
+      assert APIDocsView.api_url() == "https://blockscout.com/api"
+    end
+  end
+
+  describe "eth_rpc_api_url/1" do
+    test "adds slash before path" do
+      Application.put_env(:block_scout_web, BlockScoutWeb.Endpoint,
+        url: [scheme: "https", host: "blockscout.com", port: 9999, path: "/chain/dog"]
+      )
+
+      assert APIDocsView.eth_rpc_api_url() == "https://blockscout.com/chain/dog/api/eth_rpc"
+    end
+
+    test "does not add slash to empty path" do
+      Application.put_env(:block_scout_web, BlockScoutWeb.Endpoint,
+        url: [scheme: "https", host: "blockscout.com", port: 9999, path: ""]
+      )
+
+      assert APIDocsView.eth_rpc_api_url() == "https://blockscout.com/api/eth_rpc"
+    end
+  end
 end