Adding vault global inclusion exclusions

content/vault/v1.20.x/content/docs/concepts/client-count/test-vault-exclusion.mdx

@@ -0,0 +1,25 @@
+---
+  page_title: Test Vault Content Exclusion
+---
+
+# Test Vault Content Exclusion
+
+This content should always appear.
+
+<!-- BEGIN: VLT:>=v1.21.x -->
+This content should be REMOVED because current version (1.20.x) is less than 1.21.x
+<!-- END: VLT:>=v1.21.x -->
+
+<!-- BEGIN: VLT:<=v1.21.x -->
+This content should STAY because current version (1.20.x) is less than or equal to 1.21.x
+<!-- END: VLT:<=v1.21.x -->
+
+<!-- BEGIN: VLT:=v1.20.x -->
+This content should STAY because current version equals 1.20.x
+<!-- END: VLT:=v1.20.x -->
+
+<!-- BEGIN: VLT:<v1.19.x -->
+This content should be REMOVED because current version (1.20.x) is not less than 1.19.x
+<!-- END: VLT:<v1.19.x -->
+
+Final content that should always appear.

scripts/prebuild/mdx-transforms/build-mdx-transforms-file.mjs

@@ -19,6 +19,7 @@ import {
 	loadRedirects,
 } from './rewrite-internal-redirects/rewrite-internal-redirects.mjs'
 import { transformExcludeTerraformContent } from './exclude-terraform-content/index.mjs'
+import { transformExcludeVaultContent } from './exclude-vault-content/index.mjs'
 
 const CWD = process.cwd()
 const VERSION_METADATA_FILE = path.join(CWD, 'app/api/versionMetadata.json')
