Locking for multiple nodes the easy way: GCS

Emmanouil GkatziourasOctober 20th, 2020Last Updated: October 15th, 2020

0 91 5 minutes read

It happens to all of us. We develop stateless applications that can scale horizontally without any effort.
However sometimes cases arise where you need to achieve some type of coordination.

You can go really advanced on this one. For example you can use a framework like Akka and it’s cluster capabilities. Or you can go really simple like rolling a mechanism on your own as long as it gives you the results needed. On another note you can just have different node groups based on the work you need them to do. The options and the solutions can change based on the problem.

If your problem can go with a simple option, one way to do so , provided you use Google Cloud Storage, is to use its lock capabilities.
Imagine for example a scenario of 4 nodes, they do scale dynamically but each time a new node registers you want to change its actions by acquiring a unique configuration which does not collide with a configuration another node might have received.

The strategy can be to use a file on Google Cloud Storage for locking and a file that acts as a centralised configuration registry.

The lock file is nothing more that a file on cloud storage which shall be created and deleted. What will give us lock abilities is the option on GCS to create a file only if it not exists.
Thus a process from one node will try to create the `lock` file, this action would be equivalent to obtaining the lock.
Once the process is done will delete the file, this action would be equivalent to releasing the lock.
Other processes in the meantime will try to create the file (acquire the lock) and fail (file already exists) because other processes have created the file.
Meanwhile the process that has successfully created the file (acquired the lock) will change the centralised configuration registry and once done will delete the file (release the lock).

So let’s start with the lock object.

package com.gkatzioura.gcs.lock;
 
import java.util.Optional;
 
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageException;
 
public class GCSLock {
 
    public static final String LOCK_STRING = "_lock";
    private final Storage storage;
    private final String bucket;
    private final String keyName;
 
    private Optional<Blob> acquired = Optional.empty();
 
    GCSLock(Storage storage, String bucket, String keyName) {
        this.storage = storage;
        this.bucket = bucket;
        this.keyName = keyName;
    }
 
    public boolean acquire() {
        try {
            var blobInfo = BlobInfo.newBuilder(bucket, keyName).build();
            var blob = storage.create(blobInfo, LOCK_STRING.getBytes(), Storage.BlobTargetOption.doesNotExist());
            acquired = Optional.of(blob);
            return true;
        } catch (StorageException storageException) {
            return false;
        }
    }
 
    public void release() {
        if(!acquired.isPresent()) {
            throw new IllegalStateException("Lock was never acquired");
        }
        storage.delete(acquired.get().getBlobId());
    }
 
}

As you can see the write specifies to write an object only if it does not exist. This operation behind the scenes is using the x-goog-if-generation-match header which is used for concurrency.
Thus one node will be able to acquire the lock and change the configuration files.
Afterwards it can delete the lock. If an exception is raised probably the operation fails and the lock is already acquired.

To make the example more complete let’s make the configuration file. The configuration file would be a simple json file for key map actions.

package com.gkatzioura.gcs.lock;
 
import java.util.HashMap;
import java.util.Map;
 
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.Storage;
import org.json.JSONObject;
 
public class GCSConfiguration {
 
    private final Storage storage;
    private final String bucket;
    private final String keyName;
 
    GCSConfiguration(Storage storage, String bucket, String keyName) {
        this.storage = storage;
        this.bucket = bucket;
        this.keyName = keyName;
    }
 
    public void addProperty(String key, String value) {
        var blobId = BlobId.of(bucket, keyName);
        var blob = storage.get(blobId);
 
        final JSONObject configJson;
 
        if(blob==null) {
            configJson = new JSONObject();
        } else {
            configJson = new JSONObject(new String(blob.getContent()));
        }
 
        configJson.put(key, value);
 
        var blobInfo = BlobInfo.newBuilder(blobId).build();
        storage.create(blobInfo, configJson.toString().getBytes());
    }
 
    public Map<String,String> properties() {
 
        var blobId = BlobId.of(bucket, keyName);
        var blob = storage.get(blobId);
 
        var map = new HashMap<String,String>();
 
        if(blob!=null) {
            var jsonObject = new JSONObject(new String(blob.getContent()));
            for(var key: jsonObject.keySet()) {
                map.put(key, jsonObject.getString(key));
            }
        }
 
        return map;
    }
 
}

It is a simple config util backed by GCS. Eventually it can be changed and put the lock operating inside the addProperty operation, it’s up to the user and the code. For the purpose of this blog we shall just acquire the lock change the configuration and release the lock.
Our main class will look like this.

package com.gkatzioura.gcs.lock;
 
import com.google.cloud.storage.StorageOptions;
 
public class Application {
 
    public static void main(String[] args) {
        var storage = StorageOptions.getDefaultInstance().getService();
 
        final String bucketName = "bucketName";
        final String lockFileName = "lockFileName";
        final String configFileName = "configFileName";
 
        var lock = new GCSLock(storage, bucketName, lockFileName);
        var gcsConfig = new GCSConfiguration(storage, bucketName, configFileName);
 
        var lockAcquired = lock.acquire();
        if(lockAcquired) {
            gcsConfig.addProperty("testProperty", "testValue");
            lock.release();
        }
 
        var config = gcsConfig.properties();
 
        for(var key: config.keySet()) {
            System.out.println("Key "+key+" value "+config.get(key));
        }
 
    }
 
}

Now let’s go for some multithreading. Ten threads will try to put values, it is expected that they have some failure.

package com.gkatzioura.gcs.lock;
 
import java.util.ArrayList;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
 
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
 
public class ApplicationConcurrent {
 
    private static final String bucketName = "bucketName";
    private static final String lockFileName = "lockFileName";
    private static final String configFileName = "configFileName";
 
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        var storage = StorageOptions.getDefaultInstance().getService();
 
        final int threads = 10;
        var service = Executors.newFixedThreadPool(threads);
        var futures = new ArrayList<Future>(threads);
 
        for (var i = 0; i < threads; i++) {
            futures.add(service.submit(update(storage, "property-"+i, "value-"+i)));
        }
 
        for (var f : futures) {
            f.get();
        }
 
        service.shutdown();
 
        var gcsConfig = new GCSConfiguration(storage, bucketName, configFileName);
        var properties = gcsConfig.properties();
 
        for(var i=0; i < threads; i++) { System.out.println(properties.get("property-"+i)); } } private static Runnable update(final Storage storage, String property, String value) { return () -> {
            var lock = new GCSLock(storage, bucketName, lockFileName);
            var gcsConfig = new GCSConfiguration(storage, bucketName, configFileName);
 
            boolean lockAcquired = false;
 
            while (!lockAcquired) {
                lockAcquired = lock.acquire();
                System.out.println("Could not acquire lock");
            }
 
            gcsConfig.addProperty(property, value);
            lock.release();
        };
    }
}

Obviously 10 threads are ok to display the capabilities. During the thread initialization and execution some threads will try to acquire the lock simultaneously and one will fails, while other threads will be late and will fail and wait until the lock is available.

In the end what is expected is all of them to have their values added to the configuration.
That’s it. If your problems have a simple nature this approach might do the trick. Obviously you can use the http api instead of the sdk. You can find the code on github.

Published on Java Code Geeks with permission by Emmanouil Gkatziouras, partner at our JCG program. See the original article here: Locking for multiple nodes the easy way: GCS

Opinions expressed by Java Code Geeks contributors are their own.