[YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE #28549

HasithDeAlwis · 2025-09-10T22:18:42Z

Closes #27319

Summary

Add lint checks for Form/FormData pairs and handle type transformations

Enhancements:

Validate that each Form_* type in yb_typedefs.list has a corresponding FormData_* entry and vice versa
Ensure YB_DEFINE_HANDLE_TYPE macros correspond to Ybc-prefixed types in yb_typedefs.list

netlify · 2025-09-10T22:20:35Z

✅ Deploy Preview for infallible-bardeen-164bc9 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`08d9c42`
🔍 Latest deploy log	https://app.netlify.com/projects/infallible-bardeen-164bc9/deploys/68c1f9443a7f170008f71187
😎 Deploy Preview	https://deploy-preview-28549--infallible-bardeen-164bc9.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

HasithDeAlwis · 2025-09-10T22:21:51Z

src/lint/typedefs_list.sh

+    fi
+  done
+
+  find src -name '*.h' -exec grep -l 'YB_DEFINE_HANDLE_TYPE' {} \; 2>/dev/null | \


This check adds a lot of time (around 4 seconds on my Mac). Are we ok with this?

YB_DEFINE_HANDLE_TYPE is only used in src/yb/yql/pggate/ybc_pg_typedefs.h, so it feels almost odd to check the entire src/ directory.

please only check src/yb/yql/pggate: grep -rl YB_DEFINE_HANDLE_TYPE src/yb/yql/pggate

jasonyb

arc lint src/postgres/src/tools/pgindent/yb_typedefs.list to test

jasonyb · 2025-09-12T18:57:03Z

src/lint/typedefs_list.sh

+    fi
+  done
+
+  find src -name '*.h' -exec grep -l 'YB_DEFINE_HANDLE_TYPE' {} \; 2>/dev/null | \


please only check src/yb/yql/pggate: grep -rl YB_DEFINE_HANDLE_TYPE src/yb/yql/pggate

jasonyb · 2025-09-12T20:01:39Z

src/lint/typedefs_list.sh

+  grep -o 'Form_[a-zA-Z0-9_]*' "$1" | while read -r form; do
+    formdata="FormData_${form#Form_}"
+    if ! grep -q "^$formdata$" "$1"; then
+      echo "error:missing_FormData:$formdata is missing for $form"


Suggested change

echo "error:missing_FormData:$formdata is missing for $form"

echo "error:missing_formdata:$formdata is missing for $form"

jasonyb · 2025-09-12T20:01:47Z

src/lint/typedefs_list.sh

+  grep -o 'FormData_[a-zA-Z0-9_]*' "$1" | while read -r formdata; do
+    form="Form_${formdata#FormData_}"
+    if ! grep -q "^$form$" "$1"; then
+      echo "error:missing_Form:$form is missing for $formdata"


Suggested change

echo "error:missing_Form:$form is missing for $formdata"

echo "error:missing_form:$form is missing for $formdata"

jasonyb · 2025-09-12T20:05:06Z

src/lint/typedefs_list.sh

+    sed 's/YB_DEFINE_HANDLE_TYPE(//' | sed 's/)//' | sort -u | while read -r handle_type; do
+      transformed_type="Ybc${handle_type}"
+      if ! grep -q "^$transformed_type$" "$1"; then
+        echo "error:missing_handle_type:$transformed_type is missing for YB_DEFINE_HANDLE_TYPE($handle_type)"


line too long

jasonyb · 2025-09-12T23:25:25Z

src/lint/typedefs_list.sh

+  grep -o 'Form_[a-zA-Z0-9_]*' "$1" | while read -r form; do
+    formdata="FormData_${form#Form_}"
+    if ! grep -q "^$formdata$" "$1"; then
+      echo "error:missing_FormData:$formdata is missing for $form"


diff --git i/src/postgres/src/tools/pgindent/yb_typedefs.list w/src/postgres/src/tools/pgindent/yb_typedefs.list index 53ecb19f4b..86c2d322f1 100644 --- i/src/postgres/src/tools/pgindent/yb_typedefs.list +++ w/src/postgres/src/tools/pgindent/yb_typedefs.list @@ -1,6 +1,5 @@ FormData_pg_yb_migration FormData_pg_yb_profile -FormData_pg_yb_role_profile FormData_pg_yb_tablegroup FormData_yb_pg_catalog_version FormData_yb_pg_invalidation_messages

does not cause lint failure. you are missing filename and line number from the message

jasonyb · 2025-09-12T23:25:38Z

src/lint/typedefs_list.sh

@@ -25,6 +25,29 @@ if [[ "$1" == */yb_typedefs.list ]]; then
  grep -Env "$pattern" "$1" \
    | sed 's/^/error:missing_yb_in_type_name:'\
 'Types in yb_typedefs.list should have "yb":/'
+
+  grep -o 'Form_[a-zA-Z0-9_]*' "$1" | while read -r form; do


Suggested change

grep -o 'Form_[a-zA-Z0-9_]*' "$1" | while read -r form; do

grep -o '^Form_[a-zA-Z0-9_]*' "$1" | while read -r form; do

jasonyb · 2025-09-12T23:25:49Z

src/lint/typedefs_list.sh

+    fi
+  done
+
+  grep -o 'FormData_[a-zA-Z0-9_]*' "$1" | while read -r formdata; do


Suggested change

grep -o 'FormData_[a-zA-Z0-9_]*' "$1" | while read -r formdata; do

grep -o '^FormData_[a-zA-Z0-9_]*' "$1" | while read -r formdata; do

jasonyb · 2025-09-12T23:26:13Z

src/lint/typedefs_list.sh

+  grep -o 'FormData_[a-zA-Z0-9_]*' "$1" | while read -r formdata; do
+    form="Form_${formdata#FormData_}"
+    if ! grep -q "^$form$" "$1"; then
+      echo "error:missing_Form:$form is missing for $formdata"


diff --git i/src/postgres/src/tools/pgindent/yb_typedefs.list w/src/postgres/src/tools/pgindent/yb_typedefs.list index 53ecb19f4b..f16a49fe48 100644 --- i/src/postgres/src/tools/pgindent/yb_typedefs.list +++ w/src/postgres/src/tools/pgindent/yb_typedefs.list @@ -9,7 +9,6 @@ Form_pg_yb_migration Form_pg_yb_profile Form_pg_yb_role_profile Form_pg_yb_tablegroup -Form_yb_pg_catalog_version Form_yb_pg_invalidation_messages Form_yb_pg_logical_client_version YBExecuteMessageFunctorContext

does not cause lint failure for same reason

jasonyb · 2025-09-12T23:26:35Z

src/lint/typedefs_list.sh

+    sed 's/YB_DEFINE_HANDLE_TYPE(//' | sed 's/)//' | sort -u | while read -r handle_type; do
+      transformed_type="Ybc${handle_type}"
+      if ! grep -q "^$transformed_type$" "$1"; then
+        echo "error:missing_handle_type:$transformed_type is missing for YB_DEFINE_HANDLE_TYPE($handle_type)"


diff --git i/src/postgres/src/tools/pgindent/yb_typedefs.list w/src/postgres/src/tools/pgindent/yb_typedefs.list index 53ecb19f4b..c655a151ab 100644 --- i/src/postgres/src/tools/pgindent/yb_typedefs.list +++ w/src/postgres/src/tools/pgindent/yb_typedefs.list @@ -267,7 +267,6 @@ YbcPgSession YbcPgSessionState YbcPgSessionTxnInfo YbcPgSplitDatum -YbcPgStatement YbcPgSysColumns YbcPgSysTablePrefetcherCacheMode YbcPgTableDesc

does not cause lint failure for same reason

HasithDeAlwis added 2 commits September 5, 2025 12:00

feat(linters): add check sfor Form_* and FromData_*

7746ead

feat(linters): add check for YB_DEFINE_HANDLE_TYPE

08d9c42

HasithDeAlwis changed the title ~~Add linter check for form yb defs~~ [YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE Sep 10, 2025

HasithDeAlwis commented Sep 10, 2025

View reviewed changes

jasonyb requested changes Sep 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE #28549

[YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE #28549

HasithDeAlwis commented Sep 10, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 10, 2025

Uh oh!

HasithDeAlwis Sep 10, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb left a comment

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

jasonyb Sep 12, 2025

Uh oh!

Uh oh!

	echo "error:missing_FormData:$formdata is missing for $form"
	echo "error:missing_formdata:$formdata is missing for $form"

	echo "error:missing_Form:$form is missing for $formdata"
	echo "error:missing_form:$form is missing for $formdata"

	grep -o 'Form_[a-zA-Z0-9_]*' "$1" \| while read -r form; do
	grep -o '^Form_[a-zA-Z0-9_]*' "$1" \| while read -r form; do

	grep -o 'FormData_[a-zA-Z0-9_]*' "$1" \| while read -r formdata; do
	grep -o '^FormData_[a-zA-Z0-9_]*' "$1" \| while read -r formdata; do

[YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE #28549

Are you sure you want to change the base?

[YSQL] add lint rule for yb_typedefs.list Form_* and YB_DEFINE_HANDLE_TYPE #28549

Conversation

HasithDeAlwis commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

netlify bot commented Sep 10, 2025

✅ Deploy Preview for infallible-bardeen-164bc9 ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jasonyb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HasithDeAlwis commented Sep 10, 2025 •

edited

Loading