[Release 3.0] Planned Breaking Changes for 3.0 in OpenSearch-Dashboards

[virajsanghvi]

This is a meta issue which lists down all breaking changes in OpenSearch-Dashboards 3.0. This will continue to be updated as we learn more.

Major updates

• [Proposed] New Breaking Change Definition for OpenSearch-Dashboards
• [Proposed] Defaulting to "New Home Page" and Discover experience
• [Proposed] Defaulting to workspaces enabled
• [Impact][OpenSearch Breaking Change] Existing index patterns that use removed painless scripting OpenSerch APIs will fail
  • [Remove] Remove deprecated methods from JodaCompatibleZonedDateTime which are called by scripts OpenSearch#3346
  • Painless APIs removed:

Breaking behavior in 3.0+

• Bump opensearch client and opensearch-next will be removed: (#3469)

Removed code in 3.0+

Code from the following deprecations will be removed:

• Deprecating CssDistFilename exports in favor of themeCssDistFilenames in @osd/ui-shared-deps (#7625)
• Remove data enhancements config and readonly flag. Removes dead url link, (#7291)
• Rename withLongNumerals to withLongNumeralsSupport in HttpFetchOptions #5592
• Remove timeline application (#3971)
• [CVE-2020-36632] [REQUIRES PLUGIN VALIDATION] Bump flat from 4.1.1 to 5.0.2 (#3419). To the best of our knowledge, this is a non-breaking change, but if your plugin relies on mocha tests, validate that they still work correctly (and plan to migrate them to jest in preparation for mocha deprecation.
• Remove non-inclusive language
  • server.xsrf.whitelist --> server.xsrf.allowlist
  • server.compression.referrerWhitelist --> server.compression.referrerAllowlist
  • opensearch.requestHeadersWhitelist --> opensearch.requestHeadersAllowlist
  • opensearch.requestHeadersWhitelistConfigured --> opensearch.requestHeadersAllowlistConfigured

Misc

• [BUG] EOL of Node.js version 18.x used in Opensearch-dashboards #8463
  • Switch to NodeJS LTS 20 "Iron" #9171

[kavilla]

Will gather links but brain dumping now:

• 3.0 we bump opensearch js client to a breaking change version. For 2.x we alias that package as opensearch-next, plugins that use the dependency opensearch js client could have issues if they do not update properly

[virajsanghvi]

Will gather links but brain dumping now:

• 3.0 we bump opensearch js client to a breaking change version. For 2.x we alias that package as opensearch-next, plugins that use the dependency opensearch js client could have issues if they do not update properly

@kavilla Is this planned work for 3.0? If so, can we add to list of breaking changes above so plugins are aware.

[zhongnansu]

@kavilla fyi, opensearch js client 3.x is also officially released, could this be a chance we skip 2.x, bump to 3.x to bring the latest client experience to community? https://github.com/opensearch-project/opensearch-js/releases/tag/3.0.0

https://github.com/opensearch-project/opensearch-js/blob/main/UPGRADING.md

[kavilla]

@virajsanghvi, this work has been done and for 2.x sake we aliased the next version to be a breaking change version of the dependency. i have updated the issue.

@zhongnansu we could but currently unplanned. i see a draft open here #9139

It might be too risky to bump up to 3.x as of right now. Worth tracking as an issue for 4.0 and perhaps introducing the alias of opensearch-next point to the 3.0 client

[kavilla]

This one will be little bit hard @virajsanghvi:

#1600

Example, users can create an index pattern with a painless script that is removed in 3.0. Since the index pattern is a saved object and the script is user entered replacing the script with migrations would be difficult. but will fail for the user. For example:

#1607, our tests were failing. Something that got de-prioritized in communicating to users that the script they are using is deprecated and removed in OpenSearch 3.0.0 and wont work. But it might appear as a failure on OSD side.

[kavilla]

@virajsanghvi is there a plan to make OpenSearch Dashboards 4.0.0 compatible with legacy version 7.10.2?

[kavilla]

Also is this still planned: #4713 ?

[kavilla]

We also have a number of deprecated configs that we marked deprecated for a while.

OpenSearch has removed in 3.0 the whitelist I think we should too but we still allow it (with a warning on start up to the host) . For example, #1467

[peterzhuamazon]

Hi @virajsanghvi @kavilla ,

We also might need to focus on this:

• Switch to NodeJS LTS 20 "Iron" #9171

As node18 will be eol very soon.

Thanks.