Skip to content
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

Remove configFile URL param support #724

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

kmcginnes
Copy link
Collaborator

@kmcginnes kmcginnes commented Dec 13, 2024

Description

Removes support for an obscure and undocumented way of loading an initial connection.

To use the feature a user must:

  1. Create a valid connection JSON file by exporting from an existing Graph Explorer instance or hand crafting the JSON
  2. Put the JSON file in the Graph Explorer source code so it is hosted by the server
  3. Launch the Graph Explorer site using the correct param:
    http://localhost:5173/?configFile=connection.json

If those steps are followed then the database will be initialized with the connection data inside the file.

However, if any connections already exist this logic will be skipped. So it is only useful for setting up a brand new user of Graph Explorer.

This process is undocumented and is tedious to set up. There are better approaches to configuring initial connections for new users. So my theory is that this feature was initially created for the original developers to test out new browsers or to quickly setup their test environment after wiping their local database.

Validation

  • Verified the feature works, but I have no idea how it was intended to work
  • Verified that removing the feature does not break other default connection logic

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0
    license.
  • I have run pnpm checks to ensure code compiles and meets standards.
  • I have run pnpm test to check if all tests are passing.
  • I have covered new added functionality with unit tests if necessary.
  • I have added an entry in the Changelog.md.

@kmcginnes kmcginnes force-pushed the remove-configfile-param branch from eb3faaf to 93f2ea3 Compare December 13, 2024 00:02
@kmcginnes kmcginnes marked this pull request as ready for review December 13, 2024 00:03
@kmcginnes kmcginnes force-pushed the remove-configfile-param branch from 93f2ea3 to b6ae34c Compare December 14, 2024 17:28
@kmcginnes
Copy link
Collaborator Author

Updated to fix conflicts

@kmcginnes kmcginnes merged commit ea271ad into aws:main Dec 17, 2024
1 check passed
@kmcginnes kmcginnes deleted the remove-configfile-param branch December 17, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task] Remove configFile URL param support
2 participants