Copilot commented on code in PR #40804: URL: https://github.com/apache/superset/pull/40804#discussion_r3363320959
########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + Review Comment: This module introduces new user-facing labels (renderer options / OSM style choice) but doesn’t use the standard `t(...)` translation helper, so these strings won’t be localizable in Explore controls. ########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + +export type MapStyleChoice = { + value: string; + label: string; + attribution?: string; +}; + +export type MapRendererOption = { + value: MapProvider; + label: string; + disabled?: boolean; +}; + +export type RasterTileMapStyle = { + version: 8; + sources: { + [sourceId: string]: { + type: 'raster'; + tiles: string[]; + tileSize: 256; + attribution: string; + }; + }; + layers: [ + { + id: string; + type: 'raster'; + source: string; + minzoom: 0; + maxzoom: 22; + }, + ]; +}; + +export type ResolvedMapStyle = string | RasterTileMapStyle; + +export const OSM_TILE_STYLE_URL = + 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'; +export const OSM_TILE_ATTRIBUTION = '© OpenStreetMap contributors'; +export const OSM_TILE_STYLE_CHOICE: MapStyleChoice = { + value: OSM_TILE_STYLE_URL, + label: 'Streets (OSM)', + attribution: OSM_TILE_ATTRIBUTION, +}; Review Comment: `OSM_TILE_STYLE_CHOICE.label` is displayed in UI controls; it should be wrapped in `t(...)` so it can be translated like other control labels. ########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + +export type MapStyleChoice = { + value: string; + label: string; + attribution?: string; +}; + +export type MapRendererOption = { + value: MapProvider; + label: string; + disabled?: boolean; +}; + +export type RasterTileMapStyle = { + version: 8; + sources: { + [sourceId: string]: { + type: 'raster'; + tiles: string[]; + tileSize: 256; + attribution: string; + }; + }; + layers: [ + { + id: string; + type: 'raster'; + source: string; + minzoom: 0; + maxzoom: 22; + }, + ]; +}; + +export type ResolvedMapStyle = string | RasterTileMapStyle; + +export const OSM_TILE_STYLE_URL = + 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'; +export const OSM_TILE_ATTRIBUTION = '© OpenStreetMap contributors'; +export const OSM_TILE_STYLE_CHOICE: MapStyleChoice = { + value: OSM_TILE_STYLE_URL, + label: 'Streets (OSM)', + attribution: OSM_TILE_ATTRIBUTION, +}; + +export const MAPLIBRE_RENDERER_OPTION: MapRendererOption = { + value: 'maplibre', + label: 'MapLibre (open-source)', +}; +export const MAPBOX_RENDERER_OPTION: MapRendererOption = { + value: 'mapbox', + label: 'Mapbox (API key required)', +}; +export const DISABLED_MAPBOX_RENDERER_OPTION: MapRendererOption = { + ...MAPBOX_RENDERER_OPTION, + label: 'Mapbox (MAPBOX_API_KEY required)', + disabled: true, +}; + +const TILE_PROTOCOL = 'tile://'; +const RASTER_SOURCE_ID = 'osm-raster-tiles'; +const RASTER_LAYER_ID = 'osm-raster-layer'; + +type BootstrapData = { + common?: { + conf?: { + MAPBOX_API_KEY?: unknown; + }; + }; +}; + +export function getBootstrapDataFromDocument(): unknown { + if (typeof document === 'undefined') { + return undefined; + } + + try { + const appContainer = document.getElementById('app'); + const dataBootstrap = appContainer?.getAttribute('data-bootstrap'); + return dataBootstrap ? JSON.parse(dataBootstrap) : undefined; + } catch { + return undefined; + } +} + +export function getMapboxApiKeyFromBootstrap( + bootstrapData: unknown = getBootstrapDataFromDocument(), +): string { + const mapboxApiKey = (bootstrapData as BootstrapData | undefined)?.common + ?.conf?.MAPBOX_API_KEY; + return typeof mapboxApiKey === 'string' ? mapboxApiKey : ''; +} + +export function hasMapboxApiKey( + bootstrapData: unknown = getBootstrapDataFromDocument(), +): boolean { + return getMapboxApiKeyFromBootstrap(bootstrapData).trim().length > 0; +} + +export function getMapRendererOptions({ + hasMapboxKey, +}: { + hasMapboxKey: boolean; + currentValue?: MapProvider; +}): MapRendererOption[] { + return [ + MAPLIBRE_RENDERER_OPTION, + hasMapboxKey ? MAPBOX_RENDERER_OPTION : DISABLED_MAPBOX_RENDERER_OPTION, + ]; +} + +function unwrapTileProtocol(value: string): string { + return value.startsWith(TILE_PROTOCOL) + ? value.slice(TILE_PROTOCOL.length) + : value; +} + +export function isRasterTileTemplate(value: unknown): value is string { + if (typeof value !== 'string') { + return false; + } + const tileUrl = unwrapTileProtocol(value); + return ['{z}', '{x}', '{y}'].every(templateParam => + tileUrl.includes(templateParam), + ); +} + +export function buildRasterTileMapStyle(value: string): RasterTileMapStyle { + return { + version: 8, + sources: { + [RASTER_SOURCE_ID]: { + type: 'raster', + tiles: [unwrapTileProtocol(value)], + tileSize: 256, + attribution: OSM_TILE_ATTRIBUTION, + }, + }, + layers: [ + { + id: RASTER_LAYER_ID, + type: 'raster', + source: RASTER_SOURCE_ID, + minzoom: 0, + maxzoom: 22, + }, + ], + }; +} Review Comment: `buildRasterTileMapStyle()` assigns OpenStreetMap attribution to *any* raster tile template (anything containing {z}/{x}/{y}). This is incorrect for non-OSM tile servers and can misattribute third-party map data. ########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + +export type MapStyleChoice = { + value: string; + label: string; + attribution?: string; +}; + +export type MapRendererOption = { + value: MapProvider; + label: string; + disabled?: boolean; +}; + +export type RasterTileMapStyle = { + version: 8; + sources: { + [sourceId: string]: { + type: 'raster'; + tiles: string[]; + tileSize: 256; + attribution: string; + }; + }; + layers: [ + { + id: string; + type: 'raster'; + source: string; + minzoom: 0; + maxzoom: 22; + }, + ]; +}; + +export type ResolvedMapStyle = string | RasterTileMapStyle; + +export const OSM_TILE_STYLE_URL = + 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'; +export const OSM_TILE_ATTRIBUTION = '© OpenStreetMap contributors'; +export const OSM_TILE_STYLE_CHOICE: MapStyleChoice = { + value: OSM_TILE_STYLE_URL, + label: 'Streets (OSM)', + attribution: OSM_TILE_ATTRIBUTION, +}; + +export const MAPLIBRE_RENDERER_OPTION: MapRendererOption = { + value: 'maplibre', + label: 'MapLibre (open-source)', +}; +export const MAPBOX_RENDERER_OPTION: MapRendererOption = { + value: 'mapbox', + label: 'Mapbox (API key required)', +}; Review Comment: `MAPBOX_RENDERER_OPTION.label` is a user-facing control label; wrap it in `t(...)` so it remains translatable. ########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + +export type MapStyleChoice = { + value: string; + label: string; + attribution?: string; +}; + +export type MapRendererOption = { + value: MapProvider; + label: string; + disabled?: boolean; +}; + +export type RasterTileMapStyle = { + version: 8; + sources: { + [sourceId: string]: { + type: 'raster'; + tiles: string[]; + tileSize: 256; + attribution: string; + }; + }; + layers: [ + { + id: string; + type: 'raster'; + source: string; + minzoom: 0; + maxzoom: 22; + }, + ]; +}; + +export type ResolvedMapStyle = string | RasterTileMapStyle; + +export const OSM_TILE_STYLE_URL = + 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'; +export const OSM_TILE_ATTRIBUTION = '© OpenStreetMap contributors'; +export const OSM_TILE_STYLE_CHOICE: MapStyleChoice = { + value: OSM_TILE_STYLE_URL, + label: 'Streets (OSM)', + attribution: OSM_TILE_ATTRIBUTION, +}; + +export const MAPLIBRE_RENDERER_OPTION: MapRendererOption = { + value: 'maplibre', + label: 'MapLibre (open-source)', +}; Review Comment: `MAPLIBRE_RENDERER_OPTION.label` is a user-facing control label; wrap it in `t(...)` to keep renderer choices localizable. ########## superset-frontend/packages/superset-ui-core/src/utils/mapStyles.ts: ########## @@ -0,0 +1,180 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export type MapProvider = 'maplibre' | 'mapbox'; + +export type MapStyleChoice = { + value: string; + label: string; + attribution?: string; +}; + +export type MapRendererOption = { + value: MapProvider; + label: string; + disabled?: boolean; +}; + +export type RasterTileMapStyle = { + version: 8; + sources: { + [sourceId: string]: { + type: 'raster'; + tiles: string[]; + tileSize: 256; + attribution: string; + }; + }; + layers: [ + { + id: string; + type: 'raster'; + source: string; + minzoom: 0; + maxzoom: 22; + }, + ]; +}; + +export type ResolvedMapStyle = string | RasterTileMapStyle; + +export const OSM_TILE_STYLE_URL = + 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'; +export const OSM_TILE_ATTRIBUTION = '© OpenStreetMap contributors'; +export const OSM_TILE_STYLE_CHOICE: MapStyleChoice = { + value: OSM_TILE_STYLE_URL, + label: 'Streets (OSM)', + attribution: OSM_TILE_ATTRIBUTION, +}; + +export const MAPLIBRE_RENDERER_OPTION: MapRendererOption = { + value: 'maplibre', + label: 'MapLibre (open-source)', +}; +export const MAPBOX_RENDERER_OPTION: MapRendererOption = { + value: 'mapbox', + label: 'Mapbox (API key required)', +}; +export const DISABLED_MAPBOX_RENDERER_OPTION: MapRendererOption = { + ...MAPBOX_RENDERER_OPTION, + label: 'Mapbox (MAPBOX_API_KEY required)', + disabled: true, +}; Review Comment: `DISABLED_MAPBOX_RENDERER_OPTION.label` is shown in Explore when Mapbox is disabled; it should be translated via `t(...)` like the other renderer labels. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
