stitch-sdk-bug-bash
Original:🇺🇸 English
Translated
Find bugs in the Stitch SDK using a real API key. Covers standard functional edges and tricky situations.
2installs
Added on
NPX Install
npx skill4agent add google-labs-code/stitch-sdk stitch-sdk-bug-bashTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Stitch SDK Bug Bash
This skill provides a framework and instructions for finding bugs in the Stitch SDK using a real API key. It guides you through exploring standard functional edge cases and tricky situations beyond the golden path.
The Mindset: Adversarial Exploration
When using this skill, do not just verify that the SDK works. Try to break it!
- Pass invalid or boundary parameters.
- Attempt operations on deleted or stale handles.
- Simulate unexpected API responses if possible or find edge cases where projection might fail.
Surface Areas to Cover
1. Root & Initialization (Stitch
)
Stitch- Zero Config: Verify the singleton works without explicit config if is present.
STITCH_API_KEY - Invalid Config: Pass an empty API key or invalid base URL to and verify that the first call fails with a clear authentication or connection error, not a generic noise error.
StitchToolClient
2. Project Lifecycle (Project
)
Project- Handle Creation: Verify that does not throw (lazy instantiation) but the first call on it fails safely.
stitch.project('invalid-id') - Factory vs API: Verify that creating a project handle via the factory doesn't trigger API calls, but methods like do.
project.listScreens()
3. Screen Lifecycle (Screen
)
Screen- The Handover: Verify that properties from are correctly populated on the returned
Project.generate()instances without a second fetch.Screen - Null Safety in Projections: Test tools or scenarios that return empty arrays or missing optional fields. Verify that the SDK handle handles them as or empty arrays rather than crashing on null property access!
undefined
4. Design System (DesignSystem
)
DesignSystem- Application: Create a design system, and apply it to a list of screens. Verify that if the list is empty or invalid, the SDK fails cleanly!
- Handles: Verify that correctly receives the
project.designSystem('ds-id')and injects it into calls likeprojectId.ds.apply(...)
Tricky Situations Matrix (Standard Functional Edges)
| Scenario | What to try | Expected Behavior |
|---|---|---|
| Stale Handles | Create a screen, delete the project, then try to edit the screen handle. | Clean API error indicating resource not found, wrapped in |
| Empty Prompts | Call | Safe rejection or clear API error, no crash in codegen. |
| Projections on null | Force an API call that returns a response without the expected projection field (if you can simulate or find such a tool fallback case). | The SDK should use optional chaining (e.g., |
| Massive arrays | Pass hundreds of screen IDs to | Check if it hits payload limits gracefully or fails with a clear message. |
Diagnostic Hygiene
- Always wrap your test calls in .
try/catch - Log the error and inspect or
error.codeto see if it's aerror.nameor a generic raw error.StitchError - If an execution throws a raw or "cannot read property of undefined", that is a HIGH PRIORITY BUG in the SDK's projection logic!
TypeError
Test Template: The Full Workflow Bash
Use this template to run a quick end-to-end bash session.
typescript
import { stitch } from "@google/stitch-sdk";
async function bash() {
const apiKey = process.env.STITCH_API_KEY;
if (!apiKey) throw new Error("STITCH_API_KEY is required");
console.log("🚀 Starting Bug Bash...");
let project;
try {
// 1. Create a fresh project
project = await stitch.createProject({
displayName: `Bug Bash ${new Date().toISOString()}`
});
console.log(`✓ Created Project: ${project.id}`);
// 2. Try to break generate with empty prompt
try {
await project.generate({ prompt: "" });
console.log("✗ BUG: Generate with empty prompt should have failed!");
} catch (e) {
console.log("✓ Generate with empty prompt failed safely as expected.");
}
// 3. Create a design system
const ds = await project.createDesignSystem({
name: "Bash Style",
variables: { primaryColor: "#ff0000" }
});
console.log(`✓ Created Design System: ${ds.id}`);
// 4. List screens (should be empty)
const screens = await project.listScreens();
console.log(`✓ Listed screens: found ${screens.length}`);
// 5. Apply design system to empty list
try {
await ds.apply({ selectedScreenIds: [] });
console.log("✓ Applied design system to empty list (handled).");
} catch (e) {
console.log("✗ Did applying to empty list fail? Inspect error.");
}
} catch (error) {
console.error("💥 Bash failed with error:", error);
} finally {
// 6. Cleanup
if (project) {
console.log(`🧹 Cleaning up project ${project.id}...`);
// Assuming we have a deleteProject binding or we just leave it if not available
// await project.delete();
}
}
}
bash();