Bugfix/benchmark flutter

.github/workflows/checkout.yml

@@ -30,6 +30,7 @@ jobs:
       image: dart:stable
     env:
       pub-cache-name: pub
+      PUB_CACHE: /github/home/.pub-cache
     timeout-minutes: 10
     steps:
       - name: 🚂 Get latest code
@@ -42,45 +43,41 @@ jobs:
             lib
             test
             analysis_options.yaml
+            README.md
             CHANGELOG.md
 
       - name: 📤 Restore Pub modules
         id: cache-pub-restore
         uses: actions/cache/restore@v4
         with:
           path: |
-            $PWD/.pub_cache/
-          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('**/pubspec.yaml') }}
-
-      - name: 🗄️ Export Pub cache directory
-        id: export-pub-cache
-        timeout-minutes: 1
-        run: |
-          export PUB_CACHE=$PWD/.pub_cache/
-          export PATH="$PATH":"$HOME/.pub-cache/bin"
+            ${{ env.PUB_CACHE }}
+          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('pubspec.yaml') }}
 
       - name: 👷 Install Dependencies
         id: install-dependencies
         timeout-minutes: 1
-        run: dart pub get --no-example
+        run: |
+          echo $PUB_CACHE/bin >> $GITHUB_PATH
+          dart pub get --no-example
 
       - name: 📥 Save Pub modules
         id: cache-pub-save
         uses: actions/cache/save@v4
         with:
           path: |
-            $PWD/.pub_cache/
-          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('**/pubspec.yaml') }}
+            ${{ env.PUB_CACHE }}
+          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('pubspec.yaml') }}
 
       - name: 🔎 Check format
         id: check-format
         timeout-minutes: 1
-        run: dart format --set-exit-if-changed -l 80 -o none lib/
+        run: dart format --set-exit-if-changed -l 80 -o none lib/ test/
 
       - name: 📈 Check analyzer
         id: check-analyzer
         timeout-minutes: 1
-        run: dart analyze --fatal-infos --fatal-warnings lib/
+        run: dart analyze --fatal-infos --fatal-warnings lib/ test/
 
       - name: 👀 Verify versions
         id: verify-versions

.github/workflows/tests.yml

@@ -104,6 +104,7 @@ jobs:
     env:
       pub-cache-name: pub
       threshold: 50
+      PUB_CACHE: /github/home/.pub-cache
     timeout-minutes: 15
     steps:
       - name: 🚂 Get latest code
@@ -129,20 +130,14 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: |
-            $PWD/.pub_cache/
-          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('**/pubspec.yaml') }}
-
-      - name: 🗄️ Export Pub cache directory
-        id: export-pub-cache
-        timeout-minutes: 1
-        run: |
-          export PUB_CACHE=$PWD/.pub_cache/
-          export PATH="$PATH":"$HOME/.pub-cache/bin"
+            ${{ env.PUB_CACHE }}
+          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('pubspec.yaml') }}
 
       - name: 👷 Install Dependencies
         id: install-dependencies
         timeout-minutes: 1
         run: |
+          echo $PUB_CACHE/bin >> $GITHUB_PATH
           apt-get update && apt-get install -y lcov bc
           dart pub get --no-example
 
@@ -151,8 +146,8 @@ jobs:
         uses: actions/cache/save@v4
         with:
           path: |
-            $PWD/.pub_cache/
-          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('**/pubspec.yaml') }}
+            ${{ env.PUB_CACHE }}
+          key: ${{ runner.os }}-spinify-${{ env.pub-cache-name }}-${{ hashFiles('pubspec.yaml') }}
 
       - name: 📢 Run Echo server
         id: run-echo-server

.pubignore

@@ -0,0 +1 @@
+example/benchmark/

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.3
+
+- Move benchmark to example folder
+
 ## 0.0.2
 
 - Basic functionality implemented

Makefile

@@ -1,41 +1,71 @@
-.PHONY: format get outdated test publish deploy echo-up echo-down coverage analyze check pana generate
-
 ifeq ($(OS),Windows_NT)
+	SHELL = cmd
     RM = del /Q
     MKDIR = mkdir
     PWD = $(shell $(PWD))
 else
+	SHELL = /bin/bash -e -o pipefail
     RM = rm -f
     MKDIR = mkdir -p
     PWD = pwd
 endif
 
-format:
-	@echo "Formatting the code"
-	@dart format -l 80 --fix .
+.DEFAULT_GOAL := all
+.PHONY: all
+all: ## build pipeline
+all: generate format check test
+
+.PHONY: precommit
+precommit: ## validate the branch before commit
+precommit: all
+
+.PHONY: help
+help:
+	@echo 'Usage: make <OPTIONS> ... <TARGETS>'
+	@echo ''
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: format
+format: ## Format the code
+	@dart format -l 80 --fix lib/ test/
 	@dart fix --apply .
 
-get:
+.PHONY: get
+get: ## Get the dependencies
 	@dart pub get
 
