kafka icon indicating copy to clipboard operation
kafka copied to clipboard

KAFKA-15307: Update/errors for deprecated config

Open Cerchie opened this issue 2 years ago • 4 comments

This PR is a follow-up on https://github.com/apache/kafka/pull/14360. It ensures that warnings are shown if the dep'd configs outlined in that PR are used (note topology.optimization's variable has changed rather than the configuration itself; this is already addressed in the code via KIP-626).

Tests have been added to StreamsConfigTest.java to ensure the proper warnings show up.

Committer Checklist (excluded from commit message)

  • [ ] Verify design and implementation
  • [ ] Verify test coverage and CI build status
  • [ ] Verify documentation (including upgrade notes)

Cerchie avatar Sep 25 '23 19:09 Cerchie

tagging @mjsax for review

Cerchie avatar Sep 25 '23 19:09 Cerchie

This PR is being marked as stale since it has not had any activity in 90 days. If you would like to keep this PR alive, please ask a committer for review. If the PR has merge conflicts, please update it with the latest from trunk (or appropriate release branch)

If this PR is no longer valid or desired, please feel free to close it. If no activity occurs in the next 30 days, it will be automatically closed.

github-actions[bot] avatar Dec 25 '23 03:12 github-actions[bot]

Thanks for the PR. Overall LGTM.

I am just wondering if we should also update the JavaDocs for all deprecated configs? For example:

    /** {@code default.windowed.key.serde.inner} */
    @SuppressWarnings("WeakerAccess")
    @Deprecated
    public static final String DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS = "default.windowed.key.serde.inner";

We could change it to:

    /**
     * {@code default.windowed.key.serde.inner}
     * @deprecation Since X.y.0. Use {@link #WINDOWED_INNER_CLASS_SERDE} instead.
     */
    @SuppressWarnings("WeakerAccess")
    @Deprecated
    public static final String DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS = "default.windowed.key.serde.inner";

Thought? We could do this for all deprecated configs?

mjsax avatar Jan 17 '24 23:01 mjsax

Thanks for the PR. Overall LGTM.

I am just wondering if we should also update the JavaDocs for all deprecated configs? For example:

    /** {@code default.windowed.key.serde.inner} */
    @SuppressWarnings("WeakerAccess")
    @Deprecated
    public static final String DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS = "default.windowed.key.serde.inner";

We could change it to:

    /**
     * {@code default.windowed.key.serde.inner}
     * @deprecation Since X.y.0. Use {@link #WINDOWED_INNER_CLASS_SERDE} instead.
     */
    @SuppressWarnings("WeakerAccess")
    @Deprecated
    public static final String DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS = "default.windowed.key.serde.inner";

Thought? We could do this for all deprecated configs?

went through and addressed all the missing ones I found

Cerchie avatar Feb 22 '24 15:02 Cerchie

tagging @mjsax in for re-review

Cerchie avatar Apr 30 '24 20:04 Cerchie

@Cerchie -- this PR would need a rebase as #14360 was merged. Also, seems we introduced a few JavaDoc issues (cf https://github.com/apache/kafka/pull/14360#issuecomment-2108456039) that we should fix in this PR.

mjsax avatar May 16 '24 06:05 mjsax

This PR is being marked as stale since it has not had any activity in 90 days. If you would like to keep this PR alive, please ask a committer for review. If the PR has merge conflicts, please update it with the latest from trunk (or appropriate release branch)

If this PR is no longer valid or desired, please feel free to close it. If no activity occurs in the next 30 days, it will be automatically closed.

github-actions[bot] avatar Aug 17 '24 03:08 github-actions[bot]