-
Notifications
You must be signed in to change notification settings - Fork 837
Add root-level GLV examples and fix existing example issues #3218
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 3.7-dev
Are you sure you want to change the base?
Add root-level GLV examples and fix existing example issues #3218
Conversation
GLV Examples Fixes: - Fix Go WriteBufferSize=0 causing E1201 buffer errors and nil pointer crashes - Fix Node.js v22+ WebSocket API incompatibility with conditional .on() method usage - Resolve Python dependency conflicts preventing example builds - Configure all examples to consistently use local development code - Add comprehensive documentation with prerequisites and build steps Root-level Examples: - Create glv-examples/ directory with examples for all 5 GLVs using published drivers (3.7.4) - Add comprehensive README with server setup and usage instructions - Update main documentation to reference root-level examples for users - Update release process documentation to include version update requirements - Add developer documentation explaining dual example structure Provides reliable GLV examples for development and out-of-the-box examples for new users while maintaining separation between local and published versions.
5f7f8d5
to
3c8b784
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 3.7-dev #3218 +/- ##
=============================================
+ Coverage 76.14% 76.23% +0.09%
- Complexity 13152 13307 +155
=============================================
Files 1084 1092 +8
Lines 65160 67657 +2497
Branches 7285 7378 +93
=============================================
+ Hits 49616 51581 +1965
- Misses 12839 13335 +496
- Partials 2705 2741 +36 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Remove incorrect claim about build execution of GLV examples - Move GLV examples section from build commands list to dedicated section
6604f36
to
7c2f8a9
Compare
Thanks @kirill-stepanishin, the changes LGTM. VOTE +1 |
glv-examples/README.md
Outdated
|
||
### Java | ||
```bash | ||
cd gremlin-java |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be gremlin-driver
for consistency with the module package name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is a fair point, I'm not sure. Module package name is gremlin-driver
, but the documentation lists it as gremlin-java
along the other gremlin variants and drivers https://tinkerpop.apache.org/docs/current/reference/#gremlin-java
The package-lock.json file in gremlin-javascript/examples/ directory was orphaned with no corresponding package.json file and no dependencies. The actual package.json files are in the browser/ and node/ subdirectories.
Added explanation that root-level GLV examples use published drivers for out-of-the-box usage, while module-level examples use local code.
407e156
to
b509b0f
Compare
b509b0f
to
d44ee51
Compare
Summary
This PR improves GLV examples reliability and adds user-friendly root-level examples that work out-of-the-box with published drivers.
This is a follow-up to PR #3213 which fixed GLV examples reliability issues but required switching examples to local code so that fixes could be applied immediately. However, that approach meant new users had to build TinkerPop from source to run examples. This PR addresses that limitation by adding a separate set of root-level examples using published drivers.
Issues Fixed
GLV Examples Reliability (from PR #3213):
User Experience (New):
Changes Made
GLV Examples Fixes (from PR #3213):
Root-Level Examples (New):
glv-examples/
directory with examples for all 5 GLVs using published drivers (3.7.4)Approach
gremlin-*/examples/
): Use local development code for contributors and testingglv-examples/
): Use published drivers for end users, manually updated during releasesKnown Limitations
Credits
JavaScript WebSocket compatibility fix originally contributed by @xhuberty in PR #3204.