Include an arm64 shared library in the ruby gem (#1733)

* Update nokogiri to version with support for apple silicon

* Update gem dependencies to address spec failures running with Ruby 3

* Require ActiveRecordAdapter from spec that uses it

* Add support for both x86_64 and arm64 linux architectures

* Build both x86 and arm dynamic libraries for ruby

* Use Ruby 2.6 as minimum tested version and 3.2 for all ruby-related tasks

Rationale: 2.6.10 is what ships with macOS 14.0 even though support for it
stopped in March of 2022 and 3.2 is the latest stable version.

* Ensure the ruby libs are copied and available for testing

* Bump solargraph and rubocop

Disable new cops for existing violations

* Update bundler to get rid of SPELL_CHECKERS warning

* Do not suggest extensions

* Simplify YARD docs for query method

Add the host and bindings parameters so calls that contain them don't fail typecheck

* Must use Ruby 2.4 in order to build the docs on main

* Must use Ruby 2.4 in order to build the docs on main

* Use .ruby-version instead of hard-coding the current ruby version in Github actions

The rationale for this is from the way that docs diffing works. Both the base branch and the new branch need to be able to build using the version of Ruby supported by that branch. Without this change, when a PR is introduced that updates the target Ruby version, a followup PR will be required to update the github action for building the 'base' branch's version of the docs. With this change, github actions will choose the version of Ruby targeted by the branch it is trying to build

* Clippy

* Cargo fmt

* Test

* Try building aarch64 first

Seeing if
[this](cross-rs/cross#724 (comment))
is a quick fix so I can avoid any deeper debugging.

* Keep shuffling the deck chairs

* Revert "Test"

This reverts commit 7feebd1.

* Add 0.27.3 changelog

* Bump version

* Let's just release now instead

---------

Co-authored-by: Gabe Jackson <17556281+gj@users.noreply.github.com>

.github/workflows/docs-diff.yml

@@ -49,7 +49,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Install yard
@@ -84,7 +83,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.79.1'
+          hugo-version: "0.79.1"
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Build Hugo docs
         env:
@@ -136,7 +135,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
+          ruby-version: "2.7"
           working-directory: "languages/ruby"
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Install yard
@@ -171,7 +170,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.79.1'
+          hugo-version: "0.79.1"
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Build Hugo docs
         env:

.github/workflows/docs-preview.yml

@@ -31,7 +31,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
       - name: Install yard
         run: gem install yard
@@ -61,7 +60,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.79.1'
+          hugo-version: "0.79.1"
       - name: Get branch name (branch)
         if: github.event_name != 'pull_request'
         shell: bash

.github/workflows/publish-docs.yml

@@ -6,7 +6,7 @@ on:
         description: "docs s3 path (docs.oso.dev or docs-preview.oso.dev)"
       oso_version:
         description: "oso release to build docs for"
-        default: "0.27.2" # oso_version
+        default: "0.27.3" # oso_version
       flask_oso_version:
         description: "flask oso release to build docs for"
         default: "0.27.1" # flask_oso_version
@@ -49,7 +49,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
       - name: Install yard
         run: gem install yard

.github/workflows/publish.yml

@@ -108,7 +108,7 @@ jobs:
       - name: Set up ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: "3.2"
           working-directory: "languages/ruby"
       - run: gem push oso-oso-${{ github.event.inputs.version }}.gem
         working-directory: "oso-ruby-${{ github.event.inputs.version }}"

.github/workflows/release.yml

@@ -55,31 +55,42 @@ jobs:
           profile: minimal
           toolchain: 1.69.0
           override: true
-      - name: Build release libraries
-        run: cargo build --release -p polar-c-api
-      - name: Build x86_64 release musl library
-        run: |
-          rustup target add x86_64-unknown-linux-musl
-          RUSTFLAGS="-C target-feature=-crt-static" cargo build --target x86_64-unknown-linux-musl --release -p polar-c-api
-      - name: Download cross
+      - name: Install cross
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release download --repo cross-rs/cross --pattern 'cross-x86_64-unknown-linux-gnu\.tar\.gz'
+        run: |
+          gh release download --repo cross-rs/cross --pattern 'cross-x86_64-unknown-linux-gnu\.tar\.gz'
+          tar -xzvf cross-x86_64-unknown-linux-gnu.tar.gz
+      - name: Build aarch64 dynamic lib
+        run: |
+          rustup target add aarch64-unknown-linux-gnu
+          RUSTFLAGS="-C target-feature=-crt-static" ./cross build --target aarch64-unknown-linux-gnu --release -p polar-c-api
       - name: Build aarch64 release musl library
         run: |
           rustup target add aarch64-unknown-linux-musl
-          tar -xzvf cross-x86_64-unknown-linux-gnu.tar.gz
           RUSTFLAGS="-C target-feature=-crt-static" ./cross build --target aarch64-unknown-linux-musl --release -p polar-c-api
+      - name: Build x86_64 release libraries
+        run: cargo build --release -p polar-c-api
+      - name: Build x86_64 release musl library
+        run: |
+          rustup target add x86_64-unknown-linux-musl
+          RUSTFLAGS="-C target-feature=-crt-static" cargo build --target x86_64-unknown-linux-musl --release -p polar-c-api
       - name: Rename static lib
         run: mv target/release/libpolar.a target/libpolar-${{runner.os}}.a
       - name: Rename x86_64 static lib
         run: mv target/x86_64-unknown-linux-musl/release/libpolar.a target/libpolar-musl-x86_64.a
       - name: Rename aarch64 static lib
         run: mv target/aarch64-unknown-linux-musl/release/libpolar.a target/libpolar-musl-aarch64.a
+      - name: Rename x86_64 dynamic lib
+        run: mv target/release/libpolar.so target/libpolar-x86_64.so
+      - name: Rename aarch64 dynamic lib
+        run: mv target/aarch64-unknown-linux-gnu/release/libpolar.so target/libpolar-aarch64.so
       - uses: actions/upload-artifact@v2
         with:
           name: oso_library
-          path: target/release/libpolar.so
+          path: |
+            target/libpolar-x86_64.so
+            target/libpolar-aarch64.so
       - uses: actions/upload-artifact@v2
         with:
           name: oso_library
@@ -252,7 +263,7 @@ jobs:
       - name: Copy libraries into resources.
         run: |
           mkdir -p languages/java/oso/src/main/resources/linux
-          cp -r oso_library/libpolar.so languages/java/oso/src/main/resources/linux/
+          cp -r oso_library/libpolar-x86_64.so languages/java/oso/src/main/resources/linux/libpolar.so
           mkdir -p languages/java/oso/src/main/resources/macos
           cp -r oso_library/libpolar-macOS-fat.dylib languages/java/oso/src/main/resources/macos/libpolar.dylib
           mkdir -p languages/java/oso/src/main/resources/win
@@ -280,7 +291,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
       - name: Set version env
         id: version
@@ -292,7 +302,8 @@ jobs:
       - name: Copy libraries into resources.
         run: |
           mkdir -p languages/ruby/ext/oso-oso/lib
-          cp -r oso_library/libpolar.so languages/ruby/ext/oso-oso/lib/
+          cp -r oso_library/libpolar-x86_64.so languages/ruby/ext/oso-oso/lib/
+          cp -r oso_library/libpolar-aarch64.so languages/ruby/ext/oso-oso/lib/
           cp -r oso_library/libpolar-macOS-fat.dylib languages/ruby/ext/oso-oso/lib/libpolar.dylib
           cp -r oso_library/polar.dll languages/ruby/ext/oso-oso/lib/
       - name: Test
@@ -689,7 +700,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-11, windows-2019]
-        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
+        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
     steps:
       - uses: actions/checkout@v2
       - name: Set version env
@@ -805,7 +816,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
+          ruby-version: "2.7"
           working-directory: "docs/examples/quickstart/ruby"
       - name: Use Node.js 12
         uses: actions/setup-node@v1

.github/workflows/test.yml

@@ -57,7 +57,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
       - name: Lint Ruby code
         working-directory: "languages/ruby"
@@ -214,7 +213,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '2.7'
           working-directory: "languages/ruby"
       - name: Test ruby
         run: make ruby-test
@@ -350,8 +348,8 @@ jobs:
       - name: Install Ruby + gems
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
           bundler-cache: true
+          working-directory: "languages/ruby"
       - name: Use Node.js 18
         uses: actions/setup-node@v3
         with:
@@ -362,6 +360,8 @@ jobs:
           java-version: "11"
       - name: Build python lib
         run: make python-build
+      - name: Build ruby lib
+        run: make ruby-build
       - name: Python test deps
         run: make -C languages/python/oso test-requirements
       - name: Build js lib

.gitignore

@@ -174,7 +174,6 @@ cython_debug/
 # Java class files
 *.class
 
-.ruby-version
 languages/java/oso/dependency-reduced-pom.xml
 languages/java/oso/src/main/resources/*
 

Makefile

@@ -42,6 +42,9 @@ python-django-test: python-build python-django-build
 python-sqlalchemy-test: python-build
 	$(MAKE) -C languages/python/sqlalchemy-oso test
 
+ruby-build: rust-build
+	$(MAKE) -C languages/ruby copy_lib
+
 ruby-test:
 	$(MAKE) -C languages/ruby test
 
@@ -55,7 +58,7 @@ java-test:
 go-test: rust-build
 	$(MAKE) -C languages/go test
 
-docs-test: python-build
+docs-test: python-build ruby-build
 	$(MAKE) -C docs test
 
 fmt: fmt-java fmt-rust fmt-python fmt-js fmt-go

VERSION

@@ -1 +1 @@
-0.27.2
+0.27.3

docs/content/any/project/changelogs/2024-01-12.md

@@ -0,0 +1,21 @@
+---
+title: Release 2024-01-12
+menuTitle: 2024-01-12
+any: true
+description: >-
+  Changelog for Release 2024-01-12 (0.27.3) containing new features,
+  bug fixes, and more.
+---
+
+## `oso` 0.27.3
+
+### Ruby
+
+#### New features
+
+##### Linux AArch64 support
+
+You can now run the `oso-oso` gem in AArch64 Linux environments, including in
+Docker on Apple silicon.
+
+Thanks to [`@jdeff`](https://github.com/jdeff) for the contribution!

docs/examples/Makefile

@@ -7,7 +7,7 @@ JS_DIR := $(OSO_ROOT)/languages/js
 RUBY_DIR := $(OSO_ROOT)/languages/ruby
 
 # Needed for tests
-JAVA_PACKAGE_JAR_PATH := $(JAVA_DIR)/oso/target/oso-0.27.2.jar
+JAVA_PACKAGE_JAR_PATH := $(JAVA_DIR)/oso/target/oso-0.27.3.jar
 
 # Note: if you are using bundler in a sub-makefile (in a docs test for example),
 # you need to add `unexport BUNDLE_GEMFILE` to that makefile. Otherwise this

languages/java/oso/pom.xml

@@ -12,7 +12,7 @@
 
   <groupId>com.osohq</groupId>
   <artifactId>oso</artifactId>
-  <!-- oso_version --><version>0.27.2</version>
+  <!-- oso_version --><version>0.27.3</version>
 
   <distributionManagement>
     <snapshotRepository>

languages/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oso",
-  "version": "0.27.2",
+  "version": "0.27.3",
   "description": "oso authorization library.",
   "bin": "bin/repl.js",
   "main": "dist/src/index.js",

languages/python/docs/conf.py

@@ -42,8 +42,8 @@
 project = "oso"
 copyright = "2020-2021 Oso Security, Inc"
 author = "oso"
-version = "0.27.2"
-release = "0.27.2"
+version = "0.27.3"
+release = "0.27.3"
 
 
 # -- General configuration ---------------------------------------------------

languages/python/oso/oso/oso.py

@@ -1,6 +1,6 @@
 """Core oso functionality"""
 
-__version__ = "0.27.2"
+__version__ = "0.27.3"
 
 import os
 from typing import Any, List, Set, Type

languages/ruby/.gitignore

@@ -11,3 +11,4 @@ vendor
 
 # rspec failure tracking
 .rspec_status
+ext