The DSpace 7 Project–A Simple Summary
From Tim Donohue, DSpace Tech Lead and the DSpace 7 UI Outreach Group. DSpace 7 development will be highlighted at OR2017 next month including demonstrations. Recordings and slides from the recent Hot Topics webinar series, "Introducing DSpace 7: Next Generation UI" are available here.
Background to the DSpace 7 project
- Starting in 2015, a DSpace 2015-18 Strategic Plan was created/adopted, along with a Technical RoadMap. For more details see: 2015 Strategic Planning Activities and the OR2015 presentation "DSpace Technology Roadmap"
- The #1 priority on that RoadMap was to adopt a new, single User Interface (to replace the aging JSPUI and XMLUI).
- In late 2015, a DSpace UI Prototype Working Group was established to develop/create a DSpace UI Prototype Challenge. The goal of this challenge was to hold a "friendly competition" to prototype several different technologies for a new, single User Interface. The Prototype Challenge ended in Dec 2015.
- In early 2016, the DSpace UI Prototype Working Group began analyzing the 9 submitted UI Prototypes, and put out several calls for feedback from the broad community. See also 2016 Strategic Planning Activities.
- During this activity/analysis, we discovered that the Angular 2 platform had been released (in beta) in Dec 2015. While one Prototype featured Angular v1, we had several concerns (namely Search Engine Optimization and accessibility) with Angular 1. The Angular 2 release promised to support both SEO and accessibility
- Steering and Leadership saw great promise in a Client Side UI built on Angular 2. But, no one was comfortable with finalizing that decision without a proof of concept.
- Immediately after the Summit, four institutions (DuraSpace, Atmire, Texas A&M and Cineca) decided to collaboratively build a rapid proof of concept / prototype UI on Angular 2.
- From March to June, the four institutions publicly collaborated to build a basic, proof-of-concept Angular 2 UI against the DSpace 5 REST API
- During this prototyping, it was discovered that our REST API was lacking in features, and was not currently capable of supporting a full-fledged client side UI.
- By late May / early June, the group presented findings on Angular 2 to the DSpace Steering/Leadership Groups. Both groups approved of the direction.
- In June, at OR2016, the proof-of-concept Angular UI was presented/demoed. See the OR2016 presentation "Introducing the New DSpace User Interface"
- (From June until November 2016, developer concentration moved over to getting DSpace 6.0released. DSpace 6 is the final release to include the JSPUI and XMLUI.)
- In late 2016 / early 2017, a DSpace 7 UI Working Group was established to formalize the process of building a new Angular2 UI and enhanced REST API for the DSpace 7.0 release.
- Early in 2017, this UI Working Group has concentrated on planning out the architecture (especially for the enhanced REST API) and building the "framework" for the Angular UI.
- In parallel, a DSpace 7 UI Outreach Group was established to help with outreach, and update/capture use cases needed to be met by the new UI. See: Use Cases
There are several reasons Angular 2 caught our immediate attention when it was beta released in late 2015 (For more on some of these see: https://angular.io/features.html)
- Angular 2 supports Search Engine Optimization (SEO). In other words, applications built with Angular 2 can be easily indexed/searched by Google or Google Scholar (NOTE: we verified this by running a series of tests with Google Scholar team).
- Better separation of concerns between UI and backend. Building the user interface on a client side technology forces a distinct separation between server-side (backend) code and the user interface. While this separation is not required, it is a best practice. It also has the advantage of allowing the UI to potentially run on a separate server from the backend (REST API).
- Better / enhanced REST API (for future integrations). While DSpace has had a REST API since DSpace 4.0, this REST API is very limited in functionality and practical use cases. Building a client-side application requires a stable, well-documented REST API that provides all necessary UI features/functionality. A fully featured REST API also has a secondary benefit of providing an easier path towards future integrations with DSpace (by other third-party platforms or plugins).
- Innovative / exciting. No software platform can last forever without continual modernization / enhancements based on the latest technologies. DSpace is no different. Both of the existing UIs are outdated. (While it has received recent code refactoring, the JSPUI was initially released in 2002. The XMLUI was released in 2008, but relies on an unmaintained, nearly obsolete, Apache Cocoon framework.) Updating DSpace to use modern technologies will not only improve the user experience and UI development processes, it'll also help us get newer developers involved and excited about DSpace.
Why are we re-building the REST API?
While DSpace has had a REST API since DSpace 4.0, this REST API is very limited in functionality and practical use cases:
- 4.x REST API is read-only.
- 5.x - 6.x REST API allows for basic read/write functionality. However, many other UI features are still lacking, including:
- All administrative functionality (i.e. anything in Admin UI screens)
- Search/Browse via Solr (including browse by facets)
- Submission Process (You can manually create new Items and add metadata via the REST API, but it is not a staged process and requires a large number of requests to complete)
In addition, the existing REST API has the following disadvantages:
- While it is a decent, first-try at a REST API, it does not follow any modern best practices for REST APIs (e.g. HATEOAS (Hypertext As The Engine Of Application State), ALPS (Application Level Profile Semantics), etc)
- Similar to the first point, the REST API is mostly "handcrafted", custom code (i.e. it defines its own response syntaxes, not based on any widely adopted standards). While it does provide basic documentation on those responses, there is no formal REST "contract" (a contract is detailed documentation on how a REST API "promises" to interact with any external system)
- It uses a third-party library (Jersey) that is not widely used in the DSpace codebase, and does not provide the modern best practices mentioned above.
Therefore, we have decided to rebuild the REST API for the following benefits:
- We can update it to follow modern best practices such as HATEOAS (Hypertext As The Engine Of Application State), ALPS (Application Level Profile Semantics), and using the HAL (Hypertext Application Language) response format.
- Updating to use these best practices would make our REST API easier to understand, and allow widely-used third-party tools to immediately interact with it (e.g. a HAL Browser exists which can parse/respond to any REST API that uses the HAL response format). Since our current REST API is completely custom, no third-party tools exist that can interact with it immediately.
- We can update it to use modern technologies (such as those provided by the Spring Framework)
- As of DSpace 6, the DSpace Java API now uses Spring technologies throughout. There are newer Spring technologies that allow us to more easily implement modern REST API best practices (e.g. Spring HATEOAS). So, rather than building our REST API in a custom manner, we can rely on third-party, Spring libraries to implement these REST API best practices.
- We can more easily enhance and maintain it.
- Updating our technologies and using third-party libraries (like Spring Framework libraries) to achieve best practices also will make our REST API codebase easier to manage and maintain in the long run. Less of our code will be custom, and we'll be able to receive enhancements/improvements from the widely used Spring libraries.
Keep in mind, if you have local, custom tools or applications that already make use of the (existing) DSpace REST API, they will need updating once this new REST API is released (as we get further along, documentation will be provided). However, if you do not currently make use of the REST API, these REST API changes will have no effect on you (other than to provide the backend that the new Angular UI).
What's been done so far?
As of March 2017, both the new REST API and the Angular UI are still in their "infancy". Much of early 2017 was spent hashing out how the new REST API would be built, and beginning to build mockups of that REST API, which the Angular team is basing early development on. However, both projects will begin taking larger steps in the very near future as we work towards a goal of a basic alpha-level demo of search/browse functionality by OR2017 in June.
During early 2017, much of the REST API work was around analyzing REST API technologies and best practices to determine whether we truly needed to rebuild our REST API, or whether we could "morph" the existing REST API to meet the needs of the Angular UI. In the end, for the reasons detailed above, we've decided a new REST API will be the easier route for the long term. This team has begun laying the groundwork/foundation of the new REST API. This work is progressing in the following areas:
- The REST API codebase is in the main codebase at: https://github.com/DSpace/DSpace/tree/rest7
- Updates / ongoing discussions occur on Slack (#rest-api channel) and weekly meetings. See notes at DSpace 7 UI Working Group
During early 2017, much of the Angular UI work revolved around building out the groundwork (in Angular) to support the new REST API, and beginning to create interactions with a "mock" (i.e. faked) REST API. As the new REST API is still in very active development, the Angular team has had to develop against faked versions (until the real one is far enough along to interact with). This work is progressing in the following areas: