forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[feat] PIP-335: Add support Oxia as a metadata store (apache#22007)
- Loading branch information
Showing
11 changed files
with
450 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
283 changes: 283 additions & 0 deletions
283
pulsar-metadata/src/main/java/org/apache/pulsar/metadata/impl/oxia/OxiaMetadataStore.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| /* | ||
| * 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.pulsar.metadata.impl.oxia; | ||
|
|
||
| import io.streamnative.oxia.client.OxiaClientBuilder; | ||
| import io.streamnative.oxia.client.api.AsyncOxiaClient; | ||
| import io.streamnative.oxia.client.api.DeleteOption; | ||
| import io.streamnative.oxia.client.api.KeyAlreadyExistsException; | ||
| import io.streamnative.oxia.client.api.Notification; | ||
| import io.streamnative.oxia.client.api.PutOption; | ||
| import io.streamnative.oxia.client.api.PutResult; | ||
| import io.streamnative.oxia.client.api.UnexpectedVersionIdException; | ||
| import io.streamnative.oxia.client.api.Version; | ||
| import java.time.Duration; | ||
| import java.util.EnumSet; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.UUID; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.CompletionStage; | ||
| import lombok.NonNull; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.pulsar.metadata.api.GetResult; | ||
| import org.apache.pulsar.metadata.api.MetadataEventSynchronizer; | ||
| import org.apache.pulsar.metadata.api.MetadataStoreConfig; | ||
| import org.apache.pulsar.metadata.api.MetadataStoreException; | ||
| import org.apache.pulsar.metadata.api.NotificationType; | ||
| import org.apache.pulsar.metadata.api.Stat; | ||
| import org.apache.pulsar.metadata.api.extended.CreateOption; | ||
| import org.apache.pulsar.metadata.impl.AbstractMetadataStore; | ||
|
|
||
| @Slf4j | ||
| public class OxiaMetadataStore extends AbstractMetadataStore { | ||
|
|
||
| private final AsyncOxiaClient client; | ||
|
|
||
| private final String identity; | ||
| private final Optional<MetadataEventSynchronizer> synchronizer; | ||
|
|
||
| OxiaMetadataStore( | ||
| @NonNull String serviceAddress, | ||
| @NonNull String namespace, | ||
| @NonNull MetadataStoreConfig metadataStoreConfig, | ||
| boolean enableSessionWatcher) | ||
| throws Exception { | ||
| super("oxia-metadata"); | ||
|
|
||
| var linger = metadataStoreConfig.getBatchingMaxDelayMillis(); | ||
| if (!metadataStoreConfig.isBatchingEnabled()) { | ||
| linger = 0; | ||
| } | ||
| this.synchronizer = Optional.ofNullable(metadataStoreConfig.getSynchronizer()); | ||
| identity = UUID.randomUUID().toString(); | ||
| client = | ||
| new OxiaClientBuilder(serviceAddress) | ||
| .clientIdentifier(identity) | ||
| .namespace(namespace) | ||
| .sessionTimeout(Duration.ofMillis(metadataStoreConfig.getSessionTimeoutMillis())) | ||
| .batchLinger(Duration.ofMillis(linger)) | ||
| .maxRequestsPerBatch(metadataStoreConfig.getBatchingMaxOperations()) | ||
| .asyncClient() | ||
| .get(); | ||
| client.notifications(this::notificationCallback); | ||
| super.registerSyncListener(Optional.ofNullable(metadataStoreConfig.getSynchronizer())); | ||
| } | ||
|
|
||
| private void notificationCallback(Notification notification) { | ||
| if (notification instanceof Notification.KeyCreated keyCreated) { | ||
| receivedNotification( | ||
| new org.apache.pulsar.metadata.api.Notification( | ||
| NotificationType.Created, keyCreated.key())); | ||
| notifyParentChildrenChanged(keyCreated.key()); | ||
|
|
||
| } else if (notification instanceof Notification.KeyModified keyModified) { | ||
| receivedNotification( | ||
| new org.apache.pulsar.metadata.api.Notification( | ||
| NotificationType.Modified, keyModified.key())); | ||
| } else if (notification instanceof Notification.KeyDeleted keyDeleted) { | ||
| receivedNotification( | ||
| new org.apache.pulsar.metadata.api.Notification( | ||
| NotificationType.Deleted, keyDeleted.key())); | ||
| notifyParentChildrenChanged(keyDeleted.key()); | ||
| } else { | ||
| log.error("Unknown notification type {}", notification); | ||
| } | ||
| } | ||
|
|
||
| Optional<GetResult> convertGetResult( | ||
| String path, io.streamnative.oxia.client.api.GetResult result) { | ||
| if (result == null) { | ||
| return Optional.empty(); | ||
| } | ||
| return Optional.of(result) | ||
| .map( | ||
| oxiaResult -> | ||
| new GetResult(oxiaResult.getValue(), convertStat(path, oxiaResult.getVersion()))); | ||
| } | ||
|
|
||
| Stat convertStat(String path, Version version) { | ||
| return new Stat( | ||
| path, | ||
| version.versionId(), | ||
| version.createdTimestamp(), | ||
| version.modifiedTimestamp(), | ||
| version.sessionId().isPresent(), | ||
| version.clientIdentifier().stream().anyMatch(identity::equals), | ||
| version.modificationsCount() == 0); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<List<String>> getChildrenFromStore(String path) { | ||
| var pathWithSlash = path + "/"; | ||
|
|
||
| return client | ||
| .list(pathWithSlash, pathWithSlash + "/") | ||
| .thenApply( | ||
| children -> | ||
| children.stream().map(child -> child.substring(pathWithSlash.length())).toList()) | ||
| .exceptionallyCompose(this::convertException); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<Boolean> existsFromStore(String path) { | ||
| return client.get(path).thenApply(Objects::nonNull) | ||
| .exceptionallyCompose(this::convertException); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<Optional<GetResult>> storeGet(String path) { | ||
| return client.get(path).thenApply(res -> convertGetResult(path, res)) | ||
| .exceptionallyCompose(this::convertException); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<Void> storeDelete(String path, Optional<Long> expectedVersion) { | ||
| return getChildrenFromStore(path) | ||
| .thenCompose( | ||
| children -> { | ||
| if (children.size() > 0) { | ||
| return CompletableFuture.failedFuture( | ||
| new MetadataStoreException("Key '" + path + "' has children")); | ||
| } else { | ||
| var delOption = | ||
| expectedVersion | ||
| .map(DeleteOption::ifVersionIdEquals) | ||
| .orElse(DeleteOption.Unconditionally); | ||
| CompletableFuture<Boolean> result = client.delete(path, delOption); | ||
| return result | ||
| .thenCompose( | ||
| exists -> { | ||
| if (!exists) { | ||
| return CompletableFuture.failedFuture( | ||
| new MetadataStoreException.NotFoundException( | ||
| "Key '" + path + "' does not exist")); | ||
| } | ||
| return CompletableFuture.completedFuture((Void) null); | ||
| }) | ||
| .exceptionallyCompose(this::convertException); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<Stat> storePut( | ||
| String path, byte[] data, Optional<Long> optExpectedVersion, EnumSet<CreateOption> options) { | ||
| CompletableFuture<Void> parentsCreated = createParents(path); | ||
| return parentsCreated.thenCompose( | ||
| __ -> { | ||
| var expectedVersion = optExpectedVersion; | ||
| if (expectedVersion.isPresent() | ||
| && expectedVersion.get() != -1L | ||
| && options.contains(CreateOption.Sequential)) { | ||
| return CompletableFuture.failedFuture( | ||
| new MetadataStoreException( | ||
| "Can't have expectedVersion and Sequential at the same time")); | ||
| } | ||
| CompletableFuture<String> actualPath; | ||
| if (options.contains(CreateOption.Sequential)) { | ||
| var parent = parent(path); | ||
| var parentPath = parent == null ? "/" : parent; | ||
|
|
||
| actualPath = | ||
| client | ||
| .put(parentPath, new byte[] {}) | ||
| .thenApply( | ||
| r -> String.format("%s%010d", path, r.version().modificationsCount())); | ||
| expectedVersion = Optional.of(-1L); | ||
| } else { | ||
| actualPath = CompletableFuture.completedFuture(path); | ||
| } | ||
| var versionCondition = | ||
| expectedVersion | ||
| .map( | ||
| ver -> { | ||
| if (ver == -1) { | ||
| return PutOption.IfRecordDoesNotExist; | ||
| } | ||
| return PutOption.ifVersionIdEquals(ver); | ||
| }) | ||
| .orElse(PutOption.Unconditionally); | ||
| var putOptions = | ||
| options.contains(CreateOption.Ephemeral) | ||
| ? new PutOption[] {PutOption.AsEphemeralRecord, versionCondition} | ||
| : new PutOption[] {versionCondition}; | ||
| return actualPath | ||
| .thenCompose( | ||
| aPath -> | ||
| client | ||
| .put(aPath, data, putOptions) | ||
| .thenApply(res -> new PathWithPutResult(aPath, res))) | ||
| .thenApply(res -> convertStat(res.path(), res.result().version())) | ||
| .exceptionallyCompose(this::convertException); | ||
| }); | ||
| } | ||
|
|
||
| private <T> CompletionStage<T> convertException(Throwable ex) { | ||
| if (ex.getCause() instanceof UnexpectedVersionIdException | ||
| || ex.getCause() instanceof KeyAlreadyExistsException) { | ||
| return CompletableFuture.failedFuture( | ||
| new MetadataStoreException.BadVersionException(ex.getCause())); | ||
| } else if (ex.getCause() instanceof IllegalStateException) { | ||
| return CompletableFuture.failedFuture(new MetadataStoreException.AlreadyClosedException(ex.getCause())); | ||
| } else { | ||
| return CompletableFuture.failedFuture(ex.getCause()); | ||
| } | ||
| } | ||
|
|
||
| private CompletableFuture<Void> createParents(String path) { | ||
| var parent = parent(path); | ||
| if (parent == null || parent.isEmpty()) { | ||
| return CompletableFuture.completedFuture(null); | ||
| } | ||
| return exists(parent) | ||
| .thenCompose( | ||
| exists -> { | ||
| if (exists) { | ||
| return CompletableFuture.completedFuture(null); | ||
| } else { | ||
| return client | ||
| .put(parent, new byte[] {}, PutOption.IfRecordDoesNotExist) | ||
| .thenCompose(__ -> createParents(parent)); | ||
| } | ||
| }) | ||
| .exceptionallyCompose( | ||
| ex -> { | ||
| if (ex.getCause() instanceof KeyAlreadyExistsException) { | ||
| return CompletableFuture.completedFuture(null); | ||
| } | ||
| return CompletableFuture.failedFuture(ex.getCause()); | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws Exception { | ||
| if (client != null) { | ||
| client.close(); | ||
| } | ||
| super.close(); | ||
| } | ||
|
|
||
| public Optional<MetadataEventSynchronizer> getMetadataEventSynchronizer() { | ||
| return synchronizer; | ||
| } | ||
|
|
||
| private record PathWithPutResult(String path, PutResult result) {} | ||
| } |
Oops, something went wrong.