@@ -89,6 +90,7 @@ export async function applyFileMdxTransforms(entry, versionMetadata = {}) {
 		const remarkResults = await remark()
 			.use(remarkMdx)
 			.use(transformExcludeTerraformContent, { filePath })
+			.use(transformExcludeVaultContent, { filePath, version })
 			.use(remarkIncludePartialsPlugin, { partialsDir, filePath })
 			.use(paragraphCustomAlertsPlugin)
 			.use(rewriteInternalRedirectsPlugin, {

scripts/prebuild/mdx-transforms/build-mdx-transforms.mjs

@@ -24,9 +24,12 @@ import {
 	loadRedirects,
 } from './rewrite-internal-redirects/rewrite-internal-redirects.mjs'
 import { transformExcludeTerraformContent } from './exclude-terraform-content/index.mjs'
+import { transformExcludeVaultContent } from './exclude-vault-content/index.mjs'
 
 import { PRODUCT_CONFIG } from '#productConfig.mjs'
 
+export const DIRECTIVE_PRODUCTS = ['VLT', 'TFC', 'TFEnterprise']
+
 /**
  * Given a target directory,
  * Apply MDX transforms to all `.mdx` files found in the directory and its
@@ -37,6 +40,15 @@ import { PRODUCT_CONFIG } from '#productConfig.mjs'
  * And we expect the `partials` directory to be located at:
  * - `<targetDir>/<repoSlug>/<version>/<contentDir>/partials`
  *
+ * Adding this note here for now but the location can change if it's decided
+ * to be somewhere better:
+ * To add content inclusions/exclusions for a certain product, it has to be
+ * included in the array named DIRECTIVE_PRODUCTS so that the relevant code
+ * in `transformExcludeTerraformContent` and `transformExcludeVaultContent`
+ * know to look out for and account for these products.
+ *
+ * e.g. const DIRECTIVE_PRODUCTS = ['VLT', 'TFC', 'TFEnterprise', 'CONSUL', 'NOMAD']
+ *
  * @param {string} targetDir
  * @param {string} outputDir the directory to write transformed files to
  */
@@ -135,6 +147,7 @@ async function applyMdxTransforms(entry, versionMetadata = {}) {
 		const remarkResults = await remark()
 			.use(remarkMdx)
 			.use(transformExcludeTerraformContent, { filePath })
+			.use(transformExcludeVaultContent, { filePath, version })
 			.use(remarkIncludePartialsPlugin, { partialsDir, filePath })
 			.use(paragraphCustomAlertsPlugin)
 			.use(rewriteInternalRedirectsPlugin, {

scripts/prebuild/mdx-transforms/exclude-terraform-content/index.mjs

@@ -4,6 +4,7 @@
  */
 
 import visit from 'unist-util-visit'
+import { DIRECTIVE_PRODUCTS } from '../build-mdx-transforms.mjs'
 
 // this is a courtesy wrapper to prepend error messages
 class ExcludeTerraformContentError extends Error {
@@ -21,6 +22,7 @@ export const BEGIN_RE = /^(\s+)?<!--\s+BEGIN:\s+(?<block>.*?)\s+-->(\s+)?$/
 export const END_RE = /^(\s+)?<!--\s+END:\s+(?<block>.*?)\s+-->(\s+)?$/
 export const DIRECTIVE_RE = /(?<exclusion>TFC|TFEnterprise):only/i
 
+// Adding the directive products parameter to allow for extensibility in tests
 export function transformExcludeTerraformContent({ filePath }) {
 	return function transformer(tree) {
 		// accumulate the content exclusion blocks
@@ -125,6 +127,12 @@ export function transformExcludeTerraformContent({ filePath }) {
 
 			// TODO: line start and end do not take into account front matter, as it is just tree parsing and technically front matter is not part of the MDX tree
 			if (!directive) {
+				// Check if this is a product we should handle
+				const productMatch = flag.match(/^(\w+):/)
+
+				if (productMatch && DIRECTIVE_PRODUCTS.includes(productMatch[1])) {
+					return // Skip this directive - it's for another product
+				}
 				throw new ExcludeTerraformContentError(
 					`Directive block ${block} could not be parsed between lines ${start} and ${end}`,
 					tree,

scripts/prebuild/mdx-transforms/exclude-terraform-content/index.test.mjs

@@ -5,9 +5,19 @@
 
 import { describe, it, expect, vi } from 'vitest'
 import { transformExcludeTerraformContent } from './index.mjs'
+// import { DIRECTIVE_PRODUCTS } from '../build-mdx-transforms.mjs'
 import remark from 'remark'
 import remarkMdx from 'remark-mdx'
 
+// Mock for testing custom directive products
+vi.mock('../build-mdx-transforms.mjs', async (importOriginal) => {
+	const actual = await importOriginal()
+	return {
+		...actual,
+		DIRECTIVE_PRODUCTS: ['VLT', 'TFC', 'TFEnterprise'], // Default for most tests
+	}
+})
+
 const runTransform = async (markdown, filePath) => {
 	const processor = await remark()
 		.use(remarkMdx)
@@ -222,4 +232,39 @@ This content should stay.
 		const result = await runTransform(markdown, filePath)
 		expect(result.trim()).toBe(expected.trim())
 	})
+
+	it('should throw an error for directives with products not in directiveProducts array', async () => {
+		// Override DIRECTIVE_PRODUCTS for this test only
+		vi.doMock('../build-mdx-transforms.mjs', async (importOriginal) => {
+			const actual = await importOriginal()
+			return {
+				...actual,
+				DIRECTIVE_PRODUCTS: ['TFC', 'TFEnterprise'], // CONSUL not included
+			}
+		})
+
+		// Need to re-import the transform after mocking
+		const { transformExcludeTerraformContent: mockTransform } = await import(
+			'./index.mjs'
+		)
+
+		const markdown = `
+<!-- BEGIN: CONSUL:only -->
+This should cause an error - CONSUL not in directiveProducts.
+<!-- END: CONSUL:only -->
+`
+		const customRunTransform = async (markdown, filePath) => {
+			const processor = await remark()
+				.use(remarkMdx)
+				.use(mockTransform, { filePath })
+				.process(markdown)
+			return processor.contents
+		}
+
+		await expect(async () => {
+			return await customRunTransform(markdown, ptfeFilePath)
+		}).rejects.toThrow(
+			'Directive block CONSUL:only could not be parsed between lines 2 and 4',
+		)
+	})
 })