Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 eric sciple
|
16e22db75a | ||
|
eric sciple
|
d954a19859 |
@@ -27,36 +27,3 @@ jobs:
|
||||
- run: npm run build -ws
|
||||
- run: npm run lint -ws
|
||||
- run: npm test -ws
|
||||
|
||||
check-generated:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js 16.15
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 16.15
|
||||
cache: 'npm'
|
||||
registry-url: 'https://npm.pkg.github.com'
|
||||
- run: npm ci
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Regenerate JSON files
|
||||
run: |
|
||||
cd languageservice && npm run update-webhooks && cd ..
|
||||
- name: Check for uncommitted changes
|
||||
run: |
|
||||
if ! git diff --exit-code; then
|
||||
echo ""
|
||||
echo "=========================================="
|
||||
echo "ERROR: Generated files are out of date!"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
echo "Please run the following commands locally and commit the changes:"
|
||||
echo ""
|
||||
echo " cd languageservice && npm run update-webhooks && cd .."
|
||||
echo " git add -A && git commit -m 'Regenerate JSON files'"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
+1
-9
@@ -2,12 +2,4 @@
|
||||
*/dist
|
||||
lerna-debug.log
|
||||
node_modules
|
||||
.DS_Store
|
||||
|
||||
# Minified JSON (generated at build time)
|
||||
*.min.json
|
||||
|
||||
# Intermediate JSON for size comparison (generated by update-webhooks --all)
|
||||
*.all.json
|
||||
*.drop.json
|
||||
*.strip.json
|
||||
.DS_Store
|
||||
@@ -0,0 +1,666 @@
|
||||
# Bundle Size Investigation
|
||||
|
||||
## Current State
|
||||
|
||||
**Package sizes on disk (in github-ui node_modules):**
|
||||
- `@actions/languageservice`: **7.9M**
|
||||
- `@actions/workflow-parser`: **1.5M**
|
||||
- `@actions/expressions`: **560K**
|
||||
- **Total: ~10M**
|
||||
|
||||
**Largest files:**
|
||||
| File | Size | % of total |
|
||||
|------|------|------------|
|
||||
| `languageservice/dist/context-providers/events/webhooks.json` | 6.2M | 62% |
|
||||
| `languageservice/dist/context-providers/events/objects.json` | 948K | 9.5% |
|
||||
| `workflow-parser/dist/workflow-v1.0.json` | 112K | 1% |
|
||||
| `languageservice/dist/context-providers/descriptions.json` | 20K | <1% |
|
||||
|
||||
## JSON File Analysis
|
||||
|
||||
### What `webhooks.json` is used for
|
||||
|
||||
Provides autocomplete and validation for `github.*` context expressions. When you type `${{ github.event.` the language service uses this data to:
|
||||
- Suggest available properties based on event type (push, pull_request, etc.)
|
||||
- Provide descriptions for hover tooltips
|
||||
- Validate property access is valid for the event type
|
||||
|
||||
### Field usage analysis
|
||||
|
||||
| Field | Location | Size | Used for Autocomplete | Used for Validation | Used for Hover |
|
||||
|-------|----------|------|----------------------|---------------------|----------------|
|
||||
| `bodyParameters[].description` | Inside each param | Part of bodyParams | ✅ Documentation popup | ✅ Property existence | ✅ Descriptions |
|
||||
| `bodyParameters[].name/type/etc` | Inside each param | 1.55 MB total | ✅ Property names | ✅ Property existence | ✅ Structure |
|
||||
| `description` | Top-level on event | 17 KB | ❌ Defined but unused | ❌ | ❌ |
|
||||
| `summary` | Top-level on event | 155 KB | ❌ | ❌ | ❌ |
|
||||
| `availability` | Top-level on event | 7 KB | ❌ | ❌ | ❌ |
|
||||
| `category` | Top-level on event | 3 KB | ❌ | ❌ | ❌ |
|
||||
| `action` | Top-level on event | 2 KB | ❌ | ❌ | ❌ |
|
||||
|
||||
**Key insight:** `bodyParameters` (including nested `description` fields) is used for ALL features. The **top-level** fields (`summary`, `description`, `availability`, `category`, `action`) are defined in the TypeScript types but never actually accessed in code - they can be stripped.
|
||||
|
||||
### Why top-level `description`/`summary` shouldn't be used for workflow events
|
||||
|
||||
**Question:** Could we use the webhooks.json top-level `description` or `summary` fields to enhance autocomplete/hover for the `on:` field?
|
||||
|
||||
**Answer:** No - they serve different purposes and the existing solution is better.
|
||||
|
||||
**Comparison:**
|
||||
|
||||
| Source | Example for `push` | Purpose |
|
||||
|--------|-------------------|---------|
|
||||
| `workflow-v1.0.json` (current) | "Runs your workflow when you push a commit or tag." | **User-facing** - explains what triggers the workflow |
|
||||
| `webhooks.json` description | "A push was made to a repository branch..." | **API-facing** - describes the GitHub API event |
|
||||
| `webhooks.json` summary | "This event occurs when a commit or tag is pushed. To subscribe to this event, a GitHub App must have at least read-level access..." | **App developer-facing** - API permissions info |
|
||||
|
||||
**The current solution is correct:**
|
||||
- `workflow-v1.0.json` contains workflow-specific event descriptions written for GitHub Actions users
|
||||
- These are shown in autocomplete/hover when completing `on: push`, `on: pull_request`, etc.
|
||||
- Located in `languageservice/src/value-providers/definition.ts` line 46: `description: def.description`
|
||||
|
||||
**The webhooks.json descriptions would be wrong:**
|
||||
- Written for GitHub App developers, not GitHub Actions users
|
||||
- Include irrelevant details (API permissions, subscription info)
|
||||
- Don't explain what happens in the context of a workflow
|
||||
|
||||
**Conclusion:** Keep the top-level fields stripped - they're not needed and would be confusing if used.
|
||||
|
||||
### Minification analysis
|
||||
|
||||
| File | Pretty Size | Minified Size | Savings |
|
||||
|------|-------------|---------------|---------|
|
||||
| `webhooks.json` | 4.1 MB | 1.6 MB | **2.5 MB (60.5%)** |
|
||||
| `objects.json` | 666 KB | 325 KB | **341 KB (51.3%)** |
|
||||
| `workflow-v1.0.json` | 91 KB | 70 KB | **22 KB (23.5%)** |
|
||||
|
||||
**The files are NOT minified!** Just minifying saves 60%.
|
||||
|
||||
### Compression analysis (gzip)
|
||||
|
||||
Production servers typically gzip assets. Here's what matters for network transfer:
|
||||
|
||||
| File | Original | Minified | Gzipped | Min+Gzip |
|
||||
|------|----------|----------|---------|----------|
|
||||
| `webhooks.json` | 4.0 MB | 1.6 MB | 198 KB | **90 KB** |
|
||||
| `objects.json` | 651 KB | 317 KB | 38 KB | **23 KB** |
|
||||
| `workflow-v1.0.json` | 91 KB | 70 KB | 13 KB | **13 KB** |
|
||||
|
||||
**What matters for different concerns:**
|
||||
|
||||
| Concern | What matters |
|
||||
|---------|--------------|
|
||||
| **Network transfer** | Compressed size (gzip/brotli) - already small (~126 KB total) |
|
||||
| **npm package size** | Uncompressed size on disk - affects install times |
|
||||
| **Memory usage** | Parsed JSON object size in memory |
|
||||
| **Parse time** | Uncompressed size (must decompress before parsing) |
|
||||
|
||||
**Key insight:** Network transfer is NOT the main concern (~126 KB gzipped). Minifying still matters for:
|
||||
- Smaller npm package size (better install times)
|
||||
- Less to decompress on client
|
||||
- Faster JSON parsing (less text to parse)
|
||||
|
||||
## How the files are generated
|
||||
|
||||
The JSON files are **auto-generated** from GitHub's official REST API description:
|
||||
|
||||
```
|
||||
npm run update-webhooks
|
||||
```
|
||||
|
||||
**Source:** `github:github/rest-api-description` (GitHub's OpenAPI spec)
|
||||
|
||||
**Generation script:** `languageservice/script/webhooks/index.ts`
|
||||
- Reads webhook definitions from the dereferenced OpenAPI schema
|
||||
- Extracts body parameters, descriptions, summaries
|
||||
- Runs deduplication to create `objects.json` (shared parameters stored once, referenced by index)
|
||||
- Outputs pretty-printed JSON (not minified)
|
||||
|
||||
**Current deduplication strategy (`deduplicate.ts`):**
|
||||
- Finds body parameters that appear in multiple webhooks
|
||||
- Stores them once in `objects.json` array
|
||||
- Replaces duplicates with numeric index references in `webhooks.json`
|
||||
|
||||
**Optimization opportunities in generation:**
|
||||
1. Add minification step (remove whitespace) - easy, ~60% savings
|
||||
2. Strip unused fields (`summary`, `availability`, `category`, `action`) - ~10% additional savings
|
||||
3. Consider more aggressive deduplication (e.g., dedupe descriptions, nested objects)
|
||||
|
||||
### `workflow-v1.0.json` (workflow schema)
|
||||
|
||||
**Hand-authored** - not generated. Located in `workflow-parser/src/`.
|
||||
|
||||
Optimization: Minify at build time (112K pretty → smaller minified).
|
||||
|
||||
### Other Small JSON Files
|
||||
|
||||
| File | Purpose | Pretty | Minified | Further Optimized |
|
||||
|------|---------|--------|----------|-------------------|
|
||||
| `descriptions.json` | Hover descriptions for contexts/functions | 18 KB | 17 KB | N/A (all used) |
|
||||
| `schedule.json` | Sample `github.event` for schedule trigger | 5.7 KB | 5.1 KB | **1.8 KB** (strip values) |
|
||||
| `workflow_call.json` | Sample `github.event` for reusable workflows | 7.3 KB | 6.5 KB | **2.3 KB** (strip values) |
|
||||
|
||||
**Why `schedule.json` / `workflow_call.json` exist:**
|
||||
|
||||
These events are NOT webhooks - they're internal GitHub Actions triggers that don't appear in the REST API webhook definitions. The files provide sample `github.event` payloads so the language service knows what properties to autocomplete:
|
||||
|
||||
```
|
||||
User types: ${{ github.event.repository.owner.login }}
|
||||
↑
|
||||
Language service walks schedule.json to find valid property names
|
||||
```
|
||||
|
||||
The code (`eventPayloads.ts` lines 109-116) uses `mergeObject()` to recursively extract property **names** - the actual values are never used.
|
||||
|
||||
**Key insight for `schedule.json` / `workflow_call.json`:** These files provide sample event payloads. The code only uses property **names** (for autocomplete like `github.event.repository.owner.login`), not values. The actual values (URLs, IDs, emails) can be replaced with `null`:
|
||||
|
||||
```javascript
|
||||
// Original (5.1 KB)
|
||||
{"repository":{"id":186853002,"name":"Hello-World","owner":{"login":"Codertocat",...},...},...}
|
||||
|
||||
// Stripped (1.8 KB) - same autocomplete functionality
|
||||
{"repository":{"id":null,"name":null,"owner":{"login":null,...},...},...}
|
||||
```
|
||||
|
||||
**Savings:** ~65% smaller for these files.
|
||||
|
||||
## JSON File Maintenance & Documentation
|
||||
|
||||
### TODO: Document maintenance procedures
|
||||
|
||||
| File | Source | How to Update | Documented? |
|
||||
|------|--------|---------------|-------------|
|
||||
| `webhooks.json` + `objects.json` | `npm run update-webhooks` from `rest-api-description` | Run script | ⚠️ Partial (in script) |
|
||||
| `workflow-v1.0.json` | Hand-authored | Manual edits | ❌ No |
|
||||
| `descriptions.json` | Hand-authored | Manual edits | ❌ No |
|
||||
| `schedule.json` | Hand-authored sample payload | Manual edits | ❌ No - unclear origin |
|
||||
| `workflow_call.json` | Hand-authored sample payload | Manual edits | ❌ No - unclear origin |
|
||||
|
||||
### Historical context (from git history):
|
||||
|
||||
- **`schedule.json`** - Added in commit `b68ac91` (Dec 2022) by Beth Brennan in "Use payload schema for events"
|
||||
- Uses "Codertocat/Hello-World" sample data (appears to be from GitHub's webhook documentation examples)
|
||||
- No documentation on where this came from or how to update it
|
||||
- **Question:** Is this based on a real scheduled workflow run? How do we know it includes all possible properties?
|
||||
|
||||
- **`workflow_call.json`** - Same commit, similar questions
|
||||
|
||||
- **Many other event JSON files** were added in that same commit, but were later replaced by the generated `webhooks.json` system. Only `schedule.json` and `workflow_call.json` remain as manual files because they're not real webhooks.
|
||||
|
||||
### Questions to answer:
|
||||
|
||||
1. **`schedule.json`** - Where did this sample payload come from? Is it based on a real event? How do we know it's complete/accurate? Does it need updating when GitHub adds new repository properties?
|
||||
|
||||
2. **`workflow_call.json`** - Same questions. Was this captured from an actual workflow run?
|
||||
|
||||
3. **`descriptions.json`** - Are these descriptions synced from docs.github.com or manually maintained? How do we keep them up to date?
|
||||
|
||||
4. **`workflow-v1.0.json`** - What's the process for adding new workflow syntax (new keys, new event types)?
|
||||
|
||||
### Recommended actions:
|
||||
|
||||
1. **Add README files** - Each JSON file should have documentation explaining what it's for, how to update it, and who maintains it
|
||||
|
||||
2. **Automate where possible** - Could `schedule.json` be generated from a real scheduled workflow run's `github.event`? Could we capture a sample automatically?
|
||||
|
||||
3. **Add tests** - Validate that sample payloads match expected structure
|
||||
|
||||
### ⚠️ BUG: `workflow_call.json` may be incorrect/useless
|
||||
|
||||
**Finding:** For `on: workflow_call` (reusable workflows), the `github.event` context is **inherited from the calling workflow**. If the caller was triggered by `push`, then `github.event` contains push data. If by `pull_request`, it contains PR data.
|
||||
|
||||
**Current behavior in `github.ts`:**
|
||||
```typescript
|
||||
// Line 87-89 - For VALIDATION mode, returns Null (any value allowed)
|
||||
if (eventsConfig.workflow_call && mode == Mode.Validation) {
|
||||
return new data.Null();
|
||||
}
|
||||
|
||||
// But for COMPLETION/HOVER mode, falls through and uses workflow_call.json!
|
||||
```
|
||||
|
||||
**Problem:** `workflow_call.json` contains generic repo/sender/org data, but this is WRONG for autocomplete. When you type `${{ github.event.` in a reusable workflow, showing `repository`, `sender`, etc. is misleading because:
|
||||
- The actual properties depend on how the workflow was called
|
||||
- Could be push properties, PR properties, or anything else
|
||||
|
||||
**Recommendation:**
|
||||
- Either return `Null` for completion/hover too (show nothing, since we can't know)
|
||||
- Or remove `workflow_call.json` entirely since it's actively misleading
|
||||
- This would save 7KB and fix a bug!
|
||||
|
||||
## npm Package Sizes
|
||||
|
||||
The actual npm package sizes (gzipped tarballs) are much smaller than disk size:
|
||||
|
||||
| Package | Disk Size | Package Size (gzipped) | Unpacked |
|
||||
|---------|-----------|------------------------|----------|
|
||||
| `@actions/languageservice` | 7.9M | **368 KB** | 7.7 MB |
|
||||
| `@actions/workflow-parser` | 1.5M | **98 KB** | 548 KB |
|
||||
| `@actions/expressions` | 560K | **34 KB** | 153 KB |
|
||||
| **Total** | ~10M | **~500 KB** | ~8.4 MB |
|
||||
|
||||
**Key insight:** npm install downloads ~500KB gzipped. The disk/memory impact is ~8.4 MB unpacked.
|
||||
|
||||
## Dependencies Analysis
|
||||
|
||||
**Direct dependencies:**
|
||||
|
||||
| Package | Disk Size | Used By | Notes |
|
||||
|---------|-----------|---------|-------|
|
||||
| `yaml` | 1.4 MB | workflow-parser, languageservice | Full YAML parser, well-structured |
|
||||
| `cronstrue` | 1.4 MB | workflow-parser | Cron → human text. Main: 44KB (no i18n) |
|
||||
| `vscode-languageserver-types` | 396 KB | languageservice | Type definitions for LSP |
|
||||
| `vscode-languageserver-textdocument` | 72 KB | languageservice | Text document handling |
|
||||
| `vscode-uri` | 256 KB | languageservice | URI parsing |
|
||||
|
||||
**Observations:**
|
||||
- `cronstrue` has a 44KB main entry (without i18n) vs 238KB with i18n. Bundlers should use the smaller one.
|
||||
- `yaml` is necessary - no lighter alternative for full YAML parsing
|
||||
- `vscode-*` packages are minimal and necessary for LSP compatibility
|
||||
|
||||
## Areas to Investigate
|
||||
|
||||
1. ✅ **Total bundle size** - Analyzed above
|
||||
2. ✅ **Specific heavy dependencies** - `cronstrue` and `yaml` analyzed
|
||||
3. **Tree-shaking** - Whether unused code is being properly eliminated
|
||||
4. ✅ **Load time impact** - Lazy-loaded in github-ui via dynamic import()
|
||||
5. ✅ **JSON files for event validation** - Main culprit (6.2MB webhooks.json)
|
||||
6. ✅ **Minifying the workflow schema JSON file** - 112K → can be minified
|
||||
|
||||
## Potential Optimizations
|
||||
|
||||
### High Impact
|
||||
|
||||
1. **Drop 31 unused webhook events** - Events like `installation`, `marketplace_purchase`, `sponsorship`, `star`, `team`, etc. are in `webhooks.json` but cannot be used as workflow triggers. Confirmed against [GitHub's official docs](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows).
|
||||
|
||||
| Metric | Before | After | Savings |
|
||||
|--------|--------|-------|---------|
|
||||
| Events | 63 | 32 | 31 dropped |
|
||||
| Size | 1.76 MB | 1.42 MB | **19%** |
|
||||
|
||||
**Events to drop:**
|
||||
```
|
||||
code_scanning_alert, commit_comment, dependabot_alert, deploy_key,
|
||||
github_app_authorization, installation, installation_repositories,
|
||||
installation_target, marketplace_purchase, member, membership, meta,
|
||||
org_block, organization, package, ping, projects_v2, projects_v2_item,
|
||||
pull_request_review_thread, repository, repository_import,
|
||||
repository_vulnerability_alert, secret_scanning_alert,
|
||||
secret_scanning_alert_location, security_advisory, security_and_analysis,
|
||||
sponsorship, star, team, team_add, workflow_job
|
||||
```
|
||||
|
||||
2. **Strip unused fields** - Remove `summary`, `availability`, `category`, `action` fields that are never used by the language service. Only `bodyParameters` and `descriptionHtml` are needed.
|
||||
|
||||
3. **Minify JSON files** - Currently pretty-printed with whitespace. Minifying saves ~60%.
|
||||
|
||||
4. **Combined impact estimate:**
|
||||
|
||||
| Optimization | webhooks.json | objects.json |
|
||||
|--------------|---------------|--------------|
|
||||
| Original | 6.2 MB | 948 KB |
|
||||
| Drop unused events | 5.0 MB (-19%) | 770 KB (-19%) |
|
||||
| Strip unused fields | 3.0 MB (-40%) | 460 KB (-40%) |
|
||||
| Minify | 1.2 MB (-60%) | 225 KB (-52%) |
|
||||
| **Gzipped (network)** | **~60 KB** | **~20 KB** |
|
||||
|
||||
5. **Add `"sideEffects"` to all package.json files** - Enable tree-shaking across all packages:
|
||||
- `expressions/package.json`: `"sideEffects": false`
|
||||
- `workflow-parser/package.json`: `"sideEffects": false`
|
||||
- `languageservice/package.json`: `"sideEffects": ["./dist/context-providers/events/eventPayloads.js"]`
|
||||
|
||||
### Medium Impact
|
||||
|
||||
6. **Minify `workflow-v1.0.json` schema (112K)** - Strip whitespace. Note: This file is hand-authored, not generated from webhook data.
|
||||
|
||||
7. **Minify and strip small JSON files** - `schedule.json`, `descriptions.json`:
|
||||
- Minify all (remove whitespace)
|
||||
- Strip values from `schedule.json` (only property names are used)
|
||||
|
||||
8. **Investigate `workflow_call.json` usage** - See bug section above. This file may be incorrect/useless:
|
||||
- For `on: workflow_call`, `github.event` is inherited from the calling workflow
|
||||
- Current code returns `Null` for validation (correct) but uses `workflow_call.json` for completion (incorrect?)
|
||||
- Options: Remove file entirely, or fix code to return `Null` for all modes
|
||||
- Saves 7KB + potentially fixes misleading autocomplete
|
||||
|
||||
9. **Lazy-load event validation data** - Refactor `eventPayloads.ts` to load JSON on first use instead of at import time.
|
||||
|
||||
### Low Impact / Further Investigation
|
||||
|
||||
10. **Tree-shake unused exports** - Ensure webpack is eliminating dead code.
|
||||
|
||||
11. **Evaluate `cronstrue` size** - Check if it's worth keeping or replacing with lighter alternative.
|
||||
|
||||
11. **Bundle analysis** - Run webpack-bundle-analyzer to see actual bundled sizes after minification/compression.
|
||||
|
||||
## Implementation Plan
|
||||
|
||||
### Phase 1: Update generation script (`languageservice/script/webhooks/index.ts`)
|
||||
|
||||
1. Add list of valid workflow trigger events (whitelist)
|
||||
2. Filter out events not in whitelist during generation
|
||||
3. Strip unused fields (`summary`, `availability`, `category`, `action`)
|
||||
4. Output minified JSON (`JSON.stringify(data)` instead of `JSON.stringify(data, null, 2)`)
|
||||
|
||||
### Phase 1b: Minify/optimize small hand-authored JSON files
|
||||
|
||||
1. Minify `descriptions.json` (18 KB → 17 KB)
|
||||
2. Strip values & minify `schedule.json` (5.7 KB → 1.8 KB)
|
||||
3. Strip values & minify `workflow_call.json` (7.3 KB → 2.3 KB)
|
||||
4. Minify `workflow-v1.0.json` (112 KB → ~90 KB)
|
||||
|
||||
### Phase 2: Add sideEffects to all package.json files
|
||||
|
||||
1. Add `"sideEffects": false` to `expressions/package.json`
|
||||
2. Add `"sideEffects": false` to `workflow-parser/package.json`
|
||||
3. Add `"sideEffects": ["./dist/context-providers/events/eventPayloads.js"]` to `languageservice/package.json`
|
||||
|
||||
### Phase 3: (Optional) Refactor for lazy loading
|
||||
|
||||
1. Move JSON imports inside functions
|
||||
2. Remove top-level hydration code, make it lazy
|
||||
|
||||
### Phase 4: Automated JSON updates via GitHub Actions
|
||||
|
||||
Create workflows to automatically keep JSON files up to date:
|
||||
|
||||
#### 4a: Webhook JSON auto-update workflow
|
||||
|
||||
```yaml
|
||||
# .github/workflows/update-webhooks.yml
|
||||
name: Update webhook definitions
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * 1' # Weekly on Monday
|
||||
workflow_dispatch: # Manual trigger
|
||||
|
||||
jobs:
|
||||
update:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
- run: npm ci
|
||||
- run: npm run update-webhooks
|
||||
- name: Create PR if changes
|
||||
uses: peter-evans/create-pull-request@v5
|
||||
with:
|
||||
title: "chore: Update webhook definitions"
|
||||
body: |
|
||||
Automated update from `rest-api-description` package.
|
||||
|
||||
This PR was created automatically by the update-webhooks workflow.
|
||||
branch: auto/update-webhooks
|
||||
delete-branch: true # Delete old branch, creates fresh PR each time
|
||||
commit-message: "chore: Update webhook definitions"
|
||||
```
|
||||
|
||||
#### 4b: Schedule/workflow_call JSON auto-update workflow
|
||||
|
||||
Create a workflow that runs an actual scheduled workflow and captures `github.event`:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/capture-schedule-payload.yml
|
||||
name: Capture schedule event payload
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 1 * *' # Monthly on the 1st
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
capture:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Capture github.event
|
||||
run: |
|
||||
echo '${{ toJSON(github.event) }}' > /tmp/schedule-event.json
|
||||
# Strip to just property structure (values → null)
|
||||
node -e "
|
||||
const fs = require('fs');
|
||||
const strip = (o) => {
|
||||
if (Array.isArray(o)) return o.length ? [strip(o[0])] : [];
|
||||
if (o && typeof o === 'object') return Object.fromEntries(
|
||||
Object.entries(o).map(([k,v]) => [k, strip(v)])
|
||||
);
|
||||
return null;
|
||||
};
|
||||
const data = JSON.parse(fs.readFileSync('/tmp/schedule-event.json'));
|
||||
const stripped = strip(data);
|
||||
fs.writeFileSync(
|
||||
'languageservice/src/context-providers/events/schedule.json',
|
||||
JSON.stringify(stripped, null, 2)
|
||||
);
|
||||
"
|
||||
|
||||
- name: Create PR if changes
|
||||
uses: peter-evans/create-pull-request@v5
|
||||
with:
|
||||
title: "chore: Update schedule.json payload structure"
|
||||
body: |
|
||||
Captured fresh `github.event` structure from a real scheduled workflow run.
|
||||
|
||||
This ensures autocomplete suggestions match the actual event payload.
|
||||
branch: auto/update-schedule-json
|
||||
delete-branch: true
|
||||
commit-message: "chore: Update schedule.json from live event"
|
||||
```
|
||||
|
||||
#### 4c: Workflow_call payload capture
|
||||
|
||||
Similar approach - create a reusable workflow that calls itself and captures `github.event`:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/capture-workflow-call-payload.yml
|
||||
name: Capture workflow_call event payload
|
||||
on:
|
||||
workflow_call:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
capture:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Capture and update workflow_call.json
|
||||
if: github.event_name == 'workflow_call'
|
||||
run: |
|
||||
# Similar to schedule capture above
|
||||
echo '${{ toJSON(github.event) }}' | node -e "..." > workflow_call.json
|
||||
- name: Trigger self as reusable workflow
|
||||
if: github.event_name == 'workflow_dispatch'
|
||||
uses: ./.github/workflows/capture-workflow-call-payload.yml
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
- JSON files stay up to date automatically
|
||||
- PRs are created for review (not auto-merged)
|
||||
- Captures real event structures, not guessed samples
|
||||
- Weekly/monthly schedule catches GitHub API changes
|
||||
|
||||
## Validation Stages Analysis
|
||||
|
||||
The current `validate()` function does everything in one pass. We could split it into stages that load progressively:
|
||||
|
||||
### Current Loading Cascade
|
||||
|
||||
```
|
||||
validate() called
|
||||
└─ imports workflow-parser
|
||||
└─ imports workflow-v1.0.json (112KB) ← loaded immediately
|
||||
└─ parseWorkflow() → YAML parse + schema validation
|
||||
└─ additionalValidations()
|
||||
└─ getContext() → imports github.ts
|
||||
└─ imports eventPayloads.ts
|
||||
└─ imports webhooks.json (6.2MB) ← loaded immediately
|
||||
```
|
||||
|
||||
### Potential Validation Stages
|
||||
|
||||
| Stage | What it validates | Data needed | Size |
|
||||
|-------|-------------------|-------------|------|
|
||||
| **1. YAML Syntax** | Valid YAML? Quotes closed? Indentation? | YAML parser (bundled) | ~0 |
|
||||
| **2. Workflow Schema** | Valid `jobs:`, `steps:`, `runs-on:`? | `workflow-v1.0.json` | 112KB |
|
||||
| **3. Expression Syntax** | Valid `${{ }}` syntax? Functions exist? | Expression parser | ~0 |
|
||||
| **4. Context Validation** | `github.sha`, `env.FOO` exist? | Just code | ~0 |
|
||||
| **5. Event Payload Validation** | `github.event.pull_request.title` exists? | `webhooks.json` | 6.2MB |
|
||||
|
||||
### Key Insight
|
||||
|
||||
Stages 1-4 can run with minimal data (~112KB). Only Stage 5 needs the 6.2MB webhook data.
|
||||
|
||||
**Expression syntax** (`${{ secrets.FOO }}`) is different from **event payload validation** (`${{ github.event.issue.number }}`):
|
||||
- Expression syntax: Is this a valid expression? Does the function exist?
|
||||
- Event payload: Does this specific property exist on the `pull_request` event?
|
||||
|
||||
### Options for Progressive Loading
|
||||
|
||||
**Option A: Lazy load webhooks.json (simplest)**
|
||||
```typescript
|
||||
// eventPayloads.ts - defer import until first use
|
||||
let webhooksData: Webhooks | null = null;
|
||||
async function getWebhooks() {
|
||||
if (!webhooksData) {
|
||||
const { default: data } = await import("./webhooks.json");
|
||||
webhooksData = data;
|
||||
}
|
||||
return webhooksData;
|
||||
}
|
||||
```
|
||||
- Pro: Minimal code changes
|
||||
- Con: Still blocks when github.event.* is first accessed
|
||||
|
||||
**Option B: Multi-pass validation in languageservice**
|
||||
```typescript
|
||||
// New exports from @actions/languageservice
|
||||
export { validateSchema } from "./validate-schema"; // Fast
|
||||
export { validateExpressions } from "./validate-expressions"; // Needs webhooks
|
||||
export { validate } from "./validate"; // Combined (current)
|
||||
```
|
||||
- Pro: Clean API, consumer controls loading
|
||||
- Con: More work, API change
|
||||
|
||||
**Option C: Multi-pass validation in github-ui**
|
||||
```typescript
|
||||
// github-ui can show partial results
|
||||
const schemaErrors = await validate(doc); // Returns what it can immediately
|
||||
// Later, more errors may arrive as webhooks.json loads
|
||||
```
|
||||
- Pro: No languageservice changes
|
||||
- Con: Complex state management in consumer
|
||||
|
||||
### Recommendation
|
||||
|
||||
1. **Phase 1**: Minify + strip unused data (reduce 6.2MB → ~1.2MB)
|
||||
2. **Phase 2**: Lazy load webhooks.json in `eventPayloads.ts`
|
||||
3. **Phase 3** (future): Consider multi-pass API if needed
|
||||
|
||||
The lazy loading approach gives 90% of the benefit with 10% of the complexity.
|
||||
|
||||
## Side Effects Analysis
|
||||
|
||||
Need to verify the packages have no side effects before adding `"sideEffects": false`:
|
||||
|
||||
- [x] `@actions/languageservice` - Has ONE file with side effects
|
||||
- [x] `@actions/workflow-parser` - ✅ No side effects
|
||||
- [x] `@actions/expressions` - ✅ No side effects
|
||||
|
||||
Common side effects to look for:
|
||||
- Top-level function calls (not just definitions)
|
||||
- Modifying global objects (`Object.prototype`, `window`, etc.)
|
||||
- Polyfills
|
||||
- CSS imports (not applicable here)
|
||||
|
||||
### JSON Files Imported at Top Level
|
||||
|
||||
| Package | File | JSON Imported | Size | Has Side Effects? |
|
||||
|---------|------|---------------|------|-------------------|
|
||||
| languageservice | `eventPayloads.ts` | `webhooks.json` | 6.2 MB | ⚠️ YES (mutation) |
|
||||
| languageservice | `eventPayloads.ts` | `objects.json` | 948 KB | ⚠️ YES (mutation) |
|
||||
| languageservice | `eventPayloads.ts` | `schedule.json` | 6 KB | ⚠️ YES (mutation) |
|
||||
| languageservice | `eventPayloads.ts` | `workflow_call.json` | 8 KB | ⚠️ YES (mutation) |
|
||||
| languageservice | `descriptions.ts` | `descriptions.json` | 20 KB | ❌ No |
|
||||
| workflow-parser | `workflow-schema.ts` | `workflow-v1.0.json` | 112 KB | ❌ No |
|
||||
| expressions | (none) | (none) | - | ❌ No |
|
||||
|
||||
### Findings
|
||||
|
||||
**`@actions/expressions`** - ✅ No side effects
|
||||
- No JSON imports
|
||||
- No top-level code execution
|
||||
- Can use `"sideEffects": false`
|
||||
|
||||
**`@actions/workflow-parser`** - ✅ No side effects
|
||||
- `workflow-schema.ts` imports `workflow-v1.0.json` at top level BUT:
|
||||
- Only exports a function `getWorkflowSchema()` with lazy initialization
|
||||
- No top-level function calls or mutations
|
||||
- Can use `"sideEffects": false`
|
||||
|
||||
**`@actions/languageservice`** - ⚠️ HAS ONE FILE with side effects
|
||||
|
||||
`descriptions.ts` - ❌ No side effects
|
||||
- Imports `descriptions.json` (20KB) at top level
|
||||
- Only exports functions, no top-level execution
|
||||
|
||||
`eventPayloads.ts` - ⚠️ HAS SIDE EFFECTS
|
||||
```typescript
|
||||
// Lines 3-7: JSON imports at top level (7.2MB total)
|
||||
import webhookObjects from "./objects.json";
|
||||
import webhooks from "./webhooks.json";
|
||||
import schedule from "./schedule.json";
|
||||
import workflow_call from "./workflow_call.json";
|
||||
|
||||
// Lines 85-93: Executes at module load time, mutates data
|
||||
getWebhookPayload("workflow_dispatch", "default");
|
||||
const inputs = webhookPayloads?.["workflow_dispatch"]?.["default"].bodyParameters.find(p => p.name === "inputs");
|
||||
if (inputs) {
|
||||
delete inputs.childParamsGroups;
|
||||
}
|
||||
```
|
||||
|
||||
### Recommended `sideEffects` Configuration
|
||||
|
||||
**`expressions/package.json`:**
|
||||
```json
|
||||
"sideEffects": false
|
||||
```
|
||||
|
||||
**`workflow-parser/package.json`:**
|
||||
```json
|
||||
"sideEffects": false
|
||||
```
|
||||
|
||||
**`languageservice/package.json`:**
|
||||
```json
|
||||
"sideEffects": ["./dist/context-providers/events/eventPayloads.js"]
|
||||
```
|
||||
|
||||
**Impact:** Allows webpack to tree-shake unused exports. Without this, webpack assumes all imports may have side effects and keeps everything.
|
||||
|
||||
### Optional: Refactor `eventPayloads.ts` to Remove Side Effects
|
||||
|
||||
To allow `"sideEffects": false` for the entire languageservice package, refactor the mutation code:
|
||||
|
||||
```typescript
|
||||
// Before: Top-level mutation
|
||||
getWebhookPayload("workflow_dispatch", "default");
|
||||
const inputs = webhookPayloads?.["workflow_dispatch"]?.["default"].bodyParameters.find(p => p.name === "inputs");
|
||||
if (inputs) {
|
||||
delete inputs.childParamsGroups;
|
||||
}
|
||||
|
||||
// After: Lazy initialization inside function
|
||||
let initialized = false;
|
||||
function ensureInitialized() {
|
||||
if (initialized) return;
|
||||
initialized = true;
|
||||
// ... mutation code here
|
||||
}
|
||||
|
||||
export function getEventPayload(...) {
|
||||
ensureInitialized();
|
||||
// ... rest of function
|
||||
}
|
||||
```
|
||||
|
||||
This would allow full tree-shaking AND defer the 7.2MB JSON load until first use.
|
||||
@@ -0,0 +1,153 @@
|
||||
# Bundle Size Optimization Plan
|
||||
|
||||
## Goal
|
||||
|
||||
Reduce `@actions/languageservice` package size from **7.9 MB** to **~1.5 MB** (80% reduction).
|
||||
|
||||
## Summary
|
||||
|
||||
| Phase | Change | Savings | Effort |
|
||||
|-------|--------|---------|--------|
|
||||
| 1a | Minify all JSON | 60% | Low |
|
||||
| 1b | Strip unused fields | 10% | Low |
|
||||
| 1c | Drop unused events | 19% | Low |
|
||||
| 2 | Lazy-load webhooks.json (optional) | Faster initial load | Medium |
|
||||
|
||||
## Phase 1: Optimize JSON files
|
||||
|
||||
### What each JSON file is used for
|
||||
|
||||
| File | Package | Purpose |
|
||||
|------|---------|---------|
|
||||
| `webhooks.json` | languageservice | Autocomplete/validation for `github.event.*` expressions. Contains event payload schemas from GitHub's REST API. |
|
||||
| `objects.json` | languageservice | Deduplicated parameter definitions shared across webhooks (reduces duplication in webhooks.json). |
|
||||
| `workflow-v1.0.json` | workflow-parser | Workflow schema defining valid YAML structure (`jobs`, `steps`, `runs-on`, event triggers, etc.). |
|
||||
| `descriptions.json` | languageservice | Hover descriptions for contexts (`github`, `env`, `secrets`) and built-in functions (`format`, `contains`, etc.). |
|
||||
| `schedule.json` | languageservice | Sample `github.event` payload for `on: schedule` trigger (not a real webhook, manually authored). |
|
||||
| `workflow_call.json` | languageservice | Sample `github.event` payload for `on: workflow_call` trigger (not a real webhook, manually authored). |
|
||||
|
||||
### Impact table
|
||||
|
||||
| File | Original | Strip | Drop | Minify | Gzip | All (no Gzip) | All (w/ Gzip) |
|
||||
|------|----------|-------|------|--------|------|---------------|---------------|
|
||||
| `webhooks.json` | 6.2 MB | 5.6 MB | 5.0 MB | 2.4 MB | 188 KB | **1.0 MB** | **50 KB** |
|
||||
| `objects.json` | 948 KB | N/A | 770 KB | 460 KB | 36 KB | **180 KB** | **18 KB** |
|
||||
| `workflow-v1.0.json` | 112 KB | N/A | N/A | 70 KB | 13 KB | **70 KB** | **12 KB** |
|
||||
| `descriptions.json` | 18 KB | N/A | N/A | 17 KB | 3 KB | **17 KB** | **3 KB** |
|
||||
| `schedule.json` | 5.7 KB | N/A | N/A | 5.1 KB | 1 KB | **5.1 KB** | **1 KB** |
|
||||
| `workflow_call.json` | 7.3 KB | N/A | N/A | 6.5 KB | 1 KB | **6.5 KB** | **1 KB** |
|
||||
| **Total** | **7.3 MB** | | | | **~240 KB** | **~1.3 MB** | **~85 KB** |
|
||||
|
||||
- **Strip** = Remove unused fields (`summary`, `availability`, `category`, `action`)
|
||||
- **Drop** = Remove 31 non-trigger events (`installation`, `star`, `team`, etc.)
|
||||
- **Minify** = Remove whitespace (`JSON.stringify(data)` instead of `JSON.stringify(data, null, 2)`)
|
||||
- **Gzip** = Network transfer size (free - handled automatically by browser/server)
|
||||
|
||||
### 1a. Minify all JSON files
|
||||
|
||||
**Generated files** (`webhooks.json`, `objects.json`):
|
||||
- Update `languageservice/script/webhooks/index.ts`
|
||||
- These are generated via `npm run update-webhooks` from GitHub's REST API spec
|
||||
- Use `JSON.stringify(data)` instead of `JSON.stringify(data, null, 2)`
|
||||
|
||||
**Hand-authored files** (`workflow-v1.0.json`, `descriptions.json`, `schedule.json`, `workflow_call.json`):
|
||||
- Add minification step to build scripts
|
||||
|
||||
### 1b. Strip unused fields from webhooks.json
|
||||
|
||||
Remove before writing:
|
||||
- `summary`
|
||||
- `availability`
|
||||
- `category`
|
||||
- `action`
|
||||
|
||||
### 1c. Drop non-trigger events from webhooks.json
|
||||
|
||||
Keep only events that can trigger workflows ([docs](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)). Drop 31 events:
|
||||
|
||||
```
|
||||
code_scanning_alert, commit_comment, dependabot_alert, deploy_key,
|
||||
github_app_authorization, installation, installation_repositories,
|
||||
installation_target, marketplace_purchase, member, membership, meta,
|
||||
org_block, organization, package, ping, projects_v2, projects_v2_item,
|
||||
pull_request_review_thread, repository, repository_import,
|
||||
repository_vulnerability_alert, secret_scanning_alert,
|
||||
secret_scanning_alert_location, security_advisory, security_and_analysis,
|
||||
sponsorship, star, team, team_add, workflow_job
|
||||
```
|
||||
|
||||
**Expected result:** Total JSON 7.3 MB → ~1.3 MB (82% reduction)
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Lazy loading (optional)
|
||||
|
||||
Refactor `eventPayloads.ts` to load JSON on first use:
|
||||
|
||||
```typescript
|
||||
let webhooksData: Webhooks | null = null;
|
||||
|
||||
async function getWebhooks() {
|
||||
if (!webhooksData) {
|
||||
const { default: data } = await import("./webhooks.json");
|
||||
webhooksData = hydrate(data);
|
||||
}
|
||||
return webhooksData;
|
||||
}
|
||||
```
|
||||
|
||||
**Benefit:** Faster initial load when `github.event.*` isn't used.
|
||||
|
||||
---
|
||||
|
||||
## Current github-ui architecture
|
||||
|
||||
github-ui lazy-loads the language service via dynamic import:
|
||||
|
||||
```typescript
|
||||
// workflow-editor-next.ts
|
||||
let languageServicePromise: Promise<typeof import('./workflow-editor-language-service')> | null = null
|
||||
|
||||
async function getLanguageServiceModule() {
|
||||
if (!languageServicePromise) {
|
||||
languageServicePromise = import('./workflow-editor-language-service')
|
||||
}
|
||||
return languageServicePromise
|
||||
}
|
||||
```
|
||||
|
||||
**What this means:**
|
||||
- The language service is only loaded when the workflow editor needs autocomplete/hover/validation
|
||||
- Webpack code-splits it into a separate chunk
|
||||
- The ~7.9 MB package is NOT loaded on initial page load
|
||||
|
||||
**Why Phase 1 is the priority:**
|
||||
- When the language service chunk IS loaded, it still loads all 7.3 MB of JSON
|
||||
- Reducing JSON to ~1.3 MB directly reduces this chunk size
|
||||
- No changes needed in github-ui - the benefit is automatic
|
||||
|
||||
---
|
||||
|
||||
## Not doing
|
||||
|
||||
- **Tree-shaking / `sideEffects`** - github-ui imports `complete`, `hover`, and `validate` together, and all three depend on the same webhook JSON. Tree-shaking can't eliminate any of it.
|
||||
- **Replacing dependencies** - `yaml` and `cronstrue` are appropriately sized
|
||||
- **Multi-pass validation API** - Too complex for the benefit
|
||||
- **Further deduplication** - Current object deduplication is sufficient
|
||||
|
||||
---
|
||||
|
||||
## Future considerations
|
||||
|
||||
- **`workflow_call.json` may be incorrect** - For `on: workflow_call`, `github.event` is inherited from the calling workflow (could be push, pull_request, etc.). The current file shows generic properties which may be misleading for autocomplete. Consider returning `Null` for all modes or removing the file entirely.
|
||||
|
||||
---
|
||||
|
||||
## Success metrics
|
||||
|
||||
| Metric | Before | After |
|
||||
|--------|--------|-------|
|
||||
| `webhooks.json` | 6.2 MB | ~1.2 MB |
|
||||
| `objects.json` | 948 KB | ~225 KB |
|
||||
| Total package (disk) | 7.9 MB | ~1.5 MB |
|
||||
| npm tarball (gzipped) | 368 KB | ~80 KB |
|
||||
@@ -0,0 +1,35 @@
|
||||
# JSON Optimization Summary
|
||||
|
||||
| File | Original | Strip | Minify | Gzip | Strip+Minify | Minify+Gzip | Strip+Minify+Gzip |
|
||||
|------|----------|-------|--------|------|--------------|-------------|-------------------|
|
||||
| `webhooks.json` | 4.1 MB | 3.7 MB | 1.6 MB | 188 KB | 1.4 MB | 84 KB | 68 KB |
|
||||
| `objects.json` | 666 KB | N/A | 325 KB | 36 KB | 325 KB | 22 KB | 22 KB |
|
||||
| **Total** | **4.78 MB** | - | **1.95 MB** | **224 KB** | **1.77 MB** | **106 KB** | **91 KB** |
|
||||
|
||||
**Stripping removes:** `summary`, `availability`, `category`, `action` fields from webhooks.json (unused by language service)
|
||||
|
||||
## workflow-v1.0.json (hand-authored schema)
|
||||
|
||||
| File | Original | Minify | Gzip | Minify+Gzip |
|
||||
|------|----------|--------|------|-------------|
|
||||
| `workflow-v1.0.json` | 91 KB | 69 KB | 13 KB | 12 KB |
|
||||
|
||||
**Note:** No stripping applicable - this is a hand-authored schema where all fields are used.
|
||||
|
||||
## Recommended Action
|
||||
|
||||
**For webhooks.json and objects.json:** Strip + Minify
|
||||
|
||||
- Modify `languageservice/script/webhooks/index.ts` to:
|
||||
1. Strip unused fields (`summary`, `availability`, `category`, `action`) before writing
|
||||
2. Use `JSON.stringify(obj)` instead of `JSON.stringify(obj, null, 2)` to minify
|
||||
|
||||
- Gzip is handled automatically by github-ui's production server
|
||||
|
||||
**For workflow-v1.0.json:** Minify at build time
|
||||
|
||||
- Add a build step to minify the JSON before publishing
|
||||
|
||||
**Expected savings:**
|
||||
- npm package size: 4.78 MB → 1.77 MB (63% reduction)
|
||||
- Network transfer (gzip): 224 KB → 91 KB (59% reduction)
|
||||
@@ -8,10 +8,6 @@ This repository contains multiple npm packages for working with GitHub Actions w
|
||||
- [languageserver](./languageserver) - Language Server for GitHub Actions, hosting the language service for LSP-compatible editors
|
||||
- [browser-playground](./browser-playground) - Browser-based playground for the language service
|
||||
|
||||
## Documentation
|
||||
|
||||
- [JSON Data Files](./docs/json-data-files.md) - How the JSON data files are generated and maintained
|
||||
|
||||
### Note
|
||||
|
||||
Thank you for your interest in this GitHub repo, however, right now we are not taking contributions.
|
||||
|
||||
@@ -1,150 +0,0 @@
|
||||
# JSON Data Files
|
||||
|
||||
This document describes the JSON data files used by the language service packages and how they are maintained.
|
||||
|
||||
## Overview
|
||||
|
||||
The language service uses several JSON files containing schema definitions, webhook payloads, and other metadata. To reduce bundle size, these files are:
|
||||
|
||||
1. **Optimized at generation time** — unused events are dropped, unused fields are stripped
|
||||
2. **Minified at build time** — whitespace is removed to produce `.min.json` files
|
||||
|
||||
The source `.json` files are human-readable and checked into the repository. The `.min.json` files are generated during build and gitignored.
|
||||
|
||||
## Files
|
||||
|
||||
### languageservice
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `src/context-providers/events/webhooks.json` | Webhook event payload schemas for autocompletion |
|
||||
| `src/context-providers/events/objects.json` | Deduplicated shared object definitions referenced by webhooks |
|
||||
| `src/context-providers/events/schedule.json` | Schedule event context data |
|
||||
| `src/context-providers/events/workflow_call.json` | Reusable workflow call context data |
|
||||
| `src/context-providers/descriptions.json` | Context variable descriptions for hover |
|
||||
|
||||
### workflow-parser
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `src/workflow-v1.0.json` | Workflow YAML schema definition |
|
||||
|
||||
## Generation
|
||||
|
||||
### Webhooks and Objects
|
||||
|
||||
The `webhooks.json` and `objects.json` files are generated from the [GitHub REST API description](https://github.com/github/rest-api-description):
|
||||
|
||||
```bash
|
||||
cd languageservice
|
||||
npm run update-webhooks
|
||||
```
|
||||
|
||||
This script:
|
||||
1. Fetches webhook schemas from the GitHub API description
|
||||
2. **Validates** all events are categorized (fails if new events are found)
|
||||
3. **Drops** events that aren't valid workflow triggers (see [Dropped Events](#dropped-events))
|
||||
4. **Strips** unused fields like `description` and `summary` (see [Stripped Fields](#stripped-fields))
|
||||
5. **Deduplicates** shared object definitions into `objects.json`
|
||||
6. Writes the optimized, pretty-printed JSON files
|
||||
|
||||
### Handling New Webhook Events
|
||||
|
||||
When GitHub adds a new webhook event, the script will fail with an error like:
|
||||
|
||||
```
|
||||
ERROR: New webhook event(s) detected!
|
||||
|
||||
The following events are not categorized:
|
||||
- new_event_name
|
||||
|
||||
Action required:
|
||||
1. Check if the event is a valid workflow trigger
|
||||
2. Add the event to DROPPED_EVENTS or KEPT_EVENTS
|
||||
```
|
||||
|
||||
**To resolve:**
|
||||
|
||||
1. Check [Events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)
|
||||
|
||||
2. Edit `languageservice/script/webhooks/index.ts`:
|
||||
- Add to `KEPT_EVENTS` if it's a valid workflow trigger
|
||||
- Add to `DROPPED_EVENTS` if it's GitHub App or API-only
|
||||
|
||||
3. Run `npm run update-webhooks` and commit the changes
|
||||
|
||||
#### Viewing Full Unprocessed Data
|
||||
|
||||
To see all available fields and events before optimization:
|
||||
|
||||
```bash
|
||||
npm run update-webhooks -- --all
|
||||
```
|
||||
|
||||
This generates `webhooks.all.json` and `objects.all.json` (gitignored) containing the complete unprocessed data from the GitHub API.
|
||||
|
||||
### Other Files
|
||||
|
||||
The other JSON files (`schedule.json`, `workflow_call.json`, `descriptions.json`, `workflow-v1.0.json`) are manually maintained.
|
||||
|
||||
## Minification
|
||||
|
||||
At build time, all JSON files are minified (whitespace removed) to produce `.min.json` versions:
|
||||
|
||||
```bash
|
||||
npm run minify-json
|
||||
```
|
||||
|
||||
This runs automatically via `prebuild` and `pretest` hooks, so you don't need to run it manually.
|
||||
|
||||
The code imports the minified versions:
|
||||
|
||||
```ts
|
||||
import webhooks from "./events/webhooks.min.json"
|
||||
```
|
||||
|
||||
## CI Verification
|
||||
|
||||
CI verifies that generated source files are up-to-date:
|
||||
|
||||
1. Runs `npm run update-webhooks` to regenerate webhooks.json and objects.json
|
||||
2. Checks for uncommitted changes with `git diff --exit-code`
|
||||
|
||||
The `.min.json` files are generated at build time and are not committed to the repository.
|
||||
|
||||
If the build fails, run `cd languageservice && npm run update-webhooks` locally and commit the changes.
|
||||
|
||||
## Dropped Events
|
||||
|
||||
Webhook events that aren't valid workflow `on:` triggers are dropped (e.g., `installation`, `ping`, `member`, etc.). These are GitHub App or API-only events.
|
||||
|
||||
See `DROPPED_EVENTS` in `script/webhooks/index.ts` for the full list.
|
||||
|
||||
## Stripped Fields
|
||||
|
||||
Unused fields are stripped to reduce bundle size. For example:
|
||||
|
||||
```json
|
||||
// Before (from webhooks.all.json)
|
||||
{
|
||||
"type": "object",
|
||||
"name": "issue",
|
||||
"in": "body",
|
||||
"description": "The issue itself.",
|
||||
"isRequired": true,
|
||||
"childParamsGroups": [...]
|
||||
}
|
||||
|
||||
// After (webhooks.json)
|
||||
{
|
||||
"name": "issue",
|
||||
"description": "The issue itself.",
|
||||
"childParamsGroups": [...]
|
||||
}
|
||||
```
|
||||
|
||||
Only `name`, `description`, and `childParamsGroups` are kept — these are used for autocompletion and hover docs.
|
||||
|
||||
To compare all fields vs stripped, run `npm run update-webhooks -- --all` and diff the `.all.json` files against the regular ones.
|
||||
|
||||
See `EVENT_ACTION_FIELDS` and `BODY_PARAM_FIELDS` in `script/webhooks/index.ts` to modify what gets stripped.
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@actions/expressions",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
"source": "./src/index.ts",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@actions/languageserver",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"description": "Language server for GitHub Actions",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
@@ -43,8 +43,8 @@
|
||||
"watch": "tsc --build tsconfig.build.json --watch"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/languageservice": "^0.3.23",
|
||||
"@actions/workflow-parser": "^0.3.23",
|
||||
"@actions/languageservice": "^0.3.22",
|
||||
"@actions/workflow-parser": "^0.3.22",
|
||||
"@octokit/rest": "^21.1.1",
|
||||
"@octokit/types": "^9.0.0",
|
||||
"vscode-languageserver": "^8.0.2",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@actions/languageservice",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"description": "Language service for GitHub Actions",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
@@ -37,18 +37,15 @@
|
||||
"format-check": "prettier --check '**/*.ts'",
|
||||
"lint": "eslint 'src/**/*.ts'",
|
||||
"lint-fix": "eslint --fix 'src/**/*.ts'",
|
||||
"minify-json": "node ../script/minify-json.js src/context-providers/descriptions.json src/context-providers/events/webhooks.json src/context-providers/events/objects.json src/context-providers/events/schedule.json src/context-providers/events/workflow_call.json",
|
||||
"prebuild": "npm run minify-json",
|
||||
"prepublishOnly": "npm run build && npm run test",
|
||||
"pretest": "npm run minify-json",
|
||||
"test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
|
||||
"test-watch": "NODE_OPTIONS=\"--experimental-vm-modules\" jest --watch",
|
||||
"update-webhooks": "npx tsx script/webhooks/index.ts",
|
||||
"update-webhooks": "ts-node-esm script/webhooks/index.ts",
|
||||
"watch": "tsc --build tsconfig.build.json --watch"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/expressions": "^0.3.23",
|
||||
"@actions/workflow-parser": "^0.3.23",
|
||||
"@actions/expressions": "^0.3.22",
|
||||
"@actions/workflow-parser": "^0.3.22",
|
||||
"vscode-languageserver-textdocument": "^1.0.7",
|
||||
"vscode-languageserver-types": "^3.17.2",
|
||||
"vscode-uri": "^3.0.8",
|
||||
|
||||
@@ -7,185 +7,6 @@ const schema = schemaImport as any;
|
||||
|
||||
const OUTPUT_PATH = "./src/context-providers/events/webhooks.json";
|
||||
const OBJECTS_PATH = "./src/context-providers/events/objects.json";
|
||||
const ALL_OUTPUT_PATH = "./src/context-providers/events/webhooks.all.json";
|
||||
const ALL_OBJECTS_PATH = "./src/context-providers/events/objects.all.json";
|
||||
const DROP_OUTPUT_PATH = "./src/context-providers/events/webhooks.drop.json";
|
||||
const DROP_OBJECTS_PATH = "./src/context-providers/events/objects.drop.json";
|
||||
const STRIP_OUTPUT_PATH = "./src/context-providers/events/webhooks.strip.json";
|
||||
const STRIP_OBJECTS_PATH = "./src/context-providers/events/objects.strip.json";
|
||||
|
||||
// Parse --all flag
|
||||
const generateAll = process.argv.includes("--all");
|
||||
|
||||
// Events to drop - not valid workflow triggers (GitHub App or API-only events)
|
||||
// See: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
|
||||
const DROPPED_EVENTS = new Set([
|
||||
"branch_protection_configuration",
|
||||
"code_scanning_alert",
|
||||
"commit_comment",
|
||||
"custom_property",
|
||||
"custom_property_values",
|
||||
"dependabot_alert",
|
||||
"deploy_key",
|
||||
"github_app_authorization",
|
||||
"installation",
|
||||
"installation_repositories",
|
||||
"installation_target",
|
||||
"marketplace_purchase",
|
||||
"member",
|
||||
"membership",
|
||||
"merge_group",
|
||||
"meta",
|
||||
"org_block",
|
||||
"organization",
|
||||
"package",
|
||||
"personal_access_token_request",
|
||||
"ping",
|
||||
"repository",
|
||||
"repository_advisory",
|
||||
"repository_ruleset",
|
||||
"secret_scanning_alert",
|
||||
"secret_scanning_alert_location",
|
||||
"security_advisory",
|
||||
"security_and_analysis",
|
||||
"sponsorship",
|
||||
"star",
|
||||
"team",
|
||||
"team_add"
|
||||
]);
|
||||
|
||||
// Events to keep - valid workflow triggers
|
||||
// See: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
|
||||
const KEPT_EVENTS = new Set([
|
||||
"branch_protection_rule",
|
||||
"check_run",
|
||||
"check_suite",
|
||||
"create",
|
||||
"delete",
|
||||
"deployment",
|
||||
"deployment_status",
|
||||
"discussion",
|
||||
"discussion_comment",
|
||||
"fork",
|
||||
"gollum",
|
||||
"issue_comment",
|
||||
"issues",
|
||||
"label",
|
||||
"milestone",
|
||||
"page_build",
|
||||
"project",
|
||||
"project_card",
|
||||
"project_column",
|
||||
"projects_v2",
|
||||
"projects_v2_item",
|
||||
"public",
|
||||
"pull_request",
|
||||
"pull_request_review",
|
||||
"pull_request_review_comment",
|
||||
"pull_request_review_thread",
|
||||
"push",
|
||||
"registry_package",
|
||||
"release",
|
||||
"repository_dispatch",
|
||||
"repository_import",
|
||||
"repository_vulnerability_alert",
|
||||
"status",
|
||||
"watch",
|
||||
"workflow_dispatch",
|
||||
"workflow_job",
|
||||
"workflow_run"
|
||||
]);
|
||||
|
||||
/**
|
||||
* Fields to strip from the JSON data.
|
||||
*
|
||||
* EVENT_ACTION_FIELDS: stripped from each event action object (top level only)
|
||||
* Example event action object before stripping:
|
||||
* {
|
||||
* "description": "This event is triggered when...", // <-- stripped
|
||||
* "summary": "A brief summary", // <-- stripped
|
||||
* "availability": ["repository"], // <-- stripped
|
||||
* "category": "issues", // <-- stripped
|
||||
* "action": "opened", // kept
|
||||
* "bodyParameters": [...] // kept
|
||||
* }
|
||||
*
|
||||
* BODY_PARAM_FIELDS: stripped from every bodyParameters object, recursively through childParamsGroups
|
||||
* Example bodyParameter object before stripping:
|
||||
* {
|
||||
* "type": "object", // <-- stripped
|
||||
* "name": "changes", // kept (used for property names)
|
||||
* "in": "body", // <-- stripped
|
||||
* "description": "The changes that were made.", // kept (used for hover docs)
|
||||
* "isRequired": true, // <-- stripped
|
||||
* "enum": ["a", "b"], // <-- stripped
|
||||
* "default": "a", // <-- stripped
|
||||
* "childParamsGroups": [ // kept (used for nested properties)
|
||||
* {
|
||||
* "type": "string", // <-- stripped (recursive)
|
||||
* "name": "from", // kept
|
||||
* "isRequired": true // <-- stripped (recursive)
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
*/
|
||||
const EVENT_ACTION_FIELDS = ["description", "summary", "availability", "category"];
|
||||
const BODY_PARAM_FIELDS = ["type", "in", "isRequired", "enum", "default"];
|
||||
|
||||
/**
|
||||
* Strip fields from a bodyParameter object and recursively from childParamsGroups.
|
||||
*/
|
||||
function stripBodyParam(param: any): any {
|
||||
if (typeof param !== "object" || param === null) {
|
||||
return param;
|
||||
}
|
||||
|
||||
const result: any = {};
|
||||
for (const [key, value] of Object.entries(param)) {
|
||||
if (BODY_PARAM_FIELDS.includes(key)) {
|
||||
continue; // Strip this field
|
||||
}
|
||||
if (key === "childParamsGroups" && Array.isArray(value)) {
|
||||
result[key] = value.map(stripBodyParam);
|
||||
} else {
|
||||
result[key] = value;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Strip unused fields from event action data.
|
||||
*/
|
||||
function stripEventActionFields(action: any): any {
|
||||
const result: any = {};
|
||||
for (const [key, value] of Object.entries(action)) {
|
||||
if (EVENT_ACTION_FIELDS.includes(key)) {
|
||||
continue; // Strip this field
|
||||
}
|
||||
if (key === "bodyParameters" && Array.isArray(value)) {
|
||||
result[key] = value.map((p: any) => (typeof p === "number" ? p : stripBodyParam(p)));
|
||||
} else {
|
||||
result[key] = value;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Strip unused fields from all webhooks.
|
||||
* Structure: { eventName: { actionName: { ...fields } } }
|
||||
*/
|
||||
function stripFields(webhooks: Record<string, Record<string, any>>): Record<string, Record<string, any>> {
|
||||
const result: Record<string, Record<string, any>> = {};
|
||||
for (const [eventName, actions] of Object.entries(webhooks)) {
|
||||
result[eventName] = {};
|
||||
for (const [actionName, actionData] of Object.entries(actions)) {
|
||||
result[eventName][actionName] = stripEventActionFields(actionData);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
const rawWebhooks = Object.values(schema.webhooks || schema["x-webhooks"]) as any[];
|
||||
if (!rawWebhooks) {
|
||||
@@ -199,51 +20,11 @@ for (const webhook of Object.values(rawWebhooks)) {
|
||||
|
||||
await Promise.all(webhooks.map(webhook => webhook.process()));
|
||||
|
||||
// Check for unknown events (not in DROPPED_EVENTS or KEPT_EVENTS)
|
||||
const unknownEvents: string[] = [];
|
||||
for (const webhook of webhooks) {
|
||||
if (!DROPPED_EVENTS.has(webhook.category) && !KEPT_EVENTS.has(webhook.category)) {
|
||||
if (!unknownEvents.includes(webhook.category)) {
|
||||
unknownEvents.push(webhook.category);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (unknownEvents.length > 0) {
|
||||
console.error("");
|
||||
console.error("══════════════════════════════════════════════════════════════════");
|
||||
console.error("ERROR: New webhook event(s) detected!");
|
||||
console.error("══════════════════════════════════════════════════════════════════");
|
||||
console.error("");
|
||||
console.error("The following events are not categorized:");
|
||||
for (const event of unknownEvents.sort()) {
|
||||
console.error(` - ${event}`);
|
||||
}
|
||||
console.error("");
|
||||
console.error("Action required:");
|
||||
console.error(" 1. Check if the event is a valid workflow trigger:");
|
||||
console.error(
|
||||
" https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows"
|
||||
);
|
||||
console.error("");
|
||||
console.error(" 2. Add the event to DROPPED_EVENTS or KEPT_EVENTS in:");
|
||||
console.error(" languageservice/script/webhooks/index.ts");
|
||||
console.error("");
|
||||
console.error(" 3. See docs/json-data-files.md for more details.");
|
||||
console.error("");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// The category is the name of the webhook
|
||||
const categorizedWebhooks: Record<string, Record<string, Webhook>> = {};
|
||||
for (const webhook of webhooks) {
|
||||
if (!webhook.action) webhook.action = "default";
|
||||
|
||||
// Drop unused events
|
||||
if (DROPPED_EVENTS.has(webhook.category)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (categorizedWebhooks[webhook.category]) {
|
||||
categorizedWebhooks[webhook.category][webhook.action] = webhook;
|
||||
} else {
|
||||
@@ -252,59 +33,7 @@ for (const webhook of webhooks) {
|
||||
}
|
||||
}
|
||||
|
||||
// Strip fields before deduplication
|
||||
const strippedWebhooks = stripFields(categorizedWebhooks);
|
||||
const objectsArray = deduplicateWebhooks(categorizedWebhooks);
|
||||
|
||||
// Deduplicate after dropping and stripping
|
||||
const objectsArray = deduplicateWebhooks(strippedWebhooks);
|
||||
|
||||
// Write optimized output
|
||||
await fs.writeFile(OBJECTS_PATH, JSON.stringify(objectsArray, null, 2));
|
||||
await fs.writeFile(OUTPUT_PATH, JSON.stringify(strippedWebhooks, null, 2));
|
||||
|
||||
console.log(`Wrote ${OUTPUT_PATH} (${Object.keys(strippedWebhooks).length} events)`);
|
||||
console.log(`Wrote ${OBJECTS_PATH} (${objectsArray.length} objects)`);
|
||||
|
||||
// Optionally generate intermediate versions for size comparison
|
||||
if (generateAll) {
|
||||
// Helper to deep clone
|
||||
function clone<T>(obj: T): T {
|
||||
return JSON.parse(JSON.stringify(obj));
|
||||
}
|
||||
|
||||
// Build full webhooks (no drop, no strip) from fresh data
|
||||
const fullWebhooks: Record<string, Record<string, any>> = {};
|
||||
for (const webhook of webhooks) {
|
||||
const w = clone(webhook);
|
||||
if (!w.action) w.action = "default";
|
||||
fullWebhooks[w.category] ||= {};
|
||||
fullWebhooks[w.category][w.action] = w;
|
||||
}
|
||||
|
||||
// Generate all version (no drop, no strip)
|
||||
const allWebhooks = clone(fullWebhooks);
|
||||
const allObjects = deduplicateWebhooks(allWebhooks);
|
||||
await fs.writeFile(ALL_OUTPUT_PATH, JSON.stringify(allWebhooks, null, 2));
|
||||
await fs.writeFile(ALL_OBJECTS_PATH, JSON.stringify(allObjects, null, 2));
|
||||
console.log(`Wrote ${ALL_OUTPUT_PATH} (${Object.keys(allWebhooks).length} events)`);
|
||||
console.log(`Wrote ${ALL_OBJECTS_PATH} (${allObjects.length} objects)`);
|
||||
|
||||
// Generate drop-only version (drop events, no strip)
|
||||
const dropWebhooks = clone(fullWebhooks);
|
||||
for (const event of DROPPED_EVENTS) {
|
||||
delete dropWebhooks[event];
|
||||
}
|
||||
const dropObjects = deduplicateWebhooks(dropWebhooks);
|
||||
await fs.writeFile(DROP_OUTPUT_PATH, JSON.stringify(dropWebhooks, null, 2));
|
||||
await fs.writeFile(DROP_OBJECTS_PATH, JSON.stringify(dropObjects, null, 2));
|
||||
console.log(`Wrote ${DROP_OUTPUT_PATH} (${Object.keys(dropWebhooks).length} events)`);
|
||||
console.log(`Wrote ${DROP_OBJECTS_PATH} (${dropObjects.length} objects)`);
|
||||
|
||||
// Generate strip-only version (strip fields, no drop)
|
||||
const stripWebhooks = stripFields(clone(fullWebhooks));
|
||||
const stripObjects = deduplicateWebhooks(stripWebhooks);
|
||||
await fs.writeFile(STRIP_OUTPUT_PATH, JSON.stringify(stripWebhooks, null, 2));
|
||||
await fs.writeFile(STRIP_OBJECTS_PATH, JSON.stringify(stripObjects, null, 2));
|
||||
console.log(`Wrote ${STRIP_OUTPUT_PATH} (${Object.keys(stripWebhooks).length} events)`);
|
||||
console.log(`Wrote ${STRIP_OBJECTS_PATH} (${stripObjects.length} objects)`);
|
||||
}
|
||||
await fs.writeFile(OUTPUT_PATH, JSON.stringify(categorizedWebhooks, null, 2));
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import descriptions from "./descriptions.min.json";
|
||||
import descriptions from "./descriptions.json";
|
||||
|
||||
export const RootContext = "root";
|
||||
const FunctionContext = "functions";
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
import {DescriptionDictionary} from "@actions/expressions";
|
||||
import {getEventPayload, getSupportedEventTypes} from "./eventPayloads";
|
||||
|
||||
describe("eventPayloads", () => {
|
||||
describe("getSupportedEventTypes", () => {
|
||||
it("returns action types for push event", () => {
|
||||
const types = getSupportedEventTypes("push");
|
||||
expect(types).toContain("default");
|
||||
});
|
||||
|
||||
it("returns action types for issues event", () => {
|
||||
const types = getSupportedEventTypes("issues");
|
||||
expect(types.length).toBeGreaterThan(1);
|
||||
expect(types).toContain("opened");
|
||||
expect(types).toContain("closed");
|
||||
});
|
||||
});
|
||||
|
||||
describe("getEventPayload", () => {
|
||||
it("returns payload for push event", () => {
|
||||
const payload = getEventPayload("push", "default");
|
||||
expect(payload).toBeDefined();
|
||||
|
||||
// Verify common fields exist
|
||||
expect(payload?.get("ref")).toBeDefined();
|
||||
expect(payload?.get("repository")).toBeDefined();
|
||||
expect(payload?.get("sender")).toBeDefined();
|
||||
});
|
||||
|
||||
it("returns payload for issues event", () => {
|
||||
const payload = getEventPayload("issues", "opened");
|
||||
expect(payload).toBeDefined();
|
||||
|
||||
expect(payload?.get("action")).toBeDefined();
|
||||
expect(payload?.get("issue")).toBeDefined();
|
||||
expect(payload?.get("repository")).toBeDefined();
|
||||
});
|
||||
|
||||
it("preserves descriptions for hover documentation", () => {
|
||||
// This test ensures bodyParameters[].description is not stripped
|
||||
// during JSON optimization. The description field is used for hover
|
||||
// documentation in the workflow editor.
|
||||
const payload = getEventPayload("push", "default");
|
||||
expect(payload).toBeDefined();
|
||||
|
||||
// Get the description for a well-known field
|
||||
// repository should have a description like "A repository on GitHub"
|
||||
const repoDescription = payload?.getDescription("repository");
|
||||
expect(repoDescription).toBeDefined();
|
||||
expect(repoDescription?.length).toBeGreaterThan(0);
|
||||
|
||||
// sender should have a description
|
||||
const senderDescription = payload?.getDescription("sender");
|
||||
expect(senderDescription).toBeDefined();
|
||||
expect(senderDescription?.length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it("preserves childParamsGroups for nested property access", () => {
|
||||
// This test ensures bodyParameters[].childParamsGroups is not stripped
|
||||
// during JSON optimization. childParamsGroups defines nested properties
|
||||
// used for autocompletion like github.event.repository.owner.login
|
||||
const payload = getEventPayload("push", "default");
|
||||
expect(payload).toBeDefined();
|
||||
|
||||
// repository has nested properties like owner, license, etc.
|
||||
const repository = payload?.get("repository") as DescriptionDictionary | undefined;
|
||||
expect(repository).toBeDefined();
|
||||
|
||||
// repository.owner should exist (nested via childParamsGroups)
|
||||
const owner = repository?.get("owner") as DescriptionDictionary | undefined;
|
||||
expect(owner).toBeDefined();
|
||||
|
||||
// repository.owner.login should exist (deeply nested)
|
||||
const login = owner?.get("login");
|
||||
expect(login).toBeDefined();
|
||||
});
|
||||
|
||||
it("preserves name fields for property identification", () => {
|
||||
// This test ensures bodyParameters[].name is not stripped
|
||||
// during JSON optimization. The name field identifies each property.
|
||||
const payload = getEventPayload("issues", "opened");
|
||||
expect(payload).toBeDefined();
|
||||
|
||||
// Verify well-known property names exist
|
||||
expect(payload?.get("action")).toBeDefined();
|
||||
expect(payload?.get("issue")).toBeDefined();
|
||||
expect(payload?.get("repository")).toBeDefined();
|
||||
expect(payload?.get("sender")).toBeDefined();
|
||||
|
||||
// Verify nested property names work
|
||||
const issue = payload?.get("issue") as DescriptionDictionary | undefined;
|
||||
expect(issue?.get("title")).toBeDefined();
|
||||
expect(issue?.get("number")).toBeDefined();
|
||||
expect(issue?.get("user")).toBeDefined();
|
||||
});
|
||||
|
||||
it("returns undefined for unknown event", () => {
|
||||
const payload = getEventPayload("not_a_real_event", "default");
|
||||
expect(payload).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,10 +1,10 @@
|
||||
import {data, DescriptionDictionary} from "@actions/expressions";
|
||||
|
||||
import webhookObjects from "./objects.min.json";
|
||||
import webhooks from "./webhooks.min.json";
|
||||
import webhookObjects from "./objects.json";
|
||||
import webhooks from "./webhooks.json";
|
||||
|
||||
import schedule from "./schedule.min.json";
|
||||
import workflow_call from "./workflow_call.min.json";
|
||||
import schedule from "./schedule.json";
|
||||
import workflow_call from "./workflow_call.json";
|
||||
|
||||
const customEventPayloads: {[name: string]: unknown} = {
|
||||
schedule,
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
+1
-1
@@ -6,5 +6,5 @@
|
||||
"languageservice",
|
||||
"languageserver"
|
||||
],
|
||||
"version": "0.3.23"
|
||||
"version": "0.3.22"
|
||||
}
|
||||
Generated
+9
-9
@@ -135,7 +135,7 @@
|
||||
},
|
||||
"expressions": {
|
||||
"name": "@actions/expressions",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.0.3",
|
||||
@@ -395,11 +395,11 @@
|
||||
},
|
||||
"languageserver": {
|
||||
"name": "@actions/languageserver",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/languageservice": "^0.3.23",
|
||||
"@actions/workflow-parser": "^0.3.23",
|
||||
"@actions/languageservice": "^0.3.22",
|
||||
"@actions/workflow-parser": "^0.3.22",
|
||||
"@octokit/rest": "^21.1.1",
|
||||
"@octokit/types": "^9.0.0",
|
||||
"vscode-languageserver": "^8.0.2",
|
||||
@@ -921,11 +921,11 @@
|
||||
},
|
||||
"languageservice": {
|
||||
"name": "@actions/languageservice",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/expressions": "^0.3.23",
|
||||
"@actions/workflow-parser": "^0.3.23",
|
||||
"@actions/expressions": "^0.3.22",
|
||||
"@actions/workflow-parser": "^0.3.22",
|
||||
"vscode-languageserver-textdocument": "^1.0.7",
|
||||
"vscode-languageserver-types": "^3.17.2",
|
||||
"vscode-uri": "^3.0.8",
|
||||
@@ -12834,10 +12834,10 @@
|
||||
},
|
||||
"workflow-parser": {
|
||||
"name": "@actions/workflow-parser",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/expressions": "^0.3.23",
|
||||
"@actions/expressions": "^0.3.22",
|
||||
"cronstrue": "^2.21.0",
|
||||
"yaml": "^2.0.0-8"
|
||||
},
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
{
|
||||
"name": "actions-languageservices",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"workspaces": [
|
||||
"./expressions",
|
||||
"./workflow-parser",
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Minifies JSON files by removing whitespace.
|
||||
*
|
||||
* Usage: node script/minify-json.js <file1.json> <file2.json> ...
|
||||
*
|
||||
* For each input file, creates a corresponding .min.json file.
|
||||
* Example: src/data.json -> src/data.min.json
|
||||
*/
|
||||
|
||||
import {promises as fs} from "fs";
|
||||
import path from "path";
|
||||
|
||||
const files = process.argv.slice(2);
|
||||
|
||||
if (files.length === 0) {
|
||||
console.error("Usage: node script/minify-json.js <file1.json> <file2.json> ...");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
for (const file of files) {
|
||||
try {
|
||||
const content = await fs.readFile(file, "utf8");
|
||||
const data = JSON.parse(content);
|
||||
const minified = JSON.stringify(data);
|
||||
|
||||
// Replace .json with .min.json
|
||||
const ext = path.extname(file);
|
||||
const outputFile = file.slice(0, -ext.length) + ".min" + ext;
|
||||
|
||||
await fs.writeFile(outputFile, minified);
|
||||
|
||||
const originalSize = Buffer.byteLength(content, "utf8");
|
||||
const minifiedSize = Buffer.byteLength(minified, "utf8");
|
||||
const savings = ((1 - minifiedSize / originalSize) * 100).toFixed(1);
|
||||
|
||||
console.log(`${file} -> ${outputFile} (${savings}% smaller)`);
|
||||
} catch (err) {
|
||||
console.error(`Error processing ${file}:`, err);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@actions/workflow-parser",
|
||||
"version": "0.3.23",
|
||||
"version": "0.3.22",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
"source": "./src/index.ts",
|
||||
@@ -38,17 +38,14 @@
|
||||
"format-check": "prettier --check '**/*.ts'",
|
||||
"lint": "eslint 'src/**/*.ts'",
|
||||
"lint-fix": "eslint --fix 'src/**/*.ts'",
|
||||
"minify-json": "node ../script/minify-json.js src/workflow-v1.0.json",
|
||||
"prebuild": "npm run minify-json",
|
||||
"prepublishOnly": "npm run build && npm run test",
|
||||
"pretest": "npm run minify-json",
|
||||
"test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
|
||||
"test-xlang": "NODE_OPTIONS=\"--experimental-vm-modules\" jest --testPathPattern xlang",
|
||||
"test-watch": "NODE_OPTIONS=\"--experimental-vm-modules\" jest --watch",
|
||||
"watch": "tsc --build tsconfig.build.json --watch"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/expressions": "^0.3.23",
|
||||
"@actions/expressions": "^0.3.22",
|
||||
"cronstrue": "^2.21.0",
|
||||
"yaml": "^2.0.0-8"
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import {JSONObjectReader} from "../templates/json-object-reader";
|
||||
import {TemplateSchema} from "../templates/schema";
|
||||
import WorkflowSchema from "../workflow-v1.0.min.json";
|
||||
import WorkflowSchema from "../workflow-v1.0.json";
|
||||
|
||||
let schema: TemplateSchema;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user