Adding escape_string helper to ensure connector_name field is escaped properly (#12444)

mattnowzari · web-flow · commit 1253fe6b9c6f · 2025-01-24T08:34:55.000-05:00
* Added escape_string helper to elastic_connectors to ensure connector_name field is being escaped properly

* updated manifest.yml and changelog.yml

* Changed type from bug to bugfix
diff --git a/packages/elastic_connectors/agent/input/amazon_s3.yml.hbs b/packages/elastic_connectors/agent/input/amazon_s3.yml.hbs
@@ -3,5 +3,5 @@ service_type: s3
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/azure_blob_storage.yml.hbs b/packages/elastic_connectors/agent/input/azure_blob_storage.yml.hbs
@@ -3,5 +3,5 @@ service_type: azure_blob_storage
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/box.yml.hbs b/packages/elastic_connectors/agent/input/box.yml.hbs
@@ -3,5 +3,5 @@ service_type: box
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/confluence.yml.hbs b/packages/elastic_connectors/agent/input/confluence.yml.hbs
@@ -3,5 +3,5 @@ service_type: confluence
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/dropbox.yml.hbs b/packages/elastic_connectors/agent/input/dropbox.yml.hbs
@@ -3,5 +3,5 @@ service_type: dropbox
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/github.yml.hbs b/packages/elastic_connectors/agent/input/github.yml.hbs
@@ -3,5 +3,5 @@ service_type: github
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/gmail.yml.hbs b/packages/elastic_connectors/agent/input/gmail.yml.hbs
@@ -3,5 +3,5 @@ service_type: gmail
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/google_cloud_storage.yml.hbs b/packages/elastic_connectors/agent/input/google_cloud_storage.yml.hbs
@@ -3,5 +3,5 @@ service_type: google_cloud_storage
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/google_drive.yml.hbs b/packages/elastic_connectors/agent/input/google_drive.yml.hbs
@@ -3,5 +3,5 @@ service_type: google_drive
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/jira.yml.hbs b/packages/elastic_connectors/agent/input/jira.yml.hbs
@@ -3,5 +3,5 @@ service_type: jira
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/microsoft_sql.yml.hbs b/packages/elastic_connectors/agent/input/microsoft_sql.yml.hbs
@@ -3,5 +3,5 @@ service_type: mssql
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/mongodb.yml.hbs b/packages/elastic_connectors/agent/input/mongodb.yml.hbs
@@ -3,5 +3,5 @@ service_type: mongodb
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/mysql.yml.hbs b/packages/elastic_connectors/agent/input/mysql.yml.hbs
@@ -3,5 +3,5 @@ service_type: mysql
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/network_drive.yml.hbs b/packages/elastic_connectors/agent/input/network_drive.yml.hbs
@@ -3,5 +3,5 @@ service_type: network_drive
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/notion.yml.hbs b/packages/elastic_connectors/agent/input/notion.yml.hbs
@@ -3,5 +3,5 @@ service_type: notion
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/onedrive.yml.hbs b/packages/elastic_connectors/agent/input/onedrive.yml.hbs
@@ -3,5 +3,5 @@ service_type: onedrive
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/oracle.yml.hbs b/packages/elastic_connectors/agent/input/oracle.yml.hbs
@@ -3,5 +3,5 @@ service_type: oracle
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/outlook.yml.hbs b/packages/elastic_connectors/agent/input/outlook.yml.hbs
@@ -3,5 +3,5 @@ service_type: outlook
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/postgresql.yml.hbs b/packages/elastic_connectors/agent/input/postgresql.yml.hbs
@@ -3,5 +3,5 @@ service_type: postgresql
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/salesforce.yml.hbs b/packages/elastic_connectors/agent/input/salesforce.yml.hbs
@@ -3,5 +3,5 @@ service_type: salesforce
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/servicenow.yml.hbs b/packages/elastic_connectors/agent/input/servicenow.yml.hbs
@@ -3,5 +3,5 @@ service_type: servicenow
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/sharepoint_online.yml.hbs b/packages/elastic_connectors/agent/input/sharepoint_online.yml.hbs
@@ -3,5 +3,5 @@ service_type: sharepoint_online
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/sharepoint_server.yml.hbs b/packages/elastic_connectors/agent/input/sharepoint_server.yml.hbs
@@ -3,5 +3,5 @@ service_type: sharepoint_server
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/slack.yml.hbs b/packages/elastic_connectors/agent/input/slack.yml.hbs
@@ -3,5 +3,5 @@ service_type: slack
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/teams.yml.hbs b/packages/elastic_connectors/agent/input/teams.yml.hbs
@@ -3,5 +3,5 @@ service_type: microsoft_teams
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/agent/input/zoom.yml.hbs b/packages/elastic_connectors/agent/input/zoom.yml.hbs
@@ -3,5 +3,5 @@ service_type: zoom
 connector_id: {{connector_id}}
 {{/if}}
 {{#if connector_name}}
-connector_name: {{connector_name}}
+connector_name: {{escape_string connector_name}}
 {{/if}}
diff --git a/packages/elastic_connectors/changelog.yml b/packages/elastic_connectors/changelog.yml
@@ -1,4 +1,9 @@
 # newer versions go on top
+- version: 1.0.1
+  changes:
+    - description: Add escape_string halper to connector_name field
+      type: bugfix
+      link: https://github.com/elastic/integrations/pull/12444
 - version: 1.0.0
   changes:
     - description: Remove links to all connectors in README
diff --git a/packages/elastic_connectors/manifest.yml b/packages/elastic_connectors/manifest.yml
@@ -1,7 +1,7 @@
 format_version: 3.3.1
 name: elastic_connectors
 title: "Elastic Connectors"
-version: 1.0.0
+version: 1.0.1
 source:
   license: "Elastic-2.0"
 description: "Sync data from source to the Elasticsearch index."
