Sanitize the project name when saving to file, to remove illegal filesystem characters or grab a URL hostname (if a URL was used for the project name). The project name in the SIDE file will be respected as entered by the user.

Author: David Haeffner

packages/selenium-ide/src/neo/IO/filesystem.js

@@ -34,6 +34,7 @@ import Manager from '../../plugin/manager'
 import chromeGetFile from './filesystem/chrome'
 import firefoxGetFile from './filesystem/firefox'
 import { userAgent as parsedUA } from '../../common/utils'
+import url from 'url'
 
 export function getFile(path) {
   const browserName = parsedUA.browser.name
@@ -75,14 +76,23 @@ export function saveProject(_project) {
   UiState.saved()
 }
 
+export function sanitizeProjectName(projectName) {
+  let name = projectName
+  if (name.startsWith('http')) {
+    return url.parse(projectName).host
+  } else {
+    return name.replace(/([^a-z0-9 ._-]+)/gi, '')
+  }
+}
+
 function downloadProject(project) {
   return exportProject(project).then(snapshot => {
     if (snapshot) {
       project.snapshot = snapshot
       Object.assign(project, Manager.emitDependencies())
     }
     return browser.downloads.download({
-      filename: project.name + '.side',
+      filename: sanitizeProjectName(project.name) + '.side',
       url: createBlob(
         'application/json',
         beautify(JSON.stringify(project), { indent_size: 2 })

packages/selenium-ide/src/neo/__test__/IO/filesystem.spec.js

@@ -0,0 +1,30 @@
+import { sanitizeProjectName } from '../../IO/filesystem'
+
+describe('filesystem', () => {
+  describe('save', () => {
+    describe('filename', () => {
+      it('allows alpha-numeric characters', () => {
+        const input = 'asdf1234'
+        expect(sanitizeProjectName(input)).toEqual(input)
+      })
+      it('allows limited special characters', () => {
+        let input = 'asdf-1234'
+        expect(sanitizeProjectName(input)).toEqual(input)
+        input = 'asdf_1234'
+        expect(sanitizeProjectName(input)).toEqual(input)
+        input = 'asdf.1234'
+        expect(sanitizeProjectName(input)).toEqual(input)
+        input = 'asdf 1234'
+        expect(sanitizeProjectName(input)).toEqual(input)
+      })
+      it('ignores illegal filesystem characters', () => {
+        const input = 'blah:/blah'
+        expect(sanitizeProjectName(input)).toEqual('blahblah')
+      })
+      it('with URI returns the root', () => {
+        const input = 'http://a.b.com'
+        expect(sanitizeProjectName(input)).toEqual('a.b.com')
+      })
+    })
+  })
+})