File size: 6,031 Bytes
c9c49ab | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | defmodule Plausible.Google.APITest do
use Plausible.DataCase, async: true
use Plausible.Test.Support.HTTPMocker
alias Plausible.Google
alias Plausible.Stats.{DateTimeRange, QueryBuilder}
import ExUnit.CaptureLog
import Mox
setup :verify_on_exit!
setup [:create_user, :create_site]
describe "fetch_stats/3 errors" do
setup %{user: user, site: site} do
insert(:google_auth,
user: user,
site: site,
property: "sc-domain:dummy.test",
expires: NaiveDateTime.add(NaiveDateTime.utc_now(), 3600)
)
:ok
end
test "returns generic google_auth_error on 401/403", %{site: site} do
expect(
Plausible.HTTPClient.Mock,
:post,
fn
"https://www.googleapis.com/webmasters/v3/sites/sc-domain%3Adummy.test/searchAnalytics/query",
[{"Authorization", "Bearer 123"}],
%{
dimensionFilterGroups: [],
dimensions: ["query"],
endDate: "2022-01-05",
rowLimit: 5,
startRow: 0,
startDate: "2022-01-01"
} ->
{:error, %{reason: %Finch.Response{status: Enum.random([401, 403])}}}
end
)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}
)
assert {:error, "google_auth_error"} = Google.API.fetch_stats(site, query, {5, 0}, "")
end
test "returns whatever error code google returns on API client error", %{site: site} do
expect(
Plausible.HTTPClient.Mock,
:post,
fn
"https://www.googleapis.com/webmasters/v3/sites/sc-domain%3Adummy.test/searchAnalytics/query",
_,
_ ->
{:error, %{reason: %Finch.Response{status: 400, body: %{"error" => "some_error"}}}}
end
)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}
)
assert {:error, "some_error"} = Google.API.fetch_stats(site, query, {5, 0}, "")
end
test "returns generic HTTP error and logs it", %{site: site} do
expect(
Plausible.HTTPClient.Mock,
:post,
fn
"https://www.googleapis.com/webmasters/v3/sites/sc-domain%3Adummy.test/searchAnalytics/query",
_,
_ ->
{:error, Finch.Error.exception(:some_reason)}
end
)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}
)
log =
capture_log(fn ->
assert {:error, "failed_to_list_stats"} =
Google.API.fetch_stats(site, query, {5, 0}, "")
end)
assert log =~
"Google Search Console: failed to list stats: %Finch.Error{reason: :some_reason}"
end
end
test "returns error when token refresh fails", %{user: user, site: site} do
mock_http_with("google_auth#invalid_grant.json")
insert(:google_auth,
user: user,
site: site,
property: "sc-domain:dummy.test",
access_token: "*****",
refresh_token: "*****",
expires: NaiveDateTime.add(NaiveDateTime.utc_now(), -3600)
)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}
)
assert {:error, "invalid_grant"} = Google.API.fetch_stats(site, query, 5, "")
end
test "returns error when google auth not configured", %{site: site} do
time_range = DateTimeRange.new!(~U[2022-01-01 00:00:00Z], ~U[2022-01-05 23:59:59Z])
query = %Plausible.Stats.Query{utc_time_range: time_range}
assert {:error, :google_property_not_configured} = Google.API.fetch_stats(site, query, 5, "")
end
describe "fetch_stats/3 with valid auth" do
setup %{user: user, site: site} do
insert(:google_auth,
user: user,
site: site,
property: "sc-domain:dummy.test",
expires: NaiveDateTime.add(NaiveDateTime.utc_now(), 3600)
)
:ok
end
test "returns name and visitor count", %{site: site} do
mock_http_with("google_search_console.json")
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}
)
assert {:ok,
[
%{name: "keyword1", visitors: 25, ctr: 36.8, impressions: 50, position: 2.2},
%{name: "keyword3", visitors: 15}
]} = Google.API.fetch_stats(site, query, {5, 0}, "")
end
test "transforms page filters to search console format", %{site: site} do
expect(
Plausible.HTTPClient.Mock,
:post,
fn
"https://www.googleapis.com/webmasters/v3/sites/sc-domain%3Adummy.test/searchAnalytics/query",
[{"Authorization", "Bearer 123"}],
%{
dimensionFilterGroups: [
%{filters: [%{expression: "https://dummy.test/page", dimension: "page"}]}
],
dimensions: ["query"],
endDate: "2022-01-05",
rowLimit: 5,
startRow: 0,
startDate: "2022-01-01"
} ->
{:ok, %Finch.Response{status: 200, body: %{"rows" => []}}}
end
)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]},
filters: [[:is, "event:page", ["/page"]]]
)
assert {:ok, []} = Google.API.fetch_stats(site, query, {5, 0}, "")
end
test "returns :invalid filters when using filters that cannot be used in Search Console", %{
site: site
} do
insert(:goal, event_name: "Signup", site: site)
query =
QueryBuilder.build!(site,
input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]},
filters: [[:is, "event:goal", ["Signup"]]]
)
assert {:error, :unsupported_filters} = Google.API.fetch_stats(site, query, 5, "")
end
end
end
|