josefrichter

josefrichter

Programming Phoenix book: syncing frontend-backend state in example Rumbl app

Hello, I’ve been going thru this great book, building the example app, and ran into some issues. I am trying to check whether these issues are “by design” or I understand it incorrectly, or there’s something else to keep in mind:

To quickly summarize, the app plays a youtube video and lets you write annotations (comments) as the video is playing. Each annotation has a timestamp that should make sure it’s displayed at given time of the playback.

It runs on websockets. On join, all annotations are loaded from backend. Then on frontend, there’s a scheduling function that “ticks” every second and renders the annotations that match the current time on the video player.

The important bits on frontend:

let vidChannel   = socket.channel("videos:" + videoId, () => {
      return {last_seen_id: lastSeenId} // sending this param when user joins (or rejoins) channel
    }
vidChannel.join()
      .receive("ok", resp => {
        let ids = resp.annotations.map(ann => ann.id)
        if(ids.length > 0){ lastSeenId = Math.max(...ids) } //sets lastSeenId to newest existing annotation/
        this.scheduleMessages(msgContainer, resp.annotations)
      })
      .receive("error", reason => console.log("join failed", reason))
vidChannel.on("new_annotation", (resp) => {
      lastSeenId = resp.id // update lastSeenId to the newly created annotation id /
      this.renderAnnotation(msgContainer, resp)
    })

on backend this is the core:

def join("videos:" <> video_id, params, socket) do
    send(self(), :after_join)
    last_seen_id = params["last_seen_id"] || 0
    video_id = String.to_integer(video_id)
    video = Multimedia.get_video!(video_id)

    annotations =
      video
      |> Multimedia.list_annotations(last_seen_id)
      |> Phoenix.View.render_many(AnnotationView, "annotation.json")

    {:ok, %{annotations: annotations}, assign(socket, :video_id, video_id)}
  end
def handle_in("new_annotation", params, user, socket) do
    case Multimedia.annotate_video(user, socket.assigns.video_id, params) do
      {:ok, annotation} ->
        broadcast!(socket, "new_annotation", %{
          id: annotation.id,
          user: RumblWeb.UserView.render("user.json", %{user: user}),
          body: annotation.body,
          at: annotation.at
        })

        {:reply, :ok, socket}

      {:error, changeset} ->
        {:reply, {:error, %{errors: changeset}}, socket}
    end
  end

This works mostly fine, but here are the issues:

When one user posts an annotation while playing video, this is immediately shown to all users, regardless their current player time. It shows even when the player is stopped. This is obviously caused by directly calling the renderAnnotation once any is received. I assume this is by design to simplify things.

Now what if I wanted the new annotation to be “scheduled” together with the other ones, to appear only at the right time? I can think of two approaches:

  1. keeping annotations array on client too, push new annotations to it, and call the schedule function - however this means two states that need to be kept in sync, probably a nightmare and not very functional apporach

  2. every time new annotation is added, return all annotations from backend, rather than just the new one, and call the scheduling function. however, this would mean transferring potentially almost the same data to all clients every time new annotation is added. sounds like overkill.

  3. rewrite the annotations as LiveView component :slight_smile: What I’m not exacly sure whether I’d be able to keep this component in sync with the video player.. Has anyone tried this approach by any chance?

Can you think of some other efficient solutions to this, please? Thank you!

For completeness, this is the full repo of the app: GitHub - josefrichter/rumbl_umbrella: rumbl app from programming phoenix book · GitHub

Where Next?

Popular in Questions Top

skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID&lt;0.412.0&gt; terminating ** (Postgrex.Error) FATAL...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
baxterw3b
Hi guys, i’m new in the Elixir world, and i have to say, that i love it! i’m having some problem to understand anonymous functions with ...
New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
RisingFromAshes
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
yawaramin
In the Dialyzer docs ( dialyzer — OTP 29.0.2 (dialyzer 6.0.1) ), there is a way to turn off a specific warning for a function: -dialyzer...
New

Other popular topics Top

danschultzer
None of the current solutions worked well for me, so I went ahead and built a user management system from scratch. This project took far...
548 29377 241
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
TunkShif
This post is an instruction guide to help you setup your Neovim for Elixir development from scratch. It includes general information on h...
274 41539 114
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
aesmail
Hello guys, I have finally made it. I created an admin interface for a framework. It’s been on my todo list for years and with the curre...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39297 209
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
dogweather
I wrote this comment on r/haskell, and it’s not popular there. :wink: But I think I’m on to something… Haskell reminds me of Java, and e...
New

We're in Beta

About us Mission Statement