fix: prevent Obsidian 1.3.0 log spam (#1952)

* Partial fix to #1951

* Added a fix for the log spam for Markdown rendering (e.g. Reading
Mode) based on this instruction by licat:
https://discord.com/channels/686053708261228577/716028884885307432/1110789810160939048

Author: esm7

src/InlineRenderer.ts

@@ -1,4 +1,5 @@
 import type { MarkdownPostProcessorContext, Plugin } from 'obsidian';
+import { MarkdownRenderChild } from 'obsidian';
 import { GlobalFilter } from './Config/GlobalFilter';
 import { Task } from './Task';
 import { TaskLocation } from './TaskLocation';
@@ -15,6 +16,11 @@ export class InlineRenderer {
      * of QueryRenderer (e.g. it removes the global filter and handles other formatting).
      */
     private async _markdownPostProcessor(element: HTMLElement, context: MarkdownPostProcessorContext): Promise<void> {
+        // As of Obsidian 1.3.0, it is required by Obsidian to create and/or pass a Component object
+        // when using its Markdown rendering methods
+        const childComponent = new MarkdownRenderChild(element);
+        context.addChild(childComponent);
+
         const renderedElements = element.findAll('.task-list-item').filter((taskItem) => {
             const linesText = taskItem.textContent?.split('\n');
             if (linesText === undefined) {
@@ -96,6 +102,7 @@ export class InlineRenderer {
             const taskElement = await task.toLi({
                 parentUlElement: element,
                 listIndex,
+                obsidianComponent: childComponent,
             });
 
             // If the rendered element contains a sub-list or sub-div (e.g. the

src/QueryRenderer.ts

@@ -202,6 +202,7 @@ class QueryRenderChild extends MarkdownRenderChild {
                 layoutOptions: this.query.layoutOptions,
                 isFilenameUnique,
                 taskLayout: layout,
+                obsidianComponent: this,
             });
 
             // Remove all footnotes. They don't re-appear in another document.

src/TaskLineRenderer.ts

@@ -12,6 +12,7 @@ export type TaskLineRenderDetails = {
     parentUlElement: HTMLElement;
     /** The nth item in this list (including non-tasks). */
     listIndex: number;
+    obsidianComponent: Component | null;
     layoutOptions?: LayoutOptions;
     isFilenameUnique?: boolean;
     taskLayout?: TaskLayout;
@@ -35,10 +36,21 @@ const DAY_VALUE_OVER_RANGE_POSTFIX = 'far';
 /**
  * The function used to render a Markdown task line into an existing HTML element.
  */
-export type TextRenderer = (text: string, element: HTMLSpanElement, path: string) => Promise<void>;
-
-async function obsidianMarkdownRenderer(text: string, element: HTMLSpanElement, path: string) {
-    await MarkdownRenderer.renderMarkdown(text, element, path, null as unknown as Component);
+export type TextRenderer = (
+    text: string,
+    element: HTMLSpanElement,
+    path: string,
+    obsidianComponent: Component | null, // null is allowed here only for tests
+) => Promise<void>;
+
+async function obsidianMarkdownRenderer(
+    text: string,
+    element: HTMLSpanElement,
+    path: string,
+    obsidianComponent: Component | null,
+) {
+    if (!obsidianComponent) throw new Error('Must call the Obsidian renderer with an Obsidian Component object');
+    await MarkdownRenderer.renderMarkdown(text, element, path, obsidianComponent);
 }
 
 /**
@@ -138,7 +150,14 @@ async function taskToHtml(
                 // to do things like surrouding only the text (rather than its whole placeholder) with a highlight
                 const internalSpan = document.createElement('span');
                 span.appendChild(internalSpan);
-                await renderComponentText(internalSpan, componentString, component, task, textRenderer);
+                await renderComponentText(
+                    internalSpan,
+                    componentString,
+                    component,
+                    task,
+                    textRenderer,
+                    renderDetails.obsidianComponent,
+                );
                 const [genericClasses, dataAttributes] = getComponentClassesAndData(component, task);
                 addInternalClasses(component, internalSpan);
                 // Add the generic classes that apply to what this component is (priority, due date etc)
@@ -178,14 +197,15 @@ async function renderComponentText(
     component: TaskLayoutComponent,
     task: Task,
     textRenderer: TextRenderer,
+    obsidianComponent: Component | null,
 ) {
     if (component === 'description') {
         const { debugSettings } = getSettings();
         if (debugSettings.showTaskHiddenData) {
             // Add some debug output to enable hidden information in the task to be inspected.
             componentString += `<br>🐛 <b>${task.lineNumber}</b> . ${task.sectionStart} . ${task.sectionIndex} . '<code>${task.originalMarkdown}</code>'<br>'<code>${task.path}</code>' > '<code>${task.precedingHeader}</code>'<br>`;
         }
-        await textRenderer(componentString, span, task.path);
+        await textRenderer(componentString, span, task.path, obsidianComponent);
 
         // If the task is a block quote, the block quote wraps the p-tag that contains the content.
         // In that case, we need to unwrap the p-tag *inside* the surrounding block quote.

tests/TaskLineRenderer.test.ts

@@ -33,6 +33,7 @@ async function createMockParentAndRender(task: Task, layoutOptions?: LayoutOptio
             parentUlElement: parentElement,
             listIndex: 0,
             layoutOptions: layoutOptions,
+            obsidianComponent: null,
         },
         mockTextRenderer,
     );