feat(taps,targets): Support the x-singer.decimal JSON Schema extension

[edgarrmondragon]

TODO:

• Docs
• Capability/Built-in setting

Related:

• Closes feat: Support Singer Decimal as a config item #1890

---

📚 Documentation preview 📚: https://meltano-sdk--2786.org.readthedocs.build/en/2786/

Summary by Sourcery

Adds support for the singer.decimal JSON Schema extension. This allows numbers to be represented as strings with the singer.decimal format instead of as numbers. A new use_singer_decimal option is added to the SQLToJSONSchema class to control whether numbers are represented as string with the singer.decimal format or as number.

New Features:

• Adds support for the singer.decimal JSON Schema extension, allowing numbers to be represented as strings with the singer.decimal format instead of as numbers.

Enhancements:

• Adds a use_singer_decimal option to the SQLToJSONSchema class to control whether numbers are represented as string with the singer.decimal format or as number.

Tests:

• Adds a test case for converting numeric types to singer.decimal format.
• Adds a test case for converting singer.decimal types to SQLAlchemy DECIMAL types.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.37%. Comparing base (aa9b2b2) to head (d710ac4).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2786      +/-   ##
==========================================
+ Coverage   91.35%   91.37%   +0.02%     
==========================================
  Files          63       63              
  Lines        5214     5227      +13     
  Branches      675      676       +1     
==========================================
+ Hits         4763     4776      +13     
  Misses        319      319              
  Partials      132      132              

☔ View full report in Codecov by Sentry.
📢 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.

[codspeed-hq]

CodSpeed Performance Report

Merging #2786 will not alter performance

_{Comparing edgarrmondragon/feat/singer-decimal (d710ac4) with main (aa9b2b2)}

Summary

✅ 7 untouched benchmarks

[s7clarke10]

That's awesome, thanks once again @edgarrmondragon 🙌

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces support for the singer.decimal JSON Schema extension. It modifies the SQLToJSONSchema class to allow representing numeric values as strings with the singer.decimal format. It also modifies the JSONSchemaToSQL class to handle the singer.decimal format and return the appropriate SQLAlchemy type. Finally, it adds a SingerDecimalType to typing.py.

Class diagram for SingerDecimalType

classDiagram
  class SingerDecimalType {
    +string_format = "singer.decimal"
  }
  SingerDecimalType --|> StringType
  class StringType

Loading

File-Level Changes

Change	Details	Files
Added support for the singer.decimal JSON Schema extension, allowing numeric values to be represented as strings with a specific format.	Added use_singer_decimal parameter to SQLToJSONSchema to control whether numbers are represented as string with the singer.decimal format. Implemented float_to_jsonschema to return SingerDecimalType when use_singer_decimal is enabled. Added _handle_singer_decimal to JSONSchemaToSQL to handle the singer.decimal format and return the appropriate SQLAlchemy type. Added SingerDecimalType to typing.py.	singer_sdk/connectors/sql.py tests/core/test_connector_sql.py singer_sdk/typing.py

Possibly linked issues

• feat: Support Singer Decimal as a config item #1890: The PR closes the issue by adding support for the singer.decimal format, allowing users to represent decimals as strings.
• feat: Support Singer Decimal as a config item #1890: The PR closes the issue by adding support for the singer.decimal format, resolving the schema ambiguity.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @edgarrmondragon - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a default value for max_varchar_length in the JSONSchemaToSQL constructor to avoid breaking changes.
• It might be worth adding a test case that checks the precision and scale are passed through correctly to the SQLAlchemy DECIMAL type.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 2 issues found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[edgarrmondragon]

@sourcery-ai review