[WIP] Variant A: saved segments

[apata]

This PR outlines schema and API structure for saved segments. Not intended to be merged as is.

[macobo]

Some initial thoughts. 🚀

[macobo]

Since it's not clear whether this is intended as the full code: Nit: separate test.

[macobo]

Nit: I don't think DRY-ing the variables here helps here - it just ends up with a wordier test where you need to scroll back-and-forth.

[macobo]

Nit: This is confusing to follow - it isn't clear what the response actually looks like. I suggest the following structure.

segment = from(s in segments, where: %{ site_id: ^site_id }) |> Repo.one()

assert json_response(conn, 200) == %{
               "role" => "owner",
               "segment" => %{ ... }
}

And using fully-hard-coded values

[apata]

Thanks! I struggled with the timestamps in this test file. Any tips on how to omit them from the comparison while remaining brief?

[macobo]

Good question - elixir assertions don't have any clever shorthands like any(datetime) for assert. I'll dig into existing tests for controllers and see how they have solved it. 🤔 Will provide an answer tomorrow!

[macobo]

Dug a bit.

We don't have a usecase yet for exposing updated_at or inserted_at at the API level. Looking at similar models like lib/plausible/auth/invitation.ex and lib/plausible/site.ex we don't expose them either. I'd remove exposing them.

I'd rewrite the test as follows:

  describe "POST /internal-api/:domain/segments" do
    setup [:create_user, :create_new_site, :log_in]

    test "creates segment successfully", %{conn: conn, site: site} do
      conn =
        post(conn, "/internal-api/#{site.domain}/segments", %{
          "segment_data" => %{"filters" => [["is", "visit:entry_page", ["/blog"]]]},
          "name" => "Blog entry"
        })

      segment = Plausible.Repo.one(Plausible.Segment)

      assert json_response(conn, 200) == %{
               "role" => "owner",
               "segment" => %{
                 "id" => segment.id,
                 "name" => "Blog entry",
                 "segment_data" => %{"filters" => [["is", "visit:entry_page", ["/blog"]]]},
                 "description" => nil,
               }
             }
    end
  end

[macobo]

This doesn't apply the JSON schema which is a problem.

[macobo]

Nit: Let's inline the operation given there's only one and we're not repeating the ref anywhere.

Suggested change

	"$ref": "#/definitions/filter_operation_for_segments"
	"const": "is"

[macobo]

Should validate here that it's valid and doesn't contain any nested segment references right?

[apata]

Agreed! It should be validated, but at what level? I didn't want to make this module depend on query / filters parsing. How about doing that in the API controller?

[macobo]

Doing it in the controller seems valid and best (and if it's already validated then sorry for missing it!).

[macobo]

Rather than insert it here, would it make sense to use the other APIs to create these to simulate user behavior?

[github-actions]

Preview environment👷🏼‍♀️🏗️
PR-4648

[CLAassistant]

All committers have signed the CLA.