search

mitodl / mit-learn

BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Server rendering for homepage, units and topics listing pages #1822

Closed jonkafton closed 1 week ago

jonkafton commented 2 weeks ago

What are the relevant tickets?

Closes: Next.js: Homepage: Prefetch API calls #5920 Next.js: Topics, Units and Channels pages: Prefetch API calls #6036

Description (What does it do?)

Homepage

Makes API calls needed to render homepage learning resources on the server so that these prerender:

These are all learning resources, however the learning resource endpoints return user specific data, namely the user lists each resource may be a member of. This PR https://github.com/mitodl/mit-learn/pull/1808 provides a new endpoint to query for user list relationships independently of the learning resources endpoints, enabling us to querying them publicly for server rendering.

There is the follow up task to implement these endpoints in the frontend so that the server rendered learning resources in this PR are then furnished with their user list memberships in the browser.

In the meantime, this PR fetches the public learning resources on the server, then invalidates the cache so that they are refetched on the client complete with the user specific data. This required commenting out the featured list shuffle behavior to prevent the content flicker as the client rendered resource cards replace the server rendered version. This will be reinstated with this task: https://github.com/mitodl/hq/issues/6032.

Unit Listing page /units

Updates to make a single call /api/v0/channels/?channel_type=unit, replacing calls to each channel detail page in the unit cards. Prefetches channels list and count by unit.

Topics Listing page /topics

Prefetches topics list and counts by topic.

How can this be tested?

These routes should server render all public content without any prefetch mismatch warnings in the browser console:

Additional Context

Also adds reusable server PageParams type and cleans up the api key factory imports.

jonkafton commented 1 week ago

1808 has been merged, but what's left to be done on that before randomization can be turned back on?

This has to be done to make use of the new membership endpoint - https://github.com/mitodl/hq/issues/6032. The idea is that the learning resources will be fetched on the server and we'll query for memberships on the client to update the user lists. With that we can turn off the learning resource cache invalidation added with this PR to refetch for the memberships, so can reinstate the randomization.