fix(docs-page): process.env.ENABLE_VERSIONED_DOCS is string (#382)

* fix(docs-page): env-var check - `process.env.ENABLE_VERSIONED_DOCS === 'true'` * chore: changeset
hashicorp · Oct 5, 2021 · cc46ed6 · cc46ed6 · vercel · Oct 5, 2021
1 parent ef6333f
commit cc46ed6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 6 deletions.
diff --git a/.changeset/tender-lies-type.md b/.changeset/tender-lies-type.md
@@ -0,0 +1,7 @@
+---
+'@hashicorp/react-docs-page': patch
+---
+
+This updates logic to check `process.env.ENABLE_VERSIONED_DOCS === 'true'` since environment variables are _always strings_.
+
+This should prevent some unintended behavior if ENABLE_VERSIONED_DOCS is parsed as a string `"false"`, but unintentionally evaluating to `truthy`
diff --git a/packages/docs-page/docs.mdx b/packages/docs-page/docs.mdx
@@ -30,7 +30,7 @@ We have a lot of docs sites, all of which render content in exactly the same way
 >{`<DocsPage
   product={{ name: 'Nomad', slug: 'nomad' }}
   baseRoute='docs'
-  showVersionSelect={false /*process.env.ENABLE_VERSIONED_DOCS*/}
+  showVersionSelect={false /* process.env.ENABLE_VERSIONED_DOCS === "true" */}
   // pass in the results of executing the 'generateStaticProps' function from '@hashicorp/react-docs-page/server'
   staticProps={staticPropsResult}
 >

diff --git a/packages/docs-page/index.tsx b/packages/docs-page/index.tsx
@@ -47,7 +47,7 @@ const DocsPageWrapper: FunctionComponent<DocsPageWrapperProps> = ({
   githubFileUrl,
   product: { name, slug },
   showEditPage = true,
-  showVersionSelect = process.env.ENABLE_VERSIONED_DOCS,
+  showVersionSelect = process.env.ENABLE_VERSIONED_DOCS === 'true',
   versions,
 }) => {
   const isMobile = useIsMobile()
@@ -117,7 +117,8 @@ const DocsPageWrapper: FunctionComponent<DocsPageWrapperProps> = ({
           id="inner"
           role="main"
           className={classNames(s.inner, s.tempJumpToSectionParent, {
-            [s.versionedDocsOffset]: process.env.ENABLE_VERSIONED_DOCS,
+            [s.versionedDocsOffset]:
+              process.env.ENABLE_VERSIONED_DOCS === 'true',
           })}
         >
           <Content

diff --git a/packages/docs-page/props.js b/packages/docs-page/props.js
@@ -35,7 +35,7 @@ module.exports = {
   showVersionedDocs: {
     type: 'boolean',
     description:
-      'If `true`, a version select option will be displayed. Defaults to `process.env.ENABLE_VERSIONED_DOCS`',
+      'If `true`, a version select option will be displayed. Defaults to `process.env.ENABLE_VERSIONED_DOCS === "true"`',
     default: null,
   },
   additionalComponents: {

diff --git a/packages/docs-page/server/generate-static-paths.ts b/packages/docs-page/server/generate-static-paths.ts
@@ -33,7 +33,7 @@ export interface GenerateStaticPathsContext {
 
 const defaultOptions = {
   VERCEL_ENV: process.env.VERCEL_ENV,
-  ENABLE_VERSIONED_DOCS: process.env.ENABLE_VERSIONED_DOCS,
+  ENABLE_VERSIONED_DOCS: process.env.ENABLE_VERSIONED_DOCS === 'true',
 }
 
 export async function generateStaticPaths(

diff --git a/packages/docs-page/server/generate-static-props.ts b/packages/docs-page/server/generate-static-props.ts
@@ -77,7 +77,7 @@ export function mapVersionList(
 
 const defaultOptions = {
   VERCEL_ENV: process.env.VERCEL_ENV,
-  ENABLE_VERSIONED_DOCS: process.env.ENABLE_VERSIONED_DOCS,
+  ENABLE_VERSIONED_DOCS: process.env.ENABLE_VERSIONED_DOCS === 'true',
 }
 
 export async function generateStaticProps(