sfcc-performance-analyser 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +109 -2
- package/dist/analyze.d.ts +47 -0
- package/dist/analyze.d.ts.map +1 -0
- package/dist/analyze.js +74 -0
- package/dist/analyze.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +228 -0
- package/dist/cli.js.map +1 -0
- package/dist/config.d.ts +36 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +58 -0
- package/dist/config.js.map +1 -0
- package/dist/data/benchmarks.d.ts +17 -0
- package/dist/data/benchmarks.d.ts.map +1 -0
- package/dist/data/benchmarks.js +22 -0
- package/dist/data/benchmarks.js.map +1 -0
- package/dist/engine/ENGINE_VERSION.d.ts +2 -0
- package/dist/engine/ENGINE_VERSION.d.ts.map +1 -0
- package/dist/engine/ENGINE_VERSION.js +5 -0
- package/dist/engine/ENGINE_VERSION.js.map +1 -0
- package/dist/engine/analyzeEndpoint.d.ts +5 -0
- package/dist/engine/analyzeEndpoint.d.ts.map +1 -0
- package/dist/engine/analyzeEndpoint.js +156 -0
- package/dist/engine/analyzeEndpoint.js.map +1 -0
- package/dist/engine/benchmarkEngine.d.ts +19 -0
- package/dist/engine/benchmarkEngine.d.ts.map +1 -0
- package/dist/engine/benchmarkEngine.js +26 -0
- package/dist/engine/benchmarkEngine.js.map +1 -0
- package/dist/engine/configuredProfile.d.ts +9 -0
- package/dist/engine/configuredProfile.d.ts.map +1 -0
- package/dist/engine/configuredProfile.js +138 -0
- package/dist/engine/configuredProfile.js.map +1 -0
- package/dist/engine/defaults.d.ts +26 -0
- package/dist/engine/defaults.d.ts.map +1 -0
- package/dist/engine/defaults.js +134 -0
- package/dist/engine/defaults.js.map +1 -0
- package/dist/engine/diagnostics.d.ts +21 -0
- package/dist/engine/diagnostics.d.ts.map +1 -0
- package/dist/engine/diagnostics.js +260 -0
- package/dist/engine/diagnostics.js.map +1 -0
- package/dist/engine/exportMermaid.d.ts +3 -0
- package/dist/engine/exportMermaid.d.ts.map +1 -0
- package/dist/engine/exportMermaid.js +62 -0
- package/dist/engine/exportMermaid.js.map +1 -0
- package/dist/engine/graphEngine.d.ts +20 -0
- package/dist/engine/graphEngine.d.ts.map +1 -0
- package/dist/engine/graphEngine.js +81 -0
- package/dist/engine/graphEngine.js.map +1 -0
- package/dist/engine/jobEngine.d.ts +26 -0
- package/dist/engine/jobEngine.d.ts.map +1 -0
- package/dist/engine/jobEngine.js +35 -0
- package/dist/engine/jobEngine.js.map +1 -0
- package/dist/engine/latencyEngine.d.ts +25 -0
- package/dist/engine/latencyEngine.d.ts.map +1 -0
- package/dist/engine/latencyEngine.js +61 -0
- package/dist/engine/latencyEngine.js.map +1 -0
- package/dist/engine/nodeFactory.d.ts +5 -0
- package/dist/engine/nodeFactory.d.ts.map +1 -0
- package/dist/engine/nodeFactory.js +74 -0
- package/dist/engine/nodeFactory.js.map +1 -0
- package/dist/engine/pathEngine.d.ts +20 -0
- package/dist/engine/pathEngine.d.ts.map +1 -0
- package/dist/engine/pathEngine.js +169 -0
- package/dist/engine/pathEngine.js.map +1 -0
- package/dist/engine/provenance.d.ts +15 -0
- package/dist/engine/provenance.d.ts.map +1 -0
- package/dist/engine/provenance.js +34 -0
- package/dist/engine/provenance.js.map +1 -0
- package/dist/engine/semantics.d.ts +16 -0
- package/dist/engine/semantics.d.ts.map +1 -0
- package/dist/engine/semantics.js +58 -0
- package/dist/engine/semantics.js.map +1 -0
- package/dist/engine/types.d.ts +221 -0
- package/dist/engine/types.d.ts.map +1 -0
- package/dist/engine/types.js +3 -0
- package/dist/engine/types.js.map +1 -0
- package/dist/engine/validateGraph.d.ts +3 -0
- package/dist/engine/validateGraph.d.ts.map +1 -0
- package/dist/engine/validateGraph.js +57 -0
- package/dist/engine/validateGraph.js.map +1 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -0
- package/dist/report/markdown.d.ts +51 -0
- package/dist/report/markdown.d.ts.map +1 -0
- package/dist/report/markdown.js +263 -0
- package/dist/report/markdown.js.map +1 -0
- package/dist/report/staticFindings.d.ts +21 -0
- package/dist/report/staticFindings.d.ts.map +1 -0
- package/dist/report/staticFindings.js +104 -0
- package/dist/report/staticFindings.js.map +1 -0
- package/dist/trace/apiCatalog.d.ts +33 -0
- package/dist/trace/apiCatalog.d.ts.map +1 -0
- package/dist/trace/apiCatalog.js +156 -0
- package/dist/trace/apiCatalog.js.map +1 -0
- package/dist/trace/buildModel.d.ts +31 -0
- package/dist/trace/buildModel.d.ts.map +1 -0
- package/dist/trace/buildModel.js +159 -0
- package/dist/trace/buildModel.js.map +1 -0
- package/dist/trace/entries.d.ts +40 -0
- package/dist/trace/entries.d.ts.map +1 -0
- package/dist/trace/entries.js +407 -0
- package/dist/trace/entries.js.map +1 -0
- package/dist/trace/parse.d.ts +13 -0
- package/dist/trace/parse.d.ts.map +1 -0
- package/dist/trace/parse.js +126 -0
- package/dist/trace/parse.js.map +1 -0
- package/dist/trace/tracer.d.ts +192 -0
- package/dist/trace/tracer.d.ts.map +1 -0
- package/dist/trace/tracer.js +1004 -0
- package/dist/trace/tracer.js.map +1 -0
- package/dist/trace/workspace.d.ts +51 -0
- package/dist/trace/workspace.d.ts.map +1 -0
- package/dist/trace/workspace.js +240 -0
- package/dist/trace/workspace.js.map +1 -0
- package/package.json +67 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Rahul Anand
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,110 @@
|
|
|
1
|
-
#
|
|
1
|
+
# SFCC Performance Analyser
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Statically traces Salesforce B2C Commerce (SFCC) endpoints **through your own cartridge code**, builds a latency model with the same engine as the [SFCC Performance Analyzer](https://www.rahulpunitanand.com/tools/sfcc-performance-analyzer) web tool, and writes a Markdown report you can upload there to inspect, tweak and compare.
|
|
4
|
+
|
|
5
|
+
It's static analysis: nothing runs on a sandbox, no credentials needed. Point it at the repository that contains your cartridges.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save-dev sfcc-performance-analyser
|
|
9
|
+
npx sfcc-perf --list
|
|
10
|
+
npx sfcc-perf Product-Show --out reports/Product-Show.md
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## What it traces
|
|
14
|
+
|
|
15
|
+
| Entry | Example id |
|
|
16
|
+
|---|---|
|
|
17
|
+
| SFRA controller route | `Product-Show` |
|
|
18
|
+
| SCAPI Custom API endpoint | `api:loyalty/getPoints` |
|
|
19
|
+
| OCAPI / SCAPI / custom hook | `hook:dw.ocapi.shop.basket.beforePATCH` |
|
|
20
|
+
| Job step (`steptypes.json`) | `job:custom.ExportOrders` |
|
|
21
|
+
| Any function | `cartridges/app_x/cartridge/scripts/foo.js#bar` |
|
|
22
|
+
|
|
23
|
+
It resolves the cartridge path, SFRA `extend`/`append`/`prepend`/`replace` chains, `*/cartridge/…` and `module.superModule` requires, helpers, models, `hooks.json` hooks, Service Framework calls (with timeouts from `services.xml`), `Transaction.wrap`, `CacheMgr` caches, the page cache, ISML remote includes / slots / content assets, branches and loops. Each SFCC API call becomes one of the web tool's operation blocks.
|
|
24
|
+
|
|
25
|
+
## CLI
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
sfcc-perf --list # every traceable entry point
|
|
29
|
+
sfcc-perf Product-Show # Markdown report to stdout
|
|
30
|
+
sfcc-perf Product-Show --out perf/Product-Show.md # … to a file
|
|
31
|
+
sfcc-perf Product-Show Cart-AddProduct --out-dir perf
|
|
32
|
+
sfcc-perf --all --json # every entry, JSON summary, reports in .sfcc-perf/reports
|
|
33
|
+
sfcc-perf --all --max-p95 900 # exit 2 if any modeled P95 > 900 ms
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
`sfcc-performance-analyser` is the same command with a longer name. Run `sfcc-perf --help` for all options.
|
|
37
|
+
|
|
38
|
+
| Exit code | Meaning |
|
|
39
|
+
|---|---|
|
|
40
|
+
| 0 | OK |
|
|
41
|
+
| 1 | An entry couldn't be traced (unknown route, missing file, …) |
|
|
42
|
+
| 2 | A latency budget was exceeded |
|
|
43
|
+
|
|
44
|
+
### CI example (GitHub Actions)
|
|
45
|
+
|
|
46
|
+
```yaml
|
|
47
|
+
- run: npx sfcc-perf --all --json > perf-summary.json
|
|
48
|
+
- uses: actions/upload-artifact@v4
|
|
49
|
+
with: { name: sfcc-perf-reports, path: .sfcc-perf/reports }
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Config file
|
|
53
|
+
|
|
54
|
+
`.sfcc-perf.json` in the repository root is read by the CLI, the API helpers and the VS Code extension:
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"cartridgePath": "app_custom:int_payment:app_storefront_base",
|
|
59
|
+
"conditionalProbability": 0.5,
|
|
60
|
+
"loopIterations": 5,
|
|
61
|
+
"cacheHitRate": 0.8,
|
|
62
|
+
"maxDepth": 12,
|
|
63
|
+
"scanTemplates": true,
|
|
64
|
+
"latencyOverrides": { "serviceFrameworkCall": { "avg": 350, "p95": 900 } },
|
|
65
|
+
"reportDirectory": "perf-reports",
|
|
66
|
+
"entries": ["Product-Show", "Search-Show", "Cart-AddProduct", "api:loyalty/getPoints"],
|
|
67
|
+
"budgets": {
|
|
68
|
+
"Product-Show": { "avg": 400, "p95": 900 },
|
|
69
|
+
"*": { "p95": 1500 }
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Command-line flags override the file. Without a `cartridgePath`, it is read from a `site.xml` `<custom-cartridges>` in the repo, or inferred (`app_*` → `int_`/`link_` → `plugin_` → `lib_` → `app_storefront_base`).
|
|
75
|
+
|
|
76
|
+
## API
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import fs from "node:fs";
|
|
80
|
+
import { runAnalysis, renderMarkdown, listEntryPoints, createSession, loadConfig, checkBudget } from "sfcc-performance-analyser";
|
|
81
|
+
|
|
82
|
+
const run = runAnalysis(["/path/to/repo"], "Product-Show", { loopIterations: 3 });
|
|
83
|
+
run.analysis.averageLatency; // modeled average (ms)
|
|
84
|
+
run.analysis.p95; // modeled P95
|
|
85
|
+
run.model.nodes; // the web tool's node/edge model
|
|
86
|
+
run.findings, run.staticFindings; // engine findings + code findings
|
|
87
|
+
fs.writeFileSync("Product-Show.md", renderMarkdown(run, { reportDir: "." }));
|
|
88
|
+
|
|
89
|
+
// Several entries with one parsed workspace:
|
|
90
|
+
const { ws, tracer, opts } = createSession(["/path/to/repo"], loadConfig("/path/to/repo").config);
|
|
91
|
+
for (const e of listEntryPoints(ws, tracer)) console.log(e.id, e.detail);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Types are included.
|
|
95
|
+
|
|
96
|
+
## The report
|
|
97
|
+
|
|
98
|
+
Summary (average, P50/P95/P99, best/worst case, critical path, cache hit vs miss, reference range), the middleware chain, every operation with its source `file:line`, how often it runs and its share, the top contributors, findings (the web tool's rules plus code findings: N+1 in loops, raw `HTTPClient`, writes in GET, uncached rendered pages, missing service timeouts, full catalog scans), the call tree, a Mermaid flow, assumptions and coverage, and the embedded model the web tool imports (between `<!-- sfcc-perf-model:begin -->` and `<!-- sfcc-perf-model:end -->`).
|
|
99
|
+
|
|
100
|
+
On the web analyzer, click **Import** and choose the `.md`: it loads the traced flow, recomputes it with the same engine and shows a *report → now* comparison while you change values.
|
|
101
|
+
|
|
102
|
+
> These are **modeled** numbers built from the web analyzer's illustrative latency defaults, not measurements. Use them to compare designs and find the expensive path, not as SLAs.
|
|
103
|
+
|
|
104
|
+
## Limits
|
|
105
|
+
|
|
106
|
+
Static analysis can't see runtime values: dynamic `require()` and hook names, values passed through arrays/objects and calls on unknown receivers are skipped (each report lists what it couldn't resolve). Remote includes are counted at include cost only — trace the included route separately. Legacy XML pipelines are not supported.
|
|
107
|
+
|
|
108
|
+
## License
|
|
109
|
+
|
|
110
|
+
MIT
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { type BenchmarkComparison } from "./engine/benchmarkEngine";
|
|
2
|
+
import { type SfccFinding } from "./engine/diagnostics";
|
|
3
|
+
import { type JobThroughputResult } from "./engine/jobEngine";
|
|
4
|
+
import type { EndpointAnalysis, LatencyProfile, ModelDefaultsState, OperationType } from "./engine/types";
|
|
5
|
+
import { type ModelBuild } from "./trace/buildModel";
|
|
6
|
+
import { type TraceResult } from "./trace/entries";
|
|
7
|
+
import { type StaticFinding } from "./report/staticFindings";
|
|
8
|
+
import { Tracer, type TraceOptions } from "./trace/tracer";
|
|
9
|
+
import { SfccWorkspace } from "./trace/workspace";
|
|
10
|
+
export interface AnalyzeOptions extends TraceOptions {
|
|
11
|
+
cartridgePath: string;
|
|
12
|
+
cacheHitRate: number;
|
|
13
|
+
latencyOverrides: Partial<Record<OperationType, Partial<LatencyProfile>>>;
|
|
14
|
+
}
|
|
15
|
+
export declare const DEFAULT_OPTIONS: AnalyzeOptions;
|
|
16
|
+
export interface AnalysisRun {
|
|
17
|
+
ws: SfccWorkspace;
|
|
18
|
+
tracer: Tracer;
|
|
19
|
+
trace: TraceResult;
|
|
20
|
+
model: ModelBuild;
|
|
21
|
+
modelDefaults: ModelDefaultsState;
|
|
22
|
+
analysis: EndpointAnalysis;
|
|
23
|
+
findings: SfccFinding[];
|
|
24
|
+
staticFindings: StaticFinding[];
|
|
25
|
+
benchmark: BenchmarkComparison;
|
|
26
|
+
job: JobThroughputResult | null;
|
|
27
|
+
options: AnalyzeOptions;
|
|
28
|
+
generatedAt: Date;
|
|
29
|
+
}
|
|
30
|
+
export declare function createSession(roots: string[], options?: Partial<AnalyzeOptions>): {
|
|
31
|
+
ws: SfccWorkspace;
|
|
32
|
+
tracer: Tracer;
|
|
33
|
+
opts: {
|
|
34
|
+
cartridgePath: string;
|
|
35
|
+
cacheHitRate: number;
|
|
36
|
+
latencyOverrides: Partial<Record<OperationType, Partial<LatencyProfile>>>;
|
|
37
|
+
conditionalProbability: number;
|
|
38
|
+
loopIterations: number;
|
|
39
|
+
maxDepth: number;
|
|
40
|
+
scanTemplates: boolean;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
export declare function buildModelDefaults(opts: AnalyzeOptions): ModelDefaultsState;
|
|
44
|
+
/** Trace one entry point end to end and evaluate it with the web analyzer's engine. */
|
|
45
|
+
export declare function runAnalysis(roots: string[], entryId: string, options?: Partial<AnalyzeOptions>): AnalysisRun;
|
|
46
|
+
export declare function analyzeWith(ws: SfccWorkspace, tracer: Tracer, opts: AnalyzeOptions, entryId: string): AnalysisRun;
|
|
47
|
+
//# sourceMappingURL=analyze.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analyze.d.ts","sourceRoot":"","sources":["../src/analyze.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAExF,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAwB,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACpF,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1G,OAAO,EAAc,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAkB,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;CAC3E;AAED,eAAO,MAAM,eAAe,EAAE,cAQ7B,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,aAAa,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,EAAE,UAAU,CAAC;IAClB,aAAa,EAAE,kBAAkB,CAAC;IAClC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,GAAG,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAChC,OAAO,EAAE,cAAc,CAAC;IACxB,WAAW,EAAE,IAAI,CAAC;CACnB;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM;;;;uBA9BnE,MAAM;sBACP,MAAM;0BACF,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;;;;;;EAiC1E;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,kBAAkB,CAQ3E;AAED,uFAAuF;AACvF,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM,GAAG,WAAW,CAGhH;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CAwBjH"}
|
package/dist/analyze.js
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEFAULT_OPTIONS = void 0;
|
|
4
|
+
exports.createSession = createSession;
|
|
5
|
+
exports.buildModelDefaults = buildModelDefaults;
|
|
6
|
+
exports.runAnalysis = runAnalysis;
|
|
7
|
+
exports.analyzeWith = analyzeWith;
|
|
8
|
+
const analyzeEndpoint_1 = require("./engine/analyzeEndpoint");
|
|
9
|
+
const benchmarkEngine_1 = require("./engine/benchmarkEngine");
|
|
10
|
+
const defaults_1 = require("./engine/defaults");
|
|
11
|
+
const diagnostics_1 = require("./engine/diagnostics");
|
|
12
|
+
const jobEngine_1 = require("./engine/jobEngine");
|
|
13
|
+
const buildModel_1 = require("./trace/buildModel");
|
|
14
|
+
const entries_1 = require("./trace/entries");
|
|
15
|
+
const staticFindings_1 = require("./report/staticFindings");
|
|
16
|
+
const tracer_1 = require("./trace/tracer");
|
|
17
|
+
const workspace_1 = require("./trace/workspace");
|
|
18
|
+
exports.DEFAULT_OPTIONS = {
|
|
19
|
+
cartridgePath: "",
|
|
20
|
+
conditionalProbability: 0.5,
|
|
21
|
+
loopIterations: 5,
|
|
22
|
+
maxDepth: 12,
|
|
23
|
+
scanTemplates: true,
|
|
24
|
+
cacheHitRate: 0.8,
|
|
25
|
+
latencyOverrides: {},
|
|
26
|
+
};
|
|
27
|
+
function createSession(roots, options = {}) {
|
|
28
|
+
const opts = { ...exports.DEFAULT_OPTIONS, ...options };
|
|
29
|
+
const ws = workspace_1.SfccWorkspace.discover(roots, opts.cartridgePath);
|
|
30
|
+
const tracer = new tracer_1.Tracer(ws, opts);
|
|
31
|
+
return { ws, tracer, opts };
|
|
32
|
+
}
|
|
33
|
+
function buildModelDefaults(opts) {
|
|
34
|
+
const md = (0, defaults_1.createDefaultModelDefaults)();
|
|
35
|
+
md.cacheHitRate = opts.cacheHitRate;
|
|
36
|
+
for (const [type, patch] of Object.entries(opts.latencyOverrides ?? {})) {
|
|
37
|
+
const key = type;
|
|
38
|
+
if (md.profiles[key] && patch)
|
|
39
|
+
md.profiles[key] = { ...md.profiles[key], ...patch };
|
|
40
|
+
}
|
|
41
|
+
return md;
|
|
42
|
+
}
|
|
43
|
+
/** Trace one entry point end to end and evaluate it with the web analyzer's engine. */
|
|
44
|
+
function runAnalysis(roots, entryId, options = {}) {
|
|
45
|
+
const { ws, tracer, opts } = createSession(roots, options);
|
|
46
|
+
return analyzeWith(ws, tracer, opts, entryId);
|
|
47
|
+
}
|
|
48
|
+
function analyzeWith(ws, tracer, opts, entryId) {
|
|
49
|
+
if (ws.cartridges.length === 0)
|
|
50
|
+
throw new Error("No SFCC cartridges found (folders containing a `cartridge/` directory).");
|
|
51
|
+
const trace = (0, entries_1.traceEntry)(ws, tracer, entryId);
|
|
52
|
+
const modelDefaults = buildModelDefaults(opts);
|
|
53
|
+
const model = (0, buildModel_1.buildModel)(trace, modelDefaults);
|
|
54
|
+
const analysis = (0, analyzeEndpoint_1.analyzeEndpoint)(model.nodes, model.edges, modelDefaults, model.rootId);
|
|
55
|
+
const findings = (0, diagnostics_1.runSfccDiagnostics)(model.nodes, model.edges, analysis, modelDefaults);
|
|
56
|
+
const benchmark = (0, benchmarkEngine_1.compareToBenchmark)(analysis, trace.presetKey);
|
|
57
|
+
const rootData = model.nodes.find((n) => n.id === model.rootId).data;
|
|
58
|
+
const job = rootData.jobConfig ? (0, jobEngine_1.analyzeJobThroughput)(model.nodes, model.edges, modelDefaults, model.rootId, rootData.jobConfig) : null;
|
|
59
|
+
return {
|
|
60
|
+
ws,
|
|
61
|
+
tracer,
|
|
62
|
+
trace,
|
|
63
|
+
model,
|
|
64
|
+
modelDefaults,
|
|
65
|
+
analysis,
|
|
66
|
+
findings,
|
|
67
|
+
staticFindings: (0, staticFindings_1.staticFindings)(trace, model, tracer),
|
|
68
|
+
benchmark,
|
|
69
|
+
job,
|
|
70
|
+
options: opts,
|
|
71
|
+
generatedAt: new Date(),
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=analyze.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analyze.js","sourceRoot":"","sources":["../src/analyze.ts"],"names":[],"mappings":";;;AA2CA,sCAKC;AAED,gDAQC;AAGD,kCAGC;AAED,kCAwBC;AA1FD,8DAA2D;AAC3D,8DAAwF;AACxF,gDAA+D;AAC/D,sDAA4E;AAC5E,kDAAoF;AAEpF,mDAAiE;AACjE,6CAA+D;AAC/D,4DAA6E;AAC7E,2CAA2D;AAC3D,iDAAkD;AAQrC,QAAA,eAAe,GAAmB;IAC7C,aAAa,EAAE,EAAE;IACjB,sBAAsB,EAAE,GAAG;IAC3B,cAAc,EAAE,CAAC;IACjB,QAAQ,EAAE,EAAE;IACZ,aAAa,EAAE,IAAI;IACnB,YAAY,EAAE,GAAG;IACjB,gBAAgB,EAAE,EAAE;CACrB,CAAC;AAiBF,SAAgB,aAAa,CAAC,KAAe,EAAE,UAAmC,EAAE;IAClF,MAAM,IAAI,GAAG,EAAE,GAAG,uBAAe,EAAE,GAAG,OAAO,EAAE,CAAC;IAChD,MAAM,EAAE,GAAG,yBAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACpC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,SAAgB,kBAAkB,CAAC,IAAoB;IACrD,MAAM,EAAE,GAAG,IAAA,qCAA0B,GAAE,CAAC;IACxC,EAAE,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,EAAE,CAAC;QACxE,MAAM,GAAG,GAAG,IAAqB,CAAC;QAClC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK;YAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;IACtF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,uFAAuF;AACvF,SAAgB,WAAW,CAAC,KAAe,EAAE,OAAe,EAAE,UAAmC,EAAE;IACjG,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3D,OAAO,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED,SAAgB,WAAW,CAAC,EAAiB,EAAE,MAAc,EAAE,IAAoB,EAAE,OAAe;IAClG,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC3H,MAAM,KAAK,GAAG,IAAA,oBAAU,EAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,aAAa,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,IAAA,uBAAU,EAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAA,iCAAe,EAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxF,MAAM,QAAQ,GAAG,IAAA,gCAAkB,EAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IACvF,MAAM,SAAS,GAAG,IAAA,oCAAkB,EAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAChE,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,MAAM,CAAE,CAAC,IAAI,CAAC;IACtE,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,gCAAoB,EAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxI,OAAO;QACL,EAAE;QACF,MAAM;QACN,KAAK;QACL,KAAK;QACL,aAAa;QACb,QAAQ;QACR,QAAQ;QACR,cAAc,EAAE,IAAA,+BAAc,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC;QACpD,SAAS;QACT,GAAG;QACH,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI,IAAI,EAAE;KACxB,CAAC;AACJ,CAAC"}
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAsJA,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAqE3C"}
|
package/dist/cli.js
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
|
+
};
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.main = main;
|
|
8
|
+
const node_fs_1 = __importDefault(require("node:fs"));
|
|
9
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
10
|
+
const analyze_1 = require("./analyze");
|
|
11
|
+
const config_1 = require("./config");
|
|
12
|
+
const markdown_1 = require("./report/markdown");
|
|
13
|
+
const entries_1 = require("./trace/entries");
|
|
14
|
+
const HELP = `sfcc-performance-analyser ${markdown_1.GENERATOR_VERSION}
|
|
15
|
+
Static SFCC endpoint trace → latency model + Markdown report for the SFCC Performance Analyzer.
|
|
16
|
+
|
|
17
|
+
Usage:
|
|
18
|
+
sfcc-perf --list list every traceable entry point
|
|
19
|
+
sfcc-perf <entry> [<entry>...] trace entries, print the report (one entry) or write reports
|
|
20
|
+
sfcc-perf --all trace every entry (or "entries" from the config file)
|
|
21
|
+
|
|
22
|
+
Entries:
|
|
23
|
+
Product-Show SFRA controller route
|
|
24
|
+
api:<api-name>/<endpoint> SCAPI Custom API endpoint
|
|
25
|
+
hook:<extension.point>[#function] hooks.json extension point
|
|
26
|
+
job:<step-type-id> steptypes.json job step
|
|
27
|
+
path/to/file.js#functionName any exported / top-level function
|
|
28
|
+
|
|
29
|
+
Options:
|
|
30
|
+
--root DIR workspace root (repeatable, default: cwd)
|
|
31
|
+
--config FILE config file (default: .sfcc-perf.json in the first root)
|
|
32
|
+
--cartridge-path P colon-separated cartridge path (default: config, site.xml, or inferred)
|
|
33
|
+
--out FILE report file (single entry; default: stdout)
|
|
34
|
+
--out-dir DIR report folder for several entries (default: config reportDirectory or .sfcc-perf/reports)
|
|
35
|
+
--json print a JSON summary instead of Markdown
|
|
36
|
+
--max-avg MS fail (exit 2) when a modeled average exceeds MS
|
|
37
|
+
--max-p95 MS fail (exit 2) when a modeled P95 exceeds MS
|
|
38
|
+
--conditional N branch probability (default 0.5)
|
|
39
|
+
--loops N loop iteration assumption (default 5)
|
|
40
|
+
--hit-rate N cache hit rate (default 0.8)
|
|
41
|
+
--max-depth N call depth limit (default 12)
|
|
42
|
+
--no-templates do not scan ISML templates
|
|
43
|
+
-v, --version print the version
|
|
44
|
+
|
|
45
|
+
Exit codes: 0 ok · 1 error · 2 budget exceeded
|
|
46
|
+
`;
|
|
47
|
+
function parseArgs(argv) {
|
|
48
|
+
const a = { roots: [], entries: [], all: false, list: false, json: false, out: null, outDir: null, configFile: undefined, options: {}, cliBudget: {} };
|
|
49
|
+
const num = (flag, v) => {
|
|
50
|
+
const n = Number(v);
|
|
51
|
+
if (v === undefined || Number.isNaN(n))
|
|
52
|
+
throw new Error(`${flag} expects a number`);
|
|
53
|
+
return n;
|
|
54
|
+
};
|
|
55
|
+
for (let i = 0; i < argv.length; i++) {
|
|
56
|
+
const arg = argv[i];
|
|
57
|
+
const next = () => {
|
|
58
|
+
const v = argv[++i];
|
|
59
|
+
if (v === undefined)
|
|
60
|
+
throw new Error(`${arg} expects a value`);
|
|
61
|
+
return v;
|
|
62
|
+
};
|
|
63
|
+
switch (arg) {
|
|
64
|
+
case "-h":
|
|
65
|
+
case "--help":
|
|
66
|
+
return "help";
|
|
67
|
+
case "-v":
|
|
68
|
+
case "--version":
|
|
69
|
+
return "version";
|
|
70
|
+
case "--list":
|
|
71
|
+
a.list = true;
|
|
72
|
+
break;
|
|
73
|
+
case "--all":
|
|
74
|
+
a.all = true;
|
|
75
|
+
break;
|
|
76
|
+
case "--json":
|
|
77
|
+
a.json = true;
|
|
78
|
+
break;
|
|
79
|
+
case "--root":
|
|
80
|
+
a.roots.push(node_path_1.default.resolve(next()));
|
|
81
|
+
break;
|
|
82
|
+
case "--config":
|
|
83
|
+
a.configFile = next();
|
|
84
|
+
break;
|
|
85
|
+
case "--out":
|
|
86
|
+
a.out = node_path_1.default.resolve(next());
|
|
87
|
+
break;
|
|
88
|
+
case "--out-dir":
|
|
89
|
+
a.outDir = node_path_1.default.resolve(next());
|
|
90
|
+
break;
|
|
91
|
+
case "--cartridge-path":
|
|
92
|
+
a.options.cartridgePath = next();
|
|
93
|
+
break;
|
|
94
|
+
case "--conditional":
|
|
95
|
+
a.options.conditionalProbability = num(arg, next());
|
|
96
|
+
break;
|
|
97
|
+
case "--loops":
|
|
98
|
+
a.options.loopIterations = num(arg, next());
|
|
99
|
+
break;
|
|
100
|
+
case "--hit-rate":
|
|
101
|
+
a.options.cacheHitRate = num(arg, next());
|
|
102
|
+
break;
|
|
103
|
+
case "--max-depth":
|
|
104
|
+
a.options.maxDepth = num(arg, next());
|
|
105
|
+
break;
|
|
106
|
+
case "--no-templates":
|
|
107
|
+
a.options.scanTemplates = false;
|
|
108
|
+
break;
|
|
109
|
+
case "--max-avg":
|
|
110
|
+
a.cliBudget.avg = num(arg, next());
|
|
111
|
+
break;
|
|
112
|
+
case "--max-p95":
|
|
113
|
+
a.cliBudget.p95 = num(arg, next());
|
|
114
|
+
break;
|
|
115
|
+
default:
|
|
116
|
+
if (arg.startsWith("-"))
|
|
117
|
+
throw new Error(`Unknown option ${arg} (see --help)`);
|
|
118
|
+
a.entries.push(arg);
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
if (a.roots.length === 0)
|
|
122
|
+
a.roots.push(process.cwd());
|
|
123
|
+
return a;
|
|
124
|
+
}
|
|
125
|
+
function summary(run, reportFile, violations) {
|
|
126
|
+
const a = run.analysis;
|
|
127
|
+
const r = (n) => (n === null ? null : Math.round(n * 10) / 10);
|
|
128
|
+
return {
|
|
129
|
+
entry: run.trace.entry.id,
|
|
130
|
+
kind: run.trace.entry.kind,
|
|
131
|
+
averageMs: r(a.averageLatency),
|
|
132
|
+
p50Ms: r(a.p50),
|
|
133
|
+
p95Ms: r(a.p95),
|
|
134
|
+
p99Ms: r(a.p99),
|
|
135
|
+
minMs: r(a.minLatency),
|
|
136
|
+
maxMs: r(a.maxLatency),
|
|
137
|
+
criticalPathMs: r(a.criticalPathTotal),
|
|
138
|
+
operations: run.model.nodes.length - 2,
|
|
139
|
+
findings: run.findings.length + run.staticFindings.length,
|
|
140
|
+
report: reportFile,
|
|
141
|
+
budgetViolations: violations,
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
function main(argv) {
|
|
145
|
+
const parsed = parseArgs(argv);
|
|
146
|
+
if (parsed === "help") {
|
|
147
|
+
process.stdout.write(HELP);
|
|
148
|
+
return 0;
|
|
149
|
+
}
|
|
150
|
+
if (parsed === "version") {
|
|
151
|
+
process.stdout.write(`${markdown_1.GENERATOR_VERSION}\n`);
|
|
152
|
+
return 0;
|
|
153
|
+
}
|
|
154
|
+
const args = parsed;
|
|
155
|
+
const { config, file: configFile } = (0, config_1.loadConfig)(args.roots[0], args.configFile);
|
|
156
|
+
const { reportDirectory, entries: configEntries, budgets, ...configOptions } = config;
|
|
157
|
+
const { ws, tracer, opts } = (0, analyze_1.createSession)(args.roots, { ...configOptions, ...args.options });
|
|
158
|
+
if (args.list || (!args.all && args.entries.length === 0)) {
|
|
159
|
+
const list = (0, entries_1.listEntryPoints)(ws, tracer);
|
|
160
|
+
if (args.json) {
|
|
161
|
+
process.stdout.write(JSON.stringify({ cartridgePath: ws.cartridgePath, cartridgePathSource: ws.cartridgePathSource, entries: list.map((e) => ({ id: e.id, kind: e.kind, detail: e.detail, file: ws.display(e.file) })) }, null, 2) + "\n");
|
|
162
|
+
}
|
|
163
|
+
else {
|
|
164
|
+
process.stdout.write(`Cartridge path (${ws.cartridgePathSource}): ${ws.cartridgePath || "(no cartridges found)"}\n`);
|
|
165
|
+
if (configFile)
|
|
166
|
+
process.stdout.write(`Config: ${configFile}\n`);
|
|
167
|
+
process.stdout.write("\n");
|
|
168
|
+
for (const e of list)
|
|
169
|
+
process.stdout.write(`${e.id.padEnd(50)} ${e.detail}\n`);
|
|
170
|
+
if (!args.list)
|
|
171
|
+
process.stdout.write(`\n${HELP}`);
|
|
172
|
+
}
|
|
173
|
+
return 0;
|
|
174
|
+
}
|
|
175
|
+
const ids = args.all ? (configEntries?.length ? configEntries : (0, entries_1.listEntryPoints)(ws, tracer).map((e) => e.id)) : args.entries;
|
|
176
|
+
const single = ids.length === 1 && !args.all;
|
|
177
|
+
const outDir = args.outDir ?? (configFile && reportDirectory ? node_path_1.default.resolve(node_path_1.default.dirname(configFile), reportDirectory) : node_path_1.default.resolve(args.roots[0], reportDirectory ?? ".sfcc-perf/reports"));
|
|
178
|
+
const results = [];
|
|
179
|
+
let failed = false;
|
|
180
|
+
let errors = 0;
|
|
181
|
+
for (const id of ids) {
|
|
182
|
+
let run;
|
|
183
|
+
try {
|
|
184
|
+
run = (0, analyze_1.analyzeWith)(ws, tracer, opts, id);
|
|
185
|
+
}
|
|
186
|
+
catch (e) {
|
|
187
|
+
errors++;
|
|
188
|
+
process.stderr.write(`error: ${id}: ${e.message}\n`);
|
|
189
|
+
continue;
|
|
190
|
+
}
|
|
191
|
+
const budget = { ...((0, config_1.budgetFor)(run.trace.entry.id, budgets) ?? {}), ...args.cliBudget };
|
|
192
|
+
const violations = (0, config_1.checkBudget)(run, Object.keys(budget).length ? budget : null);
|
|
193
|
+
if (violations.length)
|
|
194
|
+
failed = true;
|
|
195
|
+
let reportFile = null;
|
|
196
|
+
const toStdout = single && !args.out && !args.outDir && !args.json;
|
|
197
|
+
if (toStdout) {
|
|
198
|
+
process.stdout.write((0, markdown_1.renderMarkdown)(run));
|
|
199
|
+
}
|
|
200
|
+
else if (!(args.json && single && !args.out && !args.outDir)) {
|
|
201
|
+
reportFile = single && args.out ? args.out : node_path_1.default.join(outDir, `${id.replace(/[^\w.-]+/g, "_")}.md`);
|
|
202
|
+
node_fs_1.default.mkdirSync(node_path_1.default.dirname(reportFile), { recursive: true });
|
|
203
|
+
node_fs_1.default.writeFileSync(reportFile, (0, markdown_1.renderMarkdown)(run, { reportDir: node_path_1.default.dirname(reportFile) }));
|
|
204
|
+
}
|
|
205
|
+
results.push(summary(run, reportFile, violations));
|
|
206
|
+
if (!args.json && !toStdout) {
|
|
207
|
+
const s = results[results.length - 1];
|
|
208
|
+
process.stderr.write(`${violations.length ? "✗" : "✓"} ${id}: avg ${s.averageMs} ms · p95 ${s.p95Ms ?? "–"} ms · ${s.operations} ops${reportFile ? ` → ${node_path_1.default.relative(process.cwd(), reportFile)}` : ""}\n`);
|
|
209
|
+
}
|
|
210
|
+
for (const v of violations)
|
|
211
|
+
process.stderr.write(` budget exceeded: ${v.metric} ${Math.round(v.actualMs)} ms > ${v.limitMs} ms\n`);
|
|
212
|
+
}
|
|
213
|
+
if (args.json)
|
|
214
|
+
process.stdout.write(JSON.stringify(single ? results[0] ?? null : results, null, 2) + "\n");
|
|
215
|
+
if (failed)
|
|
216
|
+
return 2;
|
|
217
|
+
return errors > 0 ? 1 : 0;
|
|
218
|
+
}
|
|
219
|
+
if (require.main === module) {
|
|
220
|
+
try {
|
|
221
|
+
process.exitCode = main(process.argv.slice(2));
|
|
222
|
+
}
|
|
223
|
+
catch (e) {
|
|
224
|
+
process.stderr.write(`error: ${e.message}\n`);
|
|
225
|
+
process.exitCode = 1;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAsJA,oBAqEC;AA1ND,sDAAyB;AACzB,0DAA6B;AAC7B,uCAA8F;AAC9F,qCAAiG;AACjG,gDAAsE;AACtE,6CAAkD;AAElD,MAAM,IAAI,GAAG,6BAA6B,4BAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgC1D,CAAC;AAeF,SAAS,SAAS,CAAC,IAAc;IAC/B,MAAM,CAAC,GAAS,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAC7J,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,CAAqB,EAAE,EAAE;QAClD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,mBAAmB,CAAC,CAAC;QACpF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,KAAK,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,CAAC;YAC/D,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QACF,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,OAAO,MAAM,CAAC;YAChB,KAAK,IAAI,CAAC;YACV,KAAK,WAAW;gBACd,OAAO,SAAS,CAAC;YACnB,KAAK,QAAQ;gBACX,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;gBACd,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC;gBACb,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;gBACd,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBACnC,MAAM;YACR,KAAK,UAAU;gBACb,CAAC,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC;gBACtB,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,CAAC,GAAG,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,WAAW;gBACd,CAAC,CAAC,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,kBAAkB;gBACrB,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,IAAI,EAAE,CAAC;gBACjC,MAAM;YACR,KAAK,eAAe;gBAClB,CAAC,CAAC,OAAO,CAAC,sBAAsB,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBACpD,MAAM;YACR,KAAK,SAAS;gBACZ,CAAC,CAAC,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,YAAY;gBACf,CAAC,CAAC,OAAO,CAAC,YAAY,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1C,MAAM;YACR,KAAK,aAAa;gBAChB,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,gBAAgB;gBACnB,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC;gBAChC,MAAM;YACR,KAAK,WAAW;gBACd,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnC,MAAM;YACR,KAAK,WAAW;gBACd,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnC,MAAM;YACR;gBACE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,eAAe,CAAC,CAAC;gBAC/E,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACtD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,GAAgB,EAAE,UAAyB,EAAE,UAA6B;IACzF,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IACvB,MAAM,CAAC,GAAG,CAAC,CAAgB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9E,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACzB,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI;QAC1B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAC9B,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACf,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACf,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACf,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QACtB,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QACtB,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC;QACtC,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QACtC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,CAAC,MAAM;QACzD,MAAM,EAAE,UAAU;QAClB,gBAAgB,EAAE,UAAU;KAC7B,CAAC;AACJ,CAAC;AAED,SAAgB,IAAI,CAAC,IAAc;IACjC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,4BAAiB,IAAI,CAAC,CAAC;QAC/C,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAChF,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,GAAG,MAAM,CAAC;IACtF,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAA,uBAAa,EAAC,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAE9F,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,IAAA,yBAAe,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,aAAa,EAAE,EAAE,CAAC,aAAa,EAAE,mBAAmB,EAAE,EAAE,CAAC,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7O,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,mBAAmB,MAAM,EAAE,CAAC,aAAa,IAAI,uBAAuB,IAAI,CAAC,CAAC;YACrH,IAAI,UAAU;gBAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,UAAU,IAAI,CAAC,CAAC;YAChE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,KAAK,MAAM,CAAC,IAAI,IAAI;gBAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;YAC/E,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,yBAAe,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IAC7H,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,IAAI,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,eAAe,IAAI,oBAAoB,CAAC,CAAC,CAAC;IAC/L,MAAM,OAAO,GAAiC,EAAE,CAAC;IACjD,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;QACrB,IAAI,GAAgB,CAAC;QACrB,IAAI,CAAC;YACH,GAAG,GAAG,IAAA,qBAAW,EAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,EAAE,CAAC;YACT,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,KAAM,CAAW,CAAC,OAAO,IAAI,CAAC,CAAC;YAChE,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,GAAG,CAAC,IAAA,kBAAS,EAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACxF,MAAM,UAAU,GAAG,IAAA,oBAAW,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChF,IAAI,UAAU,CAAC,MAAM;YAAE,MAAM,GAAG,IAAI,CAAC;QAErC,IAAI,UAAU,GAAkB,IAAI,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACnE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAA,yBAAc,EAAC,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,UAAU,GAAG,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;YACrG,iBAAE,CAAC,SAAS,CAAC,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,iBAAE,CAAC,aAAa,CAAC,UAAU,EAAE,IAAA,yBAAc,EAAC,GAAG,EAAE,EAAE,SAAS,EAAE,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,SAAS,aAAa,CAAC,CAAC,KAAK,IAAI,GAAG,SAAS,CAAC,CAAC,UAAU,OAAO,UAAU,CAAC,CAAC,CAAC,MAAM,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAChN,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,UAAU;YAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC;IACtI,CAAC;IAED,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3G,IAAI,MAAM;QAAE,OAAO,CAAC,CAAC;IACrB,OAAO,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAW,CAAW,CAAC,OAAO,IAAI,CAAC,CAAC;QACzD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
|
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { AnalysisRun, AnalyzeOptions } from "./analyze";
|
|
2
|
+
export declare const CONFIG_FILE_NAMES: string[];
|
|
3
|
+
/** Latency budget for one entry point (milliseconds, modeled values). */
|
|
4
|
+
export interface Budget {
|
|
5
|
+
avg?: number;
|
|
6
|
+
p95?: number;
|
|
7
|
+
p99?: number;
|
|
8
|
+
max?: number;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Project config shared by the CLI, the programmatic API and the VS Code
|
|
12
|
+
* extension. Lives in `.sfcc-perf.json` at the repository root.
|
|
13
|
+
*/
|
|
14
|
+
export interface SfccPerfConfig extends Partial<AnalyzeOptions> {
|
|
15
|
+
/** Where reports are written, relative to the config file. */
|
|
16
|
+
reportDirectory?: string;
|
|
17
|
+
/** Entry ids traced by `--all` when given; defaults to every discovered entry. */
|
|
18
|
+
entries?: string[];
|
|
19
|
+
/** Budgets keyed by entry id; `"*"` applies to every entry without its own budget. */
|
|
20
|
+
budgets?: Record<string, Budget>;
|
|
21
|
+
}
|
|
22
|
+
export interface LoadedConfig {
|
|
23
|
+
config: SfccPerfConfig;
|
|
24
|
+
file: string | null;
|
|
25
|
+
}
|
|
26
|
+
export declare function findConfigFile(root: string): string | null;
|
|
27
|
+
export declare function loadConfig(root: string, explicitFile?: string): LoadedConfig;
|
|
28
|
+
export interface BudgetViolation {
|
|
29
|
+
entryId: string;
|
|
30
|
+
metric: keyof Budget;
|
|
31
|
+
limitMs: number;
|
|
32
|
+
actualMs: number;
|
|
33
|
+
}
|
|
34
|
+
export declare function budgetFor(entryId: string, budgets: Record<string, Budget> | undefined): Budget | null;
|
|
35
|
+
export declare function checkBudget(run: AnalysisRun, budget: Budget | null): BudgetViolation[];
|
|
36
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE7D,eAAO,MAAM,iBAAiB,UAA+C,CAAC;AAE9E,yEAAyE;AACzE,MAAM,WAAW,MAAM;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,cAAc,CAAC;IAC7D,8DAA8D;IAC9D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM1D;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,YAAY,CAW5E;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAGrG;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,eAAe,EAAE,CAYtF"}
|
package/dist/config.js
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.CONFIG_FILE_NAMES = void 0;
|
|
7
|
+
exports.findConfigFile = findConfigFile;
|
|
8
|
+
exports.loadConfig = loadConfig;
|
|
9
|
+
exports.budgetFor = budgetFor;
|
|
10
|
+
exports.checkBudget = checkBudget;
|
|
11
|
+
const node_fs_1 = __importDefault(require("node:fs"));
|
|
12
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
13
|
+
exports.CONFIG_FILE_NAMES = [".sfcc-perf.json", "sfcc-perf.config.json"];
|
|
14
|
+
function findConfigFile(root) {
|
|
15
|
+
for (const name of exports.CONFIG_FILE_NAMES) {
|
|
16
|
+
const f = node_path_1.default.join(root, name);
|
|
17
|
+
if (node_fs_1.default.existsSync(f))
|
|
18
|
+
return f;
|
|
19
|
+
}
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
function loadConfig(root, explicitFile) {
|
|
23
|
+
const file = explicitFile ? node_path_1.default.resolve(root, explicitFile) : findConfigFile(root);
|
|
24
|
+
if (!file)
|
|
25
|
+
return { config: {}, file: null };
|
|
26
|
+
let parsed;
|
|
27
|
+
try {
|
|
28
|
+
parsed = JSON.parse(node_fs_1.default.readFileSync(file, "utf8"));
|
|
29
|
+
}
|
|
30
|
+
catch (e) {
|
|
31
|
+
throw new Error(`Cannot read ${file}: ${e.message}`);
|
|
32
|
+
}
|
|
33
|
+
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
|
|
34
|
+
throw new Error(`${file} must contain a JSON object.`);
|
|
35
|
+
return { config: parsed, file };
|
|
36
|
+
}
|
|
37
|
+
function budgetFor(entryId, budgets) {
|
|
38
|
+
if (!budgets)
|
|
39
|
+
return null;
|
|
40
|
+
return budgets[entryId] ?? budgets["*"] ?? null;
|
|
41
|
+
}
|
|
42
|
+
function checkBudget(run, budget) {
|
|
43
|
+
if (!budget)
|
|
44
|
+
return [];
|
|
45
|
+
const a = run.analysis;
|
|
46
|
+
const actual = { avg: a.averageLatency, p95: a.p95, p99: a.p99, max: a.maxLatency };
|
|
47
|
+
const out = [];
|
|
48
|
+
for (const metric of Object.keys(budget)) {
|
|
49
|
+
const limit = budget[metric];
|
|
50
|
+
const value = actual[metric];
|
|
51
|
+
if (limit === undefined || value === null || value === undefined)
|
|
52
|
+
continue;
|
|
53
|
+
if (value > limit)
|
|
54
|
+
out.push({ entryId: run.trace.entry.id, metric, limitMs: limit, actualMs: value });
|
|
55
|
+
}
|
|
56
|
+
return out;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;;AAgCA,wCAMC;AAED,gCAWC;AASD,8BAGC;AAED,kCAYC;AA7ED,sDAAyB;AACzB,0DAA6B;AAGhB,QAAA,iBAAiB,GAAG,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;AA4B9E,SAAgB,cAAc,CAAC,IAAY;IACzC,KAAK,MAAM,IAAI,IAAI,yBAAiB,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,iBAAE,CAAC,UAAU,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,UAAU,CAAC,IAAY,EAAE,YAAqB;IAC5D,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACpF,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC7C,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,KAAM,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,8BAA8B,CAAC,CAAC;IAC3H,OAAO,EAAE,MAAM,EAAE,MAAwB,EAAE,IAAI,EAAE,CAAC;AACpD,CAAC;AASD,SAAgB,SAAS,CAAC,OAAe,EAAE,OAA2C;IACpF,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;AAClD,CAAC;AAED,SAAgB,WAAW,CAAC,GAAgB,EAAE,MAAqB;IACjE,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IACvB,MAAM,MAAM,GAAwC,EAAE,GAAG,EAAE,CAAC,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;IACzH,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAqB,EAAE,CAAC;QAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAC3E,IAAI,KAAK,GAAG,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IACxG,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { SourceProvenance } from "../engine/types";
|
|
2
|
+
export type BenchmarkEntry = {
|
|
3
|
+
key: string;
|
|
4
|
+
label: string;
|
|
5
|
+
range: [number, number];
|
|
6
|
+
source: SourceProvenance;
|
|
7
|
+
notes?: string;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Comparison context only - never injected as a graph node or summed into a
|
|
11
|
+
* modeled result. See engine/benchmarkEngine.ts for the correctness
|
|
12
|
+
* guarantee. Every entry ships as "tool-assumption" with an explicit
|
|
13
|
+
* disclaimer; do not upgrade to "salesforce-reference" without an actual,
|
|
14
|
+
* linkable citation to Salesforce documentation.
|
|
15
|
+
*/
|
|
16
|
+
export declare const SALESFORCE_REFERENCE_BENCHMARKS: Record<string, BenchmarkEntry>;
|
|
17
|
+
//# sourceMappingURL=benchmarks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"benchmarks.d.ts","sourceRoot":"","sources":["../../src/data/benchmarks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAMF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAQ1E,CAAC"}
|