Add output caching for Forge 1.13+.

CHANGES - Forge installer is no longer stored to the work directory. It is now stored in a cache folder corresponding to the artifact version. - Installer output is now cached by default - Added options to generate distro. - --discardOutput Delete cached output after it is no longer required. May be useful if disk space is limited. - --invalidateCache Invalidate and delete existing caches as they are encountered. Requires fresh cache generation. - Both options are false by default. - To invalide a single version, manually delete the folder. - Old functionality is essentially g distro --discardOutput --invalidateCache.
2021-03-20 16:28:12 -04:00
parent 2540ca383e
commit 3f90a22972
9 changed files with 126 additions and 53 deletions
--- a/src/resolver/forge/adapter/ForgeGradle2.resolver.ts
+++ b/src/resolver/forge/adapter/ForgeGradle2.resolver.ts
@@ -29,9 +29,11 @@ export class ForgeGradle2Adapter extends ForgeResolver {
        relativeRoot: string,
        baseUrl: string,
        minecraftVersion: MinecraftVersion,
-        forgeVersion: string
+        forgeVersion: string,
+        discardOutput: boolean,
+        invalidateCache: boolean
    ) {
-        super(absoluteRoot, relativeRoot, baseUrl, minecraftVersion, forgeVersion)
+        super(absoluteRoot, relativeRoot, baseUrl, minecraftVersion, forgeVersion, discardOutput, invalidateCache)
    }

    public async getModule(): Promise<Module> {
--- a/src/resolver/forge/adapter/ForgeGradle3.resolver.ts
+++ b/src/resolver/forge/adapter/ForgeGradle3.resolver.ts
@@ -4,7 +4,7 @@ import { LoggerUtil } from '../../../util/LoggerUtil'
 import { VersionUtil } from '../../../util/versionutil'
 import { Module, Type } from 'helios-distribution-types'
 import { LibRepoStructure } from '../../../structure/repo/LibRepo.struct'
-import { pathExists, remove, mkdirs, copy, writeFile, readFile, lstat, move, writeJson } from 'fs-extra'
+import { pathExists, remove, mkdirs, copy, writeFile, readFile, lstat, writeJson } from 'fs-extra'
 import { join, basename, dirname } from 'path'
 import { spawn } from 'child_process'
 import { JavaUtil } from '../../../util/java/javautil'
@@ -42,9 +42,11 @@ export class ForgeGradle3Adapter extends ForgeResolver {
        relativeRoot: string,
        baseUrl: string,
        minecraftVersion: MinecraftVersion,
-        forgeVersion: string
+        forgeVersion: string,
+        discardOutput: boolean,
+        invalidateCache: boolean
    ) {
-        super(absoluteRoot, relativeRoot, baseUrl, minecraftVersion, forgeVersion)
+        super(absoluteRoot, relativeRoot, baseUrl, minecraftVersion, forgeVersion, discardOutput, invalidateCache)
        this.configure()
    }

@@ -198,57 +200,72 @@ export class ForgeGradle3Adapter extends ForgeResolver {

    private async processWithInstaller(installerPath: string): Promise<Module> {

-        const workDir = this.repoStructure.getWorkDirectory()
-        if (await pathExists(workDir)) {
-            await remove(workDir)
+        let doInstall = true
+        // Check cache.
+        const cacheDir = this.repoStructure.getForgeCacheDirectory(this.artifactVersion)
+        if (await pathExists(cacheDir)) {
+            if(this.invalidateCache) {
+                ForgeGradle3Adapter.logger.info(`Removing existing cache ${cacheDir}..`)
+                await remove(cacheDir)
+            } else {
+                // Use cache.
+                doInstall = false
+                ForgeGradle3Adapter.logger.info(`Using cached results at ${cacheDir}.`)
+            }
+        } else {
+            await mkdirs(cacheDir)
+        }
+        const installerOutputDir = cacheDir
+
+        if(doInstall) {
+            const workingInstaller = join(installerOutputDir, basename(installerPath))
+
+            await copy(installerPath, workingInstaller)
+    
+            // Required for the installer to function.
+            await writeFile(join(installerOutputDir, 'launcher_profiles.json'), JSON.stringify({}))
+    
+            ForgeGradle3Adapter.logger.debug('Spawning forge installer')
+    
+            ForgeGradle3Adapter.logger.info('============== [ IMPORTANT ] ==============')
+            ForgeGradle3Adapter.logger.info('When the installer opens please set the client installation directory to:')
+            ForgeGradle3Adapter.logger.info(installerOutputDir)
+            ForgeGradle3Adapter.logger.info('===========================================')
+    
+            await this.executeInstaller(workingInstaller)
+    
+            ForgeGradle3Adapter.logger.debug('Installer finished, beginning processing..')
        }

-        await mkdirs(workDir)
-
-        const workingInstaller = join(workDir, basename(installerPath))
-
-        await copy(installerPath, workingInstaller)
-
-        // Required for the installer to function.
-        await writeFile(join(workDir, 'launcher_profiles.json'), JSON.stringify({}))
-
-        ForgeGradle3Adapter.logger.debug('Spawning forge installer')
-
-        ForgeGradle3Adapter.logger.info('============== [ IMPORTANT ] ==============')
-        ForgeGradle3Adapter.logger.info('When the installer opens please set the client installation directory to:')
-        ForgeGradle3Adapter.logger.info(workDir)
-        ForgeGradle3Adapter.logger.info('===========================================')
-
-        await this.executeInstaller(workingInstaller)
-
-        ForgeGradle3Adapter.logger.debug('Installer finished, beginning processing..')
-
        ForgeGradle3Adapter.logger.debug('Processing Version Manifest')
-        const versionManifestTuple = await this.processVersionManifest()
+        const versionManifestTuple = await this.processVersionManifest(installerOutputDir)
        const versionManifest = versionManifestTuple[0] as VersionManifestFG3

        ForgeGradle3Adapter.logger.debug('Processing generated forge files.')
-        const forgeModule = await this.processForgeModule(versionManifest)
+        const forgeModule = await this.processForgeModule(versionManifest, installerOutputDir)

        // Attach version.json module.
        forgeModule.subModules?.unshift(versionManifestTuple[1] as Module)

        ForgeGradle3Adapter.logger.debug('Processing Libraries')
-        const libs = await this.processLibraries(versionManifest)
+        const libs = await this.processLibraries(versionManifest, installerOutputDir)

        forgeModule.subModules = forgeModule.subModules?.concat(libs)

-        await remove(workDir)
+        if(this.discardOutput) {
+            ForgeGradle3Adapter.logger.info(`Removing installer output at ${installerOutputDir}..`)
+            await remove(installerOutputDir)
+            ForgeGradle3Adapter.logger.info('Removed successfully.')
+        }

        return forgeModule

    }

-    private async processVersionManifest(): Promise<[VersionManifestFG3, Module]> {
-        const workDir = this.repoStructure.getWorkDirectory()
+    private async processVersionManifest(installerOutputDir: string): Promise<[VersionManifestFG3, Module]> {
        const versionRepo = this.repoStructure.getVersionRepoStruct()
        const versionName = versionRepo.getFileName(this.minecraftVersion, this.forgeVersion)
-        const versionManifestPath = join(workDir, 'versions', versionName, `${versionName}.json`)
+        const versionManifestPath = join(installerOutputDir, 'versions', versionName, `${versionName}.json`)

        const versionManifestBuf = await readFile(versionManifestPath)
        const versionManifest = JSON.parse(versionManifestBuf.toString()) as VersionManifestFG3
@@ -269,14 +286,14 @@ export class ForgeGradle3Adapter extends ForgeResolver {
            this.forgeVersion
        )

-        await move(versionManifestPath, destination, {overwrite: true})
+        await copy(versionManifestPath, destination, {overwrite: true})

        return [versionManifest, versionManifestModule]
    }

-    private async processForgeModule(versionManifest: VersionManifestFG3): Promise<Module> {
+    private async processForgeModule(versionManifest: VersionManifestFG3, installerOutputDir: string): Promise<Module> {

-        const libDir = join(this.repoStructure.getWorkDirectory(), 'libraries')
+        const libDir = join(installerOutputDir, 'libraries')
        
        if(this.wildcardsInUse) {
            if(this.wildcardsInUse.indexOf(ForgeGradle3Adapter.WILDCARD_MCP_VERSION) > -1) {
@@ -349,7 +366,7 @@ export class ForgeGradle3Adapter extends ForgeResolver {
                        _classifier
                    )

-                    await move(targetLocalPath, destination, {overwrite: true})
+                    await copy(targetLocalPath, destination, {overwrite: true})

                    located = true
                    break classifierLoop
@@ -371,9 +388,9 @@ export class ForgeGradle3Adapter extends ForgeResolver {
        return forgeModule
    }

-    private async processLibraries(manifest: VersionManifestFG3): Promise<Module[]> {
+    private async processLibraries(manifest: VersionManifestFG3, installerOutputDir: string): Promise<Module[]> {

-        const libDir = join(this.repoStructure.getWorkDirectory(), 'libraries')
+        const libDir = join(installerOutputDir, 'libraries')
        const libRepo = this.repoStructure.getLibRepoStruct()

        const mdls: Module[] = []
@@ -416,7 +433,7 @@ export class ForgeGradle3Adapter extends ForgeResolver {
                    components.extension
                )

-                await move(targetLocalPath, destination, {overwrite: true})
+                await copy(targetLocalPath, destination, {overwrite: true})

            }
        }
--- a/src/resolver/forge/forge.resolver.ts
+++ b/src/resolver/forge/forge.resolver.ts
@@ -19,7 +19,9 @@ export abstract class ForgeResolver extends BaseResolver {
        relativeRoot: string,
        baseUrl: string,
        protected minecraftVersion: MinecraftVersion,
-        protected forgeVersion: string
+        protected forgeVersion: string,
+        protected discardOutput: boolean,
+        protected invalidateCache: boolean
    ) {
        super(absoluteRoot, relativeRoot, baseUrl)
        this.repoStructure = new RepoStructure(absoluteRoot, relativeRoot)