mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-01-01 06:01:18 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix: paths now correct, better download logic

Browse Source
This commit is contained in:
Eli Bosley
2025-02-03 15:44:50 -05:00
parent bb92c3f9f8
commit 9e12407565
22 changed files with 99 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api/.gitignore vendored
View File

@@ -80,6 +80,3 @@ deploy/*
# IDE Settings Files # IDE Settings Files
.idea .idea
# Downloaded Fixtures (For File Modifications)
src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/*

41
api/src/unraid-api/unraid-file-modifier/file-modification.ts
View File

@@ -4,6 +4,7 @@ import { access, readFile, unlink, writeFile } from 'fs/promises';
import { basename, dirname, join } from 'path'; import { basename, dirname, join } from 'path';
import { applyPatch, parsePatch, reversePatch } from 'diff'; import { applyPatch, parsePatch, reversePatch } from 'diff';
import { patch } from 'semver';
export interface ShouldApplyWithReason { export interface ShouldApplyWithReason {
shouldApply: boolean; shouldApply: boolean;
@@ -18,7 +19,7 @@ export abstract class FileModification {
public constructor(protected readonly logger: Logger) {} public constructor(protected readonly logger: Logger) {}
// This is the main method that child classes need to implement // This is the main method that child classes need to implement
protected abstract generatePatch(): Promise<string>; protected abstract generatePatch(overridePath?: string): Promise<string>;
private getPatchFilePath(targetFile: string): string { private getPatchFilePath(targetFile: string): string {
const dir = dirname(targetFile); const dir = dirname(targetFile);
@@ -64,8 +65,14 @@ export abstract class FileModification {
} }
private async applyPatch(patchContents: string): Promise<void> { private async applyPatch(patchContents: string): Promise<void> {
if (!patchContents.trim()) {
throw new Error('Patch contents are empty');
}
const currentContent = await readFile(this.filePath, 'utf8'); const currentContent = await readFile(this.filePath, 'utf8');
const parsedPatch = parsePatch(patchContents)[0]; const parsedPatch = parsePatch(patchContents)[0];
if (!parsedPatch?.hunks.length) {
throw new Error('Invalid Patch Format: No hunks found');
}
const results = applyPatch(currentContent, parsedPatch); const results = applyPatch(currentContent, parsedPatch);
if (results === false) { if (results === false) {
throw new Error(`Failed to apply patch to ${this.filePath}`); throw new Error(`Failed to apply patch to ${this.filePath}`);
@@ -75,22 +82,26 @@ export abstract class FileModification {
// Default implementation of apply that uses the patch // Default implementation of apply that uses the patch
async apply(): Promise<void> { async apply(): Promise<void> {
// First attempt to apply the patch that was generated try {
const staticPatch = await this.getPregeneratedPatch(); // First attempt to apply the patch that was generated
if (staticPatch) { const staticPatch = await this.getPregeneratedPatch();
try { if (staticPatch) {
await this.applyPatch(staticPatch); try {
await this.savePatch(staticPatch); await this.applyPatch(staticPatch);
return; await this.savePatch(staticPatch);
} catch (error) { return;
this.logger.error( } catch (error) {
`Failed to apply static patch to ${this.filePath}, continuing with dynamic patch` this.logger.error(
); `Failed to apply static patch to ${this.filePath}, continuing with dynamic patch`
);
}
} }
const patchContents = await this.generatePatch();
await this.applyPatch(patchContents);
await this.savePatch(patchContents);
} catch (err) {
this.logger.error(`Failed to apply patch to ${this.filePath}: ${err}`);
} }
const patchContents = await this.generatePatch();
await this.applyPatch(patchContents);
await this.savePatch(patchContents);
} }
// Update rollback to use the shared utility // Update rollback to use the shared utility

0
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/local/DefaultPageLayout.php → api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/DefaultPageLayout.php
View File

1
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/DefaultPageLayout.php.last-download-time Normal file
View File

@@ -0,0 +1 @@
1738614986599

0
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/local/Notifications.page → api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/Notifications.page
View File

1
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/Notifications.page.last-download-time Normal file
View File

@@ -0,0 +1 @@
1738614986764

0
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/local/auth-request.php → api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/auth-request.php
View File

1
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/auth-request.php.last-download-time Normal file
View File

@@ -0,0 +1 @@
1738614987214

0
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/local/logrotate.conf → api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/logrotate.conf
View File

1
api/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/logrotate.conf.last-download-time Normal file
View File

@@ -0,0 +1 @@
999999999999999999999999999999999999

65
api/src/unraid-api/unraid-file-modifier/modifications/__test__/generic-modification.spec.ts
View File

@@ -1,16 +1,24 @@
import { Logger } from '@nestjs/common'; import { Logger } from '@nestjs/common';
import { existsSync } from 'fs'; import { existsSync } from 'fs';
import { cp, readFile, writeFile } from 'fs/promises'; import { cp, readFile, writeFile } from 'fs/promises';
import { basename, resolve } from 'path'; import path, { basename, resolve } from 'path';
import { describe, expect, test } from 'vitest'; import { describe, expect, test } from 'vitest';
import { FileModification } from '@app/unraid-api/unraid-file-modifier/file-modification'; import { FileModification } from '@app/unraid-api/unraid-file-modifier/file-modification';
import AuthRequestModification from '@app/unraid-api/unraid-file-modifier/modifications/auth-request.modification'; import AuthRequestModification from '@app/unraid-api/unraid-file-modifier/modifications/auth-request.modification';
import DefaultPageLayoutModification from '@app/unraid-api/unraid-file-modifier/modifications/default-page-layout.modification'; import DefaultPageLayoutModification from '@app/unraid-api/unraid-file-modifier/modifications/default-page-layout.modification';
import { LogRotateModification } from '@app/unraid-api/unraid-file-modifier/modifications/log-rotate.modification';
import NotificationsPageModification from '@app/unraid-api/unraid-file-modifier/modifications/notifications-page.modification'; import NotificationsPageModification from '@app/unraid-api/unraid-file-modifier/modifications/notifications-page.modification';
import SSOFileModification from '@app/unraid-api/unraid-file-modifier/modifications/sso.modification'; import SSOFileModification from '@app/unraid-api/unraid-file-modifier/modifications/sso.modification';
import { LogRotateModification } from '@app/unraid-api/unraid-file-modifier/modifications/log-rotate.modification';
interface ModificationTestCase { interface ModificationTestCase {
ModificationClass: new (...args: ConstructorParameters<typeof FileModification>) => FileModification; ModificationClass: new (...args: ConstructorParameters<typeof FileModification>) => FileModification;
@@ -49,49 +57,58 @@ const testCases: ModificationTestCase[] = [
}, },
]; ];
async function testModification(testCase: ModificationTestCase) { const downloadOrRetrieveOriginalFile = async (filePath: string, fileUrl: string): Promise<string> => {
// First download the file from Github
const fileName = basename(testCase.fileUrl);
const path = resolve(__dirname, `../__fixtures__/downloaded/${fileName}`);
const pathLocal = resolve(__dirname, `../__fixtures__/local/${fileName}`);
let originalContent = ''; let originalContent = '';
if (!existsSync(path)) { // Check last download time, if > than 1 week and not in CI, download the file from Github
const lastDownloadTime = await readFile(`${filePath}.last-download-time`, 'utf-8')
.catch(() => 0)
.then(Number);
const shouldDownload = lastDownloadTime < Date.now() - 1000 * 60 * 60 * 24 * 7 && !process.env.CI;
if (shouldDownload) {
try { try {
console.log('Downloading file', testCase.fileUrl); console.log('Downloading file', fileUrl);
originalContent = await fetch(testCase.fileUrl).then((response) => response.text()); originalContent = await fetch(fileUrl).then((response) => response.text());
await writeFile(path, originalContent); if (!originalContent) {
await writeFile(pathLocal, originalContent); throw new Error('Failed to download file');
}
await writeFile(filePath, originalContent);
await writeFile(`${filePath}.last-download-time`, Date.now().toString());
return originalContent;
} catch (error) { } catch (error) {
console.error('Failed to download file - using local fixture', error); console.error('Error downloading file', error);
await cp(resolve(__dirname, `../__fixtures__/local/${fileName}`), path); console.error(
originalContent = await readFile(path, 'utf-8'); `Failed to download file - using version created at ${new Date(lastDownloadTime).toISOString()}`
);
} }
} else {
console.log('Using existing fixture file', path);
originalContent = await readFile(path, 'utf-8');
} }
return await readFile(filePath, 'utf-8');
};
async function testModification(testCase: ModificationTestCase) {
const fileName = basename(testCase.fileUrl);
const filePath = resolve(__dirname, `../__fixtures__/downloaded/${fileName}`);
const originalContent = await downloadOrRetrieveOriginalFile(filePath, testCase.fileUrl);
const logger = new Logger(); const logger = new Logger();
const patcher = await new testCase.ModificationClass(logger); const patcher = await new testCase.ModificationClass(logger);
const originalPath = patcher.filePath;
// @ts-expect-error - Ignore for testing purposes // @ts-expect-error - Ignore for testing purposes
patcher.filePath = path; patcher.filePath = filePath;
// @ts-expect-error - Ignore for testing purposes // @ts-expect-error - Ignore for testing purposes
const patch = await patcher.generatePatch(); const patch = await patcher.generatePatch(originalPath);
// Test patch matches snapshot // Test patch matches snapshot
await expect(patch).toMatchFileSnapshot(`../patches/${patcher.id}.patch`); await expect(patch).toMatchFileSnapshot(`../patches/${patcher.id}.patch`);
// Apply patch and verify modified file // Apply patch and verify modified file
await patcher.apply(); await patcher.apply();
await expect(await readFile(path, 'utf-8')).toMatchFileSnapshot( await expect(await readFile(filePath, 'utf-8')).toMatchFileSnapshot(
`snapshots/${fileName}.modified.snapshot.php` `snapshots/${fileName}.modified.snapshot.php`
); );
// Rollback and verify original state // Rollback and verify original state
await patcher.rollback(); await patcher.rollback();
const revertedContent = await readFile(path, 'utf-8'); const revertedContent = await readFile(filePath, 'utf-8');
await expect(revertedContent).toMatch(originalContent); await expect(revertedContent).toMatch(originalContent);
} }
@@ -99,4 +116,4 @@ describe('File modifications', () => {
test.each(testCases)(`$fileName modifier correctly applies to fresh install`, async (testCase) => { test.each(testCases)(`$fileName modifier correctly applies to fresh install`, async (testCase) => {
await testModification(testCase); await testModification(testCase);
}); });
}); });

6
api/src/unraid-api/unraid-file-modifier/modifications/auth-request.modification.ts
View File

@@ -10,7 +10,7 @@ import {
} from '@app/unraid-api/unraid-file-modifier/file-modification'; } from '@app/unraid-api/unraid-file-modifier/file-modification';
export default class AuthRequestModification extends FileModification { export default class AuthRequestModification extends FileModification {
public filePath: string = '/usr/local/emhttp/auth-request.php'; public filePath: string = '/usr/local/emhttp/auth-request.php' as const;
public webComponentsDirectory: string = public webComponentsDirectory: string =
'/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components/_nuxt/' as const; '/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components/_nuxt/' as const;
id: string = 'auth-request'; id: string = 'auth-request';
@@ -21,7 +21,7 @@ export default class AuthRequestModification extends FileModification {
const baseDir = '/usr/local/emhttp'; // TODO: Make this configurable const baseDir = '/usr/local/emhttp'; // TODO: Make this configurable
return files.map((file) => (file.startsWith(baseDir) ? file.slice(baseDir.length) : file)); return files.map((file) => (file.startsWith(baseDir) ? file.slice(baseDir.length) : file));
}; };
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
const jsFiles = await this.getJsFiles(this.webComponentsDirectory); const jsFiles = await this.getJsFiles(this.webComponentsDirectory);
this.logger.debug(`Found ${jsFiles.length} .js files in ${this.webComponentsDirectory}`); this.logger.debug(`Found ${jsFiles.length} .js files in ${this.webComponentsDirectory}`);
@@ -43,7 +43,7 @@ export default class AuthRequestModification extends FileModification {
const newContent = fileContent.replace(/(\$arrWhitelist\s*=\s*\[)/, `$1\n${filesToAddString}`); const newContent = fileContent.replace(/(\$arrWhitelist\s*=\s*\[)/, `$1\n${filesToAddString}`);
// Generate and return patch // Generate and return patch
const patch = createPatch(this.filePath, fileContent, newContent, undefined, undefined, { const patch = createPatch(overridePath ?? this.filePath, fileContent, newContent, undefined, undefined, {
context: 3, context: 3,
}); });

4
api/src/unraid-api/unraid-file-modifier/modifications/default-page-layout.modification.ts
View File

@@ -41,12 +41,12 @@ export default class DefaultPageLayoutModification extends FileModification {
return transformers.reduce((content, fn) => fn(content), fileContent); return transformers.reduce((content, fn) => fn(content), fileContent);
} }
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
const fileContent = await readFile(this.filePath, 'utf-8'); const fileContent = await readFile(this.filePath, 'utf-8');
const newContent = this.applyToSource(fileContent); const newContent = this.applyToSource(fileContent);
const patch = createPatch(this.filePath, fileContent, newContent, undefined, undefined, { const patch = createPatch(overridePath ?? this.filePath, fileContent, newContent, undefined, undefined, {
context: 2, context: 2,
}); });

4
api/src/unraid-api/unraid-file-modifier/modifications/log-rotate.modification.ts
View File

@@ -30,13 +30,13 @@ export class LogRotateModification extends FileModification {
super(logger); super(logger);
} }
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
const currentContent = (await fileExists(this.filePath)) const currentContent = (await fileExists(this.filePath))
? await readFile(this.filePath, 'utf8') ? await readFile(this.filePath, 'utf8')
: ''; : '';
const patch = createPatch( const patch = createPatch(
this.filePath, overridePath ?? this.filePath,
currentContent, currentContent,
this.logRotateConfig, this.logRotateConfig,
undefined, undefined,

4
api/src/unraid-api/unraid-file-modifier/modifications/notifications-page.modification.ts
View File

@@ -12,12 +12,12 @@ export default class NotificationsPageModification extends FileModification {
id: string = 'notifications-page'; id: string = 'notifications-page';
public readonly filePath: string = '/usr/local/emhttp/plugins/dynamix/Notifications.page'; public readonly filePath: string = '/usr/local/emhttp/plugins/dynamix/Notifications.page';
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
const fileContent = await readFile(this.filePath, 'utf-8'); const fileContent = await readFile(this.filePath, 'utf-8');
const newContent = NotificationsPageModification.applyToSource(fileContent); const newContent = NotificationsPageModification.applyToSource(fileContent);
const patch = createPatch(this.filePath, fileContent, newContent, undefined, undefined, { const patch = createPatch(overridePath ?? this.filePath, fileContent, newContent, undefined, undefined, {
context: 3, context: 3,
}); });

6
api/src/unraid-api/unraid-file-modifier/modifications/patches/auth-request.patch
View File

@@ -1,7 +1,7 @@
Index: /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/auth-request.php Index: /usr/local/emhttp/auth-request.php
=================================================================== ===================================================================
--- /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/auth-request.php --- /usr/local/emhttp/auth-request.php
+++ /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/auth-request.php +++ /usr/local/emhttp/auth-request.php
@@ -15,6 +15,7 @@ @@ -15,6 +15,7 @@
} }

6
api/src/unraid-api/unraid-file-modifier/modifications/patches/default-page-layout.patch
View File

@@ -1,7 +1,7 @@
Index: /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/DefaultPageLayout.php Index: /usr/local/emhttp/plugins/dynamix/include/DefaultPageLayout.php
=================================================================== ===================================================================
--- /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/DefaultPageLayout.php --- /usr/local/emhttp/plugins/dynamix/include/DefaultPageLayout.php
+++ /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/DefaultPageLayout.php +++ /usr/local/emhttp/plugins/dynamix/include/DefaultPageLayout.php
@@ -557,14 +557,5 @@ @@ -557,14 +557,5 @@
$.post('/webGui/include/Notify.php',{cmd:'get',csrf_token:csrf_token},function(msg) { $.post('/webGui/include/Notify.php',{cmd:'get',csrf_token:csrf_token},function(msg) {
$.each($.parseJSON(msg), function(i, notify){ $.each($.parseJSON(msg), function(i, notify){

6
api/src/unraid-api/unraid-file-modifier/modifications/patches/log-rotate.patch
View File

@@ -1,7 +1,7 @@
Index: /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/logrotate.conf Index: /etc/logrotate.d/unraid-api
=================================================================== ===================================================================
--- /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/logrotate.conf --- /etc/logrotate.d/unraid-api
+++ /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/logrotate.conf +++ /etc/logrotate.d/unraid-api
@@ -0,0 +1,12 @@ @@ -0,0 +1,12 @@
+ +
+/var/log/unraid-api/*.log { +/var/log/unraid-api/*.log {

6
api/src/unraid-api/unraid-file-modifier/modifications/patches/notifications-page.patch
View File

@@ -1,7 +1,7 @@
Index: /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/Notifications.page Index: /usr/local/emhttp/plugins/dynamix/Notifications.page
=================================================================== ===================================================================
--- /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/Notifications.page --- /usr/local/emhttp/plugins/dynamix/Notifications.page
+++ /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/Notifications.page +++ /usr/local/emhttp/plugins/dynamix/Notifications.page
@@ -135,23 +135,7 @@ @@ -135,23 +135,7 @@
:notifications_auto_close_help: :notifications_auto_close_help:

6
api/src/unraid-api/unraid-file-modifier/modifications/patches/sso.patch
View File

@@ -1,7 +1,7 @@
Index: /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/.login.php Index: /usr/local/emhttp/plugins/dynamix/include/.login.php
=================================================================== ===================================================================
--- /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/.login.php original --- /usr/local/emhttp/plugins/dynamix/include/.login.php original
+++ /app/src/unraid-api/unraid-file-modifier/modifications/__fixtures__/downloaded/.login.php modified +++ /usr/local/emhttp/plugins/dynamix/include/.login.php modified
@@ -1,5 +1,33 @@ @@ -1,5 +1,33 @@
<?php <?php
+ +

4
api/src/unraid-api/unraid-file-modifier/modifications/sso.modification.ts
View File

@@ -11,7 +11,7 @@ export default class SSOFileModification extends FileModification {
id: string = 'sso'; id: string = 'sso';
public readonly filePath: string = '/usr/local/emhttp/plugins/dynamix/include/.login.php'; public readonly filePath: string = '/usr/local/emhttp/plugins/dynamix/include/.login.php';
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
// Define the new PHP function to insert // Define the new PHP function to insert
/* eslint-disable no-useless-escape */ /* eslint-disable no-useless-escape */
const newFunction = ` const newFunction = `
@@ -64,7 +64,7 @@ function verifyUsernamePasswordAndSSO(string $username, string $password): bool
newContent = newContent.replace(/<\/form>/i, `</form>\n${tagToInject}`); newContent = newContent.replace(/<\/form>/i, `</form>\n${tagToInject}`);
// Create and return the patch // Create and return the patch
const patch = createPatch(this.filePath, originalContent, newContent, 'original', 'modified'); const patch = createPatch(overridePath ?? this.filePath, originalContent, newContent, 'original', 'modified');
return patch; return patch;
} }

4
api/src/unraid-api/unraid-file-modifier/unraid-file-modifier.spec.ts
View File

@@ -19,8 +19,8 @@ class TestFileModification extends FileModification {
id = 'test'; id = 'test';
public readonly filePath: string = FIXTURE_PATH; public readonly filePath: string = FIXTURE_PATH;
protected async generatePatch(): Promise<string> { protected async generatePatch(overridePath?: string): Promise<string> {
return createPatch('text-patch-file.txt', ORIGINAL_CONTENT, 'modified'); return createPatch(overridePath ?? 'text-patch-file.txt', ORIGINAL_CONTENT, 'modified');
} }
async shouldApply(): Promise<ShouldApplyWithReason> { async shouldApply(): Promise<ShouldApplyWithReason> {