Add Node example validator by Aryex · Pull Request #253 · valkey-io/valkey-glide-docs

Aryex · 2026-06-21T23:14:33Z

Summary

This PR implement the Node example validator.

Issue link

#237

Content Changes

Added a new scripts/validators/node.py to validator Node examples.
Updated workflow to check C# and Node examples in a single workflow.
Fixed Node code examples found.
Moved csharp validator script into validator/ folder.

Implementation

Follows the implementation per #237.

currantw

Reviewed to ea8c3c6.

currantw · 2026-06-23T15:09:46Z


    // Retrieve statistics
-    const stats = await client.getStatistics();
+    const stats = await client.getStatistics() as Record<string, any>;


Hmmm. Why is this cast necessary? Are we not properly specifying the return type for getStatistics? 🤔

getStatistics return type is an Object so the example need to cast it to use the . notation.

currantw · 2026-06-23T15:19:24Z

+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:


workflow_dispatch isn't included in the corresponding C# workflow. Should we add it for consistency?

currantw · 2026-06-23T15:21:52Z

+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout valkey-glide-docs
+        uses: actions/checkout@v4


One of the security findings for the C# repo was that we should use commit hashes rather than version numbers, e.g.

uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

(As I understand it, a commit hash cannot be changed, but a malicious actor who was able to gain control of a repo could update the tag to point to a new commit and so download different code).

Are you able to raise an issue for this on the docs repo? Should be a very easy issue to fix with AI.

Created #261

currantw · 2026-06-23T15:26:51Z

+      - name: Checkout valkey-glide
+        uses: actions/checkout@v4
+        with:
+          repository: valkey-io/valkey-glide
+          path: valkey-glide


Would there be any advantages to doing a limited checkout of the few directories (e.g. node/, ffi/, and glide-core) that are actually needed for this job?

