Salesforce Event Subscriber

Real-time Salesforce Platform Events, Change Data Capture (CDC), and streaming API monitoring directly in VS Code.

🎯 Overview

The Salesforce Event Subscriber is a Visual Studio Code extension that allows you to manage and interact with Salesforce platform events and streaming APIs directly from your workspace. This tool is designed to increase efficiency and streamline the development process when working with Salesforce real-time events.

✨ What's New in v0.1.2

• 🔄 Event Replay: Track and replay events from specific ReplayIds
• 🧪 Automated Testing: 53 comprehensive unit tests ensuring reliability
• 🔒 Security Updates: Upgraded to jsforce 3.10.8 with zero vulnerabilities
• 📊 Enhanced Metadata: Better discoverability with improved categories and keywords
• 🐛 Bug Fixes: Fixed workspace state serialization issues

🚀 Features

This extension provides an interface within VS Code to:

1. Auto-Connect to Salesforce: Automatically detects the default org in your workspace
2. Subscribe to Events: Subscribe and unsubscribe from Platform Events, CDC, and streaming topics
3. Event Replay: Track ReplayIds and replay missed events from the last 72 hours
4. Real-time Monitoring: View event data in real-time using VS Code's Output Channel
5. Multiple Subscriptions: Manage multiple event subscriptions simultaneously
6. Persistent State: Remember your subscriptions and last ReplayIds across VS Code sessions
7. Pretty-printed Output: JSON event data formatted for easy reading

Supported Event Types

• ✅ Platform Events: /event/EventName__e
• ✅ Change Data Capture (CDC): /data/ChangeEventName
• ✅ Streaming Topics: /topic/TopicName
• ✅ Generic Streaming: Any Salesforce streaming channel

📦 Installation

From VS Code Marketplace

1. Open Visual Studio Code
2. Press Ctrl+P (or Cmd+P on Mac) to open the Quick Open dialog
3. Type ext install nagendra080389.event-subscriber
4. Click Install

From Source

1. Clone this repository
2. Run npm install
3. Run npm run compile
4. Press F5 to launch the extension in debug mode

📋 Requirements

• Visual Studio Code v1.78.0 or higher
• Salesforce CLI (sf or sfdx)
• Authenticated Salesforce Org with streaming API access
• Salesforce DX Project (with .sfdx/sfdx-config.json)

🎮 Usage

Connecting to Salesforce Org

After installing the extension, the Salesforce Event Subscriber panel appears in the Activity Bar. Expand the Org's Data tree to view your connected Salesforce org information:

• Access Token (hidden by default)
• API Version
• Connected Status
• Org ID
• Instance URL
• Username

Managing Event Subscriptions

Add a Channel

1. Click the "+" icon in the Channel List panel
2. Enter the full channel path:
   • Platform Event: /event/MyEvent__e
   • CDC: /data/AccountChangeEvent
   • Topic: /topic/MyTopic
3. Click on the channel name to subscribe

View Event Messages

1. Right-click on a subscribed channel
2. Select "Show Output Channel"
3. Real-time events appear in a dedicated output channel

Replay Events from ReplayId

1. Right-click on a subscribed channel
2. Select "Replay from ReplayId"
3. Enter a ReplayId:
   • -1: Latest events (default)
   • -2: All stored events (past 72 hours)
   • Specific number: Replay from that ReplayId

Delete a Subscription

1. Right-click on a channel
2. Click the delete icon or select "Delete"
3. Confirm to unsubscribe and remove

Commands

The extension provides the following commands:

🔄 Event Replay Feature

The extension automatically tracks the ReplayId of every received event. This allows you to:

• Resume after disconnection: Pick up where you left off
• Debug past events: Replay events from the last 72 hours
• Test event handlers: Re-run events without triggering them again

ReplayId Display: Each channel shows its last ReplayId in the tree view:

/event/OrderEvent__e (Last: 12345678)

How to Use:

1. Right-click on any channel → "Replay from ReplayId"
2. Choose:
   • Use the pre-filled last ReplayId
   • Enter -1 for latest events
   • Enter -2 for all stored events
   • Enter a specific ReplayId number

🛠️ Configuration

Multi-threaded CLI Execution (Optional)

Enable multi-threaded execution of Salesforce CLI commands:

{
  "vsCodeStreamingSubscriber.enableMultithread": true
}

Note: This is experimental and disabled by default.

🧪 Development & Testing

This extension includes comprehensive automated tests:

# Install dependencies
npm install

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Compile TypeScript
npm run compile

# Watch mode for development
npm run watch

Test Coverage: 53 unit tests covering all core modules with Jest.

🐛 Known Issues

• Large Event Volumes: Very high-frequency events may cause UI lag. Use filtering (planned feature) for better performance.

If you discover bugs or have feature requests, please open an issue on GitHub.

🗺️ Roadmap

Planned features for future releases:

• 🔍 Event Filtering: Filter events by JSON path expressions
• 📊 Analytics Dashboard: Event metrics and visualizations
• 🌐 Multi-Org Support: Switch between multiple Salesforce orgs
• 🤖 AI-Powered Features: Anomaly detection and smart suggestions
• 🔌 Pub/Sub API Support: Modern Salesforce streaming with gRPC

See our full improvement plan for details.

📚 Additional Documentation

• Usage Guide - Detailed usage instructions
• Changelog - Version history and updates

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

Nagendra Singh

• Email: nagendra080389@gmail.com
• GitHub: @Nagendra080389

⚠️ Disclaimer

This extension is not an official Salesforce product. It is an independent tool created to streamline Salesforce streaming API development in VS Code.

🎥 Demo

Built with ❤️ for the Salesforce Developer Community