Skip to content

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

  • Create a post endpoint for statements implementing the LRS spec

Changed

  • Upgrade bclick to 3.2.2
  • Upgrade click to 8.1.3
  • Upgrade elasticsearch to 8.2.0
  • Upgrade fastapi to 0.78.0
  • Upgrade Jinja2 to 3.1.2
  • Upgrade ovh to 1.0.0
  • Upgrade pyparsing to 3.0.9
  • Upgrade python-swiftclient to 3.13.1
  • Upgrade sentry_sdk to 1.5.12
  • Upgrade uvicorn to 0.17.6
  • Upgrade websockets to 10.3
  • Make backends yield results instead of writing to standard streams

Fixed

  • Tray: do not create a cronjobs list when no cronjob has been defined

2.1.0 - 2022-04-13

Added

  • Implement edx problem interaction events pydantic models
  • Implement edx textbook interaction events pydantic models
  • ws websocket stream backend (compatible with the fetch command)
  • bundle jq, curl and wget in the fundocker/ralph Docker image
  • Tray: enable ralph app deployment command configuration
  • Add a runserver command with basic auth and a whoami route
  • Create a get endpoint for statements implementing the LRS spec
  • Add optional fields to BaseXapiModel

Changed

  • Upgrade uvicorn to 0.17.4
  • Upgrade elasticsearch to 7.17.0
  • Upgrade sentry_sdk to 1.5.5
  • Upgrade fastapi to 0.73.0
  • Upgrade pyparsing to 3.0.7
  • Upgrade pydantic to 1.9.0
  • Upgrade python-keystoneclient to 4.4.0
  • Upgrade python-swiftclient to 3.13.0
  • Upgrade pyyaml to 6.0
  • Upgrade requests to 2.27.1
  • Upgrade websockets to 10.1

2.0.1 - 2021-07-15

Changed

  • Upgrade elasticsearch to 7.13.3

Fixed

  • Restore elasticsearch backend datastream compatibility for bulk operations

2.0.0 - 2021-07-09

Added

  • xAPI video interacted pydantic models
  • xAPI video terminated pydantic models
  • xAPI video completed pydantic models
  • xAPI video seeked pydantic models
  • xAPI video initialized pydantic models
  • xAPI video paused pydantic models
  • convert command to transform edx events to xAPI format
  • EdX to xAPI converters for page viewed andpage_close events
  • Implement core event format converter
  • xAPI video played pydantic models
  • xAPI page viewed and page terminated pydantic models
  • Implement edx navigational events pydantic models
  • Implement edx enrollment events pydantic models
  • Install security updates in project Docker images
  • Model selector to retrieve associated pydantic model of a given event
  • validate command to lint edx events using pydantic models
  • Support all available bulk operation types for the elasticsearch backend (create, index, update, delete) using the --es-op-type option

Changed

  • Upgrade elasticsearch to 7.13.2
  • Upgrade python-swiftclient to 3.12.0
  • Upgrade click to 8.0.1
  • Upgrade click-option-group to 0.5.3
  • Upgrade pydantic to 1.8.2
  • Upgrade sentry_sdk to 1.1.0
  • Rename edx models
  • Migrate model tests from factories to hypothesis strategies
  • Tray: switch from openshift to k8s (BC)
  • Tray: remove useless deployment probes

Fixed

  • Tray: remove version immutable field in DC selector

1.2.0 - 2021-02-26

Added

  • EdX server event pydantic model and factory
  • EdX page_close browser event pydantic model and factory
  • Tray: allow to specify a self-generated elasticsearch cluster CA certificate

Fixed

  • Tray: add missing Swift variables in the secret
  • Tray: fix pods anti-affinity selector

Removed

  • pandas is no longer required

1.1.0 - 2021-02-04

Added

  • Support for Swift storage backend
  • Use the push command --ignore-errors option to ignore ES bulk import errors
  • The elasticsearch backend now accepts passing all supported client options

Changed

  • Upgrade pyyaml to 5.4.1
  • Upgrade pandas to 1.2.1

Removed

  • click_log is no longer required as we are able to configure logging

1.0.0 - 2021-01-13

Added

  • Implement base CLI commands (list, extract, fetch & push) for supported backends
  • Support for ElasticSearch database backend
  • Support for LDP storage backend
  • Support for FS storage backend
  • Parse (gzipped) tracking logs in GELF format
  • Support for application’s configuration file
  • Add optional sentry integration
  • Distribute Arnold’s tray to deploy Ralph in a k8s cluster as cronjobs