Skip to content

fix: notion-compat page title missing richtext causes convert failure #629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bycaldr
Copy link

@bycaldr bycaldr commented May 2, 2025

Description

Since I upgraded from v6 to the latest v7, I found an unexpected issue with notion-compat API client.

(I'm not an expert on Notion API, so sorry for the possibly incorrect description) My Notion page has for some reason title as plaintext, not rich_text and then convertRichText() fails due undefined parameter: Cannot read properties of undefined (reading 'map').

I added this basic check, which fixed the case on my project.

Notion Test Page ID

Notion page ID: 1e4b49ae084b809597f6c5bd5167d82c

Copy link

vercel bot commented May 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
react-notion-x ❌ Failed (Inspect) May 2, 2025 0:54am
react-notion-x-minimal-demo ✅ Ready (Inspect) Visit Preview May 2, 2025 0:54am

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @bycaldr, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request addresses an issue in the notion-compat API client where pages with a plaintext title (instead of rich_text) cause a conversion failure. The change adds a check to ensure that page.properties.title exists and has the rich_text property before attempting to convert it, preventing the Cannot read properties of undefined (reading 'map') error.

Highlights

  • Bug Fix: Addresses a conversion failure in notion-compat when a Notion page title is plaintext instead of rich_text.
  • Defensive Check: Adds a check for page.properties.title?.rich_text to prevent errors when the rich_text property is missing.

Changelog

  • packages/notion-compat/src/convert-block.ts
    • Added a check for page.properties.title?.rich_text on line 228 to avoid errors when the rich_text property is missing.
    • This prevents the code from attempting to read the map property of an undefined value, resolving the reported issue.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


A Notion page's plight,
Title's plaintext, not rich text bright,
A simple check's grace,
Error erased from its face,
Now conversions take flight.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a critical issue where the convertRichText() function fails when a Notion page title is in plaintext format instead of rich_text. The added check seems to resolve the problem effectively. However, I have a suggestion to improve the code's robustness and clarity.

Summary of Findings

  • Nullish Coalescing and Type Assertion: The current check page.properties.title?.rich_text effectively prevents the error. However, it might be beneficial to add a more explicit check for the type of page.properties.title to ensure that it is indeed a rich_text object before attempting to access its rich_text property. This would add an extra layer of safety and prevent potential issues if the title property has an unexpected structure.

Merge Readiness

The provided fix addresses a critical issue and prevents a runtime error. However, to ensure the robustness of the code, I suggest incorporating the proposed code suggestion to explicitly check the type of page.properties.title. Once this is addressed, the pull request will be ready for merging. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.

Comment on lines +228 to 231
if (page.properties.title?.rich_text) {
compatBlock.properties.title = convertRichText(
(page.properties.title as any).rich_text
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While the nullish coalescing operator (?.) prevents the error, it might be beneficial to add a more explicit check for the type of page.properties.title to ensure that it is indeed a rich_text object before attempting to access its rich_text property. This would add an extra layer of safety and prevent potential issues if the title property has an unexpected structure.

          if (
            page.properties.title &&
            typeof page.properties.title === 'object' &&
            'rich_text' in page.properties.title
          ) {
            compatBlock.properties.title = convertRichText(
              (page.properties.title as any).rich_text
            )
          }

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant