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

[FLINK-18429][DataStream API] Make CheckpointListener.notifyCheckpointAborted(checkpointId) a default method. #12767

Closed
wants to merge 3 commits into from

Conversation

StephanEwen
Copy link
Contributor

Purpose / Brief change log

This PR prevents breaking existing user programs by making the newly added method CheckpointListener.notifyCheckpointAborted(checkpointId) a default method.

In addition, this PR upgrades the stability of CheckpointListener and CheckpointedFunction to @Public to reflect that we should not break them and make sure this is caught by our tooling.

Original Confusion about (Not) Having a Default Method

(Copying the description from the JIRA issue here)

There was confusion about this originally, going back to a comment by myself suggesting this should not be a default method, incorrectly thinking of it as an internal interface: #8693 (comment)

See clarification email on the mailing list:

About the "notifyCheckpointAborted()":

When I wrote that comment, I was (apparently wrongly) assuming we were talking about
an internal interface here, because the "abort" signal was originally only intended to cancel
the async part of state backend checkpoints.

I just realized that this is exposed to users - and I am actually with Thomas on this one. 
he "CheckpointListener" is a very public interface that many users implement. The fact that
it is tagged "@PublicEvolving" is somehow not aligned with reality. So adding the method
here will in reality break lots and lots of user programs.

I think also in practice it is much less relevant for user applications to react to aborted checkpoints.
Since the notifications there can not be relied upon (if there is a task failure concurrently) users
 always have to follow the "newer checkpoint subsumes older checkpoint" contract, so the abort
method is probably rarely relevant.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): yes
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit cf0c7ec (Wed Jun 24 16:20:19 UTC 2020)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

Copy link
Contributor

@pnowojski pnowojski left a comment

Choose a reason for hiding this comment

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

Thanks for providing a fix and resolving the confusion :)

@flinkbot
Copy link
Collaborator

flinkbot commented Jun 24, 2020

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

StephanEwen added a commit to StephanEwen/flink that referenced this pull request Jun 24, 2020
@asfgit asfgit closed this in 4776813 Jun 24, 2020
fsk119 pushed a commit to fsk119/flink that referenced this pull request Jul 6, 2020
…tAborted(checkpointId) a default method.

This avoid breaking many user programs that use this interface.

This closes apache#12767
fsk119 pushed a commit to fsk119/flink that referenced this pull request Jul 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants