Merge branch 'main' into fix/dio-requester-requestUri

Author: techouse

.eslintrc.cjs

@@ -196,8 +196,10 @@ module.exports = {
     },
     {
       files: ['*.json'],
-
-      plugins: ['json-format'],
+      parserOptions: {
+        extraFileExtensions: ['.json'],
+      },
+      extends: ["plugin:json/recommended-legacy"]
     },
     {
       files: ['templates/**/*.mustache'],

.github/ISSUE_TEMPLATE/Bug_report.yml

@@ -43,7 +43,7 @@ body:
     id: client
     attributes:
       label: Client
-      description: What API are you targetting?
+      description: Which API are you targetting?
       options:
         - All
         - AB testing

.github/actions/setup/action.yml

@@ -9,6 +9,9 @@ inputs:
   language:
     description: the language for which to install deps
     required: false
+  version:
+    description: the version of the language to setup
+    required: false
 
 runs:
   using: composite
@@ -48,19 +51,6 @@ runs:
       shell: bash
       run: yarn workspace scripts build:cli
 
-    - name: Get all languages versions
-      id: versions
-      shell: bash
-      run: |
-        # remove patch from php version
-        echo "CSHARP_VERSION=$(cat config/.csharp-version)" >> $GITHUB_OUTPUT
-        echo "DART_VERSION=$(cat config/.dart-version)" >> $GITHUB_OUTPUT
-        echo "GO_VERSION=$(cat config/.go-version)" >> $GITHUB_OUTPUT
-        echo "PHP_VERSION=$(cat config/.php-version | cut -d '.' -f 1,2)" >> $GITHUB_OUTPUT
-        echo "PYTHON_VERSION=$(cat config/.python-version)" >> $GITHUB_OUTPUT
-        echo "RUBY_VERSION=$(cat config/.ruby-version)" >> $GITHUB_OUTPUT
-        echo "SWIFT_VERSION=$(cat config/.swift-version)" >> $GITHUB_OUTPUT
-
     # JavaScript client deps
     - name: Get yarn js-client cache directory path
       if: ${{ inputs.language == 'javascript' }}
@@ -92,7 +82,7 @@ runs:
       if: ${{ inputs.language == 'php' }}
       uses: shivammathur/setup-php@v2
       with:
-        php-version: ${{ steps.versions.outputs.PHP_VERSION }}
+        php-version: ${{ inputs.version }}
         tools: composer
 
     - name: Run composer install
@@ -108,7 +98,7 @@ runs:
       uses: actions/setup-go@v5
       with:
         cache-dependency-path: clients/algoliasearch-client-go/go.sum
-        go-version: ${{ steps.versions.outputs.GO_VERSION }}
+        go-version: ${{ inputs.version }}
 
     - name: Install golangci-lint
       if: ${{ inputs.language == 'go' }}
@@ -123,7 +113,7 @@ runs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/golangci-lint
-        key: golangci-lint-${{ steps.versions.outputs.GO_VERSION }}-${{ hashFiles('clients/algoliasearch-client-go/go.sum') }}
+        key: golangci-lint-${{ inputs.version }}-${{ hashFiles('clients/algoliasearch-client-go/go.sum') }}
 
     # Kotlin
     - name: Cache spotless
@@ -138,7 +128,7 @@ runs:
       if: ${{ inputs.language == 'dart' }}
       uses: dart-lang/setup-dart@v1
       with:
-        sdk: ${{ steps.versions.outputs.DART_VERSION }}
+        sdk: ${{ inputs.version }}
 
     - name: Setup dart tools
       if: ${{ inputs.language == 'dart' }}
@@ -154,7 +144,7 @@ runs:
     - uses: actions/setup-python@v5
       if: ${{ inputs.language == 'python' }}
       with:
-        python-version: ${{ steps.versions.outputs.PYTHON_VERSION }}
+        python-version: ${{ inputs.version }}
         cache: 'poetry'
 
     - run: poetry install
@@ -167,7 +157,7 @@ runs:
       if: ${{ inputs.language == 'ruby' }}
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ steps.versions.outputs.RUBY_VERSION }}
+        ruby-version: ${{ inputs.version }}
         bundler-cache: true
 
     - name: Install Ruby formatter
