Code discussions

.vscode/launch.json

@@ -7,7 +7,7 @@
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
-      "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
+      "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--enable-proposed-api=sourcegraph.sourcegraph"],
       "stopOnEntry": false,
       "sourceMaps": true,
       "outFiles": ["${workspaceRoot}/out/**/*.js"],

package.json

@@ -10,15 +10,15 @@
     "type": "git",
     "url": "https://github.com/sourcegraph/sourcegraph-vscode.git"
   },
+  "enableProposedApi": true,
   "engines": {
-    "vscode": "^1.11.0"
+    "vscode": "^1.27.1"
   },
   "categories": [
     "Other"
   ],
   "activationEvents": [
-    "onCommand:extension.open",
-    "onCommand:extension.search"
+    "*"
   ],
   "main": "./out/extension",
   "contributes": {
@@ -51,11 +51,18 @@
       "title": "Sourcegraph extension configuration",
       "properties": {
         "sourcegraph.url": {
-          "type": [
-            "string"
-          ],
+          "type": "string",
           "default": "https://sourcegraph.com",
           "description": "The base URL of the Sourcegraph instance to use."
+        },
+        "sourcegraph.accessToken": {
+          "type": "string",
+          "description": "An access token for your account on the Sourcegraph instance configured in `sourcegraph.url`. You do not need to provide an access token unless you have `\"sourcegraph.discussionsPreviewEnabled\": true` in your settings."
+        },
+        "sourcegraph.discussionsPreviewEnabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enables Sourcegraph discussions (preview)"
         }
       }
     }
@@ -90,7 +97,8 @@
     "build": "tsc -p .",
     "watch": "tsc -w -p .",
     "postinstall": "node ./node_modules/vscode/bin/install",
-    "test": "node ./node_modules/vscode/bin/test"
+    "test": "node ./node_modules/vscode/bin/test",
+    "graphql": "get-graphql-schema https://sourcegraph.com/.api/graphql --json | gql2ts -n SourcegraphGQL -o src/typings/SourcegraphGQL.d.ts && prettier src/typings/SourcegraphGQL.d.ts --write"
   },
   "devDependencies": {
     "@commitlint/cli": "^7.0.0",
@@ -101,7 +109,10 @@
     "@types/execa": "^0.9.0",
     "@types/mocha": "^2.2.32",
     "@types/node": "^10.3.3",
+    "@types/node-fetch": "^2.1.2",
     "@types/opn": "^5.1.0",
+    "get-graphql-schema": "^2.1.1",
+    "gql2ts": "^1.8.2",
     "husky": "^0.14.3",
     "mocha": "^5.2.0",
     "prettier": "1.13.7",
@@ -114,6 +125,7 @@
   },
   "dependencies": {
     "execa": "^0.6.3",
+    "node-fetch": "^2.2.0",
     "opn": "^5.0.0"
   }
 }

src/comments.ts

