WL13061: Add Schema Validation to create/modify collection.

Author: silvakid

common/collection.cc

@@ -344,3 +344,110 @@ void Op_idx_create::process(cdk::Any::Document::Processor &prc) const
 
   prc.doc_end();
 }
+
+/*
+  Collection create/modify json options
+*/
+
+
+struct Collection_options_converter
+  : public cdk::Converter< cdk::Doc_prc_converter<JSON_val_conv> >
+{
+  typedef cdk::Converter< cdk::Doc_prc_converter<JSON_val_conv> >  Base;
+
+  typedef typename Base::Prc_from Prc_from;
+  typedef typename Base::Prc_to   Prc_to;
+  using Base::m_proc;
+
+  typedef cdk::Any_prc_converter<JSON_val_conv> Any_conv;
+  typedef typename Prc_from::Any_prc Any_prc;
+
+  void doc_begin() { m_proc->doc_begin(); }
+  void doc_end()   { m_proc->doc_end(); }
+
+  Any_conv m_any_conv;
+
+  Any_prc* key_val(const string &key)
+  {
+    typename Prc_to::Any_prc *ap;
+    if(key == "reuseExisting")
+    {
+      ap = m_proc->key_val("reuse_existing");
+    }
+    else {
+      ap = m_proc->key_val(key);
+    }
+
+    if (!ap)
+      return NULL;
+    m_any_conv.reset(*ap);
+    return &m_any_conv;
+  }
+
+};
+
+void Op_create_modify_base::process(cdk::Any::Document::Processor &prc) const
+{
+
+  prc.doc_begin();
+
+  for (auto it : m_map)
+  {
+    Value_scalar val(it.second);
+    val.process_if(prc.key_val(it.first));
+  }
+
+  if(!m_options.empty())
+  {
+    const parser::JSON_parser parser(m_options);
+    Collection_options_converter conv;
+    auto * options =
+        m_validation_options ?
+          prc.key_val("options")->doc()->key_val("validation")->doc()
+        : prc.key_val("options")->doc();
+    if(options)
+    {
+      conv.reset(*options);
+      parser.process(conv);
+    }
+    prc.doc_end();
+    return;
+  }
+
+  if(!m_validation_level.empty() || !m_validation_schema.empty())
+  {
+    auto options =safe_prc(prc.key_val("options"))->doc();
+    options->doc_begin();
+
+    if (!m_validation_level.empty() || !m_validation_schema.empty())
+    {
+      //validation
+      auto validation = options->key_val("validation")->doc();
+      validation->doc_begin();
+
+      if(!m_validation_level.empty())
+      {
+        validation->key_val("level")->scalar()->str(m_validation_level);
+      }
+
+      if(!m_validation_schema.empty())
+      {
+        const parser::JSON_parser parser(m_validation_schema);
+        cdk::Doc_prc_converter<JSON_val_conv> conv;
+        auto schema = validation->key_val("schema")->doc();
+        if(schema)
+        {
+          conv.reset(*schema);
+          parser.process(conv);
+        }
+      }
+
+      validation->doc_end();
+    }
+
+    options->doc_end();
+  }
+  prc.doc_end();
+  return;
+
+}

common/op_impl.h

@@ -1522,27 +1522,91 @@ struct Op_create<Object_type::SCHEMA>
   {}
 };
 
