kibana/test/server_integration/http/platform/cache.ts
Christiane (Tina) Heiligers 3a68f8b3ae
[http] api_integration tests handle internal route restriction (#192407)
fix https://github.com/elastic/kibana/issues/192052
## Summary

Internal APIs will be
[restricted](https://github.com/elastic/kibana/issues/163654) from
public access as of 9.0.0. In non-serverless environments, this breaking
change will result in a 400 error if an external request is made to an
internal Kibana API (route `access` option as `"internal"` or
`"public"`).
This PR allows API owners of non-xpack plugins to run their `ftr` API
integration tests against the restriction and adds examples of how to
handle it.

### Checklist
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios


Note to reviewers: The header needed to allow access to internal apis
shouldn't change your test output, with or without the restriction
enabled.

### How to test the changes work:
#### Non x-pack:
1. Set `server.restrictInternalApis: true` in `test/common/config.js`
2. Ensure your tests pass

#### x-pack:
1. Set `server.restrictInternalApis: true` in
`x-pack/test/api_integration/apis/security/config.ts`
2. Ensure the spaces tests pass

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-09-12 09:23:10 +02:00

40 lines
1.5 KiB
TypeScript

/*
* 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/
import { X_ELASTIC_INTERNAL_ORIGIN_REQUEST } from '@kbn/core-http-common';
import { FtrProviderContext } from '../../services/types';
export default function ({ getService }: FtrProviderContext) {
const supertest = getService('supertest');
describe('kibana server cache-control', () => {
it('properly marks responses as private, with directives to disable caching', async () => {
await supertest
.get('/api/status')
.expect('Cache-Control', 'private, no-cache, no-store, must-revalidate')
.expect(200);
});
it('allows translation bundles to be cached', async () => {
await supertest
.get('/translations/en.json')
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
.expect('Cache-Control', 'public, max-age=31536000, immutable')
.expect(200);
});
it('allows the bootstrap bundles to be cached', async () => {
await supertest
.get('/bootstrap.js')
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
.expect('Cache-Control', 'must-revalidate')
.expect(200);
});
});
}