You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "mayuehappy (via GitHub)" <gi...@apache.org> on 2025/03/27 13:11:25 UTC
[PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
mayuehappy opened a new pull request, #26364:
URL: https://github.com/apache/flink/pull/26364
…MetaInfo V2
<!--
*Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message (including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
*(For example: This pull request makes task deployment go through the blob server, rather than through RPC. That way we avoid re-transferring them on each deployment (during recovery).)*
## Brief change log
*(for example:)*
- *The TaskInfo is stored in the blob store on job creation time as a persistent artifact*
- *Deployments RPC transmits only the blob storage reference*
- *TaskManagers retrieve the TaskInfo from the blob cache*
## Verifying this change
Please make sure both new and modified tests in this PR follow [the conventions for tests defined in our code quality guide](https://flink.apache.org/how-to-contribute/code-style-and-quality-common/#7-testing).
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (100MB)*
- *Extended integration test for recovery after master (JobManager) failure*
- *Added test that validates that TaskInfo is transferred only once across recoveries*
- *Manually verified the change by running a 4 node cluster with 2 JobManagers and 4 TaskManagers, a stateful streaming program, and killing one JobManager and two TaskManagers during the execution, verifying that recovery happens correctly.*
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes / no)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / no)
- The serializers: (yes / no / don't know)
- The runtime per-record code paths (performance sensitive): (yes / no / don't know)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
- The S3 file system connector: (yes / no / don't know)
## Documentation
- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #26364:
URL: https://github.com/apache/flink/pull/26364#issuecomment-2758084664
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "07e80436bb06d3e45add10b9ff2698e438e7ebce",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "07e80436bb06d3e45add10b9ff2698e438e7ebce",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 07e80436bb06d3e45add10b9ff2698e438e7ebce UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2016992120
##########
flink-runtime/src/test/java/org/apache/flink/runtime/state/v2/RegisteredKeyValueStateBackendMetaInfoV2Test.java:
##########
@@ -0,0 +1,199 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.state.v2;
+
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.DoubleSerializer;
+import org.apache.flink.api.common.typeutils.base.IntSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.api.common.typeutils.base.StringSerializer;
+import org.apache.flink.core.memory.ByteArrayInputStreamWithPos;
+import org.apache.flink.core.memory.ByteArrayOutputStreamWithPos;
+import org.apache.flink.core.memory.DataInputViewStreamWrapper;
+import org.apache.flink.core.memory.DataOutputViewStreamWrapper;
+import org.apache.flink.runtime.state.KeyedBackendSerializationProxy;
+import org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class RegisteredKeyValueStateBackendMetaInfoV2Test {
+ @Test
+ void testRegisteredKeyValueStateBackendMetaInfoV2SerializationRoundtrip() throws Exception {
+
+ TypeSerializer<?> keySerializer = IntSerializer.INSTANCE;
+ TypeSerializer<?> namespaceSerializer = LongSerializer.INSTANCE;
+ TypeSerializer<?> stateSerializer = DoubleSerializer.INSTANCE;
+ TypeSerializer<?> userKeySerializer = StringSerializer.INSTANCE;
Review Comment:
I could be misunderstanding. I read the Jira as "If MapState is used and the schema of userKey has changes, StateBackend cannot determine if it is compatible. So we need to add the information of userKeySeriailzer in org.apache.link.runtime.state.v2.RegisteredKeyValueStateBackendMetaInfo", but in the tests I only see userKeySerializer set to `StringSerializer.INSTANCE`. Can we have a test where the userKeySerializer changes from one type to another. I assume non-Strings are allowed as map key types - which is why we cannot assume it is a String serializer.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "mayuehappy (via GitHub)" <gi...@apache.org>.
mayuehappy commented on PR #26364:
URL: https://github.com/apache/flink/pull/26364#issuecomment-2758002143
@Zakelly hi , can you help take a review of this PR ？
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "Zakelly (via GitHub)" <gi...@apache.org>.
Zakelly merged PR #26364:
URL: https://github.com/apache/flink/pull/26364
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "mayuehappy (via GitHub)" <gi...@apache.org>.
mayuehappy commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2018233057
##########
flink-runtime/src/test/java/org/apache/flink/runtime/state/v2/RegisteredKeyValueStateBackendMetaInfoV2Test.java:
##########
@@ -0,0 +1,199 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.state.v2;
+
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.DoubleSerializer;
+import org.apache.flink.api.common.typeutils.base.IntSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.api.common.typeutils.base.StringSerializer;
+import org.apache.flink.core.memory.ByteArrayInputStreamWithPos;
+import org.apache.flink.core.memory.ByteArrayOutputStreamWithPos;
+import org.apache.flink.core.memory.DataInputViewStreamWrapper;
+import org.apache.flink.core.memory.DataOutputViewStreamWrapper;
+import org.apache.flink.runtime.state.KeyedBackendSerializationProxy;
+import org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class RegisteredKeyValueStateBackendMetaInfoV2Test {
+ @Test
+ void testRegisteredKeyValueStateBackendMetaInfoV2SerializationRoundtrip() throws Exception {
+
+ TypeSerializer<?> keySerializer = IntSerializer.INSTANCE;
+ TypeSerializer<?> namespaceSerializer = LongSerializer.INSTANCE;
+ TypeSerializer<?> stateSerializer = DoubleSerializer.INSTANCE;
+ TypeSerializer<?> userKeySerializer = StringSerializer.INSTANCE;
Review Comment:
@davidradl thanks for your suggestion , I've added a new Test for MapState userKeySerializer changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "Zakelly (via GitHub)" <gi...@apache.org>.
Zakelly commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2022324270
##########
flink-state-backends/flink-statebackend-forst/src/main/java/org/apache/flink/state/forst/ForStKeyedStateBackend.java:
##########
@@ -405,10 +424,11 @@ public <N, S extends InternalKeyedState, SV> S createStateInternal(
return Tuple2.of(newStateInfo.columnFamilyHandle, newMetaInfo);
}
- private <N, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStateMetaInfo(
+ private <N, UK, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStateMetaInfo(
Tuple2<ColumnFamilyHandle, RegisteredKeyValueStateBackendMetaInfo<N, SV>> oldStateInfo,
StateDescriptor<SV> stateDesc,
TypeSerializer<SV> stateSerializer,
+ TypeSerializer userKeySerializer,
Review Comment:
```suggestion
TypeSerializer<UK> userKeySerializer,
```
And add `UK` as type parameter of this method
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "mayuehappy (via GitHub)" <gi...@apache.org>.
mayuehappy commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2020507754
##########
flink-state-backends/flink-statebackend-forst/src/main/java/org/apache/flink/state/forst/ForStKeyedStateBackend.java:
##########
@@ -438,6 +449,18 @@ private <N, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStat
+ ").");
}
+ if (userKeySerializer != null) {
+ TypeSerializer<UK> previousUserValueStateSerializer =
+ restoredKvStateMetaInfo.getUserKeySerializer();
+ TypeSerializerSchemaCompatibility<UK> userKeySerializerCompatibility =
+ restoredKvStateMetaInfo.updateUserKeySerializer(userKeySerializer);
+ if (!previousUserValueStateSerializer.equals(userKeySerializer)
Review Comment:
@Zakelly Thanks for your suggestion , I‘ve updated the PR ， PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "Zakelly (via GitHub)" <gi...@apache.org>.
Zakelly commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2018332233
##########
flink-state-backends/flink-statebackend-forst/src/main/java/org/apache/flink/state/forst/ForStKeyedStateBackend.java:
##########
@@ -438,6 +449,18 @@ private <N, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStat
+ ").");
}
+ if (userKeySerializer != null) {
+ TypeSerializer<UK> previousUserValueStateSerializer =
+ restoredKvStateMetaInfo.getUserKeySerializer();
+ TypeSerializerSchemaCompatibility<UK> userKeySerializerCompatibility =
+ restoredKvStateMetaInfo.updateUserKeySerializer(userKeySerializer);
+ if (!previousUserValueStateSerializer.equals(userKeySerializer)
Review Comment:
`previousUserValueStateSerializer` could be null.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "Zakelly (via GitHub)" <gi...@apache.org>.
Zakelly commented on code in PR #26364:
URL: https://github.com/apache/flink/pull/26364#discussion_r2022324270
##########
flink-state-backends/flink-statebackend-forst/src/main/java/org/apache/flink/state/forst/ForStKeyedStateBackend.java:
##########
@@ -405,10 +424,11 @@ public <N, S extends InternalKeyedState, SV> S createStateInternal(
return Tuple2.of(newStateInfo.columnFamilyHandle, newMetaInfo);
}
- private <N, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStateMetaInfo(
+ private <N, UK, SV> RegisteredKeyValueStateBackendMetaInfo<N, SV> updateRestoredStateMetaInfo(
Tuple2<ColumnFamilyHandle, RegisteredKeyValueStateBackendMetaInfo<N, SV>> oldStateInfo,
StateDescriptor<SV> stateDesc,
TypeSerializer<SV> stateSerializer,
+ TypeSerializer userKeySerializer,
Review Comment:
```suggestion
TypeSerializer<UK> userKeySerializer,
```
##########
flink-state-backends/flink-statebackend-forst/src/main/java/org/apache/flink/state/forst/ForStKeyedStateBackend.java:
##########
@@ -372,20 +379,32 @@ public <N, S extends InternalKeyedState, SV> S createStateInternal(
Tuple2.of(oldStateInfo.columnFamilyHandle, castedMetaInfo),
stateDesc,
stateSerializer,
+ userKeySerializer,
namespaceSerializer);
newStateInfo =
new ForStOperationUtils.ForStKvStateInfo(
oldStateInfo.columnFamilyHandle, newMetaInfo);
kvStateInformation.put(stateDesc.getStateId(), newStateInfo);
} else {
- newMetaInfo =
- new RegisteredKeyValueStateBackendMetaInfo<>(
- stateDesc.getStateId(),
- stateDesc.getType(),
- namespaceSerializer,
- stateSerializer,
- StateSnapshotTransformer.StateSnapshotTransformFactory.noTransform());
+ if (stateDesc.getType().equals(StateDescriptor.Type.MAP)) {
+ newMetaInfo =
+ new RegisteredKeyAndUserKeyValueStateBackendMetaInfo<>(
+ stateDesc.getStateId(),
+ stateDesc.getType(),
+ namespaceSerializer,
+ stateSerializer,
+ userKeySerializer);
+ } else {
+ newMetaInfo =
+ new RegisteredKeyValueStateBackendMetaInfo<>(
+ stateDesc.getStateId(),
+ stateDesc.getType(),
+ namespaceSerializer,
+ stateSerializer,
+ StateSnapshotTransformer.StateSnapshotTransformFactory
+ .noTransform());
+ }
Review Comment:
Could we align these two constructor? Either both provide `StateSnapshotTransformer` or both not
##########
flink-runtime/src/main/java/org/apache/flink/runtime/state/v2/RegisteredKeyAndUserKeyValueStateBackendMetaInfo.java:
##########
@@ -0,0 +1,237 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.runtime.state.v2;
+
+import org.apache.flink.api.common.state.v2.StateDescriptor;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.TypeSerializerSchemaCompatibility;
+import org.apache.flink.api.common.typeutils.TypeSerializerSnapshot;
+import org.apache.flink.runtime.state.StateSerializerProvider;
+import org.apache.flink.runtime.state.StateSnapshotTransformer.StateSnapshotTransformFactory;
+import org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot;
+import org.apache.flink.util.CollectionUtil;
+import org.apache.flink.util.Preconditions;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Compound meta information for a registered state in a keyed state backend. This combines all
+ * serializers and the state name.
+ *
+ * @param <S> Type of state value
+ */
+public class RegisteredKeyAndUserKeyValueStateBackendMetaInfo<N, UK, S>
+ extends RegisteredKeyValueStateBackendMetaInfo<N, S> {
+
+ @Nullable private StateSerializerProvider<UK> userKeySerializerProvider;
Review Comment:
Add some words to explain the `Nullable`?
```suggestion
// We keep it @Nullable since in the very first version we did not store this serializer here.
@Nullable private StateSerializerProvider<UK> userKeySerializerProvider;
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-37569] Add userKeySerializer in RegisteredKeyValueStateBackend V2 [flink]
Posted by "mayuehappy (via GitHub)" <gi...@apache.org>.
mayuehappy commented on PR #26364:
URL: https://github.com/apache/flink/pull/26364#issuecomment-2769146659
@Zakelly Thanks for your suggestion , I've updated the PR . PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org