Merge pull request #249 from dotCMS/changelog-singleton-fix

fixed the v param for evergreen versions

Author: jdcmsd

components/changelogs/ChangeLogList.js

@@ -3,21 +3,21 @@
 import OnThisPage from "../navigation/OnThisPage";
 import ChangeLogEntry from "./ChangeLogEntry";
 import Link from "next/link";
-import { useSearchParams, useRouter } from "next/navigation";
+import { useSearchParams } from "next/navigation";
 import { extractDateForTables } from '../../util/formatDate'
 import { useChangelog } from "@/hooks/useChangelog";
 import { ChevronLeft, ChevronRight, Loader2 } from "lucide-react";
 import Breadcrumbs from "../navigation/Breadcrumbs";
 import PaginationBar from "../PaginationBar";
 import Dropdown from "../shared/dropdown";
-import { useState, useEffect } from "react";
+import { useEffect } from "react";
 
 export default function ChangeLogContainer({ sideNav, slug }) {
   //const router = useRouter(); // see removal of router in handleVersionChange
   const searchParams = useSearchParams();
   const paramLts = searchParams.get("lts");
-
-  const [singleVersion, setSingleVersion] = useState(searchParams.get("v"));
+  /** Always read from URL (useState initial value can miss ?v= on first paint). */
+  const vParam = searchParams.get("v") ?? "";
 
   let isLts = paramLts && paramLts !== "false";
   let vLts = "";
@@ -29,7 +29,7 @@ export default function ChangeLogContainer({ sideNav, slug }) {
   const { data, loading, error, hasNextPage, hasPrevPage } = useChangelog(
     currentPage,
     paramLts,
-    singleVersion,
+    vParam,
   );
 
   // Handle hash scrolling after data is loaded
@@ -192,6 +192,19 @@ export default function ChangeLogContainer({ sideNav, slug }) {
           <ChangeLogEntry key={item?.identifier || index} item={item} index={index} />
         ))}
 
+        {vParam && (
+          <p className="mt-8 pl-1 text-base leading-7 text-foreground">
+            Want to browse every release?{" "}
+            <Link
+              href="/docs/changelogs"
+              className="text-primary-purple hover:opacity-80 underline hover:no-underline"
+            >
+              Visit the full changelog
+            </Link>
+            .
+          </p>
+        )}
+
         <div className="mt-8 mb-12">
           <PaginationBar pagination={data.pagination} currentPage={data.pagination.page} additionalQueryParams={isLts ? `&lts=${isLts}` : ""} />
         </div>

hooks/useChangelog.ts

