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

Jump to bottom

Add :debounce to input outputs when missing #2228

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Add :debounce to input outputs when missing #2228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 12 additions & 5 deletions lib/livebook/runtime.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,28 +298,33 @@ defprotocol Livebook.Runtime do
%{
type: :text,
default: String.t(),
label: String.t()
label: String.t(),
debounce: :blur | non_neg_integer()
}
| %{
type: :textarea,
default: String.t(),
label: String.t(),
debounce: :blur | non_neg_integer(),
monospace: boolean()
}
| %{
type: :password,
default: String.t(),
label: String.t()
label: String.t(),
debounce: :blur | non_neg_integer()
}
| %{
type: :number,
default: number() | nil,
label: String.t()
label: String.t(),
debounce: :blur | non_neg_integer()
}
| %{
type: :url,
default: String.t() | nil,
label: String.t()
label: String.t(),
debounce: :blur | non_neg_integer()
}
| %{
type: :select,
Expand All @@ -336,6 +341,7 @@ defprotocol Livebook.Runtime do
type: :range,
default: number(),
label: String.t(),
debounce: :blur | non_neg_integer(),
min: number(),
max: number(),
step: number()
Expand Down Expand Up @@ -364,7 +370,8 @@ defprotocol Livebook.Runtime do
| %{
type: :color,
default: String.t(),
label: String.t()
label: String.t(),
debounce: :blur | non_neg_integer()
}
| %{
type: :image,
Expand Down
50 changes: 45 additions & 5 deletions lib/livebook/session.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2886,39 +2886,70 @@ defmodule Livebook.Session do
end
end

# Maps legacy outputs and adds missing attributes
# Normalizes output to match the most recent specification.
#
# Rewrites legacy output formats and adds defaults for newly introduced
# attributes that are missing.
defp normalize_runtime_output(output)

defp normalize_runtime_output(%{type: :input, attrs: attrs} = output)
when attrs.type in [:text, :textarea, :password, :number, :url, :range, :color] and
not is_map_key(attrs, :debounce) do
put_in(output.attrs[:debounce], :blur)
|> normalize_runtime_output()
end

# Traverse composite outputs

defp normalize_runtime_output(output) when output.type in [:frame, :tabs, :grid] do
outputs = Enum.map(output.outputs, &normalize_runtime_output/1)
%{output | outputs: outputs}
end

defp normalize_runtime_output(%{type: :frame_update} = output) do
{update_type, new_outputs} = output.update
new_outputs = Enum.map(new_outputs, &normalize_runtime_output/1)
%{output | update: {update_type, new_outputs}}
end

defp normalize_runtime_output(output) when is_map(output), do: output

# Rewrite tuples to maps for backward compatibility with Kino <= 0.10.0

defp normalize_runtime_output(:ignored) do
%{type: :ignored}
|> normalize_runtime_output()
end

# Rewrite tuples to maps for backward compatibility with Kino <= 0.10.0
defp normalize_runtime_output({:text, text}) do
%{type: :terminal_text, text: text, chunk: false}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:plain_text, text}) do
%{type: :plain_text, text: text, chunk: false}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:markdown, text}) do
%{type: :markdown, text: text, chunk: false}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:image, content, mime_type}) do
%{type: :image, content: content, mime_type: mime_type}
|> normalize_runtime_output()
end

# Rewrite older output format for backward compatibility with Kino <= 0.5.2
defp normalize_runtime_output({:js, %{ref: ref, pid: pid, assets: assets, export: export}}) do
normalize_runtime_output(
{:js, %{js_view: %{ref: ref, pid: pid, assets: assets}, export: export}}
)
{:js, %{js_view: %{ref: ref, pid: pid, assets: assets}, export: export}}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:js, info}) do
%{type: :js, js_view: info.js_view, export: info.export}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:frame, outputs, %{ref: ref, type: :default} = info}) do
Expand All @@ -2928,6 +2959,7 @@ defmodule Livebook.Session do
outputs: Enum.map(outputs, &normalize_runtime_output/1),
placeholder: Map.get(info, :placeholder, true)
}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:frame, outputs, %{ref: ref, type: :replace}}) do
Expand All @@ -2936,6 +2968,7 @@ defmodule Livebook.Session do
ref: ref,
update: {:replace, Enum.map(outputs, &normalize_runtime_output/1)}
}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:frame, outputs, %{ref: ref, type: :append}}) do
Expand All @@ -2944,10 +2977,12 @@ defmodule Livebook.Session do
ref: ref,
update: {:append, Enum.map(outputs, &normalize_runtime_output/1)}
}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:tabs, outputs, %{labels: labels}}) do
%{type: :tabs, outputs: Enum.map(outputs, &normalize_runtime_output/1), labels: labels}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:grid, outputs, info}) do
Expand All @@ -2958,6 +2993,7 @@ defmodule Livebook.Session do
gap: Map.get(info, :gap, 8),
boxed: Map.get(info, :boxed, false)
}
|> normalize_runtime_output()
end

defp normalize_runtime_output({:input, attrs}) do
Expand All @@ -2970,6 +3006,7 @@ defmodule Livebook.Session do
end

