fix(db2): stop truncating table comments to one character

[rusackas]

SUMMARY

Db2EngineSpec.get_table_comment indexes into the returned comment with comment[0], based on a comment saying "Ibm Db2 return comments as tuples, so we need to get the first element."

That was true for older ibm_db_sa, but it was fixed upstream in ibmdb/python-ibmdbsa#135 (merged 2023-07-04, first released in v0.4.1): get_table_comment now returns a plain string, not a tuple.

Superset's own dependency pin (ibm-db-sa<=0.4.4, >=0.4.4 in pyproject.toml) already requires that fixed version. So today, comment[0] is indexing into a plain string and returning only its first character — every DB2 table comment gets silently truncated to one character, with no error (the except IndexError only fires when the comment is empty).

BEFORE/AFTER

Before:

comment = None
try:
    table_comment = inspector.get_table_comment(table.table, table.schema)
    comment = table_comment.get("text")
    return comment[0]
except IndexError:
    return comment

A table comment of "Customer records" returns "C".

After:

comment = None
try:
    table_comment = inspector.get_table_comment(table.table, table.schema)
    return table_comment.get("text")

Returns the full "Customer records".

TESTING INSTRUCTIONS

pytest tests/unit_tests/db_engine_specs/test_db2.py -v

Updated test_get_table_comment to mock the current (string-returning) ibm_db_sa shape instead of the old tuple shape. Confirmed the updated test fails against the pre-fix code (returns "T" instead of the full string) and passes with the fix.

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration
• Introduces new feature or API
• Removes existing feature or API

[bito-code-review]

Code Review Agent Run #369752

Actionable Suggestions - 0

Additional Suggestions - 1

• superset/db_engine_specs/db2.py - 1

  • Dead variable initialization · Line 132-132
    Remove the unused `comment = None` initialization at the start of the method and add an explicit `return None` inside the exception handler to clearly indicate the function returns `None` on errors.

Filtered by Review Rules

Bito filtered these suggestions based on rules created automatically for your feedback. Manage rules.

• superset/db_engine_specs/db2.py - 1

  • Missing None guard for dict access · Line 135-135

Review Details

• Files reviewed - 2 · Commit Range: 9404d6e..9404d6e

  • superset/db_engine_specs/db2.py
  • tests/unit_tests/db_engine_specs/test_db2.py
• Files skipped - 0
• Tools

  • MyPy (Static Code Analysis) - ✔︎ Successful
  • Astral Ruff (Static Code Analysis) - ✔︎ Successful
  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[codecov]

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 65.44%. Comparing base (6279caf) to head (c3ea4f3).
⚠️ Report is 21 commits behind head on master.

Files with missing lines	Patch %	Lines
superset/db_engine_specs/db2.py	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #42645      +/-   ##
==========================================
- Coverage   65.44%   65.44%   -0.01%     
==========================================
  Files        2810     2810              
  Lines      159349   159358       +9     
  Branches    36368    36372       +4     
==========================================
+ Hits       104290   104291       +1     
- Misses      53016    53024       +8     
  Partials     2043     2043              

Flag	Coverage Δ
hive	38.09% <0.00%> (-0.01%)	⬇️
mysql	57.82% <0.00%> (-0.01%)	⬇️
postgres	57.87% <0.00%> (-0.01%)	⬇️
presto	39.98% <0.00%> (-0.01%)	⬇️
python	59.25% <0.00%> (-0.01%)	⬇️
sqlite	57.50% <0.00%> (-0.01%)	⬇️
unit	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rusackas]

Good catch, fixed!

[netlify]

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	b8ce10f
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/6a6cdd68a3bd030008e01b8d
😎 Deploy Preview	https://deploy-preview-42645--superset-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

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

[bito-code-review]

Bito Automatic Review Skipped – PR Already Merged

Bito scheduled an automatic review for this pull request, but the review was skipped because this PR was merged before the review could be run.
No action is needed if you didn't intend to review it. To get a review, you can type /review in a comment and save it