808faa9fa5
* Force useMongoProxyEndpoint to always return true if valid endpoint provided. Enables new Mongo proxy in all environments. * Checking MP endpoint in config context. * Enabling cassandra proxy in all environments. Requires later cleanup. * Simplifying and removing endpoint validation since run when config context is generated. * Enabling one MP API at a time globally. * Revent to existing CP selection logic. * Creating list of globally enable CP apis. * Add list of mongo and cassandra APIs to config and only enable if environment outside existing list of environments. * Remove environment checks. If API globally enabled, return true. * Adding config initialization for mongo unit tests. * Default to empty enable list to minimize possible impact. Config.json overrides can be used for testing. |
||
---|---|---|
.devcontainer | ||
.github | ||
.vs | ||
.vscode | ||
__mocks__ | ||
configs | ||
docs | ||
externals | ||
fonts/segoe-ui/west-european/normal | ||
images | ||
jest | ||
less | ||
patches | ||
preview | ||
quickstart | ||
sampleData | ||
src | ||
strict-null-checks | ||
test | ||
utils | ||
.editorconfig | ||
.env.example | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.npmrc | ||
CODING_GUIDELINES.md | ||
CONTRIBUTING.md | ||
DataExplorer.nuspec | ||
LICENSE | ||
README.md | ||
ReleaseNotes.md | ||
SECURITY.md | ||
azure-pipelines.cg.yml | ||
babel.config.js | ||
copyToConsumers.js | ||
jest.config.js | ||
mockModule.js | ||
package-lock.json | ||
package.json | ||
playwright.config.ts | ||
tsconfig.contracts.json | ||
tsconfig.json | ||
tsconfig.strict.json | ||
tsconfig.test.json | ||
web.config | ||
webpack.config.js |
README.md
Cosmos DB Explorer
UI for Azure Cosmos DB. Powers the Azure Portal, https://cosmos.azure.com/, and the Cosmos DB Emulator
Getting Started
npm install
npm run build
Developing
Watch mode
Run npm start
to start the development server and automatically rebuild on changes
Hosted Development (https://cosmos.azure.com)
- Visit:
https://localhost:1234/hostedExplorer.html
- The default webpack dev server configuration will proxy requests to the production portal backend:
https://cdb-ms-mpac-pbe.cosmos.azure.com
. This will allow you to use production connection strings on your local machine.
Emulator Development
- Start the Cosmos Emulator
- Visit: https://localhost:1234/index.html
Setting up a Remote Emulator
The Cosmos emulator currently only runs in Windows environments. You can still develop on a non-Windows machine by setting up an emulator on a windows box and exposing its ports publicly:
-
Expose these ports publicly: 8081, 8900, 8979, 10250, 10251, 10252, 10253, 10254, 10255, 10256
-
Download and install the emulator: https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator
-
Start the emulator from PowerShell:
> cd C:/
> .\CosmosDB.Emulator.exe -AllowNetworkAccess -Key="<EMULATOR MASTER KEY>"
Portal Development
- Visit: https://ms.portal.azure.com/?dataExplorerSource=https%3A%2F%2Flocalhost%3A1234%2Fexplorer.html
- You may have to manually visit https://localhost:1234/explorer.html first and click through any SSL certificate warnings
Testing
Unit Tests
Unit tests are located adjacent to the code under test and run with Jest:
npm run test
End to End CI Tests
Jest and Puppeteer are used for end to end browser based tests and are contained in test/
. To run these tests locally:
- Copy .env.example to .env
- Update the values in .env including your local data explorer endpoint (ask a teammate/codeowner for help with .env values)
- Make sure all packages are installed
npm install
- Run the server
npm run start
and wait for it to start - Run
npm run test:e2e
Releasing
We generally adhere to the release strategy documented by the Azure SDK Guidelines. Most releases should happen from the master branch. If master contains commits that cannot be released, you may create a release from a release/
or hotfix/
branch. See linked documentation for more details.
Architecture
Contributing
Please read the contribution guidelines.