Pass request headers when making application config calls

[tianleh]

Description

Application config plugin allows external plugin to register a different storage other than the default OpenSearch. The external plugin may need some additional information about the request headers when handling the requests.

Issues Resolved

Screenshot

Testing the changes

Update the csp rules.

call

curl 'http://localhost:5601/api/appconfig/csp.rules' -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'osd-xsrf: osd-fetch' -H 'Sec-Fetch-Dest: empty' --data-raw '{"newValue":"frame-ancestors https://example-site.org"}'

response

{"newValue":"frame-ancestors https://example-site.org"}%

Confirm on UI that the new value is used.

Check API calls to all configs

curl 'http://localhost:5601/api/appconfig'

response

{"value":{"csp.rules":"frame-ancestors https://example-site.org"}}%

Check API to get only csp rules.

curl 'http://localhost:5601/api/appconfig/csp.rules'

response

{"value":"frame-ancestors https://example-site.org"}%

Delete

curl 'http://localhost:5601/api/appconfig/csp.rules' -X DELETE -H 'osd-xsrf: osd-fetch' -H 'Sec-Fetch-Dest: empty'

Response

{"deletedEntity":"csp.rules"}%

Get all again

curl 'http://localhost:5601/api/appconfig'

response

{"value":{}}%

verify that default csp with frame ancestors is used.

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 67.24%. Comparing base (a9e874f) to head (b607403).

Files	Patch %	Lines
.../plugins/application_config/server/routes/index.ts	88.88%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6164      +/-   ##
==========================================
+ Coverage   67.21%   67.24%   +0.02%     
==========================================
  Files        3344     3344              
  Lines       64792    64796       +4     
  Branches    10427    10427              
==========================================
+ Hits        43552    43572      +20     
+ Misses      18697    18683      -14     
+ Partials     2543     2541       -2     

Flag	Coverage Δ
Linux_1	31.64% <ø> (?)
Linux_2	55.45% <ø> (ø)
Linux_3	44.69% <90.00%> (+<0.01%)	⬆️
Linux_4	35.06% <ø> (ø)
Windows_1	31.67% <ø> (ø)
Windows_2	55.41% <ø> (?)
Windows_3	44.70% <90.00%> (+<0.01%)	⬆️
Windows_4	35.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tianleh]

The failed test https://github.com/opensearch-project/OpenSearch-Dashboards/actions/runs/8331507596/job/22798565980?pr=6164 is not related to my changes.

[kavilla]

Cypress test likely to fail unrelated

[bandinib-amzn]

Re-running failed CI