Add support for fetching with credentials (#385)

* explicitly set 'credentials' parameter for fetch
Element84 · May 14, 2024 · cd2bd91 · cd2bd91
1 parent d2af52d
commit cd2bd91
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## unreleased
+
+### Changed
+
+- API calls via `fetch` now include configuration for including authentication.
+  This can be changed with the config FETCH_CREDENTIALS, which defaults to the
+  browser default of `same-origin`.
+
 ## 5.2.0 - 2024-05-08
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -107,6 +107,7 @@ The file `config_helper/config.example.json` is included in this repository as r
 | LAYER_LIST_SERVICES      | Defines the services used as reference layers for the map. **Limitations:** Currently only WMS services are supported and only `EPSG:4326` or `EPSG:3857` are supported values for defining crs options. If not set or not formatted correctly, reference layer list widget will either be empty or will not render. Formatting should match example in `config.example.json`.                                                                                                                                                | Optional |
 | STAC_LINK_ENABLED        | If set to `true`, STAC Item link will render in Item Details.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Optional |
 | SHOW_ITEM_AUTO_ZOOM      | If set to `true`, switch will render in `Filters` list to let the user toggle if the map automatically centers on item footprint when selected item is changed. Default when initialized is auto-zoom not enabled, user must opt-in by turning on (choice will persist for app session).                                                                                                                                                                                                                                      | Optional |
+| FETCH_CREDENTIALS        | Defines if API calls made from the app should include the authentication used to access the app. Can be set to `same-origin` (default), `include`, or `omit`.                                                                                                                                                                                                                                                                                                                                                                 | Optional |
 
 ### Links
 

diff --git a/src/services/get-aggregate-service.js b/src/services/get-aggregate-service.js
@@ -13,7 +13,8 @@ export async function AggregateSearchService(searchParams, gridType) {
       store.getState().mainSlice.appConfig.STAC_API_URL
     }/aggregate?${searchParams}`,
     {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     }
   )
     .then((response) => {

diff --git a/src/services/get-aggregations-service.js b/src/services/get-aggregations-service.js
@@ -6,7 +6,8 @@ export async function GetCollectionAggregationsService(collectionId) {
       store.getState().mainSlice.appConfig.STAC_API_URL
     }/collections/${collectionId}/aggregations`,
     {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     }
   )
     .then((response) => {

diff --git a/src/services/get-all-scenes-service.js b/src/services/get-all-scenes-service.js
@@ -8,7 +8,11 @@ import {
 import { DEFAULT_MAX_SCENES_RENDERED } from '../components/defaults'
 
 async function fetchFeatures(url, abortSignal) {
-  const response = await fetch(url, { signal: abortSignal })
+  const response = await fetch(url, {
+    signal: abortSignal,
+    credentials:
+      store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
+  })
   const data = await response.json()
   clearLayer('clickedSceneImageLayer')
 

diff --git a/src/services/get-collections-service.js b/src/services/get-collections-service.js
@@ -11,7 +11,8 @@ export async function GetCollectionsService(searchParams) {
   await fetch(
     `${store.getState().mainSlice.appConfig.STAC_API_URL}/collections`,
     {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     }
   )
     .then((response) => {

diff --git a/src/services/get-config-service.js b/src/services/get-config-service.js
@@ -9,7 +9,6 @@ export async function LoadConfigIntoStateService() {
   }config/config.json?_cb=${cacheBuster}`
 
   await fetch(configUrl, {
-    method: 'GET',
     cache: 'no-store'
   })
     .then((response) => {

diff --git a/src/services/get-local-grid-data-json-service.js b/src/services/get-local-grid-data-json-service.js
@@ -7,7 +7,6 @@ export async function LoadLocalGridDataService(fileName) {
     import.meta.env.BASE_URL
   }data/${fileName}.json?_cb=${cacheBuster}`
   await fetch(configUrl, {
-    method: 'GET',
     cache: 'no-store'
   })
     .then((response) => {

diff --git a/src/services/get-mosaic-bounds.js b/src/services/get-mosaic-bounds.js
@@ -1,7 +1,10 @@
+import { store } from '../redux/store'
+
 export function GetMosaicBoundsService(mosaicURL) {
   return new Promise(function (resolve, reject) {
     fetch(mosaicURL, {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     })
       .then((response) => {
         if (response.ok) {

diff --git a/src/services/get-queryables-service.js b/src/services/get-queryables-service.js
@@ -6,7 +6,8 @@ export function GetCollectionQueryablesService(collectionId) {
       store.getState().mainSlice.appConfig.STAC_API_URL
     }/collections/${collectionId}/queryables`,
     {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     }
   )
     .then((response) => {

diff --git a/src/services/get-search-service.js b/src/services/get-search-service.js
@@ -15,7 +15,8 @@ export async function SearchService(searchParams, typeOfSearch) {
       store.getState().mainSlice.appConfig.STAC_API_URL
     }/search?${searchParams}`,
     {
-      method: 'GET'
+      credentials:
+        store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
     }
   )
     .then((response) => {

diff --git a/src/utils/mapHelper.js b/src/utils/mapHelper.js
@@ -376,7 +376,8 @@ function addImageOverlay(item) {
   const tilerParams = constructSceneTilerParams(_selectedCollectionData.id)
 
   fetch(featureURL, {
-    method: 'GET'
+    credentials:
+      store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
   })
     .then(function (response) {
       return response.json()

diff --git a/src/utils/searchHelper.js b/src/utils/searchHelper.js
@@ -433,7 +433,9 @@ function newMosaicSearch() {
     headers: {
       'Content-Type': 'application/vnd.titiler.stac-api-query+json'
     },
-    body: JSON.stringify(createMosaicBody)
+    body: JSON.stringify(createMosaicBody),
+    credentials:
+      store.getState().mainSlice.appConfig.FETCH_CREDENTIALS || 'same-origin'
   }
 
   AddMosaicService(requestOptions)