Docs snippets tests by techwritermat · Pull Request #538 · pubnub/javascript

techwritermat · 2026-11-04T11:27:20Z

No description provided.

pubnub-snyk-universal-prd · 2026-11-04T11:27:36Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

- Added a new test to verify occupant visibility through channel groups in presence.ts, addressing potential timing issues in CI. - Refactored exitWhenIdle function in cli.ts to provide clearer error messages when the event loop remains busy, and introduced a new describeHandles function to detail active handles and resources.

…tions - Updated the exitWhenIdle function in cli.ts to provide clearer warnings when only timers are keeping the event loop busy. - Added unref() calls in wait.ts to ensure abandoned timers do not prevent process exit after tests complete.

The presence fixture now waits until each channel group (cg1, my_channel_group) and the ch1 plus cg1 combination list the occupant. A group read resolves the group's member channels first and can lag the per-channel reads, which made hereNowBasicUsage fail in CI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Five steps read back what the docs sample just wrote, from another client, in one shot. App Context reads lag behind writes, and on the fast CI runner setMembershipBasicUsage read an empty list. The same assertions now run inside eventually(). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

- Introduced a new script `snippet-summary.cjs` to generate a Markdown summary of snippet results per ID for GitHub Actions. - Updated `package.json` to include a new command for running the summary script. - Modified GitHub Actions workflows to utilize the new summary script and adjusted checkout actions for consistency. - Enhanced error handling in `mocha-entry.ts` to ensure all keysets are processed, even if some fail. This improves visibility into snippet test results and ensures comprehensive reporting in CI runs.

- Revised multiple snippets and README entries to specify that React and React Native sources cannot be run in this repository due to the absence of necessary dependencies. - Adjusted comments and documentation to reflect that the snippets are retained for documentation purposes only and are type-checked but not executed. - Enhanced clarity in various files regarding the environment setup and execution context for the snippets. This improves the accuracy of documentation and helps users understand the limitations of running certain snippets.

parfeon

Mostly looks good.

parfeon · 2026-11-05T13:27:16Z

+      live: ${{ steps.diff.outputs.live }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4


this is brutal. We actually can at least trust official GitHub account to deliver stable products.
Current checkout is v7

parfeon · 2026-11-05T14:27:58Z

+      # of its own role only. The janitor step after them needs every role, so it keeps all of them.
+      - name: Shard open
+        id: open
+        if: success() || failure()


so, we will still run this step event previous setup steps failed? Does it really make sense?

I needed it for testing as one of the tests was flaky and it never ran my code snippets check. Now it runs only when the build step succeeded and the run wasn't cancelled

parfeon · 2026-11-05T14:52:34Z

+    setPresenceState();
+  }, []);
+
+  return <div>User with presence state</div>;


Should it show progress as it has been shown with react-subscribe.jsx?

parfeon · 2026-11-05T15:10:48Z

+const channel = pubnub.channel('hello_world');
+const subscription = channel.subscription();


Should we show it in the following way:

Suggested change

const channel = pubnub.channel('hello_world');

const subscription = channel.subscription();

const subscription = pubnub.channel('hello_world').subscription();

parfeon · 2026-11-05T15:12:37Z

+<head>
+  <meta charset="utf-8" />
+  <title>PubNub quickstart</title>
+  <script src="https://cdn.pubnub.com/sdk/javascript/pubnub.13.1.3.js"></script>


This could become invalid really soon.
Version bumping available through the release process but it requires modification in this file.

Good catch. The release process now updates the CDN version in quickstart-web.html along with .pubnub.yml, package.json and README.md, like you suggested.

I also fixed two stale 9.6.0 references in the shared worker sample, the comment and the worker URL. The same release config updates them.

@ts-expect-error

Review fixes (PR 538): - Workflow: checkout moves to v7. Shards run only after a successful build. Keep-report steps run after a cancel too. The janitor runs only after a build, so nothing is revoked for a run that never started. - react-subscribe.jsx: the subscribed text shows only after the client reports PNConnectedCategory or PNSubscriptionChangedCategory, through pubnub.addListener (the subscription object has no onStatus). - react-set-state.jsx: shows "Setting state..." until setState resolves. - quickstart-web.ts and .html: one chained line for the subscription. Policy: every skip fails the run. The budget, the allowed list, REQUIRE_FEATURES and STRICT are gone, and so are the browser and React Native stub steps that could never run here. Not changed, open: the published declarations (lib/types) lack subscriptionWorkerUrl and declare toFile(): Promise<void>. The web source does not. The hidden @ts-expect-error lines stay until the published declarations are fixed.

- Updated the version in browser-shared-worker.ts from v9.6.0 to v13.1.3 to reflect the latest SDK version. - Added new version patterns for quickstart-web.html and browser-shared-worker.ts in versions.json to enhance version matching capabilities. This ensures that the documentation snippets are aligned with the current SDK version and improves version management in the documentation.

- Updated the presence test to include a polling mechanism that waits for the channel group member to appear in the results after the fixture joins. - This change addresses timing issues in CI where the group member may not be immediately listed, ensuring more reliable test outcomes. This improvement enhances the robustness of the presence tests by accommodating potential delays in member visibility.

- Implemented a retry logic for the joiner subscription to handle potential delays or losses in join events. The joiner will attempt to re-subscribe up to two times if the initial join event is not received. - This enhancement ensures that lost joins are recorded and visible in the report, improving the reliability of the subscription process. This change addresses issues with join event delivery and enhances the robustness of the subscribe legacy API.

parfeon

LGTM!

The snippet files are test fixtures for the docs. Their code is not product code, and Codacy reports on them as issues.

Docs snippets tests

3d87be5

techwritermat requested review from jguz-pubnub, kazydek, mohitpubnub and parfeon as code owners November 4, 2026 11:27

techwritermat and others added 4 commits November 4, 2026 12:40

techwritermat mentioned this pull request Nov 5, 2026

ci: remove the cross-workflow cancel from Tests and Validations #539

Merged

techwritermat and others added 3 commits November 5, 2026 09:41

Merge branch 'master' into docs-snippets-live-tests

0a7cb2b

parfeon approved these changes Nov 5, 2026

View reviewed changes

techwritermat added 2 commits November 6, 2026 07:06

techwritermat force-pushed the docs-snippets-live-tests branch from 32e31a4 to db0f637 Compare November 6, 2026 07:49

techwritermat added 2 commits November 6, 2026 09:06

parfeon self-requested a review November 6, 2026 09:18

parfeon approved these changes Nov 6, 2026

View reviewed changes

Exclude docs-snippets from Codacy analysis

f042a61

The snippet files are test fixtures for the docs. Their code is not product code, and Codacy reports on them as issues.

techwritermat merged commit 2ec1761 into master Nov 6, 2026
23 of 37 checks passed

techwritermat deleted the docs-snippets-live-tests branch November 6, 2026 10:55

		const channel = pubnub.channel('hello_world');
		const subscription = channel.subscription();

	const channel = pubnub.channel('hello_world');
	const subscription = channel.subscription();
	const subscription = pubnub.channel('hello_world').subscription();

Conversation

techwritermat commented Nov 4, 2026

Uh oh!

pubnub-snyk-universal-prd Bot commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

parfeon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

parfeon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pubnub-snyk-universal-prd Bot commented Nov 4, 2026 •

edited

Loading