1. Wiktor Jarka
Creatuity
Synchronizacja - sekcje krytyczne
na przykładzie integracji z
systemem lojalnościowym

2. Definicje
Sekcja krytyczna
“W programowaniu
współbieżnym fragment kodu, w którym
korzysta się z zasobu
współdzielonego, a co
za tym idzie - w danej
chwili może być
wykorzystywany przez
co najwyżej jeden
wątek.”
Semafor
“Chroniona zmienna lub
abstrakcyjny typ danych,
który stanowi klasyczną
metodę kontroli dostępu
przez wiele procesów do
wspólnego zasobu w
środowisku
programowania
równoległego.”

3. Opis problemu
● Projekt: system zakupów grupowych
wyspecjalizowany w polach golfowych,
● Opticard: system punktów lojalnościowych
posiadający API,
● typy transakcji: inicjacja karty, dodawanie punktów,
zapisanie danych użytkownika,
● sequence number: część specyfikacji Opticard API,
● pula numerów kart: część specyfikacji modułu
integrującego Opticard z Magento.

4. Zachowanie spójności danych
Jak?

5. Sequence Number
● służy do zachowania spójności Opticard
i systemu,
● zwiększany po poprawnej transakcji,
● pozostaje taki sam po błędzie,
● nie mogą istnieć dwie poprawne transakcje
z tym samym numerem sekwencji.

6. Pula kart
● administrator Magento definiuje jakie karty mogą być
przypisane do klientów,
● dowolna, wolna karta jest przypisywana do
użytkownika w momencie, kiedy pierwszy raz coś
kupi,
● jedna karta może być przypisana tylko do jednego
użytkownika (przez cały “cykl życia” karty).

7. Podstawowe informacje o
systemie

8. Wersja wyjściowa
class Creatuitycorp_Opticard_Model_Card_Pool extends Varien_Object {
(...)
public function assignAnyFreeCardToCustomer($customerOrId) {
$customerId = $this->_helper()->asCustomerId($customerOrId);
$freeCards = $this->getFreeCardNumbersCollection()
->addFieldToSelect('card_id')
->addFieldToSelect('card_number');
if ($freeCards->count() == 0) {
Mage::throwException('There is no Opticard card numbers available to assign');
}
/** @var Creatuitycorp_Opticard_Model_Card $card */
$card = $freeCards->getFirstItem();
$card->assignToCustomer($customerId);
$card->save();
return $card;
}
}

9. Synchronizacja w PHP
Jest kilka możliwości:
● poprzez plik: flock(),
● poprzez wbudowany semafor: sem_acquire(),
● poprzez mysql: GET_LOCK().

