PCBC-660: Detect when to raise CasMismatchException

avsej · avsej · commit 8d30b8ffb5ab · 2020-03-02T17:32:10.000Z
Change-Id: Ia1f6f812697aa4be7550ece327d69bcc02946bba Reviewed-on: http://review.couchbase.org/123053 Tested-by: Build Bot <build@couchbase.com> Reviewed-by: Sergey Avseyev <sergey.avseyev@gmail.com>
diff --git a/couchbase.h b/couchbase.h
@@ -130,8 +130,13 @@ extern zend_class_entry *pcbc_binary_collection_ce;
 #define PCBC_RESOLVE_COLLECTION PCBC_RESOLVE_COLLECTION_EX(pcbc_collection_ce)
 #define PCBC_RESOLVE_BINARY_COLLECTION PCBC_RESOLVE_COLLECTION_EX(pcbc_binary_collection_ce)
 
+#define PCBC_OPCODE_UNSPEC (-1)
+#define PCBC_OPCODE_REPLACE (1)
+#define PCBC_OPCODE_DELETE (2)
+#define PCBC_OPCODE_UNLOCK (3)
+
 void pcbc_create_lcb_exception(zval *return_value, long code, zend_string *context, zend_string *ref, int http_code,
-                               const char *http_msg TSRMLS_DC);
+                               const char *http_msg, int opcode TSRMLS_DC);
 
 void pcbc_exception_init(zval *return_value, long code, const char *message TSRMLS_DC);
 #define throw_pcbc_exception(__pcbc_message, __pcbc_code)                                                              \
@@ -142,7 +147,7 @@ void pcbc_exception_init(zval *return_value, long code, const char *message TSRM
         zend_throw_exception_object(&__pcbc_error TSRMLS_CC);                                                          \
     } while (0)
 
-#define throw_lcb_exception(code, result_ce)                                                                           \
+#define throw_lcb_exception_ex(code, opcode, result_ce)                                                                \
     do {                                                                                                               \
         zend_string *ctx = NULL, *ref = NULL;                                                                          \
         zval *zref, __rv1, *zctx, __rv2;                                                                               \
@@ -158,15 +163,18 @@ void pcbc_exception_init(zval *return_value, long code, const char *message TSRM
         }                                                                                                              \
         zval __pcbc_error;                                                                                             \
         ZVAL_UNDEF(&__pcbc_error);                                                                                     \
-        pcbc_create_lcb_exception(&__pcbc_error, code, ctx, ref, 0, NULL TSRMLS_CC);                                   \
+        pcbc_create_lcb_exception(&__pcbc_error, code, ctx, ref, 0, NULL, opcode TSRMLS_CC);                           \
         zend_throw_exception_object(&__pcbc_error TSRMLS_CC);                                                          \
     } while (0)
 
+#define throw_lcb_exception(code, result_ce) throw_lcb_exception_ex((code), PCBC_OPCODE_UNSPEC, (result_ce))
+
 #define throw_http_exception(code, query_code, query_msg)                                                              \
     do {                                                                                                               \
         zval __pcbc_error;                                                                                             \
         ZVAL_UNDEF(&__pcbc_error);                                                                                     \
-        pcbc_create_lcb_exception(&__pcbc_error, code, NULL, NULL, query_code, query_msg TSRMLS_CC);                   \
+        pcbc_create_lcb_exception(&__pcbc_error, code, NULL, NULL, query_code, query_msg,                              \
+                                  PCBC_OPCODE_UNSPEC TSRMLS_CC);                                                       \
         zend_throw_exception_object(&__pcbc_error TSRMLS_CC);                                                          \
     } while (0)
 
diff --git a/exception.c b/exception.c
@@ -138,8 +138,9 @@ PHP_MINIT_FUNCTION(CouchbaseException)
 
     INIT_NS_CLASS_ENTRY(ce, "Couchbase", "KeyValueException", NULL);
     pcbc_key_value_exception_ce = zend_register_internal_class_ex(&ce, pcbc_base_exception_ce TSRMLS_CC);
-    INIT_NS_CLASS_ENTRY(ce, "Couchbase", "KeyNotFoundException", NULL);
+    INIT_NS_CLASS_ENTRY(ce, "Couchbase", "DocumentNotFoundException", NULL);
     pcbc_key_not_found_exception_ce = zend_register_internal_class_ex(&ce, pcbc_key_value_exception_ce TSRMLS_CC);
+    zend_register_class_alias("Couchbase\\KeyNotFoundException", pcbc_key_not_found_exception_ce);
     INIT_NS_CLASS_ENTRY(ce, "Couchbase", "KeyExistsException", NULL);
     pcbc_key_exists_exception_ce = zend_register_internal_class_ex(&ce, pcbc_key_value_exception_ce TSRMLS_CC);
     INIT_NS_CLASS_ENTRY(ce, "Couchbase", "ValueTooBigException", NULL);
