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

Author: techouse

.eslintignore

@@ -6,3 +6,4 @@ composer.json
 tsconfig.json
 vendor
 builddir
+foo

.eslintrc.cjs

@@ -79,136 +79,6 @@ module.exports = {
         'yml/no-empty-mapping-value': 0,
       },
     },
-    {
-      // es linter
-      files: ['*.ts', '*.js'],
-
-      extends: [
-        'algolia',
-        'algolia/typescript',
-        'plugin:import/errors',
-        'plugin:import/warnings',
-        'plugin:import/typescript',
-      ],
-
-      env: {
-        es6: true,
-      },
-
-      parser: '@typescript-eslint/parser',
-
-      parserOptions: {
-        tsconfigRootDir: __dirname,
-        project: './**/tsconfig.json',
-      },
-
-      settings: {
-        'import/extensions': ['.js', '.ts'],
-        'import/parsers': {
-          '@typescript-eslint/parser': ['.ts'],
-        },
-        'import/ignore': ['node_modules'],
-      },
-
-      plugins: ['algolia', 'unused-imports'],
-
-      rules: {
-        // disabled
-        'no-bitwise': 0,
-        'max-classes-per-file': 0,
-        'no-continue': 0,
-        '@typescript-eslint/prefer-enum-initializers': 0,
-        '@typescript-eslint/no-namespace': 0,
-        'import/dynamic-import-chunkname': 0,
-
-        'unused-imports/no-unused-imports-ts': 2,
-        '@typescript-eslint/no-unused-vars': 2,
-        '@typescript-eslint/consistent-indexed-object-style': 2,
-        '@typescript-eslint/member-ordering': [
-          'error',
-          {
-            default: [
-              'protected-instance-method',
-              'private-instance-method',
-              'public-instance-method',
-            ],
-          },
-        ],
-        '@typescript-eslint/no-restricted-types': [
-          'error',
-          {
-            types: {
-              String: {
-                message: 'Use `string` instead.',
-                fixWith: 'string',
-              },
-              Number: {
-                message: 'Use `number` instead.',
-                fixWith: 'number',
-              },
-              Boolean: {
-                message: 'Use `boolean` instead.',
-                fixWith: 'boolean',
-              },
-              Symbol: {
-                message: 'Use `symbol` instead.',
-                fixWith: 'symbol',
-              },
-              Object: {
-                message:
-                  'The `Object` type is mostly the same as `unknown`. You probably want `Record<string, unknown>` instead. See https://github.com/typescript-eslint/typescript-eslint/pull/848',
-                fixWith: 'Record<string, unknown>',
-              },
-              '{}': {
-                message:
-                  'The `{}` type is mostly the same as `unknown`. You probably want `Record<string, unknown>` instead.',
-                fixWith: 'Record<string, unknown>',
-              },
-              object: {
-                message:
-                  'The `object` type is hard to use. Use `Record<string, unknown>` instead. See: https://github.com/typescript-eslint/typescript-eslint/pull/848',
-                fixWith: 'Record<string, unknown>',
-              },
-              Function: 'Use a specific function type instead, like `() => void`.',
-            },
-          },
-        ],
-        'jsdoc/match-description': [
-          'error',
-          {
-            matchDescription: '^\n?([A-Z`\[\\d_][\\s\\S]*[.?!`]\\s*)?$'
-          },
-        ],
-      },
-    },
-    {
-      files: ['clients/algoliasearch-client-javascript/packages/**/*.ts'],
-
-      rules: {
-        // For a wider browser support (IE>=11), we forbid those two
-        'no-restricted-syntax': [
-          'error',
-          {
-            selector: "LogicalExpression[operator='??']",
-            message:
-              'For wider browser support, nullish coalescing operator is not allowed.',
-          },
-          {
-            selector: 'ChainExpression',
-            message:
-              'For wider browser support, optional chaining is not allowed.',
-          },
-        ],
-        '@typescript-eslint/prefer-optional-chain': 0,
-      }
-    },
-    {
-      files: ['clients/algoliasearch-client-javascript/packages/**/__tests__/**/*.ts'],
-
-      extends: ["plugin:vitest/legacy-recommended"],
-
-      plugins: ['@vitest/eslint-plugin'],
-    },
     {
       files: ['*.json'],
       parserOptions: {

.github/actions/setup/action.yml

@@ -34,7 +34,7 @@ runs:
     - name: Download Java formatter
       if: inputs.type != 'minimal'
       shell: bash
-      run: curl --retry 3 -L "https://github.com/google/google-java-format/releases/download/v1.23.0/google-java-format-1.23.0-all-deps.jar" > /tmp/java-formatter.jar
+      run: curl --retry 3 -L "https://github.com/google/google-java-format/releases/download/v1.24.0/google-java-format-1.24.0-all-deps.jar" > /tmp/java-formatter.jar
 
     # JavaScript for monorepo and tooling
     - name: Install Node
@@ -45,7 +45,7 @@ runs:
 
     - name: Install JavaScript dependencies
       shell: bash
-      run: YARN_ENABLE_HARDENED_MODE=0 yarn install
+      run: YARN_ENABLE_HARDENED_MODE=0 YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install
 
     - name: Build scripts
       shell: bash
@@ -106,7 +106,7 @@ runs:
       run: |
         curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.60.3
         echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-        go install golang.org/x/tools/cmd/goimports@latest
+        go install golang.org/x/tools/cmd/goimports@v0.22.0
 
     - name: Cache golangci-lint analysis
       if: ${{ inputs.language == 'go' }}

.github/workflows/check.yml

@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 10
     env:
-      CACHE_VERSION: 1 # bump this to run all clients on the CI.
+      CACHE_VERSION: 1.02 # bump this to run all clients on the CI.
     steps:
       - name: debugging - dump GitHub context
         env:
@@ -146,7 +146,7 @@ jobs:
         run: yarn scripts:test
 
       - name: Lint custom eslint plugin
-        run: yarn workspace eslint-plugin-automation-custom lint
+        run: yarn cli format javascript eslint
 
       - name: Test custom eslint plugin
         run: yarn workspace eslint-plugin-automation-custom test
@@ -174,7 +174,7 @@ jobs:
           path: ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX).bundledPath }}
 
   client_gen_javascript:
