Conversation
Co-authored-by: xingfan-git <50465320+xingfan-git@users.noreply.github.com>
Co-authored-by: xingfan-git <50465320+xingfan-git@users.noreply.github.com>
- Copy documentBuffer.ts from sample PR, excluding cosmos-related code - Update ClustersClient.ts InsertDocumentsResult and insertDocuments method - Update importDocuments.ts with buffering logic following sample PR - Rename insertDocumentIntoCluster to insertDocumentWithBufferIntoCluster - Update l10n bundle with new error message Co-authored-by: xingfan-git <50465320+xingfan-git@users.noreply.github.com>
…-documentdb into copilot/fix-130
…t/vscode-documentdb into dev/tnaum/migration-api
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…rovider` interface
…eeds improvements in the future
# Conflicts: # .github/workflows/api-extractor.yaml
…e for plugins as we're still in the experimental phase
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR releases version v0.2.2 of the DocumentDB for VS Code extension with major updates in the migration framework, URL connection handling, and improved import performance while also including documentation and workflow improvements.
- Introduces an experimental migration framework and API enhancements for provider-based migrations.
- Adds deep-link URL handling for direct connection navigation and updates several documentation files.
- Updates CI/CD workflows for API publishing and refines linting rules.
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/release-notes/0.2.2.md | New release notes detailing key features of v0.2.2. |
| docs/release-notes/0.2.1.md | Added release notes for v0.2.1. |
| docs/manual/index.md | New manual index page linking to URL construction documentation. |
| docs/manual/how-to-construct-url.md | Comprehensive documentation on constructing deep-link URLs. |
| docs/learn-more/index.md | Updated TOC including a new experimental Data Migrations section. |
| docs/learn-more/data-migrations.md | New documentation on data migration concepts and workflow. |
| docs/index.md | Updated Table of Contents for documentation. |
| api/tsconfig.json | Added TypeScript configuration for the API project. |
| api/src/utils/getApi.ts | Implements API retrieval with version checking and whitelisting. |
| api/src/migration/migrationProvider.ts | Defines interfaces for migration providers. |
| api/src/migration/migrationApi.ts | Defines migration API interface for provider registration. |
| api/src/migration/index.ts | Re-exports migration API and provider interfaces. |
| api/src/index.ts | Main entry point for the API package re-exporting public APIs. |
| api/src/extensionApi.ts | Defines the DocumentDB extension API interface. |
| api/package.json | New package manifest for the API project. |
| api/api-extractor.json | Configuration file for API extraction and declaration generation. |
| api/README.md | Detailed API usage documentation including migration provider examples. |
| CHANGELOG.md | Updated changelog detailing new features and fixes for v0.2.2. |
| .github/workflows/api-publish.yaml | Revised CI workflow for publishing the API package. |
| .eslintignore | Updated linting ignore rules for the repository and API subproject. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant updates to the DocumentDB extension API, including a new experimental migration framework, enhancements to the publishing workflow, and documentation updates. The changes focus on enabling advanced data migration scenarios, improving API usability, and refining the development process for the extension.
API Enhancements:
DocumentDBExtensionApiinterface, providing a structured API for extension interactions, including migration-related functionality (api/src/extensionApi.ts,api/src/index.ts,api/src/migration/index.ts, [1] [2] [3].MigrationApiinterface to support registering migration providers (api/src/migration/migrationApi.ts, api/src/migration/migrationApi.tsR1-R18).MigrationProviderinterface, enabling extensible provider-based migrations with authentication and customizable actions (api/src/migration/migrationProvider.ts, api/src/migration/migrationProvider.tsR1-R112).getDocumentDBExtensionApiutility function for retrieving the API, including experimental safeguards and client whitelisting (api/src/utils/getApi.ts, api/src/utils/getApi.tsR1-R93).Workflow Improvements:
.github/workflows/api-publish.yamlfile to automate the API package publishing process, including dependency installation, npm cache restoration, and package publishing (.github/workflows/api-publish.yaml, .github/workflows/api-publish.yamlL17-R50).Documentation Updates:
api/README.mdto provide detailed guidance on API usage, including migration provider implementation, authentication support, and workflow steps (api/README.md, api/README.mdR1-R231).CHANGELOG.mdwith new features, improvements, and bug fixes for version 0.2.2, including data migration preview support and connection URL handling (CHANGELOG.md, F7e138d5R1).Configuration Additions:
api/api-extractor.jsonto configure API extraction and TypeScript declaration file generation (api/api-extractor.json, api/api-extractor.jsonR1-R21).api/package.jsonwith scripts for building, cleaning, compiling, and publishing the API package, along with dependency definitions (api/package.json, api/package.jsonR1-R35).Miscellaneous:
.eslintignoreto exclude additional directories and files from linting (.eslintignore, .eslintignoreR2-R7).