-outdated:
+.PHONY: outdated
+outdated: get ## Check for outdated dependencies
 	@dart pub outdated --show-all --dev-dependencies --dependency-overrides --transitive --no-prereleases
 
-test: get
-	@dart test --debug --coverage=coverage --platform chrome,vm test/unit_test.dart
+.PHONY: test
+test: get ## Run the tests
+	@dart test --debug --coverage=coverage --platform vm,chrome test/unit_test.dart
 
-publish: generate
+.PHONY: publish-check
+publish-check: ## Check the package before publishing
+	@dart pub publish --dry-run
+
+.PHONY: deploy-check
+deploy-check: publish-check
+
+.PHONY: publish
+publish: generate ## Publish the package
 	@yes | dart pub publish
 
+.PHONY: deploy
 deploy: publish
 
-echo-up:
+.PHONY: echo-up
+echo-up: ## Start the echo server
 	@dart run tool/echo_up.dart
 
-echo-down:
+.PHONY: echo-down
+echo-down: ## Stop the echo server
 	@dart run tool/echo_down.dart
 
-coverage: get
+.PHONY: coverage
+coverage: get ## Generate the coverage report
 	@dart pub global activate coverage
 	@dart pub global run coverage:test_with_coverage -fb -o coverage -- \
 		--platform vm --compiler=kernel --coverage=coverage \
@@ -50,23 +80,34 @@ coverage: get
 	@lcov --list coverage/lcov.info
 	@genhtml -o coverage coverage/lcov.info
 
-analyze: get format
-	@echo "Analyze the code"
-	@dart analyze --fatal-infos --fatal-warnings
+.PHONY: analyze
+analyze: get ## Analyze the code
+	@dart format --set-exit-if-changed -l 80 -o none lib/ test/
+	@dart analyze --fatal-infos --fatal-warnings lib/ test/
 
-check: analyze
-	@dart pub publish --dry-run
+.PHONY: check
+check: analyze publish-check ## Check the code
 	@dart pub global activate pana
 	@pana --json --no-warning --line-length 80 > log.pana.json
 
+.PHONY: pana
 pana: check
 
-generate: get
+.PHONY: generate
+generate: get ## Generate the code
 	@dart pub global activate protoc_plugin
 	@protoc --proto_path=lib/src/protobuf --dart_out=lib/src/protobuf lib/src/protobuf/client.proto
 	@dart run build_runner build --delete-conflicting-outputs
 	@dart format -l 80 lib/src/model/pubspec.yaml.g.dart lib/src/protobuf/ test/
 
+.PHONY: gen
 gen: generate
 
-codegen: generate
+.PHONY: codegen
+codegen: generate
+
+.PHONY: diff
+diff: ## git diff
+	$(call print-target)
+	@git diff --exit-code
+	@RES=$$(git status --porcelain) ; if [ -n "$$RES" ]; then echo $$RES && exit 1 ; fi

benchmark/pubspec.yaml → example/benchmark/pubspec.yaml

@@ -6,7 +6,8 @@ publish_to: 'none'
 version: 1.0.0+1
 
 environment:
-  sdk: ^3.5.0
+  sdk: ^3.4.0
+  flutter: ^3.24.0
 
 dependencies:
   flutter:
@@ -18,7 +19,7 @@ dependencies:
   # Centrifuge clients
   centrifuge: ^0.14.0
   spinify:
-    path: ../
+    path: ../../
 
   # Utilities
   l: ^5.0.0-pre.2

lib/src/model/pubspec.yaml.g.dart

@@ -93,13 +93,13 @@ sealed class Pubspec {
   static const PubspecVersion version = (
     /// Non-canonical string representation of the version as provided
     /// in the pubspec.yaml file.
-    representation: r'0.0.2',
+    representation: r'0.0.3',
 
     /// Returns a 'canonicalized' representation
     /// of the application version.
     /// This represents the version string in accordance with
     /// Semantic Versioning (SemVer) standards.
-    canonical: r'0.0.2',
+    canonical: r'0.0.3',
 
     /// MAJOR version when you make incompatible API changes.
     /// The major version number: 1 in "1.2.3".
@@ -112,7 +112,7 @@ sealed class Pubspec {
 
     /// PATCH version when you make backward compatible bug fixes.
     /// The patch version number: 3 in "1.2.3".
-    patch: 2,
+    patch: 3,
 
     /// The pre-release identifier: "foo" in "1.2.3-foo".
     preRelease: <String>[],
@@ -125,12 +125,12 @@ sealed class Pubspec {
   static final DateTime timestamp = DateTime.utc(
     2024,
     8,
-    18,
-    6,
-    33,
-    36,
-    43,
-    85,
+    21,
+    23,
+    58,
+    0,
+    218,
+    35,
   );
 
   /// Name

pubspec.yaml

@@ -4,7 +4,7 @@ description: >
   Dart client to communicate with Centrifuge and Centrifugo from Dart and Flutter
   over WebSockets with Protobuf support.
 
-version: 0.0.2
+version: 0.0.3
 
 homepage: https://centrifugal.dev