Add new Partials mode - upsert

Open
#2,835 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
deno, typescript
Domain
frontend

Research direction

Start by reading the partial update implementation and the existing replace, append, and prepend modes; the issue does not name specific files or tests. Decide whether keyed child replacement belongs in a new upsert mode or in the existing modes, then define tests for matching and unmatched keys. Done means the chosen behavior is implemented and verified, but the issue gives no test entry point.

Written by the indexing model from the issue text.

Description

feat

I propose adding an additional mode for partials to complement replace, append, and prepend. At this stage I have called it upsert.

Associated pull request- #2834

It functions similar to append, however each direct child node in the Partial update with a ‘key’ prop is compared to the direct children of the corresponding Partial already in the document. If a match is found, it will swap out that element, otherwise it will append the new node to the existing content.

I believe this has several use cases, the simplest I can think would be a todo list, where individual todo items can be sent to the client to populate a list, or update as they are modified, without using islands or any additional client side JavaScript. Another example, which is my specific use case, is that I need to update a list of recent chats in a messaging app as new messages arrive. Rather than send another copy of the entire list on each update, I can send just the individual item, which would feature an unread message badge. My current work around is using global state to maintain an array of the DOM nodes, and sending that list to the server with every request, in order to determine whether a message is coming from someone already in the recent list or not, so I don’t end up with duplicates.

If adding this additional mode is considered adding unnecessary complexity, then an alternative solution might be that both append and prepend would automatically substitute child nodes if a matching key is detected. Preact warns about having duplicate keys in component children already, but Fresh will currently not check this.

I am happy to take on feedback, both for this feature, as well as the correct etiquette for contributing. I am a solo web developer with absolutely no experience collaborating on projects.

Dominant language
TypeScript
Stars
13.8k
Forks
757
Avg merge
3m
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from freshframework/fresh

All issues in freshframework/fresh

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.