chore: generate test connections COMPASS-7546 #25
Conversation
No it does not do that (import of the connections). I did not find any usage of our script within Compass codebase. Are we using it somewhere else? Or we just keep the script so that we can quickly import test connections in Compass? |
Super sorry, I think I'm not explaining clearly enough here what I'm asking about. What I mean is that this old script that we're removing was made for convenience of the engineers, not for some CI task or something. If you want to prepopulate your local Compass installation with connections instead of doing this manually, the script will do this for you with just one command, it will put all the files in correct place and you can start Compass and see your connections, all done from just compass monorepo, one step to do this, pretty cool and convenient. Now that we moved it to this repo, there are multiple steps spread across multiple repos and manual import in the application. I'm not saying this was exactly the old behavior, I'm just asking whether or not you think it's feasible to implement something that is as convenient as the old script was? All good if not easy to do, we can tackle it in the future |
I actually ended on your comment on another PR (related to this one) and that made things clear. It makes sense to add this. I'll be making this change. |
mabaasit
force-pushed
the
generate-test-connections
branch
from
6300ec7 to
4a1f42e
Compare
src/index.ts
Outdated
| connections.push({ | ||
| id: v4(), | ||
| favorite: { | ||
| name: variant, |
There was a problem hiding this comment.
We're using some internal Compass format here, would it be better if we instead have this on the Compass side? I did approve the removing of the test connections in mongodb-js/compass#5247 Looking at it more I'm thinking it could make more sense to have that script still in Compass and do this connection loading into Compass' format there instead of here.
The functionality Sergey mentioned of loading the test connections is a nice one for setting up on new environments.
There was a problem hiding this comment.
Yeah, agreed. However this came up in a slack conversation and we agreed to remove the script from Compass completely and have a set connections (json) in this repo, but I ended up creating a script.
I added another comment on the related PR in Compass (sorry the discussion is split across).
There was a problem hiding this comment.
We do have an public import connection file format, this is what is used by import-export-connections, so I'd just update the script to generate the file in this format so that you can then import it in compass (I kinda assumed that this is what this script is already generating, didn't notice that it's missing a few fields from the exported connections file)
mabaasit
force-pushed
the
generate-test-connections
branch
from
4a1f42e to
b38b1d6
Compare
Co-authored-by: Rhys <[email protected]>
| const path = require('path'); | ||
| const fs = require('fs/promises'); | ||
|
|
||
| const FILE_PATH = path.resolve(__dirname, '..', 'compass-connections.json'); |
There was a problem hiding this comment.
Small nit: we probably want to write this in the same folder where you ar running this from (or from an argument with this being a default, but this complicates things too much)
| const FILE_PATH = path.resolve(__dirname, '..', 'compass-connections.json'); | |
| const FILE_PATH = path.resolve(process.cwd(), 'compass-connections.json'); |
There was a problem hiding this comment.
missed this one. will add it.
As we removed import-test-connections script from Compass (in mongodb-js/compass#5247), we added this code here.