@@ -196,7 +197,7 @@ PHP_MINIT_FUNCTION(CouchbaseException)
 }
 
 void pcbc_create_lcb_exception(zval *return_value, long code, zend_string *context, zend_string *ref, int http_code,
-                               const char *http_msg TSRMLS_DC)
+                               const char *http_msg, int opcode TSRMLS_DC)
 {
     zend_class_entry *exc_ce = NULL;
 
@@ -210,7 +211,22 @@ void pcbc_create_lcb_exception(zval *return_value, long code, zend_string *conte
         break;
 
     case LCB_ERR_DOCUMENT_EXISTS:
-        exc_ce = pcbc_key_exists_exception_ce;
+        switch (opcode) {
+        case PCBC_OPCODE_DELETE:
+        case PCBC_OPCODE_REPLACE:
+            exc_ce = pcbc_cas_mismatch_exception_ce;
+            break;
+        default:
+            exc_ce = pcbc_key_exists_exception_ce;
+        }
+        break;
+
+    case LCB_ERR_DOCUMENT_LOCKED:
+        if (opcode == PCBC_OPCODE_UNLOCK) {
+            exc_ce = pcbc_cas_mismatch_exception_ce;
+        } else {
+            exc_ce = pcbc_key_exists_exception_ce;
+        }
         break;
 
     case LCB_ERR_DOCUMENT_NOT_FOUND:
diff --git a/src/couchbase/bucket/remove.c b/src/couchbase/bucket/remove.c
@@ -159,6 +159,7 @@ PHP_METHOD(Collection, remove)
     lcb_cmdremove_create(&cmd);
     lcb_cmdremove_collection(cmd, scope_str, scope_len, collection_str, collection_len);
     lcb_cmdremove_key(cmd, ZSTR_VAL(id), ZSTR_LEN(id));
+    uint64_t cas = 0;
     if (options) {
         zval *prop, ret;
         prop = zend_read_property(pcbc_remove_options_ce, options, ZEND_STRL("timeout"), 0, &ret);
@@ -173,7 +174,6 @@ PHP_METHOD(Collection, remove)
         if (Z_TYPE_P(prop) == IS_STRING) {
             zend_string *decoded = php_base64_decode_str(Z_STR_P(prop));
             if (decoded) {
-                uint64_t cas = 0;
                 memcpy(&cas, ZSTR_VAL(decoded), ZSTR_LEN(decoded));
                 lcb_cmdremove_cas(cmd, cas);
                 zend_string_free(decoded);
@@ -202,7 +202,7 @@ PHP_METHOD(Collection, remove)
     }
 
     if (err != LCB_SUCCESS) {
-        throw_lcb_exception(err, pcbc_mutation_result_impl_ce);
+        throw_lcb_exception_ex(err, cas == 0 ? PCBC_OPCODE_UNSPEC : PCBC_OPCODE_DELETE, pcbc_mutation_result_impl_ce);
     }
 }
 
diff --git a/src/couchbase/bucket/store.c b/src/couchbase/bucket/store.c
@@ -578,7 +578,7 @@ PHP_METHOD(Collection, replace)
         lcbtrace_span_finish(parent_span, LCBTRACE_NOW);
     }
     if (err != LCB_SUCCESS) {
-        throw_lcb_exception(err, pcbc_store_result_impl_ce);
+        throw_lcb_exception_ex(err, PCBC_OPCODE_REPLACE, pcbc_store_result_impl_ce);
     }
 }
 
diff --git a/src/couchbase/bucket/unlock.c b/src/couchbase/bucket/unlock.c
@@ -132,7 +132,7 @@ PHP_METHOD(Collection, unlock)
     }
 
     if (err != LCB_SUCCESS) {
-        throw_lcb_exception(err, pcbc_result_impl_ce);
+        throw_lcb_exception_ex(err, PCBC_OPCODE_UNLOCK, pcbc_result_impl_ce);
     }
 }
 
diff --git a/tests/BucketTest.php b/tests/BucketTest.php
@@ -171,7 +171,7 @@ function testCas($c) {
         $this->wrapException(function() use($c, $key, $old_cas) {
             $options = (new \Couchbase\ReplaceOptions())->cas($old_cas);
             $c->replace($key, 'ferret', $options);
-        }, '\Couchbase\KeyExistsException', COUCHBASE_KEYALREADYEXISTS);
+        }, '\Couchbase\CasMismatchException', COUCHBASE_KEYALREADYEXISTS);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -578,7 +578,7 @@ PHP_METHOD(Collection, replace)`
`578`	`578`	`lcbtrace_span_finish(parent_span, LCBTRACE_NOW);`
`579`	`579`	`}`
`580`	`580`	`if (err != LCB_SUCCESS) {`
`581`		`- throw_lcb_exception(err, pcbc_store_result_impl_ce);`
	`581`	`+ throw_lcb_exception_ex(err, PCBC_OPCODE_REPLACE, pcbc_store_result_impl_ce);`
`582`	`582`	`}`
`583`	`583`	`}`
`584`	`584`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ PHP_METHOD(Collection, unlock)`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`if (err != LCB_SUCCESS) {`
`135`		`- throw_lcb_exception(err, pcbc_result_impl_ce);`
	`135`	`+ throw_lcb_exception_ex(err, PCBC_OPCODE_UNLOCK, pcbc_result_impl_ce);`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ function testCas($c) {`
`171`	`171`	`$this->wrapException(function() use($c, $key, $old_cas) {`
`172`	`172`	`$options = (new \Couchbase\ReplaceOptions())->cas($old_cas);`
`173`	`173`	`$c->replace($key, 'ferret', $options);`
`174`		`- }, '\Couchbase\KeyExistsException', COUCHBASE_KEYALREADYEXISTS);`
	`174`	`+ }, '\Couchbase\CasMismatchException', COUCHBASE_KEYALREADYEXISTS);`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`/**`