Skip to content

Commit

Permalink
#10322: Fix scale selector to make it compatible with different proje…
Browse files Browse the repository at this point in the history 
…ctions

Description:
- fix not compatablity projections issue
- add unit tests
  • Loading branch information
@mahmoudadel54
mahmoudadel54 committed May 30, 2024
1 parent 6cbb710 commit 138ae35
Show file tree
Hide file tree
Showing 10 changed files with 212 additions and 56 deletions.
15 changes: 15 additions & 0 deletions web/client/actions/__tests__/print-test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,21 @@ describe('Test correctness of the print actions', () => {
expect(retVal.projection).toBe('EPSG:4326');
expect(retVal.currentLocale).toBe('en-US');
});
it('configurePrintMap with useFixedScales', () => {
const retVal = configurePrintMap({x: 1, y: 1}, 5, 6, 2.0, [], 'EPSG:4326', 'en-US', true);
expect(retVal).toExist();
expect(retVal.type).toBe(CONFIGURE_PRINT_MAP);
expect(retVal.center).toExist();
expect(retVal.center.x).toBe(1);
expect(retVal.zoom).toBe(5);
expect(retVal.scaleZoom).toBe(6);
expect(retVal.scale).toBe(2.0);
expect(retVal.layers).toExist();
expect(retVal.layers.length).toBe(0);
expect(retVal.projection).toBe('EPSG:4326');
expect(retVal.currentLocale).toBe('en-US');
expect(retVal.useFixedScales).toBe(true);
});

