fix: restore stats output target functionality. #3030
There are no files selected for viewing
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,174 @@ | ||
| import { byteSize, sortBy } from '@utils'; | ||
| import type * as d from '../../declarations'; | ||
|
|
||
| /** | ||
| * | ||
| * @param config | ||
| * @param compilerCtx | ||
| * @param buildCtx | ||
| * @returns | ||
| */ | ||
| export function generateBuildStats(config: d.Config, buildCtx: d.BuildCtx) { | ||
| const buildResults = buildCtx.buildResults; | ||
|
|
||
| let jsonData: d.CompilerBuildStats | { diagnostics: d.Diagnostic[] }; | ||
|
|
||
| try { | ||
| if (buildResults.hasError) { | ||
| jsonData = { | ||
| diagnostics: buildResults.diagnostics, | ||
| }; | ||
| } else { | ||
| const stats: d.CompilerBuildStats = { | ||
| timestamp: buildResults.timestamp, | ||
| compiler: { | ||
| name: config.sys.name, | ||
| version: config.sys.version, | ||
| }, | ||
| app: { | ||
| namespace: config.namespace, | ||
| fsNamespace: config.fsNamespace, | ||
| components: Object.keys(buildResults.componentGraph).length, | ||
| entries: Object.keys(buildResults.componentGraph).length, | ||
| bundles: buildResults.outputs.reduce((total, en) => (total += en.files.length), 0), | ||
rwaskiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| outputs: getAppOutputs(config, buildResults), | ||
| }, | ||
| options: { | ||
| minifyJs: config.minifyJs, | ||
| minifyCss: config.minifyCss, | ||
| hashFileNames: config.hashFileNames, | ||
| hashedFileNameLength: config.hashedFileNameLength, | ||
| buildEs5: config.buildEs5, | ||
| }, | ||
| formats: { | ||
| esmBrowser: sanitizeBundlesForStats(buildCtx.esmBrowserComponentBundle), | ||
| esm: sanitizeBundlesForStats(buildCtx.esmComponentBundle), | ||
| es5: sanitizeBundlesForStats(buildCtx.es5ComponentBundle), | ||
| system: sanitizeBundlesForStats(buildCtx.systemComponentBundle), | ||
| commonjs: sanitizeBundlesForStats(buildCtx.commonJsComponentBundle), | ||
| }, | ||
| components: getComponentsFileMap(config, buildCtx), | ||
| entries: buildCtx.entryModules, | ||
| componentGraph: buildResults.componentGraph, | ||
| sourceGraph: getSourceGraph(config, buildCtx), | ||
| rollupResults: buildCtx.rollupResults, | ||
| collections: getCollections(config, buildCtx), | ||
| }; | ||
|
|
||
| jsonData = stats; | ||
| } | ||
| } catch (e) { | ||
| jsonData = { | ||
| diagnostics: [e.message], | ||
| }; | ||
| } | ||
|
|
||
| return jsonData; | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param config | ||
| * @param buildCtx | ||
| * @returns | ||
| */ | ||
| export async function writeBuildStats(config: d.Config, data: d.CompilerBuildStats) { | ||
| const statsTargets = config.outputTargets.filter((o) => o.type === 'stats') as d.OutputTargetStats[]; | ||
rwaskiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| await Promise.all( | ||
| statsTargets.map((outputTarget) => { | ||
| config.sys.writeFile(outputTarget.file, JSON.stringify(data, null, 2)); | ||
rwaskiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }) | ||
| ); | ||
| } | ||
|
|
||
| function sanitizeBundlesForStats(bundleArray: d.BundleModule[]): d.CompilerBuildStatBundle[] { | ||
rwaskiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (!bundleArray) { | ||
| return []; | ||
| } | ||
|
|
||
| return bundleArray.map((bundle) => { | ||
| return { | ||
| // Should probably get the file size too. | ||
rwaskiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| key: bundle.entryKey, | ||
| components: bundle.cmps.map((c) => c.tagName), | ||
| bundleId: bundle.output.bundleId, | ||
| fileName: bundle.output.fileName, | ||
| imports: bundle.rollupResult.imports, | ||
| // code: bundle.rollupResult.code, // (use this to debug) | ||
| // Currently, this number is inaccurate vs what seems to be on disk. | ||
| byteSize: byteSize(bundle.rollupResult.code), | ||
|
There was a problem hiding this comment. @rwaskiewicz or @Lars, any recs about how to get this number to be more accurate without reading the file from disk? Should I omit for the time being? There was a problem hiding this comment. How inaccurate are we talking? Like an order of magnitude? or a few bytes? There was a problem hiding this comment. Oh, duh. It's because the files are compressed. It's a symptom of uglifying the files being applied after the build. Ironically, there's also some larger discrepancy between esmBrowser and esm as a result of esm not being minified. Since esm is not compressed right now (there's another bug somewhere filed about this...) the esm file's byte sizes produced at this point are accurate. I think I'm going to rename this to "originalByteSize" instead. We should in the future figure out how to add that. Feels like an ordering problem. I'd hate to read files, as generating the stats may be much slower. |
||
| }; | ||
| }); | ||
| } | ||
|
|
||
| function getSourceGraph(config: d.Config, buildCtx: d.BuildCtx) { | ||
| let sourceGraph: d.BuildSourceGraph = {}; | ||
|
|
||
| sortBy(buildCtx.moduleFiles, (m) => m.sourceFilePath).forEach((moduleFile) => { | ||
| const key = relativePath(config, moduleFile.sourceFilePath); | ||
| sourceGraph[key] = moduleFile.localImports.map((localImport) => relativePath(config, localImport)).sort(); | ||
| }); | ||
|
|
||
| return sourceGraph; | ||
| } | ||
|
|
||
| function getAppOutputs(config: d.Config, buildResults: d.CompilerBuildResults) { | ||
| return buildResults.outputs.map((output) => { | ||
| return { | ||
| name: output.type, | ||
| files: output.files.length, | ||
| generatedFiles: output.files.map((file) => relativePath(config, file)), | ||
| }; | ||
| }); | ||
| } | ||
|
|
||
| function getComponentsFileMap(config: d.Config, buildCtx: d.BuildCtx) { | ||
| return buildCtx.components.map((component) => { | ||
| return { | ||
| tag: component.tagName, | ||
| path: relativePath(config, component.jsFilePath), | ||
| source: relativePath(config, component.sourceFilePath), | ||
| elementRef: component.elementRef, | ||
| componentClassName: component.componentClassName, | ||
| assetsDirs: component.assetsDirs, | ||
| dependencies: component.dependencies, | ||
| dependents: component.dependents, | ||
| directDependencies: component.directDependencies, | ||
| directDependents: component.directDependents, | ||
| docs: component.docs, | ||
| encapsulation: component.encapsulation, | ||
| excludeFromCollection: component.excludeFromCollection, | ||
| events: component.events, | ||
| internal: component.internal, | ||
| legacyConnect: component.legacyConnect, | ||
| legacyContext: component.legacyContext, | ||
| listeners: component.listeners, | ||
| methods: component.methods, | ||
| potentialCmpRefs: component.potentialCmpRefs, | ||
| properties: component.properties, | ||
| shadowDelegatesFocus: component.shadowDelegatesFocus, | ||
| states: component.states, | ||
| }; | ||
| }); | ||
| } | ||
|
|
||
| function getCollections(config: d.Config, buildCtx: d.BuildCtx) { | ||
| return buildCtx.collections | ||
| .map((c) => { | ||
| return { | ||
| name: c.collectionName, | ||
| source: relativePath(config, c.moduleDir), | ||
| tags: c.moduleFiles.map((m) => m.cmps.map((cmp: d.ComponentCompilerMeta) => cmp.tagName)).sort(), | ||
| }; | ||
| }) | ||
| .sort((a, b) => { | ||
| if (a.name < b.name) return -1; | ||
| if (a.name > b.name) return 1; | ||
| return 0; | ||
| }); | ||
| } | ||
|
|
||
| function relativePath(config: d.Config, file: string) { | ||
| return config.sys.normalizePath(config.sys.platformPath.relative(config.rootDir, file)); | ||
| } | ||
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,59 @@ | ||
| import type * as d from '@stencil/core/declarations'; | ||
| import { mockConfig, mockCompilerCtx, mockBuildCtx } from '@stencil/core/testing'; | ||
| import { generateBuildResults } from '../build-results'; | ||
| import { generateBuildStats } from '../build-stats'; | ||
| import path from 'path'; | ||
|
|
||
| describe('generateBuildStats', () => { | ||
| const root = path.resolve('/'); | ||
| const config = mockConfig(); | ||
| let compilerCtx: d.CompilerCtx; | ||
| let buildCtx: d.BuildCtx; | ||
|
|
||
| beforeEach(() => { | ||
| compilerCtx = mockCompilerCtx(config); | ||
| buildCtx = mockBuildCtx(config, compilerCtx); | ||
| }); | ||
|
|
||
| it('should return a structured json object', async () => { | ||
| buildCtx.buildResults = generateBuildResults(config, compilerCtx, buildCtx); | ||
|
|
||
| const result = generateBuildStats(config, buildCtx); | ||
|
|
||
| if (result.hasOwnProperty('timestamp')) { | ||
| delete result.timestamp; | ||
| } | ||
|
|
||
| expect(result).toStrictEqual({ | ||
| app: { bundles: 0, components: 0, entries: 0, fsNamespace: undefined, namespace: 'Testing', outputs: [] }, | ||
| collections: [], | ||
| compiler: { name: 'in-memory', version: '0.0.0-dev.20210827160156' }, | ||
| componentGraph: {}, | ||
| components: [], | ||
| entries: [], | ||
| formats: { commonjs: [], es5: [], esm: [], esmBrowser: [], system: [] }, | ||
| options: { | ||
| buildEs5: false, | ||
| hashFileNames: false, | ||
| hashedFileNameLength: undefined, | ||
| minifyCss: false, | ||
| minifyJs: false, | ||
| }, | ||
| rollupResults: undefined, | ||
| sourceGraph: {}, | ||
| }); | ||
| }); | ||
|
|
||
| it('should return diagnostics if an error is hit', async () => { | ||
| buildCtx.buildResults = generateBuildResults(config, compilerCtx, buildCtx); | ||
|
|
||
| buildCtx.buildResults.hasError = true; | ||
| buildCtx.buildResults.diagnostics = ['Something bad happened']; | ||
|
|
||
| const result = generateBuildStats(config, buildCtx); | ||
|
|
||
| expect(result).toStrictEqual({ | ||
| diagnostics: ['Something bad happened'], | ||
| }); | ||
| }); | ||
| }); |
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor, the JSDocs in this file just seem to be stubbed out