From dcae2d8fb411c626c62271dc38fcb23920fc912c Mon Sep 17 00:00:00 2001
From: mck <mck@apache.org>
Date: Fri, 6 Dec 2024 13:05:34 +0100
Subject: [PATCH] =?UTF-8?q?SQUASH=20=E2=80=93=20wip=20=E2=80=93=C2=A0gener?=
 =?UTF-8?q?ate=20spec=20html=20pages=20for=20each=20intree=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 cqlprotodoc/template.gohtml                   | 12 +---
 site-content/Dockerfile                       |  2 +-
 site-content/docker-entrypoint.sh             | 63 +++++++------------
 ...process-native-protocol-specs-in-docker.sh | 53 ----------------
 site-ui/src/layouts/native-protocol.hbs       |  6 +-
 5 files changed, 29 insertions(+), 107 deletions(-)
 delete mode 100755 site-content/process-native-protocol-specs-in-docker.sh
diff --git a/cqlprotodoc/template.gohtml b/cqlprotodoc/template.gohtml
index 12ed19f9d..efa99b14f 100644
--- a/cqlprotodoc/template.gohtml
+++ b/cqlprotodoc/template.gohtml
@@ -24,15 +24,9 @@
     </style>
 </head>
 <body>
-    <nav class="top">
-        <ul>
-            <li><a href="native_protocol_v5.html">v5</a></li>
-            <li><a href="native_protocol_v4.html">v4</a></li>
-            <li><a href="native_protocol_v3.html">v3</a></li>
-            <li><a href="NOTICE">NOTICE</a></li>
-        </ul>
-    </nav>
-    <pre>{{.LicenseHTML}}</pre>
+<!--
+{{.LicenseHTML}}
+-->
     <h1>{{.Title}}</h1>
     <h2>Table of Contents</h2>
         <nav>
diff --git a/site-content/Dockerfile b/site-content/Dockerfile
index b40672ce8..0092d032d 100644
--- a/site-content/Dockerfile
+++ b/site-content/Dockerfile
@@ -33,6 +33,7 @@ RUN apt update && \
     apt install -y \
         openjdk-8-jdk \
         openjdk-11-jdk \
+        openjdk-17-jdk \
         python3 \
         python3-pip \
         ant \
@@ -123,7 +124,6 @@ EXPOSE 5151/tcp
 USER ${BUILD_USER}
 WORKDIR ${BUILD_DIR}
 COPY docker-entrypoint.sh /usr/local/bin/
-COPY process-native-protocol-specs-in-docker.sh /usr/local/bin/
 ENTRYPOINT ["docker-entrypoint.sh"]
 
 # Possible commands are listed below. The entrypoint will accept any combination of these commands.
diff --git a/site-content/docker-entrypoint.sh b/site-content/docker-entrypoint.sh
index a22b0e436..86d470785 100755
--- a/site-content/docker-entrypoint.sh
+++ b/site-content/docker-entrypoint.sh
@@ -1,4 +1,19 @@
 #!/bin/bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 # Abort script if a command fails
 set -e
@@ -7,7 +22,6 @@ export CASSANDRA_USE_JDK11=true
 export CASSANDRA_WEBSITE_DIR="${BUILD_DIR}/cassandra-website"
 export CASSANDRA_SOURCE_DIR="${BUILD_DIR}/cassandra"
 export CASSANDRA_WORKING_DIR="${BUILD_DIR}/working/cassandra"
