Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himenon/performance-report
continuous performance report in integration.
https://github.com/himenon/performance-report
continuous-integration performance
Last synced: 4 days ago
JSON representation
continuous performance report in integration.
- Host: GitHub
- URL: https://github.com/himenon/performance-report
- Owner: Himenon
- License: mit
- Created: 2020-11-13T04:19:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-15T07:28:57.000Z (about 4 years ago)
- Last Synced: 2024-11-05T22:46:22.155Z (about 2 months ago)
- Topics: continuous-integration, performance
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@himenon/performance-report
- Size: 488 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @himenon/performance-report
Measure the difference in performance.
In addition, Git Repository is used as the save destination of the measurement result.
The currently measurable performance indicators are:
- [x] File size
- [x] Execution time
## Usage
[GitHub Action Sample Code](https://github.com/Himenon/performance-report/blob/main/scripts/tools/check-perf.ts)
```ts
import { EOL } from "os";
import * as path from "path";
import * as PerformanceReport from "../../lib";
import * as GitHubActions from "./actions";
import * as Exectime from "./exectime";
import * as Config from "./config";
import { setEnv, getEnv } from "./env";
const pkg = require("../../package.json");
const generateHideComment = (value: string): string => ``;
export interface Option {
isPullRequest: boolean;
isLocal: boolean;
}
export const createPerformanceReport = async ({ isPullRequest, isLocal }: Option): Promise => {
if (!isLocal) {
setEnv({ isPullRequest });
}
const { baseRef, datalakeGitHubToken } = getEnv();
const taskId = isPullRequest ? Config.taskId.pr : Config.taskId.merge;
const gitHubActions = GitHubActions.create();
const meta = gitHubActions.generateMeta();
const option: PerformanceReport.Option = {
snapshot: {
minimize: true,
},
filesize: {
applicationRoot: Config.applicationRoot,
},
exectime: {
averageList: [2, "all"],
},
};
const query: PerformanceReport.Filesize.Repository.Query = {
git: {
base: {
ref: baseRef,
},
},
};
const filesize: PerformanceReport.Filesize.InitialParams = {
snapshot: {
filename: path.join(Config.workingDirectory, pkg.name, Config.snapshot.filesize),
query,
},
meta,
groups: [
{
name: `${pkg.name}-seed`,
version: `${pkg.version}`,
items: {
"package.json": {
absolutePath: path.join(Config.applicationRoot, "package.json"),
},
},
},
{
name: `${pkg.name}-cjs`,
version: `${pkg.version}`,
items: {
"$cjs/index.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$cjs/index.js"),
},
"$cjs/exectime.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$cjs/exectime.js"),
},
"$cjs/filesize.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$cjs/filesize.js"),
},
},
},
{
name: `${pkg.name}-esm`,
version: `${pkg.version}`,
items: {
"$esm/index.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$esm/index.js"),
},
"$esm/exectime.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$esm/exectime.js"),
},
"$esm/filesize.js": {
absolutePath: path.join(Config.applicationRoot, "lib/$esm/filesize.js"),
},
},
},
],
};
const exectime: PerformanceReport.Exectime.InitialParams = {
snapshot: {
filename: path.join(Config.workingDirectory, pkg.name, Config.snapshot.exectime),
query,
},
meta,
groups: [
{
name: pkg.name,
description: "self repository performance report.",
measurement: Exectime.generateExectimeMeasure(),
},
],
};
const config: PerformanceReport.Config = {
reporter: {
filesize,
exectime,
},
git: Config.gitConfig(datalakeGitHubToken),
applicationRoot: Config.applicationRoot,
workingDirectory: Config.workingDirectory,
};
const report = await PerformanceReport.generate(config, option);
if (isPullRequest) {
const text = [report.markdown.exectime, report.markdown.filesize, generateHideComment(taskId)].join(EOL + EOL);
await gitHubActions.createOrUpdateComment(text, taskId);
}
if (!isPullRequest && !isLocal) {
await report.sync();
}
if (!isLocal) {
report.clearWorkingDirectory();
}
};
```
## Development
| scripts | description |
| :------------------------ | :------------------------------------------ |
| `build` | typescript build and create proxy directory |
| `clean` | clean up |
| `format:code` | prettier |
| `format:yarn:lock` | yarn.lock deduplicate |
| `lerna:version:up` | lerna version up |
| `test` | execute test:depcruise, test:jest |
| `test:depcruise` | dependency-cruiser's test |
| `test:jest` | jest test |
| `ts` | execute ts-node |
| `release:github:registry` | publish github registry |
| `release:npm:registry` | publish npm registry |
## Features
- [Proxy Directory](https://himenon.github.io/docs/javascript/proxy-directory-design-pattern/)
## Release
- Automatic version updates are performed when merged into the `main` branch.
## LICENCE
[@@himenon/performance-report](https://github.com/Himenon/performance-report)・MIT