Create API for research search #3987
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tt12/community-platform into 3924-research-remix-backend
onearmy-community-platform
|
||||||||||||||||||||||||||||||||||||||||||||||
| Project |
onearmy-community-platform
|
| Branch Review |
pull/3987
|
| Run status |
|
| Run duration | 05m 37s |
| Commit |
|
| Committer | unknown |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
2
|
Flaky
|
1
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
70
|
| View all changes introduced in this branch ↗︎ | |
Tests for review
settings.spec.ts • 1 failed test • ci-chrome
| Test | Artifacts | |
|---|---|---|
| [Settings] > [Fixing Fashion] > Can create member |
Test Replay
Screenshots
Video
|
|
map.spec.ts • 1 failed test • ci-chrome
| Test | Artifacts | |
|---|---|---|
| [Map] > [Shows expected pins] |
Test Replay
Screenshots
Video
|
|
src/integration/research/follow.spec.ts • 1 flaky test • ci-chrome
| Test | Artifacts | |
|---|---|---|
| [Research] > [By Authenticated] > [Follow button] |
Test Replay
Screenshots
Video
|
|
|
|
||
| describe('research.service', () => { | ||
| describe('search', () => { | ||
| it('fetches research articles based on search criteria', async () => { |
There was a problem hiding this comment.
these tests aren't very useful now, because it's just mocking and checking the mocked value, so not testing anything real.
we should instead add cypress and/or UI tests.
| constraints = [...constraints, sortConstraint] | ||
| try { | ||
| const response = await fetch( | ||
| `/api/research?words=${words.join(',')}&category=${category}&sort=${sort}&status=${status ?? ''}&last_doc_id=${lastDocId ?? ''}`, |
There was a problem hiding this comment.
would be cleaner to use URLSearchParams
https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/append
There was a problem hiding this comment.
Done, thank you for the idea
|
|
||
| import type { ICategory } from 'oa-shared' | ||
|
|
||
| const cache = new Keyv<ICategory[]>({ ttl: 600000 }) // ttl: 10 minutes |
There was a problem hiding this comment.
this rarely changes, should increase for at least 1h
| export const loader = async ({ request }) => { | ||
| const url = new URL(request.url) | ||
| const searchParams = url.searchParams | ||
| const userId: string | null = searchParams.get('user_id') |
There was a problem hiding this comment.
these params are usualy camelCase, so userId
There was a problem hiding this comment.
Done, on the API side as well
| export const loader = async () => { | ||
| const cachedCategories = await cache.get('researchCategories') | ||
|
|
||
| // check if cached map pins are availbe, if not - load from db and cache them |
| const cachedCategories = await cache.get('researchCategories') | ||
|
|
||
| // check if cached map pins are availbe, if not - load from db and cache them | ||
| if (cachedCategories) return json({ categories: cachedCategories }) |
There was a problem hiding this comment.
What brackets do you mean?
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Fetching of research articles is being done directly with Firestore
What is the new behavior?
Fetching of research articles have moved to a Remix backend API
If useful, provide screenshot or capture to highlight main changes
Does this PR introduce a breaking change?
Git Issues
Closes #3924
What happens next?
Thanks for the contribution! We try to make sure all PRs are reviewed ahead of our monthly maintainers call (first Monday of the month)
If the PR is working as intended it'll be merged and included in the next platform release, if not changes will be requested and re-reviewed once updated.
If you need more immediate feedback you can try reaching out on Discord in the Community Platform
developmentchannel.