doesitarm/build-lists.js
ThatGuySam 747e564e17 fix(build): prune stale generated api endpoints
Clean list-specific JSON endpoint directories before rewriting them so local and deploy-style API builds do not fail on leftover files from older runs.

Keep the count check, but count only generated JSON outputs so the verification reflects the actual endpoint set.
2026-03-15 12:55:06 -05:00

753 lines
23 KiB
JavaScript

import { dirname, basename, extname, join } from 'path'
import os from 'os'
import fs from 'fs-extra'
import dotenv from 'dotenv'
import semver from 'semver'
import memoize from 'fast-memoize'
import has from 'just-has'
import { saveYouTubeVideos } from '~/helpers/api/youtube/build.js'
import buildAppList from '~/helpers/build-app-list.js'
import buildGamesList from '~/helpers/build-game-list.js'
import buildHomebrewList from '~/helpers/build-homebrew-list.js'
import buildVideoList from '~/helpers/build-video-list.js'
import buildDeviceList from '~/helpers/build-device-list.js'
import {
saveSitemap,
getUrlsForAstroDefinedPages
} from '~/helpers/api/sitemap/build.js'
import { deviceSupportsApp } from '~/helpers/devices.js'
import getListSummaryNumbers from '~/helpers/get-list-summary-numbers.js'
import { logArraysDifference } from '~/helpers/array.js'
import {
getRelatedVideos
} from '~/helpers/related.js'
import { buildVideoPayload, buildAppBenchmarkPayload } from '~/helpers/build-payload.js'
import {
categories,
getCategoryKindName
} from '~/helpers/categories.js'
import {
getAppType,
getAppEndpoint,
getVideoEndpoint,
isVideo
} from '~/helpers/app-derived.js'
import { makeSearchableList } from '~/helpers/searchable-list.js'
import {
writeStorkToml
} from '~/helpers/stork/toml.js'
import {
KindListMemoized as KindList
} from '~/helpers/api/kind.js'
import {
apiDirectory
} from '~/helpers/api/config.js'
import {
cliOptions
} from '~/helpers/cli-options.js'
import {
streamToJson
} from '~/helpers/json.js'
// Setup dotenv
dotenv.config()
let timeRunGetListArray = 0
let timeRunGetListByCategories = 0
function normalizeVersion ( rawVersion ) {
const containsNumbers = /\d+/.test( rawVersion )
if ( !containsNumbers ) {
return '0.0.0'
}
let version = rawVersion
// Parse each part
version = version
.split('.')
.map( part => {
// It it's just a single digit
// pass it as-is
if ( part.length === 1 ) return part
// Trim leading zeros
return part.replace(/^0+/, '')
} )
.join('.')
return semver.coerce(version)
}
class BuildLists {
constructor () {
// Where our lists are stored
this.lists = {}
this.endpointMaps = {
// Where Nuxt Routes and Payloads get stored
nuxt: new Map(),
// Where Eleventy Endpoints get stored
eleventy: new Map()
}
this.allVideoAppsList = new Set()
}
listsOptions = [
// Mixed sources will(theoretically) go here
// then be read by follow main build methods
// Main build methods
{
name: 'app',
endpointPrefix: 'app',
path: '/static/app-list.json',
buildMethod: buildAppList,
},
{
name: 'game',
endpointPrefix: 'game',
path: '/static/game-list.json',
buildMethod: buildGamesList,
},
{
name: 'homebrew',
endpointPrefix: 'formula',
path: '/static/homebrew-list.json',
buildMethod: buildHomebrewList,
},
{
name: 'device',
endpointPrefix: 'device',
path: '/static/device-list.json',
buildMethod: buildDeviceList,
},
// Secondary Derivative built lists
// Always goes after initial lists
// since it depends on them
{
name: 'video',
endpointPrefix: 'tv',
path: '/static/video-list.json',
buildMethod: async () => {
return await buildVideoList( this.getAllVideoAppsList() )
},
beforeSave: videoListSet => {
this.allVideoAppsList = this.getAllVideoAppsList()
return Array.from(videoListSet).map( video => {
return {
...video,
payload: buildVideoPayload( video, this.allVideoAppsList, this.lists.video )
}
})
}
}
]
getListOptions ( listName ) {
return this.listsOptions.find( listOption => listOption.name === listName )
}
shouldHaveRelatedVideos ( app ) {
const appType = getAppType( app )
const typeWithRelatedVideos = new Set([
'app',
'formula',
'game'
])
return typeWithRelatedVideos.has( appType )
}
shouldHaveDeviceSupport ( app ) {
const appType = getAppType( app )
return appType === 'app' || appType === 'formula' || appType === 'game'
}
getAllVideoAppsList = () => {
return new Set([
...this.lists.app,
...this.lists.game,
])
}
bundles = []
async getSavedAppBundles ( options = {} ) {
const {
keepBundlesInMemory = true
} = options
if ( !keepBundlesInMemory ) {
// console.log('Getting bundles from file')
return await fs.readJson('./static/app-bundles.json')
}
// From here we get and store bundles
// Check if any bundles are already in memory
if ( this.bundles.length === 0 ) {
// console.log('Storing bundles to memory')
this.bundles = await fs.readJson('./static/app-bundles.json')
}
// console.log('Getting bundles from memory')
return this.bundles
}
// Load the bundles from files
// so that we don't have to keep them in memory
async findAppBundle ( needleBundleIdentifier ) {
const bundles = await this.getSavedAppBundles()
return bundles.find( ([
storedAppBundleIdentifier,
// versions
]) => storedAppBundleIdentifier === needleBundleIdentifier )
}
async getAppBundles ( app ) {
return await Promise.all( app.bundleIds.map( async bundleIdentifier => {
return await this.findAppBundle( bundleIdentifier )
} ) )
}
sortBundleVersions ( bundles ) {
return bundles.map( bundle => {
const [
bundleIdentifier,
versionsObject
] = bundle
// Sort versions by semver
const versions = Object.entries( versionsObject ).sort( ( [ aVersionRaw ], [ bVersionRaw ] ) => {
// console.log( 'a, b', aVersionRaw, bVersionRaw )
const aVersion = normalizeVersion( aVersionRaw )
const bVersion = normalizeVersion( bVersionRaw )
return semver.compare( bVersion, aVersion )
} )
return [
bundleIdentifier,
versions
]
} )
}
saveToJson = async function ( content, path ) {
// Write the list to JSON
await fs.writeFile(path, JSON.stringify(content))
return
}
saveList = async function ( listOptions ) {
if (this.lists[listOptions.name].size === 0) throw new Error('Trying to save empty list')
// Make the relative path for our new JSON file
const listFullPath = `.${listOptions.path}`
const hasSaveMethod = listOptions.hasOwnProperty('beforeSave')
const saveMethod = hasSaveMethod ? listOptions.beforeSave : listSet => Array.from( listSet )
// console.log('listFullPath', listFullPath)
const saveableList = saveMethod( this.lists[listOptions.name] )
await streamToJson( saveableList, listFullPath )
return
}
// Run all listsOptions methods
// and store them to this.lists
async buildLists () {
console.log( 'Build Lists started', cliOptions )
for ( const listOptions of this.listsOptions ) {
const methodName = `Building ${listOptions.name}`
console.time(methodName)
const builtList = await listOptions.buildMethod()
// Run the build method to get the lists
this.lists[listOptions.name] = new Set( builtList )
console.timeEnd(methodName)
console.log(`Finished ${listOptions.name} list with ${this.lists[listOptions.name].size} items`)
}
console.log('Build Lists finished')
return
}
getListArray ( listName ) {
console.log(`getListArray run ${ timeRunGetListArray += 1 } times`)
return Array.from( this.lists[ listName ] )
}
getListArrayMemoized = memoize( this.getListArray.bind( this ) )
makeAppsByCategory () {
// Initialize empty category lists
// so empty categories still get defined
const emptyCategories = Object.fromEntries(
Object.keys( categories ).map( categorySlug => [ categorySlug, [] ])
)
const appsByCategory = this.getListArrayMemoized( 'app' ).reduce( ( categories, app ) => {
const categorySlug = app.category.slug
if ( !categories[categorySlug] ) {
throw Error(`Category ${categorySlug} not defined`)
}
categories[categorySlug].push( app )
return categories
}, emptyCategories )
return appsByCategory
}
getAppsByCategory = this.makeAppsByCategory//memoize( this.makeAppsByCategory.bind( this ) )
getAppCategoryList ( category ) {
const categoryLists = this.getAppsByCategory()
return categoryLists[category]
}
makeKindLists () {
const getters = Object.fromEntries( Object.entries( this.lists ).map( ([ listName ]) => {
const listEndpointPrefix = this.getListOptions( listName ).endpointPrefix
return [
// Key
listEndpointPrefix,
() => this.getListArrayMemoized( listName )
]
} ) )
// Add getters for categories
// Homebrew category overrides Homebrew app type from above
for ( const categorySlug in categories ) {
// Throw if category already defined
if ( getters[categorySlug] ) throw Error(`Category ${categorySlug} already defined`)
getters[categorySlug] = () => this.getAppCategoryList( categorySlug )
}
const kindLists = {}
for ( const kindSlug in getters ) {
// Throw if kindSlug already defined
if ( kindLists[kindSlug] ) throw Error(`Kind ${kindSlug} already defined`)
kindLists[ kindSlug ] = new KindList({
// Get list method
list: getters[ kindSlug ],
kindSlug
})
}
return kindLists
}
get kindRoutes () {
return Object.entries( this.makeKindLists() ).map( ([ kindSlug, kindList ]) => {
return kindList.routes
}).flat()
}
async saveKinds () {
const kindLists = this.makeKindLists()
// Save the lists
for ( const kindSlug in kindLists ) {
console.log('\n', `-- Starting kind lists for ${ kindSlug }`)
const endpointMethodName = `Finished kind lists for ${ kindSlug }`
console.time(endpointMethodName)
const kindList = kindLists[ kindSlug ]
// Ensure the base directory exists
await fs.ensureDir( kindList.basePath )
for ( const file of kindList.apiFiles ) {
// console.log('kindPage.items', kindPage)
await this.saveToJson( file.content, file.path )
}
console.timeEnd(endpointMethodName)
console.log( '\n\n' )
}
const kindIndex = categories
// Delete no-category
delete kindIndex['no-category']
// Store sample names into kindIndex as description
for ( const categorySlug in kindIndex ) {
const kindName = getCategoryKindName( categorySlug )
// Skip empty categories
if ( kindLists[ kindName ].list.length === 0 ) continue
kindIndex[ categorySlug ].description = kindLists[ kindName ].summary.sampleNames
// Save kindName
kindIndex[ categorySlug ].kindName = kindName
}
// Save the index
await this.saveToJson( kindIndex, `${ apiDirectory }/kind/index.json` )
}
saveApiEndpoints = async ( listOptions ) => {
const apiListDirectory = `${ apiDirectory }/${ listOptions.endpointPrefix }`
await fs.ensureDir( apiListDirectory )
for ( const existingFile of await fs.readdir( apiListDirectory ) ) {
if ( extname( existingFile ) !== '.json' ) continue
await fs.remove( join( apiListDirectory, existingFile ) )
}
// const poolSize = 1000
// Store app bundles to memory
await this.getSavedAppBundles({
keepBundlesInMemory: true
})
// await Promise.all( this.getListArrayMemoized( listOptions.name ).map( async ( listEntry ) => {
for ( const listEntry of this.getListArrayMemoized( listOptions.name ) ) {
// console.log('listEntry', listEntry)
const {
// name,
// aliases,
// status,
// bundleIds,
endpoint,
} = listEntry
const endpointPath = `${ apiDirectory }${ endpoint }.json`
const endpointDirectory = dirname(endpointPath)
// Add related videos
if ( this.shouldHaveRelatedVideos( listEntry ) ) {
listEntry.relatedVideos = getRelatedVideos({
listing: listEntry,
videoListSet: this.lists.video,
appListSet: this.allVideoAppsList
})
}
// Add App Bundles
if ( Array.isArray( listEntry.bundleIds ) ) {
listEntry.bundles = await this.getAppBundles( listEntry )
listEntry.bundles = this.sortBundleVersions( listEntry.bundles )
}
// Add device support
if ( this.shouldHaveDeviceSupport( listEntry ) ) {
const deviceList = this.getListArrayMemoized( 'device' )
listEntry.deviceSupport = deviceList.map( device => {
const supportsApp = deviceSupportsApp( device, listEntry )
return {
...device,
emoji: supportsApp ? '✅' : '🚫',
ariaLabel: `${ listEntry.name } has ${ supportsApp ? '' : 'not' } been reported to work on ${ device.name }`
}
})
}
const hasSaveMethod = has( listOptions, 'beforeSave' )
const saveMethod = hasSaveMethod ? listOptions.beforeSave : listSet => Array.from( listSet )
const [ saveableEntry ] = saveMethod( new Set( [ listEntry ] ) )
// Ensure the directory exists
await fs.ensureDir( endpointDirectory )
// Write the endpoint to JSON
await this.saveToJson( saveableEntry, endpointPath )
}
// Count saved files
const fileCount = fs.readdirSync( apiListDirectory )
.filter( fileName => extname( fileName ) === '.json' )
.length
console.log( fileCount, 'Files saved in', apiListDirectory )
console.log( this.lists[listOptions.name].size, 'Entries' )
if ( fileCount !== this.lists[listOptions.name].size ) {
const listSlugs = Array.from( this.lists[listOptions.name] ).map( listEntry => listEntry.slug )
const fileNames = fs.readdirSync( apiListDirectory )
.filter( fileName => extname( fileName ) === '.json' )
.map( fileName => basename(fileName).split('.')[0] )
logArraysDifference( listSlugs, fileNames )
throw new Error( `Files (${ fileCount }) don\'t match list count in ${ apiListDirectory }(${ this.lists[listOptions.name].size }).` )
}
}
// Save app lists to JSON
saveAppLists = async function () {
if (Object.keys(this.listsOptions).length === 0) throw new Error('Trying to store empty lists')
console.log('Save lists started')
for ( const listOptionsKey in this.listsOptions ) {
const methodName = `Saving ${this.listsOptions[listOptionsKey].path}`
console.time(methodName)
const listOptions = this.listsOptions[listOptionsKey]
if ( !cliOptions.noLists ) {
await this.saveList( listOptions )
}
const searchableList = makeSearchableList( this.lists[listOptions.name] )
// console.log('searchableList', searchableList)
// Save a searchable list
await this.saveToJson( Array.from(searchableList), `./static/${listOptions.name}-list-searchable.json` )
console.timeEnd(methodName)
if ( cliOptions.withApi ) {
console.log('\n', `-- Starting individual /${ listOptions.name } endpoints`)
const endpointMethodName = `Finished individual /${ listOptions.name } endpoints`
console.time(endpointMethodName)
await this.saveApiEndpoints( listOptions )
console.timeEnd(endpointMethodName)
console.log( '\n\n' )
}
}
//
console.log('Save lists finished')
return
}
async saveAllAppsSummary () {
const summaryNumbers = getListSummaryNumbers( [
...this.getListArray('app'),
...this.getListArray('game'),
...this.getListArray('homebrew'),
] )
await this.saveToJson( summaryNumbers, `${apiDirectory}/all-apps-summary.json` )
return summaryNumbers
}
async build () {
console.log( 'Thread Pool Size', process.env.UV_THREADPOOL_SIZE )
console.log( 'CPU Count', os.cpus().length )
await saveYouTubeVideos()
// Pull in and layer data from all sources
await this.buildLists()
// Save the data to respective files as lists
await this.saveAppLists()
await this.saveAllAppsSummary()
// Save kind lists
await this.saveKinds()
// Add list based routes
for ( const listKey in this.lists ) {
this.lists[listKey].forEach( app => {
// const isVideo = (app.category === undefined)
const appType = getAppType( app )
if ( isVideo( app ) ) {
this.endpointMaps.eleventy.set(
getVideoEndpoint(app),
buildVideoPayload( app, this.allVideoAppsList, this.lists.video )
)
// this.endpointMaps.nuxt.set( getVideoEndpoint(app), buildVideoPayload( app, this.allVideoAppsList, this.lists.video ) )
return
}
// if ( isGame ) { console.log() }
// Add benchmark endpoints for apps and games
if ( appType === 'app' || appType === 'game' ) {
const payload = buildAppBenchmarkPayload( app, this.allVideoAppsList, this.lists.video )
// Only add a benchmarks endpoint if it has any videos
if ( payload.allVideos.length > 0 ) {
// this.endpointMaps.nuxt.add({
// route: `${getAppEndpoint(app)}/benchmarks`,
// payload: buildAppBenchmarkPayload( app, this.allVideoAppsList, this.lists.video )
// })
this.endpointMaps.nuxt.set( `${getAppEndpoint(app)}/benchmarks`, buildAppBenchmarkPayload( app, this.allVideoAppsList, this.lists.video ) )
}
}
// Add standard app endpoint
if ( this.shouldHaveRelatedVideos( app ) ) {
const relatedVideos = getRelatedVideos({
listing: app,
videoListSet: this.lists.video,
appListSet: this.allVideoAppsList
})
// Add app or formula endpoint
this.endpointMaps.eleventy.set( getAppEndpoint(app), {
app,
relatedVideos
} )
} else if ( appType === 'device' ) {
// Add device endpoint
// console.log('Added to nuxt endpoints', app.endpoint )
this.endpointMaps.nuxt.set( app.endpoint , { listing: app } )
} else {
// Add game or other endpoint
// console.log('Added to nuxt endpoints', app.endpoint )
this.endpointMaps.nuxt.set( getAppEndpoint(app), { app } )
}
return
})
}
// Create endpoints for categories
Object.keys(categories).forEach( slug => {
// this.endpointMaps.nuxt.add({
// route: '/kind/' + slug,
// // payload: appList
// })
this.endpointMaps.nuxt.set( '/kind/' + slug, {} )
})
for ( const [ endpointSetName, endpointSet ] of Object.entries(this.endpointMaps) ) {
// Save Endpoints
await this.saveToJson(Array.from( endpointSet , ([route, payload]) => ({ route, payload })), `./static/${endpointSetName}-endpoints.json`)
}
const sitemapEndpoints = Object.values(this.endpointMaps).map( endpointSet => {
return Array.from( endpointSet , ([route, payload]) => ({ route, payload }) )
} ).flat(1)
// Add kind routes to sitemap
this.kindRoutes.forEach( route => {
sitemapEndpoints.push({
route,
payload: {}
})
} )
// Add routes for Astro pages
const astroPageUrls = await getUrlsForAstroDefinedPages()
astroPageUrls.forEach( url => {
sitemapEndpoints.push({
route: url,
payload: {}
})
})
// Save sitemap endpoints
console.log('Building Sitemap JSON')
await this.saveToJson( sitemapEndpoints, './static/sitemap-endpoints.json')
// Save XML Sitemap
console.log('Building XML Sitemap')
await saveSitemap( sitemapEndpoints.map( ({ route }) => route ) )
// Save stork toml index
console.log('Building Stork toml index')
await writeStorkToml( sitemapEndpoints )
console.log('Total Nuxt Endpoints', this.endpointMaps.nuxt.size )
console.log('Total Eleventy Endpoints', this.endpointMaps.eleventy.size )
console.log('Total Endpoints', this.endpointMaps.nuxt.size + this.endpointMaps.eleventy.size )
return
}
}
const listBuilder = new BuildLists()
listBuilder.build()