Skip to content

Commit

Permalink
feat(datahub): Added an option in config to specify if WMS shoul be t…
Browse files Browse the repository at this point in the history
…iled or not. False by default.
  • Loading branch information
Romuald Caplier committed May 29, 2024
1 parent ff2a9db commit f0ae0ef
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 42 deletions.
3 changes: 3 additions & 0 deletions conf/default.toml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ background_color = "#fdfbff"
# Optional; if true, opens external viewer in new tab (default false)
# external_viewer_open_new_tab = false

# Optional; Will not tile WMS. False by default.
# do_not_tile_wms = false

# Optional; if true, the default basemap will not be added to the map.
# Use [[map_layer]] sections to define your own custom layers (see below)
# do_not_use_default_basemap = false
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,10 @@ The map section lets you customize how maps appear and behave across GeoNetwork-
max_extent = [-418263.418776, 5251529.591305, 961272.067714, 6706890.609855]
```

- `do_not_tile_wms` (optional)

Will not use tiling when requesting WMS services. Defaults to `false` (WMS are tiled). Not using tiles for WMS might incur performance loss since the client will not benefit from an eventual tile cache anymore. On the other hand, visual quality might improve in case a map tile server does not handle neighbouring tiles correctly, e.g. symbols or text being cropped at tile boundaries. This can be set true to prevent visual conflicts on tile borders, if the WMS server does not add a gutter, for example. gn-ui does not add a gutter on the client side, in order to allow server-side caching.

- `do_not_use_default_basemap` (optional)

If set to `true`, the default basemap will not be added to the map. Defaults to `false` (base map is shown).
Expand Down
85 changes: 56 additions & 29 deletions libs/feature/map/src/lib/map-context/map-context.service.spec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { HttpClientTestingModule } from '@angular/common/http/testing'
import { TestBed } from '@angular/core/testing'
import { MAP_CONFIG_FIXTURE } from '@geonetwork-ui/util/app-config'
import { MAP_CONFIG_FIXTURE, MapConfig } from '@geonetwork-ui/util/app-config'
import { FeatureCollection } from 'geojson'
import { Geometry } from 'ol/geom'
import TileLayer from 'ol/layer/Tile'
Expand Down Expand Up @@ -33,6 +33,8 @@ import {
MapContextService,
} from './map-context.service'
import Feature from 'ol/Feature'
import ImageWMS from 'ol/source/ImageWMS'
import ImageLayer from 'ol/layer/Image'

const mapStyleServiceMock = {
createDefaultStyle: jest.fn(() => new Style()),
Expand Down Expand Up @@ -130,35 +132,60 @@ describe('MapContextService', () => {
})

describe('WMS', () => {
beforeEach(() => {
;(layerModel = MAP_CTX_LAYER_WMS_FIXTURE),
(layer = service.createLayer(layerModel))
})
it('create a tile layer', () => {
expect(layer).toBeTruthy()
expect(layer).toBeInstanceOf(TileLayer)
})
it('create a TileWMS source', () => {
const source = layer.getSource()
expect(source).toBeInstanceOf(TileWMS)
})
it('set correct WMS params', () => {
const source = layer.getSource()
const params = source.getParams()
expect(params.LAYERS).toBe(layerModel.name)
})
it('set correct url without existing REQUEST and SERVICE params', () => {
const source = layer.getSource()
const urls = source.getUrls()
expect(urls.length).toBe(1)
expect(urls[0]).toBe(
'https://www.geograndest.fr/geoserver/region-grand-est/ows?REQUEST=GetCapabilities&SERVICE=WMS'
)
describe('when mapConfig.DO_NOT_TILE_WMS === false', () => {
beforeEach(() => {
const mapConfig: MapConfig = {
...MAP_CONFIG_FIXTURE,
DO_NOT_TILE_WMS: false,
}
;(layerModel = MAP_CTX_LAYER_WMS_FIXTURE),
(layer = service.createLayer(layerModel, mapConfig))
})
it('create a tile layer', () => {
expect(layer).toBeTruthy()
expect(layer).toBeInstanceOf(TileLayer)
})
it('create a TileWMS source', () => {
const source = layer.getSource()
expect(source).toBeInstanceOf(TileWMS)
})
it('set correct WMS params', () => {
const source = layer.getSource()
const params = source.getParams()
expect(params.LAYERS).toBe(layerModel.name)
})
it('set correct url without existing REQUEST and SERVICE params', () => {
const source = layer.getSource()
const urls = source.getUrls()
expect(urls.length).toBe(1)
expect(urls[0]).toBe(
'https://www.geograndest.fr/geoserver/region-grand-est/ows?REQUEST=GetCapabilities&SERVICE=WMS'
)
})
})
it('set WMS gutter of 20px', () => {
const source = layer.getSource()
const gutter = source.gutter_
expect(gutter).toBe(20)

describe('when mapConfig.DO_NOT_TILE_WMS === true', () => {
beforeEach(() => {
const mapConfig: MapConfig = {
...MAP_CONFIG_FIXTURE,
DO_NOT_TILE_WMS: true,
}
;(layerModel = MAP_CTX_LAYER_WMS_FIXTURE),
(layer = service.createLayer(layerModel, mapConfig))
})
it('create an image layer', () => {
expect(layer).toBeTruthy()
expect(layer).toBeInstanceOf(ImageLayer)
})
it('create an ImageWMS source', () => {
const source = layer.getSource()
expect(source).toBeInstanceOf(ImageWMS)
})
it('set correct WMS params', () => {
const source = layer.getSource()
const params = source.getParams()
expect(params.LAYERS).toBe(layerModel.name)
})
})
})

Expand Down
31 changes: 22 additions & 9 deletions libs/feature/map/src/lib/map-context/map-context.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import OGCVectorTile from 'ol/source/OGCVectorTile.js'
import { MVT } from 'ol/format'
import VectorTileLayer from 'ol/layer/VectorTile'
import OGCMapTile from 'ol/source/OGCMapTile.js'
import ImageLayer from 'ol/layer/Image'
import ImageWMS from 'ol/source/ImageWMS'

export const DEFAULT_BASELAYER_CONTEXT: MapContextLayerXyzModel = {
type: MapContextLayerTypeEnum.XYZ,
Expand Down Expand Up @@ -73,11 +75,13 @@ export class MapContextService {
}
map.setView(this.createView(mapContext.view, map))
map.getLayers().clear()
mapContext.layers.forEach((layer) => map.addLayer(this.createLayer(layer)))
mapContext.layers.forEach((layer) =>
map.addLayer(this.createLayer(layer, mapConfig))
)
return map
}

createLayer(layerModel: MapContextLayerModel): Layer {
createLayer(layerModel: MapContextLayerModel, mapConfig?: MapConfig): Layer {
const { type } = layerModel
const style = this.styleService.styles.default
switch (type) {
Expand Down Expand Up @@ -112,13 +116,22 @@ export class MapContextService {
}),
})
case MapContextLayerTypeEnum.WMS:
return new TileLayer({
source: new TileWMS({
url: layerModel.url,
params: { LAYERS: layerModel.name },
gutter: 20,
}),
})
if (mapConfig?.DO_NOT_TILE_WMS) {
return new ImageLayer({
source: new ImageWMS({
url: layerModel.url,
params: { LAYERS: layerModel.name },
}),
})
} else {
return new TileLayer({
source: new TileWMS({
url: layerModel.url,
params: { LAYERS: layerModel.name, TILED: true },
}),
})
}

case MapContextLayerTypeEnum.WMTS: {
// TODO: isolate this in utils service
const olLayer = new TileLayer({})
Expand Down
8 changes: 4 additions & 4 deletions libs/feature/record/src/lib/map-view/map-view.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,16 @@ import {
MapUtilsService,
} from '@geonetwork-ui/feature/map'
import { getOptionalMapConfig, MapConfig } from '@geonetwork-ui/util/app-config'
import { getLinkLabel, ProxyService } from '@geonetwork-ui/util/shared'
import { getLinkLabel } from '@geonetwork-ui/util/shared'
import Feature from 'ol/Feature'
import { Geometry } from 'ol/geom'
import { StyleLike } from 'ol/style/Style'
import {
BehaviorSubject,
combineLatest,
from,
lastValueFrom,
Observable,
of,
startWith,
Subscription,
throwError,
withLatestFrom,
Expand Down Expand Up @@ -117,7 +115,9 @@ export class MapViewComponent implements OnInit, OnDestroy {
},
} as MapContextModel)
),
tap(() => this.resetSelection())
tap((res) => {
this.resetSelection()
})
)
),
withLatestFrom(this.mdViewFacade.metadata$),
Expand Down
2 changes: 2 additions & 0 deletions libs/util/app-config/src/lib/app-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ export function loadAppConfig() {
[],
[
'max_zoom',
'do_not_tile_wms',
'max_extent',
'baselayer',
'do_not_use_default_basemap',
Expand All @@ -158,6 +159,7 @@ export function loadAppConfig() {
? null
: ({
MAX_ZOOM: parsedMapSection.max_zoom,
DO_NOT_TILE_WMS: parsedMapSection.do_not_tile_wms,
MAX_EXTENT: parsedMapSection.max_extent,
EXTERNAL_VIEWER_URL_TEMPLATE:
parsedMapSection.external_viewer_url_template,
Expand Down
1 change: 1 addition & 0 deletions libs/util/app-config/src/lib/fixtures.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export const MAP_CONFIG_FIXTURE: MapConfig = {
MAX_ZOOM: 10,
MAX_EXTENT: [-418263.418776, 5251529.591305, 961272.067714, 6706890.609855],
DO_NOT_USE_DEFAULT_BASEMAP: false,
DO_NOT_TILE_WMS: false,
EXTERNAL_VIEWER_URL_TEMPLATE:
'https://example.com/myviewer/#/?actions=[{"type":"CATALOG:ADD_LAYERS_FROM_CATALOGS","layers":["${layer_name}"],"sources":[{"url":"${service_url}","type":"${service_type}"}]}]',
EXTERNAL_VIEWER_OPEN_NEW_TAB: true,
Expand Down
1 change: 1 addition & 0 deletions libs/util/app-config/src/lib/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export interface LayerConfig {

export interface MapConfig {
MAX_ZOOM?: number
DO_NOT_TILE_WMS: boolean
MAX_EXTENT?: [number, number, number, number] // Expressed as [minx, miny, maxx, maxy]
EXTERNAL_VIEWER_URL_TEMPLATE?: string
EXTERNAL_VIEWER_OPEN_NEW_TAB?: boolean
Expand Down

0 comments on commit f0ae0ef

Please sign in to comment.