-    timeout-minutes: 10
+    timeout-minutes: 15
     runs-on: ubuntu-22.04
     needs:
       - setup
@@ -199,12 +199,10 @@ jobs:
           type: specs
 
       - name: Remove generated clients
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
         run: |
           cd clients/algoliasearch-client-javascript/packages
-          ls | grep -v -E "(client-common|requester-*|algoliasearch)" | xargs rm -rf
-          cd algoliasearch
-          ls | grep -v -E "__tests__" | xargs rm -rf
+          find . -mindepth 1 -maxdepth 1 ! -name 'requester-*' ! -name 'logger-*' ! -name 'client-common' -type d -exec rm -rf {}/src {}/model {}/dist {}/builds \;
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -222,17 +220,17 @@ jobs:
         run: ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).buildCommand }}
 
       - name: Build the playground
-        run: yarn cli build playground javascript
+        run: yarn cli build playground javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Run common and requester tests
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
 
       - name: Test JavaScript bundle size
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        if: ${{ startsWith(github.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-') }}
+        if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }}
         run: cd clients/algoliasearch-client-javascript && yarn test:bundle
 
       - name: Remove previous CTS output
@@ -269,17 +267,26 @@ jobs:
         run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --no-client --no-requests
 
       - name: Retry e2e CTS
-        if: ${{ !github.event.pull_request.head.repo.fork && steps.cts-e2e.outcome == 'failure' }}
+        if: ${{ steps.cts-e2e.outcome == 'failure' }}
         run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --no-client --no-requests
 
       - name: Run benchmarks
         run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }} --benchmark --no-client --no-requests --no-e2e
 
-      - name: Generate code snippets for documentation
+      - name: Generate code snippets
         run: yarn cli snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
