Distributed locks for 1C:Enterprise in a Yandex Managed Service for Valkey™ cluster

You can use a Yandex Managed Service for Valkey™ cluster as a distributed lock storage for 1C:Enterprise, e.g., to prevent multiple users from editing the same catalog item at the same time.

Integration is implemented via an intermediate HTTP server running on a Yandex Compute Cloud virtual machine. The server provides an HTTP API for managing locks and uses a Valkey™ cluster as its backend. A 1C:Enterprise module accesses the API through an external connection.

To set up locks:

1. Set up your infrastructure.
2. Deploy your HTTP lock server.
3. Configure the 1C:Enterprise module.
4. Test the locks.
5. Delete the resources you created.

Getting startedGetting started

Sign up for Yandex Cloud and create a billing account:

1. Navigate to the management console and log in to Yandex Cloud or create a new account.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one and link a cloud to it.

If you have an active billing account, you can create or select a folder for your infrastructure on the cloud page.

Learn more about clouds and folders here.

Required paid resourcesRequired paid resources

• Yandex Managed Service for Valkey™ cluster: the host's computing resources and storage size (see Yandex Managed Service for Valkey™ pricing).
• VM instance: use of computing resources, storage, public IP address, and OS (see Compute Cloud pricing).

Set up your infrastructureSet up your infrastructure

Deploy your HTTP lock serverDeploy your HTTP lock server

An HTTP lock server is a thin layer between a 1C:Enterprise server and a Yandex Managed Service for Valkey™ cluster. It exposes endpoints with the lock prefix:

How to work with your cluster:

• To acquire a lock (lock/acquire), use the SET command with the NX argument and specify the key TTL (PX). The NX argument ensures the lock is only acquired when no such key exists, while the TTL prevents the lock from lasting indefinitely:

  SET <key> <token> NX PX <ttl_in_milliseconds>
  

• To release (lock/release) or renew (lock/renew) a lock, use the EVAL command to call Lua scripts. These scripts perform the following operations in Valkey™ sequentially:

  1. Get lock data by key.
  2. Compare the lock token with the request token.
  3. Delete the key or renew the lock.

  Calling a script ensures transaction atomicity, meaning that either all operations complete successfully or none of them do. Below is an example of a script for releasing a lock:

  -- release: Delete the key only if the token matches.
  local value = server.call('GET', KEYS[1])
  if not value then
    return 0
  end
  local ok, lock = pcall(cjson.decode, value)
  if not ok or lock['token'] ~= ARGV[1] then
    return 0
  end
  return server.call('DEL', KEYS[1])
  

• The server returns HTTP status codes and error messages showing whether it successfully acquired, released, or renewed the lock.

To deploy your server:

Configure the 1C:Enterprise moduleConfigure the 1C:Enterprise module

1C:Enterprise uses the Catalog lock module, which accesses the HTTP server through an external connection. The ready-to-use module code is in the container hosting the 1C:Enterprise test database in the valkey/webinar-260624-1c-example repository.

The module performs the following functions:

• Sends HTTP requests to the server endpoints (lock/acquire, lock/release, lock/status, lock/renew, lock/list) depending on the action.
• Generates a lock key from the full catalog path (collection metadata) and the item ID. This ensures a unique lock for each catalog item.
• In the module form, you can configure event handlers for catalogs:
  • On opening: Attempt to acquire the lock.
  • On modification and closing: Renew or release the lock.
• To prevent the lock from expiring while the user is working with the form, configure periodic lock renewal.
• For clarity, the form displays lock information: its status (acquired or available), the remaining TTL, and the token used to verify lock ownership.

To configure the module:

1. Connect the database from the 1CExample repository directory and copy the CatalogLocks common module to your 1C:Enterprise configuration.

2. If methods are called from server form code, make sure server calls are enabled for the module.

3. In the HTTPRequest() function, specify the HTTP lock server address:

   Connection = New HTTPConnection("<new_VM_public_IP_address>", <port_from_HTTP_ADDR_variable>);
   

4. Add the lock to the appropriate form. Follow these steps:

   • Add form attributes for the token and status.
   • When opening the form, call LockCatalog().
   • When closing the form, call UnlockCatalog().
   • Enable periodic renew sending.

5. Connect the form event handlers to the appropriate catalogs. Here is a minimum functionality example:

   OnCreatingOnServer:
       acquire
   
   OnOpening:
       renew
   
   OnClosing:
       release
   

6. Set up a lock key. By default, the key is generated as follows:

   "Catalog." + Reference.Metadata().Name + ":" + Reference.UniqueID()
   

   For documents, you can use the same approach:

   Document.CustomerOrder:UniqueID()
   

   If you need to use one module for different object types, generalize the LockKey() function.

Test the locksTest the locks

1. Open 1C:Enterprise and go to a catalog, such as Customers.

2. Open an item, such as Roman, for editing. The form will display the lock status as acquired, along with the lock TTL and token.

3. Monitor the TTL for a while: it should decrease over time, e.g., from 41 to 31 seconds. When the renewal interval expires (30 seconds by default), 1C:Enterprise automatically renews the lock.

4. Make sure the lock appears in the cluster:

   Management console

   SQL

   1. Open Yandex WebSQL Connections.
   2. Add a database connection for the Valkey™ server you created earlier. Specify 0 as the database name.
   3. Connect to the 0 database and find the the lock key row.

   Note

   Due to encoding limitations, WebSQL may display the key name incorrectly. To verify lock ownership, check whether the key exists and look at its value (token), rather than checking whether the key name is readable.

   Connect to the Yandex Managed Service for Valkey™ cluster and run this command:

   KEYS <lock_key_prefix>:*
   

   Valkey™ will return the lock key as a string.

Delete the resources you createdDelete the resources you created

To reduce resource usage, delete the resources you no longer need: