-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(admin-ui-plugin): Detect whether extensions need to be re-compiled
Relates to #55
- Loading branch information
1 parent
c2742ec
commit ba8c44f
Showing
6 changed files
with
133 additions
and
72 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| /* tslint:disable:no-console */ | ||
| import { compileAdminUiApp } from '@vendure/admin-ui/devkit/compile'; | ||
| import path from 'path'; | ||
|
|
||
| console.log('Building admin-ui from source...'); | ||
| compileAdminUiApp(path.join(__dirname, 'lib/admin-ui'), []); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| import { Injectable } from '@nestjs/common'; | ||
| import { compileAdminUiApp } from '@vendure/admin-ui/devkit/compile'; | ||
| import { AdminUiExtension } from '@vendure/common/lib/shared-types'; | ||
| import { Logger } from '@vendure/core'; | ||
| import crypto from 'crypto'; | ||
| import fs from 'fs-extra'; | ||
| import path from 'path'; | ||
|
|
||
| @Injectable() | ||
| export class UiAppCompiler { | ||
| private readonly outputPath = path.join(__dirname, '../admin-ui'); | ||
| private readonly hashfile = path.join(__dirname, 'modules-hash.txt'); | ||
|
|
||
| async compileAdminUiApp(extensions: AdminUiExtension[] | undefined): Promise<string> { | ||
| const compiledAppExists = fs.existsSync(path.join(this.outputPath, 'index.html')); | ||
| const extensionsWithId = this.normalizeExtensions(extensions); | ||
|
|
||
| if (!compiledAppExists || this.extensionModulesHaveChanged(extensionsWithId)) { | ||
| Logger.info('Compiling Admin UI with extensions...', 'AdminUiPlugin'); | ||
| await compileAdminUiApp(path.join(__dirname, '../admin-ui'), extensionsWithId); | ||
| Logger.info('Completed compilation!', 'AdminUiPlugin'); | ||
| } else { | ||
| Logger.info('Extensions not changed since last run', 'AdminUiPlugin'); | ||
| } | ||
| return this.outputPath; | ||
| } | ||
|
|
||
| /** | ||
| * Ensures each extension has an ID. If not defined by the user, a deterministic ID is generated | ||
| * from a hash of the extension config. | ||
| */ | ||
| private normalizeExtensions(extensions?: AdminUiExtension[]): Array<Required<AdminUiExtension>> { | ||
| return (extensions || []).map(e => { | ||
| if (e.id) { | ||
| return e as Required<AdminUiExtension>; | ||
| } | ||
| const hash = crypto.createHash('sha256'); | ||
| hash.update(JSON.stringify(e)); | ||
| const id = hash.digest('hex'); | ||
| return { ...e, id }; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Checks whether the extensions configuration or any of the extension module files have been | ||
| * changed since the last run. | ||
| */ | ||
| private extensionModulesHaveChanged(extensions: Array<Required<AdminUiExtension>>): boolean { | ||
| fs.ensureFileSync(this.hashfile); | ||
| const previousHash = fs.readFileSync(this.hashfile, 'utf-8'); | ||
| if (!previousHash && extensions.length === 0) { | ||
| // No extensions are configured and there is no last has, | ||
| // as when the plugin is newly installed. In this case, | ||
| // it would be unnecessary to recompile. | ||
| return false; | ||
| } | ||
| const currentHash = this.getExtensionModulesHash(extensions); | ||
|
|
||
| if (currentHash === previousHash) { | ||
| return false; | ||
| } | ||
| fs.writeFileSync(this.hashfile, currentHash, 'utf-8'); | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Generates a hash based on the extensions array as well as the modified time of each file | ||
| * in the ngModulesPaths. | ||
| */ | ||
| private getExtensionModulesHash(extensions: Array<Required<AdminUiExtension>>): string { | ||
| let modifiedDates: string[] = []; | ||
| for (const extension of extensions) { | ||
| modifiedDates = [...modifiedDates, ...this.getAllModifiedDates(extension.ngModulePath)]; | ||
| } | ||
| const hash = crypto.createHash('sha256'); | ||
| hash.update(modifiedDates.join('') + JSON.stringify(extensions)); | ||
| return hash.digest('hex'); | ||
| } | ||
|
|
||
| private getAllModifiedDates(dirPath: string): string[] { | ||
| const modifiedDates: string[] = []; | ||
| this.visitRecursive(dirPath, filePath => { | ||
| modifiedDates.push(fs.statSync(filePath).mtimeMs.toString()); | ||
| }); | ||
| return modifiedDates; | ||
| } | ||
|
|
||
| private visitRecursive(dirPath: string, visitor: (filePath: string) => void) { | ||
| const files = fs.readdirSync(dirPath); | ||
| for (const file of files) { | ||
| const fullPath = path.join(dirPath, file); | ||
| if (fs.statSync(fullPath).isDirectory()) { | ||
| this.visitRecursive(fullPath, visitor); | ||
| } else { | ||
| visitor(fullPath); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters