Implement shared ID in window.__keyborg for refs dictionary#101
Draft
Copilot wants to merge 2 commits into
Draft
Implement shared ID in window.__keyborg for refs dictionary#101Copilot wants to merge 2 commits into
Copilot wants to merge 2 commits into
Conversation
Co-authored-by: mathis-m <11584315+mathis-m@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update Keyborg refs dictionary to use shared ID
Implement shared ID in window.__keyborg for refs dictionary
May 23, 2025
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.
Problem
The
refsdictionary inwindow.__keyborgwas not using a shared ID system, leading to potential ID conflicts when multiple bundles of the library are loaded on the same page. This could cause reference management issues where one bundle might overwrite or conflict with references created by another bundle.Solution
This PR implements a shared ID system by:
lastIdproperty to theWindowWithKeyborginterface to track the last used IDKeyborgconstructor to:lastIdif it doesn't exist in the window objectrefsdictionary is properly initializedlastIdfromwindow.__keyborgwhen creating new instancesKeyborgCoreconstructor to also use the sharedlastIdTesting
The code has been thoroughly tested to ensure:
refsdictionaryImplementation Details
The implementation maintains backward compatibility by checking if properties exist before using them, and initializing them with appropriate values if they don't exist.
Before this fix, each bundle maintained its own ID counter (
_lastId). Now, all bundles share a global ID counter stored inwindow.__keyborg.lastId, ensuring consistent and unique IDs across all bundles.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.