publisher: rework page property processing

Calls to `get_page_property` should return `None` for non-entries on a
page. This was the original intent with the implementation, but final
tweaks for initial APIv2 support made the default result a partially
populated property instance. This commit cleans up this to restore the
original intent to have undefined properties return `None`, as well as
updates various locations to use a default property value for each
applicable section. Specifically:

- `CB_PROP_KEY` returns a prepared empty value dictionary, since the
   requests will push up a new property change
- Property fetching for v2 will return a `None` populated value to
   explicitly indicate that the requests should support this type of
   metadata, as well as that Confluence has reported no value exists
- Update events will populate with a fallback value `None`, which will
   be updated with the provided property value for the expected change
   to the property value.

Signed-off-by: James Knight <[email protected]>
(cherry picked from commit 8bd8137)

Author: jdknight

sphinxcontrib/confluencebuilder/publisher.py

@@ -601,7 +601,9 @@ def get_page(self, page_name, expand='version', status='current'):
                 props_to_fetch.append('editor')
 
             for prop_key in props_to_fetch:
-                prop_entry = self.get_page_property(page_id, prop_key)
+                prop_entry = self.get_page_property(page_id, prop_key, {
+                    'value': None,
+                })
                 meta_props[prop_key] = prop_entry
 
         return page_id, page
@@ -700,9 +702,7 @@ def get_page_property(self, page_id, key, default=None):
             the property value
         """
 
-        props = {
-            'value': default,
-        }
+        props = default
 
         if page_id:
             try:
@@ -930,7 +930,9 @@ def store_page(self, page_name, data, parent_id=None):
 
         # fetch known properties (associated with this extension) from the page
         page_id = page['id'] if page else None
-        cb_props = self.get_page_property(page_id, CB_PROP_KEY, {})
+        cb_props = self.get_page_property(page_id, CB_PROP_KEY, {
+            'value': {},
+        })
 
         # calculate the hash for a page; we will first use this to check if
         # there is a update to apply, and if we do need to update, we will
@@ -986,8 +988,8 @@ def store_page(self, page_name, data, parent_id=None):
 
         # if we are not force uploading, check if the new page hash matches
         # the remote hash; if so, do not publish
-        if cb_props and not force_publish:
-            remote_hash = cb_props.get('value', {}).get('hash')
+        if not force_publish:
+            remote_hash = cb_props['value'].get('hash')
             if new_page_hash == remote_hash:
                 logger.verbose(f'no changes in page: {page_name}')
                 return page['id']
@@ -1148,7 +1150,9 @@ def store_page_by_id(self, page_name, page_id, data):
             raise ConfluenceMissingPageIdError(self.space_key, page_id) from ex
 
         # fetch known properties (associated with this extension) from the page
-        cb_props = self.get_page_property(page_id, CB_PROP_KEY, {})
+        cb_props = self.get_page_property(page_id, CB_PROP_KEY, {
+            'value': {},
+        })
 
         # calculate the hash for a page; we will first use this to check if
         # there is a update to apply, and if we do need to update, we will
@@ -1157,8 +1161,8 @@ def store_page_by_id(self, page_name, page_id, data):
 
         # if we are not force uploading, check if the new page hash matches
         # the remote hash; if so, do not publish
-        if cb_props and not self.config.confluence_publish_force:
-            remote_hash = cb_props.get('value', {}).get('hash')
+        if not self.config.confluence_publish_force:
+            remote_hash = cb_props['value'].get('hash')
             if new_page_hash == remote_hash:
                 logger.verbose(f'no changes in page: {page_name}')
                 return page_id
@@ -1208,7 +1212,9 @@ def _update_page_properties(self, page_id, properties):
             attempt = 1
             while attempt <= MAX_ATTEMPTS_TO_UPDATE_PROPERTY:
                 prop_key = prop['key']
-                prop_entry = self.get_page_property(page_id, prop_key)
+                prop_entry = self.get_page_property(page_id, prop_key, {
+                    'value': None,
+                })
 
                 # ignore if the property already matches the desired
                 # value