10. Rozwiązanie: krok 1
class Creatuitycorp_Opticard_Model_Card_Pool extends Varien_Object {
public function assignAnyFreeCardToCustomer($customerOrId) {
$customerId = $this->_helper()try {
>asCustomerId($customerOrId);
$row = $this->_db()->query("SELECT GET_LOCK('" . self::$_lockName . "', 15) AS
locked")->fetch();
$freeCards = $this$isTimeout = $row['locked'] == 0;
>getFreeCardNumbersCollection()
if ($isTimeout) {
->addFieldToSelect('card_id')
$this->_debugLog("Couldn't lock. Timeout exceeded.");
->addFieldToSelect('card_number');
Mage::throwException("I was unable to create lock within 15 seconds.");
}
if ($freeCards->count() == 0) {
$this->_db()->beginTransaction();
Mage::throwException('There is no
Opticard card numbers available to
// LOGIC GOES HERE
assign');
}
$this->_db()->commit();
/** @var
$this->_db()->query("DO RELEASE_LOCK('" . self::$_lockName . "')");
Creatuitycorp_Opticard_Model_Card $card
return $card;
*/
$card = $freeCards->getFirstItem();
} catch (Exception $e) {
$this->_db()->rollback();
$card->assignToCustomer($customerId);
$this->_db()->query("DO RELEASE_LOCK('" . self::$_lockName . "')");
throw $e;
$card->save();
}
}
(...)

11. Lepiej, ale…?
• Ciężko to pokazać na slajdzie (serio!),
• duplikacja kodu dla każdej funkcji, która wymaga
działania w sekcji krytycznej,
• kiedy sekcje nachodzą do siebie - RELEASE_LOCK
może być wykonane zbyt wcześnie.

12. Nachodzące na siebie sekcje
Wymagana transakcyjność!

13. Rozwiązanie: krok 2.1
class Creatuitycorp_Opticard_Model_Mysql_Transactional_Critical_Section
extends Creatuitycorp_Opticard_Model_Mysql_Abstract {
public function begin() {
$this->_semaphore()->lock();
$this->_transaction()->begin();
}
public function end() {
$this->_transaction()->commit();
$this->_semaphore()->release();
}
public function revert() {
$this->_transaction()->rollback();
$this->_semaphore()->release();
}
/** @return Creatuitycorp_Opticard_Model_Mysql_Transactions */
protected function _transaction() {
return Mage::getSingleton('opticard/mysql_transactions');
}
/** @return Creatuitycorp_Opticard_Model_Mysql_Semaphore */
protected function _semaphore() {
return Mage::getSingleton('opticard/mysql_semaphore');
}
(...)

14. Rozwiązanie: krok 2.2
class Creatuitycorp_Opticard_Model_Mysql_Semaphore
extends Creatuitycorp_Opticard_Model_Mysql_Abstract {
private static $_count = 0;
private static $_lockName = 'opticard_semaphore';
public function lock($timeout = 300) {
if (self::$_count++ === 0) {
$row = $this->_db()->query("SELECT GET_LOCK('" . self::$_lockName . "', " . $timeout
. ") AS locked")->fetch();
$isTimeout = $row['locked'] == 0;
if ($isTimeout) {
Mage::throwException("Unable to lock. Timeout exceeded.");
}
}
}
public function release() {
if (self::$_count === 0) {
Mage::throwException("Cannot unlock what's not locked. Neither can Chuck Norris.");
}
if (--self::$_count === 0) {
$this->_db()->query("DO RELEASE_LOCK('" . self::$_lockName . "')");
}
}
(...)

15. Rozwiązanie: krok 2.3
class Creatuitycorp_Opticard_Model_Card_Pool extends Varien_Object {
public function assignAnyFreeCardToCustomer($customerOrId) {
try {
$this->_criticalSection()->begin();
$customerId = $this->_helper()->asCustomerId($customerOrId);
$freeCards = $this->getFreeCardNumbersCollection()
->addFieldToSelect('card_id')
->addFieldToSelect('card_number');
if ($freeCards->count() == 0) {
Mage::throwException('There is no Opticard card numbers available to assign');
}
/** @var Creatuitycorp_Opticard_Model_Card $card */
$card = $freeCards->getFirstItem();
$card->assignToCustomer($customerId);
$card->save();
$this->_criticalSection()->end();
return $card;
} catch (Exception $e) {
$this->_criticalSection()->rollback();
throw $e;
}
}
(...)

16. Krok 2 - podsumowanie
Minusy
•
konieczność dodawania
dodatkowego kodu do
każdej funkcji
używającej sekcji
krytycznej
Plusy
•
•
obsługa nachodzących
na siebie sekcji
krytycznych
lepsza organizacja
i czytelność kodu

17. Rozwiązanie: krok 3.1
class Creatuitycorp_Opticard_Model_Card_Pool extends Varien_Object {
public function assignAnyFreeCardToCustomer__CRITICAL_SECTION($customerOrId) {
$customerId = $this->_helper()->asCustomerId($customerOrId);
$freeCards = $this->getFreeCardNumbersCollection()
->addFieldToSelect('card_id')
->addFieldToSelect('card_number');
if ($freeCards->count() == 0) {
Mage::throwException('There is no Opticard card numbers available to assign');
}
/** @var Creatuitycorp_Opticard_Model_Card $card */
$card = $freeCards->getFirstItem();
$card->assignToCustomer($customerId);
$card->save();
return $card;
}
public function __call($method, $args) {
if ($this->_criticalSection()->shouldRunInCriticalSection($this, $method)) {
return $this->_criticalSection()->runMethodInCriticalSection($this, $method, $args);
}
return parent::__call($method, $args);
}
(...)

18. Rozwiązanie: krok 3.2
class Creatuitycorp_Opticard_Model_Mysql_Transactional_Critical_Section
extends Creatuitycorp_Opticard_Model_Mysql_Abstract {
const METHOD_SUFFIX = '__CRITICAL_SECTION';
public function shouldRunInCriticalSection($object, $methodName) {
return method_exists($object, $this->_csMethodName($methodName));
}
public function runMethodInCriticalSection($object, $methodName, $args) {
return $this->run($object, $this->_csMethodName($methodName), $args);
}
protected function _csMethodName($methodName) {
return $methodName . self::METHOD_SUFFIX;
}
public function run($object, $methodName, array $args = array()) {
try {
$this->begin();
$result = call_user_func_array(array($object, $methodName), $args);
$this->end();
return $result;
} catch (Exception $e) {
$this->revert();
throw $e;
}
}
(...)

19. Krok 3 - podsumowanie
Minusy
•
konieczność nadpisania
funkcji __call dla każdej
klasy używającej sekcji
krytycznej
Plusy
•
funkcja robi tylko
i wyłącznie to za co jest
odpowiedzialna

20. Pytania?

21. A jak Ty byś to zrobił?

22. Dziękuję za uwagę
@wiktorjarka
wiktor@jarka.pl