Merge pull request #190 from splitio/task/arm

Task/arm

Author: mmelograno

.github/workflows/docker.yml

@@ -40,7 +40,7 @@ jobs:
         run: echo "BUILD_VERSION=$(cat package.json | grep version | head -1 | awk '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]')" >> $GITHUB_ENV
 
       - name: Docker build
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: ${{ github.event_name == 'push' }}
@@ -59,7 +59,7 @@ jobs:
         run: echo "BUILD_VERSION=$(cat package.json | grep version | head -1 | awk '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]')" >> $GITHUB_ENV
 
       - name: Docker build
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: false

.github/workflows/unstable.yml

@@ -32,7 +32,7 @@ jobs:
         run: echo "SHORT_SHA=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
 
       - name: Docker Build
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: true

.github/workflows/update-license-year.yml

@@ -38,7 +38,7 @@ jobs:
           git commit -m "Updated License Year" -a
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           title: Update License Year

.jest/app.setup.js

@@ -1,6 +1,5 @@
 const { gracefulShutDown } = require('../utils/testWrapper/index');
 
-afterAll( async (done) => {
+afterAll(async () => {
   await gracefulShutDown();
-  done()
-})
+})

CHANGES.txt

@@ -1,9 +1,14 @@
+2.7.0 (Dec 20, 2024)
+  - Added support to arm64 images.
+  - Updated base image to node:20.13.1-alpine3.20
+  - Updated @splitsoftware/splitio package to version 11.0.3 that includes vulnerability fixes and other improvements.
+
 2.6.0 (May 16, 2024)
   - Updated @splitsoftware/splitio package to version 10.26.0 that includes:
     - Added support for targeting rules based on semantic versions (https://semver.org/).
     - Added special impression label "targeting rule type unsupported by sdk" when the matcher type is not supported by the SDK, which returns 'control' treatment.
     - Updated Split API client to include the flags spec version query parameter for the `splitChanges` and `auth` endpoints.
-  - Updated base image to node:20.13.1-alpine3.19 
+  - Updated base image to node:20.13.1-alpine3.19
 
 2.5.1 (Mar 14, 2024)
   - Updated @splitsoftware/splitio package to version 10.25.1 that includes:

Dockerfile

@@ -1,5 +1,5 @@
 # Builder stage
-FROM node:20.13.1-alpine3.19 AS builder
+FROM node:20.13.1-alpine3.20 AS builder
 
 WORKDIR /usr/src/split-evaluator
 
@@ -8,7 +8,7 @@ COPY package.json package-lock.json ./
 RUN npm install --only=production
 
 # Runner stage
-FROM node:20.13.1-alpine3.19 AS runner
+FROM node:20.13.1-alpine3.20 AS runner
 
 WORKDIR /usr/src/split-evaluator
 

Makefile

@@ -0,0 +1,39 @@
+# Setup defaults
+MAKE ?= make
+DOCKER ?= docker
+PLATFORM ?= linux/arm64/v8,linux/amd64
+BUILDER ?= container
+
+version				:= $(shell cat package.json | grep '"version": "' | sed 's/  "version": "//' | tr -d '",')
+
+# Help target borrowed from: https://docs.cloudposse.com/reference/best-practices/make-best-practices/
+## This help screen
+help:
+	@printf "Available targets:\n\n"
+	@awk '/^[a-zA-Z\-\_0-9%:\\]+/ { \
+	    helpMessage = match(lastLine, /^## (.*)/); \
+		if (helpMessage) { \
+		    helpCommand = $$1; \
+		    helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
+		    gsub("\\\\", "", helpCommand); \
+		    gsub(":+$$", "", helpCommand); \
+		    printf "  \x1b[32;01m%-35s\x1b[0m %s\n", helpCommand, helpMessage; \
+		} \
+	    } \
+	    { lastLine = $$0 }' $(MAKEFILE_LIST) | sort -u
+	@printf "\n"
+
+## Build release-ready docker images with proper tags and output push commands in stdout
+images_release_multi_load: # entrypoints
+	@echo "make sure you have buildx configured 'docker buildx ls', if not 'docker buildx create --name container --driver=docker-container'"
+	$(DOCKER) buildx build \
+		-t splitsoftware/split-evaluator:latest -t splitsoftware/split-evaluator:$(version) \
+		--platform $(PLATFORM) \
+		--builder $(BUILDER) \
+		--load .
+	@echo "Images created. Make sure everything works ok, and then run the following commands to push them."
+	@echo "$(DOCKER) push splitsoftware/split-evaluator:$(version)"
+	@echo "$(DOCKER) push splitsoftware/split-evaluator:latest"
+
+platform_str		= $(if $(PLATFORM),--platform $(PLATFORM),)
+builder_str		= $(if $(BUILDER),--builder $(BUILDER),)

README.md

@@ -55,23 +55,24 @@ Split has built and maintains SDKs for:
 
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
-* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
-* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
+* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
+* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
 * React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
 * React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
 * Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
-* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
-* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
 
-For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
+For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 
 **Learn more about Split:**
 
-Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [docs.split.io](https://help.split.io/hc/en-us) for more detailed information.
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](https://help.split.io) for more detailed information.

admin/__tests__/healthcheck.test.js

@@ -4,26 +4,23 @@ const { expectError } = require('../../utils/testWrapper/index');
 
 describe('healthcheck', () => {
   // Testing authorization
-  test('should be 401 if auth is not passed', async (done) => {
+  test('should be 401 if auth is not passed', async () => {
     const response = await request(app)
       .get('/admin/healthcheck');
     expectError(response, 401, 'Unauthorized');
-    done();
   });
 
-  test('should be 401 if auth does not match', async (done) => {
+  test('should be 401 if auth does not match', async () => {
     const response = await request(app)
       .get('/admin/healthcheck')
       .set('Authorization', 'invalid');
     expectError(response, 401, 'Unauthorized');
-    done();
   });
 
-  test('should be 200', async (done) => {
+  test('should be 200', async () => {
     const response = await request(app)
       .get('/admin/healthcheck')
       .set('Authorization', 'test');
     expect(response.statusCode).toEqual(200);
-    done();
   });
 });

admin/__tests__/machine.test.js

@@ -1,33 +1,30 @@
 const os = require('os');
-const ip = require('@splitsoftware/splitio/lib/utils/ip');
+const ip = require('@splitsoftware/splitio/cjs/utils/ip');
 const request = require('supertest');
 const app = require('../../app');
 const { expectError } = require('../../utils/testWrapper/index');
 
 describe('machine', () => {
   // Testing authorization
-  test('should be 401 if auth is not passed', async (done) => {
+  test('should be 401 if auth is not passed', async () => {
     const response = await request(app)
       .get('/admin/machine');
     expectError(response, 401, 'Unauthorized');
-    done();
   });
 
-  test('should be 401 if auth does not match', async (done) => {
+  test('should be 401 if auth does not match', async () => {
     const response = await request(app)
       .get('/admin/machine')
       .set('Authorization', 'invalid');
     expectError(response, 401, 'Unauthorized');
-    done();
   });
 
-  test('should be 200', async (done) => {
+  test('should be 200', async () => {
     const response = await request(app)
       .get('/admin/machine')
       .set('Authorization', 'test');
     expect(response.statusCode).toEqual(200);
     expect(response.body).toHaveProperty('ip', ip.address());
     expect(response.body).toHaveProperty('name', os.hostname());
-    done();
   });
 });