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.

Sign up for GitHub

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

fix(ingestion/salesforce): escape markdown char for multiline description #10351

Merged
merged 1 commit into from
Apr 23, 2024
Merged

fix(ingestion/salesforce): escape markdown char for multiline description #10351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions metadata-ingestion/src/datahub/ingestion/source/salesforce.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,11 +537,21 @@ def get_profile_workunit(

# Here field description is created from label, description and inlineHelpText
def _get_field_description(self, field: dict, customField: dict) -> str:
desc = field["Label"]
if field.get("FieldDefinition", {}).get("Description"):
desc = "{0}\n\n{1}".format(desc, field["FieldDefinition"]["Description"])
if field.get("InlineHelpText"):
desc = "{0}\n\n{1}".format(desc, field["InlineHelpText"])
desc = (
"\\" + field["Label"] if field["Label"].startswith("#") else field["Label"]
)

for key in ["FieldDefinition", "InlineHelpText"]:
text: Optional[str] = ""
if isinstance(field.get(key), dict):
text = field[key].get("Description")
else:
text = field.get(key)

if text:
prefix = "\\" if text.startswith("#") else ""
desc += f"\n\n{prefix}{text}"

return desc

# Here jsonProps is used to add additional salesforce field level properties.
Expand Down Expand Up @@ -575,13 +585,6 @@ def _get_schema_field(

description = self._get_field_description(field, customField)

# escaping string starting with `#`
description = (
"\\" + description
if description and description.startswith("#")
else description
)

schemaField = SchemaFieldClass(
fieldPath=fieldPath,
type=SchemaFieldDataTypeClass(type=TypeClass()), # type:ignore
Expand Down
4 changes: 3 additions & 1 deletion metadata-ingestion/tests/integration/salesforce/mock_files/account_fields_soql_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2517,6 +2517,7 @@
"QualifiedApiName": "Unique_Account",
"DeveloperName": "Unique_Account",
"Label": "# Unique_Account",
"InlineHelpText": "# Help Text",
"FieldDefinition": {
"attributes": {
"type": "FieldDefinition",
Expand All @@ -2527,7 +2528,8 @@
"LastModifiedBy": null,
"IsIndexed": false,
"ComplianceGroup": null,
"SecurityClassification": null
"SecurityClassification": null,
"Description": "This is the # description"
},
"DataType": "string",
"Precision": 0,
Expand Down
2 changes: 1 addition & 1 deletion metadata-ingestion/tests/integration/salesforce/salesforce_mces_golden.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@
{
"fieldPath": "Unique_Account",
"nullable": true,
"description": "\\# Unique_Account",
"description": "\\# Unique_Account\n\nThis is the # description\n\n\\# Help Text",
"type": {
"type": {
"com.linkedin.schema.StringType": {}
Expand Down
Loading