Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding error return patterns to functions specs #342

Open
wants to merge 15 commits into
base: kobil
Choose a base branch
from
Open

Adding error return patterns to functions specs #342

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b4ff598
FT SCP-998: Fixed, ignored dialyzer issues before function specificat…
hbarisik Mar 24, 2020
7f839d6
FT SCP-998: Added missing error returns as generic structure {:error …
hbarisik Mar 24, 2020
07c970c
Added error return pattern for find_one
hbarisik Jul 6, 2020
cbda7fc
Formatting changes
hbarisik Jul 7, 2020
1c98096
Removed unnecesary assignment within if block
hbarisik Jul 8, 2020
d8128c5
return pattern of aggregate function has been changed as a reponse to…
hbarisik Jul 9, 2020
7f0627a
fixed the remaining changed return pattern
hbarisik Jul 9, 2020
77b71f3
Fixed more return pattern mismatches
hbarisik Jul 9, 2020
0ea52e7
More changes on return pattern
hbarisik Jul 9, 2020
238e35e
A fix and formatting improvements
hbarisik Jul 9, 2020
34ec575
More changes for return pattern changes for aggregate function
hbarisik Jul 9, 2020
bb1c333
And fixed one more mismatched return pattern issue
hbarisik Jul 9, 2020
594a7d9
Created basic_result return pattern and started applying them
hbarisik Jul 10, 2020
39f25f6
Applied basic_result return pattern to more functions
hbarisik Jul 10, 2020
5e058ef
Remove pipelines with only one step
hauleth Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .dialyzer-ignore.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[
{":0:unknown_type Unknown type: Mongo.WriteError.t/0." }
]
hauleth marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 6 additions & 6 deletions lib/mongo.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ defmodule Mongo do
* `:max_time` - Specifies a time limit in milliseconds
* `:use_cursor` - Use a cursor for a batched response (Default: true)
"""
@spec aggregate(GenServer.server(), collection, [BSON.document()], Keyword.t()) :: cursor
@spec aggregate(GenServer.server(), collection, [BSON.document()], Keyword.t()) :: cursor | {:error, Mongo.Error.t()}
hauleth marked this conversation as resolved.
Show resolved Hide resolved
def aggregate(topology_pid, coll, pipeline, opts \\ []) do
query =
[
Expand Down Expand Up @@ -482,7 +482,7 @@ defmodule Mongo do
* `:projection` - Limits the fields to return for all matching document
* `:skip` - The number of documents to skip before returning (Default: 0)
"""
@spec find(GenServer.server(), collection, BSON.document(), Keyword.t()) :: cursor
@spec find(GenServer.server(), collection, BSON.document(), Keyword.t()) :: cursor | {:error, Mongo.Error.t()}
def find(topology_pid, coll, filter, opts \\ []) do
query =
[
Expand Down Expand Up @@ -538,7 +538,7 @@ defmodule Mongo do
* `:skip` - The number of documents to skip before returning (Default: 0)
"""
@spec find_one(GenServer.server(), collection, BSON.document(), Keyword.t()) ::
BSON.document() | nil
BSON.document() | nil | {:error, Mongo.Error.t()}
def find_one(conn, coll, filter, opts \\ []) do
opts =
opts
Expand Down Expand Up @@ -1001,7 +1001,7 @@ defmodule Mongo do
@doc """
Returns a cursor to enumerate all indexes
"""
@spec list_indexes(GenServer.server(), String.t(), Keyword.t()) :: cursor
@spec list_indexes(GenServer.server(), String.t(), Keyword.t()) :: cursor | {:error, Mongo.Error.t()}
def list_indexes(topology_pid, coll, opts \\ []) do
with {:ok, conn, _, _} <- select_server(topology_pid, :read, opts) do
aggregation_cursor(conn, "$cmd", [listIndexes: coll], nil, opts)
Expand All @@ -1011,7 +1011,7 @@ defmodule Mongo do
@doc """
Convenient function that returns a cursor with the names of the indexes.
"""
@spec list_index_names(GenServer.server(), String.t(), Keyword.t()) :: %Stream{}
@spec list_index_names(GenServer.server(), String.t(), Keyword.t()) :: %Stream{} | {:error, Mongo.Error.t()}
def list_index_names(topology_pid, coll, opts \\ []) do
list_indexes(topology_pid, coll, opts)
|> Stream.map(fn %{"name" => name} -> name end)
Expand All @@ -1020,7 +1020,7 @@ defmodule Mongo do
@doc """
Getting Collection Names
"""
@spec show_collections(GenServer.server(), Keyword.t()) :: cursor
@spec show_collections(GenServer.server(), Keyword.t()) :: cursor | {:error, Mongo.Error.t()}
def show_collections(topology_pid, opts \\ []) do
##
# from the specs
Expand Down
1 change: 1 addition & 0 deletions lib/mongo/session.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ defmodule Mongo.Session do
@impl :gen_statem
# Abort all pending transactions if there any and end session itself.
def terminate(_reason, state, %{pid: pid} = data) do
_=
hauleth marked this conversation as resolved.
Show resolved Hide resolved
if state == :in_transaction do
_ = try_run_txn_command(data, :abortTransaction)
end
Expand Down
1 change: 1 addition & 0 deletions mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ defmodule Mongodb.Mixfile do
description: description(),
package: package(),
dialyzer: [
ignore_warnings: ".dialyzer-ignore.exs",
flags: [:underspecs, :unknown, :unmatched_returns],
plt_add_apps: [:logger, :connection, :db_connection, :mix, :elixir, :ssl, :public_key],
plt_add_deps: :transitive
Expand Down