(The C# validator workflow doesn't checkout the valkey-glide submodule for same reason!)

We could restrict it but I don't think it would net us much improvements.

The main bottleneck currently is during the Node client build phase. It has to build the Rust layer and Node, essentially building the full client. The C# checker only has to build the C# layer so it doesn't need valkey-glide submodule, and is a lot quicker.

currantw · 2026-06-23T15:29:03Z

+      - name: Build Node client
+        working-directory: valkey-glide/node
+        run: |
+          npm ci
+          npm run build:release


In the C# example, we are able to skip building the Rust core because it actually isn't needed to validate the examples syntax. Are there any similar optimizations that we could perform here? I know that building the Rust core can be quite slow. What about installing all of the node modules?

Yup this is currently the biggest bottleneck here. Updating this to match C# would require a code change on Node side although I haven't looked at the scope of this.

currantw · 2026-06-23T15:58:27Z

+def _extract_examples() -> dict[str, str]:
+    """Extract TypeScript/JS code blocks from all MDX files."""
+    examples: dict[str, str] = {}


Some more documentation of the return type (similar to what exists in the current C# script) might be useful, I think.

Moved to _common.py and updated docstring.

See 244a629

currantw · 2026-06-23T15:59:09Z

+_DEFAULT_IMPORTS = (
+    "GlideClient, GlideClusterClient, GlideClientConfiguration, "
+    "GlideClusterClientConfiguration, Batch, ClusterBatch, BatchOptions, "
+    "ClusterBatchOptions, ClusterBatchRetryStrategy, Script, Transaction, "
+    "Routes, Logger, RequestError, ServerCredentials, GlideFt, "
+    "GlideJson, OpenTelemetry, ClientSideCache, EvictionPolicy, TimeUnit, "
+    "Field, FtSearchOptions, FtSearchReturnType, Decoder, "
+    "AdvancedGlideClusterClientConfiguration, CompressionBackend, "
+    "OpenTelemetryConfig, OpenTelemetryMetricsConfig, OpenTelemetryTracesConfig, "
+    "ClusterScanCursor, ReadFrom, GlideString, PubSubMsg, ALL_CHANNELS, ALL_PATTERNS"
+)


Why are these grouped into multi-entry strings like this?

It is a formatted form from a single line import.

currantw · 2026-06-23T16:01:05Z

+        line = lines[i]
+        if _IMPORT_LINE.match(line):
+            import_lines = [line]
+            while not re.search(r"""from\s+["'][^"']+["']\s*;?\s*$""", line) and i + 1 < len(lines):


Perhaps we should extract this regex? Otherwise, I think it might re-compile on each pass through the loop (not sure whether a typical Python interpreter would optimize this?)

Extracted. See 0761d6a

currantw · 2026-06-23T16:05:33Z

+    for imp in imports:
+        m = re.search(r"\{([^}]+)\}", imp)
+        if m:
+            for name in m.group(1).split(","):
+                existing_names.add(name.strip())
+    defaults = [
+        n.strip() for n in _DEFAULT_IMPORTS.split(",")
+        if n.strip() not in existing_names
+    ]
+    if defaults:
+        parts.append(f"import {{ {', '.join(defaults)} }} from \"@valkey/valkey-glide\";\n")


It's not completely clear to me how the logic in here works, or what the re.search call is doing. Maybe some comments would be useful?

Refactored in 8a7a4fb.

We are trying to build the import statement, but have to take care and remove duplicated imports as it counts as errors for tsc.

currantw · 2026-06-23T16:18:27Z

+            if source:
+                result[source] = msgs


Under what circumstances would this not be part of the dict?

Removed. See 7ac52e6

Signed-off-by: Alex Le <alex.le@improving.com>

Aryex force-pushed the alexl/node-ex-validator branch 3 times, most recently from fce337b to f5069c5 Compare June 22, 2026 16:40

Aryex marked this pull request as ready for review June 22, 2026 21:26

Aryex requested a review from currantw June 22, 2026 21:26

Aryex force-pushed the alexl/node-ex-validator branch 2 times, most recently from db2cc54 to ea8c3c6 Compare June 22, 2026 21:46

Aryex changed the title ~~Implemented Node example validator~~ Add Node example validator Jun 22, 2026

currantw assigned Aryex Jun 23, 2026

currantw added documentation Improvements or additions to documentation nodejs ci/cd labels Jun 23, 2026

currantw reviewed Jun 23, 2026

View reviewed changes

Aryex mentioned this pull request Jun 23, 2026

ci: port docs example compilation check to all client languages #243

Closed

7 tasks

Aryex added 4 commits June 29, 2026 09:24

docs: added docs on circuit breaker

0979fd7

Signed-off-by: Alex Le <alex.le@improving.com>

addressed comments

8c50af8

Signed-off-by: Alex Le <alex.le@improving.com>

fixed typo

d401df7

Signed-off-by: Alex Le <alex.le@improving.com>

fixed typo

8b2b0d4

Signed-off-by: Alex Le <alex.le@improving.com>

Aryex mentioned this pull request Jul 1, 2026

Pin GitHub Actions to commit hashes instead of version tags #261

Open

Aryex added 9 commits July 1, 2026 17:06

Implemented Node example validator

b52e90e

Signed-off-by: Alex Le <alex.le@improving.com>

Fixed examples

810f371

Signed-off-by: Alex Le <alex.le@improving.com>

Use separate workflows

062a72d

Signed-off-by: Alex Le <alex.le@improving.com>

renamed and moved validator scripts

29c542a

Signed-off-by: Alex Le <alex.le@improving.com>

fix: added workflow_dispatch to c# validator

255b9b1

Signed-off-by: Alex Le <alex.le@improving.com>

added common.py with extract_all()

244a629

Signed-off-by: Alex Le <alex.le@improving.com>

refactored node example validator

0761d6a

Signed-off-by: Alex Le <alex.le@improving.com>

refactored _wrap_snippet

8a7a4fb

Signed-off-by: Alex Le <alex.le@improving.com>

removed validate check

7ac52e6

Signed-off-by: Alex Le <alex.le@improving.com>

Aryex force-pushed the alexl/node-ex-validator branch from ea8c3c6 to 7ac52e6 Compare July 2, 2026 00:07

fixed node code example

04cbc86

Signed-off-by: Alex Le <alex.le@improving.com>

Aryex added 3 commits July 1, 2026 17:58

Changed to node-index instead

17eb384

Signed-off-by: Alex Le <alex.le@improving.com>

added readme

934eb20

Signed-off-by: Alex Le <alex.le@improving.com>

cleanup Readme

2dda231

Signed-off-by: Alex Le <alex.le@improving.com>

Aryex force-pushed the main branch from f8fa3df to ccdef10 Compare July 15, 2026 19:13

Uh oh!

Conversation

Aryex commented Jun 21, 2026 • edited by currantw Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Issue link

Content Changes

Implementation

Uh oh!

currantw 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aryex Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Aryex Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Aryex Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aryex Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aryex Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Aryex commented Jun 21, 2026 •

edited by currantw

Loading

Aryex Jun 23, 2026 •

edited

Loading

Aryex Jul 1, 2026 •

edited

Loading

Aryex Jul 1, 2026 •

edited

Loading

Aryex Jul 2, 2026 •

edited

Loading

Aryex Jul 2, 2026 •

edited

Loading