Skip to content
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

Use native unicode data types for notification templates #6078

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

darshanasbg
Copy link
Contributor

@darshanasbg darshanasbg commented Oct 29, 2024

Proposed changes in this pull request

$subject.

  • Used native unicode data types for the supported databases like oracle & mssql.
  • Added a config to indicate the native datatype support.

Config

[NotificationTemplates]
UseUnicodeDataTypes = true

When should this PR be merged

Immediate

Follow up actions

Merge,

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly?

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes should be documented.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

Copy link

codecov bot commented Oct 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.80%. Comparing base (0d53ca2) to head (4041f72).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #6078   +/-   ##
=========================================
  Coverage     40.80%   40.80%           
  Complexity    14478    14478           
=========================================
  Files          1764     1764           
  Lines        117814   117814           
  Branches      19131    19131           
=========================================
  Hits          48072    48072           
  Misses        62460    62460           
  Partials       7282     7282           
Flag Coverage Δ
unit 24.99% <ø> (ø)

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

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

BODY TEXT,
FOOTER TEXT,
SUBJECT NVARCHAR(4000),
BODY NVARCHAR(MAX),

Choose a reason for hiding this comment

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

Cannot we consider VARBINARY here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

VARBINARY is used to store binary data.. Here we are handling unicode text.. While we can technically use VARBINARY to store this data in the binary format, wouldn't it better to use more native datatype which doesn't require additional binary-text conversion?

Also, can you share what's the problem we can solve, if we are to changing the datatype from NVARCHAR to VARBINARY?

Copy link

@inthirakumaaran inthirakumaaran Oct 30, 2024

Choose a reason for hiding this comment

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

You're correct; if we only need to support Unicode text (+ HTML), then using NVARCHAR should be sufficient.

Copy link

sonarcloud bot commented Nov 7, 2024

@darshanasbg darshanasbg changed the title Charset issue Use native unicode data types for notification templates Nov 7, 2024
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.

2 participants