added Document Synchronization integration tests

.github/workflows/release.yml → .github/workflows/nightly-release.yml

@@ -1,4 +1,4 @@
-name: Release to Marketplace
+name: Nightly Release
 on:
   push:
     tags: [ "*" ]
@@ -28,11 +28,7 @@ jobs:
       - run: |
           echo "RELEASE_VERSION=$(./scripts/version-from-git-tag.sh)" >> $GITHUB_ENV
       - run: echo "Publishing version $RELEASE_VERSION"
-      - run: ./gradlew "-PpluginVersion=$RELEASE_VERSION" publishPlugin
-        env:
-          PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
       - name: Publish nightly version
-        if: "!endsWith(env.RELEASE_VERSION, '-nightly')"
         run: |
           echo "Publishing nightly version ${RELEASE_VERSION}-nightly"
           ./gradlew "-PpluginVersion=${RELEASE_VERSION}-nightly" publishPlugin

.github/workflows/stable-release.yml

@@ -0,0 +1,32 @@
+name: Stable Release
+on:
+  workflow_dispatch
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+          cache: gradle
+      # See note about QEMU and binfmt requirement here https://github.com/vercel/pkg#targets
+      - name: Set up QEMU
+        id: qemu
+        uses: docker/setup-qemu-action@v3
+        with:
+          image: tonistiigi/binfmt:latest
+          platforms: all
+      - name: Gradle Wrapper Validation
+        uses: gradle/wrapper-validation-action@v3
+      - run: yarn global add [email protected]
+      - run: |
+          echo "RELEASE_VERSION=$(./scripts/version-from-git-tag.sh)" >> $GITHUB_ENV
+      - run: echo "Publishing version $RELEASE_VERSION"
+      - run: ./gradlew "-PpluginVersion=$RELEASE_VERSION" publishPlugin
+        env:
+          PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: JetBrains Tests
+name: Build, test and verify
 on:
   pull_request:
   push:
@@ -46,18 +46,22 @@ jobs:
       - run: echo "SKIP_CODE_SEARCH_BUILD=true" >> $GITHUB_ENV
       - run: ./gradlew spotlessCheck
       - run: ./gradlew check
-      - name: Upload test report
+      - name: Upload the test report
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: test-report
           path: build/reports/tests/
+          compression-level: 9
       - run: ./gradlew buildPlugin
       - run: ./gradlew --stop
-      - uses: actions/upload-artifact@v4
+      - name: Upload the plugin package
+        uses: actions/upload-artifact@v4
         with:
-          name: plugin.zip
+          name: plugin
           path: './build/distributions/Sourcegraph-*.zip'
+          compression-level: 0
+          retention-days: 7
   plugin-verifier:
     name: IntelliJ Plugin Verifier
     runs-on: ubuntu-latest
@@ -66,7 +70,7 @@ jobs:
     steps:
       - uses: actions/download-artifact@v4
         with:
-          name: plugin.zip
+          name: plugin
       - name: Verify Plugin on IntelliJ Platforms
         id: verify
         uses: ChrisCarini/[email protected]
@@ -85,8 +89,11 @@ jobs:
             PLUGIN_STRUCTURE_WARNINGS
             MISSING_DEPENDENCIES
             INVALID_PLUGIN
-      - uses: actions/upload-artifact@v4
+      - name: Upload the verification reports
+        if: always()
+        uses: actions/upload-artifact@v4
         with:
           name: plugin-verifier-reports
           path: 'verification-*'
+          compression-level: 9
 

CONTRIBUTING.md

@@ -117,28 +117,33 @@ After doing that:
 
 ## Publishing a New Release
 