-
-template<>
-struct Op_create<Object_type::COLLECTION>
-  : public Op_admin
+struct Op_create_modify_base
+    : public Op_admin
 {
-  Op_create(
-    Shared_session_impl sess,
-    const cdk::api::Object_ref &coll,
-    bool reuse = true
-  )
-    : Op_admin(sess, "create_collection")
+  //TODO:
+  //Allow validation schema and m_options to be a document, not only a JSON string.
+  //Currently not possible because common layer does not have a document class
+  //like DbDoc.
+  std::string m_options;
+  std::string m_validation_level;
+  std::string m_validation_schema;
+  //If true, means m_options refers to validation json, not the full options
+  bool m_validation_options = false;
+
+  Op_create_modify_base(Shared_session_impl sess, const char *cmd,
+                        const cdk::api::Object_ref &coll,
+                        std::string level,
+                        std::string validation_schema)
+    : Op_admin(sess, cmd)
+    , m_validation_level(std::move(level))
+    , m_validation_schema(std::move(validation_schema))
   {
     if (coll.schema())
       add_param("schema", Value::Access::mk_str(coll.schema()->name()));
     else
       common::throw_error("No schema specified for create collection operation");
     add_param("name", Value::Access::mk_str(coll.name()));
+  }
+
+  Op_create_modify_base(Shared_session_impl sess, const char *cmd,
+                        const cdk::api::Object_ref &coll,
+                        std::string json,
+                        bool validation_json = false)
+    : Op_create_modify_base(sess, cmd, coll, std::string(),std::string() )
+  {
+    m_options = std::move(json);
+    m_validation_options = validation_json;
+  }
+  // cdk::Param_source
+
+  void process(cdk::Any::Document::Processor &prc) const override;
+
+};
+
+template<>
+struct Op_create<Object_type::COLLECTION>
+  : public Op_create_modify_base
+{
+  Op_create(
+        Shared_session_impl sess,
+        const cdk::api::Object_ref &coll,
+        bool reuse,
+        std::string validation_level,
+        std::string validation_schema
+  )
+    : Op_create_modify_base(sess, "create_collection", coll,
+                            std::move(validation_level), std::move(validation_schema))
+  {
     // 1050 = table already exists
     if (reuse)
       skip_error(cdk::server_error(1050));
   }
+
+  Op_create(
+        Shared_session_impl sess,
+        const cdk::api::Object_ref &coll,
+        bool reuse,
+        std::string validation_json
+  )
+    : Op_create_modify_base(sess, "create_collection", coll,
+                            std::move(validation_json), true)
+  {
+    // 1050 = table already exists
+    if (reuse)
+      skip_error(cdk::server_error(1050));
+  }
+
+  Op_create(
+        Shared_session_impl sess,
+        const cdk::api::Object_ref &coll,
+        std::string json,
+        bool validation_json = false
+  )
+    : Op_create_modify_base(sess, "create_collection", coll, std::move(json), validation_json)
+  {}
+
 };
 
 
@@ -1557,9 +1621,92 @@ void create_object(
   Shared_session_impl sess, Ty&&... args
 )
 {
-  Op_create<T> create(sess, std::forward<Ty>(args)...);
-  Result_impl res(create.execute());
-  res.next_result();
+  try{
+    Op_create<T> create(sess, std::forward<Ty>(args)...);
+    Result_impl res(create.execute());
+    res.next_result();
+  }
+  catch(const cdk::Error &err)
+  {
+    if(err.code().value() == 5015)
+    { //Old server... doesn't support schema validation
+      common::throw_error(
+            "The server doesn't support the requested operation. " \
+            "Please update the MySQL Server and or Client library");
+    }
+    throw;
+  }
+
+}
+
+
+// ----------------------------------------------------------------------
+
+/*
+  Operations which modify database objects.
+
+  They are implemented as Op_modify<> template parametrized by the type of the
+  object to modify.
+*/
+
+template <Object_type T>
+struct Op_modify;
+
+
+template<>
+struct Op_modify<Object_type::COLLECTION>
+  : public Op_create_modify_base
+{
+
+  Op_modify(
+        Shared_session_impl sess,
+        const cdk::api::Object_ref &coll,
+        std::string validation_level,
+        std::string validation_schema
+  ) : Op_create_modify_base(sess, "modify_collection_options", coll,
+                            std::move(validation_level),
+                            std::move(validation_schema))
+  {}
+
+  Op_modify(
+        Shared_session_impl sess,
+        const cdk::api::Object_ref &coll,
+        std::string json,
+        bool validation_json = false
+  )
+    : Op_create_modify_base(sess, "modify_collection_options",
+                            coll,
+                            std::move(json), validation_json)
+  {}
+
+};
+
+/*
+  A helper function which constructs an operation that modifies a database object
+  and executes it.
+*/
+
+template <Object_type T, typename... Ty>
+inline
+void modify_object(
+  Shared_session_impl sess, Ty&&... args
+)
+{
+  try{
+    Op_modify<T> modify(sess, std::forward<Ty>(args)...);
+    Result_impl res(modify.execute());
+    res.next_result();
+  }
+  catch(const cdk::Error &err)
+  {
+    if(err.code().value() == 5157)
+    { //Old server... doesn't support modify collection
+      common::throw_error(
+            "The server doesn't support the requested operation. " \
+            "Please update the MySQL Server and or Client library");
+    }
+    throw;
+  }
 }
 
 

common/value.cc

@@ -185,4 +185,3 @@ const std::u16string& Value::get_ustring() const
     throw Error("Value cannot be converted to string");
   }
 }
-

devapi/document.cc

@@ -76,7 +76,7 @@ DbDoc::DbDoc(const std::shared_ptr<Impl> &impl)
 
 const char* DbDoc::get_json() const
 {
-  return m_impl ? m_impl->get_json() : nullptr;
+  return m_impl ? m_impl->get_json() : "";
 }