it('changePrintZoomLevel', () => {
const retVal = changePrintZoomLevel(5, 10000);
Expand Down
5 changes: 3 additions & 2 deletions web/client/actions/print.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export function printTransformerAdded(name) {
};
}

export function configurePrintMap(center, zoom, scaleZoom, scale, layers, projection, currentLocale) {
export function configurePrintMap(center, zoom, scaleZoom, scale, layers, projection, currentLocale, useFixedScales) {
return {
type: CONFIGURE_PRINT_MAP,
center,
Expand All @@ -141,7 +141,8 @@ export function configurePrintMap(center, zoom, scaleZoom, scale, layers, projec
scale,
layers,
projection,
currentLocale
currentLocale,
useFixedScales
};
}

Expand Down
54 changes: 27 additions & 27 deletions web/client/plugins/Print.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ import { layersSelector } from '../selectors/layers';
import { currentLocaleSelector } from '../selectors/locale';
import { mapSelector, scalesSelector } from '../selectors/map';
import { mapTypeSelector } from '../selectors/maptype';
import { normalizeSRS, reprojectBbox, convertDegreesToRadian } from '../utils/CoordinatesUtils';
import { normalizeSRS, convertDegreesToRadian } from '../utils/CoordinatesUtils';
import { getMessageById } from '../utils/LocaleUtils';
import { defaultGetZoomForExtent, getResolutions, mapUpdated, dpi2dpu, DEFAULT_SCREEN_DPI } from '../utils/MapUtils';
import { defaultGetZoomForExtent, getResolutions, mapUpdated, dpi2dpu, DEFAULT_SCREEN_DPI, getScales, reprojectZoom } from '../utils/MapUtils';
import { isInsideResolutionsLimits } from '../utils/LayersUtils';
import { has, includes } from 'lodash';
import {additionalLayersSelector} from "../selectors/additionallayers";
Expand Down Expand Up @@ -289,7 +289,8 @@ export default {
overrideOptions: PropTypes.object,
items: PropTypes.array,
addPrintParameter: PropTypes.func,
printingService: PropTypes.object
printingService: PropTypes.object,
printMap: PropTypes.object
};

static contextTypes = {
Expand Down Expand Up @@ -340,7 +341,8 @@ export default {
currentLocale: 'en-US',
overrideOptions: {},
items: [],
printingService: getDefaultPrintingService()
printingService: getDefaultPrintingService(),
printMap: {}
};

state = {
Expand Down Expand Up @@ -569,34 +571,30 @@ export default {
const {
map: newMap,
capabilities,
minZoom,
configurePrintMap: configurePrintMapProp,
useFixedScales,
getZoomForExtent,
maxZoom,
currentLocale,
scales: scalesProp,
layers
layers,
printMap,
printSpec
} = props || this.props;
if (newMap && newMap.bbox && capabilities) {
const bbox = reprojectBbox([
newMap.bbox.bounds.minx,
newMap.bbox.bounds.miny,
newMap.bbox.bounds.maxx,
newMap.bbox.bounds.maxy
], newMap.bbox.crs, newMap.projection);
const mapSize = this.getMapSize();
const selectedPrintProjection = (printSpec && printSpec?.params?.projection) || (printSpec && printSpec?.projection) || (printMap && printMap.projection) || 'EPSG:3857';
const printSrs = normalizeSRS(selectedPrintProjection);
const mapProjection = newMap.projection;
const mapSrs = normalizeSRS(mapProjection);
const zoom = reprojectZoom(newMap.zoom, mapSrs, printSrs);
const scales = getPrintScales(capabilities);
const printMapScales = getScales(printSrs);
const scaleZoom = getNearestZoom(zoom, scales, printMapScales);
if (useFixedScales) {
const mapZoom = getZoomForExtent(bbox, mapSize, minZoom, maxZoom);
const scales = getPrintScales(capabilities);
const scaleZoom = getNearestZoom(newMap.zoom, scales);
const scale = scales[scaleZoom];
configurePrintMapProp(newMap.center, mapZoom, scaleZoom, scale,
layers, newMap.projection, currentLocale);
configurePrintMapProp(newMap.center, zoom, scaleZoom, scale,
layers, newMap.projection, currentLocale, useFixedScales);
} else {
const scale = scalesProp[newMap.zoom];
configurePrintMapProp(newMap.center, newMap.zoom, newMap.zoom, scale,
layers, newMap.projection, currentLocale);
const scale = printMapScales[zoom];
configurePrintMapProp(newMap.center, zoom, scaleZoom, scale,
layers, newMap.projection, currentLocale, useFixedScales);
}
}
};
Expand Down Expand Up @@ -629,8 +627,9 @@ export default {
scalesSelector,
(state) => state.browser && (!state.browser.ie || state.browser.ie11),
currentLocaleSelector,
mapTypeSelector
], (open, capabilities, printSpec, pdfUrl, error, map, layers, additionalLayers, scales, usePreview, currentLocale, mapType) => ({
mapTypeSelector,
(state) => state.print.map
], (open, capabilities, printSpec, pdfUrl, error, map, layers, additionalLayers, scales, usePreview, currentLocale, mapType, printMap) => ({
open,
capabilities,
printSpec,
Expand All @@ -650,7 +649,8 @@ export default {
scales,
usePreview,
currentLocale,
mapType
mapType,
printMap
}));

const PrintPlugin = connect(selector, {
Expand Down
82 changes: 82 additions & 0 deletions web/client/plugins/__tests__/Print-test.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,88 @@ describe('Print Plugin', () => {
});
});

it('test configuration with useFixedScales and enableScalebox = true', (done) => {
const printingService = {
getMapConfiguration() {
return {
layers: [],
center: {
x: 0,
y: 0,
crs: "EPSG:4326"
}
};
},
validate() { return {};}
};
getPrintPlugin({
state: {...initialState,
print: {...initialState.print,
capabilities: {...initialState.print.capabilities,
scales: [1000000, 500000, 100000].map(value => ({name: value, value}))}
}}
}).then(async({ Plugin }) => {
try {
await ReactDOM.render(<Plugin
projectionOptions={{
"projections": [{"name": "UTM32N", "value": "EPSG:23032"}, {"name": "EPSG:3857", "value": "EPSG:3857"}, {"name": "EPSG:4326", "value": "EPSG:4326"}]
}}
printingService={printingService}
useFixedScales mapPreviewOptions={{
enableScalebox: true
}}/>, document.getElementById("container"));
const comp = document.getElementById("container");
await ReactTestUtils.act(async() => comp);
expect(comp).toExist();
const scaleBoxComp = document.querySelector("#mappreview-scalebox select");
expect(scaleBoxComp).toExist();
done();
} catch (ex) {
done(ex);
}
});
});
it('test configuration with useFixedScales and enableScalebox = false', (done) => {
const printingService = {
getMapConfiguration() {
return {
layers: [],
center: {
x: 0,
y: 0,
crs: "EPSG:4326"
}
};
},
validate() { return {};}
};
getPrintPlugin({
state: {...initialState,
print: {...initialState.print,
capabilities: {...initialState.print.capabilities,
scales: [1000000, 500000, 100000].map(value => ({name: value, value}))}
}}
}).then(async({ Plugin }) => {
try {
await ReactDOM.render(<Plugin
projectionOptions={{
"projections": [{"name": "UTM32N", "value": "EPSG:23032"}, {"name": "EPSG:3857", "value": "EPSG:3857"}, {"name": "EPSG:4326", "value": "EPSG:4326"}]
}}
printingService={printingService}
useFixedScales mapPreviewOptions={{
enableScalebox: false
}}/>, document.getElementById("container"));
const comp = document.getElementById("container");
await ReactTestUtils.act(async() => comp);
expect(comp).toExist();
const scaleBoxComp = document.querySelector("#mappreview-scalebox select");
expect(scaleBoxComp).toNotExist();
done();
} catch (ex) {
done(ex);
}
});
});
it('default configuration with not allowed layers', (done) => {
getPrintPlugin({
layers: [{visibility: true, type: "bing"}]
Expand Down
17 changes: 10 additions & 7 deletions web/client/plugins/__tests__/print/Projection-test.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ const initialState = {
map: {
scale: 1784,
scaleZoom: 2,
projection: "EPSG:3857"
projection: "EPSG:3857",
zoom: 3
},
capabilities: {
createURL: "http://fakeservice",
Expand Down Expand Up @@ -119,11 +120,12 @@ describe('PrintProjection Plugin', () => {
});

it('map transformer with user chosen crs', (done) => {
getPrintProjectionPlugin().then(({ Plugin, store }) => {
getPrintProjectionPlugin().then(async({ Plugin, store }) => {
try {
ReactDOM.render(<Plugin projections={[{"name": "Mercator", "value": "EPSG:3857"}, {"name": "WGS84", "value": "EPSG:4326"}]}/>, document.getElementById("container"));
const comp = ReactDOM.render(<Plugin projections={[{"name": "Mercator", "value": "EPSG:3857"}, {"name": "WGS84", "value": "EPSG:4326"}]}/>, document.getElementById("container"));
await ReactTestUtils.act(async() => comp);
const combo = getByXPath("//select");
ReactTestUtils.Simulate.change(combo, {
await ReactTestUtils.Simulate.change(combo, {
target: {
value: "EPSG:4326"
}
Expand All @@ -139,11 +141,12 @@ describe('PrintProjection Plugin', () => {
});

it('validator without allowPreview', (done) => {
getPrintProjectionPlugin().then(({ Plugin, store }) => {
getPrintProjectionPlugin().then(async({ Plugin, store }) => {
try {
ReactDOM.render(<Plugin projections={[{"name": "Mercator", "value": "EPSG:3857"}, {"name": "WGS84", "value": "EPSG:4326"}]}/>, document.getElementById("container"));
const comp = ReactDOM.render(<Plugin projections={[{"name": "Mercator", "value": "EPSG:3857"}, {"name": "WGS84", "value": "EPSG:4326"}]}/>, document.getElementById("container"));
await ReactTestUtils.act(async() => comp);
const combo = getByXPath("//select");
ReactTestUtils.Simulate.change(combo, {
await ReactTestUtils.Simulate.change(combo, {
target: {
value: "EPSG:4326"
}
Expand Down
24 changes: 12 additions & 12 deletions web/client/plugins/print/Projection.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,27 @@ import { setPrintParameter } from "../../actions/print";
import printReducer from "../../reducers/print";
import Choice from "../../components/print/Choice";
import { getMessageById } from '../../utils/LocaleUtils';
import {getScales, reprojectZoom} from "../../utils/MapUtils";
import {getScales} from "../../utils/MapUtils";

import { getAvailableCRS, normalizeSRS } from '../../utils/CoordinatesUtils';

export const projectionSelector = (state) => state?.print?.spec?.params?.projection ?? state?.print?.map?.projection ?? "EPSG:3857";

function mapTransformer(state, map) {
const projection = projectionSelector(state);
const mapProjection = mapProjectionSelector(state);
const srs = normalizeSRS(projection);
const scales = getScales(srs);
const mapProjection = mapProjectionSelector(state);
const mapSrs = normalizeSRS(mapProjection);
if (srs !== mapSrs) {
const zoom = reprojectZoom(map.scaleZoom, mapSrs, srs);
const scales = getScales(srs);
return {
...map,
zoom: zoom,
scaleZoom: map.scaleZoom, // the selected value from scale DD
scale: scales[zoom],
scale: scales[map.zoom],
zoom: map.zoom >= 1 ? map.zoom - 1 : map.zoom, // for print map preview
projection: srs
};
}
return map;
return {...map, scale: scales[map.zoom], zoom: map.zoom >= 1 ? map.zoom - 1 : map.zoom};
}

const validator = (allowPreview) => (state) => {
Expand Down Expand Up @@ -67,15 +65,17 @@ export const Projection = ({
addValidator("projection", "map-preview", validator(allowPreview));
}
}, [allowPreview]);
function changeProjection(crs) {
onChangeParameter("params.projection", crs);
onRefresh();
}
useEffect(() => {
if (enabled) {
changeProjection(projection);
addMapTransformer("projection", mapTransformer);
}
}, []);
function changeProjection(crs) {
onChangeParameter("params.projection", crs);
onRefresh();
}

return enabled ? (
<>
<Choice
Expand Down
20 changes: 20 additions & 0 deletions web/client/reducers/__tests__/print-test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,26 @@ describe('Test the print reducer', () => {
expect(state.map.layers.length).toBe(0);
expect(state.map.projection).toBe('EPSG:4326');
});
it('configure print map with useFixedScales = true', () => {
const state = print({capabilities: {}, spec: {}}, {
type: CONFIGURE_PRINT_MAP,
center: {x: 1, y: 1},
zoom: 5,
scaleZoom: 6,
scale: 10000,
layers: [],
projection: 'EPSG:4326',
useFixedScales: true
});
expect(state.map).toExist();
expect(state.map.center).toExist();
expect(state.map.center.x).toBe(1);
expect(state.map.zoom).toBe(5);
expect(state.map.scale).toBe(10000);
expect(state.map.layers.length).toBe(0);
expect(state.map.projection).toBe('EPSG:4326');
expect(state.map.useFixedScales).toBe(true);
});

it('configure print map title', () => {
const state = print({capabilities: {}, spec: {}}, {
Expand Down
5 changes: 3 additions & 2 deletions web/client/reducers/print.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ function print(state = {spec: initialSpec, capabilities: null, map: null, isLoad
scale: action.scale,
layers,
size: action.size ?? state.map?.size,
projection: action.projection
projection: action.projection,
useFixedScales: action.useFixedScales
},
error: null
}
Expand All @@ -108,7 +109,7 @@ function print(state = {spec: initialSpec, capabilities: null, map: null, isLoad
return assign({}, state, {
map: assign({}, state.map, {
scaleZoom: action.zoom,
zoom: state.map.zoom + diff,
zoom: state.map.zoom + diff >= 0 ? state.map.zoom + diff : 0,
scale: action.scale
})
}
Expand Down
Loading

0 comments on commit 138ae35

Please sign in to comment.