SIMSBIOHUB-239: Proxy BCTW/Critterbase requests through the SIMS backend using the SIMS Service Account #1077

JeremyQuartech · 2023-08-25T16:48:38Z

Links to Jira Tickets

https://apps.nrs.gov.bc.ca/int/jira/browse/SIMSBIOHUB-239

Description of Changes

Adds new method to Keylcloak service to get service account token
Adds new service, 'BctwService', to make requests to the BCTW API
Adds new '/telemetry' API endpoint for generic lookups and calls that proxy straight through to BCTW API
Adds new 'CritterbaseService', to make requests to the Critterbase API
Adds '/critter-data' endpoint for generic lookup and xref proxied calls to the Critterbase API

Testing Notes

'BCTW_API_HOST' must be added to your env file for the BctwService to function.
'CB_API_HOST' must be added to your env file for CritterbaseService to work.
'KEYCLOAK_ADMIN_USERNAME' and 'KEYCLOAK_ADMIN_PASSWORD' must be present in your env file for the Keycloak.getServiceToken method to work.
The changes required in BCTW API and Critterbase are live in their dev environments: BCTW_API_HOST=https://moe-bctw-api-dev.apps.silver.devops.gov.bc.ca, CB_API_HOST=https://moe-critterbase-api-dev.apps.silver.devops.gov.bc.ca/api

…NoSummarySectionData.tsx

…tterbase from within SIMS api

…o critterbase calls, still need to implement automated signup

…pi routes similar to existing SIMS routes

…handling

…out menus in UI

…mponents can now be added to form on button click

… calling cb api through hooks in the frontend. No more extra auth headers, now all done through keycloak JWT.

…rbase. Made a wrapper function for critterbase selects that uses existing Formik components

…der and the docker compose that we don't need anymore

…ge in dev environment

api/src/paths/critter-data/critters/{critterId}.ts

NickPhura · 2023-08-29T23:58:25Z

There are a couple of code smells for a few tests that don't have a complete assertion

api/src/paths/critter-data/critters/index.test.ts

…for bctw and critterbase services

…oken retrieval

…ior, fixed critterbase service test

…IOHUB-239

…to SIMSBIOHUB-239

…t code smells, improved assertions.

al-rosenthal

🌆

sonarcloud · 2023-08-31T19:41:36Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
1.9% Duplication

