Skip to content

CHANGELOG.md

Latest commit

 

History

History
237 lines (153 loc) · 7.94 KB

CHANGELOG.md

File metadata and controls

237 lines (153 loc) · 7.94 KB

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

0.18.0 - 2026-04-16

Changed

  • Include :children IDs to the "document" node for the flat parse result.

  • Collapse consecutive text nodes. This is going to produce less nodes.

  • Refactor the implementation of the tree sink to use an arena for faster allocations, as one of the html5ever's examples demonstrates.

    See the example in https://github.com/servo/html5ever/blob/ce64836c685025a5fef0860fa2e9c80b2683e8d0/html5ever/examples/arena.rs This change only affects the API by including the "Process Instruction" nodes (:pi). In terms of performance, it does not change much (from Floki's performance tests).

  • Update html5ever dependency. This should affect the parsed HTML documents, as it is a huge bump in the version - from 0.27 to 0.39.

Removed

  • Remove support for Elixir v1.14.

0.17.0 - 2025-08-15

Changed

  • Require at least Rustler v0.36.0

  • Require at least RustlerPrecompiled v0.8. This is dropping support for versions 0.6 and 0.7 of that dependency.

  • Use newer versions of OS images to build the precompiled artifacts. Some of the images we were using are deprecated. Updated ubuntu-20.04 to ubuntu-22.04, macos-11 to macos-13 and windows-2019 to windows-2022. Those changes may break systems running in older versions of the related operational system.

Removed

  • Remove support for Elixir 1.13.

0.16.1 - 2024-05-15

Fixed

  • Fix parsing of HTML documents that may start with a comment or an XML doc tag.

0.16.0 - 2024-03-25

Fixed

  • Fix parsing of comments in parse/1.
  • Avoid panic when parsing content with the "template" tag.

Removed

  • Drop support for Elixir 1.12

0.15.0 - 2023-06-16

Added

  • Add two new functions to parse documents:

    • parse_with_attributes_as_maps/1
    • flat_parse_with_attributes_as_maps/1

    And as the names suggest, it returns a document tree with attributes as maps, instead of lists of pairs. These functions are useful to match node attributes, since the order of attributes does not matter must of the times.

Fixed

  • Use dirty CPU scheduler for all functions. For some reason we were using a normal scheduler, but this could cause instability.

    With a dirty scheduler we can parse medium to big files without worry about lengthy work. Please read https://www.erlang.org/doc/man/erl_nif.html#lengthy_work for further information.

Removed

  • Remove support for Elixir 1.11.

0.14.3 - 2023-05-26

Added

  • Add precompilation target for Linux running on RISC-V 64 bits machines. This is useful for projects using Nerves.

    Note that this is going to require rustler_precompiled v0.6 or above, since the that version includes RISC-V on Linux as defaults.

  • Add support for OTP 26 by updating the rustler-sys package.

0.14.2 - 2023-05-20

Added

  • Add precompilation target for Linux running on ARM64 machines (both musl and gnu ABI). This is useful for projects using Nerves.

    Note that this is going to require rustler_precompiled v0.6 or above, since the that version includes ARM64 on Linux as defaults.

0.14.1 - 2023-05-20

Added

  • Add support for rustler_precompiled v0.6.

Changed

  • Update Rustler version in the crate from v0.26 to v0.28. This shouldn't break anything, but would require the installation of rustler v0.28 if needed in the Elixir side.

  • Change the Rust edition to 2021 (it was 2018). This shouldn't change any behaviour.

0.14.0 - 2022-11-04

Changed

  • Require rustler_precompiled equal or above v0.5.2 - thanks @Benjamin-Philip.
  • Use Application.compile_env/3 instead of Application.get_env/3 in the native module.

0.13.1 - 2022-06-24

Fixed

  • Fix the precompilation build for targets using cross by adding a Cross.toml file with a setting telling to read the RUSTLER_NIF_VERSION env var from the host machine.

0.13.0 - 2022-04-28

Changed

  • Bump requirement for rustler_precompiled to ~> v0.4. This is needed to avoid installing Rustler by default.
  • Bump html5ever (Rust crate) to v0.26.0.

0.12.0 - 2022-03-14

Changed

0.11.0 - 2021-12-15

Security

  • Add checksum verification of precompiled NIF files before extracting them to the correct location. This is to avoid supply chain attacks. With this change we added a new mix task to download all the files and generate the checksum before publishing the package. Additionally the user can download only the local NIF file with the checksum. See the RELEASE_CHECKLIST.md file for details on how we ensure this works correctly.

Removed

  • Remove support for Elixir 1.10 and below. This is to keep a policy of supporting the latest three Elixir versions.

Changed

  • Switch from thread pool to being a dirty NIF. This prevents the resulting term from having to be sent between processes, and therefore prevents an extra copy from having to be performed.
  • In the FlatSink implementation for the NIF, track children in a pool instead of allocating new vectors for every node. This significantly reduces allocator pressure while parsing, and improves performance.
  • When converting a parsed FlatSink into its term representation, use a common child node stack instead of allocating a new one for every node. This significantly reduces allocator pressure while creating terms, and improves performance.
  • Start using LTO for the NIF compilation. This reduces the build size and improves performance.

Fixed

  • Fix the target selection when using TARGET_* env vars on macOS.

0.10.1 - 2021-11-24

Fixed

  • It provides a precompiled NIF for ARM 64 bits running on Linux. This is needed for Raspberry PI 4.

0.10.0 - 2021-11-24

Added

  • Add the ability to download precompiled NIFs. We provide compiled NIF files in our GitHub releases page (from GitHub Actions) and the lib will try to download the correct NIF respecting the OS, NIF version and architecture of your build machine. This also works for Nerves projects that compiles to different targets. This way the Rust toolchain is not needed for most of people using this project.

Fixed

  • Fix compilation on macOS.

0.9.0 - 2021-10-02

Added

  • Add support for OTP 24. This was achieved by updating Rustler to v0.22.