In late 2011 and early 2012, Encodo designed a querying language for Quino. Quino has an ORM that, combined with .NET Linq provides a powerful querying interface for developers. QQL is a DSL that brings this power to non-developers.
QQL never made it to implementation---only specification. In the meantime, the world moved on and we have common, generic querying APIs like OData. The time for QQL is past, but the specification is still an interesting artifact, in its own right.
Who knows? Maybe we'll get around to implementing some of it, at some point.
At any rate, you can download the specification from the downloads section.
The following excerpts should give you an idea of what you're in for, should you download and read the 80-page document.
Details
The TOC lists the following top-level chapters:
- Introduction
- Examples
- Context & Scopes
- Standard Queries
- Grouping Queries
- Evaluation
- Syntax
- Data Types and Operators
- Libraries
- Best Practices
- Implementation Details
- Future Enhancements
From the abstract in the document:
The Quino Query Language (QQL) defines a syntax and semantics for formulating data requests against hierarchical data structures. It is easy to read and learn both for those familiar with SQL and non-programmers with a certain capacity for abstract thinking (i.e. power users). Learning only a few basic rules is enough to allow a user to quickly determine which data will be returned by all but the more complex queries. As with any other language, more complex concepts result in more complex texts, but the syntax of QQL limits these cases.
From the overview:
QQL defines a syntax and semantics for writing queries against hierarchical data structures. A query describes a set of data by choosing an initial context in the data and specifying which data are to be returned and how the results are to be organized. An execution engine generates this result by applying the query to the data.
Examples
Standard Projections
The follow is from chapter 2.1, "Simple Standard Query":
The following query returns the first and last name of all active people as well as their 10 most recent time entries, reverse-sorted first by last name, then by first name.
Person
{
select
{
FirstName; LastName;
Sample:= TimeEntries { orderby Date desc; limit 10 }
}
where Active
orderby
{
LastName desc;
FirstName desc;
}
}
In chapter 2, there are also "2.2 Intermediate Standard Query" and "2.3 Complex Standard Query" examples.
Grouping Projections
The following is from chapter 2.4, "Simple Grouping Query":
The following query groups active people by last name and returns the age of the youngest person and the maximum contracts for each last name. Results are ordered by the maximum contracts for each group and then by last name.
group Person
{
groupby LastName;
select
{
default;
Age:= (Now - BirthDate.Min).Year;
MaxContracts:= Contracts.Count.Max
}
where Active;
orderby
{
MaxContracts desc;
LastName desc;
}
}
In chapter 2, there are also "2.5 Complex Grouping Query", "2.6 Standard Query with Grouping Query" and "2.7 Nested Grouping Queries" examples.
Any software product should have a version number. This article will answer the following questions about how Encodo works with them.
- How do we choose a version number?
- What parts does a version number have?
- What do these parts mean?
- How do different stakeholders interpret the number?
- What conventions exist for choosing numbers?
- Who chooses and sets these parts?
Stakeholders
In decreasing order of expected expertise,
- Developers: Writes the software; may change version numbers
- Testers: Tests the software; highly interested in version numbers that make sense
- End users: Uses the software as a black box
The intended audience of this document is developers.
Definitions and Assumptions
- Build servers, not developer desktops, produce artifacts
- The source-control system is Git
- The
quinocommand-line tool is installed on all machines. This tool can read and write version numbers for any .NET solution, regardless of which of the many version-numbering methods a given solution actually uses. - A software library is a package or product that has a developer as an end user
- A breaking change in a software library causes one of the following
- a build error
- an API to behave differently in a way that cannot be justified as a bug fix
Semantic versions
Encodo uses semantic versions. This scheme has a strict ordering that allows you to determine which version is "newer". It indicates pre-releases (e.g. alphas, betas, rcs) with a "minus", as shown below.
Version numbers come in two flavors:
- Official releases:
[Major].[Minor].[Patch].[Build] - Pre-releases:
[Major].[Minor].[Patch]-[Label][Build]
See Microsoft's NuGet Package Version Reference for more information.
Examples
0.9.0-alpha34: A pre-release of 0.9.00.9.0-beta48: A pre-release of 0.9.00.9.0.67: An official release of 0.9.01.0.0-rc512: A pre-release of 1.0.01.0.0.523: An official release of 1.0.0
The numbers are strictly ordered. The first three parts indicate the "main" version. The final part counts strictly upward.
Parts
The following list describes each of the parts and explains what to expect when it changes.
Build
- Identifies the build task that produced the artifact
- Strictly increasing
Label
- An arbitrary designation for the "type" of pre-release
Patch
- Introduces bug fixes but no features or API changes
- May introduce obsolete members
- May not introduce breaking changes
This part is also known as "Maintenance" (see Software versioning on Wikipedia).
Minor
- Introduces new features that extend existing functionality
- May include bug fixes
- May cause minor breaking changes
- May introduce obsolete members that cause compile errors
- Workarounds must be documented in release notes or obsolete messages
Major
- Introduces major new features
- Introduces breaking changes that require considerable effort to integrate
- Introduces a new data or protocol format that requires migration
Conventions
Uniqueness for official releases
There will only ever be one artifact of an official release corresponding to a given "main" version number.
That is, if 1.0.0.523 exists, then there will never be a 1.0.0.524. This is due the fact that the build number (e.g. 524) is purely for auditing.
For example, suppose your software uses a NuGet package with version 1.0.0.523. NuGet will not offer to upgrade to 1.0.0.524.
Pre-release Labels
There are no restrictions on the labels for pre-releases. However, it's recommended to use one of the following:
alphabetarc
Be aware that if you choose a different label, then it is ordered alphabetically relative to the other pre-releases.
For example, if you were to use the label pre-release to produce the version 0.9.0-prealpha21, then that version is considered to be higher than 0.0.0-alpha34. A tool like NuGet will not see the latter version as an upgrade.
Release branches
The name of a release branch should be the major version of that release. E.g. release/1 for version 1.x.x.x.
Pre-release branches
The name of a pre-release branch should be of the form feature/[label] where [label] is one of the labels recommended above. It's also OK to use a personal branch to create a pre-release build, as in mvb/[label].
Setting the base version
A developer uses the quino tool to set the version.
For example, to set the version to 1.0.1, execute the following:
quino fix -v 1.0.1.0
The tool will have updated the version number in all relevant files.
Calculating final version
The build server calculates a release's version number as follows,
- major: Taken from solution
- minor: Taken from solution
- maintenance: Read from solution
- label: Taken from the Git branch (see below for details)
- build: Provided by the build server
Git Branches
The name of the Git branch determines which kind of release to produce.
- If the name of the branch matches the glob
**/release/*, then it's an official release - Everything else is a pre-release
For example,
origin/release/1origin/production/release/neworigin/release/release/1production/release/newrelease/
The name of the branch doesn't influence the version number since an official release doesn't have a label.
Pre-release labels
The label is taken from the last part of the branch name.
For example,
origin/feature/betayieldsbetaorigin/feature/rcyieldsrcorigin/mvb/rcyieldsrc
The following algorithm ensures that the label can be part of a valid semantic version.
- Remove invalid characters
- Append an
Xafter a trailing digit - Use
Xif the label is empty (or becomes empty after having removed invalid characters)
For example,
origin/feature/rc1yieldsrc1Xorigin/feature/linux_compatyieldslinuxcompatorigin/feature/12yieldsX
Examples
Assume that,
- the version number in the solution is 0.9.0.0
- the build counter on the build server is at 522
Then,
- Deploying from branch
origin/release/1produces artifacts with version number0.9.0.522 - Deploying from branch
origin/feature/rcproduces artifacts with version number0.9.0-rc522
Release Workflow
The following are very concise guides for how to produce artifacts.
Pre-release
- Ensure you are on a non-release branch (e.g.
feature/rc,master) - Verify or set the base version (e.g.
quino fix -v 1.0.2.0 - Push any changes to Git
- Execute the "deploy" task against your branch on the build server
Release
- Ensure you are on a release branch (e.g.
release/1) - Verify or set the base version (e.g.
quino fix -v 1.0.2.0 - Push any changes to Git
- Execute the "deploy" task against your branch on the build server
The summary below describes major new features, items of note and breaking changes.
- Download the artifacts
- See the full list of issues
The links above require a login.
Overview
At long last, Quino enters the world of .NET Standard and .NET Core. Libraries target .NET Standard 2.0, which means they can all be used with any .NET runtime on any .NET platform (e.g. Mac and Linux). Sample applications and testing assemblies target .NET Core 2.0. Tools like quinogenerate and quinofix target .NET Core 2.1 to take advantage of the standardized external tool-support there.
Furthermore, the Windows, Winform and WPF projects have moved to a separate solution/repository called Quino-Windows.
Quino-Standard is the core on which both Quino-Windows and Quino-WebAPI build.
- All core assemblies target .NET Standard 2.0.
- All assemblies in
Quino-Windowstarget .NET Framework 4.6.2 because that's the first framework that can interact with .NET Standard (and under which Windows-specific code runs). - All assemblies in
Quino-WebAPIcurrently target .NET Framework 4.6.2. We plan on targeting .NET Core in an upcoming version (tentatively planned for v7).
Highlights
- Target .NET Standard and .NET Core from Quino-Standard
- Split Windows-specific code to Quino-Windows
- Improve authentication API to use
IIdentityeverywhere (deprecatingICredentialsandIUserCredentials).
Breaking Changes
6.0 is a pretty major break from the 5.x release. Although almost all assembly names have stayed the same, we had to move some types around to accommodate targeting .NET Standard with 85% of Quino's code.
APIs
We've tried to support existing code wherever possible, but some compile errors will be unavoidable (e.g. from namespace changes or missing references). In many cases, R#/VS should be able to help repair these errors.
These are the breaking changes that are currently known.
- Moved
IRunSettingsandRunModefromEncodo.ApplicationtoEncodo.Core.
References
Any .NET Framework executable that uses assemblies targeting .NET Standard must reference .NET Standard itself. The compiler (MSBuild) in Visual Studio will alert you to add a reference to .NET Standard using NuGet. This applies not just to Winform executables, but also to any unit-test assemblies.
Tools
One piece that has changed significantly is the tool support formerly provided with Quino.Utils. As of version 6, Quino no longer uses NAnt, instead providing dotnet-compatible tools that you can install using common .NET commands. Currently, Quino supports:
dotnet quinofixdotnet quinogeneratedotnet quinopack
Please see the tools documentation for more information on how to install and use the new tools.
The standalone Winforms-based tools are in the Quino-Windows download, in the Tools.zip archive.
Quino.MigratorQuino.PasswordEncryptor
Quino.Utils is no longer supported as a NuGet package.
The summary below describes major new features, items of note and breaking changes.
- Download the artifacts
- See the full list of issues
The links above require a login.
Overview
This is the last planned release on the 5.x branch of Quino. The future lies with Quino 6, which targets .NET Standard and .NET Core wherever possible.
Highlights
- Improved Console Support for Windows Services (QNO-5938)
Breaking changes
- Renamed
AddDefaultExceptionDetailsFormatters()toUseDefaultExceptionDetailsFormatters() - Moved crash-reporter types to
Encodo.Monitor - Renamed
ProcessExtensions.StopChild()toStopAndClose() - Renamed
IProcessParameters.TimeouttoIProcessParameters.TimeoutInMilliseconds - Renamed
IDataGeneratePluginInitializertoIDataGeneratorPluginInitializer - Plugin support has been moved from
Encodo.Application.StandardtoEncodo.Plugins PasswordEncryptionTypehas been replaced withHashAlgorithmGetSearchClass(IMetaClass)was moved fromQuino.MetatoQuino.BuildersGetLayoutno longer has a default value for thelayoutTypeparameter (passLayoutType.Detailto get the previous behavior)IKeyValueNode.GetValue()has been moved to an extension method. You may need to include the namespaceEncodo.Nodes.- Namespaces in
Quino.Bookmarkshave been changed fromEncodo.Quino.Bookmarks.BookmarkstoEncodo.Quino.Bookmarks. - WPF schema-migration types have been moved from the
Quino.Module.Schema.Wpfnamespace toEncodo.Quino.Module.Schema.Wpf. - Some testing support types have been moved from the
Teststo theTestingnamespace (e.g.EncodoServicesBasedTestsBaseandEncodoTestsBase). - Introduced the
IFinalizerBuilderProviderso that applications no longer need to include theMetaStandardBuilderin models.
Finalizer Provider
Whiile an application no longer needs to manage the insertion point of the MetaStandardBuilder and therefore no longer needs to override PostFinalize() instead of a more relevant method, this is a breaking change for certain situations. For example, if a builder overrode PostFinalize() and expected the finalizer builders included in MetaStandardBuilder to have already run previously.
The workaround is to either:
- Rewrite the logic to avoid depending on expressions/model added by the finalizer builders. (this is what we ended up doing in Punchclock).
- Add the builder to the list of finalizer builders (in which case it will be executed last). You can customize the finalizer builders as with an other
IProvideusing something like the following in your application startup.
application.Configure<IFinalizerBuilderProvider>(
p =>
{
p.Register<MyOwnFinalizerBuilder>();
p.Remove<FallbackLayoutBuilder>();
}
);
Relation Captions
Automatic generation of relation captions has changed slightly.
Whereas previously, the captions of the target class were always used, the FallbackCaptionBuilder now only does this if the name of the relation has not been changed from the default.
If the name was changed to something else, then that name is used for relation captions. For example, if you make a relation from a Company to a Person called People, then Quino will still use the captions from the class. This allows your application to set the caption on the class and it will be used for many relations.
However, if you create a similar relation, but rename it to CEO, Quino will no longer use the class captions, since in this case Person and People (and translations) are no longer appropriate. In this case, CEO and CEOs is more appropriate.
In this case, the captions in the default language will be more appropriate but the captions for other languages previously taken from the class will no longer be used on the relation.
The summary below describes major new features, items of note and breaking changes. The full list of issues is in the release notes and is available to those with access to the Encodo issue tracker.
Highlights
- Improved support for Windows Services (QNO-4652, QNO-5967, QNO-5968, QNO-5970)
- Fixed data-retrieval for wrappers introduced in previous release (backward-compatibility only) (QNO-5945, QNO-5960)
- Improved main-window focus for Winform applications (QNO-5928)
- Fixed stack overflow exception for some expression-based titles (QNO-5951)
- Fixed various issues in report-manager UI (QNO-5956, QNO-5957, QNO-5985, QNO-5990)
- Introduce nant reset command to clear all files (QNO-5982)
- Deprecate GetAllInstances() and RegisterSingles() (QNO-5989)
Breaking changes
- No known breaking changes.
Abstract
Encodo has updated its technology stack for SPAs. Current and future projects will use a combination of React Component States, React Contexts and Redux:
- Use React Component States to manage state that is used only in a single component.
- Use React Contexts to manage presentational state for component hierarchies.
- Use Redux to manage global or persistent state.
The following article provides justification and reasoning for the conclusions listed above.
Overview
Encodo have undertaken a number of Single Page Application (SPA) projects over the last several years. During this time, web technologies, common standards and best practices have changed significantly. As such, these projects each had different configurations and used different sets of web technologies.
The last two years have brought a reduction in churn in web technologies. Encodo have therefore decided to evaluate SPA libraries with the goal of defining a stack that will be stable for the next few years. The outcome of this evaluation proposes a set of best practices in architecting an SPA, and most importantly, architecting an SPA’s state.
Participants
- Marc Duerst
- Marco von Ballmoos
- Remo von Ballmoos
- Richi Buetzer
- Tom Szpytman
Introduction
Having undertaken an earlier evaluation of SPA rendering libraries, Encodo’s SPA projects have all relied upon the Javascript library React. To date, the company still feels that React provides an adequate and stable platform upon which to build SPAs.
Where the company feels its knowledge can be improved upon, is how state should be structured in an SPA, and which SPA state libraries, or combination of libraries, provide the most maintainable, stable and readable architectures. As such, this evaluation will only focus on discussing SPA-state libraries and not SPA-rendering libraries.
Requirements
Encodo focusses on both the building and maintenance of elegant solutions. It is therefore paramount that these software solutions are stable, yet future-proof in an ever-changing world. Many of Encodo’s clients request that solutions be backward-compatible with older browsers. An SPA state library must therefore adhere to the following criteria:
- The library must have a moderately-sized community
- The library must have a solid group of maintainers and contributors
- Typescript typings must be available (and maintained)
- The library must be open-source
- The library must support all common browsers, as far back as IE11
- The library must have a roadmap / future
- Code using the library must be maintainable and readable (and support refactoring in a useful manner)
Candidates
Redux
Redux was released over three years ago and has amassed over 40,000 stars on Github. The project team provides a thorough set of tutorials, and software developers are additionally able to find a plethora of other resources online. Furthermore, with almost 15,000 related questions on StackOverflow, the chances of finding unique problems that other developers haven’t previously encountered are slim. Redux has over 600 contributors, and although its main contributors currently work for Facebook, the library is open source in its own right and not owned by Facebook.
Redux is an implementation of the Flux pattern; that is, you have a set of stores that each hold and maintain part of an application state. Stores register with a dispatcher, and by connecting to the dispatcher, receive notifications of events (usually as a result of a user input, but often also as a result of an automated process, e.g. a timer which emits an event each second). In the Redux world, these events are called actions. An action is no more than a Javascript object containing a type (a descriptive unique id) and optional additional information associated with that event.
Example 1 – A basic Redux action
Imagine a scenario where a user clicks on a button. Clicking the button toggles the application’s background colour. If the button were connected to Redux, it would then call the dispatcher and pass it an action:
{
type: ‘TOGGLE_BACKGROUND_COLOUR’
}
Example 2 – A Redux action with a payload
Suppose now the application displayed an input field which allowed the user to specify a background colour. The value of the text field could be extracted and added as data to the action:
{
type: ‘TOGGLE_BACKGROUND_COLOUR’,
payload: {
colour: ‘red’ // Taken from the value of the text field, for example
}
}
—
When the dispatcher receives an action, it passes the action down to its registered stores. If the store is configured to process an action of that type, it runs the action through its configuration and emits a modified state. If not, it simply ignores the action.
Example 3 – Processing an action
Suppose an application had two stores:
Store X has an initial state
{ colour: ‘red’ }and is configured to processTOGGLE_BACKGROUND_COLOURactions. If it encounters an action of this type, it is configured to set its state to the colour in the action’s payload.Store Y has an initial state
{ users: [] }and is configured to processUSER_LOADactions. If it encounters an action of this type, it is configured to set its state to the users in the action’s payload.
Suppose the following occurs:
- A
TOGGLE_BACKGROUND_COLOURaction is sent to the dispatcher with payload{ colour: ‘green’ }.
The result would be:
Store Y ignores this action as it is not configured to process actions of the
TOGGLE_BACKGROUND_COLOURtype. It therefore maintains its state as{ users: [] }.Store X on the other hand, is configured to process
TOGGLE_BACKGROUND_COLOURactions and emits the modified state{ colour: ‘green’ }.
—
Views bind the stores and dispatcher together. Views are as their name suggests; the application’s visual components.
When using Redux in combination with React, Views, in the Redux sense, are React components that render parts of the state (e.g. the application’s background colour) and re-render when those parts of the state change.
Redux doesn’t have to be used in conjunction with React, so the general definition of a view is a construct that re-renders every time the part of the state it watches changes. Views are additionally responsible for creating and passing actions to the dispatcher. As an example, a view might render two elements; a div displaying the current colour and a toggle button which, when clicked, sends a TOGGLE_BACKGROUND_COLOUR action to the dispatcher.
Figure 1: The flow of a Redux application
Pros
Software written following Redux’s guidelines is readable, quick to learn and easy to work with. Whilst Redux’s verbosity is often cited as a pitfall, the level of detail its verbosity provides helps debugging. Debugging is also aided by a highly detailed, well-constructed, browser extension; Redux DevTools. At any given point in time, a developer can open up Redux DevTools and not only be presented with an overview of an application’s state, but the effect of each action on the state. That’s certainly a tick in the box for Redux when it comes to ease of debugging.
Pairing Redux with React is as simple as installing and configuring the react-redux library. The library enforces a certain pattern of integrating the two, and as such, React-Redux projects are generally structured in similar ways. This is incredibly beneficial for developers, as the learning curve when jumping into new Redux-based projects is significantly reduced.
Redux also allows applications to rehydrate their state. In non-Redux terms, this means that when a Redux application starts, a developer can provide the application with a previously saved state. This is incredibly useful in instances where an application’s state needs to be persisted between sessions, or when data from the server needs to be cached. As an example, suppose our application sends data to and from an authenticated API and needs to send an authentication token on each request. It’d be impractical if this token were to be lost every time the page was refreshed or the browser closed. Redux could instead be configured so that the authentication token always be persisted and then re-retrieved from the browser’s Local Storage when the application started. The ability to re-hydrate a state can also lead to significantly faster application start-up times. In an application which displays a list of users, Redux could be configured to cache/persist the list of users, and on startup, display the cached version of that list until the application has time to make an API call to fetch the latest, updated list of users.
All in all, Redux proves itself to be a library which is easy to learn, use and maintain. It provides excellent React integration and the community around it offer a plethora of tools that help optimise and simplify complicated application scenarios.
Cons
As previously mentioned, Redux is considered verbose; that is, a software developer has to write a lot of code in order to connect a View to a Dispatcher. Many regard this as ‘boilerplate’ code, however, the author considers this a misuse of the word ‘boilerplate’, as code is not repeated, but rather, a developer has to write a lot of it.
Additionally, while Redux describes the flow and states very well, its precision negatively impacts on refactoring and maintainability. If there is significant change to the structure of the components, it's very difficult to modify the existing actions and reducers. It's not hard to lose time trying to find the balance between refactoring what you had and just starting from scratch.
Example 4 – The disadvantages of Redux
class Foo Extends React.Component {
render() {
return (
<div onClick={this.props.click}>
{this.props.hasBeenClicked
? “I’ve been clicked”
: “I haven’t been clicked yet”
}
</div>
);
}
}
Consider the bare-bones example above that illustrates:
- A component which starts by displaying the string “I haven’t been clicked yet” and then changes to display the string “I’ve been clicked” when the initial string is clicked.
If we were to use Redux as the state store for this scenario, we’d have to:
- Create and define a reducer (Redux’s term for a store’s configuration function) and a corresponding action
- Configure this component to use Redux. This would involve wiring up the various prop types (those passed down from the parent component, a click action to send to the dispatcher and a hasBeenClicked prop that needs to be read out from the Redux state)
What could remain a fairly small file if we were to use, say, class Foo’s component state (see the React Component State chapter for details), would end up as a series of long files if we were to use Redux. Clearly Redux’s forte doesn’t lie in managing a purely presentational component’s state.
Furthermore, suppose we had fifty presentational components like Foo, whose states were only used by the components themselves. Storing each component’s UI state in the global application state would not only pollute the Redux state tree (imagine having fifty different reducers/actions just to track tiny UI changes), but would actually slow down Redux’s performance. There’d be a lot of state changes, and each time the state changed, Redux would have to calculate which views were listening on that changed state and notify them of the changes.
Managing the state of simple UI/presentational components is therefore not a good fit for Redux.
Summary
Redux’s strengths lie in acting as an application’s global state manager. That is, Redux works extremely well for state which needs to be accessed from across an application at various depths. Its enforcement of common patterns and its well-constructed developer tools means that developers can reasonably quickly open up unfamiliar Redux-based projects and understand the code. Finally, the out of the box ability to save/restore parts of the state means that Redux outweighs most other contenders as a global state manager.
Mobx
At the time of writing, as with Redux, Mobx was first released over three years ago. Although still sizeable, its community is much smaller than Redux’s; it has over 16,000 stars on Github and almost 700 related questions on StackOverflow. The library is maintained by one main contributor, and although other contributors do exist, the combined number of their commits is dwarfed by those from the main contributor.
In its most basic form, Mobx implements the observer pattern. In practice, this means that Mobx allows an object to be declared as an ‘observable’ which ‘observers’ can then subscribe to and receive notifications of the observable object’s changes. When combining Mobx with React, observers can take the form of React components that re-render each time the observables they’re subscribed to change, or basic functions which re-run when the observables they reference change.
Pros
What Mobx lacks in community support, it makes up for in its ease of setup. Re-implementing Example 4 above using Mobx, a developer would simply:
- Declare the component an observer
- Give the class a boolean field property and register it as an observable
Example 5 – A simple Mobx setup
@observer
class Foo Extends React.Component {
hasBeenClicked = observable(false);
render() {
return (
<div onClick={() => this.hasBeenClicked.set(true)}>
{this.hasBeenClicked.get()
? “I’ve been clicked”
: “I haven’t been clicked yet”
}
</div>
);
}
}
Short and sweet. Mobx at its finest.
—
The tree-like state structures required by Redux can feel rather limiting. In contrast, a developer using Mobx as a global state manager could encapsulate the global state in several singleton objects, each making up part of the state. Although there are recommended guidelines for using this approach (Mobx Store, Mobx project structure), these aren’t as readily enforced by Mobx as Redux does its recommended ways of structuring code.
Mobx proves itself as a worthy candidate for managing the state of UI/presentational components. Furthermore, it offers the flexibility of being able to declare observables/observers anywhere in the application, thus preventing pollution of the global application state and allowing some states to be encapsulated locally within React components. Finally, when used as a global application state manager, the ability to model the global state in an object-orientated manner can also seem more logical than the tree structure enforced by Redux.
Cons
Mobx seems great so far; it’s a small, niche library which does exactly what it says on the tin. Where could it possibly go wrong? Lots of places…
For starters, Mobx’s debugging tool is far inferior to the host of tools offered by the Redux community. Mobx-trace work perfectly well when trying to ascertain who/what triggered an update to an observable, or why an observer re-rendered/re-executed, but in contrast to Redux DevTools, it lacks the ability to gain an overview of the entire application state at any given point in time.
Moreover, Mobx doesn’t come with any out of the box persist/restore functionality, and although there are libraries out there to help, these libraries have such small user bases that they don’t provide Typescript support. The Mobx creator has, in the past, claimed that it wouldn’t be too hard for a developer to write a custom persistence library, but having simple, out of the box persist/restore functionality as Redux does is still favourable.
Beyond the simplicity presented in Example 5, Mobx is a library that provides an overwhelming number of low-level functions. In doing so, and in not always providing clear guidelines describing the use-cases of each function, the library allows developers to trip up over themselves. As examples, developers could read the Mobx documentation and still be left with the questions:
- When is it best to use autorun vs reaction vs a simple observer?
- When should I “dispose” of observable functions?
In summary, the relatively small community surrounding Mobx has led to the library lacking in a solid set of developer tools, add-on libraries and resources to learn about its intricacies. Ultimately this is a huge negative aspect and should be heavily considered when opting to use Mobx in an SPA.
Summary
As a library, Mobx has huge potential; its core concepts are simple and the places in which it lacks could easily be improved upon. Its downfall, however, is the fact that it only has one main contributor and a small community surrounding it. This means that the library lacks, and will lack, essentials such as in-depth tutorials and development tools.
Added to this, as of Mobx v5, the library dropped support for IE11. In doing so, the library now fails to meet Encodo’s cross-compatibility requirements. The current claim is that Mobx v4 will remain actively supported, but with a limited number of contributors, it is debatable whether or not support for v4 will remain a priority.
Beyond the lack of IE11 support, Mobx's lack of coherent guidelines, sub-par debugging tools and free reign given to developers to architect projects as they please makes for problematic code maintenance.
React Component State
React was initially released over five years ago and from its inception, has always offered a way of managing and maintaining state. Here we must note, that whilst a state management system exists, it is not intended to be used as a global state management system. Instead, it is designed to function as a local state system for UI/presentational components. As such, the evaluation of React Component states will only focus on the benefits and drawbacks of using it as a local state manager.
Pros
React component state is an easy to learn, easy to use framework for managing a small UI state.
Example 6 – Component state
class Foo Extends React.Component {
state = {
hasBeenClicked = false
};
render () {
return (
<div
onClick={() => this.setState({ hasBeenClicked: true })}
>
{this.state.hasBeenClicked
? “I’ve been clicked”
: “I haven’t been clicked yet”
}
</div>
);
}
}
Refreshingly simple.
Configuring a Component state can be as simple as:
- Defining a component’s initial state
- Configuring the component’s render function to display that state
- Binding to UI triggers (e.g. onClick methods) which update the component’s state, thus forcing a re-render of the component
React Component State is just as concise as the similar MobX example above, without introducing a separate library.
Cons
React component states aren’t well architected to managing the states of hierarchies of UI components.
Example 7 – The drawbacks of using Component state
class Foo Extends React.Component {
state = {
hasBeenClicked: false,
numberOfClicks: 0
};
onClick = () => {
return this.setState(
(previousState) =>
({
hasBeenClicked: true,
numberOfClicks: previousState.numberOfClicks + 1
})
);
}
render() {
return (
<div>
<FooDisplay
hasBeenClicked={this.state.hasBeenClicked}
numberOfClicks={this.state.numberOfClicks}
/>
<Button onClick={this.onClick} />
</div>
);
}
}
class FooDisplay extends React.Component {
render() {
return (
<div>
{this.props.hasBeenClicked
? “I’ve been clicked”
: <CountDisplay
numberOfClicks={this.props.numberOfClicks}
/>
}
</div>
);
}
}
class CountDisplay extends React.Component {
render() {
return (
<div>
I’ve been clicked {this.props.numberOfClicks} times
</div>
);
}
}
class Button Extends React.Component {
render () {
return (
<button onClick={this.props.onClick}>
Click me
</button>
);
}
}
Although basic, the example above attempts to illustrate the following:
- State/state modifying functions have to be passed down through the hierarchy of components as props. If the components were split into multiple files (as is common to do in a React project), it’d become cumbersome to trace the source of CountDisplay’s props
- FooDisplay’s only use for its
numberOfClicksprop is to pass it down further. This feels a bit sloppy, but is the only way of gettingnumberOfClicksdown to CountDisplay when using Component State.
Summary
React Component States are often overlooked. Yes, they are limited and only work well for a single specific use case (managing the UI state of a single component), but component states do this extremely well. Software developers often claim that they need more fully-fledged state management libraries such as Redux or Mobx, but if just used to manage UI states, they’d probably be mis-using these libraries.
React component state is as its name suggests; a way of managing state for a single component. React has this functionality built-in, begging the question; is there ever really a use-case for using an alternative library to manage a single component’s state?
React Contexts
React 16.3 introduced a public-facing ‘Context’ API. Contexts were part of the library prior to the public API, and other libraries such as Redux were already making use of it as early as 2 years ago.
React Contexts excel where the Component State architecture begins to crumble; with Contexts, applications no longer have to pass state data down through the component tree to the consumer of the data. Like Redux, React Contexts aren’t well suited to tracking the state of single presentational components; an application tracking single component states with Contexts would end up being far too complicated. Rather, React Contexts are useful for managing the state of hierarchies of presentational components.
Pros
React Contexts allow developers to encapsulate a set of UI components without affecting the rest of the application. By encapsulating the state of a hierarchy of UI components, the hierarchy can be used within any application, at any depth of a component tree. Contexts furthermore allow developers to model UI state in an OO structure. In this sense, React Contexts (in addition to React Component State) provide many of the advantages of Mobx (again, without pulling in a separate library).
UI states are quite often a set of miscellaneous booleans and other variables which don’t necessarily fit into hierarchical tree structures. The ability to encapsulate these variables into one, or several objects is much more fitting. The last benefit of using Contexts is that they allow all components below the hierarchy’s root component to retrieve the state without interfering with intermediary components in the process.
Example 8 – React Contexts
class VisibilityStore = {
isVisible = true;
toggle = () => this.isVisible = !this.isVisible;
}
const VisibilityContext = React.createContext(VisibilityStore);
class Visibility extends React.Component {
store = new VisibilityStore();
render() {
return (
<VisibilityContext.Provider value={store}>
<VisibilityButton />
<VisibilityDisplay />
</VisibilityContext.Provider>
);
}
}
class VisibilityButton extends React.Component {
render() {
return (
<VisibilityContext.Consumer>
{(context) => <button onClick={context.toggle} />}
</VisibilityContext.Consumer>
);
}
}
class VisibilityDisplay extends React.Component {]
render() {
return (
<VisibilityContext.Consumer>
{
(context) =>
<div>
{context.isVisible
? ‘Visible’
: ‘Invisible’
}
</div>
}
</VisibilityContext.Consumer>
);
}
}
The example above exemplifies modelling the UI state as an object (VisibilityStore), retrieving the UI state (VisibilityDisplay) and finally updating the state (VisibilityButton). Although a simple example, it depicts how state can be accessed at various depths of the component tree without affecting intermediary nodes.
Cons
Using Contexts to manage the state of single components would be overkill. Contexts are also ill-equipped to be used as global state managers; they lack a persist/re-load mechanism, and additionally, lack debugging tools which would help provide an overview of the application’s state at any given point in time.
Summary
React Contexts are well suited to a single use-case; managing the state of a group of UI components. Contexts, on their own, aren’t the solution to managing the state of an entire SPA, but the React team’s public release of the Context API comes at a time where it is common to see SPA states bloated full of UI-related state. Developers should therefore seriously consider trimming down their global application states by making use of Contexts.
Alternatives
Although the main React-compatible state management libraries have already been evaluated in this document, it is important to evaluate alternative libraries that are growing in popularity.
Undux
Undux was first released a year ago and sells itself as a lightweight Redux alternative. In just under a year it has amassed nearly 1000 Github stars. That being said, the library still lacks a community around it; there’s still only one main contributor and resources on the library are scarce. Having a single contributor means that the library suffers from under-delivering on essential features like state selectors.
That aside, Undux seems like a promising library; it strips out the verbosity of React, works with React’s debugging tools, supports Typescript and is highly cross-browser compatible. If the size of Undux’s community and number of contributors were to increase, it could be a real contender to Redux.
React Easy State
Like Undux, React Easy State was released over a year ago and has amassed just over 1000 Github stars. It sells itself as an alternative to Mobx and has gained a strong community around it. Both official and non-official resources are plentiful, Typescript support comes out of the box and the library’s API looks extremely promising. React Easy State, however, cannot be considered an SPA management library for Encodo’s purposes as it doesn’t support (and states it will never support) Internet Explorer.
Conclusion
Software libraries are built out of a need to solve a specific problem, or a set of specific problems. Software developers should be mindful of using libraries to solve these sets of problems, and not overstretch libraries to solve problems they weren’t ever designed to solve. Dan Abramov’s blogpost on why Redux shouldn’t be used as the go-to library for all SPA state management problems highlights this argument perfectly.
In light of this, Encodo propose that the use of multiple libraries to solve different problems is beneficial, so long as there are clear rules detailing when one library should be used over another. Having evaluated several different SPA state management libraries, Encodo conclude by suggesting that SPAs should use a combination of Redux, React Contexts and React Component states:
- React Component states should be used to manage the state of individual presentational components whose states aren't required by the rest of the application.
- React Contexts should be used to manage the state of hierarchies of presentational components. Again, beyond the hierarchies, the states encapsulated by Contexts shouldn’t be required by the rest of the application.
- Redux should be used to store any state that needs to be used across the application, or needs to be persisted and then re-initialised.
Mobx has been omitted from the list of recommendations, as upon evaluation, Encodo conclude that it does not meet their requirements. Mobx is a library which exposes a large surface area, thereby offering solutions to a wide range of problems, but not providing a small set of optimised solutions. Many of the advantages of Mobx – mapping state in an OO manner and concise, simple bindings – are provided by React Component State and React Context.
The contender to Mobx, React Easy State, has also been omitted from Encodo’s recommendations, as although it is certainly a promising library with a growing community surrounding it, the library doesn’t support Internet Explorer and therefore does not fulfil Encodo’s requirements.
Finally, although Undux could be a strong contender in replacing Redux, at the time of writing, Encodo feel that the library is not mature enough to be a production-ready, future proof choice and therefore also exclude it from their list of recommendations.
The title is a bit specific for this blog post, but that's the gist of it: we ended up with a bunch of references to an in-between version of .NET (4.6.1) that was falsely advertising itself as a more optimal candidate for satisfying 4.6.2 dependencies. This is a known issue; there are several links to MS GitHub issues below.
In this blog, I will discuss direct vs. transient dependencies as well as internal vs. runtime dependencies.
tl;dr
If you've run into problems with an application targeted to .NET Framework 4.6.2 that does not compile on certain machines, it's possible that the binding redirects Visual Studio has generated for you use versions of assemblies that aren't installed anywhere but on a machine with Visual Studio installed.
How I solved this issue:
- Remove the C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461\ directory
- Remove all System* binding redirects
- Clean out all bin/ and obj/ folders
- Delete the .vs folder (may not be strictly necessary)
- Build in Visual Studio
- Observe that a few binding-redirect warnings appear
- Double-click them to re-add the binding redirects, but this time to actual 4.6.2 versions (you may need to add
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>to your project) - Rebuild and verify that you have no more warnings
The product should now run locally and on other machines.
For more details, background and the story of how I ran into and solved this problem, read on.
Building Software
What do we mean when we say that we "build" an application?
Building is the process of taking a set of inputs and producing an artifact targeted at a certain runtime. Some of these inputs are included directly while others are linked externally.
- Examples of direct inputs are the binary artifacts produced from the source code that comprises your application
- Examples of external inputs are OS components and runtime environments
The machine does exactly what you tell it to, so it's up to you to make sure that your instructions are as precise as possible. However, you also want your application to be flexible so that it can run on as wide an array of environments as possible.
Your source code consists of declarations. We've generally got the direct inputs under control. The code compiles and produces artifacts as expected. It's the external-input declarations where things go awry.
What kind of external inputs does our application have?
- System dependencies in the runtime target (assemblies like System.Runtime, System.Data, etc.), each with a minimum version
- Third-party dependencies pulled via NuGet, each with a minimum version
How is this stitched together to produce the application that is executed?
- The output folder contains our application, our own libraries and the assemblies from NuGet dependencies
- All other dependencies (e.g. system dependencies) are pulled from the environment
The NuGet dependencies are resolved at build time. All resources are pulled and added to the release on the build machine. There are no run-time decisions to make about which versions of which assemblies to use.
Dependencies come in two flavors:
- Direct: A reference in the project itself
- Transient: A direct reference inherited from another direct or transient reference
It is with the transient references that we run into issues. The following situations can occur:
- A transient dependency is referenced one or more times with the same version. This is no problem, as the builder simply uses that version or substitutes a newer version if that version is no longer available (rare, but possible)
- A transient dependency is referenced in different versions. In this case, the builder tries to substitute a single version for all requirements. This generally works OK since most dependencies require a given version or higher. It may be that one or another library cannot work with all newer versions, but this is also rare. In this case, the top-level assembly (the application) must include a hint (an assembly-binding redirect) that indicates that the substitution is OK. More on these below.
- A transient dependency requires a lower version than the version that is directly referenced. This is also not a problem, as the transient dependency is satisfied by the direct dependency with the higher version. In this case, the top-level application must also include an assembly-binding redirect to allow the substitution without warning.
- A transient dependency requires a higher version than the version that is directly referenced. This is an error (no longer just a warning) that must be solved by either downgrading the dependency that leads to the problematic transient dependency or upgrading the direct dependency. Generally, the application will upgrade the direct dependency.
Assembly-Binding Redirects
An application generally includes an app.config (desktop applications or services) or web.config XML file that includes a section where binding redirects are listed. A binding redirect indicates the range of versions that can be mapped (or redirected) to a certain fixed version (which is generally also included as a direct dependency).
A redirect looks like this (a more-complete form is further below):
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0"/>
When the direct dependency is updated, the binding redirect must be updated as well (generally by updating the maximum version number in the range and the version number of the target of the redirect). NuGet does this for you when you're using package.config. If you're using Package References, you must update these manually. This situation is currently not so good, as it increases the likelihood that your binding redirects remain too restrictive.
NuGet Packages
NuGet packages are resolved at build time. These dependencies are delivered as part of the deployment. If they could be resolved on the build machine, then they are unlikely to cause issues on the deployment machine.
System Dependencies
Where the trouble comes in is with dependencies that are resolved at execution time rather than build time. The .NET Framework assemblies are resolved in this manner. That is, an application that targets .NET Framework expects certain versions of certain assemblies to be available on the deployment machine.
We mentioned above that the algorithm sometimes chooses the desired version or higher. This is not the case for dependencies that are in the assembly-binding redirects. Adding an explicit redirect locks the version that can be used.
This is generally a good idea as it increases the likelihood that the application will only run in a deployment environment that is extremely close or identical to the development, building or testing environment.
Aside: Other Bundling Strategies
How can we avoid these pesky run-time dependencies? There are several ways that people have come up with, in increasing order of flexibility:
- Deliver hardware and software together. This is common in industrial applications and used to be much more common for businesses, as well. Nearly bulletproof. If it worked in the factory, it will work for the customer.
- Deliver a VM (virtual machine) as your application. This includes the entire execution environment right down to the hardware. Safe, but inefficient.
- Use a container (e.g. Docker) to deliver a description of the execution environment. The image is built to match the declaration. This is also quite stable and can avoid many of the substitution errors outlined above. If components are outdated, the machine fails to start and the definition must first be updated (and, presumably, tested). This type of deployment is getting more reliable but is also overkill for many applications.
- Deliver the runtime with the application instead of describing the runtime you'd like to have. Targeting .NET Core instead of .NET Framework includes the runtime. This seems like a nice alternative and it's not surprising that Microsoft went in this direction with .NET Core. It's a good solution to the external-dependency issues outlined above.
To sum up:
- A VM delivers the OS, runtime and application.
- A Container delivers a description of the OS and runtime as well as the application itself.
- .NET Core includes the runtime and application and is OS-agnostic (within reason).
- .NET Framework includes only the application and some directives on the remaining components to obtain from the runtime environment.
Our application targets .NET Framework (for now). We're looking into .NET Core, but aren't ready to take that step yet.
Where can the deployment go wrong?
To sum up the information from above, problems arise when the build machine contains components that are not available on the deployment machine.
How can this happen? Won't the deployment machine just use the best match for the directives included in the build?
Ordinarily, it would. However, if you remember our discussion of assembly-binding redirects above, those are set in stone. What if you included binding redirects that required versions of system dependencies that are only available on your build machine ... or even your developer machine?
Special Tip for Web Applications
We actually discovered an issue in our deployment because the API server was running, but the Authentication server was not. The Authentication server was crashing because it couldn't find the runtime it needed in order to compile its Razor views (it has ASP.Net MVC components). We only discovered this issue on the deployment server because the views were only ever compiled on-the-fly.
To catch these errors earlier in the deployment process, you can enable pre-compiling views in release mode so that the build server will fail to compile instead of a producing a build that will sometimes fail to run.
Add the <MvcBuildViews>true</MvcBuildViews> to any MVC projects in the PropertyGroup for the release build, as shown in the example below:
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
<Optimize>true</Optimize>
<OutputPath>bin</OutputPath>
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<LangVersion>6</LangVersion>
<MvcBuildViews>true</MvcBuildViews>
</PropertyGroup>
How do I create a redirect?
We mentioned above that NuGet is capable of updating these redirects when the target version changes. An example is shown below. As you can see, they're not very easy to write:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Reflection.Extensions" publicKeyToken="B03F5F7F11D50A3A" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-4.0.1.0" newVersion="4.0.1.0"/>
</dependentAssembly>
<!-- Other bindings... -->
</assemblyBinding>
</runtime>
</configuration>
Most bindings are created automatically when MSBuild emits a warning that one would be required in order to avoid potential runtime errors. If you compile with MSBuild in Visual Studio, the warning indicates that you can double-click the warning to automatically generate a binding.
If the warning doesn't indicate this, then it will tell you that you should add the following to your project file:
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
After that, you can rebuild to show the new warning, double-click it and generate your assembly-binding redirect.
How did we get the wrong redirects?
When MSBuild generates a redirect, it uses the highest version of the dependency that it found on the build machine. In most cases, this will be the developer machine. A developer machine tends to have more versions of the runtime targets installed than either the build or the deployment machine.
A Visual Studio installation, in particular, includes myriad runtime targets, including many that you're not using or targeting. These are available to MSBuild but are ordinarily ignored in favor of more appropriate ones.
That is, unless there's a bit of a bug in one or more of the assemblies included with one of the SDKs...as there is with the net461 distribution in Visual Studio 2017.
Even if you are targeting .NET Framework 4.6.2, MSBuild will still sometimes reference assemblies from the 461 distribution because the assemblies are incorrectly marked as having a higher version than those in 4.6.2 and are taken first.
I found the following resources somewhat useful in explaining the problem (though none really offer a solution):
- .dll in Microsoft.NET.Build.Extensions\net461 targets .NET Framework 4.6.1
- ImplicitlyExpandNETStandardFacades option on MSBuild Extensions corrupts build (GitHub issue)
- MS Build Extensions file corrupt my bin (Web API) folder
How can you fix the problem if you're affected?
You'll generally have a crash on the deployment server that indicates a certain assembly could not be loaded (e.g. System.Runtime). If you show the properties for that reference in your web application, do you see the path C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461 somewhere in there? If so, then your build machine is linking in references to this incorrect version. If you let MSBuild generate binding redirects with those referenced paths, they will refer to versions of runtime components that do not generally exist on a deployment machine.
Tips for cleaning up:
- Use MSBuild to debug this problem. R# Build is nice, but not as good as MSBuild for this task.
- Clean and Rebuild to force all warnings
- Check your output carefully.
- Do you see warnings related to package conflicts?
- Ambiguities?
- Do you see the path
C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461in the output?
A sample warning message:
[ResolvePackageFileConflicts] Encountered conflict between 'Platform:System.Collections.dll' and 'CopyLocal:C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461\lib\System.Collections.dll'. Choosing 'CopyLocal:C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461\lib\System.Collections.dll' because AssemblyVersion '4.0.11.0' is greater than '4.0.10.0'.
The Solution
As mentioned above, but reiterated here, this what I did to finally stabilize my applications:
- Remove the C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\Microsoft\Microsoft.NET.Build.Extensions\net461\ directory
- Remove all System* binding redirects
- Clean out all bin/ and obj/ folders
- Delete the .vs folder (may not be strictly necessary)
- Build in Visual Studio
- Observe that a few binding-redirect warnings appear
- Double-click them to re-add the binding redirects, but this time to actual 4.6.2 versions (you may need to add
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>to your project) - Rebuild and verify that you have no more warnings
- Deploy and TADA!
One more thing
When you install any update of Visual Studio, it will silently repair these missing files for you. So be aware and check the folder after any installations or upgrades to make sure that the problem doesn't creep up on you again.
Use Case
I just ran into an issue recently where a concrete implementation registered as a singleton was suddenly not registered as a singleton because of architectural changes.
The changes involved creating mini-applications within a main application, each of which has its own IOC. Instead of creating controllers using the main application, I was now creating controllers with the mini-application instead (to support multi-tenancy, of which more in an upcoming post).
Silent Replacement of Singleton with Transient
Controllers are, by their nature, transient; a new controller is created to handle each incoming request.
In the original architecture, the concrete singleton was injected into the controller and all controller instances used the same shared instance. In the new architecture, the registration was not present in the mini-application (at first), which led to a (relatively) subtle bug: a transient and freshly created instance was injected into each new controller.
In cases where the singleton is a stateless algorithm, this wouldn't be a logical problem at all. At the very worst, you're over-allocating---but you probably wouldn't notice that, either. In this case, the singleton was a settings object, configured at application startup. The configured object was still in the main application's IOC, but not registered in the mini-application's IOC.
Because the singleton was registered on a concrete type rather than an interface, the semantic error occurred silently instead of throwing a lifestyle-mismatch or unregistered-interface exception.
A Straightforward Fix
This is only one of the reasons that I recommend using interfaces as the anchoring type of an IOC registration.
To fix the issue, I did exactly this: I extracted an interface from the class and used the interface everywhere (except for the implementing type of the registration). Re-running the test caused an immediate exception rather than a strange data bug (which resulted because the default configuration in the concrete type was just correct enough to allow it to limp to a result).
To show an example, instead of the following,
application.RegisterSingle<ApiSettings>()
I used,
application.RegisterSingle<IApiSettings, ApiSettings>()
This still didn't fix the crash because the mini-application doesn't get that registration automatically.
I also can't use the same registration as above because that would just create a new unconfigured ApiSettings in each mini-application (the same as I had before, but now as a singleton). To go that route, I would have to replicate the configuration-loading for the ApiSettings as well. And I don't want to do that.
Instead, I just injected the IApiSettings from the main application to the component responsible for creating the mini-application and registered the object as a singleton directly, as shown below.
public class MiniApplicationFactory
{
public MiniApplicationFactory([NotNull] IApiSettings apiSettings)
{
if (apiSettings = null) { throw new ArgumentNullException(nameof(apiSettings(); }
_apiSettings = apiSettings;
}
IApplication CreateApplication()
{
return new Application().UseRegisterSingle(_apiSettings);
}
[NotNull]
private readonly IApiSettings _apiSettings;
}
On a side note, whereas C# syntax has become more concise and powerful from version to version, I still think it has a way to go in terms of terseness for such simple objects. For such things, Kotlin and TypeScript nicely illustrate what such a syntax could look like.1
Other Drawbacks
I mentioned above that this is only "one" of the reasons I don't like registering concrete singletons. The other two reasons are:
- Complicates replacement: If the registered type is a concrete instance, then any replacement must inherit from this instance. The base class has to be constructed more carefully in order to allow for all foreseeable customizations. With an interface, the implementor is completely free to either use the existing class as a base or to re-implement the interface entirely.
- Limits Mocking: Related to the first reason is that mocking is limited in its ability to override non-virtual methods. Even without a mocking library, you're just as hard-pressed to work around unwanted behavior in a hand-coded mock as you are with an actual replacement (as described above). Such limitations are non-existent with interfaces.
-
I'm still waiting for C# to clean up a bit more of this syntax for me. The
[NotNull]should be a language feature checked by the compiler so that theArgumentNullExceptionis no longer needed. On top of that, I'd like to see parameter properties, as in TypeScript (this is where you can prefix a constructor parameter with a keyword to declare and initialize it as a property). With a few more C#-language iterations that included non-nullable reference types and parameter properties, the example could look like the code below:public class MiniApplicationFactory { public MiniApplicationFactory(private IApiSettings apiSettings) { } IApplication CreateApplication() { return new Application().UseRegistereSingle(apiSettings); } }
In recent articles, we outlined a roadmap to .NET Standard and .NET Core and a roadmap for deployment and debugging. These two roadmaps taken together illustrate our plans to extend as much of Quino as possible to other platforms (.NET Standard/Core) and to make development with Quino as convenient as possible (getting/upgrading/debugging).
To round it off, we've made good progress on another vital piece of any framework: documentation.
Introducing docs.encodo.ch
We recently set up a new server to host Quino documentation. There, you can find documentation for current releases. Going forward, we'll also retain documentation for any past releases.
We're generating our documentation with DocFX, which is the same system that powers Microsoft's own documentation web site. We've integrated documentation-generation as a build step in Quino's nightly build on TeamCity, so it's updated every night (Zürich time) 1.
The documentation includes conceptual documentation which provides an overview/tutorials/FAQ for basic concepts in Quino. The API Reference includes comprehensive documentation about the types and methods available in Quino.
Next Steps
While we're happy to announce that we have publicly available documentation for Quino, we're aware that we've got work to do. The next steps are:
- Improve and extend conceptual documentation (QNO-3452, QNO-3453, QNO-3985, QNO-5282, QNO-5283, QNO-5284, QNO-5286, QNO-5391, QNO-5528, QNO-5544, QNO-5562, QNO-5813, QNO-5912 )
- Improve the search for API documentation to include members as well as types (QNO-5934)
- Integrate documentation for the newly created/separated Quino-WebApi repository (IT-1293)
- Retain documentation for the soon-to-be-split-off Quino-Windows repository (QNO-5904)
Even though there's still work to do, this is a big step in the right direction. We're very happy to have found DocFX, which is a very comprehensive, fast and nice-looking solution to generating documentation for .NET code.2
--
-
If the build succeeds, naturally. :-)↩
-
We used to use Sandcastle many years ago, but dropped support because it took forever to generate documentation, required its own solution file, didn't look very nice out-of-the-box, wasn't so easily customized and didn't have a very good search (which also didn't work without an IIS running it).↩
In a recent article, we outlined a roadmap to .NET Standard and .NET Core. We've made really good progress on that front: we have a branch of Quino-Standard that targets .NET Standard for class libraries and .NET Core for utilities and tests. So far, we've smoke-tested these packages with Quino-WebApi. Our next steps there are to convert Quino-WebApi to .NET Standard and .NET Core as well. We'll let you know when it's ready, but progress is steady and promising.
With so much progress on several fronts, we want to address how we get Quino from our servers to our customers and users.
Getting Quino
Currently, we provide access to a private fileshare for customers. They download the NuGet packages for the release they want. They copy these to a local folder and bind it as a NuGet source for their installations.
In order to make a build available to customers, we have to publish that build by deploying it and copying the files to our file share. This process has been streamlined considerably so that it really just involves telling our CI server (TeamCity) to deploy a new release (official or pre-). From there, we download the ZIP and copy it to the fileshare.
Encodo developers don't have to use the fileshare because we can pull packages directly from TeamCity as soon as they're available. This is a much more comfortable experience and feels much more like working with nuget.org directly.
Debugging Quino
The debugging story with external code in .NET is much better than it used to be (spoiler: it was almost impossible, even with Microsoft sources), but it's not as smooth as it should be. This is mostly because NuGet started out as a packaging mechanism for binary dependencies published by vendors with proprietary/commerical products. It's only in recent year(s) that packages are predominantly open-source.
In fact, debugging with third-party sources – even without NuGet involved – has never been easy with .NET/Visual Studio.
Currently, all Quino developers must download the sources separately (also available from TeamCity or the file-share) in order to use source-level debugging.
Binding these sources to the debugger is relatively straightforward but cumbersome. Binding these sources to ReSharper is even more cumbersome and somewhat unreliable, to boot. I've created the issue Add an option to let the user search for external sources explicitly (as with the VS debugger) when navigating in the hopes that this will improve in a future version. JetBrains has already fixed one of my issues in this are (Navigate to interface/enum/non-method symbol in Nuget-package assembly does not use external sources), so I'm hopeful that they'll appreciate this suggestion, as well.
The use case I cited in the issue above is,
Developers using NuGet packages that include sources or for which sources are available want to set breakpoints in third-party source code. Ideally, a developer would be able to use R# to navigate through these sources (e.g. via F12) to drill down into the code and set a breakpoint that will actually be triggered in the debugger.
As it is, navigation in these sources is so spotty that you often end up in decompiled code and are forced to use the file-explorer in Windows to find the file and then drag/drop it to Visual Studio where you can set a breakpoint that will work.
The gist of the solution I propose is to have R# ask the user where missing sources are before decompiling (as the Visual Studio debugger does).
Nuget Protocol v3 to the rescue?
There is hope on the horizon, though: Nuget is going to address the debugging/symbols/sources workflow in an upcoming release. The overview is at NuGet Package Debugging & Symbols Improvements and the issue is Improve NuGet package debugging and symbols experience.
Once this feature lands, Visual Studio will offer seamless support for debugging packages hosted on nuget.org. Since we're using TeamCity to host our packages, we need JetBrains to [Add support for NuGet Server API v3|https://youtrack.jetbrains.com/issue/TW-47289] in order to benefit from the improved experience. Currently, our customers are out of luck even if JetBrains releases simultaneously (because our TeamCity is not available publicly).
Quino goes public?
I've created an issue for Quino, Make Quino Nuget packages available publicly to track our progress in providing Quino packages to our customers in a more convenient way that also benefits from improvements to the debugging workflow with Nuget Packages.
If we published Quino packages to NuGet (or MyGet, which allows private packages), then we would have the benefit of the latest Nuget protocol/improvements for both ourselves and our customers as soon as it's available. Alternatively, we could also proxy our TeamCity feed publicly. We're still considering our options there.
As you can see, we're always thinking about the development experience for both our developers and our customers. We're fine-tuning on several fronts to make developing and debugging with Quino a seamless experience for all developers on all platforms.
We'll keep you posted.