…using SIMS Service Account (#1077) * Adds '/telemetry' endpoint to API for proxied BCTW requests. * Adds new service to handle authenticated requests to Critterbase API. * Adds new '/critter-data' endpoint to API for proxied Critterbase requests. * Modifies Add Animal form's api hooks to point at /critter-data endpoint instead of Critterbase directly. * Adds new method to Keycloak service for service account token retrieval. --------- Co-authored-by: Mac Deluca <Mac.Deluca@quartech.com> Co-authored-by: Graham Stewart <graham.stewart@quartech.com> Co-authored-by: Alfred Rosenthal <alfred.k.rosenthal@gmail.com> Co-authored-by: Curtis Upshall <curtisupshall@gmail.com> Co-authored-by: Nick Phura <nickphura@gmail.com>

MacQSL and others added 30 commits July 18, 2023 10:27

Created section for individual animals in survey

b5e0bb8

consolidated duplicate components into single component -> now using …

df53224

…NoSummarySectionData.tsx

added SurveyAnimals.tsx to SurveyPage

43315b3

renamed file to NoSurveySectionData

da71902

updated references to use new component name/import

b96aa49

Added new express router and relevant env variables to connect to cri…

8b47054

…tterbase from within SIMS api

Added simple critterbase hook and test page to app

5f498bb

Frontend / API will not pass correct authentication headers through t…

13f4aa2

…o critterbase calls, still need to implement automated signup

adding state for animal section buttons

b96d61d

Implemented critterbase signup and markings endpoint as express-opena…

5352ef8

…pi routes similar to existing SIMS routes

fixed merge conflict, and updated styling to use MUI5 standards

ba3e335

Added state for handling the form sections

772d73a

created form context + custom hook for handling form section data

23fc5c1

Added first form section (General)

9aff645

updated default export to be the wrapped instance of the AnimalForm

4b6fc18

placeholder content created for General section

e1a1021

updated useAnimalFormData.tsx to implement useReducer for form state …

2451c14

…handling

created helpButton tooltip component, styled simlarily to current pop…

fbb6b67

…out menus in UI

modified the way the state is being handled inside the AnimalForm, co…

2a529a7

…mponents can now be added to form on button click

added temp delete button for each generated form section

ab98f4e

Removes express-openapi style critterbase routes in favor of directly…

b799aaf

… calling cb api through hooks in the frontend. No more extra auth headers, now all done through keycloak JWT.

Forgot to start tracking files for critterbase frontend hooks.

6c558b3

renamed GeneralAnimalForm and refactored

20ded28

refactored CaptureAnimalForm

8d0c847

created form section wrapper to reduce syling duplication

2988018

refactored IndividualAnimalForm to use formik FieldArray

94b5959

updated animal form related types

ceef6e2

Made another hook for getting the lookup tables and enums from critte…

cf0799a

…rbase. Made a wrapper function for critterbase selects that uses existing Formik components

Removed some extra critterbase-sims api fusion stuff from the api fol…

8015531

…der and the docker compose that we don't need anymore

Adds conditonal render to AppRouter to only display dev Playground pa…

16df8c5

…ge in dev environment

Merge branch 'dev' into SIMSBIOHUB-239

f339cdb

curtisupshall previously approved these changes Aug 29, 2023

View reviewed changes

api/src/paths/critter-data/critters/{critterId}.ts Outdated Show resolved Hide resolved

ignore-skip

b8f111e

NickPhura reviewed Aug 30, 2023

View reviewed changes

api/src/paths/critter-data/critters/index.test.ts Outdated Show resolved Hide resolved

SIMSBIOHUB-239: updated error handling

55a9c07

curtisupshall dismissed their stale review via 55a9c07 August 30, 2023 00:29

JeremyQuartech and others added 14 commits August 30, 2023 08:40

Added error handling to interceptor and removed makePostPatch method …

f8b06b7

…for bctw and critterbase services

Added request interceptor to axios instance to allow async keycloak t…

339a58f

…oken retrieval

Removed test code

5acc4bd

Fixed axios instance for critterbase service, fixed bulk insert behav…

efe242d

…ior, fixed critterbase service test

Merge branch 'SIMSBIOHUB-239' of github.com:bcgov/biohubbc into SIMSB…

0ef26ba

…IOHUB-239

WIP: Updated bctw tests

63e49f4

Merge branch 'SIMSBIOHUB-239' of https://github.com/bcgov/biohubbc in…

27c7286

…to SIMSBIOHUB-239

Fixed failing BctwService tests

9453798

Fixed failing critterbase service tests

8086044

Addressed more review comments. Added uuid format to paths, fixed tes…

c8e3abe

…t code smells, improved assertions.

Removed some outdated checks against frontend critterbase env vars

558e085

Merge branch 'dev' into SIMSBIOHUB-239

a61645d

Merge branch 'dev' into SIMSBIOHUB-239

4bd48bb

Fixed typo in config for critterbase url

061a605

NickPhura approved these changes Aug 31, 2023

View reviewed changes

Merge branch 'dev' into SIMSBIOHUB-239

fd21e40

NickPhura removed the Early Feedback Welcome PR is not finished, but early review feedback is welcomed label Aug 31, 2023

al-rosenthal approved these changes Aug 31, 2023

View reviewed changes

Merge branch 'dev' into SIMSBIOHUB-239

acfc74f

JeremyQuartech merged commit df258a0 into dev Aug 31, 2023
20 checks passed

JeremyQuartech deleted the SIMSBIOHUB-239 branch August 31, 2023 20:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SIMSBIOHUB-239: Proxy BCTW/Critterbase requests through the SIMS backend using the SIMS Service Account #1077

SIMSBIOHUB-239: Proxy BCTW/Critterbase requests through the SIMS backend using the SIMS Service Account #1077

JeremyQuartech commented Aug 25, 2023 •

edited

Loading

NickPhura commented Aug 29, 2023

al-rosenthal left a comment

sonarcloud bot commented Aug 31, 2023

SIMSBIOHUB-239: Proxy BCTW/Critterbase requests through the SIMS backend using the SIMS Service Account #1077

SIMSBIOHUB-239: Proxy BCTW/Critterbase requests through the SIMS backend using the SIMS Service Account #1077

Conversation

JeremyQuartech commented Aug 25, 2023 • edited Loading

Links to Jira Tickets

Description of Changes

Testing Notes

NickPhura commented Aug 29, 2023

al-rosenthal left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 31, 2023

JeremyQuartech commented Aug 25, 2023 •

edited

Loading