understanding-sources

elbwalker 的头像作者 elbwalker

适用于处理源、理解事件捕获或学习推送接口时使用。涵盖浏览器、dataLayer和服务器源模式。

📖 中文导读:适用于处理源、理解事件捕获或学习推送接口时使用。涵盖浏览器、dataLayer和服务器源模式。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: understanding-sources description: Use when working with sources, understanding event capture, or learning about the push interface. Covers browser, dataLayer, and server source patterns.

Understanding walkerOS Sources

Overview

Sources capture events from the external world (browser DOM, dataLayer, HTTP requests, cloud functions) and feed them to the collector.

Core principle: Sources capture. They don't process or deliver—that's collector and destinations.

Source Interface

See packages/core/src/types/source.ts for canonical interface.

Init Function (Context Pattern)

Sources use a context-based initialization pattern:

import type { Source } from '@walkeros/core';

export const sourceMySource: Source.Init<Types> = async (context) => {
  const { config = {}, env, logger, id } = context;
  // ...
};

Context contains:

Property Type Purpose
config Source.Config<T> Settings, mapping, options
env Types['env'] Environment (push, logger)
logger Logger Logging functions
id string Source identifier
collector Collector.Instance Reference to collector

Push Method

Method Purpose
push(input) Receive external input, emit events

Push Signatures by Type

Source Type Signature Example
Cloud Function push(req, res) → Promise<void> HTTP handler
Browser push(event, data) → Promise<void> DOM events
DataLayer push(event, data) → Promise<void> GTM-style

Key insight: Source push IS the handler. No wrappers needed.

// Direct deployment
http('handler', source.push);

Source Paths

Type Path Examples
Web packages/web/sources/ browser, dataLayer
Server packages/server/sources/ gcp

Browser Source

The browser source captures events from DOM using data attributes.

<button data-elb="product" data-elb-product="id:P123;name:Laptop">
  <span data-elbaction="click">Add to Cart</span>
</button>

See packages/web/sources/browser/ for implementation.

DataLayer Source

Captures events from a GTM-style dataLayer array.

window.dataLayer.push({
  event: 'product view',
  product: { id: 'P123', name: 'Laptop' },
});

See packages/web/sources/dataLayer/ for implementation.

Server Sources

Handle HTTP requests in cloud functions. Server sources use the context pattern:

import type { Source } from '@walkeros/core';

export const sourceCloudFunction: Source.Init<Types> = async (context) => {
  const { config = {}, env } = context;
  const { push: envPush } = env;

  // Validate settings with Zod schema
  const settings = SettingsSchema.parse(config.settings || {});

  const push = async (req: Request, res: Response): Promise<void> => {
    // Transform HTTP request → walkerOS event
    const event = transformRequest(req);
    await envPush(event);
    res.json({ success: true });
  };

  return { type: 'cloudfunction', config: { ...config, settings }, push };
};

// Direct deployment
export const handler = source.push;

See packages/server/sources/gcp/ for implementation.

Transformer Wiring

Sources can wire to pre-collector transformer chains via the next property:

sources: {
  browser: {
    code: sourceBrowser,
    next: 'validate'  // First transformer to run after this source
  }
}

The transformer chain runs before events reach the collector. See understanding-transformers for chain details.

Skills:

Source Files:

Package READMEs:

Documentation: