KV Value Update handles Data wrongly

Open
#2,519 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
api, backend

Research direction

Start at the values.update() and metadata.get() entry points and inspect how value, metadata, and Content-Type are sent. Reproduce the request with both fields, then add regression coverage for the intended metadata behavior. Done means metadata is stored separately and values.get() no longer returns it as part of the value.

Written by the indexing model from the issue text.

Description

Confirm this is a Python library issue and not an underlying Cloudflare API issue.
  • This is an issue with the Python library
Describe the bug

When trying to set a value in the KV Store metadata needs to be provided, but gets merged into the value and no meta data gets set.

In [29]: response = client.kv.namespaces.values.update(key_name="test", value="MY VALUE", metadata="{}", **kv.params)

In [30]: print(client.kv.namespaces.values.get(key_name="test",  **kv.params).text())
{"metadata":"{}","value":"MY VALUE"}

In [31]: print(client.kv.namespaces.metadata.get(key_name="test",  **kv.params) is None)
True

The problem seems to be caused from the whole body of the request being used as the actual value. The behaviour seems to be correct when manually specifying the request's content tye as multipart/form-data:

In [38]: response = client.kv.namespaces.values.update(key_name="test", value="MY VALUE", metadata="{}", **kv.params, extra_headers={"Content-Type": "multipart/form-data"})

In [39]: print(client.kv.namespaces.values.get(key_name="test",  **kv.params).text())
MY VALUE

In [40]: print(client.kv.namespaces.metadata.get(key_name="test",  **kv.params))
{}

This should probably be the default behaviour as it shouldn't be necessary to explicitly override the content type. On the other hand metadata should not be required in which case the whole body could be set as value

To Reproduce
  1. Call values.update() with a value and metadata. Both are set as the actual value.
  2. metadata.get() doesn't return any metadata.
  3. Metadata is returned with the value upon calling values.get().
Code snippets

OS

Every OS

Python version

3.12

Library version

v4.0.0

Dominant language
Python
Stars
509
Forks
150
Avg merge
3h 15m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudflare/cloudflare-python

All issues in cloudflare/cloudflare-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.