fiftyone.geolocation 4.3.6 → 4.4.1

package/ci/common-ci/.github/labels.yml

@@ -74,7 +74,13 @@
   color: 6ff076
 - name: "scheduled: 12th Jan 2022"
   description: This item has been scheduled for 12th Jan 2022 release
-  color: d49233
+  color: 6ff076
 - name: "scheduled: 19th Jan 2022"
   description: This item has been scheduled for 19th Jan 2022 release
-  color: d49291
+  color: 6ff076
+- name: "scheduled: 26th Jan 2022"
+  description: This item has been scheduled for 26th Jan 2022 release
+  color: 6ff076
+- name: "scheduled: 2nd Feb 2022"
+  description: This item has been scheduled for 2nd Feb 2022 release
+  color: 6ff076

package/ci/common-ci/create-tag.yml

@@ -25,12 +25,15 @@ stages:
       submodules: recursive
       persistCredentials: true
     
-    - task: gittools.gitversion.gitversion-task.GitVersion@5
-      displayName: 'Determine Version Number'
-      # Give this task a name so we can use the variables it sets later.
-      name: GitVersion
+    - task: gitversion/setup@0
+      displayName: Install GitVersion
       inputs:
-        preferBundledVersion: false
+        versionSpec: '5.x'
+    
+    - task: gitversion/execute@0
+      displayName: Determine Version
+      inputs:
+        useConfigFile: true
         configFilePath: '$(Build.SourcesDirectory)/GitVersion.yml'
     
     # Add a tag to the git repository with the version number.

package/ci/common-ci/java/shared-security-vulnerability-check.yml

@@ -0,0 +1,54 @@
+parameters:
+- name: imageName # Name of build image
+- name: dependencies # Stages that this stage depends on
+  type: object
+  default: []
+
+stages:
+- stage: 'SecurityCheck'
+  displayName: 'Security Vulnerability Check'
+  dependsOn: ${{ parameters.dependencies }}
+  
+  variables: 
+  - group: CIAutomation
+  
+  jobs:
+  - job: 'SecurityCheck'
+    displayName: 'Security Vulnerability Check'
+  
+    pool:
+      vmImage: ${{ parameters.imageName }}
+
+    steps:
+    - checkout: self
+      submodules: recursive
+      lfs: true
+      persistCredentials: true
+
+    - task: MavenAuthenticate@0
+      inputs:
+        artifactsFeeds: '$(InternalFeedName)'
+
+    # Perform a security vulnerability check on the dependencies
+    # using dependency-check-maven plugin
+    - bash: |
+        mvn dependency-check:aggregate -Pdependency-check -Dfetchrepository.id=$REPO_ID -Dfetchrepository.url=$REPO_URL
+      env:
+        REPO_ID: $(fetchrepository.id)
+        REPO_URL: $(fetchrepository.url)
+      displayName: 'Maven dependency check'
+
+    # Copy report to staging directory to be published
+    - task: CopyFiles@2
+      displayName: 'Copy Files to: $(build.artifactstagingdirectory)'
+      inputs:
+        SourceFolder: '$(build.sourcesdirectory)'
+        Contents: 'target/dependency-check-report.html'
+        TargetFolder: '$(build.artifactstagingdirectory)'
+
+    # Publish dependency check report
+    - task: PublishBuildArtifacts@1
+      displayName: 'Publish Artifact: dependency-check-report'
+      inputs:
+        PathtoPublish: '$(build.artifactstagingdirectory)'
+        ArtifactName: dependency-check-report

package/ci/common-ci/release-config.json

@@ -1,181 +1,137 @@
 {
 	"repositories": {
 		"common-ci": {
-			"version": "4.3.43",
+			"version": "4.4.5",
 			"isLeaf": true
 		},
 		"common-cxx": {
-			"version": "4.3.8",
+			"version": "4.4.2",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci"
 			]
 		},
 		"device-detection-cxx": {
-			"version": "4.3.13",
+			"version": "4.4.2",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
 				"common-cxx"
 			]
 		},
-		"pipeline-node": {
-			"version": "4.3.7",
-			"packageName": "fiftyone.pipeline",
-			"isLeaf": false,
-			"dependencies": [
-				"common-ci"
-			]
-		},
-		"location-node": {
-		    "version": "4.3.6",
-			"packageName": "fiftyone.geolocation",
+		"device-detection-varnish": {
+			"version": "4.4.1",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"pipeline-node",
-				"device-detection-node"
+				"device-detection-cxx"
 			]
 		},