@@ -0,0 +1,299 @@
+import vscode from 'vscode'
+import { repoInfo } from './git'
+import { gql, mutateGraphQL, queryGraphQL } from './graphql'
+import { log } from './log'
+
+export function activateComments(context: vscode.ExtensionContext): void {
+    if (!vscode.workspace.getConfiguration('sourcegraph').get<string>('discussionsPreviewEnabled')) {
+        return
+    }
+    log.appendLine('Discussions preview is enabled')
+    const commentProvider = new CommentProvider()
+    context.subscriptions.push(vscode.workspace.registerDocumentCommentProvider(commentProvider))
+}
+
+class CommentProvider implements vscode.DocumentCommentProvider {
+    public async provideDocumentComments(
+        document: vscode.TextDocument,
+        token: vscode.CancellationToken
+    ): Promise<vscode.CommentInfo> {
+        let threads: vscode.CommentThread[] = []
+        try {
+            threads = await provideDocumentComments(document)
+        } catch (e) {
+            log.appendLine(`provideDocumentComments ${e}`)
+        }
+
+        // commentingRanges are the ranges where the user can create a new comment.
+        // For now, this is the entire document. In the future we may wish to limit this
+        // in certain ways (e.g. not comment on lines which don't blame to a git revision that has been pushed to a remote).
+        const lastLine = document.lineCount - 1
+        const commentingRanges = [new vscode.Range(0, 0, lastLine, document.lineAt(lastLine).range.end.character)]
+
+        return { threads, commentingRanges }
+    }
+
+    public async createNewCommentThread(
+        document: vscode.TextDocument,
+        range: vscode.Range,
+        text: string,
+        token: vscode.CancellationToken
+    ): Promise<vscode.CommentThread> {
+        return await createNewCommentThread(document, range, text)
+    }
+
+    public async replyToCommentThread(
+        document: vscode.TextDocument,
+        range: vscode.Range,
+        commentThread: vscode.CommentThread,
+        text: string,
+        token: vscode.CancellationToken
+    ): Promise<vscode.CommentThread> {
+        return await replyToCommentThread(document, range, commentThread, text)
+    }
+
+    private didChangeCommentThreads = new vscode.EventEmitter<vscode.CommentThreadChangedEvent>()
+
+    public onDidChangeCommentThreads = this.didChangeCommentThreads.event
+}
+
+async function provideDocumentComments(document: vscode.TextDocument): Promise<vscode.CommentThread[]> {
+    log.appendLine(`provideDocumentComments ${document.uri}`)
+    const [remoteUrl, branch, path] = await repoInfo(document.fileName)
+    if (!remoteUrl) {
+        throw new Error('Git repository has no remote url configured')
+    }
+    const data = await queryGraphQL(
+        gql`
+            query DiscussionThreads(
+                $targetRepositoryGitCloneURL: String!
+                $targetRepositoryPath: String!
+                $relativeRev: String!
+            ) {
+                discussionThreads(
+                    first: 10000
+                    targetRepositoryGitCloneURL: $targetRepositoryGitCloneURL
+                    targetRepositoryPath: $targetRepositoryPath
+                ) {
+                    totalCount
+                    pageInfo {
+                        hasNextPage
+                    }
+                    nodes {
+                        ...DiscussionThreadFields
+                    }
+                }
+            }
+            ${discussionThreadFieldsFragment}
+        `,
+        {
+            targetRepositoryGitCloneURL: remoteUrl,
+            targetRepositoryPath: path,
+            relativeRev: branch,
+        }
+    )
+
+    if (!data.discussionThreads || !data.discussionThreads.nodes) {
+        throw new Error(`Invalid GraphQL response for DiscussionThreads`)
+    }
+
+    const threads: vscode.CommentThread[] = []
+    for (const thread of data.discussionThreads.nodes) {
+        if (thread.target.__typename !== 'DiscussionThreadTargetRepo') {
+            continue
+        }
+        // TODO: this assumes there is no diff between the document state and the revision
+        const sel = thread.target.relativeSelection
+        if (sel) {
+            const range = new vscode.Range(sel.startLine, sel.startCharacter, sel.endLine, sel.endCharacter)
+            threads.push(discussionToCommentThread(document, range, thread))
+        }
+    }
+
+    return threads
+}
+
+async function createNewCommentThread(
+    document: vscode.TextDocument,
+    range: vscode.Range,
+    text: string
+): Promise<vscode.CommentThread> {
+    log.appendLine(`createNewCommentThread ${document.uri} ${range}`)
+    const [remoteUrl, branch, path] = await repoInfo(document.fileName)
+    if (!remoteUrl) {
+        throw new Error('Git repository has no remote url configured')
+    }
+
+    const selection = getSelection(document, range)
+    const input: SourcegraphGQL.IDiscussionThreadCreateInput = {
+        title: text,
+        contents: text,
+        targetRepo: {
+            repositoryGitCloneURL: remoteUrl,
+            path,
+            branch,
+            selection,
+        },
+    }
+
+    const data = await mutateGraphQL(
+        gql`
+            mutation CreateThread($input: DiscussionThreadCreateInput!, $relativeRev: String!) {
+                discussions {
+                    createThread(input: $input) {
+                        ...DiscussionThreadFields
+                    }
+                }
+            }
+            ${discussionThreadFieldsFragment}
+        `,
+        { input, relativeRev: branch }
+    )
+
+    if (!data.discussions || !data.discussions.createThread) {
+        throw new Error(`Invalid GraphQL response for CreateThread`)
+    }
+
+    return discussionToCommentThread(document, range, data.discussions.createThread)
+}
+
+async function replyToCommentThread(
+    document: vscode.TextDocument,
+    range: vscode.Range,
+    thread: vscode.CommentThread,
+    text: string
+): Promise<vscode.CommentThread> {
+    const [, branch] = await repoInfo(document.fileName)
+    const data = await mutateGraphQL(
+        gql`
+            mutation AddCommentToThread($threadID: ID!, $contents: String!, $relativeRev: String!) {
+                discussions {
+                    addCommentToThread(threadID: $threadID, contents: $contents) {
+                        ...DiscussionThreadFields
+                    }
+                }
+            }
+            ${discussionThreadFieldsFragment}
+        `,
+        { threadID: thread.threadId, contents: text, relativeRev: branch }
+    )
+
+    if (!data.discussions || !data.discussions.addCommentToThread) {
+        throw new Error(`Invalid GraphQL response for AddCommentToThread`)
+    }
+
+    return discussionToCommentThread(document, range, data.discussions.addCommentToThread)
+}
+function discussionToCommentThread(
+    document: vscode.TextDocument,
+    range: vscode.Range,
+    thread: SourcegraphGQL.IDiscussionThread
+): vscode.CommentThread {
+    const comments = thread.comments.nodes.map(comment => ({
+        commentId: comment.id,
+        body: new vscode.MarkdownString(comment.contents),
+        userName: comment.author.username,
+        gravatar: comment.author.avatarURL || '',
+    }))
+
+    return {
+        threadId: thread.id,
+        resource: document.uri,
+        range,
+        comments,
+    }
+}
+
+function getSelection(
+    document: vscode.TextDocument,
+    range: vscode.Range
+): SourcegraphGQL.IDiscussionThreadTargetRepoSelectionInput {
+    const beforeRange = new vscode.Range(range.start.line - 3, 0, range.start.line - 1, 0)
+    const linesBefore = getLines(document, beforeRange)
+
+    const lines = getLines(document, range)
+
+    const afterRange = new vscode.Range(range.end.line + 1, 0, range.end.line + 3, 0)
+    const linesAfter = getLines(document, afterRange)
+
+    return {
+        startLine: range.start.line,
+        startCharacter: range.start.character,
+        endLine: range.end.line,
+        endCharacter: range.end.character,
+        linesBefore,
+        lines,
+        linesAfter,
+    }
+}
+
+function getLines(document: vscode.TextDocument, range: vscode.Range): string[] {
+    const lines: string[] = []
+    for (let i = range.start.line; i <= range.end.line; i++) {
+        if (i >= 0 && i < document.lineCount) {
+            lines.push(document.lineAt(i).text)
+        }
+    }
+    return lines
+}
+
+const discussionThreadFieldsFragment = gql`
+    fragment DiscussionThreadFields on DiscussionThread {
+        id
+        author {
+            ...UserFields
+        }
+        comments {
+            totalCount
+            nodes {
+                id
+                author {
+                    ...UserFields
+                }
+                contents
+            }
+        }
+        title
+        target {
+            __typename
+            ... on DiscussionThreadTargetRepo {
+                repository {
+                    name
+                }
+                path
+                relativePath(rev: $relativeRev)
+                branch {
+                    displayName
+                }
+                revision {
+                    displayName
+                }
+                selection {
+                    startLine
+                    startCharacter
+                    endLine
+                    endCharacter
+                    linesBefore
+                    lines
+                    linesAfter
+                }
+                relativeSelection(rev: $relativeRev) {
+                    startLine
+                    startCharacter
+                    endLine
+                    endCharacter
+                }
+            }
+        }
+        inlineURL
+        createdAt
+        updatedAt
+        archivedAt
+    }
+
+    fragment UserFields on User {
+        displayName
+        username
+        avatarURL
+    }
+`

src/config.ts

@@ -7,3 +7,7 @@ export function getSourcegraphUrl(): string {
     }
     return url
 }
+
+export function getAccessToken(): string | undefined {
+    return vscode.workspace.getConfiguration('sourcegraph').get<string>('accessToken')
+}