Merge pull request #140 from natcap/bugfix/132-env-urls

Remove hard-coded clipping service URL

Author: megannissel

.env.example

@@ -96,9 +96,10 @@ CKANEXT__SPATIAL__COMMON_MAP__MAPBOX__ACCESS_TOKEN=""
 CKANEXT__SPATIAL__COMMON_MAP__MAPBOX__MAP_ID=""
 
 # Config for mappreview
-CKANEXT__MAPPREVIEW__MAPBOX_API_KEY=""
-CKANEXT__MAPPREVIEW__MAPBOX_STYLE=""
-CKANEXT__MAPPREVIEW__TITILER_URL=""
+CKANEXT__MAPPREVIEW__MAPBOX_API_KEY="FIXME"
+CKANEXT__MAPPREVIEW__MAPBOX_STYLE="mapbox://styles/FIXME"
+CKANEXT__MAPPREVIEW__TITILER_URL="https://titiler-897938321824.us-west1.run.app"
+CKANEXT__MAPPREVIEW__CLIPPING_SERVICE_URL="https://clipping-service-897938321824.us-west1.run.app"
 
 # Theme configuration
 CKAN__SITE_LOGO=NatCapLogo.jpg
@@ -116,10 +117,6 @@ CKAN__AUTH__PUBLIC_USER_DETAILS=false
 # Config for or_facet, allow OR logic for facets
 CKANEXT__OR_FACET__OPTIONAL="extras_sources_res_formats extras_placenames tags"
 
-CKANEXT__MAPPREVIEW__MAPBOX_API_KEY="FIXME"
-CKANEXT__MAPPREVIEW__MAPBOX_STYLE="mapbox://styles/FIXME"
-CKANEXT__MAPPREVIEW__TITILER_URL="https://titiler-897938321824.us-west1.run.app"
-
 CKAN___GOOGLEANALYTICS__ID="G-3EBTM23KV6"  # The tracking id, could be from GA4.  Google says this is not a secret.
 CKAN___GOOGLEANALYTICS__ACCOUNT="data.naturalcapitalproject.stanford.edu"  # our GA account name, from the upper-right of the GA panel
 #CKANEXT__GOOGLEANALYTICS_USERNAME=""  # README says this is required, but I'm not seeing it in the source code and I don't want to provide it.  Doesn't appear to be needed.

Makefile

@@ -1,4 +1,4 @@
-.PHONY: deploy deploy-staging sync-on-prod fetch-nginx-config
+.PHONY: deploy deploy-staging sync-on-prod fetch-nginx-config clipping-service env-clip ckan-dev
 
 GIT_DIR := /opt/ckan-catalog/data.naturalcapitalproject.stanford.edu
 CKAN_PROD_URL := https://data.naturalcapitalproject.stanford.edu
@@ -24,3 +24,22 @@ fetch-nginx-config:
 	gcloud compute scp $(GCLOUD_COMMON_ARGS) $(PROD_VM_NAME):/etc/nginx/sites-enabled/ckan  host-nginx/etc.nginx.sites-available.ckan
 	gcloud compute scp $(GCLOUD_COMMON_ARGS) $(PROD_VM_NAME):/etc/nginx/nginx.conf          host-nginx/etc.nginx.nginx.conf
 	gcloud compute scp $(GCLOUD_COMMON_ARGS) $(PROD_VM_NAME):/etc/nginx/throttle-bots.conf  host-nginx/etc.nginx.throttle-bots.conf
+
+
+# Targets for local development:
+CLIP_ENV := clipenv
+
+env-clip:
+	conda create -n $(CLIP_ENV) -y -c conda-forge python=3.12
+	conda env update -n $(CLIP_ENV) --file ./clipping-service/app/requirements.txt
+	conda env config vars set -n $(CLIP_ENV) DEV_MODE=True
+	@echo "To activate the environment and run the clipping service:"
+	@echo ">> conda activate $(CLIP_ENV)"
+	@echo ">> make clipping-service"
+
+clipping-service:
+	python -m gunicorn --chdir ./clipping-service/app app:app --reload
+
+ckan-dev:
+	docker compose -f docker-compose.dev.yml build
+	docker compose -f docker-compose.dev.yml up --watch