-export CASSANDRA_WORKING_DOC="${CASSANDRA_WORKING_DIR}/doc"
 GIT_USER_SETUP="false"
 
 setup_git_user() {
@@ -49,10 +63,10 @@ generate_cassandra_versioned_docs() {
     commit_changes_to_branch="disabled"
   fi
 
+  pushd "${CASSANDRA_WORKING_DIR}" > /dev/null
   for version in ${GENERATE_CASSANDRA_VERSIONS}
   do
     log_message "INFO" "Checking out '${version}'"
-    pushd "${CASSANDRA_WORKING_DIR}" > /dev/null
     git clean -xdff
     git checkout "${version}"
 
@@ -70,13 +84,16 @@ generate_cassandra_versioned_docs() {
       # For Cassandra 3.11 docs use JDK 8
       java_version="/usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java"
       javac_version="/usr/lib/jvm/java-8-openjdk-amd64/bin/javac"
-      ant_cmd_options=""
-    else
+    elif [ "$(cut -d'.' -f1 <<< "${doc_version}")" -lt 5 ]
+    then
       # For Cassandra 4.0+ docs use JDK 11
-      # TODO – from 5 onwards, we can detect the default JDK version from the build.xml file
       java_version="/usr/lib/jvm/java-11-openjdk-amd64/bin/java"
       javac_version="/usr/lib/jvm/java-11-openjdk-amd64/bin/javac"
       ant_cmd_options="-Duse.jdk11=true"
+    else
+      java_version_=$(grep 'property\s*name="java.default"' build.xml |sed -ne 's/.*value="\([^"]*\)".*/\1/p')
+      java_version="/usr/lib/jvm/java-${java_version_}-openjdk-amd64/bin/java"
+      javac_version="/usr/lib/jvm/java-${java_version_}-openjdk-amd64/bin/javac"
     fi
     sudo update-alternatives --set java ${java_version}
     sudo update-alternatives --set javac ${javac_version}
@@ -84,9 +101,7 @@ generate_cassandra_versioned_docs() {
     log_message "INFO" "Using Java compiler version $(javac -version) to compile Cassandra JARs"
     ant realclean
     ant "${ant_cmd_options}" gen-asciidoc
-    popd > /dev/null
 
-    pushd "${CASSANDRA_WORKING_DIR}" > /dev/null
     if [ "${commit_changes_to_branch}" = "enabled" ]
     then
       # Remove the doc/* directory entries in the .gitignore file so we can commit the generated docs to the working
@@ -204,25 +219,6 @@ render_site_content_to_html() {
   popd > /dev/null
 }
 
-generate_native_protocol_specs_pages() {
-  log_message "INFO" "Processing native protocols spec page"
-  for version in ${GENERATE_CASSANDRA_VERSIONS}
-    do
-      log_message "INFO" "Checking out '${version}'"
-      pushd "${CASSANDRA_WORKING_DIR}" > /dev/null
-      git clean -xdff
-      git checkout "${version}"
-
-      local doc_version=""
-      doc_version=$(grep 'property\s*name=\"base.version\"' build.xml |sed -ne 's/.*value=\"\([^"]*\)\".*/\1/p')
-      if [ -d "${CASSANDRA_WEBSITE_DIR}/site-content/build/html/Cassandra/$(cut -d'.' -f1-2 <<< "${doc_version}")/cassandra/native-protocol" ]
-      then
-        sudo /usr/local/bin/process-native-protocol-specs-in-docker.sh "$(cut -d'.' -f1-2 <<< "${doc_version}")"
-      fi
-      popd > /dev/null
-    done
-}
-
 prepare_site_html_for_publication() {
   pushd "${CASSANDRA_WEBSITE_DIR}" > /dev/null
 
@@ -230,7 +226,6 @@ prepare_site_html_for_publication() {
   log_message "INFO" "Moving site HTML to content/"
   mkdir -p content/doc
   cp -r site-content/build/html/* content/
-  #rm -f content/_/sed*
 
   # remove hardcoded domain name, and empty domain names first before we duplicate and documentation
   content_files_to_change=($(grep -rl 'https://cassandra.apache.org/' content/))
@@ -332,15 +327,6 @@ run_preview_mode() {
     render_site_content_to_html
   fi
 
-  if [ "${COMMAND_GENERATE_DOCS}" = "run" ]
-  then
-    export -f generate_native_protocol_specs_pages
-    on_change_functions="${on_change_functions} && generate_native_protocol_specs_pages"
-
-    GENERATE_CASSANDRA_VERSIONS=$(cut -d' ' -f1 <<< "${GENERATE_CASSANDRA_VERSIONS}")
-  fi
-
-
   pushd "${CASSANDRA_WEBSITE_DIR}/site-content/build/html" > /dev/null
   live-server --port=5151 --host=0.0.0.0 --no-browser --no-css-inject --wait=2000 &
   popd > /dev/null
@@ -432,11 +418,6 @@ then
   export DOCSEARCH_INDEX_VERSION=latest
 
   render_site_content_to_html
-if [ "${COMMAND_GENERATE_DOCS}" = "run" ]
-then
-  generate_native_protocol_specs_pages
-fi
-
   prepare_site_html_for_publication
 fi
 
diff --git a/site-content/process-native-protocol-specs-in-docker.sh b/site-content/process-native-protocol-specs-in-docker.sh
deleted file mode 100755
index 26b0d65fe..000000000
--- a/site-content/process-native-protocol-specs-in-docker.sh
+++ /dev/null
@@ -1,53 +0,0 @@
-#!/bin/bash
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License.  You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Exit immediately if a command exits with a non-zero status.
-set -e
-
-# Variables
-DOC_VERSION="$1"
-GO_VERSION="1.23.1"
-GO_TAR="go${GO_VERSION}.linux-amd64.tar.gz"
-PARSER_DIR="/home/build/cassandra-website/cqlprotodoc"
-WEBSITE_DIR="/home/build/cassandra-website"
-CASSANDRA_DIR="/home/build/cassandra"
-
-# Step 0: Download and install Go
-echo "Downloading Go $GO_VERSION..."
-wget -q https://golang.org/dl/$GO_TAR
-
-echo "Installing Go..."
-tar -C /usr/local -xzf $GO_TAR
-
-# Set Go environment variables
-export PATH=$PATH:/usr/local/go/bin
-export GOPATH=$HOME/go
-
-# Step 1: Building the parser
-echo "Building the cqlprotodoc..."
-cd "$PARSER_DIR"
-go build -o cqlprotodoc
-
-# Step 2: Process the spec files using the parser
-echo "Processing the .spec files..."
-"$PARSER_DIR"/cqlprotodoc "$CASSANDRA_DIR/doc" "$WEBSITE_DIR/site-content/build/html/Cassandra/$DOC_VERSION/cassandra/native-protocol"
-
-# Step 3: Cleanup - Remove the Cassandra and parser directories
-echo "Cleaning up..."
-rm -rf "$PARSER_DIR/cqlprotodoc" "$PARSER_DIR/specs" /usr/local/go $GO_TAR
-
-echo "Script completed successfully."
diff --git a/site-ui/src/layouts/native-protocol.hbs b/site-ui/src/layouts/native-protocol.hbs
index 644c41a39..e5124029b 100644
--- a/site-ui/src/layouts/native-protocol.hbs
+++ b/site-ui/src/layouts/native-protocol.hbs
@@ -158,9 +158,9 @@
     }
 
     const files = [
-        'native_protocol_v3.html',
-        'native_protocol_v4.html',
-        'native_protocol_v5.html',
+        '../_attachments/native_protocol_v3.html',
+        '../_attachments/native_protocol_v4.html',
+        '../_attachments/native_protocol_v5.html',
     ];
 
     window.onload = function () {
