io.delta.flink.sink.internal.committables.DeltaCommittableSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delta-flink Show documentation
delta-flink
There is a newer version: 3.2.1
/*
 * 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 io.delta.flink.sink.internal.committables;

import java.io.IOException;

import org.apache.flink.core.io.SimpleVersionedSerializer;
import org.apache.flink.core.memory.DataInputDeserializer;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.DataOutputSerializer;
import org.apache.flink.core.memory.DataOutputView;
import org.apache.flink.streaming.api.functions.sink.filesystem.DeltaPendingFile;
import org.apache.flink.streaming.api.functions.sink.filesystem.InProgressFileWriter;
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Versioned serializer for {@link DeltaCommittable}.
 */
public class DeltaCommittableSerializer
    implements SimpleVersionedSerializer {

    /**
     * Magic number value for sanity check whether the provided bytes where not corrupted
     */
    private static final int MAGIC_NUMBER = 0x1e765c80;

    private final SimpleVersionedSerializer
        pendingFileSerializer;

    public DeltaCommittableSerializer(
        SimpleVersionedSerializer
            pendingFileSerializer) {
        this.pendingFileSerializer = checkNotNull(pendingFileSerializer);
    }

    @Override
    public int getVersion() {
        return 1;
    }

    @Override
    public byte[] serialize(DeltaCommittable committable) throws IOException {
        DataOutputSerializer out = new DataOutputSerializer(256);
        out.writeInt(MAGIC_NUMBER);
        serializeV1(committable, out);
        return out.getCopyOfBuffer();
    }

    @Override
    public DeltaCommittable deserialize(int version, byte[] serialized) throws IOException {
        DataInputDeserializer in = new DataInputDeserializer(serialized);

        if (version == 1) {
            validateMagicNumber(in);
            return deserializeV1(in);
        }
        throw new IOException("Unrecognized version or corrupt state: " + version);
    }

    void serializeV1(DeltaCommittable committable, DataOutputView dataOutputView)
        throws IOException {
        dataOutputView.writeUTF(committable.getAppId());
        dataOutputView.writeLong(committable.getCheckpointId());
        DeltaPendingFile.serialize(
            committable.getDeltaPendingFile(), dataOutputView, pendingFileSerializer);
    }

    DeltaCommittable deserializeV1(DataInputView dataInputView) throws IOException {
        String appId = dataInputView.readUTF();
        long checkpointId = dataInputView.readLong();
        DeltaPendingFile deltaPendingFile =
            DeltaPendingFile.deserialize(dataInputView, pendingFileSerializer);
        return new DeltaCommittable(deltaPendingFile, appId, checkpointId);
    }

    private static void validateMagicNumber(DataInputView in) throws IOException {
        int magicNumber = in.readInt();
        if (magicNumber != MAGIC_NUMBER) {
            throw new IOException(
                String.format("Corrupt data: Unexpected magic number %08X", magicNumber));
        }
    }
}