-		"device-detection-node": {
-			"version": "4.3.10",
-			"packageName": "fiftyone.devicedetection",
+		"device-detection-nginx": {
+			"version": "4.4.1",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"device-detection-cxx",
-				"pipeline-node"
-			]
-		},
-		"pipeline-java": {
-			"version": "4.3.8",
-			"packageName": "pipeline",
-			"versionVariableName": "pipeline.version",
-			"isLeaf": false,
-			"dependencies": [
-				"common-ci"
+				"device-detection-cxx"
 			]
 		},
 		"location-java": {
-		    "version": "4.3.8",
+		    "version": "4.4.2",
 			"packageName": "pipeline.geo-location",
 			"versionVariableName": "geolocation.version",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"pipeline-java",
 				"device-detection-java"
 			]
 		},
-		"device-detection-java": {
-			"version": "4.3.13",
-			"packageName": "pipeline.device-detection",
-			"versionVariableName": "devicedetection.version",
+		"location-onpremise-java": {
+		    "version": "4.4.3",
+			"packageName": "geo-location.digitalelement",
+			"versionVariableName": "geolocation.digitalelement.version",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"device-detection-cxx"
-			]
-		},
-		"common-dotnet": {
-			"version": "4.3.5",
-			"packageName": "FiftyOne.Common",
-			"isLeaf": false,
-			"dependencies": [
-				"common-ci"
-			]
-		},
-		"caching-dotnet": {
-			"version": "4.3.5",
-			"packageName": "FiftyOne.Caching",
-			"isLeaf": false,
-			"dependencies": [
-				"common-ci"
+				"location-java"
 			]
 		},
-		"pipeline-dotnet": {
-			"version": "4.3.15",
-			"packageName": "FiftyOne.Pipeline",
+		"device-detection-java": {
+			"version": "4.4.2",
+			"packageName": "pipeline.device-detection",
+			"versionVariableName": "devicedetection.version",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"common-dotnet",
-				"caching-dotnet"
+				"device-detection-cxx"
 			]
 		},
 		"location-dotnet": {
-		    "version": "4.3.11",
+		    "version": "4.4.1",
 			"packageName": "FiftyOne.Geolocation",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"common-dotnet",
-				"pipeline-dotnet",
 				"device-detection-dotnet"
 			]
 		},
 		"device-detection-dotnet": {
-			"version": "4.3.14",
+			"version": "4.4.1",
 			"packageName": "FiftyOne.DeviceDetection",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"device-detection-cxx",
-				"caching-dotnet",
-				"common-dotnet",
-				"pipeline-dotnet"
+				"device-detection-cxx"
 			]
 		},
