Update based on feedback

Author: marekweb

package.json

@@ -8,13 +8,15 @@
   ],
   "wip": true,
   "categories": [],
-  "tags": [],
+  "tags": [
+    "campaigns"
+  ],
   "contributes": {
     "actions": [
       {
-        "id": "start-find-replace",
-        "title": "Find-replace",
-        "command": "start-find-replace",
+        "id": "findReplace.startFindReplace",
+        "title": "Create a new find-replace campaign",
+        "command": "findReplace.startFindReplace",
         "commandArguments": [
           "${get(context, 'searchQuery')}"
         ],
@@ -26,12 +28,12 @@
     "menus": {
       "search/results/toolbar": [
         {
-          "action": "start-find-replace"
+          "action": "findReplace.startFindReplace"
         }
       ],
       "commandPalette": [
         {
-          "action": "start-find-replace"
+          "action": "findReplace.startFindReplace"
         }
       ]
     },
@@ -49,7 +51,8 @@
     "watch:typecheck": "tsc -p tsconfig.json -w",
     "watch:build": "tsc -p tsconfig.dist.json -w",
     "sourcegraph:prepublish": "yarn run typecheck && yarn run build",
-    "prettier": "prettier '**/*.{ts,md,json}' --write --list-different"
+    "prettier": "prettier '**/*.{ts,md,json}' --write --list-different",
+    "test": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' mocha --require ts-node/register **/*.test.ts"
   },
   "browserslist": [
     "last 1 Chrome versions",
@@ -60,9 +63,13 @@
   "devDependencies": {
     "@sourcegraph/eslint-config": "^0.20.11",
     "@sourcegraph/tsconfig": "^4.0.1",
+    "@types/assert": "^1.5.2",
+    "@types/mocha": "^8.0.3",
+    "assert": "^2.0.0",
     "eslint": "^7.11.0",
     "lnfs-cli": "^2.1.0",
     "mkdirp": "^1.0.4",
+    "mocha": "^8.2.0",
     "parcel-bundler": "^1.12.4",
     "prettier": "^2.1.2",
     "sourcegraph": "^24.7.0",
@@ -71,6 +78,7 @@
   "dependencies": {
     "@sourcegraph/campaigns-client": "file:../campaigns-client",
     "rxjs": "^6.6.3",
-    "slugify": "^1.4.5"
+    "slugify": "^1.4.5",
+    "ts-node": "^9.0.0"
   }
 }

src/edit-file.test.ts

@@ -0,0 +1,26 @@
+import { editFile } from './edit-file'
+import assert from 'assert'
+
+const input = 'Red redder reddest'
+
+describe('editFile', () => {
+    it('returns identical output', () => {
+        const output = editFile(input, 'foo', 'bar')
+        assert.strictEqual(output, input)
+    })
+
+    it('replaces a string with a replacement', () => {
+        const output = editFile(input, 'red', 'bar')
+        assert.strictEqual(output, 'Red barder bardest')
+    })
+
+    it('replaces a string with a blank string', () => {
+        const output = editFile(input, 'ed', '')
+        assert.strictEqual(output, 'R rder rdest')
+    })
+
+    it('works with blank find string', () => {
+        const output = editFile(input, '', 'foo')
+        assert.strictEqual(output, input)
+    })
+})

src/edit-file.ts

@@ -0,0 +1,14 @@
+/**
+ * Edit a file to apply a string replacement
+ */
+export function editFile(text: string, findString: string, replacement: string): string {
+    if (findString.length === 0) {
+        return text
+    }
+
+    if (!text.includes(findString)) {
+        return text
+    }
+
+    return text.split(findString).join(replacement)
+}

src/find-replace.ts

@@ -1,4 +1,4 @@
-import * as sourcegraph from 'sourcegraph'
+import sourcegraph from 'sourcegraph'
 import { registerFindReplaceAction } from './register-action'
 
 export function activate(context: sourcegraph.ExtensionContext): void {

src/register-action.ts

@@ -1,74 +1,82 @@
 import { Subscription } from 'rxjs'
-import * as sourcegraph from 'sourcegraph'
+import sourcegraph from 'sourcegraph'
 import { evaluateAndCreateCampaignSpec } from '@sourcegraph/campaigns-client'
 import slugify from 'slugify'
 import { getCurrentUser } from './util'
+import { editFile } from './edit-file'
 
 // TODO: sanitize this for real, it gets used in the description of the campaign
 const escapedMarkdownCode = (text: string): string => '`' + text.replace(/`/g, '\\`') + '`'
 
-// TODO: instead of using fileFilter, use the search results as the list of matching files
-const fileFilter = (path: string): boolean => path.endsWith('.yaml') || path.endsWith('.yml') || path.endsWith('.md')
-
 export const registerFindReplaceAction = (): Subscription => {
     const subscription = new Subscription()
     subscription.add(
-        sourcegraph.commands.registerCommand('start-find-replace', async (searchQuery: string) => {
+        sourcegraph.commands.registerCommand('findReplace.startFindReplace', async (searchQuery: string) => {
             // TODO: in the future, use the search query to get the list of matching files.
             console.log('context.searchQuery', searchQuery)
 
+            if (!searchQuery) {
+                return
+            }
+
             // To create campaigns, a namespace is used, which can be the current user's username.
             const currentUser = await getCurrentUser()
-            const namespaceName = currentUser?.username
-            console.log('currentUser', currentUser)
+            if (!currentUser) {
+                throw new Error('No current user')
+            }
+            const namespaceName = currentUser.username
 
-            const match = await sourcegraph.app.activeWindow!.showInputBox({
+            const findString = await sourcegraph.app.activeWindow!.showInputBox({
                 prompt: 'Find all matches of:',
             })
-            if (!match) {
+            if (!findString) {
                 return
             }
 
-            const replacement = await sourcegraph.app.activeWindow!.showInputBox({
+            const replacementString = await sourcegraph.app.activeWindow!.showInputBox({
                 prompt: 'Replace with:',
             })
             // Empty string is a valid replacement, so compare directly with undefined.
-            if (replacement === undefined) {
+            if (replacementString === undefined) {
                 return
             }
 
-            const name = `replace-${slugify(match)}-with-${slugify(replacement)}`
-            const description = `Replace ${escapedMarkdownCode(match)} with ${escapedMarkdownCode(replacement)}`
+            const campaignName = `replace-${slugify(findString)}-with-${slugify(replacementString)}`
+            const description = `Replace ${escapedMarkdownCode(findString)} with ${escapedMarkdownCode(
+                replacementString
+            )}`
 
             let percentage = 0
             const { applyURL, diffStat } = await sourcegraph.app.activeWindow!.withProgress(
                 { title: '**Find-replace**' },
-                async reporter =>
+                reporter =>
                     evaluateAndCreateCampaignSpec(namespaceName, {
-                        name,
+                        name: campaignName,
                         on: [
                             {
-                                repositoriesMatchingQuery: match,
+                                repositoriesMatchingQuery: searchQuery,
                             },
                         ],
                         description,
                         steps: [
                             {
-                                fileFilter,
+                                fileFilter: () => true,
                                 editFile: (path, text) => {
-                                    if (!text.includes(match)) {
+                                    if (!text.includes(findString)) {
+                                        // skip the file by returning null
                                         return null
                                     }
 
                                     percentage += (100 - percentage) / 100
                                     reporter.next({ message: `Computing changes in ${path}`, percentage })
-                                    return text.split(match).join(replacement)
+
+                                    return editFile(text, findString, replacementString)
                                 },
                             },
                         ],
                         changesetTemplate: {
                             title: description,
-                            branch: `campaign/${name}`,
+                            branch: `campaign/${campaignName}`,
                             commit: {
                                 message: description,
                                 author: {

src/util.ts

@@ -1,7 +1,17 @@
 import sourcegraph from 'sourcegraph'
 
-export async function getCurrentUser(): Promise<{ username: string; email: string }> {
-    const response = await sourcegraph.commands.executeCommand(
+interface CurrentUserResponse {
+    data?: {
+        currentUser?: {
+            username: string
+            email: string
+        }
+    }
+    errors?: string[]
+}
+
+export async function getCurrentUser(): Promise<{ username: string; email: string } | undefined> {
+    const response = await sourcegraph.commands.executeCommand<CurrentUserResponse>(
         'queryGraphQL',
         `{
         currentUser {