Dependencies Guide

This document describes policies for keeping Unomi dependencies up to date.

Old dependencies cause user pain and can result in a system being unusable for some users. Many users do not use Unomi in isolation and bundle other dependencies in the same deployment. These additional dependencies might pull in incompatible dependencies to user?????™s environment which can again result in broken Unomi pipelines, sometimes with undefined behavior. To prevent this, users will have to update their deployment environment or worse yet may end up not being able to use Unomi along with some of the other dependencies at all.

If a component X chooses to override the version of a dependency D from a to b and another component Y is incompatible with version b of D, deployment of a user that uses both components X and Y will end up in a broken state.

A similar issue could arise if two dependencies of Unomi depend on a common library but use incompatible versions of that library.

Also, users might not use Unomi in isolation, a user that depends on Unomi as well as other libraries in the same environment might run into similar issues if Unomi and the other library share a dependency while using incompatible versions.

This picture can become even more complicated during runtime. Runner specific code might be incompatible with dependencies included by certain modules and if these dependencies leak into runtime, a pipeline might end up in a broken state.

The overall issue is not common to Unomi and well known in the industry as the Diamond Dependency problem (or Dependency Hell).

One common solution for the diamond dependency problem is semantic versioning. The basic idea is that dependencies will be versioned in the form x.y.z where x is the major version, y is the minor version, and z is the patch version. A major version change may be backwards incompatible and is expected to be rare. Minor and patch versions may be released more regularly but are expected to be backwards compatible. But in practice, important fixes (such as security patches) might get released in the form of minor or patch version updates and it will be healthy for the Unomi project to depend on recently released minor versions of dependencies.

Identifying outdated dependencies

A big part of keeping dependencies up to date involves identifying outdated dependencies of Unomi that the community should try to upgrade.

Unomi currently executes a weekly Jenkins job that tries to identify outdated dependencies for various SDKs. This Jenkins job generates a weekly report that is shared in Unomi dev list.

In addition to this, Unomi community members might identify other critical dependency updates that have to be manually performed. For example,

  • A minor release of a dependency due to a critical security vulnerability.
  • A dependency conflict that was was triggered by a minor version release of a Unomi dependency (this does not apply to Java SDK that depends on exact minor versions of dependencies).

These kind of urgently required upgrades might not get automatically picked up by the Jenkins job for few months. So Unomi community has to act to identify such issues and perform upgrades early.

JIRA Automation

In order to track the dependency upgrade process, JIRA tickets will be created per significant outdated dependency based on the report. A bot named Unomi Jira Bot was created for managing JIRA issues. Unomi community agrees on the following policies that creates and updates issues.

  • Issues will be named as "Unomi Dependency Update Request: "
  • Issues will be created under the component dependencies
  • If more than one owners found for a dependency, the first owner will be picked as the primary owner, the others will be pinged in the issue description.
  • If no owners found, leave the assignee empty. The component lead is responsible for triaging the issue.
  • Avoid creating duplicate issues. Updating the descriptions of the open issues created by the previous dependency check.
  • The dependency sometimes is not able to be upgraded, the issue should be closed as "won't fix". And, the bot should avoid recreating issues with "won't fix".

Upgrading identified outdated dependencies

After outdated dependencies are identified, Unomi community has to act to upgrade the dependencies regularly. Unomi community has agreed on following policies regarding upgrading dependencies.

Human readable reports on status of Unomi dependencies are generated weekly by an automated Jenkins job and shared with the Unomi community through the dev list.

These reports should be concise and should highlight the cases where the community has to act on.

Unomi components should define dependencies and their versions at the top level. There can be rare exceptions, but they should come with explanations.

Components include various Unomi runners, IO connectors, etc. Component-level dependency version declarations should only be performed in rare cases and should come with a comment explaining the reasoning for overriding the dependency. For example, dependencies specific to a runner that are unlikely to be utilized by other components might be defined at the runner.

A significantly outdated dependency (identified manually or through the automated Jenkins job) should result in a JIRA that is a blocker for the next release. Release manager may choose to push the blocker to the subsequent release or downgrade from a blocker.

This will be a blocker for next major and minor version releases of Unomi. JIRA may be created automatically or manually.

For manually identified critical dependency updates, Unomi community members should create blocking JIRAs for next release. In addition to this Unomi community members may trigger patch releases for any critical dependency fixes that should be made available to users urgently.

Dependency declarations may identify owners that are responsible for upgrading respective dependencies.

Owners can be mentioned in the yaml files. Blocking JIRAs will be initially assigned to these owners (if available). Release manager may choose to re-assign these JIRAs. A dependency may have more than one declared owner and in this case the JIRA will be assigned to one of the owners mentioned.

Dependencies of Java SDK components that may cause issues to other components if leaked should be vendored.

Vendoring is the process of creating copies of third party dependencies. Combined with repackaging, vendoring will allow Unomi components to depend on third party libraries without causing conflicts to other components. Vendoring should be done in a case-by-case basis since this can increase the total number of dependencies deployed in user?????™s enviroment.

Dependency updates and backwards compatibility

Unomi releases adhere to semantic versioning. Hence, community members should take care when updating dependencies. Minor version updates to dependencies should be backwards compatible in most cases. Some updates to dependencies though may result in backwards incompatible API or functionality changes to Unomi. PR reviewers and committers should take care to detect any dependency updates that could potentially introduce backwards incompatible changes to Unomi before merging and PRs that update dependencies should include a statement regarding this verification in the form of a PR comment. Dependency updates that result in backwards incompatible changes to non-experimental features of Unomi should be held till next major version release of Unomi.

Any exceptions to this policy should only occur in extreme cases (for example, due to a security vulnerability of an existing dependency that is only fixed in a subsequent major version) and should be discussed in the Unomi dev list. Note that backwards incompatible changes to experimental features may be introduced in a minor version release.