Use runtime values in version context and selector

sfc-gh-dmatthews · sfc-gh-dmatthews · commit f1e3992984a7 · 2024-12-10T17:30:56.000-08:00
Former-commit-id: f5758ed
diff --git a/components/blocks/autofunction.js b/components/blocks/autofunction.js
@@ -152,12 +152,7 @@ const Autofunction = ({
             </a>
             {streamlitFunction.replace("streamlit", "st")}
           </H2>
-          <VersionSelector
-            versionList={versions}
-            snowflakeVersions={snowflakeVersions}
-            functionObject={functionObject}
-            slug={slug}
-          />
+          <VersionSelector functionObject={functionObject} slug={slug} />
         </div>
         <Warning>
           {version && version.startsWith("SiS") ? (
@@ -221,12 +216,7 @@ const Autofunction = ({
           `}
         >
           {headerTitle}
-          <VersionSelector
-            versionList={versions}
-            snowflakeVersions={snowflakeVersions}
-            functionObject={functionObject}
-            slug={slug}
-          />
+          <VersionSelector functionObject={functionObject} slug={slug} />
         </div>
         {deprecated === true ? (
           <Deprecation>
diff --git a/components/utilities/versionSelector.js b/components/utilities/versionSelector.js
@@ -13,23 +13,15 @@ import {
   getBestNumericVersion,
   versionAndPlatformAreCompatible,
 } from "../../context/VersionContext";
-import { CurrentRefinements } from "react-instantsearch-dom";
 
-// const VERSIONS_LIST = publicRuntimeConfig.VERSIONS_LIST;
-// const LATEST_OSS_VERSION = publicRuntimeConfig.LATEST_OSS_VERSION;
-// const PLATFORM_VERSIONS = publicRuntimeConfig.PLATFORM_VERSIONS;
-// const PLATFORM_LATEST_VERSIONS = publicRuntimeConfig.PLATFORM_LATEST_VERSIONS;
-// const PLATFORMS = [DEFAULT_PLATFORM].concat(Object.keys(PLATFORM_VERSIONS))
-const PLATFORMS = [
-  { id: "oss", name: "None" },
-  { id: "sis", name: "Streamlit in Snowflake" },
-  { id: "na", name: "Native Apps" },
-];
+const VERSIONS_LIST = publicRuntimeConfig.VERSIONS_LIST;
+const LATEST_OSS_VERSION = publicRuntimeConfig.LATEST_OSS_VERSION;
+const PLATFORM_VERSIONS = publicRuntimeConfig.PLATFORM_VERSIONS;
+const PLATFORM_LATEST_VERSIONS = publicRuntimeConfig.PLATFORM_LATEST_VERSIONS;
+const PLATFORMS = publicRuntimeConfig.PLATFORMS;
 
 const VersionSelector = ({
-  versionList,
-  snowflakeVersions,
-  functionObject,
+  functionObject, // For anchor link to jump back to function upon version change
 }) => {
   const {
     version: versionContext,
@@ -40,8 +32,6 @@ const VersionSelector = ({
   const [numericVersion, compatiblePlatform] = getBestNumericVersion(
     versionContext,
     platformContext,
-    versionList,
-    snowflakeVersions,
   );
 
   const [widgetPlatform, setWidgetPlatform] = useState(compatiblePlatform);
@@ -54,25 +44,21 @@ const VersionSelector = ({
           // versionContext can be DEFAULT_VERSION (null) or "1.40.0" (even if that's the latest).
           versionContext,
           selectedPlatform,
-          versionList,
-          snowflakeVersions,
         )
       ) {
         // Navigate to new version and platform.
         setVersionAndPlatform({
           newVersion: versionContext,
           newPlatform: selectedPlatform,
           functionName: functionObject ? functionObject.name : "",
-          versionList,
-          snowflakeVersions,
         });
       } else {
         // Just set the widget to the selected platform but dont navigate anywhere.
         // The user should pick a version first.
         setWidgetPlatform(selectedPlatform);
       }
     },
-    [functionObject, versionList, snowflakeVersions],
+    [functionObject],
   );
 
   const handleSelectVersion = useCallback(
@@ -81,17 +67,15 @@ const VersionSelector = ({
         newVersion: selectedVersion,
         newPlatform: widgetPlatform,
         functionName: functionObject ? functionObject.name : "",
-        versionList,
-        snowflakeVersions,
       });
     },
-    [widgetPlatform, functionObject, versionList, snowflakeVersions],
+    [widgetPlatform, functionObject],
   );
 
   const validVersionForWidgetPlatform =
     widgetPlatform == DEFAULT_PLATFORM
-      ? versionList
-      : snowflakeVersions[widgetPlatform];
+      ? VERSIONS_LIST
+      : PLATFORM_VERSIONS[widgetPlatform];
 
   return (
     <Popover.Root>
@@ -115,19 +99,19 @@ const VersionSelector = ({
               aria-label="streamlit platform"
               onValueChange={handleSelectPlatform}
             >
-              {PLATFORMS.map((platform) => (
-                <div key={platform.id}>
+              {Object.keys(PLATFORMS).map((platform) => (
+                <div key={platform}>
                   <RadioGroup.Item
                     className={styles.RadioGroupItem}
-                    value={platform.id}
-                    id={platform.id}
+                    value={platform}
+                    id={platform}
                   >
                     <RadioGroup.Indicator
                       className={styles.RadioGroupIndicator}
                     />
                   </RadioGroup.Item>
-                  <label className={styles.RadioLabel} htmlFor={platform.id}>
-                    {platform.name}
+                  <label className={styles.RadioLabel} htmlFor={platform}>
+                    {PLATFORMS[platform]}
                   </label>
                 </div>
               ))}
diff --git a/context/VersionContext.js b/context/VersionContext.js
@@ -9,6 +9,11 @@ const Context = createContext();
 
 export const DEFAULT_VERSION = "latest";
 export const DEFAULT_PLATFORM = "oss";
+const VERSIONS_LIST = publicRuntimeConfig.VERSIONS_LIST;
+const LATEST_OSS_VERSION = publicRuntimeConfig.LATEST_OSS_VERSION;
+const PLATFORM_VERSIONS = publicRuntimeConfig.PLATFORM_VERSIONS;
+const PLATFORM_LATEST_VERSIONS = publicRuntimeConfig.PLATFORM_LATEST_VERSIONS;
+const PLATFORMS = publicRuntimeConfig.PLATFORMS;
 
 export function VersionContextProvider({ children }) {
   const [initialized, setInitialized] = useState(false);
@@ -19,21 +24,12 @@ export function VersionContextProvider({ children }) {
   const router = useRouter();
 
   const initialize = useCallback(
-    ({
-      newVersion,
-      newPlatform,
-      versionList,
-      snowflakeVersions,
-      functionName = null,
-      currMenuItem = null,
-    }) => {
+    ({ newVersion, newPlatform, functionName = null, currMenuItem = null }) => {
       if (initialized) return [version, platform];
 
       setVersionAndPlatform({
         newVersion,
         newPlatform,
-        versionList,
-        snowflakeVersions,
         functionName,
         currMenuItem,
         updateURL: true,
@@ -50,20 +46,11 @@ export function VersionContextProvider({ children }) {
     ({
       newVersion,
       newPlatform,
-      versionList,
-      snowflakeVersions,
       functionName = null,
       currMenuItem = null,
       updateURL = true,
     }) => {
-      if (
-        !versionAndPlatformAreCompatible(
-          newVersion,
-          newPlatform,
-          versionList,
-          snowflakeVersions,
-        )
-      ) {
+      if (!versionAndPlatformAreCompatible(newVersion, newPlatform)) {
         console.error(
           "Incompatible version and platform:",
           newVersion,
@@ -76,12 +63,7 @@ export function VersionContextProvider({ children }) {
         return;
       }
 
-      const cleanedVersion = isLatestVersion(
-        newVersion,
-        newPlatform,
-        versionList,
-        snowflakeVersions,
-      )
+      const cleanedVersion = isLatestVersion(newVersion, newPlatform)
         ? DEFAULT_VERSION
         : newVersion;
       setVersionState(cleanedVersion);
@@ -131,16 +113,11 @@ export function useVersion() {
   return useContext(Context);
 }
 
-export function isLatestVersion(
-  version,
-  platform,
-  versionList,
-  snowflakeVersions,
-) {
+export function isLatestVersion(version, platform) {
   const maxVersion =
     platform == DEFAULT_PLATFORM
-      ? getLatest(versionList)
-      : getLatest(snowflakeVersions[platform]);
+      ? LATEST_OSS_VERSION
+      : PLATFORM_LATEST_VERSIONS[platform];
 
   return version == DEFAULT_VERSION || version == maxVersion;
 }
@@ -239,55 +216,38 @@ export function getVersionAndPlatformFromPathPart(pathPart) {
   return [version, cleanedPlatform];
 }
 
-export function versionAndPlatformAreCompatible(
-  version,
-  platform,
-  versionList,
-  snowflakeVersions,
-) {
+export function versionAndPlatformAreCompatible(version, platform) {
   if (version == DEFAULT_VERSION) return true;
 
-  if (platform == DEFAULT_PLATFORM && versionList.indexOf(version) >= 0) {
+  if (platform == DEFAULT_PLATFORM && VERSIONS_LIST.indexOf(version) >= 0) {
     return true;
   }
 
-  return snowflakeVersions[platform].indexOf(version) >= 0;
+  return PLATFORM_VERSIONS[platform].indexOf(version) >= 0;
 }
 
-export function getBestNumericVersion(
-  version,
-  platform,
-  versionList,
-  snowflakeVersions,
-) {
+export function getBestNumericVersion(version, platform) {
   if (version == DEFAULT_VERSION) {
-    if (snowflakeVersions[platform]) {
+    if (PLATFORM_VERSIONS[platform]) {
       // This is a valid platform so return the latest version in the platform.
-      return [getLatest(snowflakeVersions[platform]), platform];
+      return [PLATFORM_LATEST_VERSIONS[platform], platform];
     } else {
       // This is an invalid platform so we return the latest version for OSS.
-      return [getLatest(versionList), DEFAULT_PLATFORM];
+      return [LATEST_OSS_VERSION, DEFAULT_PLATFORM];
     }
   } else {
-    if (
-      versionAndPlatformAreCompatible(
-        version,
-        platform,
-        versionList,
-        snowflakeVersions,
-      )
-    ) {
+    if (versionAndPlatformAreCompatible(version, platform)) {
       // This is a numeric version that is compatible with the platform. Return it all back.
       return [version, platform];
     } else {
-      if (snowflakeVersions[platform]) {
+      if (PLATFORM_VERSIONS[platform]) {
         // Version and platform are incompatible, but platform exists. So return the latest
         // for the platform.
-        return [getLatest(snowflakeVersions[platform]), platform];
+        return [PLATFORM_LATEST_VERSIONS[platform], platform];
       } else {
         // Version and platform are incompatible, and platform does not exist. So return the
         // latest for OSS.
-        return [getLatest(versionList), DEFAULT_PLATFORM];
+        return [LATEST_OSS_VERSION, DEFAULT_PLATFORM];
       }
     }
   }
diff --git a/next.config.js b/next.config.js
@@ -25,6 +25,7 @@ for (const index in Object.keys(PLATFORM_NOTES)) {
 const PLATFORM_VERSIONS = platformVersions;
 const PLATFORM_LATEST_VERSIONS = latestPlatformVersion;
 const PLATFORMS = {};
+PLATFORMS["oss"] = "None";
 PLATFORMS["sis"] = "Streamlit in Snowflake";
 PLATFORMS["na"] = "Snowflake Native Apps";
 
diff --git a/pages/[...slug].js b/pages/[...slug].js
@@ -135,8 +135,6 @@ export default function Article({
     router,
     newVersion: versionFromStaticLoad,
     newPlatform: platformFromStaticLoad,
-    versionList: versions,
-    snowflakeVersions,
     functionName: null,
     currMenuItem,
   });
