qqu0127 commented on code in PR #2457: URL: https://github.com/apache/helix/pull/2457#discussion_r1175739068
########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClient.java: ########## @@ -0,0 +1,108 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * 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. + */ + + +import org.apache.helix.metaclient.api.MetaClientInterface; +import org.apache.helix.metaclient.api.Op; +import org.apache.helix.metaclient.datamodel.DataRecord; +import org.apache.helix.metaclient.exception.MetaClientException; +import org.apache.helix.metaclient.factories.MetaClientConfig; +import org.apache.helix.metaclient.factories.MetaClientFactory; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientConfig; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientFactory; +import org.apache.helix.zookeeper.datamodel.serializer.ZNRecordSerializer; + +import java.util.Arrays; +import java.util.List; + +public class LockClient implements LockClientInterface { + private final MetaClientInterface<LockInfo> _metaClient; + + public LockClient(MetaClientConfig config) { + if (config.getStoreType() == MetaClientConfig.StoreType.ZOOKEEPER) { + ZkMetaClientConfig zkMetaClientConfig = new ZkMetaClientConfig.ZkMetaClientConfigBuilder(). + setConnectionAddress(config.getConnectionAddress()) + // Currently only support ZNRecordSerializer. TODO: make this configurable + .setZkSerializer((new ZNRecordSerializer())) + .build(); + _metaClient = new ZkMetaClientFactory().getMetaClient(zkMetaClientConfig); + } else { + throw new MetaClientException("Unsupported store type: " + config.getStoreType()); + } Review Comment: Can this section be moved to MetaClientFactory or somewhere? Basically it's how we instantiate a metaclient from config. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClient.java: ########## @@ -0,0 +1,108 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * 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. + */ + + +import org.apache.helix.metaclient.api.MetaClientInterface; +import org.apache.helix.metaclient.api.Op; +import org.apache.helix.metaclient.datamodel.DataRecord; +import org.apache.helix.metaclient.exception.MetaClientException; +import org.apache.helix.metaclient.factories.MetaClientConfig; +import org.apache.helix.metaclient.factories.MetaClientFactory; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientConfig; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientFactory; +import org.apache.helix.zookeeper.datamodel.serializer.ZNRecordSerializer; + +import java.util.Arrays; +import java.util.List; + +public class LockClient implements LockClientInterface { + private final MetaClientInterface<LockInfo> _metaClient; + + public LockClient(MetaClientConfig config) { + if (config.getStoreType() == MetaClientConfig.StoreType.ZOOKEEPER) { + ZkMetaClientConfig zkMetaClientConfig = new ZkMetaClientConfig.ZkMetaClientConfigBuilder(). + setConnectionAddress(config.getConnectionAddress()) + // Currently only support ZNRecordSerializer. TODO: make this configurable + .setZkSerializer((new ZNRecordSerializer())) + .build(); + _metaClient = new ZkMetaClientFactory().getMetaClient(zkMetaClientConfig); + } else { + throw new MetaClientException("Unsupported store type: " + config.getStoreType()); + } + _metaClient.connect(); + } + + public LockClient(MetaClientInterface<LockInfo> client) { + _metaClient = client; + _metaClient.connect(); + } + + @Override + public boolean acquireLock(String key, LockInfo lockInfo, MetaClientInterface.EntryMode mode) { + _metaClient.create(key, lockInfo, mode); + return true; + } + + @Override + public boolean acquireLockWithTTL(String key, LockInfo lockInfo, long ttl) { + _metaClient.createWithTTL(key, lockInfo, ttl); + return true; + } + + @Override + public boolean renewTTLLock(String key) { + _metaClient.renewTTLNode(key); + return true; + } Review Comment: Open question, do these and below methods ever return false? Should they? ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClient.java: ########## @@ -0,0 +1,108 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * 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. + */ + + +import org.apache.helix.metaclient.api.MetaClientInterface; +import org.apache.helix.metaclient.api.Op; +import org.apache.helix.metaclient.datamodel.DataRecord; +import org.apache.helix.metaclient.exception.MetaClientException; +import org.apache.helix.metaclient.factories.MetaClientConfig; +import org.apache.helix.metaclient.factories.MetaClientFactory; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientConfig; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientFactory; +import org.apache.helix.zookeeper.datamodel.serializer.ZNRecordSerializer; + +import java.util.Arrays; +import java.util.List; + +public class LockClient implements LockClientInterface { + private final MetaClientInterface<LockInfo> _metaClient; + + public LockClient(MetaClientConfig config) { + if (config.getStoreType() == MetaClientConfig.StoreType.ZOOKEEPER) { + ZkMetaClientConfig zkMetaClientConfig = new ZkMetaClientConfig.ZkMetaClientConfigBuilder(). + setConnectionAddress(config.getConnectionAddress()) + // Currently only support ZNRecordSerializer. TODO: make this configurable + .setZkSerializer((new ZNRecordSerializer())) + .build(); + _metaClient = new ZkMetaClientFactory().getMetaClient(zkMetaClientConfig); + } else { + throw new MetaClientException("Unsupported store type: " + config.getStoreType()); + } + _metaClient.connect(); + } + + public LockClient(MetaClientInterface<LockInfo> client) { + _metaClient = client; + _metaClient.connect(); Review Comment: Not an issue, but a reminder related to the AutoCloseable, we should differentiate the 2 cases whether to close metaclient. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClient.java: ########## @@ -0,0 +1,108 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * 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. + */ + + +import org.apache.helix.metaclient.api.MetaClientInterface; +import org.apache.helix.metaclient.api.Op; +import org.apache.helix.metaclient.datamodel.DataRecord; +import org.apache.helix.metaclient.exception.MetaClientException; +import org.apache.helix.metaclient.factories.MetaClientConfig; +import org.apache.helix.metaclient.factories.MetaClientFactory; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientConfig; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientFactory; +import org.apache.helix.zookeeper.datamodel.serializer.ZNRecordSerializer; + +import java.util.Arrays; +import java.util.List; + +public class LockClient implements LockClientInterface { + private final MetaClientInterface<LockInfo> _metaClient; Review Comment: Let's make this class AutoCloseable, and write cleanup logic there. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClient.java: ########## @@ -0,0 +1,108 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * 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. + */ + + +import org.apache.helix.metaclient.api.MetaClientInterface; +import org.apache.helix.metaclient.api.Op; +import org.apache.helix.metaclient.datamodel.DataRecord; +import org.apache.helix.metaclient.exception.MetaClientException; +import org.apache.helix.metaclient.factories.MetaClientConfig; +import org.apache.helix.metaclient.factories.MetaClientFactory; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientConfig; +import org.apache.helix.metaclient.impl.zk.factory.ZkMetaClientFactory; +import org.apache.helix.zookeeper.datamodel.serializer.ZNRecordSerializer; + +import java.util.Arrays; +import java.util.List; + +public class LockClient implements LockClientInterface { + private final MetaClientInterface<LockInfo> _metaClient; + + public LockClient(MetaClientConfig config) { + if (config.getStoreType() == MetaClientConfig.StoreType.ZOOKEEPER) { + ZkMetaClientConfig zkMetaClientConfig = new ZkMetaClientConfig.ZkMetaClientConfigBuilder(). + setConnectionAddress(config.getConnectionAddress()) + // Currently only support ZNRecordSerializer. TODO: make this configurable + .setZkSerializer((new ZNRecordSerializer())) + .build(); + _metaClient = new ZkMetaClientFactory().getMetaClient(zkMetaClientConfig); + } else { + throw new MetaClientException("Unsupported store type: " + config.getStoreType()); + } + _metaClient.connect(); + } + + public LockClient(MetaClientInterface<LockInfo> client) { + _metaClient = client; + _metaClient.connect(); + } + + @Override + public boolean acquireLock(String key, LockInfo lockInfo, MetaClientInterface.EntryMode mode) { + _metaClient.create(key, lockInfo, mode); + return true; + } + + @Override + public boolean acquireLockWithTTL(String key, LockInfo lockInfo, long ttl) { + _metaClient.createWithTTL(key, lockInfo, ttl); + return true; + } + + @Override + public boolean renewTTLLock(String key) { + _metaClient.renewTTLNode(key); + return true; + } + + @Override + public boolean releaseLock(String key) { + MetaClientInterface.Stat stat = _metaClient.exists(key); + if (stat != null) { + int version = stat.getVersion(); + List<Op> ops = Arrays.asList( + Op.check(key, version), + Op.delete(key, version)); + _metaClient.transactionOP(ops); + if (_metaClient.exists(key) != null) { + throw new MetaClientException("Failed to release lock for key: " + key); + } + } + return true; + } + + @Override + public LockInfo retrieveLock(String key) { + MetaClientInterface.Stat stat = _metaClient.exists(key); + if (stat != null) { + //Create a new DataRecord from underlying record + DataRecord dataRecord = new DataRecord(_metaClient.get(key)); + //Create a new LockInfo from DataRecord + LockInfo lockInfo = new LockInfo(dataRecord); + //Synchronize the lockInfo with the stat + lockInfo.setGrantedAt(stat.getCreationTime()); + lockInfo.setLastRenewedAt(stat.getModifiedTime()); + return lockInfo; + } else { + return null; + } Review Comment: nit: you can check and return this first, so no need for the else branch. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
