Skip to content

Commit

Permalink
[8.10] [maps] fix Air-gapped enviroment hitting 400 error loading fon…
Browse files Browse the repository at this point in the history
…ts for layer (#165986) (#166375)

# Backport

This will backport the following commits from `main` to `8.10`:
- [[maps] fix Air-gapped enviroment hitting 400 error loading fonts for
layer (#165986)](#165986)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nathan
Reese","email":"reese.nathan@elastic.co"},"sourceCommit":{"committedDate":"2023-09-13T16:06:05Z","message":"[maps]
fix Air-gapped enviroment hitting 400 error loading fonts for layer
(#165986)\n\nCloses
#165974 root cause of
the problem is calling `basePath.prepend` on a path\r\nwithout a leading
`/`. Maps is not consistent with path constants. Some\r\nhave leading
`/` while others do not. To resolve the issue, this PR\r\nupdates all
path constants to consistently have leading `/`.\r\n\r\nPR adds
functional test runner with `map.includeElasticMapsService:\r\nfalse` to
ensure maps is tested without EMS enabled to catch
future\r\nregressions.\r\n\r\n### Test instructions\r\n* set
*map.includeElasticMapsService: false* in kibana.dev.yml\r\n* install
sample data set\r\n* create new map with documents layer\r\n* Configure
label styling\r\n* Verify layer is displayed with labels\r\n\r\n<img
width=\"500\" alt=\"Screen Shot 2023-09-13 at 6 26 23
AM\"\r\nsrc=\"https://github.com/elastic/kibana/assets/373691/44d12e87-9b80-424c-9bc9-126b373bdf18\">\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"691311ce7c38cff3ca89758f1a45e31b7f292759","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:Presentation","Feature:Maps","v8.11.0","v8.10.1"],"number":165986,"url":"#165986
fix Air-gapped enviroment hitting 400 error loading fonts for layer
(#165986)\n\nCloses
#165974 root cause of
the problem is calling `basePath.prepend` on a path\r\nwithout a leading
`/`. Maps is not consistent with path constants. Some\r\nhave leading
`/` while others do not. To resolve the issue, this PR\r\nupdates all
path constants to consistently have leading `/`.\r\n\r\nPR adds
functional test runner with `map.includeElasticMapsService:\r\nfalse` to
ensure maps is tested without EMS enabled to catch
future\r\nregressions.\r\n\r\n### Test instructions\r\n* set
*map.includeElasticMapsService: false* in kibana.dev.yml\r\n* install
sample data set\r\n* create new map with documents layer\r\n* Configure
label styling\r\n* Verify layer is displayed with labels\r\n\r\n<img
width=\"500\" alt=\"Screen Shot 2023-09-13 at 6 26 23
AM\"\r\nsrc=\"https://github.com/elastic/kibana/assets/373691/44d12e87-9b80-424c-9bc9-126b373bdf18\">\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"691311ce7c38cff3ca89758f1a45e31b7f292759"}},"sourceBranch":"main","suggestedTargetBranches":["8.10"],"targetPullRequestStates":[{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"#165986
fix Air-gapped enviroment hitting 400 error loading fonts for layer
(#165986)\n\nCloses
#165974 root cause of
the problem is calling `basePath.prepend` on a path\r\nwithout a leading
`/`. Maps is not consistent with path constants. Some\r\nhave leading
`/` while others do not. To resolve the issue, this PR\r\nupdates all
path constants to consistently have leading `/`.\r\n\r\nPR adds
functional test runner with `map.includeElasticMapsService:\r\nfalse` to
ensure maps is tested without EMS enabled to catch
future\r\nregressions.\r\n\r\n### Test instructions\r\n* set
*map.includeElasticMapsService: false* in kibana.dev.yml\r\n* install
sample data set\r\n* create new map with documents layer\r\n* Configure
label styling\r\n* Verify layer is displayed with labels\r\n\r\n<img
width=\"500\" alt=\"Screen Shot 2023-09-13 at 6 26 23
AM\"\r\nsrc=\"https://github.com/elastic/kibana/assets/373691/44d12e87-9b80-424c-9bc9-126b373bdf18\">\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"691311ce7c38cff3ca89758f1a45e31b7f292759"}},{"branch":"8.10","label":"v8.10.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Nathan Reese <reese.nathan@elastic.co>
  • Loading branch information
kibanamachine and nreese committed Sep 13, 2023
1 parent 61055bf commit 713bfd2
Show file tree
Hide file tree
Showing 13 changed files with 171 additions and 10 deletions.
1 change: 1 addition & 0 deletions .buildkite/ftr_configs.yml
Expand Up @@ -235,6 +235,7 @@ enabled:
- x-pack/test/detection_engine_api_integration/security_and_spaces/bundled_prebuilt_rules_package/config.ts
- x-pack/test/detection_engine_api_integration/security_and_spaces/large_prebuilt_rules_package/config.ts
- x-pack/test/detection_engine_api_integration/security_and_spaces/update_prebuilt_rules_package/config.ts
- x-pack/test/disable_ems/config.ts
- x-pack/test/encrypted_saved_objects_api_integration/config.ts
- x-pack/test/examples/config.ts
- x-pack/test/fleet_api_integration/config.agent.ts
Expand Down
8 changes: 4 additions & 4 deletions x-pack/plugins/maps/common/constants.ts
Expand Up @@ -23,10 +23,10 @@ export const INITIAL_LAYERS_KEY = 'initialLayers';

export const MAPS_APP_PATH = `app/${APP_ID}`;
export const MAP_PATH = 'map';
export const GIS_INTERNAL_PATH = `internal/${APP_ID}`;
export const INDEX_SETTINGS_API_PATH = `${GIS_INTERNAL_PATH}/indexSettings`;
export const FONTS_API_PATH = `${GIS_INTERNAL_PATH}/fonts`;
export const INDEX_SOURCE_API_PATH = `${GIS_INTERNAL_PATH}/docSource`;
const GIS_INTERNAL_PATH = `internal/${APP_ID}`;
export const INDEX_SETTINGS_API_PATH = `/${GIS_INTERNAL_PATH}/indexSettings`;
export const FONTS_API_PATH = `/${GIS_INTERNAL_PATH}/fonts`;
export const INDEX_SOURCE_API_PATH = `/${GIS_INTERNAL_PATH}/docSource`;
export const INDEX_FEATURE_PATH = `/${GIS_INTERNAL_PATH}/feature`;
export const GET_MATCHING_INDEXES_PATH = `/${GIS_INTERNAL_PATH}/getMatchingIndexes`;
export const CHECK_IS_DRAWING_INDEX = `/${GIS_INTERNAL_PATH}/checkIsDrawingIndex`;
Expand Down
Expand Up @@ -17,7 +17,7 @@ export const createNewIndexAndPattern = async ({
defaultMappings: IndexSourceMappings | {};
}) => {
return await getHttp().fetch<CreateDocSourceResp>({
path: `/${INDEX_SOURCE_API_PATH}`,
path: INDEX_SOURCE_API_PATH,
method: 'POST',
version: '1',
body: JSON.stringify({
Expand Down
Expand Up @@ -35,7 +35,7 @@ async function fetchIndexSettings(indexPatternTitle: string): Promise<INDEX_SETT
const http = getHttp();
const toasts = getToasts();
try {
return await http.fetch(`/${INDEX_SETTINGS_API_PATH}`, {
return await http.fetch(INDEX_SETTINGS_API_PATH, {
method: 'GET',
credentials: 'same-origin',
version: '1',
Expand Down
Expand Up @@ -56,7 +56,7 @@ export function testOnlyClearCanAccessEmsFontsPromise() {
}

export function getKibanaFontsGlyphUrl(): string {
return getHttp().basePath.prepend(`/${FONTS_API_PATH}/{fontstack}/{range}`);
return getHttp().basePath.prepend(`${FONTS_API_PATH}/{fontstack}/{range}`);
}

export function getGlyphs(): { glyphUrlTemplate: string; isEmsFont: boolean } {
Expand Down
Expand Up @@ -35,7 +35,7 @@ export function initIndexingRoutes({
}) {
router.versioned
.post({
path: `/${INDEX_SOURCE_API_PATH}`,
path: INDEX_SOURCE_API_PATH,
access: 'internal',
options: {
body: {
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/maps/server/routes.ts
Expand Up @@ -23,7 +23,7 @@ export async function initRoutes(coreSetup: CoreSetup, logger: Logger): Promise<

router.versioned
.get({
path: `/${FONTS_API_PATH}/{fontstack}/{range}`,
path: `${FONTS_API_PATH}/{fontstack}/{range}`,
access: 'internal',
})
.addVersion(
Expand Down Expand Up @@ -62,7 +62,7 @@ export async function initRoutes(coreSetup: CoreSetup, logger: Logger): Promise<

router.versioned
.get({
path: `/${INDEX_SETTINGS_API_PATH}`,
path: INDEX_SETTINGS_API_PATH,
access: 'internal',
})
.addVersion(
Expand Down
3 changes: 3 additions & 0 deletions x-pack/test/disable_ems/README.md
@@ -0,0 +1,3 @@
# FTR tests for map.includeElasticMapsService: false

Verify Kibana functionallity when connection to Elastic Maps Service is disabled
32 changes: 32 additions & 0 deletions x-pack/test/disable_ems/config.ts
@@ -0,0 +1,32 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { FtrConfigProviderContext } from '@kbn/test';
import { services, pageObjects } from './ftr_provider_context';

export default async function ({ readConfigFile }: FtrConfigProviderContext) {
const kibanaFunctionalConfig = await readConfigFile(
require.resolve('../functional/config.base.js')
);

return {
...kibanaFunctionalConfig.getAll(),
testFiles: [require.resolve('./tests')],
services,
pageObjects,
junit: {
reportName: `Kibana Maps without access to Elastic Maps Service`,
},
kbnTestServer: {
...kibanaFunctionalConfig.get('kbnTestServer'),
serverArgs: [
...kibanaFunctionalConfig.get('kbnTestServer.serverArgs'),
`--map.includeElasticMapsService=false`,
],
},
};
}
13 changes: 13 additions & 0 deletions x-pack/test/disable_ems/ftr_provider_context.ts
@@ -0,0 +1,13 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { GenericFtrProviderContext } from '@kbn/test';
import { services } from '../functional/services';
import { pageObjects } from '../functional/page_objects';

export type FtrProviderContext = GenericFtrProviderContext<typeof services, typeof pageObjects>;
export { services, pageObjects };
50 changes: 50 additions & 0 deletions x-pack/test/disable_ems/kbn_archive.json
@@ -0,0 +1,50 @@
{
"attributes": {
"fieldAttrs":"{}",
"fieldFormatMap":"{}",
"fields":"[]",
"name":"logstash-*",
"runtimeFieldMap":"{}",
"sourceFilters":"[]",
"timeFieldName":"@timestamp",
"title":"logstash-*",
"typeMeta":"{}"
},
"coreMigrationVersion":"8.8.0",
"created_at":"2023-09-07T14:49:04.891Z",
"id":"fd405dbb-002b-4caa-aae1-0893e5ffb75b",
"managed":false,
"references":[],
"type":"index-pattern",
"typeMigrationVersion":"8.0.0",
"updated_at":"2023-09-07T14:49:04.891Z",
"version":"WzEwLDFd"
}

{
"id": "ee65a3b0-4d8d-11ee-a8ed-97fb2d02a957",
"type": "map",
"namespaces": [
"default"
],
"updated_at": "2023-09-07T14:50:48.043Z",
"created_at": "2023-09-07T14:50:48.043Z",
"version": "WzE1LDFd",
"attributes": {
"title": "mvt documents with labels",
"description": "",
"layerListJSON": "[{\"sourceDescriptor\":{\"geoField\":\"geo.coordinates\",\"scalingType\":\"MVT\",\"id\":\"57798aca-8a4e-4c35-9225-e8d4133ae8a7\",\"type\":\"ES_SEARCH\",\"applyGlobalQuery\":true,\"applyGlobalTime\":true,\"applyForceRefresh\":true,\"filterByMapBounds\":true,\"tooltipProperties\":[],\"sortField\":\"\",\"sortOrder\":\"desc\",\"topHitsGroupByTimeseries\":false,\"topHitsSplitField\":\"\",\"topHitsSize\":1,\"indexPatternRefName\":\"layer_0_source_index_pattern\"},\"id\":\"00c8d672-dc32-42cc-9e11-1c43d3e9a3be\",\"label\":null,\"minZoom\":0,\"maxZoom\":24,\"alpha\":0.75,\"visible\":true,\"style\":{\"type\":\"VECTOR\",\"properties\":{\"icon\":{\"type\":\"STATIC\",\"options\":{\"value\":\"marker\"}},\"fillColor\":{\"type\":\"STATIC\",\"options\":{\"color\":\"#54B399\"}},\"lineColor\":{\"type\":\"STATIC\",\"options\":{\"color\":\"#41937c\"}},\"lineWidth\":{\"type\":\"STATIC\",\"options\":{\"size\":0}},\"iconSize\":{\"type\":\"STATIC\",\"options\":{\"size\":6}},\"iconOrientation\":{\"type\":\"STATIC\",\"options\":{\"orientation\":0}},\"labelText\":{\"type\":\"DYNAMIC\",\"options\":{\"field\":{\"label\":\"bytes\",\"name\":\"bytes\",\"origin\":\"source\",\"type\":\"number\",\"supportsAutoDomain\":true,\"isUnsupported\":false}}},\"labelColor\":{\"type\":\"STATIC\",\"options\":{\"color\":\"#000000\"}},\"labelSize\":{\"type\":\"STATIC\",\"options\":{\"size\":14}},\"labelZoomRange\":{\"options\":{\"useLayerZoomRange\":true,\"minZoom\":0,\"maxZoom\":24}},\"labelBorderColor\":{\"type\":\"STATIC\",\"options\":{\"color\":\"#FFFFFF\"}},\"symbolizeAs\":{\"options\":{\"value\":\"circle\"}},\"labelBorderSize\":{\"options\":{\"size\":\"SMALL\"}},\"labelPosition\":{\"options\":{\"position\":\"CENTER\"}}},\"isTimeAware\":true},\"includeInFitToBounds\":true,\"type\":\"MVT_VECTOR\",\"joins\":[],\"disableTooltips\":false}]",
"mapStateJSON": "{\"adHocDataViews\":[],\"zoom\":2.19,\"center\":{\"lon\":-116.75537,\"lat\":55.05932},\"timeFilters\":{\"from\":\"2015-09-19T21:21:45.309Z\",\"to\":\"2015-09-23T01:33:44.867Z\"},\"refreshConfig\":{\"isPaused\":true,\"interval\":60000},\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filters\":[],\"settings\":{\"autoFitToDataBounds\":false,\"backgroundColor\":\"#ffffff\",\"customIcons\":[],\"disableInteractive\":false,\"disableTooltipControl\":false,\"hideToolbarOverlay\":false,\"hideLayerControl\":false,\"hideViewControl\":false,\"initialLocation\":\"LAST_SAVED_LOCATION\",\"fixedLocation\":{\"lat\":0,\"lon\":0,\"zoom\":2},\"browserLocation\":{\"zoom\":2},\"keydownScrollZoom\":false,\"maxZoom\":24,\"minZoom\":0,\"showScaleControl\":false,\"showSpatialFilters\":true,\"showTimesliderToggleButton\":true,\"spatialFiltersAlpa\":0.3,\"spatialFiltersFillColor\":\"#DA8B45\",\"spatialFiltersLineColor\":\"#DA8B45\"}}",
"uiStateJSON": "{\"isLayerTOCOpen\":true,\"openTOCDetails\":[\"00c8d672-dc32-42cc-9e11-1c43d3e9a3be\"]}"
},
"references": [
{
"name": "layer_0_source_index_pattern",
"type": "index-pattern",
"id": "fd405dbb-002b-4caa-aae1-0893e5ffb75b"
}
],
"managed": false,
"coreMigrationVersion": "8.8.0",
"typeMigrationVersion": "8.4.0"
}
33 changes: 33 additions & 0 deletions x-pack/test/disable_ems/tests/fonts.ts
@@ -0,0 +1,33 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import expect from '@kbn/expect';

export default function ({ getService, getPageObjects }: FtrProviderContext) {
const PageObjects = getPageObjects(['maps']);
const security = getService('security');

describe('Fonts', function () {
before(async () => {
await security.testUser.setRoles(['test_logstash_reader', 'global_maps_all']);
await PageObjects.maps.loadSavedMap('mvt documents with labels');
});

after(async () => {
await security.testUser.restoreDefaults();
});

it('should load map with labels', async () => {
const doesLayerExist = await PageObjects.maps.doesLayerExist('logstash-*');
expect(doesLayerExist).to.equal(true);
const tooltipText = await PageObjects.maps.getLayerTocTooltipMsg('logstash-*');
expect(tooltipText).to.equal(
'logstash-*\nFound 14,000 documents.\nResults narrowed by global time'
);
});
});
}
29 changes: 29 additions & 0 deletions x-pack/test/disable_ems/tests/index.ts
@@ -0,0 +1,29 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import type { FtrProviderContext } from '../ftr_provider_context';

export default function ({ loadTestFile, getService }: FtrProviderContext) {
const kibanaServer = getService('kibanaServer');
const esArchiver = getService('esArchiver');
const browser = getService('browser');

describe('disable Elastic Maps Service', () => {
before(async () => {
await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional');
await kibanaServer.importExport.load('x-pack/test/disable_ems/kbn_archive.json');
await browser.setWindowSize(1600, 1000);
});

after(async () => {
await esArchiver.unload('x-pack/test/functional/es_archives/maps/data');
await kibanaServer.importExport.unload('x-pack/test/disable_ems/kbn_archive.json');
});

loadTestFile(require.resolve('./fonts'));
});
}

0 comments on commit 713bfd2

Please sign in to comment.