+### Historical context
+We used to publish both stable and nightly channel versions at once. 
+In that approach QA testing and JB approval happened in parallel. 
+However, it consumed a lot of CI time and JB time for the releases that did not pass our QA 
+(and did not go public eventually). Hence, we decided to use a sequential process.
+We trigger the stable channel release only after the nightly channel release passes QA.
+
 ```mermaid
 graph TD;
-    Title["JetBrains plugin release"] --> stable;
-    Title --> nightly;
-    stable --> push_stable["push git tag"];
-    push_stable --> release_job_stable["wait for release job to complete"];
-    release_job_stable --> marketplace_approval["wait for marketplace approval"];
-    marketplace_approval -->|Automated approval, up to 48hr| unhide["unhide"];
-    unhide --> available_to_end_users_stable["available for download"];
-    marketplace_approval -->|Manual quick-approve| slack_approval["request JetBrains Marketplace team to manually approve update via Slack"];
-    slack_approval --> unhide["unhide approved release (requires admin access)"];
-    nightly --> push_nightly["push git tag\nwith '-nightly' suffix"];
-    push_nightly --> release_job_nightly["wait for release job to complete"];
-    release_job_nightly --> available_to_end_users_nightly["available for download"];
+    Title --> nightly["Nightly Release"];
+    Title["JetBrains Plugin Release"] --> stable["Stable Release"];
+    stable -->  trigger_stable["Manually trigger 'Stable Release' workflow\nin GitHub Actions"];
+    release_stable --> marketplace_approval["Wait for JetBrains approval"];
+    marketplace_approval --> |Automated approval, up to 48hr| unhide["unhide"];
+    unhide --> available_to_end_users_stable["Available for download"];
+    marketplace_approval --> |Manual quick-approve| slack_approval["Request JetBrains Marketplace team\nto manually approve it via Slack"];
+    slack_approval --> unhide["Unhide the approved release\n(requires admin access)"];
+    nightly --> push_nightly["Run `push-git-tag-for-next-release.sh`"];
+    trigger_stable --> release_stable["Wait for 'Stable Release' workflow to complete"];
+    push_nightly --> release_nightly["Wait for 'Nightly Release' workflow to complete"];
+    release_nightly --> available_to_end_users_nightly["Available for download"];
 ```
 
 We aim to cut a new Stable release every other week on Mondays.
 The release cadence is irregular for Nightly versions.
 
-### 1. Push a Git Tag
-
-First, choose whether to publish a new version of nightly or stable.
+### 1. Push a git tag & publish a nightly release
 
 Use the following command for a **patch** release:
 
@@ -162,11 +167,14 @@ Or this one for a **major** release
 This script runs `verify-release.sh`, which takes a long time to run with a clean cache, which is why we don't run it in
 CI. When you have a local cache of IDEA installations then this script can run decently fast (~1-2min).
 
-After successfully pushing the new tag (for example: `v5.2.4819` or `v5.2.4249-nightly`), we are now able to publish.
+After successfully pushing the new tag (for example: `v6.0.15`), we are now able to publish.
 
 Wait for the `Release to Marketplace` GitHub workflow to complete.
 
