diff --git a/api/poetry.lock b/api/poetry.lock index cdc8cb0b9..41c4667ea 100644 --- a/api/poetry.lock +++ b/api/poetry.lock @@ -631,6 +631,20 @@ Werkzeug = ">=3.0.0" async = ["asgiref (>=3.2)"] dotenv = ["python-dotenv"] +[[package]] +name = "flask-cors" +version = "4.0.0" +description = "A Flask extension adding a decorator for CORS support" +optional = false +python-versions = "*" +files = [ + {file = "Flask-Cors-4.0.0.tar.gz", hash = "sha256:f268522fcb2f73e2ecdde1ef45e2fd5c71cc48fe03cffb4b441c6d1b40684eb0"}, + {file = "Flask_Cors-4.0.0-py2.py3-none-any.whl", hash = "sha256:bc3492bfd6368d27cfe79c7821df5a8a319e1a6d5eab277a3794be19bdc51783"}, +] + +[package.dependencies] +Flask = ">=0.9" + [[package]] name = "flask-httpauth" version = "4.8.0" @@ -903,16 +917,6 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -977,7 +981,7 @@ files = [ [package.dependencies] marshmallow = [ - {version = ">=3.13.0,<4.0"}, + {version = ">=3.13.0,<4.0", optional = true, markers = "python_version < \"3.7\" or extra != \"enum\""}, {version = ">=3.18.0,<4.0", optional = true, markers = "python_version >= \"3.7\" and extra == \"enum\""}, ] typeguard = {version = ">=2.4.1,<4.0.0", optional = true, markers = "extra == \"union\""} @@ -1597,7 +1601,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1605,16 +1608,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1631,7 +1626,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1639,7 +1633,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2067,4 +2060,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.12" -content-hash = "8b1e1f42ebc8cc699497f4b56efc1ccfcaa021a0ad018e8a8f41bee51bec427b" +content-hash = "8e71ff73a1f992be94f523af9f5aefa4b81667e34cbc7324513c3d7fa6093c06" diff --git a/api/pyproject.toml b/api/pyproject.toml index 22f0c7df8..9b17f07a5 100644 --- a/api/pyproject.toml +++ b/api/pyproject.toml @@ -21,6 +21,7 @@ marshmallow = "^3.20.1" gunicorn = "^21.2.0" psycopg = {extras = ["binary"], version = "^3.1.10"} pydantic-settings = "^2.0.3" +flask-cors = "^4.0.0" [tool.poetry.group.dev.dependencies] black = "^23.9.1" diff --git a/api/src/app.py b/api/src/app.py index 8c3d8396f..2440b0ea3 100644 --- a/api/src/app.py +++ b/api/src/app.py @@ -3,6 +3,7 @@ from typing import Any, Tuple from apiflask import APIFlask, exceptions +from flask_cors import CORS from pydantic import Field import src.adapters.db as db @@ -51,6 +52,7 @@ def create_app() -> APIFlask: feature_flag_config.initialize() + CORS(app) configure_app(app) register_blueprints(app) register_index(app) diff --git a/frontend/.env.development b/frontend/.env.development index a532c14fc..b17000af3 100644 --- a/frontend/.env.development +++ b/frontend/.env.development @@ -15,3 +15,7 @@ SENDY_API_URL= SENDY_LIST_ID= NEXT_PUBLIC_API_URL=http://localhost:8080 + +# Hardcode public auth key for local to local calls +# This is also hardcoded and checked-in on the API +NEXT_PUBLIC_LOCAL_AUTH_TOKEN=LOCAL_AUTH_12345678 diff --git a/frontend/src/api/BaseApi.ts b/frontend/src/api/BaseApi.ts index 6dea95ca6..98689de1f 100644 --- a/frontend/src/api/BaseApi.ts +++ b/frontend/src/api/BaseApi.ts @@ -18,22 +18,25 @@ export interface HeadersDict { } export default abstract class BaseApi { - /** - * Root path of API resource without leading slash. - */ + // Root path of API resource without leading slash. abstract get basePath(): string; - /** - * Namespace representing the API resource. - */ + // API version + get version() { + return "v0.1"; + } + + // Namespace representing the API resource abstract get namespace(): string; - /** - * Configuration of headers to send with all requests - * Can include feature flags in child classes - */ - get headers() { - return {}; + // Configuration of headers to send with all requests + // Can include feature flags in child classes + get headers(): HeadersDict { + const headers: HeadersDict = {}; + if (process.env.NEXT_PUBLIC_LOCAL_AUTH_TOKEN) { + headers["X-AUTH"] = process.env.NEXT_PUBLIC_LOCAL_AUTH_TOKEN; + } + return headers; } /** @@ -41,21 +44,29 @@ export default abstract class BaseApi { */ async request( method: ApiMethod, - subPath = "", + basePath: string, + namespace: string, + subPath: string, body?: JSONRequestBody, options: { additionalHeaders?: HeadersDict; } = {}, ) { const { additionalHeaders = {} } = options; - const url = createRequestUrl(method, this.basePath, subPath, body); + const url = createRequestUrl( + method, + basePath, + this.version, + namespace, + subPath, + body, + ); const headers: HeadersDict = { ...additionalHeaders, ...this.headers, }; headers["Content-Type"] = "application/json"; - const response = await this.sendRequest(url, { body: method === "GET" || !body ? null : createRequestBody(body), headers, @@ -74,7 +85,6 @@ export default abstract class BaseApi { ) { let response: Response; let responseBody: ApiResponseBody; - try { response = await fetch(url, fetchOptions); responseBody = (await response.json()) as ApiResponseBody; @@ -110,13 +120,16 @@ export default abstract class BaseApi { export function createRequestUrl( method: ApiMethod, basePath: string, + version: string, + namespace: string, subPath: string, body?: JSONRequestBody, ) { - // Remove leading slash from apiPath if it has one - const cleanedPaths = compact([basePath, subPath]).map(removeLeadingSlash); - let url = [process.env.apiUrl, ...cleanedPaths].join("/"); - + // Remove leading slash + const cleanedPaths = compact([basePath, version, namespace, subPath]).map( + removeLeadingSlash, + ); + let url = [...cleanedPaths].join("/"); if (method === "GET" && body && !(body instanceof FormData)) { // Append query string to URL const searchBody: { [key: string]: string } = {}; diff --git a/frontend/src/api/SearchOpportunityAPI.ts b/frontend/src/api/SearchOpportunityAPI.ts index 944586a42..ae6166903 100644 --- a/frontend/src/api/SearchOpportunityAPI.ts +++ b/frontend/src/api/SearchOpportunityAPI.ts @@ -1,29 +1,42 @@ import BaseApi, { JSONRequestBody } from "./BaseApi"; -export interface SearchResponseData { - opportunities: unknown[]; -} +import { Opportunity } from "../types/searchTypes"; + +export type SearchResponseData = Opportunity[]; export default class SearchOpportunityAPI extends BaseApi { get basePath(): string { - return "search/opportunities"; + return process.env.NEXT_PUBLIC_API_URL || ""; } get namespace(): string { - return "searchOpportunities"; + return "opportunities"; } get headers() { - return {}; + const baseHeaders = super.headers; + const searchHeaders = {}; + return { ...baseHeaders, ...searchHeaders }; } - async getSearchOpportunities(queryParams?: JSONRequestBody) { - const subPath = ""; + async searchOpportunities(queryParams?: JSONRequestBody) { + const requestBody = { + pagination: { + order_by: "opportunity_id", + page_offset: 1, + page_size: 25, + sort_direction: "ascending", + }, + ...queryParams, + }; + const subPath = "search"; const response = await this.request( - "GET", + "POST", + this.basePath, + this.namespace, subPath, - queryParams, + requestBody, ); return response; diff --git a/frontend/src/api/mock/APIMockResponse.json b/frontend/src/api/mock/APIMockResponse.json index e4ca84161..dc9b736b6 100644 --- a/frontend/src/api/mock/APIMockResponse.json +++ b/frontend/src/api/mock/APIMockResponse.json @@ -3,7 +3,7 @@ { "agency": "US-ABC", "applicant_types": ["state_governments", "county_governments"], - "category": "discretionary", + "category": "<===========THIS IS MOCK DATA==============>", "category_explanation": null, "created_at": "2024-02-14T20:29:26.960670+00:00", "funding_categories": ["agriculture", "recovery_act"], diff --git a/frontend/src/app/search/page.tsx b/frontend/src/app/search/page.tsx index 7b99d4573..caa7986e3 100644 --- a/frontend/src/app/search/page.tsx +++ b/frontend/src/app/search/page.tsx @@ -8,11 +8,11 @@ import { import { APISearchFetcher } from "../../services/searchfetcher/APISearchFetcher"; import { MockSearchFetcher } from "../../services/searchfetcher/MockSearchFetcher"; -import { Opportunity } from "../../types/searchTypes"; import PageNotFound from "../../pages/404"; +import { SearchResponseData } from "../../api/SearchOpportunityAPI"; import { useFeatureFlags } from "src/hooks/useFeatureFlags"; -const useMockData = true; +const useMockData = false; const searchFetcher: SearchFetcher = useMockData ? new MockSearchFetcher() : new APISearchFetcher(); @@ -22,13 +22,9 @@ const searchFetcher: SearchFetcher = useMockData // locale: string; // } -// interface SearchProps { -// initialOpportunities: Opportunity[]; -// } - export default function Search() { const { featureFlagsManager, mounted } = useFeatureFlags(); - const [searchResults, setSearchResults] = useState([]); + const [searchResults, setSearchResults] = useState([]); const handleButtonClick = (event: React.MouseEvent) => { event.preventDefault(); @@ -48,10 +44,15 @@ export default function Search() { return ( <> + {searchFetcher instanceof APISearchFetcher ? ( +

Live API

+ ) : ( +

Mock Call

+ )}
    {searchResults.map((opportunity) => ( -
  • - {opportunity.id}, {opportunity.title} +
  • + {opportunity.category}, {opportunity.opportunity_title}
    • ))}