@@ -184,7 +174,7 @@ runs:
       if: ${{ inputs.language == 'csharp' }}
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: ${{ steps.versions.outputs.CSHARP_VERSION }}
+        dotnet-version: ${{ inputs.version }}
 
     # Swift deps
     - name: Install swift
@@ -195,7 +185,7 @@ runs:
       # uses: swift-actions/setup-swift@v2
       uses: redsun82/setup-swift@b2b6f77ab14f6a9b136b520dc53ec8eca27d2b99
       with:
-        swift-version: ${{ steps.versions.outputs.SWIFT_VERSION }}
+        swift-version: ${{ inputs.version }}
 
     - name: Cache the build folder
       id: cache-swift-build
@@ -205,13 +195,13 @@ runs:
         path: |
           clients/algoliasearch-client-swift/.build
           tests/output/swift/.build
-        key: swift-build-${{ steps.versions.outputs.SWIFT_VERSION }}-${{ runner.os }}
+        key: swift-build-${{ inputs.version }}-${{ runner.os }}
 
     - name: Set swiftformat version
       if: ${{ inputs.language == 'swift' }}
       id: swiftformat-version
       shell: bash
-      run: echo "SWIFTFORMAT_VERSION=0.54.3" >> $GITHUB_OUTPUT
+      run: echo "SWIFTFORMAT_VERSION=0.54.4" >> $GITHUB_OUTPUT
 
     - name: Checkout swiftformat
       if: ${{ inputs.language == 'swift' }}

.github/workflows/check.yml

@@ -108,6 +108,8 @@ jobs:
     outputs:
       RUN_SCRIPTS: ${{ steps.diff.outputs.GITHUB_ACTIONS_CHANGED > 0 || steps.diff.outputs.SCRIPTS_CHANGED > 0 }}
 
+      RUN_WEBSITE: ${{ steps.diff.outputs.WEBSITE_CHANGED > 0 }}
+
       SPECS_MATRIX: ${{ steps.spec-matrix.outputs.MATRIX }}
 
       RUN_GEN: ${{ steps.gen-matrix.outputs.RUN_GEN }}
@@ -118,6 +120,7 @@ jobs:
       SWIFT_DATA: ${{ steps.gen-matrix.outputs.SWIFT_DATA }}
       RUN_MACOS_SWIFT_CTS: ${{ steps.gen-matrix.outputs.RUN_MACOS_SWIFT_CTS }}
 
+      KOTLIN_DATA: ${{ steps.gen-matrix.outputs.KOTLIN_DATA }}
       RUN_MACOS_KOTLIN_BUILD: ${{ steps.gen-matrix.outputs.RUN_MACOS_KOTLIN_BUILD }}
 
   scripts:
@@ -183,6 +186,7 @@ jobs:
       ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
       ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
+    name: client javascript${{ needs.setup.outputs.RUN_GEN_JAVASCRIPT == 'true' && format('@{0}', fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).version) || '' }}
     steps:
       - uses: actions/checkout@v4
 
@@ -203,6 +207,7 @@ jobs:
         uses: ./.github/actions/setup
         with:
           language: javascript
+          version: ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).version }}
 
       - name: Generate clients
         run: yarn cli generate javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
@@ -223,6 +228,10 @@ jobs:
         if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
         run: cd clients/algoliasearch-client-javascript && yarn test:size
 
+      - name: Test JavaScript bundle and types
+        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        run: cd clients/algoliasearch-client-javascript && yarn test:bundle
+
       - name: Remove previous CTS output
         run: rm -rf ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).testsToDelete }}
 
@@ -253,7 +262,7 @@ jobs:
       - name: Run e2e CTS
         id: cts-e2e
         continue-on-error: true
