Merge pull request #7393 from plotly/cam/7334/switch-geodata-providers

feat: Switch geodata providers

Author: camdecoster

.circleci/config.yml

@@ -483,11 +483,32 @@ jobs:
           name: Bundle bundle-stackgl/index.js
           command: cd stackgl_modules && cp index.js INDEX.js && npm run bundle-stackgl
       - run:
-          name: Test stackgl_modules/index.js diff - If failed please remember this file in auto generated and you should not modify it directly until a dependeny change. To suggest changes please submit pull request to the relevant dependency.
+          name: Test stackgl_modules/index.js diff - If failed please remember this file in auto generated and you should not modify it directly until a dependency change. To suggest changes please submit pull request to the relevant dependency.
           command: diff --unified --color stackgl_modules/INDEX.js stackgl_modules/index.js
       - store_artifacts:
           path: stackgl_modules/index.js
           destination: stackgl_modules/index.js
+  
+  test-topojson-build:
+    docker:
+      - image: cimg/node:18.20.4
+    working_directory: ~/plotly.js
+    steps:
+      - checkout
+      - run:
+          name: Set up build environment
+          command: cd topojson && npm ci
+      - run:
+          name: Build topojson
+          command: cd topojson && mv dist dist_backup && npm run build
+      - run:
+          name: Compare existing files with newly built files. Any difference is a failure. A failure might mean that the source data changed.
+          command: diff -qr topojson/dist topojson/dist_backup
+      - run:
+          name: Compress artifacts
+          command: tar -cvzf topojson.tar topojson/dist
+      - store_artifacts:
+          path: topojson.tar
 
 workflows:
   version: 2
@@ -560,3 +581,5 @@ workflows:
       - publish-dist-node-v22
 
       - test-stackgl-bundle
+
+      - test-topojson-build

devtools/test_dashboard/devtools.js

@@ -17,8 +17,7 @@ var Tabs = {
         Plotly.setPlotConfig({
 
             // use local topojson files
-            topojsonURL: '../../node_modules/sane-topojson/dist/',
-
+            topojsonURL: "../../topojson/dist",
             // register mapbox access token
             // run `npm run preset` if you haven't yet
             mapboxAccessToken: credentials.MAPBOX_ACCESS_TOKEN,
@@ -268,4 +267,3 @@ function handleOnLoad() {
     Tabs.setPlotConfig();
     plotFromHash();
 }
-

draftlogs/7393_change.md

@@ -171,7 +171,6 @@
     "raw-loader": "^4.0.2",
     "read-last-lines": "^1.8.0",
     "run-series": "^1.1.9",
-    "sane-topojson": "^4.0.0",
     "sass": "^1.78.0",
     "stream-browserify": "^3.0.0",
     "style-loader": "^4.0.0",

package-lock.json

@@ -1,8 +1,28 @@
 'use strict';
 
-var saneTopojson = require('sane-topojson');
+// TODO: Remove comments from Antarctica, Oceania during new maps release PR
+const topojson = {
+  africa_110m: require('../../dist/topojson/africa_110m.json'),
+  // antarctica_110m: require('../../dist/topojson/antarctica_110m.json'),
+  asia_110m: require('../../dist/topojson/asia_110m.json'),
+  europe_110m: require('../../dist/topojson/europe_110m.json'),
+  'north-america_110m': require('../../dist/topojson/north-america_110m.json'),
+  // oceania_110m: require('../../dist/topojson/oceania_110m.json'),
+  'south-america_110m': require('../../dist/topojson/south-america_110m.json'),
+  usa_110m: require('../../dist/topojson/usa_110m.json'),
+  world_110m: require('../../dist/topojson/world_110m.json'),
+  africa_50m: require('../../dist/topojson/africa_50m.json'),
+  // antarctica_50m: require('../../dist/topojson/antarctica_50m.json'),
+  asia_50m: require('../../dist/topojson/asia_50m.json'),
+  europe_50m: require('../../dist/topojson/europe_50m.json'),
+  'north-america_50m': require('../../dist/topojson/north-america_50m.json'),
+  // oceania_50m: require('../../dist/topojson/oceania_50m.json'),
+  'south-america_50m': require('../../dist/topojson/south-america_50m.json'),
+  usa_50m: require('../../dist/topojson/usa_50m.json'),
+  world_50m: require('../../dist/topojson/world_50m.json'),
+}
 
-
-exports.version = require('../version').version;
-
-exports.topojson = saneTopojson;
+module.exports = {
+  topojson,
+  version: require('../version').version
+}

package.json

@@ -13,7 +13,9 @@ topojsonUtils.getTopojsonName = function(geoLayout) {
 };
 
 topojsonUtils.getTopojsonPath = function(topojsonURL, topojsonName) {
-    return topojsonURL + topojsonName + '.json';
+    topojsonURL += topojsonURL.endsWith('/') ? '' : '/';
+    
+    return `${topojsonURL}${topojsonName}.json`;
 };
 
 topojsonUtils.getTopojsonFeatures = function(trace, topojson) {

src/assets/geo_assets.js

@@ -185,7 +185,19 @@ exports.scopeDefaults = {
         lataxisRange: [-60, 15],
         projType: 'mercator',
         projRotate: [0, 0, 0]
-    }
+    },
+    antarctica: {
+        lonaxisRange: [-180, 180],
+        lataxisRange: [-90, -60],
+        projType: 'equirectangular',
+        projRotate: [0, 0, 0]
+    },
+    oceania: {
+        lonaxisRange: [-180, 180],
+        lataxisRange: [-50, 25],
+        projType: 'equirectangular',
+        projRotate: [0, 0, 0]
+    },
 };
 
 // angular pad to avoid rounding error around clip angles

src/lib/topojson_utils.js

@@ -29,7 +29,13 @@ for path in `ls $dist/plotly*`; do
 done
 
 # copy topojson files over to the sync folder
-cp $dist/topojson/* $sync
+# NOTE: Temporarily adding the suffix '_un' to avoid overwriting the old topojson
+# which some old plots might depend on
+for filepath in $dist/topojson/*.json; do
+    f=${filepath##*/}
+    f=${f%.*}
+    cp $filepath "$sync/${f%.*}_un.json"
+done
 
 # list folder and files
 echo $sync

src/plots/geo/constants.js

@@ -73,7 +73,6 @@ function writeLibFiles(obj) {
     }
 }
 
-// copy topojson files from sane-topojson to dist/
 function copyTopojsonFiles() {
     fs.copy(
         constants.pathToTopojsonSrc,