docs: clarify makeMessage is a v1-only helper - #332
Open
cabljac wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the JSDoc documentation for the makeMessage helper functions in src/providers/pubsub.ts. It adds notes clarifying that these helpers are intended exclusively for v1 functions.pubsub.topic(...).onPublish functions and should not be used with wrapV2 for v2 onMessagePublished functions, providing examples of how to handle v2 functions instead. I have no feedback to provide as there are no review comments.
IzaakGough
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
makeMessagebuilds a v1pubsub.Message, but nothing in its docs says so, and passing its result towrapV2fails in a confusing way: the v2 mock factory reads the message'sjsongetter, which eagerly runsJSON.parse(base64Decode(data))and throws on non-JSON payloads before the handler runs (see #235 for the full diagnosis).This adds jsdoc to both
makeMessageoverloads marking the helper as v1-only and showing the CloudEvent-partial patterns to use withwrapV2instead:Docs-only change, no runtime behavior affected.
Fixes #235