New Components - philips_hue #16456
New Components - philips_hue #16456
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
WalkthroughThis update introduces a comprehensive Philips Hue integration, adding new actions and polling sources for the Hue API v2. The Philips Hue app component is expanded with dynamic property definitions and resource methods for lights, groups, scenes, and sensors. Three new actions—turning lights on, setting light color, and activating scenes—are implemented, each supporting both individual lights and groups. Three new event sources are added to emit events on light state changes, scene activations, and sensor updates, with robust state management and deduplication. Supporting base modules and test event fixtures are also included, and the package version is incremented. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PD_Component as Philips Hue Component
participant HueAPI as Philips Hue API
User->>PD_Component: Configure action/source (select light/group/scene/sensor)
PD_Component->>HueAPI: Authenticate and fetch options (e.g., list lights/scenes)
User->>PD_Component: Trigger action or polling interval fires
alt Action: Turn Light On / Set Color / Activate Scene
PD_Component->>HueAPI: Send API request (PUT) to update light/group/scene
HueAPI-->>PD_Component: Response (success/failure)
PD_Component-->>User: Return result/summary
else Source: Polling Event (light state, scene, sensor)
PD_Component->>HueAPI: Fetch current state(s)
PD_Component->>PD_Component: Compare with previous state
alt State Changed/Update Detected
PD_Component-->>User: Emit event with summary/meta
PD_Component->>PD_Component: Update stored state
end
end
Assessment against linked issues
Suggested labels
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
components/philips_hue/actions/activate-scene/activate-scene.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/philips_hue/actions/set-light-color/set-light-color.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/philips_hue/actions/turn-light-on/turn-light-on.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Nitpick comments (14)
components/philips_hue/actions/set-light-color/set-light-color.mjs (4)
39-43: Add hex color format validationConsider adding validation for the hex color format to avoid potential errors in the color conversion process.
color: { type: "string", label: "Color", description: "A hexidecimal color value to set the light(s) to. E.g. `#800080`", + pattern: "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", + errorMessage: "Please enter a valid hexadecimal color (e.g., #800080)", },
42-42: Fix typo in descriptionThere's a typo in the description: "hexidecimal" should be "hexadecimal".
- description: "A hexidecimal color value to set the light(s) to. E.g. `#800080`", + description: "A hexadecimal color value to set the light(s) to. E.g. `#800080`",
46-55: Add error handling for color conversionThe color conversion could fail if an invalid hex color is provided. Consider adding try/catch to handle potential errors.
hexToCIE(hex) { + try { + // Remove '#' if present + const hexColor = hex.startsWith('#') ? hex.substring(1) : hex; - const rgb = convert.hex.rgb(hex); + const rgb = convert.hex.rgb(hexColor); const xyz = convert.rgb.xyz(rgb); const x = xyz[0] / (xyz[0] + xyz[1] + xyz[2]); const y = xyz[1] / (xyz[0] + xyz[1] + xyz[2]); return { x, y, }; + } catch (error) { + throw new ConfigurationError(`Invalid hex color format: ${hex}. Please provide a valid hex color (e.g., #800080).`); + } },
8-8: Specify API version in descriptionUpdate the description to explicitly mention that this action uses the Hue API v2.
- description: "Sets the light color of a Philips Hue light. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)", + description: "Sets the light color of a Philips Hue light using API v2. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)",components/philips_hue/sources/new-scene-activated/test-event.mjs (2)
89-89: Update future timestamp in test eventThe test event contains a timestamp set in the future (2025-04-25). Consider using a past or present date for more realistic testing.
- "last_recall": "2025-04-25T17:06:00.896Z" + "last_recall": "2023-04-25T17:06:00.896Z"
1-92: Enhance test coverage with more action typesConsider adding examples of other action types (like xy color coordinates or hue/saturation) to provide more comprehensive test coverage for different scene types.
components/philips_hue/actions/turn-light-on/turn-light-on.mjs (3)
5-7: Consider renaming for claritySince this action can both turn lights on and off, consider renaming it to something more descriptive like "Toggle Light" or "Control Light Power".
- key: "philips_hue-turn-light-on", - name: "Turn Light On", - description: "Turns on or off a Philips Hue light or group of lights. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)", + key: "philips_hue-control-light-power", + name: "Control Light Power", + description: "Turns on or off a Philips Hue light or group of lights using API v2. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)",
70-73: Improve summary formattingThe summary message formatting breaks across multiple lines, which reduces readability. Consider reformatting to keep it on a single line.
- $.export("$summary", `Successfully turned ${this.turnLightOff - ? "off" - : "on"} light(s)`); + $.export("$summary", `Successfully turned ${this.turnLightOff ? "off" : "on"} light(s)`);
45-74: Add error handling for API responsesConsider adding specific error handling for API failures to provide clearer error messages to users.
async run({ $ }) { if ((!this.lightId && !this.groupId) || (this.lightId && this.groupId)) { throw new ConfigurationError("Must specify exactly one of Light ID or GroupID"); } const opts = { $, username: this.username, data: { on: { on: !this.turnLightOff, }, }, }; + try { const response = this.lightId ? await this.philipsHue.updateLight({ lightId: this.lightId, ...opts, }) : await this.philipsHue.updateGroup({ groupId: this.groupId, ...opts, }); $.export("$summary", `Successfully turned ${this.turnLightOff ? "off" : "on"} light(s)`); return response; + } catch (error) { + throw new Error(`Failed to control light power: ${error.message}`); + } },components/philips_hue/actions/activate-scene/activate-scene.mjs (1)
1-8: Documentation URL doesn't match the action type.The description points to the light API reference, but this is a scene activation action.
key: "philips_hue-activate-scene", name: "Activate Scene", - description: "Activates a Philips Hue light scene. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)", + description: "Activates a Philips Hue light scene. [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_scene__id__put)", version: "0.0.1", type: "action",components/philips_hue/sources/common/base.mjs (1)
32-39: Enhance event ID generation for better uniqueness.The current ID generation combines item.id with timestamp, which could potentially cause collisions if multiple items are processed in the same millisecond.
generateMeta(item) { const ts = Date.now(); + // Using a random component to further ensure uniqueness + const randomSuffix = Math.random().toString(36).substring(2, 10); return { - id: `${item.id}${ts}`, + id: `${item.id}_${ts}_${randomSuffix}`, summary: this.getSummary(item), ts, }; },components/philips_hue/sources/new-sensor-update/new-sensor-update.mjs (1)
46-55: Edge-case: string-typed empty props may bypass the “exactly one” validation
deploy()currently counts onlyundefinedvalues, so a prop supplied as an empty string ("") will still be considered “defined”, causingdefinedCountto be1and letting the deployment succeed with an invalid ID.
A quick tweak makes the intent explicit:-].filter((x) => x !== undefined).length; +].filter(Boolean).length; // filters out: undefined, null, "", 0, falseThis prevents mis-configuration at deploy time.
components/philips_hue/philips_hue.app.mjs (2)
32-37: Expose readable labels for groups (consistency with lights & scenes)
lightIdandsceneIdoption loaders return{ label, value }, butgroupId,motionId, etc. return plain strings.
Returning objects with labels greatly improves the UI in the Pipedream step-builder.return data?.map(({ id, metadata }) => ({ - id + label: metadata?.name || id, + value: id, })) || [];Applying this pattern across all option loaders keeps the UX consistent.
90-107: Minor:$default parameter shadows the framework-supplied$_makeRequest({ $ = this, path, username, … })Using
$as a parameter here shadows the special$object that Pipedream injects with logging & fetch helpers. While it works, it can confuse readers and makes the method signature harder to grasp.Consider renaming to
pdor simply removing the default and passingthisexplicitly where needed.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (11)
components/philips_hue/actions/activate-scene/activate-scene.mjs(1 hunks)components/philips_hue/actions/set-light-color/set-light-color.mjs(1 hunks)components/philips_hue/actions/turn-light-on/turn-light-on.mjs(1 hunks)components/philips_hue/package.json(2 hunks)components/philips_hue/philips_hue.app.mjs(1 hunks)components/philips_hue/sources/common/base.mjs(1 hunks)components/philips_hue/sources/new-light-state/new-light-state.mjs(1 hunks)components/philips_hue/sources/new-light-state/test-event.mjs(1 hunks)components/philips_hue/sources/new-scene-activated/new-scene-activated.mjs(1 hunks)components/philips_hue/sources/new-scene-activated/test-event.mjs(1 hunks)components/philips_hue/sources/new-sensor-update/new-sensor-update.mjs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Publish TypeScript components
- GitHub Check: pnpm publish
- GitHub Check: Verify TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (13)
components/philips_hue/package.json (1)
3-3: Version updates look appropriateThe minor version increment (0.6.0 → 0.7.0) properly reflects the addition of new Philips Hue integration features, and the platform dependency update ensures compatibility with the latest Pipedream platform.
Also applies to: 16-16
components/philips_hue/actions/set-light-color/set-light-color.mjs (1)
1-92: Overall implementation looks solidThe action has a good structure and correctly handles the color conversion from hex to CIE coordinates. The validation to ensure exactly one target (light or group) is provided is a good practice.
components/philips_hue/sources/new-scene-activated/test-event.mjs (1)
1-92: Test event structure looks comprehensiveThe test event provides a good representation of a scene activation event with detailed properties for actions, palette, metadata, and status.
components/philips_hue/actions/turn-light-on/turn-light-on.mjs (1)
1-75: Implementation looks clean and effectiveThe action correctly handles both turning lights on and off, with appropriate validation for target selection (light or group).
components/philips_hue/sources/new-light-state/new-light-state.mjs (4)
1-4: Clean imports and good organization.The imports are well-structured, pulling in the common base module, platform error handling, and test event sample. This promotes maintainability and code reuse.
5-12: Component metadata is well-defined.The metadata provides clear identification and description of the component's purpose with appropriate documentation link. Starting with version 0.0.1 is appropriate for a new component, and "dedupe: unique" ensures no duplicate events.
13-35: Props structure allows flexible configuration.The props extend the common base and properly set up two optional properties (lightId and groupId) with dynamic dependency handling based on username. This flexibility allows users to monitor either individual lights or groups.
36-42: Good validation in deploy hook.The deploy hook ensures exactly one of lightId or groupId is provided, preventing invalid configurations.
components/philips_hue/actions/activate-scene/activate-scene.mjs (1)
9-26: Props are well structured with clean dependencies.The properties are logically organized, with the scene ID dynamically dependent on the username property. This ensures proper data loading and validation.
components/philips_hue/sources/common/base.mjs (3)
1-20: Well-structured base component with essential properties.The base component defines common properties needed across Philips Hue sources, including the app interface, database access, timer configuration with sensible defaults, and username authentication.
22-27: Simple and effective data persistence methods.The methods for getting and setting previous data are straightforward and work well for state management across polling intervals.
40-44: Good base method pattern requiring implementation.The getSummary method with an error throw ensures that derived components must implement this method, which is a good pattern for enforcing contract requirements.
components/philips_hue/sources/new-light-state/test-event.mjs (1)
1-169: Comprehensive sample data for light state testing.The test event provides detailed and realistic sample data, covering all aspects of a Philips Hue light state including identification, metadata, on/off status, dimming capabilities, color properties, effects, and power-up behavior. This ensures thorough testing of the event source component.
components/philips_hue/sources/new-scene-activated/new-scene-activated.mjs
Show resolved
Hide resolved
Resolves #15146
@vunguyenhung
usernamein the components, but it would probably be better to place that in$auth.new-sensor-update).