-        if: ${{ !github.event.pull_request.head.repo.fork }}
+        if: ${{ !github.event.pull_request.head.repo.fork && !contains(format('{0} {1}', github.event.pull_request.title, github.event.head_commit.message), '[skip-e2e]') }}
         run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --no-client --no-requests
 
       - name: Retry e2e CTS
@@ -295,6 +304,7 @@ jobs:
       ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
       ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
+    name: client ${{ matrix.client.language }}@${{ matrix.client.version }}
     steps:
       - uses: actions/checkout@v4
 
@@ -307,16 +317,17 @@ jobs:
         uses: ./.github/actions/setup
         with:
           language: ${{ matrix.client.language }}
+          version: ${{ matrix.client.version }}
 
       - name: Generate clients
         run: yarn cli generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
       - name: Update composer.lock
-        if: ${{ matrix.client.language == 'php' && startsWith(env.head_ref, 'chore/renovateBaseBranch') }}
+        if: ${{ matrix.client.language == 'php' && startsWith(env.head_ref, 'chore/renovateBaseBranch')  && matrix.client.isMainVersion }}
         run: cd ${{ matrix.client.path }} && composer update
 
       - name: Check for file duplicates in Swift
-        if: ${{ matrix.client.language == 'swift' }}
+        if: ${{ matrix.client.language == 'swift' && matrix.client.isMainVersion }}
         run: |
           set -eo pipefail
           cd clients/algoliasearch-client-swift
@@ -330,46 +341,55 @@ jobs:
         run: yarn cli build playground ${{ matrix.client.language }}
 
       - name: Run Java 'algoliasearch' public API validation
-        if: ${{ matrix.client.language == 'java' }}
+        if: ${{ matrix.client.language == 'java' && matrix.client.isMainVersion && !contains(format('{0} {1}', github.event.pull_request.title, github.event.head_commit.message), '[skip-bc]') }}
         run: |
           cd ${{ matrix.client.path }}
-          ./gradlew :api:japicmp || exit 0
+          exit_code=0
+          ./gradlew :api:japicmp || exit_code=$?
 
-          FILE=${{ matrix.client.path }}/api/build/reports/japi.txt
+          FILE=./api/build/reports/japi.txt
 
           if [[ -f "$FILE" ]]; then
             cat $FILE
           fi
 
+          exit $exit_code
+
       - name: Remove previous CTS output
         run: rm -rf ${{ matrix.client.testsToDelete }} || true
 
       - name: Generate CTS
-        run: yarn cli cts generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
+        run: yarn cli cts generate ${{ matrix.client.language }} ${{ matrix.client.toRun }} --language-version ${{ matrix.client.version }}
 
       - name: Run unit CTS
         run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --no-e2e
 
       - name: Run e2e CTS
         id: cts-e2e
         continue-on-error: true
-        if: ${{ !github.event.pull_request.head.repo.fork }}
+        if: ${{ !github.event.pull_request.head.repo.fork && !contains(format('{0} {1}', github.event.pull_request.title, github.event.head_commit.message), '[skip-e2e]') }}
         run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --no-client --no-requests
 
       - name: Retry e2e CTS
         if: ${{ !github.event.pull_request.head.repo.fork && steps.cts-e2e.outcome == 'failure' }}
         run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --no-client --no-requests
 
       - name: Run benchmarks
+        if: ${{ matrix.client.isMainVersion }}
         run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }} --benchmark --no-client --no-requests --no-e2e
 
       - name: Generate code snippets for documentation
         run: yarn cli snippets ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
+      - name: Build the snippets to check validity
+        run: yarn cli build snippets ${{ matrix.client.language }}
+
       - name: Zip artifact before storing
+        if: ${{ matrix.client.isMainVersion }}
         run: zip -r -y clients-${{ matrix.client.language }}.zip ${{ matrix.client.path }} ${{ matrix.client.testsToStore }} ${{ matrix.client.snippetsToStore }} -x "**/node_modules**" "**/__pycache__/**" "**/.yarn/cache/**" "**/build/**" "**/.build/**" "**/dist/**" "**/.gradle/**" "**/bin/**" "**/vendor/**" "**/target/**" "**/.dart_tool/**"
 
       - name: Store ${{ matrix.client.language }} clients
