Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align native box connector configs #203241

Merged
merged 3 commits into from
Dec 18, 2024

Conversation

seanstory
Copy link
Member

@seanstory seanstory commented Dec 6, 2024

Summary

Raised in this community slack post, the Native Connector definition from Kibana was using some config fields (app_key, app_secret) that didn't align with what the connector itself expects (client_id, client_secret). There were also a number of configurations defined here that are not used by the Box connector (use_document_level_security, include_inherited_users_and_groups, use_text_extraction_service, retry_count, path)

This change moves to align this definition with the source of truth in the connectors codebase: https://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311

T

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Copy link
Contributor

@navarone-feekery navarone-feekery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@seanstory seanstory added release_note:fix backport:prev-major Backport to (8.x, 8.17, 8.16) the previous major branch and other branches in development labels Dec 6, 2024
@seanstory seanstory enabled auto-merge (squash) December 6, 2024 14:58
@seanstory seanstory force-pushed the seanstory/align-native-box-connector-settings branch from 9373b0e to 295bfcb Compare December 18, 2024 20:00
@seanstory seanstory merged commit db56f01 into main Dec 18, 2024
9 checks passed
@seanstory seanstory deleted the seanstory/align-native-box-connector-settings branch December 18, 2024 21:38
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.16, 8.17, 8.x

https://github.com/elastic/kibana/actions/runs/12401783118

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/search-connectors 3954 3912 -42

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
enterpriseSearch 2.6MB 2.6MB -792.0B
serverlessSearch 371.7KB 371.4KB -279.0B
total -1.0KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
searchConnectors 61.5KB 61.2KB -277.0B
Unknown metric groups

API count

id before after diff
@kbn/search-connectors 3954 3912 -42

History

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 18, 2024
## Summary

Raised in [this community slack
post](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),
the Native Connector definition from Kibana was using some config fields
(`app_key`, `app_secret`) that didn't align with what the connector
itself expects (`client_id`, `client_secret`). There were also a number
of configurations defined here that are not used by the Box connector
(`use_document_level_security`, `include_inherited_users_and_groups`,
`use_text_extraction_service`, `retry_count`, `path`)

This change moves to align this definition with the source of truth in
the connectors codebase:
https://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311

T

### Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)

(cherry picked from commit db56f01)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 18, 2024
## Summary

Raised in [this community slack
post](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),
the Native Connector definition from Kibana was using some config fields
(`app_key`, `app_secret`) that didn't align with what the connector
itself expects (`client_id`, `client_secret`). There were also a number
of configurations defined here that are not used by the Box connector
(`use_document_level_security`, `include_inherited_users_and_groups`,
`use_text_extraction_service`, `retry_count`, `path`)

This change moves to align this definition with the source of truth in
the connectors codebase:
https://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311

T

### Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)

(cherry picked from commit db56f01)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.16 Backport failed because of merge conflicts
8.17
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 203241

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Dec 18, 2024
# Backport

This will backport the following commits from `main` to `8.17`:
- [Align native box connector configs
(#203241)](#203241)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Sean
Story","email":"sean.j.story@gmail.com"},"sourceCommit":{"committedDate":"2024-12-18T21:38:45Z","message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","Team:EnterpriseSearch","backport:prev-major"],"title":"Align
native box connector
configs","number":203241,"url":"https://github.com/elastic/kibana/pull/203241","mergeCommit":{"message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203241","number":203241,"mergeCommit":{"message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4"}}]}]
BACKPORT-->

Co-authored-by: Sean Story <sean.j.story@gmail.com>
kibanamachine added a commit that referenced this pull request Dec 18, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [Align native box connector configs
(#203241)](#203241)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Sean
Story","email":"sean.j.story@gmail.com"},"sourceCommit":{"committedDate":"2024-12-18T21:38:45Z","message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","Team:EnterpriseSearch","backport:prev-major"],"title":"Align
native box connector
configs","number":203241,"url":"https://github.com/elastic/kibana/pull/203241","mergeCommit":{"message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203241","number":203241,"mergeCommit":{"message":"Align
native box connector configs (#203241)\n\n## Summary\r\n\r\nRaised in
[this community
slack\r\npost](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),\r\nthe
Native Connector definition from Kibana was using some config
fields\r\n(`app_key`, `app_secret`) that didn't align with what the
connector\r\nitself expects (`client_id`, `client_secret`). There were
also a number\r\nof configurations defined here that are not used by the
Box connector\r\n(`use_document_level_security`,
`include_inherited_users_and_groups`,\r\n`use_text_extraction_service`,
`retry_count`, `path`)\r\n\r\n\r\nThis change moves to align this
definition with the source of truth in\r\nthe connectors
codebase:\r\nhttps://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311\r\n\r\nT\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"db56f019001ae98bc251798f1d8ab1e5511e8bb4"}}]}]
BACKPORT-->

Co-authored-by: Sean Story <sean.j.story@gmail.com>
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Dec 19, 2024
## Summary

Raised in [this community slack
post](https://elasticstack.slack.com/archives/C06U8G8NJBY/p1733445905372799?thread_ts=1733378189.186729&cid=C06U8G8NJBY),
the Native Connector definition from Kibana was using some config fields
(`app_key`, `app_secret`) that didn't align with what the connector
itself expects (`client_id`, `client_secret`). There were also a number
of configurations defined here that are not used by the Box connector
(`use_document_level_security`, `include_inherited_users_and_groups`,
`use_text_extraction_service`, `retry_count`, `path`)


This change moves to align this definition with the source of truth in
the connectors codebase:
https://github.com/elastic/connectors/blob/38c2fdbfe71330d6e95de33a30bf114c29ae4cae/connectors/sources/box.py#L263-L311

T

### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-major Backport to (8.x, 8.17, 8.16) the previous major branch and other branches in development release_note:fix Team:EnterpriseSearch v8.17.1 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants