feat: improve logging output

- add performance stats for rendering pages
- add debug output for begin/end page rendering, this makes it easier
  to spot where errors occured during rendering albeit this is not a
  replacement for adding proper error handling down the road

Author: JohannesRudolph

src/ChildDatabaseRenderer.ts

@@ -1,14 +1,16 @@
-import { Client } from "@notionhq/client/build/src";
-import { Page } from "@notionhq/client/build/src/api-types";
-
-import { SyncConfig } from "./";
-import { lookupDatabaseConfig } from "./config";
-import { Database } from "./Database";
-import { DatabaseViewRenderer } from "./DatabaseViewRenderer";
-import { DeferredRenderer } from "./DeferredRenderer";
-import { RenderDatabasePageTask } from "./RenderDatabasePageTask";
-import { DatabaseConfig, DatabaseConfigRenderPages, DatabaseConfigRenderTable } from "./SyncConfig";
-import { DatabaseTableRenderer } from "./DatabaseTableRenderer";
+import { Client } from '@notionhq/client/build/src';
+import { Page } from '@notionhq/client/build/src/api-types';
+
+import { SyncConfig } from './';
+import { lookupDatabaseConfig } from './config';
+import { Database } from './Database';
+import { DatabaseTableRenderer } from './DatabaseTableRenderer';
+import { DatabaseViewRenderer } from './DatabaseViewRenderer';
+import { DeferredRenderer } from './DeferredRenderer';
+import { RenderDatabasePageTask } from './RenderDatabasePageTask';
+import { DatabaseConfig, DatabaseConfigRenderPages, DatabaseConfigRenderTable } from './SyncConfig';
+
+const debug = require("debug")("child-database");
 
 export class ChildDatabaseRenderer {
   constructor(
@@ -17,16 +19,17 @@ export class ChildDatabaseRenderer {
     private readonly deferredRenderer: DeferredRenderer,
     private readonly tableRenderer: DatabaseTableRenderer,
     private readonly viewRenderer: DatabaseViewRenderer
-  ) {}
+  ) { }
 
   async renderChildDatabase(databaseId: string): Promise<Database> {
     const dbConfig = lookupDatabaseConfig(this.config, databaseId);
 
     // no view was defined for this database, render as a plain inline table
     const allPages = await this.fetchPages(databaseId, dbConfig);
 
-    const isCmsDb = this.config.cmsDatabaseId === databaseId;
-    const renderPages = isCmsDb || dbConfig.renderAs === "pages+views"
+    const renderPages = dbConfig.renderAs === "pages+views"
+
+    debug("rendering child database " + databaseId + " as " + dbConfig.renderAs);
 
     if (renderPages) {
       const pageConfig = dbConfig as DatabaseConfigRenderPages;

src/DatabasePageRenderer.ts

@@ -1,15 +1,16 @@
-import * as fsc from "fs";
+import * as fsc from 'fs';
+import { performance } from 'perf_hooks';
 
-import { Page } from "@notionhq/client/build/src/api-types";
+import { Page } from '@notionhq/client/build/src/api-types';
 
-import { AssetWriter } from "./AssetWriter";
-import { FrontmatterRenderer } from "./FrontmatterRenderer";
-import { logger } from "./logger";
-import { PropertiesParser } from "./PropertiesParser";
-import { RecursiveBodyRenderer } from "./RecursiveBodyRenderer";
-import { RenderDatabasePageTask as RenderDatabasePageTask } from "./RenderDatabasePageTask";
-import { slugify } from "./slugify";
-import { DatabaseConfigRenderPages } from "./SyncConfig";
+import { AssetWriter } from './AssetWriter';
+import { FrontmatterRenderer } from './FrontmatterRenderer';
+import { logger } from './logger';
+import { PropertiesParser } from './PropertiesParser';
+import { RecursiveBodyRenderer } from './RecursiveBodyRenderer';
+import { RenderDatabasePageTask as RenderDatabasePageTask } from './RenderDatabasePageTask';
+import { slugify } from './slugify';
+import { DatabaseConfigRenderPages } from './SyncConfig';
 
 const fs = fsc.promises;
 
@@ -45,6 +46,8 @@ export class DatabasePageRenderer {
       file,
       properties: props,
       render: async () => {
+        const start = performance.now()
+
         const assetWriter = new AssetWriter(destDir);
 
         const frontmatter = this.frontmatterRenderer.renderFrontmatter(props);
@@ -53,7 +56,10 @@ export class DatabasePageRenderer {
         await fs.mkdir(destDir, { recursive: true });
         await fs.writeFile(file, frontmatter + body);
 
-        logger.info("wrote: " + file);
+        // note: this is excluding the time it takes to fetch properties
+        const elapsed = performance.now() - start;
+        
+        logger.info("rendered: " + file + " in " + Math.round(elapsed) + "ms.");
       },
     };
   }

src/DatabaseViewRenderer.ts

@@ -1,11 +1,11 @@
-import { LinkRenderer } from "./LinkRenderer";
-import * as markdownTable from "./markdown-table";
-import { PropertiesParser } from "./PropertiesParser";
-import { RenderDatabasePageTask } from "./RenderDatabasePageTask";
-import { DatabaseConfigRenderPages, DatabaseView } from "./SyncConfig";
-import { DatabaseTableRenderer } from "./DatabaseTableRenderer";
+import { DatabaseTableRenderer } from './DatabaseTableRenderer';
+import { LinkRenderer } from './LinkRenderer';
+import * as markdownTable from './markdown-table';
+import { PropertiesParser } from './PropertiesParser';
+import { RenderDatabasePageTask } from './RenderDatabasePageTask';
+import { DatabaseConfigRenderPages, DatabaseView } from './SyncConfig';
 
-const debug = require("debug")("database");
+const debug = require("debug")("database-views");
 
 // todo: name afte what it renders, not to where
 export class DatabaseViewRenderer {

src/DeferredRenderer.ts

@@ -1,18 +1,15 @@
-import { Page } from "@notionhq/client/build/src/api-types";
-
-import { ChildDatabaseRenderer } from "./ChildDatabaseRenderer";
-import { logger } from "./logger";
-import { DatabasePageRenderer } from "./DatabasePageRenderer";
-import { RenderedDatabaseEntry } from "./RenderedDatabaseEntry";
-import { RenderedDatabasePage } from "./RenderedDatabasePage";
-import { RenderDatabasePageTask as RenderDatabasePageTask } from "./RenderDatabasePageTask";
-import { RenderDatabaseEntryTask } from "./RenderDatabaseEntryTask";
-import {
-  DatabaseConfigRenderPages,
-  DatabaseConfigRenderTable,
-} from "./SyncConfig";
-import { Database } from "./Database";
-import { DatabaseEntryRenderer } from "./DatabaseEntryRenderer";
+import { Page } from '@notionhq/client/build/src/api-types';
+
+import { ChildDatabaseRenderer } from './ChildDatabaseRenderer';
+import { Database } from './Database';
+import { DatabaseEntryRenderer } from './DatabaseEntryRenderer';
+import { DatabasePageRenderer } from './DatabasePageRenderer';
+import { logger } from './logger';
+import { RenderDatabaseEntryTask } from './RenderDatabaseEntryTask';
+import { RenderDatabasePageTask as RenderDatabasePageTask } from './RenderDatabasePageTask';
+import { RenderedDatabaseEntry } from './RenderedDatabaseEntry';
+import { RenderedDatabasePage } from './RenderedDatabasePage';
+import { DatabaseConfigRenderPages, DatabaseConfigRenderTable } from './SyncConfig';
 
 const debug = require("debug")("rendering");
 

src/RecursiveBodyRenderer.ts

@@ -1,8 +1,10 @@
-import { Client } from "@notionhq/client";
-import { Block, Page } from "@notionhq/client/build/src/api-types";
+import { Client } from '@notionhq/client';
+import { Block, Page } from '@notionhq/client/build/src/api-types';
 
-import { AssetWriter } from "./AssetWriter";
-import { BlockRenderer } from "./BlockRenderer";
+import { AssetWriter } from './AssetWriter';
+import { BlockRenderer } from './BlockRenderer';
+
+const debug = require("debug")("body");
 
 export class RecursiveBodyRenderer {
   constructor(
@@ -14,6 +16,8 @@ export class RecursiveBodyRenderer {
     page: Page,
     assets: AssetWriter
   ): Promise<string> {
+    debug("begin rendering body of page " + page.id, page.properties);
+
     const childs = await this.publicApi.blocks.children.list({
       block_id: page.id,
     });
@@ -25,6 +29,8 @@ export class RecursiveBodyRenderer {
     const blocks = await Promise.all(renderChilds);
     const body = blocks.join("\n\n");
 
+    debug("completed rendering body of page " + page.id);
+
     return body;
   }