@@ -18,6 +18,10 @@ export function useChangelog(currentPage: number = 1, vLts: string = "false", si
   const [error, setError] = useState<Error | null>(null);
   const [page, setPage] = useState(currentPage);
 
+  useEffect(() => {
+    setPage(currentPage);
+  }, [currentPage]);
+
   const handleNextPage = () => setPage(prev => prev + 1);
   const handlePrevPage = () => setPage(prev => Math.max(1, prev - 1));
 
@@ -39,7 +43,7 @@ export function useChangelog(currentPage: number = 1, vLts: string = "false", si
     }
 
     fetchChangelog();
-  }, [page, vLts]);
+  }, [page, vLts, singleVersion]);
 
   return { 
     data, 

services/docs/getChangelog/getChangelog.ts

@@ -2,12 +2,19 @@ import { SIZE_PAGE } from './config';
 import { logRequest } from '@/util/logRequest'; 
 import {  graphqlResults } from '@/services/gql';
 
-export const getChangelog = async ({ page = 1, vLts = "false", singleVersion = "", limit = SIZE_PAGE }) => {
-  const assembleQuery = (buildQuery:string, ltsQuery:string, ltsMajVersion:string, singleVersion:string,
-                          limit:number, page:number, sortBy:string) => {
-    return `query ContentAPI {
+/** Escape a value for use inside Lucene quoted term (query_string). */
+function luceneQuotedTerm(value: string): string {
+  return value.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
+}
+
+/**
+ * Embed full Lucene query in GraphQL string literal — inner " must be escaped.
+ */
+function assembleQuery(luceneQuery: string, limit: number, page: number, sortBy: string) {
+  const escaped = luceneQuery.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
+  return `query ContentAPI {
       DotcmsbuildsCollection(
-          query: "${buildQuery} ${ltsQuery} ${ltsMajVersion} ${singleVersion}"
+          query: "${escaped}"
           limit: ${limit}
           page: ${page}
           sortBy: "${sortBy}"
@@ -42,16 +49,17 @@ export const getChangelog = async ({ page = 1, vLts = "false", singleVersion = "
           offset
       }
     }`;
-  };
-  
+}
+
+export const getChangelog = async ({ page = 1, vLts = "false", singleVersion = "", limit = SIZE_PAGE }) => {
   //Basic type info for querying any changelogs at all
   const buildQuery =
   '+contentType:Dotcmsbuilds +Dotcmsbuilds.released:true +Dotcmsbuilds.showInChangeLog:true +live:true';
 
   //Build query components to grab one of each of the LTS major versions, for reference
   const ltsQueryMaj = '+Dotcmsbuilds.lts:1';
   const sortByEol = 'Dotcmsbuilds.eolDate desc';
-  const ltsMajorQuery = assembleQuery(buildQuery, ltsQueryMaj, "", "", limit, page, sortByEol);
+  const ltsMajorQuery = assembleQuery(`${buildQuery} ${ltsQueryMaj}`, limit, page, sortByEol);
   const ltsMajorResults =  await logRequest(async () => graphqlResults(ltsMajorQuery), 'getLTSMajorVersions');
   const ltsMajorResult = ltsMajorResults?.data;
 
@@ -61,9 +69,11 @@ export const getChangelog = async ({ page = 1, vLts = "false", singleVersion = "
     throw new Error(ltsMajorResults.errors[0].message);
   }
 
-  //if singleVersion is provided, check if it's an LTS patch version
+  // If singleVersion is provided while already scoped to LTS (lts=…), detect patch lines
+  // (e.g. 23.1.2 under tag 23.1). Skip when v is used alone on "current" — otherwise short
+  // tags like "26" match calver minors such as 26.03.23-01 and we drop the minor filter.
   let ltsPatchVersion = "";
-  if(singleVersion){
+  if (singleVersion && vLts && vLts !== "false") {
     for(const item of ltsMajorResult.DotcmsbuildsCollection){
       for (const vTag of item.tags){
         if(singleVersion.startsWith(vTag) && singleVersion !== vTag){
@@ -95,7 +105,13 @@ export const getChangelog = async ({ page = 1, vLts = "false", singleVersion = "
   const ltsMajVersion = sussOutLatestMajor(ltsMajorResult.DotcmsbuildsCollection[0], vLts);
   //console.log("sussed as:", ltsMajVersion);
   const sortBy = 'Dotcmsbuilds.releasedDate desc, Dotcmsbuilds.minor desc';
-  const query = assembleQuery(buildQuery, ltsQuery, ltsMajVersion, (singleVersion && !ltsPatchVersion) ? `+Dotcmsbuilds.minor:${singleVersion}` : "", (ltsMajVersion ? 20 : limit), page, sortBy);
+  // Quote minor so hyphens (e.g. 26.03.23-01) are not parsed as Lucene operators.
+  const minorClause =
+    singleVersion && !ltsPatchVersion
+      ? `+Dotcmsbuilds.minor:"${luceneQuotedTerm(singleVersion)}"`
+      : '';
+  const luceneQuery = `${buildQuery} ${ltsQuery} ${ltsMajVersion} ${minorClause}`.trim();
+  const query = assembleQuery(luceneQuery, ltsMajVersion ? 20 : limit, page, sortBy);
   const result = await logRequest(async () => graphqlResults(query), 'getChangelog');
 
   if (result?.errors && result.errors.length > 0) {