+      
+      - name: Build the snippets to check validity
+        run: yarn cli build snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
+
+      - name: Generate code guides
+        run: yarn cli guides javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
+
+      - name: Build the guides to check validity
+        run: yarn cli build guides javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Zip artifact before storing
-        run: zip -r -y clients-javascript.zip clients/algoliasearch-client-javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).testsToStore }} ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).snippetsToStore }} -x "**/node_modules**" "**/.yarn/cache/**" "**/.yarn/install-state.gz" "**/build/**" "**/dist/**" "**/.gradle/**" "**/bin/**" "**/.nx/**"
+        run: zip -r -y clients-javascript.zip clients/algoliasearch-client-javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).testsToStore }} ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).guidesToStore }} -x "**/node_modules**" "**/.yarn/cache/**" "**/.yarn/install-state.gz" "**/build/**" "**/dist/**" "**/.gradle/**" "**/bin/**" "**/.nx/**"
 
       - name: Store javascript clients
         uses: actions/upload-artifact@v4
@@ -326,7 +333,7 @@ jobs:
         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')  && matrix.client.isMainVersion }}
+        if: ${{ matrix.client.language == 'php' && startsWith(github.head_ref, 'chore/renovateBaseBranch')  && matrix.client.isMainVersion }}
         run: cd ${{ matrix.client.path }} && composer update
 
       - name: Check for file duplicates in Swift
@@ -374,22 +381,28 @@ jobs:
         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' }}
+        if: ${{ 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
+      - name: Generate code snippets
         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: Generate code guides
+        run: yarn cli guides ${{ matrix.client.language }} ${{ matrix.client.toRun }}
+
+      - name: Build the guides to check validity
+        run: yarn cli build guides ${{ 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/**"
+        run: zip -r -y clients-${{ matrix.client.language }}.zip ${{ matrix.client.path }} ${{ matrix.client.testsToStore }} ${{ matrix.client.guidesToStore }} -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 }}
@@ -464,23 +477,27 @@ jobs:
     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
+        if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
 
       - name: Download artifacts
         uses: ./scripts/ci/actions/restore-artifacts
+        if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
         with:
           type: languages
           languages: |
             swift
 
       - name: Setup
         uses: ./.github/actions/setup
+        if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
         with:
           type: minimal
           language: swift
           version: ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).version }}
 
       - name: Run tests on macOS
         id: run-test
+        if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
         continue-on-error: true
         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' || '' }}
 
@@ -513,7 +530,7 @@ jobs:
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.ref }}
-          token: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          token: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Download all artifacts
@@ -557,14 +574,14 @@ jobs:
         id: pushGeneratedCode
         run: yarn workspace scripts pushGeneratedCode
         env:
-          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.number }}
 
       - name: update generation comment
         uses: marocchino/sticky-pull-request-comment@v2
         if: ${{ steps.pushGeneratedCode.outputs.GENERATED_COMMIT == '' }}
         with:
-          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           message: |
             ### No code generated
 
@@ -576,7 +593,7 @@ jobs:
         uses: marocchino/sticky-pull-request-comment@v2
         if: ${{ steps.pushGeneratedCode.outputs.GENERATED_COMMIT != '' }}
         with:
-          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           message: |
             ### ✔️ Code generated!
 
@@ -670,7 +687,12 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
 
-      - name: Push generation to the Algolia docs
+      - name: Push specs and snippets to algolia/doc
         run: yarn workspace scripts pushToAlgoliaDoc
         env:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}
+
+      - name: Push guides to algolia/AlgoliaWeb
+        run: yarn workspace scripts pushToAlgoliaWeb
+        env:
+          GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN }}

.github/workflows/cleanup.yml

@@ -14,4 +14,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - run: git push -d origin generated/${{ github.head_ref }} || true
+      - run: git push -d origin "generated/${{ github.head_ref }}" || true

.github/workflows/pr-title.yml

@@ -16,4 +16,4 @@ jobs:
       - name: Pull Request title rules
         uses: Slashgear/[email protected]
         with:
-          regexp: '^(docs|chore|snippets)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:clients|generators|playground|csharp|dart|go|java|javascript|kotlin|php|python|ruby|scala|swift|cts|specs|scripts|ci|templates|deps)\)): .+'
+          regexp: '^(docs|chore|snippets|guides)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:clients|generators|playground|csharp|dart|go|java|javascript|kotlin|php|python|ruby|scala|swift|cts|specs|scripts|ci|templates|deps)\)): .+'