Merge pull request #88 from akkadotnet/dev

v1.4.17 Release

Author: Aaronontheweb

README.md

@@ -42,6 +42,19 @@ akka.persistence{
 
 			# defines column db type used to store payload. Available option: BYTEA (default), JSON, JSONB
 			stored-as = BYTEA
+
+			# Setting used to toggle sequential read access when loading large objects
+			# from journals and snapshot stores.
+			sequential-access = off
+
+			# When turned on, persistence will use `BIGINT` and `GENERATED ALWAYS AS IDENTITY`
+			# for journal table schema creation.
+			# NOTE: This only affects newly created tables, as such, it should not affect any
+			#       existing database.
+			#
+			# !!!!! WARNING !!!!!
+			# To use this feature, you have to have PorsgreSql version 10 or above
+			use-bigint-identity-for-ordering-column = off
 		}
 	}
 
@@ -71,6 +84,10 @@ akka.persistence{
 			
 			# defines column db type used to store payload. Available option: BYTEA (default), JSON, JSONB
 			stored-as = BYTEA
+
+			# Setting used to toggle sequential read access when loading large objects
+			# from journals and snapshot stores.
+			sequential-access = off
 		}
 	}
 }
@@ -110,6 +127,23 @@ CREATE TABLE {your_metadata_table_name} (
 );
 ```
 
+Note that if you turn on the `akka.persistence.journal.postgresql.use-bigint-identity-for-ordering-column` flag, the journal table schema will be altered to the latest recommended primary key setting.
+```
+CREATE TABLE {your_journal_table_name} (
+	ordering BIGINT NOT NULL GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    persistence_id VARCHAR(255) NOT NULL,
+    sequence_nr BIGINT NOT NULL,
+    is_deleted BOOLEAN NOT NULL,
+    created_at BIGINT NOT NULL,
+    manifest VARCHAR(500) NOT NULL,
+    payload BYTEA NOT NULL,
+    tags VARCHAR(100) NULL,
+    serializer_id INTEGER NULL,
+    CONSTRAINT {your_journal_table_name}_uq UNIQUE (persistence_id, sequence_nr)
+);
+```
+Since this script is only run once during table generation, we will not provide any migration path for this change, any migration is left as an exercise for the user.
+
 ### Migration
 
 #### From 1.1.0 to 1.3.1

RELEASE_NOTES.md

@@ -1,3 +1,12 @@
+### 1.4.17 March 13 2021 ###
+Major upgrade and modernization for Akka.Persistence.PostgreSql
+
+- Upgraded to Akka.NET v1.4.17
+- Implemented all Akka.Persistence.Query's correctly
+- [Lots of other fixes and modernizations, which you can read here](https://github.com/akkadotnet/Akka.Persistence.PostgreSql/projects/1).
+
+Akka.Persistence.PostgreSql is now under the umbrella of the Akka.NET project again and will be maintained at roughly the same cadence as the other officially supported Akka.NET plugins.
+
 #### 1.3.9 August 29 2018 ####
 Upgraded for Akka.NET v1.3.9.
 

build-system/README.md

@@ -0,0 +1,8 @@
+# Azure Pipelines Build Files
+These `.yaml` files are used by Windows Azure DevOps Pipelines to help execute the following types of builds:
+
+- Pull request validation on Linux (Mono / .NET Core)
+- Pull request validation on Windows (.NET Framework / .NET Core)
+- NuGet releases with automatic release notes posted to a Github Release repository.
+
+**NOTE**: you will need to change some of the pipeline variables inside the `windows-release.yaml` for your specific project and you will also want to create variable groups with your signing and NuGet push information.

build-system/azure-pipeline.template.yaml

@@ -0,0 +1,63 @@
+parameters:
+  name: ''
+  vmImage: ''
+  displayName: ''
+  artifactName: 'akkaBuild'
+  scriptFileName: ''
+  scriptArgs: 'all'
+  outputDirectory: ''
+  timeoutInMinutes: 120
+
+jobs:
+  - job: ${{ parameters.name }}
+    displayName: ${{ parameters.displayName }}
+    timeoutInMinutes: ${{ parameters.timeoutInMinutes }}
+    pool:
+      vmImage: ${{ parameters.vmImage }}
+    steps:
+      - checkout: self  # self represents the repo where the initial Pipelines YAML file was found
+        clean: false  # whether to fetch clean each time
+        submodules: recursive  # set to 'true' for a single level of submodules or 'recursive' to get submodules of submodules
+        persistCredentials: true
+      - task: UseDotNet@2
+        displayName: 'Use .NET Core Runtime 3.1.10'
+        inputs:
+          packageType: runtime
+          version: 3.1.10
+      # Linux or macOS
+      - task: Bash@3 
+        displayName: Linux / OSX Build
+        inputs:
+          filePath: ${{ parameters.scriptFileName }}
+          arguments: ${{ parameters.scriptArgs }}
+        continueOnError: true
+        condition: in( variables['Agent.OS'], 'Linux', 'Darwin' )
+      # Windows test is disabled, could not use redis container in Azure Pipelines
+#      - task: BatchScript@1
+#        displayName: Windows Build
+#        inputs:
+#          filename: ${{ parameters.scriptFileName }}
+#          arguments: ${{ parameters.scriptArgs }}
+#        continueOnError: true
+#        condition: eq( variables['Agent.OS'], 'Windows_NT' )
+      - task: PublishTestResults@2
+        inputs:
+          testRunner: VSTest
+          testResultsFiles: '**/*.trx' #TestResults folder usually
+          testRunTitle: ${{ parameters.name }}
+          mergeTestResults: true
+      - task: CopyFiles@2
+        displayName: 'Copy Build Output'
+        inputs:
+          sourceFolder: ${{ parameters.outputDirectory }}
+          contents: '**\*'
+          targetFolder: $(Build.ArtifactStagingDirectory)
+          continueOnError: boolean  # 'true' if future steps should run even if this step fails; defaults to 'false'
+      - task: PublishBuildArtifacts@1
+        inputs:
+          pathtoPublish: '$(Build.ArtifactStagingDirectory)'
+          artifactName: ${{ parameters.artifactName }}
+      - script: 'echo 1>&2'
+        failOnStderr: true
+        displayName: 'If above is partially succeeded, then fail'
+        condition: eq(variables['Agent.JobStatus'], 'SucceededWithIssues')

build-system/pr-validation.yaml

@@ -0,0 +1,34 @@
+# Pull request validation for Windows against the `dev` and `master` branches
+# See https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema for reference
+trigger:
+  branches:
+    include:
+      - dev
+      - master
+
+pr:
+  autoCancel: true # indicates whether additional pushes to a PR should cancel in-progress runs for the same PR. Defaults to true
+  branches:
+    include: [ dev, master ] # branch names which will trigger a build
+
+name: $(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)
+
+jobs:
+  # Windows testing is disabled, Redis linux container can not run in windows docker.
+#  - template: azure-pipeline.template.yaml
+#    parameters:
+#      name: 'windows_pr'
+#      displayName: 'Windows PR Validation'
+#      vmImage: 'windows-2019'
+#      scriptFileName: build.cmd
+#      scriptArgs: all
+
+  - template: azure-pipeline.template.yaml
+    parameters:
+      name: 'linux_pr'
+      displayName: 'Linux PR Validation'
+      vmImage: 'ubuntu-16.04'
+      scriptFileName: './build.sh'
+      scriptArgs: RunTestsNetCore
+      outputDirectory: 'TestResults'
+      artifactName: 'net_core_tests-$(Build.BuildId)'

build-system/windows-release.yaml

@@ -0,0 +1,43 @@
+# Release task for PbLib projects
+# See https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema for reference
+
+pool:
+  vmImage: vs2017-win2016
+  demands: Cmd
+
+trigger:
+  branches:
+    include:
+      - refs/tags/*
+pr: none
+
+variables:
+  - group: signingSecrets #create this group with SECRET variables `signingUsername` and `signingPassword`
+  - group: nugetKeys #create this group with SECRET variables `nugetKey`
+  - name: githubConnectionName
+    value: AkkaDotNet_Releases
+  - name: projectName
+    value: Akka.Persistence.PostgreSql
+  - name: githubRepositoryName
+    value: akkadotnet/Akka.Persistence.PostgreSql
+steps:
+- task: UseDotNet@2
+  displayName: 'Use .NET Core Runtime 3.1.10'
+  inputs:
+    packageType: runtime
+    version: 3.1.10
+- task: BatchScript@1
+  displayName: 'FAKE Build'
+  inputs:
+    filename: build.cmd
+    arguments: 'Nuget nugetpublishurl=https://www.nuget.org/api/v2/package nugetkey=$(nugetKey)'
+
+- task: GitHubRelease@0
+  displayName: 'GitHub release (create)'
+  inputs:
+    gitHubConnection: $(githubConnectionName)
+    repositoryName: $(githubRepositoryName)
+    title: '$(projectName) v$(Build.SourceBranchName)'
+    releaseNotesFile: 'RELEASE_NOTES.md'
+    assets: |
+     bin\nuget\*.nupkg