[PR] API Stage 2 - Adding tags

[LuchoTurtle]

related to #256

This PR adds tag support, alongside some refactoring related with router helpers.

[codecov]

Codecov Report

Merging #280 (e295ced) into main (420aef5) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #280   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        15    +1     
  Lines          414       475   +61     
=========================================
+ Hits           414       475   +61     

Impacted Files	Coverage Δ
lib/app_web/router.ex	100.00% <ø> (ø)
lib/api/item.ex	100.00% <100.00%> (ø)
lib/api/tag.ex	100.00% <100.00%> (ø)
lib/app/item.ex	100.00% <100.00%> (ø)
lib/app/tag.ex	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[LuchoTurtle]

CRUD tags should now be properly working.
The API tests have also been updated with this new introduction, as well as seeds.exs.

[LuchoTurtle]

Update on this.

I've been implementing the tag array to return proper errors. I've tried different approaches to this. I'm not sure whether I should tell the user that an item already exists or just ignore a tag that exists and add others that do not, and return a 200 successful request.

I've implemented validators for both checking if a tag already exists and if any tag is invalid. However, the current implementation ignores tags that already exist.

Additionally, I'm doing separate DB transactions for each tag instead of inserting all in the same so the insert_at and updated_at fields are correctly setup. I'm aware I could pass it on manually but I think this makes the code more readable and simpler, as I don't have to manually add these fields this way.

[LuchoTurtle]

Trying to implement the embedding of tags when retrieving items but I can't seem to idiomatically implement proper json encoding.
I'm toggling tag loading depending on the embed query parameter passed on by the person using the API but I keep getting errors from Jason trying to encode it.

I've changed the Jason.Encoder annotation in the item schema to the following:

  @derive {Jason.Encoder, except: [:__meta__, :__struct__, :timer, :inserted_at, :updated_at]}

But I keep getting this annoying error:

no function clause matching in Jason.Encoder.App.Item."-inlined-encode/2-"/2

even after deleting the tag key from the map.

I've tried the approaches of these three links but none helped :(

• https://elixirforum.com/t/better-jason-encoder-for-schemas-automatically/16245/12
• https://elixirforum.com/t/better-jason-encoder-for-schemas-automatically/16245/12
• https://elixirforum.com/t/runtimeerror-cannot-encode-association-address-from-myapp-model-property-to-json-because-the-association-was-not-loaded/39696/3

[LuchoTurtle]

I can't seem to get this to work, after countless attempts. I asked the question in Elixir Forums, hopefully I have an answer:

https://elixirforum.com/t/error-json-encoding-struct-no-function-clause-matching-in-jason-encoder-app-item-inlined-encode-2-2/53423

[nelsonic]

@LuchoTurtle thank you for giving a good account of your progress in this PR and opening the question on the Forum. 👍
Let's discuss in-person tomorrow morning. 🙏

[LuchoTurtle]

Fetching items with tags is now possible. Tested and documented. Added new test suites to the CI, as well.

Going to check docs for any typos and then submit for review.

[nelsonic]

@LuchoTurtle PR is still "Draft":

Are you done with your editing? 💭

[nelsonic]

Thanks @LuchoTurtle 👍