chore(scripts): fix version for everything and use debian in docker (#1349)

Author: millotp

.github/actions/setup/action.yml

@@ -24,7 +24,7 @@ runs:
       uses: actions/setup-java@v3
       with:
         distribution: zulu
-        java-version: 11.0.4
+        java-version-file: config/.java-version
         cache: gradle
 
     - name: Validate gradle wrapper
@@ -93,6 +93,21 @@ runs:
       run: cd clients/algoliasearch-client-javascript && YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install
 
     # PHP deps
+    - name: Get PHP version
+      if: ${{ inputs.language == 'php' }}
+      id: php-version
+      shell: bash
+      run: |
+        # remove patch from version
+        echo "PHP_VERSION=$(cat config/.php-version | cut -d '.' -f 1,2)" >> $GITHUB_OUTPUT
+
+    - name: Install PHP
+      if: ${{ inputs.language == 'php' }}
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ steps.php-version.outputs.PHP_VERSION }}
+        tools: composer
+
     - name: Run composer update
       if: ${{ inputs.language == 'php' }}
       shell: bash

.lintstagedrc

@@ -1,5 +1,5 @@
 {
-  "generators/**/*.java": "docker exec -t api-clients-automation yarn cli format java generators",
+  "generators/**/*.java": "docker exec -t api-clients-automation bash -lc \"yarn cli format java generators\"",
   ".github/**/*.yml": "yarn github-actions:lint --fix",
   "*.json": "yarn fix:json",
   "scripts/**/*.(js|ts)": "yarn scripts:lint --fix"

Dockerfile

@@ -1,18 +1,42 @@
 ARG NODE_VERSION=18.14.2
+ARG JAVA_VERSION=11.0.18
+ARG PHP_VERSION=8.1.16
 
-FROM node:$NODE_VERSION-alpine3.17
+# PHP is so complicated (and long) to install that we use the docker image directly
+FROM php:${PHP_VERSION}-bullseye
+
+ARG NODE_VERSION
+ARG JAVA_VERSION
 
 ENV DOCKER=true
 
-RUN apk -U add openjdk11 jq bash perl build-base python3
-ENV JAVA_HOME=/usr/lib/jvm/default-jvm
+# use bash for subsequent commands
+SHELL ["/bin/bash", "--login", "-c"]
+
+# PHP composer
+COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
+
+RUN apt-get update && apt-get install -y \
+    curl \
+    zip \
+    unzip \
+    # python is used by nvm to install some packages
+    python3 \
+    && rm -rf /var/lib/apt/lists/*
+
+# Javascript (node)
+RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+RUN nvm install ${NODE_VERSION}
+RUN npm install -g yarn 
+
+# Java
+RUN curl -s "https://get.sdkman.io" | bash
+RUN source "$HOME/.sdkman/bin/sdkman-init.sh"
+RUN sdk install java ${JAVA_VERSION}-zulu
 
 # Java formatter
 ADD https://github.com/google/google-java-format/releases/download/v1.15.0/google-java-format-1.15.0-all-deps.jar /tmp/java-formatter.jar
 
-# PHP dependencies
-RUN apk add -U composer php8 php8-tokenizer php8-dom php8-xml php8-xmlwriter
-
 WORKDIR /app
 
-CMD ["bash"]
+CMD bash

clients/algoliasearch-client-java-2/.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: zulu
-          java-version: 11.0.4
+          java-version-file: config/.java-version
           cache: gradle
 
       - name: Validate gradle wrapper

config/.java-version

@@ -0,0 +1 @@
+11.0.18

config/.php-version

@@ -0,0 +1 @@
+8.1.16

package.json

@@ -12,7 +12,7 @@
     "build:eslint": "yarn workspace eslint-plugin-automation-custom build && yarn install",
     "clean": "rm -rf **/dist **/build **/node_modules **/.gradle **/vendor || true",
     "cli": "yarn workspace scripts ts-node --transpile-only ./cli/index.ts",
-    "docker": "docker exec -it api-clients-automation yarn cli $*",
+    "docker": "docker exec -it api-clients-automation bash -lc \"yarn cli $*\"",
     "docker:build": "./scripts/docker/build.sh",
     "docker:clean": "docker stop api-clients-automation; docker rm -f api-clients-automation; docker image rm -f api-clients-automation",
     "docker:mount": "./scripts/docker/mount.sh",

scripts/cts/runCts.ts

@@ -1,4 +1,4 @@
-import { CI, run, runComposerUpdate } from '../common';
+import { run, runComposerUpdate } from '../common';
 import { createSpinner } from '../oraLog';
 
 async function runCtsOne(language: string, verbose: boolean): Promise<void> {
@@ -23,10 +23,8 @@ async function runCtsOne(language: string, verbose: boolean): Promise<void> {
       break;
     case 'php': {
       await runComposerUpdate(verbose);
-      let php = 'php8';
-      if (CI) php = 'php';
       await run(
-        `${php} ./clients/algoliasearch-client-php/vendor/bin/phpunit tests/output/php`,
+        `php ./clients/algoliasearch-client-php/vendor/bin/phpunit tests/output/php`,
         { verbose }
       );
       break;

scripts/docker/build.sh

@@ -4,6 +4,12 @@ ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null && pwd)/../.."
 
 cd $ROOT
 
+JAVA_VERSION=$(cat config/.java-version)
 NODE_VERSION=$(cat .nvmrc)
+PHP_VERSION=$(cat config/.php-version)
 
-docker build --build-arg NODE_VERSION=$NODE_VERSION -t api-clients-automation .
+docker build \
+  --build-arg JAVA_VERSION=$JAVA_VERSION \
+  --build-arg NODE_VERSION=$NODE_VERSION \
+  --build-arg PHP_VERSION=$PHP_VERSION \
+  -t api-clients-automation .

scripts/formatter.ts

@@ -1,4 +1,4 @@
-import { CI, run, runComposerUpdate } from './common';
+import { run, runComposerUpdate } from './common';
 import { createSpinner } from './oraLog';
 
 export async function formatter(
@@ -27,9 +27,7 @@ export async function formatter(
     case 'php':
       await runComposerUpdate(verbose);
       cmd = `yarn run prettier ${folder} --write \
-            && PHP_CS_FIXER_IGNORE_ENV=1 ${
-              CI ? 'php' : 'php8'
-            } clients/algoliasearch-client-php/vendor/bin/php-cs-fixer fix ${folder} --using-cache=no --allow-risky=yes`;
+            && PHP_CS_FIXER_IGNORE_ENV=1 php clients/algoliasearch-client-php/vendor/bin/php-cs-fixer fix ${folder} --using-cache=no --allow-risky=yes`;
       break;
     default:
       return;

scripts/playground.ts

@@ -32,7 +32,7 @@ export async function playground({
        composer update && \
        composer dump-autoload && \
        cd ../../playground/php/src && \
-       php8 ${client}.php`,
+       php ${client}.php`,
         { verbose }
       );
       break;

templates/javascript/clients/client/api/hosts.mustache

@@ -1,6 +1,6 @@
 {{#hasRegionalHost}}
 export const REGIONS = [{{#allowedRegions}}'{{.}}'{{^-last}},{{/-last}}{{/allowedRegions}}] as const;
-export type Region = typeof REGIONS[number];
+export type Region = (typeof REGIONS)[number];
 {{/hasRegionalHost}}
 
 {{^hasRegionalHost}}