b4219e2994
* added SettingsV2 Tab * lint changes * foxed failing test * Addressed PR comments - removed dangerouslySetInnerHtml - removed underscore dependency - added AccessibleElement - removed unnecesary exceptions to linting * split render into separate functions - removed sinon in test - Added some enums to replace constant strings - removed dangerously set inner html - made autopilot input as StatefulValue * add settingscomponent snapshot * fixed linting errors * fixed errors * addressed PR comments - Moved StatefulValue to new class - Split render to more functions for throughputInputComponents * Added sub components - Added tests for SettingsRenderUtls - Added empty test files for adding tests later * Moved all inputs to fluent UI - removed rupm - added reusable styles * Added Tabs - Added ToolTipLabel component - Removed toggleables for individual components - Removed accessible elements - Added IndexingPolicyComponent * Added more tests * Addressed PR comments * Moved Label radio buttons to choicegroup * fixed lint errors * Removed StatefulValue - Moved conflict res tab to the end - Added styling for autpilot radiobuttons * fixed linting errors * fix bugs from merge to master * fixed formatting issue * Addressed PR comments - Added unit tests for smaller methods within each component * fixed linting errors * removed redundant snapshots * removed empty line * made separate props objects for subcomponents * Moved dirty checks to sub components * Made indesing policy component height = 80% of view port - modified auto pilot v3 messages - Added Fluent UI tolltip - * Moved warning messages inline * moved conflict res helpers out * fixed bugs * added stack style for message * fixed tests * Added tests * fixed linting and format errors * undid changes * more edits * fixed compile errors * fixed compile errors * fixed errors * fixed bug with save and discard buttons * fixed compile errors * added MongoIndexingPolicy component * addressed PR comments * moved read indexes to scale context * added add index feature * added AddMongoIndexComponent * Added collapsible portions and focus changes * removed unnecessary imports * finetuned UI * more edits * Added mongoindexeditor flight - Moved add index UI to within current index pane * minro edits * Added separate warning messages for index refresh * aligned items * Fixed tests * minor edits * resolved PR comments * modified refs usage * compile errors fixed * moved fetch of notifications and offer to within the tab activation * fixed PR comments * added error handling * added AAD verification * removed l empty line * added back line * deleted file * added file * addressed PR comments * addressed PR comments * fixed format error * updated package.json * updated package-lock.json |
||
---|---|---|
__mocks__ | ||
.github | ||
.vscode | ||
configs | ||
cypress | ||
externals | ||
fonts/segoe-ui/west-european/normal | ||
images | ||
less | ||
quickstart | ||
sampleData | ||
src | ||
strict-migration-tools | ||
test | ||
utils | ||
.env.example | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.npmrc | ||
azure-pipelines.cg.yml | ||
babel.config.js | ||
CONTRIBUTING.md | ||
copyToConsumers.js | ||
DataExplorer.nuspec | ||
jest-puppeteer.config.js | ||
jest.config.e2e.js | ||
jest.config.js | ||
LICENSE | ||
mockModule.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
ReleaseNotes.md | ||
tsconfig.contracts.json | ||
tsconfig.json | ||
tsconfig.strict.json | ||
tsconfig.test.json | ||
tslint.json | ||
web.config | ||
webpack.config.js |
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 run watch
to start the development server and automatically rebuild on changes
Specifying Development Platform
Setting the environment variable PLATFORM
during the build process will force the explorer to load the specified platform. By default in development it will run in Hosted
mode. Valid options:
- Hosted
- Emulator
- Portal
PLATFORM=Emulator npm run watch
Hosted Development
The default webpack dev server configuration will proxy requests to the production portal backend: https://main.documentdb.ext.azure.com
. This will allow you to use production connection strings on your local machine.
To run pure hosted mode, in webpack.config.js
change index HtmlWebpackPlugin to use hostedExplorer.html and change entry for index to use HostedExplorer.ts.
Emulator Development
In a window environment, running npm run build
will automatically copy the built files from /dist
over to the default emulator install paths. In a non-windows enironment you can specify an alternate endpoint using EMULATOR_ENDPOINT
and webpack dev server will proxy requests for you.
PLATFORM=Emulator EMULATOR_ENDPOINT=https://my-vm.azure.com:8081 npm run watch
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
The Cosmos Portal that consumes this repo is not currently open source. If you have access to this project, npm run build
will copy the built files over to the portal where they will be loaded by the portal development environment
You can however load a local running instance of data explorer in the production portal.
- Turn off browser SSL validation for localhost: chrome://flags/#allow-insecure-localhost OR Install valid SSL certs for localhost (on IE, follow these instructions to install the localhost certificate in the right place)
- Whitelist
https://localhost:1234
domain for CORS in the Azure Cosmos DB portal - Start the project in portal mode:
PLATFORM=Portal npm run watch
- Load the portal using the following link: https://ms.portal.azure.com/?dataExplorerSource=https%3A%2F%2Flocalhost%3A1234%2Fexplorer.html
Live reload will occur, but data explorer will not properly integrate again with the parent iframe. You will have to manually reload the page.
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
Cypress is used for end to end tests and are contained in cypress/
. Currently, it operates as sub project with its own typescript config and dependencies. It also only operates against the emulator. To run cypress tests:
- Ensure the emulator is running
- Start cosmos explorer in emulator mode:
PLATFORM=Emulator npm run watch
- Move into
cypress/
folder:cd cypress
- Install dependencies:
npm install
- Run cypress headless(
npm run test
) or in interactive mode(npm run test:debug
)
End to End Production Runners
Jest and Puppeteer are used for end to end production runners and are contained in test/
. To run these tests locally:
- Copy .env.example to .env and fill in all variables
- Run
npm run test:e2e
Releasing
We generally adhear 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.
Contributing
Please read the contribution guidelines.