diff --git a/frontend/src/services/searchfetcher/APISearchFetcher.ts b/frontend/src/services/searchfetcher/APISearchFetcher.ts index f545184e7..d063fd88b 100644 --- a/frontend/src/services/searchfetcher/APISearchFetcher.ts +++ b/frontend/src/services/searchfetcher/APISearchFetcher.ts @@ -1,19 +1,24 @@ -import { Opportunity } from "../../types/searchTypes"; -import { SearchFetcher } from "./SearchFetcher"; +import SearchOpportunityAPI, { + SearchResponseData, +} from "../../api/SearchOpportunityAPI"; -// TODO: Just a placeholder URL to display some data while we build search -const URL = "https://jsonplaceholder.typicode.com/posts"; +import { SearchFetcher } from "./SearchFetcher"; -// TODO: call BaseApi or extension to make the actual call export class APISearchFetcher extends SearchFetcher { - async fetchOpportunities(): Promise { + private searchApi: SearchOpportunityAPI; + + constructor() { + super(); + this.searchApi = new SearchOpportunityAPI(); + } + + async fetchOpportunities(): Promise { try { - const response = await fetch(URL); - if (!response.ok) { - throw new Error(`HTTP error! status: ${response.status}`); + const response = await this.searchApi.searchOpportunities(); + if (!response.data) { + throw new Error(`No data returned from API`); } - const data: Opportunity[] = (await response.json()) as Opportunity[]; - return data; + return response.data; } catch (error) { console.error("Error fetching opportunities:", error); throw error; diff --git a/frontend/src/services/searchfetcher/MockSearchFetcher.ts b/frontend/src/services/searchfetcher/MockSearchFetcher.ts index 59e4c8c6e..e8db8bd05 100644 --- a/frontend/src/services/searchfetcher/MockSearchFetcher.ts +++ b/frontend/src/services/searchfetcher/MockSearchFetcher.ts @@ -1,41 +1,11 @@ -import { Opportunity } from "../../types/searchTypes"; import { SearchFetcher } from "./SearchFetcher"; - -export const MOCKOPPORTUNITIES: Opportunity[] = [ - { - userId: 1, - id: 1, - title: - "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", - body: "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto", - }, - { - userId: 1, - id: 2, - title: "qui est esse", - body: "est rerum tempore vitae\nsequi sint nihil reprehenderit dolor beatae ea dolores neque\nfugiat blanditiis voluptate porro vel nihil molestiae ut reiciendis\nqui aperiam non debitis possimus qui neque nisi nulla", - }, - { - userId: 1, - id: 3, - title: "ea molestias quasi exercitationem repellat qui ipsa sit aut", - body: "et iusto sed quo iure\nvoluptatem occaecati omnis eligendi aut ad\nvoluptatem doloribus vel accusantium quis pariatur\nmolestiae porro eius odio et labore et velit aut", - }, - { - userId: 1, - id: 4, - title: "eum et est occaecati", - body: "ullam et saepe reiciendis voluptatem adipisci\nsit amet autem assumenda provident rerum culpa\nquis hic commodi nesciunt rem tenetur doloremque ipsam iure\nquis sunt voluptatem rerum illo velit", - }, -]; +import { SearchResponseData } from "../../api/SearchOpportunityAPI"; +import mockData from "../../api/mock/APIMockResponse.json"; export class MockSearchFetcher extends SearchFetcher { - async fetchOpportunities(): Promise { - return await new Promise((resolve) => { - // Resolve mock data file with simulated delay - setTimeout(() => { - resolve(MOCKOPPORTUNITIES); - }, 500); - }); + async fetchOpportunities(): Promise { + // simulate delay + await new Promise((resolve) => setTimeout(resolve, 750)); + return mockData.data; } } diff --git a/frontend/src/services/searchfetcher/SearchFetcher.ts b/frontend/src/services/searchfetcher/SearchFetcher.ts index be4a39f75..2eee71532 100644 --- a/frontend/src/services/searchfetcher/SearchFetcher.ts +++ b/frontend/src/services/searchfetcher/SearchFetcher.ts @@ -1,12 +1,12 @@ -import { Opportunity } from "../../types/searchTypes"; +import { SearchResponseData } from "../../api/SearchOpportunityAPI"; export abstract class SearchFetcher { - abstract fetchOpportunities(): Promise; + abstract fetchOpportunities(): Promise; } export async function fetchSearchOpportunities( searchFetcher: SearchFetcher, -): Promise { +): Promise { try { return await searchFetcher.fetchOpportunities(); } catch (error) { diff --git a/frontend/src/types/searchTypes.ts b/frontend/src/types/searchTypes.ts index d8dcd8abe..d545ddded 100644 --- a/frontend/src/types/searchTypes.ts +++ b/frontend/src/types/searchTypes.ts @@ -1,6 +1,62 @@ +export interface AssistanceListing { + assistance_listing_number: string; + program_title: string; +} + +export interface Summary { + additional_info_url: string; + additional_info_url_description: string; + agency_code: string; + agency_contact_description: string; + agency_email_address: string; + agency_email_address_description: string; + agency_name: string; + agency_phone_number: string; + applicant_eligibility_description: string | null; + archive_date: string; + award_ceiling: number; + award_floor: number; + close_date: string; + close_date_description: string; + estimated_total_program_funding: number; + expected_number_of_awards: number; + funding_category_description: string | null; + is_cost_sharing: boolean; + opportunity_status: string; + post_date: string; + summary_description: string; +} + export interface Opportunity { - userId: number; - id: number; - title: string; - body: string; + agency: string; + applicant_types: string[]; + category: string; + category_explanation: null | string; + created_at: string; + funding_categories: string[]; + funding_instruments: string[]; + modified_comments: null | string; + opportunity_assistance_listings: AssistanceListing[]; + opportunity_id: number; + opportunity_number: string; + opportunity_title: string; + revision_number: number; + summary: Summary; + updated_at: string; +} + +export interface PaginationInfo { + order_by: string; + page_offset: number; + page_size: number; + sort_direction: string; + total_pages: number; + total_records: number; +} +export interface ApiResponse { + data: Opportunity[]; + message: string; + pagination_info: PaginationInfo; + status_code: number; + warnings: []; } diff --git a/frontend/tests/api/BaseApi.test.ts b/frontend/tests/api/BaseApi.test.ts index 0c90a6bce..852ff4697 100644 --- a/frontend/tests/api/BaseApi.test.ts +++ b/frontend/tests/api/BaseApi.test.ts @@ -1,4 +1,4 @@ -import BaseApi, { ApiMethod } from "../../src/api/BaseApi"; +import BaseApi, { ApiMethod, JSONRequestBody } from "../../src/api/BaseApi"; // Define a concrete implementation of BaseApi for testing class TestApi extends BaseApi { @@ -26,9 +26,11 @@ describe("BaseApi", () => { it("sends a GET request to the API", async () => { const method: ApiMethod = "GET"; - const subPath = "endpoint"; + const basePath = "http://mydomain:8080"; + const namespace = "mynamespace"; + const subPath = "myendpointendpoint"; - await testApi.request(method, subPath); + await testApi.request(method, basePath, namespace, subPath); const expectedHeaders = { "Content-Type": "application/json", @@ -42,4 +44,34 @@ describe("BaseApi", () => { }), ); }); + + it("sends a POST request to the API", async () => { + const method: ApiMethod = "POST"; + const basePath = "http://mydomain:8080"; + const namespace = "mynamespace"; + const subPath = "myendpointendpoint"; + const body: JSONRequestBody = { + pagination: { + order_by: "opportunity_id", + page_offset: 1, + page_size: 25, + sort_direction: "ascending", + }, + }; + + await testApi.request(method, basePath, namespace, subPath, body); + + const expectedHeaders = { + "Content-Type": "application/json", + }; + + expect(fetch).toHaveBeenCalledWith( + expect.any(String), + expect.objectContaining({ + method, + headers: expectedHeaders, + body: JSON.stringify(body), + }), + ); + }); }); diff --git a/frontend/tests/api/SearchOpportunityApi.test.ts b/frontend/tests/api/SearchOpportunityApi.test.ts index 5a962fb95..31efd952b 100644 --- a/frontend/tests/api/SearchOpportunityApi.test.ts +++ b/frontend/tests/api/SearchOpportunityApi.test.ts @@ -1,3 +1,4 @@ +import { JSONRequestBody } from "../../src/api/BaseApi"; import SearchOpportunityAPI from "../../src/api/SearchOpportunityAPI"; const mockFetch = ({ @@ -24,7 +25,7 @@ describe("SearchOpportunityAPI", () => { searchApi = new SearchOpportunityAPI(); }); - describe("getSearchOpportunities", () => { + describe("searchOpportunities", () => { beforeEach(() => { global.fetch = mockFetch({ response: { @@ -37,18 +38,31 @@ describe("SearchOpportunityAPI", () => { it("sends GET request to search opportunities endpoint with query parameters", async () => { const queryParams = { keyword: "science" }; - const response = await searchApi.getSearchOpportunities(queryParams); - expect(fetch).toHaveBeenCalledWith( - `${process.env.apiUrl as string}/search/opportunities?keyword=science`, - { - method: "GET", - headers: baseRequestHeaders, - body: null, + const response = await searchApi.searchOpportunities(queryParams); + + const method = "POST"; + const headers = baseRequestHeaders; + + const body: JSONRequestBody = { + pagination: { + order_by: "opportunity_id", + page_offset: 1, + page_size: 25, + sort_direction: "ascending", }, + ...queryParams, + }; + + expect(fetch).toHaveBeenCalledWith( + expect.any(String), + expect.objectContaining({ + method, + headers, + body: JSON.stringify(body), + }), ); expect(response.data).toEqual({ opportunities: [] }); - expect(1).toBe(1); }); }); }); diff --git a/frontend/tests/pages/search.test.tsx b/frontend/tests/pages/search.test.tsx index c8ccd7d1d..a303c3a4a 100644 --- a/frontend/tests/pages/search.test.tsx +++ b/frontend/tests/pages/search.test.tsx @@ -1,8 +1,8 @@ import { fireEvent, render, screen, waitFor } from "@testing-library/react"; -import { axe } from "jest-axe"; -import { useFeatureFlags } from "src/hooks/useFeatureFlags"; import Search from "../../src/app/search/page"; +import { axe } from "jest-axe"; +import { useFeatureFlags } from "src/hooks/useFeatureFlags"; jest.mock("src/hooks/useFeatureFlags"); @@ -17,6 +17,45 @@ const setFeatureFlag = (flag: string, value: boolean) => { }); }; +const mockData = [ + { + agency: "firstagency", + category: "firstcategory", + opportunity_title: "firsttitle", + }, + { + agency: "secondagency2", + category: "secondcategory", + opportunity_title: "secondtitle", + }, +]; + +// Mock both search fetchers in case we switch +// Could also switch on a feature flag +jest.mock("../../src/services/searchfetcher/APISearchFetcher", () => { + return { + APISearchFetcher: jest.fn().mockImplementation(() => { + return { + fetchOpportunities: jest.fn().mockImplementation(() => { + return Promise.resolve(mockData); + }), + }; + }), + }; +}); + +jest.mock("../../src/services/searchfetcher/MockSearchFetcher", () => { + return { + MockSearchFetcher: jest.fn().mockImplementation(() => { + return { + fetchOpportunities: jest.fn().mockImplementation(() => { + return Promise.resolve(mockData); + }), + }; + }), + }; +}); + describe("Search", () => { it("passes accessibility scan", async () => { setFeatureFlag("showSearchV0", true); @@ -32,8 +71,9 @@ describe("Search", () => { fireEvent.click(screen.getByRole("button", { name: /update results/i })); await waitFor(() => { - expect(screen.getByText(/sunt aut/i)).toBeInTheDocument(); + expect(screen.getByText(/firstcategory/i)).toBeInTheDocument(); }); + expect(screen.getByText(/secondcategory/i)).toBeInTheDocument(); }); it("renders PageNotFound when feature flag is off", async () => {