clipping-service/app/app.py

@@ -24,19 +24,22 @@
 from osgeo import osr
 
 app = flask.Flask(__name__, template_folder='templates')
+
+cors_origins = [
+    'https://data-staging.naturalcapitalproject.org',
+    'https://data.naturalcapitalproject.stanford.edu'
+]
+
+if os.environ.get("DEV_MODE"):
+    cors_origins.append("https://localhost:*")
+
 CORS(app, resources={
     '/*': {
-        'origins': [
-            # Only use localhost for local development.
-            # 'http://localhost:*',
-            # 'http://127.0.0.1:*',
-            'https://data-staging.naturalcapitalproject.org',
-            'https://data.naturalcapitalproject.stanford.edu',
-        ]
+        'origins': cors_origins
     }
 })
-logging.basicConfig(level=logging.DEBUG)
 
+logging.basicConfig(level=logging.DEBUG)
 
 # PLAN: write a logging handler to listen for progress messages and send those
 # to the client.

docker-compose.dev.yml

@@ -36,6 +36,8 @@ services:
       - redisnet
     env_file:
       - .env
+    environment:
+      - CKANEXT__MAPPREVIEW__CLIPPING_SERVICE_URL=http://localhost:8000
     depends_on:
       db:
         condition: service_healthy

src/ckanext-mappreview/ckanext/mappreview/assets/js/mappreview.js

@@ -152,6 +152,7 @@ ckan.module("mappreview", function ($, _) {
 
       const config = JSON.parse(this.options.config.replace(/'/g, '"'));
       const globalConfig = this._getGlobalConfig();
+      const clipping_service_url = this._getGlobalConfig().clipping_service_url;
 
       mapboxgl.accessToken = globalConfig.mapbox_api_key;
       const map = new mapboxgl.Map({
@@ -909,7 +910,6 @@ ckan.module("mappreview", function ($, _) {
             clipping_options['target_cellsize'] = [target_pixel_size, -target_pixel_size];
           }
 
-          const clipping_service_url = 'https://clipping-service-897938321824.us-west1.run.app';
           fetch(`${clipping_service_url}/clip`, {
             method: "POST",
             body: JSON.stringify(clipping_options),
@@ -987,12 +987,9 @@ ckan.module("mappreview", function ($, _) {
               document.getElementById('natcap-clip-submit-button').innerHTML = submit_text;
       });
 
-      const clipping_endpoint = 'https://clipping-service-897938321824.us-west1.run.app'
-
-
       function _setEPSGItems(epsg_code) {
         console.log(`Updating SRS info for ${epsg_code}`);
-        fetch(`${clipping_endpoint}/epsg_info?epsg_code=${epsg_code}`, {
+        fetch(`${clipping_service_url}/epsg_info?epsg_code=${epsg_code}`, {
           method: "GET",
         }).then(epsg_response => {
           if (epsg_response.ok) {
@@ -1028,7 +1025,7 @@ ckan.module("mappreview", function ($, _) {
           console.log('updating source raster from cog ' + cog);
 
           var epsg_input = document.getElementById('natcapClipSettingEPSGCode');
-          var cog_stats_url = `${clipping_endpoint}/info?cog_url=${encodeURIComponent(cog)}`;;
+          var cog_stats_url = `${clipping_service_url}/info?cog_url=${encodeURIComponent(cog)}`;
           fetch(cog_stats_url).then(response => {
             if (response.ok) {
               return response.json();

src/ckanext-natcap/ckanext/natcap/assets/js/natcap-dataset-clip.js

@@ -6,7 +6,6 @@ natcap-js:
     - js/natcap-spatial-query.js
     - js/natcap-textarea-copy.js
     - js/natcap-advanced-search.js
-    - js/natcap-dataset-clip.js
     - js/natcap-copy-url.js
     - js/natcap-text-linkify.js
   extra: