fix(endpoint-micropub): add debug logs (remove from PR)

packages/endpoint-micropub/lib/controllers/action.js

@@ -1,10 +1,13 @@
+import makeDebug from "debug";
 import { IndiekitError } from "@indiekit/error";
 import { formEncodedToJf2, mf2ToJf2 } from "../jf2.js";
 import { postContent } from "../post-content.js";
 import { postData } from "../post-data.js";
 import { checkScope } from "../scope.js";
 import { uploadMedia } from "../media.js";
 
+const debug = makeDebug(`indiekit:endpoint-micropub:controllers:action`);
+
 /**
  * Perform requested post action
  * @type {import("express").RequestHandler}
@@ -41,6 +44,7 @@ export const actionController = async (request, response, next) => {
     let content;
     switch (action) {
       case "create": {
+        debug(`create and normalise JF2 data %O`, body);
         // Create and normalise JF2 data
         jf2 = request.is("json")
           ? await mf2ToJf2(body, publication.enrichPostData)
@@ -57,6 +61,7 @@ export const actionController = async (request, response, next) => {
       }
 
       case "update": {
+        debug(`update URL ${url} with body %O`, body);
         // Check for update operations
         if (!(body.replace || body.add || body.remove)) {
           throw IndiekitError.badRequest(
@@ -94,12 +99,14 @@ export const actionController = async (request, response, next) => {
       }
 
       case "delete": {
+        debug(`delete URL ${url}`);
         data = await postData.delete(application, publication, url);
         content = await postContent.delete(publication, data);
         break;
       }
 
       case "undelete": {
+        debug(`undelete URL ${url}`);
         data = await postData.undelete(
           application,
           publication,

packages/endpoint-micropub/lib/post-data.js

@@ -80,10 +80,12 @@ export const postData = {
     const { posts } = application;
     const query = { "properties.url": url };
 
+    debug(`try finding MongoDB document matching query %O`, query);
     const postData = await posts.findOne(query);
     if (!postData) {
       throw IndiekitError.notFound(url);
     }
+    debug(`found MongoDB document matching query %O`, postData);
 
     return postData;
   },

packages/endpoint-micropub/lib/update.js

@@ -1,13 +1,17 @@
+import makeDebug from "debug";
 import _ from "lodash";
 import { mf2ToJf2 } from "./jf2.js";
 
+const debug = makeDebug("indiekit:endpoint-micropub:update");
+
 /**
  * Add properties to object
  * @param {object} object - Object to update
  * @param {object} additions - Properties to add (mf2)
  * @returns {object|undefined} Updated object
  */
 export const addProperties = (object, additions) => {
+  debug(`addProperties %O`, { object, additions });
   for (const key in additions) {
     if (Object.prototype.hasOwnProperty.call(additions, key)) {
       const newValue = additions[key];
@@ -45,6 +49,7 @@ export const addProperties = (object, additions) => {
  * @returns {Promise<object>} Updated object (JF2)
  */
 export const replaceEntries = async (object, replacements) => {
+  debug(`replaceEntries %O`, { object, replacements });
   for await (const [key, value] of Object.entries(replacements)) {
     if (!Array.isArray(value)) {
       throw new TypeError("Replacement value should be an array");
@@ -82,6 +87,7 @@ export const replaceEntries = async (object, replacements) => {
  * @returns {object} Updated object
  */
 export const deleteEntries = (object, deletions) => {
+  debug(`replaceEntries %O`, { object, deletions });
   for (const key in deletions) {
     if (Object.prototype.hasOwnProperty.call(deletions, key)) {
       const valuesToDelete = deletions[key];
@@ -120,6 +126,7 @@ export const deleteEntries = (object, deletions) => {
  * @returns {object} Updated object
  */
 export const deleteProperties = (object, deletions) => {
+  debug(`deleteProperties %O`, { object, deletions });
   for (const key of deletions) {
     delete object[key];
   }