+        if: ${{ matrix.client.isMainVersion }}
         uses: actions/upload-artifact@v4
         with:
           if-no-files-found: error
@@ -390,6 +410,7 @@ jobs:
       !contains(needs.*.result, 'failure')
     outputs:
       success: ${{ steps.setoutput.outputs.success }}
+    name: client kotlin${{ needs.setup.outputs.RUN_MACOS_KOTLIN_BUILD == 'true' && format('@{0}', fromJSON(needs.setup.outputs.KOTLIN_DATA).version) || '' }} macos
     steps:
       - uses: actions/checkout@v4
 
@@ -406,6 +427,12 @@ jobs:
           type: minimal
           language: kotlin
 
+      - name: remove previous build from linux
+        run: |
+          rm -rf clients/algoliasearch-client-kotlin/build || true
+          rm -rf clients/algoliasearch-client-kotlin/.kotlin || true
+          rm -rf clients/algoliasearch-client-kotlin/.gradle || true
+
       - run: yarn cli build clients kotlin
 
       - name: Set output
@@ -430,6 +457,7 @@ jobs:
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
     outputs:
       success: ${{ steps.setoutput.outputs.success }}
+    name: client swift${{ needs.setup.outputs.RUN_MACOS_SWIFT_CTS == 'true' && format('@{0}', fromJSON(needs.setup.outputs.SWIFT_DATA).version) || '' }} macos
     steps:
       - uses: actions/checkout@v4
 
@@ -445,8 +473,9 @@ jobs:
         with:
           type: minimal
           language: swift
+          version: ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).version }}
 
-      - run: yarn cli cts run swift ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).toRun }} -v
+      - run: yarn cli cts run swift ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).toRun }} -v ${{ !contains(format('{0} {1}', github.event.pull_request.title, github.event.head_commit.message), '[skip-e2e]') && '--no-e2e' || '' }}
 
       - name: Set output
         id: setoutput
@@ -549,11 +578,11 @@ jobs:
             ${{ steps.benchmark.outputs.BENCHMARK_SECTION }}
 
       - name: Build website
-        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
+        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' && needs.setup.outputs.RUN_WEBSITE == 'true' }}
         run: yarn website:build
 
       - name: Deploy documentation
-        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' }}
+        if: ${{ github.ref == 'refs/heads/main' || github.base_ref == 'main' && needs.setup.outputs.RUN_WEBSITE == 'true' }}
         uses: nwtgck/[email protected]
         with:
           publish-dir: 'website/build'

.github/workflows/issue.yml

@@ -0,0 +1,55 @@
+name: 'Issue sync with Jira'
+on:
+  issues:
+    types: [opened]
+
+permissions:
+  issues: write
+  contents: read
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create ticket
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const action = context.payload.action;
+            if (action !== 'opened') {
+              return;
+            }
+            const title = context.payload.issue.title;
+            const body = context.payload.issue.body;
+
+            const res = await fetch('https://algolia.atlassian.net/rest/api/2/issue', {
+              method: 'POST',
+              headers: {
+                'Accept': 'application/json',
+                'Content-Type': 'application/json',
+                'Authorization': `Basic ${{ secrets.JIRA_TOKEN }}`
+              },
+              body: JSON.stringify({
+                fields: {
+                  description: `Issue created by ${context.actor} at ${context.payload.issue.html_url} \n\n${body}`,
+                  issuetype: {
+                    id: '10001'
+                  },
+                  parent: {
+                    key: 'DI-2737'
+                  },
+                  project: {
+                    id: '10118'
+                  },
+                  summary: `[GH-ISSUE] ${title}`
+                },
+                update: {}
+              })
+            });
+
+            if (!res.ok) {
+              throw new Error(`Failed to create ticket: ${res.statusText} (${res.status}) - ${await res.text()}`);
+            }
+
+            const data = await res.json();
+            console.log(`Created ticket: ${data.key}`);