-### 2. For Stable releases, wait for Marketplace approval
+### 2. Publish a stable release 
+
+Go to [Stable Release workflow](https://github.com/sourcegraph/jetbrains/actions/workflows/stable-release.yml),
+click `Run workflow` and select the tag that has been pushed before (and tested by QA team), run it.
 
 It can take up to 48hr for stable releases to get approved by the JetBrains Marketplace team.
 It's possible to expedite this process by posting a message in the `#marketplace` channel in

README.md

@@ -204,7 +204,7 @@ Experience experimental chat and command support with Ollama running locally:
 1. Install and run [Ollama](https://ollama.com/download).
 2. Set the [OLLAMA_HOST](https://sourcegraph.com/github.com/ollama/ollama@main/-/blob/docs/faq.md#how-do-i-configure-ollama-server) to `0.0.0.0`.
    1. Please refer to the [official Ollama docs](https://sourcegraph.com/github.com/ollama/ollama@main/-/blob/docs/faq.md#setting-environment-variables-on-windows) for how to set environment variables on your platform.
-3. Set the [OLLAMA_ORIGINS](https://sourcegraph.com/github.com/ollama/ollama@main/-/blob/docs/faq.md#how-can-i-allow-additional-web-origins-to-access-ollama).
+3. Set the [OLLAMA_ORIGINS](https://sourcegraph.com/github.com/ollama/ollama@main/-/blob/docs/faq.md#how-can-i-allow-additional-web-origins-to-access-ollama) to `*`.
 4. Install or restart your Ollama app.
 5. Select a chat model (a model that includes `instruct` or `chat`, e.g., [codegemma:instruct](https://ollama.com/library/codegemma:instruct), [llama3:instruct](https://ollama.com/library/llama3:instruct)) from the [Ollama Library](https://ollama.com/library).
 6. Pull the chat model locally (Example: `ollama pull codegemma:instruct`).

build.gradle.kts

@@ -93,6 +93,7 @@ dependencies {
   testImplementation("org.junit.jupiter:junit-jupiter:5.10.2")
   testImplementation("org.jetbrains.kotlin:kotlin-test-junit:2.0.0")
   testImplementation("org.mockito.kotlin:mockito-kotlin:5.3.1")
+  testImplementation("junit:junit:4.13.2")
 }
 
 spotless {

gradle.properties

@@ -24,4 +24,4 @@ kotlin.stdlib.default.dependency=false
 nodeBinaries.commit=8755ae4c05fd476cd23f2972049111ba436c86d4
 nodeBinaries.version=v20.12.2
 cody.autocomplete.enableFormatting=true
-cody.commit=cec3e5b0f1a6598ca29bb56496dadc4783fd773c
+cody.commit=06c1c0e5185810ca565d10d820fd8a79252b4ba8

scripts/next-release.sh

@@ -1,10 +1,4 @@
 #!/usr/bin/env bash
-# This script implements the time-based version scheme from RFC 795
-# Simplified: versions should be MAJOR.MINOR.PATCH where
-# - MAJOR.MINOR: Latest Sourcegraph quarterly release
-# - PATCH: time-based number from simplified formula (MINUTES_SINCE_LAST_RELEASE / MINUTES_IN_ONE_YEAR * 65535)
-# The scheme gives generates a unique version number every 10 minutes.
-# https://docs.google.com/document/d/11cw-7dAp93JmasITNSNCtx31xrQsNB1L2OoxVE6zrTc/edit#bookmark=id.ufwe0bqp83z1
 set -eu
 
 # Check the number of arguments

src/integrationTest/kotlin/com/sourcegraph/cody/AllSuites.kt

@@ -1,8 +1,9 @@
 package com.sourcegraph.cody
 
+import com.intellij.openapi.diagnostic.Logger
 import com.sourcegraph.cody.agent.CodyAgentService
 import com.sourcegraph.cody.edit.DocumentCodeTest
-import com.sourcegraph.cody.util.CodyIntegrationTextFixture
+import com.sourcegraph.cody.util.CodyIntegrationTestFixture
 import java.util.concurrent.TimeUnit
 import org.junit.AfterClass
 import org.junit.runner.RunWith
@@ -18,16 +19,25 @@ import org.junit.runners.Suite
  * automatically after the platform version bump.
  *
  * Multiple recording files can be used, but each should have its own suite with tearDown() method
- * nad define unique CODY_RECORDING_NAME.
+ * and define a unique CODY_RECORDING_NAME.
  */
 @RunWith(Suite::class)
-@Suite.SuiteClasses(DocumentCodeTest::class)
+@Suite.SuiteClasses(DocumentCodeTest::class, DocumentSynchronizationTest::class)
 class AllSuites {
   companion object {
+    private val logger = Logger.getInstance(AllSuites::class.java)
+
     @AfterClass
     @JvmStatic
     internal fun tearDown() {
-      CodyAgentService.withAgent(CodyIntegrationTextFixture.myProject!!) { agent ->
+      val project = CodyIntegrationTestFixture.myProject
+      // Can happen if a test or fixture introduces a bug, and it makes it hard to read test output
+      // if we are throwing an NPE.
+      if (project == null) {
+        logger.warn("No project found - unable to shut down agent gracefully.")
+        return
+      }
+      CodyAgentService.withAgent(project) { agent ->
         val errors = agent.server.testingRequestErrors().get()
         // We extract polly.js errors to notify users about the missing recordings, if any
         val missingRecordings = errors.filter { it.error?.contains("`recordIfMissing` is") == true }
@@ -46,7 +56,7 @@ class AllSuites {
 
         agent.server
             .shutdown()
-            .get(CodyIntegrationTextFixture.ASYNC_WAIT_TIMEOUT_SECONDS, TimeUnit.SECONDS)
+            .get(CodyIntegrationTestFixture.ASYNC_WAIT_TIMEOUT_SECONDS, TimeUnit.SECONDS)
         agent.server.exit()
       }
     }