Merge remote-tracking branch 'origin/v4.0' into cam/7678/enable-typescript-type-checking

Author: camdecoster

.github/workflows/ci.yml

@@ -23,6 +23,7 @@ jobs:
     outputs:
       stackgl_modules: ${{ steps.check.outputs.stackgl_modules }}
       topojson: ${{ steps.check.outputs.topojson }}
+      regl_codegen: ${{ steps.check.outputs.regl_codegen }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
         with:
@@ -42,6 +43,12 @@ jobs:
           if git diff --name-only "$BASE"...HEAD -- stackgl_modules/ | grep -q .; then
             echo "stackgl_modules=true" >> "$GITHUB_OUTPUT"
           fi
+          # If any of the directories listed below have changed, we need to re-run the regl-codegen step
+          # stackgl_modules/ is listed here too because the regl-* shader libs live there;
+          # changes can alter shader output and require regenerating the precompiled shaders.
+          if git diff --name-only "$BASE"...HEAD -- src/traces/scattergl/ src/traces/scatterpolargl/ src/traces/splom/ src/traces/parcoords/ src/lib/prepare_regl.js stackgl_modules/ devtools/regl_codegen/ | grep -q .; then
+            echo "regl_codegen=true" >> "$GITHUB_OUTPUT"
+          fi
 
   # ============================================================
   # Root build job - all dependent jobs fan out from here
@@ -656,3 +663,54 @@ jobs:
           name: topojson-dist
           retention-days: 7
           path: topojson/dist/
+
+  check-regl-codegen:
+    needs: [detect-changes, install-and-cibuild]
+    if: >-
+      (github.event_name == 'push' && github.ref_name == github.event.repository.default_branch) ||
+      needs.detect-changes.outputs.regl_codegen == 'true'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: ./.github/actions/setup-workspace
+      - uses: ./.github/actions/setup-chrome
+
+      - name: Run regl codegen
+        run: |
+          # Wipe the codegen output dir so orphaned shader files surface as deletions in the diff below.
+          rm -rf src/generated/regl-codegen/*
+          node devtools/regl_codegen/server.mjs &
+          SERVER_PID=$!
+          until curl -sf -o /dev/null http://localhost:3000/build/regl_codegen-bundle.js 2>/dev/null; do
+            sleep 1
+          done
+          $CHROME_BIN --headless=new --no-sandbox --enable-unsafe-swiftshader --ignore-gpu-blocklist http://localhost:3000/devtools/regl_codegen/index.html &
+          wait $SERVER_PID
+
+      - name: Check regl precompiled shaders are up to date
+        run: |
+          # git add -N so newly-generated (untracked) shader files show up in git diff
+          git add -N src/generated/regl-codegen/
+          if ! git diff --exit-code \
+              src/generated/regl-codegen/ \
+              src/traces/scattergl/regl_precompiled.js \
+              src/traces/scatterpolargl/regl_precompiled.js \
+              src/traces/splom/regl_precompiled.js \
+              src/traces/parcoords/regl_precompiled.js; then
+            echo "::error::Regl precompiled shaders are out of date. Download the 'regl-codegen' artifact from this workflow run, extract it into src/, and commit the updated files to this pull request."
+            exit 1
+          fi
+
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        name: Upload updated regl codegen files
+        if: failure()
+        with:
+          name: regl-codegen
+          retention-days: 7
+          path: |
+            src/generated/regl-codegen/
+            src/traces/scattergl/regl_precompiled.js
+            src/traces/scatterpolargl/regl_precompiled.js
+            src/traces/splom/regl_precompiled.js
+            src/traces/parcoords/regl_precompiled.js

CONTRIBUTING.md

@@ -163,19 +163,54 @@ npm run schema
 #### Step 9: REGL - Review & commit potential changes to precompiled regl shaders
 
 If you are implementing a new feature that involves regl shaders, or if you are
-making changes that affect the usage of regl shaders, you would need to run
+making changes that affect the usage of regl shaders, you will need to regenerate the precompiled regl shader code. In practice, that means edits under:
 
-```bash
-npm run regl-codegen
-```
+- `src/traces/{scattergl,scatterpolargl,splom,parcoords}/`
+- `src/lib/prepare_regl.js`
+- `stackgl_modules/` (where the `regl-*` shader libs live)
+- `devtools/regl_codegen/`
 
-to regenerate the regl code. This will prompt you to open a browser window. This will then run through all
-traces with 'regl' in the tags, and store the captured code into 
-[src/generated/regl-codegen](https://github.com/plotly/plotly.js/blob/master/src/generated/regl-codegen). If no updates are necessary, it will be a no-op, but if there are changes, you will need to commit them.
+CI's `check-regl-codegen` job uses this same list as its trigger — see [`.github/workflows/ci.yml`](.github/workflows/ci.yml) for the authoritative version.
 
 This is needed because regl performs codegen in runtime which breaks CSP
 compliance, and so for strict builds we pre-generate regl shader code here.
 
+The CI pipeline will automatically detect when regl-related files have changed and
+run the codegen process. If the precompiled shaders are out of date, the
+`check-regl-codegen` job will fail and upload a `regl-codegen` artifact containing
+the updated files. The artifact represents the full desired state of the codegen
+output (CI wipes the output directory before regenerating, so any orphaned shader
+files are pruned). To fix this:
+
+1. Download the `regl-codegen` artifact from the failed workflow run
+2. Delete `src/generated/regl-codegen/` in your working tree, then unzip the
+   artifact into `src/` so it replaces (rather than merges into) the existing
+   directory. Note that `actions/upload-artifact` strips the longest common
+   parent path from the uploaded paths, so the zip's root contains
+   `generated/regl-codegen/` and `traces/{scattergl,scatterpolargl,splom,parcoords}/regl_precompiled.js`
+   directly — extracting into `src/` restores the correct layout and
+   overwrites the four `regl_precompiled.js` files in one step.
+3. Commit and push the changes to your pull request
+
+Alternatively, you can regenerate the code locally:
+
+```bash
+rm -rf src/generated/regl-codegen/*
+npm run regl-codegen
+```
+
+The `rm -rf` step is needed to clean up any orphaned shader files left over from
+previous changes. `npm run regl-codegen` will prompt you to open
+a browser window, run through the mocks for each regl-using trace
+(`parcoords`, `scattergl`, `scatterpolargl`, `splom`), and store the captured
+shader code into
+[src/generated/regl-codegen](https://github.com/plotly/plotly.js/blob/master/src/generated/regl-codegen).
+The four `src/traces/{parcoords,scattergl,scatterpolargl,splom}/regl_precompiled.js`
+files are rewritten in the same pass so their imports point at the freshly
+generated shader files. Commit any changes that result — both the
+`src/generated/regl-codegen/` updates and any modified `regl_precompiled.js`
+files.
+
 #### Other npm scripts that may be of interest in development
 
 - `npm run preprocess`: pre-processes the css and svg source file in js. This

devtools/regl_codegen/server.mjs

@@ -85,16 +85,20 @@ function handleCodegen(data) {
     var exports = ['', '/* eslint-disable quote-props */', 'module.exports = {', ''].join('\n');
     var varId = 0;
 
-    Object.entries(generated).forEach(function (kv) {
-        var key = kv[0];
-        var value = kv[1];
-        var filePath = path.join(pathToReglCodegenSrc, key);
-        fs.writeFileSync(filePath, 'module.exports = ' + value);
-
-        imports += 'var v' + varId + " = require('../../" + path.join(constants.reglCodegenSubdir, key) + "');\n";
-        exports += "    '" + key + "': v" + varId + ',\n';
-        varId++;
-    });
+    // Sort by shader-hash key so the emitted import/export order is deterministic
+    // across machines (fs.readdir mock order varies by OS/filesystem, which would
+    // otherwise leak into regl_precompiled.js).
+    Object.keys(generated)
+        .sort()
+        .forEach((key) => {
+            var value = generated[key];
+            var filePath = path.join(pathToReglCodegenSrc, key);
+            fs.writeFileSync(filePath, 'module.exports = ' + value);
+
+            imports += 'var v' + varId + " = require('../../" + path.join(constants.reglCodegenSubdir, key) + "');\n";
+            exports += "    '" + key + "': v" + varId + ',\n';
+            varId++;
+        });
 
     if (varId > 0) {
         exports = exports.slice(0, -2) + '\n};\n';

draftlogs/7825_update.md

@@ -0,0 +1 @@
+- Enable scattermap icons to render in color, upgrade Maki icons version to 8.2, and standardize scattermap legend icons to circles [[#7825](https://github.com/plotly/plotly.js/pull/7825)]

src/components/drawing/index.js

@@ -1866,7 +1866,10 @@ function getMarkerAngle(d, trace) {
 
     if (angle === undefined) {
         angle = trace.marker.angle;
-        if (!angle || Lib.isArrayOrTypedArray(angle)) {
+        // For scattermap traces, `trace.marker.angle` defaults to 'auto',
+        // which is meaningful for the MapLibre code but not for plotly.js itself. 
+        // Therefore we need to coerce any non-numeric values to 0 (no rotation).
+        if (!isNumeric(angle) || Lib.isArrayOrTypedArray(angle)) {
             angle = 0;
         }
     }

src/components/legend/style.js

@@ -207,7 +207,12 @@ module.exports = function style(s, gd, legend) {
 
             if (showMarker) {
                 dEdit.mc = boundVal('marker.color', pickFirst);
-                dEdit.mx = boundVal('marker.symbol', pickFirst);
+                // Scattermap traces use marker.symbol to specify the Maki icon used in
+                // the map itself, which usually doesn't correspond to a valid
+                // Plotly symbol. Always draw a circle so the swatch is consistent
+                // across symbols rather than silently mismatched.
+                var isScattermapTrace = trace.type === 'scattermap' || trace.type === 'scattermapbox';
+                dEdit.mx = isScattermapTrace ? 'circle' : boundVal('marker.symbol', pickFirst);
                 dEdit.mo = boundVal('marker.opacity', Lib.mean, [0.2, 1]);
                 dEdit.mlc = boundVal('marker.line.color', pickFirst);
                 dEdit.mlw = boundVal('marker.line.width', Lib.mean, [0, 5], CST_MARKER_LINE_WIDTH);

src/components/modebar/buttons.js

@@ -76,15 +76,6 @@ modeBarButtons.sendDataToCloud = {
     }
 };
 
-modeBarButtons.editInChartStudio = {
-    name: 'editInChartStudio',
-    title: function(gd) { return _(gd, 'Edit in Chart Studio'); },
-    icon: Icons.pencil,
-    click: function(gd) {
-        Plots.sendDataToCloud(gd);
-    }
-};
-
 modeBarButtons.zoom2d = {
     name: 'zoom2d',
     _cat: 'zoom',

src/components/modebar/manage.js

@@ -145,8 +145,7 @@ function getButtonGroups(gd) {
 
     // buttons common to all plot types
     var commonGroup = ['toImage'];
-    if(context.showEditInChartStudio) commonGroup.push('editInChartStudio');
-    else if(context.showSendToCloud) commonGroup.push('sendDataToCloud');
+    if(context.showSendToCloud) commonGroup.push('sendDataToCloud');
     addGroup(commonGroup);
 
     var zoomGroup = [];

src/plot_api/plot_api.js

@@ -373,7 +373,6 @@ function _doPlot(gd, data, layout, config) {
         subroutines.drawData,
         subroutines.finalDraw,
         initInteractions,
-        Plots.addLinks,
         Plots.rehover,
         Plots.redrag,
         Plots.reselect,
@@ -485,7 +484,6 @@ function setPlotContext(gd, config) {
         context.scrollZoom = false;
         context.doubleClick = false;
         context.showTips = false;
-        context.showLink = false;
         context.displayModeBar = false;
     }
 

src/plot_api/plot_config.js

@@ -36,8 +36,7 @@ var configAttributes = {
         dflt: '',
         description: [
             'When set it determines base URL for',
-            'the \'Edit in Chart Studio\' `showEditInChartStudio`/`showSendToCloud` mode bar button',
-            'and the showLink/sendData on-graph link.',
+            'the \'Edit in Chart Studio\' `showSendToCloud` mode bar button.',
             'To enable sending your data to Chart Studio Cloud, you need to',
             'set both `plotlyServerURL` to \'https://chart-studio.plotly.com\' and',
             'also set `showSendToCloud` to true.'
@@ -227,40 +226,6 @@ var configAttributes = {
         description: 'Determines whether or not notifier is displayed.'
     },
 
-    showLink: {
-        valType: 'boolean',
-        dflt: false,
-        description: [
-            'Determines whether a link to Chart Studio Cloud is displayed',
-            'at the bottom right corner of resulting graphs.',
-            'Use with `sendData` and `linkText`.'
-        ].join(' ')
-    },
-    linkText: {
-        valType: 'string',
-        dflt: 'Edit chart',
-        noBlank: true,
-        description: [
-            'Sets the text appearing in the `showLink` link.'
-        ].join(' ')
-    },
-    sendData: {
-        valType: 'boolean',
-        dflt: true,
-        description: [
-            'If *showLink* is true, does it contain data',
-            'just link to a Chart Studio Cloud file?'
-        ].join(' ')
-    },
-    showSources: {
-        valType: 'any',
-        dflt: false,
-        description: [
-            'Adds a source-displaying function to show sources on',
-            'the resulting graphs.'
-        ].join(' ')
-    },
-
     displayModeBar: {
         valType: 'enumerated',
         values: ['hover', true, false],
@@ -286,15 +251,6 @@ var configAttributes = {
             'until you arrive at the Chart Studio and explicitly click "Save".'
         ].join(' ')
     },
-    showEditInChartStudio: {
-        valType: 'boolean',
-        dflt: false,
-        description: [
-            'Same as `showSendToCloud`, but use a pencil icon instead of a floppy-disk.',
-            'Note that if both `showSendToCloud` and `showEditInChartStudio` are turned,',
-            'only `showEditInChartStudio` will be honored.'
-        ].join(' ')
-    },
     modeBarButtonsToRemove: {
         valType: 'any',
         dflt: [],