Map.merge(fields, %{type: :input, attrs: attrs})
|> normalize_runtime_output()
end

defp normalize_runtime_output({:control, attrs}) do
Expand All @@ -2992,6 +3029,7 @@ defmodule Livebook.Session do
end

Map.merge(fields, %{type: :control, attrs: attrs})
|> normalize_runtime_output()
end

defp normalize_runtime_output({:error, message, type}) do
Expand All @@ -3002,9 +3040,11 @@ defmodule Livebook.Session do
end

%{type: :error, message: message, context: context}
|> normalize_runtime_output()
end

defp normalize_runtime_output(other) do
%{type: :unknown, output: other}
|> normalize_runtime_output()
end
end
8 changes: 4 additions & 4 deletions lib/livebook_web/live/output/input_component.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ defmodule LivebookWeb.Output.InputComponent do
class="input-range"
name="html_value"
value={@value}
phx-debounce={@attrs[:debounce] || "blur"}
phx-debounce={@attrs.debounce}
phx-target={@myself}
spellcheck="false"
autocomplete="off"
Expand All @@ -190,7 +190,7 @@ defmodule LivebookWeb.Output.InputComponent do
class={["input min-h-[38px] max-h-[300px] tiny-scrollbar", @attrs.monospace && "font-mono"]}
name="html_value"
phx-hook="TextareaAutosize"
phx-debounce={@attrs[:debounce] || "blur"}
phx-debounce={@attrs.debounce}
phx-target={@myself}
spellcheck="false"
><%= [?\n, @value] %></textarea>
Expand All @@ -206,7 +206,7 @@ defmodule LivebookWeb.Output.InputComponent do
class="input w-auto bg-gray-50"
name="html_value"
value={@value}
phx-debounce={@attrs[:debounce] || "blur"}
phx-debounce={@attrs.debounce}
phx-target={@myself}
spellcheck="false"
autocomplete="off"
Expand Down Expand Up @@ -241,7 +241,7 @@ defmodule LivebookWeb.Output.InputComponent do
class="input w-auto invalid:input--error"
name="html_value"
value={to_string(@value)}
phx-debounce={@attrs[:debounce] || "blur"}
phx-debounce={@attrs.debounce}
phx-target={@myself}
spellcheck="false"
autocomplete="off"
Expand Down
6 changes: 3 additions & 3 deletions test/livebook/session/data_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ defmodule Livebook.Session.DataTest do
ref: "ref1",
id: "i1",
destination: nil,
attrs: %{type: :text, default: "hey", label: "Text"}
attrs: %{type: :text, default: "hey", label: "Text", debounce: :blur}
}

defp eval_meta(opts \\ []) do
Expand Down Expand Up @@ -4510,15 +4510,15 @@ defmodule Livebook.Session.DataTest do
ref: "ref1",
id: "i1",
destination: nil,
attrs: %{type: :text, default: "hey", label: "Text"}
attrs: %{type: :text, default: "hey", label: "Text", debounce: :blur}
}

input2 = %{
type: :input,
ref: "ref2",
id: "i2",
destination: nil,
attrs: %{type: :text, default: "hey", label: "Text"}
attrs: %{type: :text, default: "hey", label: "Text", debounce: :blur}
}

data =
Expand Down
4 changes: 2 additions & 2 deletions test/livebook/session_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ defmodule Livebook.SessionTest do
ref: "ref",
id: "input1",
destination: :noop,
attrs: %{type: :text, default: "hey", label: "Name"}
attrs: %{type: :text, default: "hey", label: "Name", debounce: :blur}
}

smart_cell = %{
Expand Down Expand Up @@ -1899,7 +1899,7 @@ defmodule Livebook.SessionTest do
ref: "ref",
id: "input1",
destination: :noop,
attrs: %{type: :text, default: "hey", label: "Name"}
attrs: %{type: :text, default: "hey", label: "Name", debounce: :blur}
}

send(session.pid, {:runtime_evaluation_output, cell_id, legacy_output})
Expand Down
12 changes: 9 additions & 3 deletions test/livebook_web/live/session_live_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,13 @@ defmodule LivebookWeb.SessionLiveTest do
ref: "ref1",
id: "input1",
destination: test,
attrs: %{type: :textarea, default: "hey", label: "Name", monospace: false}
attrs: %{
type: :textarea,
default: "hey",
label: "Name",
debounce: :blur,
monospace: false
}
}

Session.subscribe(session.id)
Expand Down Expand Up @@ -552,7 +558,7 @@ defmodule LivebookWeb.SessionLiveTest do
ref: "input_ref1",
id: "input1",
destination: test,
attrs: %{type: :text, default: "initial", label: "Name"}
attrs: %{type: :text, default: "initial", label: "Name", debounce: :blur}
}
],
submit: "Send",
Expand Down Expand Up @@ -781,7 +787,7 @@ defmodule LivebookWeb.SessionLiveTest do
ref: "ref1",
id: "input1",
destination: test,
attrs: %{type: :number, default: 1, label: "Input inside frame"}
attrs: %{type: :number, default: 1, label: "Input inside frame", debounce: :blur}
}

frame_update = %{
Expand Down
Loading