yindo/posthog.com
1
0
Fork 0
mirror of https://github.com/BillyOutlast/posthog.com.git synced 2026-02-04 03:11:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

remove netlify from codebase (#5064)

Browse Source
This commit is contained in:
Eli Kinsey
2023-01-12 03:35:09 -08:00
committed by GitHub
parent 45fce59efe
commit 05761de0ed
26 changed files with 9 additions and 4392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
scripts/safe_rename.js
View File

@@ -1,147 +0,0 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const fs = require('fs')
const fetch = require('node-fetch')
let DEBUG = false
const log = (...args) => {
if (DEBUG) {
console.log.apply(null, args)
}
}
/** Return date (without time) in ISO format. */
const formatDate = (date) => {
return date.toISOString().slice(0, 10)
}
const redirectText = (from, to) => {
return `
[[redirects]]
from = "${from}"
to = "${to}"
`
}
const redirectWithDateCommentText = (date, redirect) => {
return `
# Added: ${formatDate(date)}${redirect}`
}
// Rules
const samePath = ({ fromPath, toPath }) => {
return fromPath === toPath
}
const mdToMdx = ({ fromPath, toPath }) => {
// # old rule
// # return '.mdx' not in from_paths[i] and '.mdx' in to_paths[i]
return fromPath.endsWith('.md') && toPath.endsWith('.mdx')
}
const redirectExists = ({ redirect, localConfig, remoteConfig }) => {
return localConfig.indexOf(redirect.trim()) !== -1 || remoteConfig.indexOf(redirect.trim()) !== -1
}
const fromDotStar = ({ fromPath }) => {
return fromPath == '(.*)'
}
const isSnippetsRename = ({ fromPath, toPath }) => {
return fromPath.indexOf('/snippets/') !== -1 || toPath.indexOf('/snippets') !== -1
}
const skipRules = {
samePath,
mdToMdx,
redirectExists,
fromDotStar,
isSnippetsRename,
}
// # Load existing remote redirect config
const getRemoteConfig = async () => {
const response = await fetch('https://raw.githubusercontent.com/PostHog/posthog.com/master/netlify.toml')
return await response.text()
}
// # Load existing redirect file to be used to avoid duplicates
const getLocalConfig = async () => {
return await fs.promises.readFile('./netlify.toml', 'utf8')
}
const appendToLocalConfig = async (newRedirects) => {
await fs.promises.appendFile('./netlify.toml', newRedirects)
}
const getRedirects = async ({ gitDiff, localConfig, remoteConfig, debug = false }) => {
DEBUG = debug
log(gitDiff)
const renameFromRegex = new RegExp('rename from contents(.*).md', 'g')
const renameToRegex = new RegExp('rename to contents(.*).md', 'g')
const fromPaths = Array.from(gitDiff.matchAll(renameFromRegex), (m) => m[1])
const toPaths = Array.from(gitDiff.matchAll(renameToRegex), (m) => m[1])
log(fromPaths, toPaths)
const newRedirects = []
if (fromPaths.length > 0 && fromPaths.length === toPaths.length) {
for (let i = 0; i < fromPaths.length; ++i) {
// handle index default directory files. /path/index will become /path
const fromPath = fromPaths[i].replace(/\/index$/, '', fromPaths[i])
const toPath = toPaths[i].replace(/\/index$/, '', toPaths[i])
const redirect = redirectText(fromPath, toPath)
// console.log(redirect)
log(`Testing if redirects are required for: "${fromPath}" to "${toPath}"`)
let skipRedirect = false
for (const [skipRuleName, skipRuleFunction] of Object.entries(skipRules)) {
if (skipRedirect === false) {
skipRedirect = skipRuleFunction({ fromPath, toPath, redirect, localConfig, remoteConfig })
log(`Rule: "${skipRuleName}"', 'skipRedirect?', ${skipRedirect}`)
}
}
if (skipRedirect === false) {
newRedirects.push(redirectWithDateCommentText(new Date(), redirect))
} else {
log('Not including redirect', redirect)
}
}
} else {
log('No path changes found')
}
return newRedirects
}
const main = async () => {
try {
const gitDiff = await fs.promises.readFile('./pr_diff', 'utf8')
const remoteConfig = await getRemoteConfig()
const localConfig = await getLocalConfig()
const debug = process.env.DEBUG
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
if (redirects.length > 0) {
log('Writing', redirects)
await appendToLocalConfig(redirects.join(''))
}
} catch (error) {
console.error(error)
}
}
if (process.env.RUN_AS_SCRIPT === 'true') {
main()
}
module.exports = {
getRedirects,
}

151
scripts/safe_rename.test.js
View File

@@ -1,151 +0,0 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const getRedirects = require('./safe_rename').getRedirects
jest.useFakeTimers().setSystemTime(new Date('2021-08-09').getTime())
const debug = false
const singleRenameGitDiff = `
rename from contents/docs/one.md
rename to contents/docs/two.md`
const multiRenameGitDiff = `
rename from contents/docs/one.md
rename to contents/docs/two.md
rename from contents/docs/cheese.md
rename to contents/docs/mushroom.md
rename from contents/docs/fish.md
rename to contents/docs/monkey.md`
const emptyConfig = ``
const existingRedirectConfig = `
# Added: 2021-08-03
[[redirects]]
from = "/docs/one"
to = "/docs/two"`
test('redirect will be added for single file rename', async () => {
const gitDiff = singleRenameGitDiff
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(1)
expect(redirects[0]).toContain('# Added: 2021-08-09')
expect(redirects[0]).toContain('from = "/docs/one"')
expect(redirects[0]).toContain('to = "/docs/two"')
})
test('redirect will be added for multi file rename', async () => {
const gitDiff = multiRenameGitDiff
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(3)
expect(redirects[0]).toContain('# Added: 2021-08-09')
expect(redirects[0]).toContain('from = "/docs/one"')
expect(redirects[0]).toContain('to = "/docs/two"')
expect(redirects[1]).toContain('# Added: 2021-08-09')
expect(redirects[1]).toContain('from = "/docs/cheese"')
expect(redirects[1]).toContain('to = "/docs/mushroom"')
expect(redirects[2]).toContain('from = "/docs/fish"')
expect(redirects[2]).toContain('to = "/docs/monkey"')
})
test('redirect will only be added for non-existing redirects in multi file rename', async () => {
const gitDiff = multiRenameGitDiff
const localConfig = emptyConfig
const remoteConfig = existingRedirectConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(2)
expect(redirects[0]).toContain('from = "/docs/cheese"')
expect(redirects[0]).toContain('to = "/docs/mushroom"')
expect(redirects[1]).toContain('from = "/docs/fish"')
expect(redirects[1]).toContain('to = "/docs/monkey"')
})
test('redirect will not be added if it already exists in the remote config', async () => {
const gitDiff = singleRenameGitDiff
const localConfig = emptyConfig
const remoteConfig = existingRedirectConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})
test('redirect will not be added if it already exists in the local config', async () => {
const gitDiff = singleRenameGitDiff
const localConfig = existingRedirectConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})
test('redirect will not be added if rename from /name to /name/index.mdx', async () => {
const gitDiff = `
rename from contents/docs/filename
rename to contents/docs/name/index.mdx`
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})
test('redirect will not be added if rename from /name to /name/index.md', async () => {
const gitDiff = `
rename from contents/docs/name
rename to contents/docs/name/index.md`
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})
test('redirect will not be added if rename from .md to .mdx', async () => {
const gitDiff = `
rename from contents/docs/filename.md
rename to contents/docs/filename.mdx`
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})
test('redirect will not be added when renaming snippets', async () => {
const gitDiff = `
rename from contents/docs/snippets/js/capture.mdx
rename to contents/docs/snippets/js/special-capture.mdx`
const localConfig = emptyConfig
const remoteConfig = emptyConfig
const redirects = await getRedirects({ gitDiff, localConfig, remoteConfig, debug })
expect(redirects.length).toBe(0)
})