-		"license-dotnet": {
-			"version": "4.3.3",
-			"packageName": "FiftyOne.(License|Resource)",
-			"isLeaf": false,
+		"internal-engines-dotnet": {
+			"version": "4.4.2",
+			"packageName": "FiftyOne.GeoLocation.OnPremise",
+			"isLeaf": false,			
 			"dependencies": [
-				"common-ci"
+				"common-ci",
+				"device-detection-dotnet",
+				"location-dotnet"
 			]
 		},
-		"entitlement-dotnet": {
-			"version": "4.1.18",
+		"location-node": {
+		    "version": "4.4.1",
+			"packageName": "fiftyone.geolocation",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"common-dotnet",
-				"license-dotnet",
-				"pipeline-dotnet"
+				"device-detection-node"
 			]
 		},
-		"pipeline-python": {
-			"version": "4.3.5",
-			"packageName": "fiftyone_pipeline",
-			"versionVariableName": "pipelineVersion",
+		"device-detection-node": {
+			"version": "4.4.2",
+			"packageName": "fiftyone.devicedetection",
 			"isLeaf": false,
 			"dependencies": [
-				"common-ci"
+				"common-ci",
+				"device-detection-cxx"
 			]
 		},
-		"location-python": {
-		    "version": "4.3.2",
-			"packageName": "fiftyone_location",
-			"versionVariableName": "locationVersion",
+		"device-detection-python": {
+			"version": "4.4.2",
+			"packageName": "fiftyone_devicedetection",
+			"versionVariableName": "deviceDetectionVersion",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"pipeline-python"
+				"device-detection-cxx"
 			]
 		},
-		"device-detection-python": {
-			"version": "4.3.4",
-			"packageName": "fiftyone_devicedetection",
-			"versionVariableName": "deviceDetectionVersion",
+		"device-detection-php-onpremise": {
+			"version": "4.4.2",
+			"packageName": "fiftyone.devicedetection",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
-				"device-detection-cxx",
-				"pipeline-python"
+				"device-detection-cxx"
 			]
 		},
 		"device-detection-go": {
-			"version": "4.3.4",
+			"version": "4.4.1",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",
@@ -183,7 +139,7 @@
 			]
 		},
 		"device-detection-examples-go": {
-			"version": "4.3.3",
+			"version": "4.4.1",
 			"isLeaf": false,
 			"dependencies": [
 				"common-ci",

package/ci/common-ci/scripts/modules/51DGitModule/51DGitModule.psm1

@@ -18,80 +18,139 @@ $script:releaseConfig = $null
 $script:repositories = $null
 
 class GitHandler {
+	static [boolean]Clean () {
+		$output = $(git clean -f -d)
+		$exitCode = $LASTEXITCODE
+		[boolean]$rtnCode = $exitCode -eq 0
+		if (!$rtnCode) {
+			Write-Host $output
+			Write-Host "# WARNING: Could not clean current dir properly. Exit code $exitCode."
+		}
+		return $rtnCode
+	}
+
+	static [boolean]UpdateSubmodules() {
+		$output = $(git submodule update --init --recursive)
+		$exitCode = $LASTEXITCODE
+		[boolean]$rtnCode = $exitCode -eq 0
+		if (!$rtnCode) {
+			Write-Host $output
+			Write-Host "# WARNING: Could not update submodules recursively. Exit code $exitCode."
+		}
+		return $rtnCode
+	}
+	
 	static [boolean]Checkout ([string]$branchName) {
 		Write-Host "# Checkout $branchName"
-		git checkout "$branchName"
-		return $?
+		$output = $(git checkout "$branchName")
+		$exitCode = $LASTEXITCODE
+		[boolean]$rtnCode = $exitCode -eq 0
+		if (!$rtnCode) {
+			Write-Host $output
+			Write-Host "# ERROR: Failed to checkout '$branchName' recursively. Exit code $exitCode."
+			return $rtnCode
+		}
+
+		$rtnCode = [GitHandler]::UpdateSubmodules()
+		if (!$rtnCode) {
+			return $rtnCode
+		}
+
+		return [GitHandler]::Clean()
 	}
 	
 	static [boolean]CheckoutTrack ([string]$branchName) {
 		Write-Host "# Checkout track $branchName"
-		git checkout --track "$branchName"
-		return $?
+		$output = $(git checkout --track "$branchName")
+		$exitCode = $LASTEXITCODE
+		[boolean]$rtnCode = $exitCode -eq 0
+		if (!$rtnCode) {
+			Write-Host $output
+			Write-Host "# ERROR: Failed to checkout '$branchName' recursively. Exit code $exitCode."
+			return $rtnCode
+		}
+
+		$rtnCode = [GitHandler]::UpdateSubmodules()
+		if (!$rtnCode) {
+			return $rtnCode
+		}
+
+		return [GitHandler]::Clean()
 	}
 	
 	static [boolean]CheckoutNew ([string]$branchName) {
 		Write-Host "# Checkout New $branchName"
-		git checkout -b "$branchName"
-		return $?
+		$output = $(git checkout -b "$branchName")
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
+		
 	}
 	
 	static [boolean]Pull () {
 		Write-Host "# Git pull"
-		git pull
-		return $?
+		$output = $(git pull)
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]FetchAllTags () {
 		Write-Host "# Fetch all tags"
 		# git -c http.extraheader="AUTHORIZATION: bearer $env:SYSTEM_ACCESSTOKEN" fetch --all --tags
-		git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" fetch --all --tags
-		return $?
+		$output = $(git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" fetch --all --tags)
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]Push ([string]$branchName) {
 		if ([string]::IsNullOrEmpty($branchName)) {
 			Write-Host "# Git Push $branchName to origin"
-			git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" push
+			$output = $(git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" push)
 		} else {
 			Write-Host "# Git Push"
-			git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" push origin "$branchName"
+			$output = $(git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" push origin "$branchName")
 		}
-		return $?
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]Commit ([string]$message) {
 		Write-Host "# Git commit"
-		git commit -m "$message"
-		return $?
+		$output = $(git commit -m "$message")
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]Config ([string]$email, [string]$name) {
 		Write-Host "# Git config email '$email' and name '$name'"
-		git config user.email "$email"
-		[boolean]$returnCode = $?
-		git config user.name "$name"
-		return $returnCode -and $?
+		$output = $(git config user.email "$email")
+		$rtnCode = [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
+
+		$output = $(git config user.name "$name")
+		return $rtnCode -and [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]Add ([string]$path) {
 		Write-Host "# Git stage '$path'"
-		git add "$path"
-		return $?
+		$output = $(git add "$path")
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]CheckoutWithAuthorization ([string]$branchName) {
 		Write-Host "# Checkout with authorization $branchName"
 		# git -c http.extraheader="AUTHORIZATION: bearer $env:SYSTEM_ACCESSTOKEN" checkout "$branchName"
-		git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" checkout "$branchName"
-		return $?
+		$output = $(git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" checkout "$branchName")
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
 	}
 	
 	static [boolean]Clone ([string]$url) {
 		Write-Host "# Clone $url"
 		# git -c http.extraheader="AUTHORIZATION: Bearer $env:SYSTEM_ACCESSTOKEN" clone "$url"
-		git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" clone "$url"
-		return $?
+		$output = $(git -c http.extraheader="AUTHORIZATION: $([Authorization]::AuthorizationString)" clone "$url")
+		return [GitHandler]::ProcessExitCode($LASTEXITCODE, $output)
+	}
+	
+	static hidden [boolean]ProcessExitCode ([int]$exitCode, [string]$commandOutput) {
+		[boolean]$rtnCode = $exitCode -eq 0
+		if (!$rtnCode) {
+			Write-Host $commandOutput
+			Write-Host "WARNING: Failed with exit code $exitCode"
+		}
+		return $rtnCode
 	}
 }
 
@@ -577,11 +636,15 @@ function Update-SubmoduleReferences {
 	Write-Host "================"
 	foreach ($submodule in $(git config --file .gitmodules --name-only --get-regexp path)) {
 		Write-Host ""
-		Write-Host "# Process submodule path $submodulePath."
+		Write-Host "# Process submodule path $submodule."
 		$submodulePath = Find-SubmodulePath -GitSubmodulePath $submodule
 		if ($submodulePath -ne $null) {
 			Write-Host "# Path $submodulePath extracted."
 			Push-Location $submodulePath
+			if (!$?) {
+				Write-Host "# ERROR: Failed to navigate to submodule $submodulePath"
+				return $false
+			}
 			
 			# Get repo name
 			$subRepoName = Get-RepositoryName

package/docs/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "51Degrees Geo-Location Node.js"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 4.3
+PROJECT_NUMBER         = 4.4
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -56,7 +56,7 @@ PROJECT_LOGO           = ../../../docs/images/logo-51Degrees-Docs.png
 # The PROJECT_URL tag is used to specify the URL which is linked by the
 # PROJECT_LOGO.
 
-PROJECT_URL            = ../../documentation/4.3/index.html
+PROJECT_URL            = ../../documentation/4.4/index.html
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -1101,7 +1101,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = 4.3
+HTML_OUTPUT            = 4.4
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

package/docs/DoxygenLayout.xml

@@ -2,7 +2,7 @@
   <!-- Generated by doxygen 1.8.15 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
-    <tab type="user" visible="yes" title="General Docs" url="../../documentation/4.3/index.html"/>
+    <tab type="user" visible="yes" title="General Docs" url="../../documentation/4.4/index.html"/>
     <tab type="pages" visible="yes" title="" intro=""/>
     <tab type="classlist" visible="yes" title="Classes" intro="51Degrees Node.js classes. These contain the interfaces and logic of the geo-location engines."/>
     <tab type="examples" visible="yes" title="Examples" intro="51Degrees geo-location examples."/>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.geolocation",
-  "version": "4.3.6",
+  "version": "4.4.1",
   "description": "Geo-location services for the 51Degrees Pipeline API",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -17,10 +17,10 @@
     "Joseph Dix <joseph@51degrees.com> (https://51degrees.com)"
   ],
   "dependencies": {
-    "fiftyone.pipeline.cloudrequestengine": "^4.3.7",
-    "fiftyone.pipeline.core": "^4.3.7",
-    "fiftyone.pipeline.engines": "^4.3.7",
-    "fiftyone.pipeline.engines.fiftyone": "^4.3.7"
+    "fiftyone.pipeline.cloudrequestengine": "^4.4.0",
+    "fiftyone.pipeline.core": "^4.4.0",
+    "fiftyone.pipeline.engines": "^4.4.0",
+    "fiftyone.pipeline.engines.fiftyone": "^4.4.0"
   },
   "devDependencies": {
     "@types/node": "^15.12.2",