UI for Azure Cosmos DB. Powers the Azure Portal, https://cosmos.azure.com/, and the Cosmos DB Emulator (Mirror of https://github.com/Azure/cosmos-explorer)
Go to file
Srinath Narayanan b4219e2994
Added Support for editing Mongo Indexing Policy from Settings tab (#284)
* 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
2020-10-26 14:17:40 -07:00
__mocks__ Clean up unused utility functions for creating databases and collections (#181) 2020-09-03 13:05:22 -07:00
.github Revert "Adds e2e tables test (#276)" (#292) 2020-10-20 12:02:50 -05:00
.vscode Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
configs Bundle config.json with published nugets (#64) 2020-06-30 13:49:14 -05:00
cypress Use edge instead of chrome for emulator e2e test (#178) 2020-09-02 12:01:32 -07:00
externals Remove jquery.contextMenu (#248) 2020-10-08 18:19:24 -05:00
fonts/segoe-ui/west-european/normal Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
images Remove enableGallery feature flag (#68) 2020-07-06 12:10:26 -07:00
less Added Support for editing Mongo Indexing Policy from Settings tab (#284) 2020-10-26 14:17:40 -07:00
quickstart Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
sampleData Move create collection to RP (#173) 2020-09-02 10:02:29 -07:00
src Added Support for editing Mongo Indexing Policy from Settings tab (#284) 2020-10-26 14:17:40 -07:00
strict-migration-tools Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
test Revert "Adds e2e tables test (#276)" (#292) 2020-10-20 12:02:50 -05:00
utils Create Cassandra Keyspace via ARM (#142) 2020-08-13 13:26:52 -05:00
.env.example Adds e2e baseline SQL test in puppeteer (#160) 2020-09-09 13:18:27 -04:00
.eslintignore Telemetry Adjustments (#182) 2020-09-08 12:44:46 -05:00
.eslintrc.js Adds mongo e2e spec (#207) 2020-09-30 16:42:33 -04:00
.gitignore Upload screenshot for runner failures (#72) 2020-07-02 09:58:36 -05:00
.npmrc Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
azure-pipelines.cg.yml Update azure-pipelines.cg.yml for Azure Pipelines 2020-10-15 16:20:38 -05:00
babel.config.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
CONTRIBUTING.md Add more files to strict compile. Update CONTRIBUTING.md (#63) 2020-07-06 17:16:24 +02:00
copyToConsumers.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
DataExplorer.nuspec Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
jest-puppeteer.config.js Fixes e2e test input focus swapping (#262) 2020-10-07 15:41:38 -04:00
jest.config.e2e.js Initial Portal Runner (#51) 2020-06-24 14:07:01 -05:00
jest.config.js Refresh Caches only in Portal (#129) 2020-08-05 15:54:17 -05:00
LICENSE Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
mockModule.js Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
package-lock.json Added Support for editing Mongo Indexing Policy from Settings tab (#284) 2020-10-26 14:17:40 -07:00
package.json Restore AppInsights fetch telemetry (#263) 2020-10-08 17:55:02 -05:00
README.md Update README.md (#255) 2020-10-08 15:57:38 -05:00
ReleaseNotes.md Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
tsconfig.contracts.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
tsconfig.json Upgrade to TypeScript 3.9 (#75) 2020-07-08 10:12:49 -05:00
tsconfig.strict.json Remove window.dataExplorerPlatform (#279) 2020-10-15 03:25:13 +00:00
tsconfig.test.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
tslint.json Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
web.config Initial Move from Azure DevOps to GitHub 2020-05-25 21:30:55 -05:00
webpack.config.js Turn off HMR (#147) 2020-08-12 20:12:31 -05:00

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:

  1. Expose these ports publicly: 8081, 8900, 8979, 10250, 10251, 10252, 10253, 10254, 10255, 10256

  2. Download and install the emulator: https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator

  3. 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.

  1. 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)
  2. Whitelist https://localhost:1234 domain for CORS in the Azure Cosmos DB portal
  3. Start the project in portal mode: PLATFORM=Portal npm run watch
  4. 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:

  1. Ensure the emulator is running
  2. Start cosmos explorer in emulator mode: PLATFORM=Emulator npm run watch
  3. Move into cypress/ folder: cd cypress
  4. Install dependencies: npm install
  5. 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:

  1. Copy .env.example to .env and fill in all variables
  2. 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.