Inputs form not rendered correctly (always empty)

[qhwa]

First of all, thanks for the library, it's awesome!
I watched your talk on ElixirConf 2021 and I was amazed. Fortunately, I got a chance to give it a try now.

However, when I followed the README document and my input definition doesn't work.

The issue

My module is quite simple:

defmodule MyApp.Chores.MyChore do
  use ChoreRunner.Chore

  def input do
    [
      string(:platform)
    ]
  end
  
  def run(inputs) do
    log(["hi, I'm running, inputs:", inspect(inputs)])
    :ok
  end
end

Expected behavior

An input form that allows me to enter some text.

Actual behavior

The input form in the UI is empty and the logged inputs value is always %{}.

The cause

After some digging, I found that actually, the function name should be inputs (plural form).
I changed the name to inputs and it now works.

So, I think in the README, it should be inputs/0 instead of input/0, and we can add @impl true before these callback functions so that the compiler can help validate the names.

Thanks!

[cigzigwon]

@cjfreeze I thought this would save me time... Can you please update docs?

[cjfreeze]

Sorry for the outdated docs @cigzigwon and @qhwa, the project had a lull in activity but is picking back up. That documentation is already set to be updated in PR #5 so this issue will be fixed within a few days 🙂. We're finally starting to see some active use of the library so plenty of improvements will be added as we work towards a 1.0 release

[cigzigwon]

@cjfreeze O.K. It's a sticky sitch for me anyhow... I'm a new entrant to LiveView coming from a 1.5.3... So now that ChoreRunner loads in the LiveUI loads but doesn't include any live connection event handling.... I don't have a frontend so what's missing??

[cigzigwon]

Got it! Need to switch to .heex templates and then set the root LayoutView in Router. This works great for me since we tossed out the entire front end at the beginning of the project so we can just re-implement the little JS hooks via libs in NPM.

https://hexdocs.pm/phoenix_live_view/installation.html

[cigzigwon]

@cjfreeze We appreciate you for this! It's working now. We needed to rip out the web crawler control tools away from our product team due to growth. We used to have logging and controls together... Now they only get logging unless of courese they are cranted access to the ChoreRunnerUI views. We used the JS snippet from the above sample and tosed it into our UI build/compile chain.

[cjfreeze]

Got it! Need to switch to .heex templates and then set the root LayoutView in Router. This works great for me since we tossed out the entire front end at the beginning of the project so we can just re-implement the little JS hooks via libs in NPM.

https://hexdocs.pm/phoenix_live_view/installation.html

Are there any documentation improvements that we could make to help with this issue you think?

[cigzigwon]

@cjfreeze You just need to mention that the runner does not ship w/client side JS that is required in that link. If they follow that guide they will hit everything they need to make ChoreRunner work.

[cjfreeze]

That would be a good disclaimer to include, thank you for the feedback!