feat(clustering/sync): add strict validation for delta workspace id (#…

…14289)

KAG-5760

kong/clustering/services/sync/validate.lua

@@ -44,6 +44,16 @@ local function validate_deltas(deltas, is_full_sync)
     local delta_entity = delta.entity
 
     if delta_entity ~= nil and delta_entity ~= null then
+
+      -- validate workspace id
+      local ws_id = delta_entity.ws_id or delta.ws_id
+      if not ws_id or ws_id == null then
+        if not errs[delta_type] then
+          errs[delta_type] = {}
+        end
+        insert(errs[delta_type], "workspace id not found")
+      end
+
       -- table: primary key string -> entity
       local schema = db[delta_type].schema
       local pk = schema:extract_pk_values(delta_entity)

spec/01-unit/19-hybrid/04-validate_deltas_spec.lua

@@ -134,7 +134,36 @@ describe("[delta validations]",function()
     for _, delta in ipairs(deltas) do
       local ws_id = delta.ws_id
       assert(ws_id and ws_id ~= ngx.null)
+
+      -- XXX EE: kong-ce entities exported from export_config_sync() do not
+      --         contain ws_id field, while kong-ee enntities does.
+      -- assert(delta.entity.ws_id)
+
+      -- mannually remove routes ws_id, and then validation will report error
+      if delta.type == "routes" then
+        delta.entity.ws_id = nil
+        delta.ws_id = nil
+      end
+
+      if delta.type == "services" then
+        delta.entity.ws_id = ngx.null
+        delta.ws_id = ngx.null
+      end
     end
+
+    local _, _, err_t = validate_deltas(deltas)
+
+    assert.same(err_t, {
+      code = 21,
+      fields = {
+        routes = { "workspace id not found" },
+        services = { "workspace id not found" },
+      },
+      flattened_errors = { },
+      message = 'sync deltas is invalid: {routes={"workspace id not found"},services={"workspace id not found"}}',
+      name = "sync deltas parse failure",
+      source = "kong.clustering.services.sync.validate.validate_deltas",
+    })
   end)
 
   it("route has no required field, but uses default value", function()