Граф коммитов

40 Коммитов

Автор SHA1 Сообщение Дата
Luke Bordonaro 78158c2120
Add documentation for column variants (#380)
* Checkpoint

* Checkpoint

* Checkpoint

* Typo

* Fix awkward sentence

* Rename Time (UTC)

* Whitespace

* Grammar

* Wording

* CHeckpoint

* Add engine docs

* Edits

* Add global varaints example code

* Fix glossary TOC

* Fix glossary TOC again

* Wording

* Add ASCII diagrams

* Address comments

* Typos

* Remove runtime section
2024-10-30 16:40:16 -07:00
Luke Bordonaro 951ebe4f60
Doc Suggestions (#372)
* small fixes and suggestions to make docs more clear

* Add note instead of code sample

---------

Co-authored-by: Karthik Sesham <t-ksesham@microsoft.com>
Co-authored-by: Karthik Sesham <98133619+karthik-sesham@users.noreply.github.com>
2024-10-17 12:55:11 -07:00
Luke Bordonaro ea450d1a19
Add docs for data source grouping (#367)
* Add docs for data source grouping

* Update index

* Fix emoji

* Grammar

* Fix typo
2024-10-17 11:53:49 -07:00
lcjh 98bea7d6de
fix url of markdown (#362)
Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2024-10-16 15:31:55 -07:00
Luke Bordonaro 7da00b7bd9
Update docs for choosing SDK version guidance (#358)
* Update docs for choosing SDK version guidance

* Spelling

* Update Choosing-SDK-Version.md
2024-05-01 14:03:56 -07:00
helenkzhang 336bca857f
Add template plugin manifest (#323)
* Add documentation for manifest file and add default manifest template

* Remove comment

* Update id naming pattern
2023-09-14 11:31:25 -07:00
helenkzhang ab49926ec5
Add Plugin CLI Tool (#317)
* Add CLI

* Add push

* Update assembly name

* Add json schema doc

* Add components doc

* Add CLI doc

* Fix doc

* Fix doc 2

* wip

* Fix metadata generator

* Update package extension to .ptix

* Remove old projeact

* Delete and untrack launchsettings.json

* Print errors

* Update extension name to ptix

* Require Id and Version

* Put cli and publisher into a folder and don't interfere with plugins system versioning

* Add manifest schema

* Exclude schema folder

* Update plugin project template

* Update metadata gen

* Clean up metadata generation

* Fix schema comma

* Add manifest schema validation

* Validate using data annotations

* Update pack

* Pack as dotnet tool

* Change publisher location

* Resolve conflicts

* Fix contents metadata

* Remove version from schema

* Add manifestVersion to required

* Move package stuff to its own project

* Fix issues in cli

* Update plugin template

* Undo change in .gitignore

* Untrack launchSettings.json

* Update to use json validation

* Update schema location

* Add "bundled manifest" option

* Fix shouldinclude

* Update template

* Update plugin template

* Rename template

* Fix path issues

* Revert changes in templates and samples

* Remove publisher project

* Remove added files in samples

* Remove schema folder

* Remove schema md doc

* Add comments in validator

* Update source directory validation to check SDK

* Refactor options classes

* Handles destination overwrites

* Undo package change

* Remove package folder

* Undo change in ZipPluginPackage

* Add schama loader

* Clean up program.cs

* Add common options

* Add args validation and exception types

* Clean ups

* Add eof new lines and copy rights

* Remove .md files

* Remove unwanted files

* Remove generated xml

* Clean up constants.cs

* Use classes for each options instead of service locator

* Fix property name

* Separate options validation

* Decoupled commands and console

* Updated error handling

* Clean up

* Add manifest locators

* Address comments for utils method

* Move options validation to separate classes

* Address more comments

* Added base command

* Update protected to private

* Decorate with NotNullWhen

* Add docstrings

* Remove empty lines and fix warning

* Update package name and tool name

* Update helptext and add basic documentation

* Continue processing if BadImageFormatException is encountered during the scan

* Adrress more comments

* Use VersionChecker to access sdk versions

* Track all versions that have been checked and log version check errors

* Update logging based on pr comments
2023-09-06 14:01:32 -07:00
helenkzhang 28ec6bba09
Add Plugins System Core and Runtime (#263)
* Add Plugin Metadata (#228)

* Add  plugin manager core project

* Add packaging metadata and test

* Add target platforms and update supported data sources

* Clean up

* Clean up doc strings

* More clean ups

* Update .editorconfig

* Update namespace

* Add authors

* Seal

* Update test code

* Remove .editorconfig

* Remove camel case

* Remove architecture and add IsMetadatatTable

* Address comments

* Remove group and upate test

* Add data cookers and extensible tables

* Add glossary.md

* Plugin Discovery (#229)

* Add plugin discovery APIs

* Update discovery and add downloader

* Add nuget implementation

* Clean up

* Update plugins manager to handle generic

* Clean up

* Change PluginInfo to a class and remove downloader interface

* Refactor discoverey orchestration

* Add doc strings and clean up

* Add new line

* Fix name and constructer

* Add glossary.md

* Add diagram

* Add alternative design

* Remove PluginInfo, update AvailablePlugin and InstalledPlugin

* Remove fetcher factory

* Add docstrings and clean up

* Add more docstrings

* Update solution file

* Remove documentation

* Added nuget implementations for new design

* Add NuGetPluginDiscoverer creation

* Update IsSupported to async

* Add TODOs

* Added todo

* Remove initial design

* Update namespaces

* Update folder names

* Copyrights

* Add resource guid to identify resource from an AvailablePlugin (#253)

* Add resource guid to identify resource from an AvailablePlugin

* Remove .editorconfig

* Refactor AvailablePlugin

* Fix NuGet discoverer provider

* Handle duplicates differently and addressed pr comments

* Not throw exceptions when there are duplicates

* Rename resource repository

* Fix results union bug

* Fix constructor para names (#260)

* Plugins Installation (#239)

* Update  metadata docstrings and add processing source guid in data cooker metadata

* Checkpoint

* Add installation APIs

* Add lock file apis

* Add supports for getting installed plugin metadata

* Implements lock

* Add progress to package extraction

* Implements verify installed

* Checks for installation and refactor synchronized object

* Add hash method

* Add hash in InstalledPlugin

* Add obsolete plugin files clean up

* Remove tests csproj

* Add TODO

* Move InstalledPlugin to Installation

* Add plugin package docstrings

* Tag todos with issue

* Address comment

* Update installer to use new AvailablePlugin

* Fix name

* Add awaits

* Address checksum comments

* Get rid of update plugin

* Deserialize metadata on getting installed plugins

* Clean ups

* Downgrade system.text.json to 7.0.0 (#261)

* Update project names (#262)

* Update project names and dirs

* Update namespaces

* Fix one namespace in runtime

* Do not read PluginMetadata json stream multiple times. (#264)

* Do not read PluginMetadata json stream multiple times.

* Use JsonSerializer.DeserializeAsync instead of document

* Remove unused variable

* Add runtime project (#265)

* Add runtime

* Add folders

* Add tests projects

* Remove global usings

* Fix path

* Override GetHashCode and fix docstrings (#266)

* Add support for plugins manager resources reflection and loading (#267)

* Add logger in PluginsManager

* Add plugin manager resource reference class

* Add resource loader implementation with refactorings

* Plugins Manager Error Handling and Logging (#268)

* Remove public setters in plugin metadata

* Move PluginPackage to runtime and  add serilazation class

* Remove unused parameter

* Add logger params

* Move serialization to core

* Add error handling in plugin registry

* Change LoadaAdditionalPluginResources return type

* Add more error handling in PluginRegistry

* Error handlings in PluginInstaller

* Add more custom exceptions for installation

* Update return type of get all installed plugins to a result class

* Add set loggers

* Clean up

* Plugin fetcher exception

* Disable loading additional resources for now

* Add error handlings for discovering APIs

* Add error handlings for adding plugin sources

* Update PluginsPackage

* Update PluginsManager

* Update exception types

* Add doctrings in plugin registry

* Add docstrings in PluginInstaller

* More docstrings

* Address PR comments

* Update docstrings to use fine-grained exeception types

* Update to use SetLogger instead of passing as parameter

* Add error notifying events for plugin source

* Update InstalledPluginResult

* Only catch Json and IO execeptions

* Add remarks

* Update to use ErrorInfo for plugin source error event args

* Address comments

* Update to use FileDistributedLock for plugin registry locking (#269)

* Update to use FileDistributedLock for plugin registry locking

* Fix doc string

* Clean up plugin registry class

* Add cancellations in plugin registry (#270)

* Add cancellation in plugin registry

* Remove progress from uninstallation

* Remove progress from uninstallation

* Rename PluginManagerResource to PluginsManagerResource

* Change parameter name from source to pluginSource

* Remove nuget

* Remove credentials from core

* Add IPluginRegistry and ISynchronizedObject

* Remove nuget from solution file

* Update discovery helper classes to internal types

* Clean up and fix white spaces

* Remove unnecessary stuff in discovery runtime

* SAdd async in method name

* Fix typo

* Make PluginSource an IEquatable

* Make AvailablePluginInfo equatable

* Fix AddPluginSources

* Add async in method names

* Update MD5 to SHA256

* Add comment

* Add TODO in reflector

* Add issue in TODOs

* Formatting

* Remove tests (will be in another PR)

* Minor refactor of plugins manager (#272)

* Remove usings

* Add ISerializer

* Add IRepository

* Update exceptions types

* Update serialization utils

* Fix docstrings

* Add IPluginInstaller

* Update PluginsManager

* Update PluginPackage

* Address feedback - use type param

* TId to TIdentifier

* Move all changes to be under Toolkit.Plugins (#273)

* Create ProcessingSourceInfo for plugins manager

* Move plugins manager errorcodes to its own class

* Move hashutils to plugins.core

* Move PluginsManagerResourceRerference to Plugins.Runtime

* Fix metadata null reference (#277)

* Remove installer APIs from IPluginsManager (#279)

* Remove installer APIs from plugins manager and just make it a facade of IPluginsInstaller

* Change installer class name

* Docstrings

* Update CI pipeline to build feature/pluginManager

* Refactor IPluginsManager to a composition-based PluginsSystem  (#280)

* Set installation root dir as a property in the installer

* Remove installtionDir from pluginsManager

* wip

* Remove DiscovererSourcesManager

* Move all discovery to new class

* Refactor out discovery and fetching from plugins manager

* Comment out fetching logic in AvailablePlugin

* Fix typo

* Revert fetching part

* Interface name change IKeyedRepository

* Add PluginsSystem

* Remove installPath from InstalledPluginInfo

* Remove IPuginsManager and use PluginSystem

* Synchronize plugin discoverer

* Update construtors

* Remove plugin sources from IPluginsDisoverer

* Add a loader interface for resources that cobimes reflected resources and directly added resources

* Plugins System cleanup (#283)

* Rename to PluginsSystem in Core

* Rename in Exceptions

* Clean up discovery

* Update resources management

* Remove manager folder

* Clean up installation and registry

* Change folder name

* Fix project reference

* Update version files so that PluginsSystem will be on its own version (#285)

* Exclude PluginsSystem from bumping main version and and a new version file for plugins

* Update plugins version to 0.1-preview

* Add unit tests for PluginSourceRepository (#284)

* Add unit tests for PluginSourceRepository

* Add return values in IRepository APIs

* Update tests by combining test cases and using dynamic data

* Add null checks in plugin source repo apis

* Address feedback

* Refactor PluginPackage (#286)

* Refactor PluginPackage

* Move package types to package folder and add PluginPackageEntry

* Remove extract method from plugin package

* Cleans up

* Add storage and fix build errors

* Remove PluginIdentity from metadata

* Fix content folder check bug

* Add unit tests

* Fix namespace and styles

* Refactor plugin installer (#288)

* Add locator

* Update validator to use locator

* Add checksum calculator

* Decoupled storage from installer

* Add plugin loader

* PR comment

* Metadata Equality (#289)

* Add equals and gethashcode override

* Add null checks and equals override in AvailablePluginInfo

* Add equals override in PluginSource

* Remove empty line

* Update PluginMetadata

* Fix typo

* Use existing plugin identity instead of creating new

* Clean up

* Fix InstalledPluginInfo Id and Version

* Add unit tests for FileSystemInstalledPluginStorage (#290)

* Add FileSystemInstalledPluginStorage tests

* More tests for AddAsync

* Add more test cases

* More

* Add plugin registry tests (#291)

* Add plugin registry tests

* Add more tests

* Clean ups (#292)

* Clean up

* Fix doc

* Exclude plugins tests from version.json

* Revert ci.yml

* Fix bugs in package installation

* Return collection instead of dictionary in IPluginDiscoverer

* Remove redundant parts in property names

* Add an abstract thread safe repository impl

* Add cref

* Fix doc

* Add TODOs

* Remove white space in plugin identity ToString()

* Move package abstraction to core

* Address PR comments

---------

Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2023-04-18 11:48:25 -07:00
Luke Bordonaro 2d9d26b21f
Clarify where ColumnRoles are added in glossary (#220) 2022-10-26 10:15:29 -07:00
Angeeras Ramanath e530f6358d
Update Engine docs sample (#194)
Sample engine code has errors

Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2022-09-27 11:42:03 -07:00
Luke Bordonaro afcd4cf095
Add WPA versions for 1.0.* (#193) 2022-02-07 12:22:47 -08:00
Jayson Maxson bb14a7bfac
Update docs for 1.0 (#191)
* Update docs 1.

* Spelling and tweaks.

* Resolving PR feedback.

* Resolve PR feedback.

* Resolve PR feedbakc.

* Resolve PR feedback.

Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2022-02-04 16:12:16 -08:00
Angeeras Ramanath 86ebf45b77
User/anramanath/documentation (#189)
* init

* Overview

* Architecture.

* WIP Moving about information

* remove about info.

* fixes in links.

* tweak links.

* bullet list.

* Optional note.

* Comments + gerund.
2022-02-03 08:21:25 -08:00
Luke Bordonaro 3ed9796244
Revamp documentation (#188)
* Refactor plugin creation to separate framework models

* Add building-a-table docs

* Link to docs overview from README

* Fix header in Creating-a-table

* Remove unused file

* Fix typo

* Update simple next steps

* Consistent periods in list

* Compatability typos fix

* Update known-driver-compat overview

* Address comments

* Exposes typo
2022-02-01 16:06:56 -08:00
Luke Bordonaro 94f415a556
Update existing documentation and add glossary file (#186)
* Slight edits to existing documents and add glossary

* Combine sentences

* Address more comments

* Address feedback

* Grammar

* Fix now-dead link

* Alphabetize
2022-02-01 14:19:54 -08:00
Zack Newman 0d695ac5dc
Explicitly call out that reuse is not implemented yet. (#173)
* Explicitly call out that reuse is not implemented yet.

* Fix incorrect Engine documentation

Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2021-12-02 14:28:22 -08:00
Thad House 1144064a94
Fix incorrect parameter in 1.0.0-rc1 Engine Update Docs (#168)
EngineCreateInfo takes a ReadOnlyDataSourceSet, but the docs were passing in a DataSourceSet, and there is no implicit conversion

Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
2021-11-18 07:51:07 -08:00
Luke Bordonaro edd82b9057
Add known SDK driver compatibility docs (#174)
* Add known SDK driver compatibility docs

* Fix 0.108.* WPA versions
2021-11-16 08:07:19 -08:00
Luke Bordonaro 2e6c505acc
Fix dead link (#169) 2021-11-12 14:09:44 -08:00
Luke Bordonaro b36fc065da
Update RC1 migration docs (#166)
* Update some docstrings

* Standardize migration formatting

* Add conceptual changes section

* Move things around

* Add table of contents

* Address comments

* Fix whitespace
2021-11-11 13:22:59 -08:00
Jayson Maxson a008e5e852
Remove isInternalTable from TableDescriptor constructor (#161)
* Remove isInternal from table descriptor ctor

* Fix tests.
CustomDataProcessor.BuildMetadataTables skips extension tables.
Re-enabled CustomDataProcessorWithSourceParser.EnableInternalTables to make with metadata extension tables work.

* Add TableDescriptorFactory tests and fix bug.

* Update migration documentation.

* PR updates

* EnableInternalTables -> EnableExtensionMetadataTables

* Updated doc comments for PR

Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
2021-11-03 16:35:42 -07:00
Tristan Gibeau 769ae8f3b4
Update ColumnRoles to use strings instead of enum (#158)
* Update ColumnRoles to use strings instead of enum

* Update migration docs
2021-11-03 10:43:23 -07:00
Luke Bordonaro 39bd60dd11
Rename ISerializer and make ApplicationEnvironment's serizlier non-customizable (#159) 2021-11-03 08:57:31 -07:00
Zack Newman 374a6e3302
Fixes all warnings in the solution. (#150)
* Fixes all warnings in the solution.

Fix all code warnings.
Remove all obsolete code as it causes warnings.

* Address PR comments.

* Address PR comments.

* Address PR comments.

* Address PR comments.

* Update migration doc.

* Revert "Address PR comments."

This reverts commit a5e6a46792.

* Address PR comments.

* Fix removed check.

* Fix toString in DataOutputPath

* Address PR comments.

* Put make EmptySourceParserId for maintenance purposes.

* Address PR comments.
2021-10-28 14:48:36 -07:00
Jayson Maxson d1df048fe3
Merge branch 'main' into user/jmaxson/fix-composite-cookers-2 (#129)
Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
2021-10-28 14:24:14 -07:00
Luke Bordonaro 5efab1c3f1
Update references to the word "plugin" (#148)
* Standardize plugin naming

* Update documentation
2021-10-27 08:14:30 -07:00
Jayson Maxson f3f09bb61f
Remove defunct code for RC1. (#128)
* Remove obsolete code.

* Add comments about EmptySourceParserId.

* Make CustomDataProcessor::ProcessAsyncCore abstract.

* Update migration documentation.

Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
2021-10-26 14:13:22 -07:00
Luke Bordonaro 9cdd470854
Rename 'viewport' references to 'visible domain' (#142)
* Rename 'viewport' references to 'visible domain'

* Update docs

* Rename 'VisibleTableRegionContainer' to 'VisibleDomainRegionContainer'

* Re-add exceptions to interfaces
2021-10-26 14:01:39 -07:00
Zack Newman 71d5808664
User/zachnew msft/disable data processors (#135)
* Comment out Data Processors.

* Update migration doc.

* Update migration doc.
2021-10-26 13:49:59 -07:00
Zack Newman f56f61c769
User/zachnew msft/table discovery (#136)
* Refactor ProcessingSource to use a table discovery interface.

This adds ITableProvider to give users an easier way to provide the
tables for their Processing Sources. The default behavior of finding
all tables in the Processing Source's assembly is preserved.

* Update migration doc.

* Fix typo.

* Simplify TableDescriptor boilerplate.

* Update doc comment.

* Move TableDiscovery to its own file.

* Move DiscoveredTable to its own file.

* Add helper methods based on PR feedback.

* Update doc comments.

* Remove obsolete constructor.

* Refactor test data source.

* Address PR comments about DiscoveredTable comparison.

* Address PR comments.

* Address PR comments.

* Address PR comments.

* Add missing unit test.
2021-10-26 13:45:56 -07:00
Zack Newman d4d080cca1
User/zachnew msft/engine msg box (#141)
* Rename GraphicalEnvironment to IsUserInteractive.

* Add interactive flag.

* Implement message boxes.

* Add test Processing Source for interaction.

* Start tests.

* Add ability to surface errors from the engine.

* Add CLI driver for interaction.

* Address PR comments.
2021-10-26 13:41:34 -07:00
Zack Newman b618a6fd14
User/zachnew msft/build table errors (#138)
* Engine Results now throws if an attempt is made to build a not-enabled table.

* Update breaking changes doc.

* Address PR comments.
2021-10-20 10:49:32 -07:00
Luke Bordonaro b1d1b73c01
RC1 -> main (#134)
* Rename abstract classes that do not need Base in their name (#92)

* Merge rc1 migration docs to one file
2021-10-05 10:37:09 -07:00
Zack Newman 3b2692fdeb
Feature/engine immediate feedback (#119)
Separates enabling cookers from adding data sources. This enables users to know if the cooker they enabled potentially has data. This also has the benefit of allowing reuse of plugins and data sources across engine instances.

Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
Co-authored-by: Zack Newman <zachnew@ntdev.microsoft.com>
2021-09-08 11:58:18 -07:00
Luke Bordonaro 3d2ea77463
Rename CustomDataSource to ProcessingSource (#86)
* Create class/interface definitions for new names and obsolete old ones

* WIP rename other stuff

* more comments. Remove old classes

* Update docs

* Re-add old class names

* Fix migration docs

* Update about info docs

* Address PR comments

* Update ProcessingSourceExecutor docstring

* Update docs from PR comments
2021-08-03 10:08:29 -07:00
Luke Bordonaro 30094c3c36
Update DataCookerPath and DataOutputPath API to not expose internal string rep of paths (#88)
* Testing changes to cooker paths

* Fix broken tests

* Restore old API and mark as Obsolete

* Fix unintended public -> internal changes

* Update migraiton doc
2021-07-27 09:01:14 -07:00
Luke Bordonaro 0d07472ff3
Mark TableConfiguration.Layout as obsolete (#91)
* Mark TableConfiguration.Layout as obsolete

* Update migration doc
2021-07-15 08:16:41 -07:00
Luke Bordonaro f03a957241
Add about info docs (#59) 2021-07-08 08:23:55 -07:00
Zack Newman d9a3f89e57
Take develop to main (#68)
Take develop to main.

Co-authored-by: Tristan Gibeau <41077386+trgibeau@users.noreply.github.com>
Co-authored-by: Luke Bordonaro <lukebo@microsoft.com>
Co-authored-by: Jayson Maxson <jmaxson@ntdev.microsoft.com>
Co-authored-by: Angeeras Ramanath <anramanath@microsoft.com>
2021-04-06 14:35:23 -07:00
Zack Newman 1b0319d3a6 Initial Code Commit. 2020-09-18 13:21:12 -07:00