Support caching for streamed responses
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
- Tipo de issue
- Bug
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- react, typescript
- Domínio
- frontend, performance
Direção de pesquisa
Comece por src/index.tsx, linhas 116-140, e reproduza o caminho de uma Promise fulfilled do exemplo vinculado de StackBlitz/routes/index.tsx. Rastreie como deferredServerData, serverData, freshData e adapter são comparados; concluído significa que o cache distingue dados armazenados em cache com a Promise fulfilled de dados que exigem revalidação, com comportamento verificado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
When using defer to stream a response from a loader that returned a promise which later used in a boundary, we cannot properly serialize the promise to store say in localStorage or IndexedDB (JSON.stringify will result in an empty object {}). The only way to store this type of data is directly in memory, so on the next navigation, clientLoader will return fulfilled promise with the data, rather than calling the server `loader'.
let cache: SerializeFrom<typeof loader>;
export const clientLoader = defineClientLoader(async ({ serverLoader }) => {
if (!cache) {
cache = await serverLoader<typeof loader>();
}
return cache;
});
clientLoader.hydrate = true;
By using remix-client-cache, we can create an adapter for when we need to cache streaming responses, rather than relying on a global setting using, for example, localStorage.
import { lru } from 'tiny-lru';
import { type CacheAdapter, createCacheAdapter } from 'remix-client-cache';
const cache = lru(100);
class LRUAdapter implements CacheAdapter {
async getItem(key: string) {
return cache.get(key);
}
async setItem(key: string, value: any) {
return cache.set(key, value);
}
async removeItem(key: string) {
return cache.delete(key);
}
}
export const { adapter: lruAdapter } = createCacheAdapter(() => new LRUAdapter());
routes/index.tsx:
import { defer } from '@remix-run/node';
import { Await, ClientLoaderFunctionArgs, Link } from '@remix-run/react';
import { Suspense } from 'react';
import { cacheClientLoader, useCachedLoaderData } from 'remix-client-cache';
import { lruAdapter } from '~/client-cache-adapter';
async function getQueryData() {
await new Promise((resolve) => setTimeout(resolve, 3000));
return { data: [{ id: 1 }] };
}
export async function loader() {
const query = getQueryData();
return defer({
query,
});
}
export const clientLoader = (args: ClientLoaderFunctionArgs) => cacheClientLoader(args, { adapter: lruAdapter });
clientLoader.hydrate = true;
export default function Page() {
const { query } = useCachedLoaderData<typeof loader>();
return (
<>
<Link to="/">Home</Link>
<br />
<br />
<Suspense fallback="loading...">
<Await resolve={query}>
{({ data }) => (
<ul>
{data?.map((entry) => <li key={entry.id}>{entry.id}</li>)}
</ul>
)}
</Await>
</Suspense>
</>
);
}
This opens up a question whether it's a good idea to store data in server memory, it would be interesting if we could transform fulfilled promises using a library like turbo-stream to store on the client-side or use a web worker and decode to the original form for consumption by .
There is currently a bug where a returned promise from the cache has already been fulfilled, the internal logic of remix-client-cache cannot understand when a revalidation should occur, or fulfilled data is currently present, since we must store promises directly in memory and not as a string.
https://github.com/forge42dev/remix-client-cache/blob/main/src/index.tsx#L116-L140
// Unpack deferred data from the server
useEffect(() => {
let isMounted = true;
if (loaderData.deferredServerData) {
loaderData.deferredServerData.then((newData: any) => {
if (isMounted) {
adapter.setItem(loaderData.key, newData);
setFreshData(newData);
}
});
}
return () => {
isMounted = false;
};
}, [loaderData, adapter]);
// Update the cache if the data changes
useEffect(() => {
if (
loaderData.serverData &&
JSON.stringify(loaderData.serverData) !== JSON.stringify(freshData)
) {
setFreshData(loaderData.serverData);
}
}, [loaderData?.serverData, freshData]);
- Linguagem predominante
- TypeScript
- Estrelas
- 247
- Forks
- 3
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Sem guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de code-forge-io/remix-client-cache
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 48/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
code-forge-io/remix-client-cache#15 · 3 comentários · 3 reações ·
-
Idea: refetching statusAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
code-forge-io/remix-client-cache#3 · 3 comentários ·
-
InvalidCache with wildcardsAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
code-forge-io/remix-client-cache#2 · 3 comentários ·
Todas as issues de code-forge-io/remix-client-cache
Issues semelhantes
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
langchain-ai/langchainjs#12239 ·
Mantenedores costumam responder em até 1 dia
-
Board view: the Monitoring column is always empty because compact issue rows drop displayStatusAberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
paperclipai/paperclip#21837 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 73/100
code-yeongyu/senpi#6813 ·
Mantenedores costumam responder em até 1 dia
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 93/100
lingdojo/kana-dojo#34169 · 1 comentário · 5 reações ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100