fiftyone.geolocation 4.3.1 → 4.3.6

package/ci/common-ci/scripts/modules/AzurePortalModules/51DTrafficManagerModule/51DTrafficManagerModule.psm1

@@ -0,0 +1,58 @@
+<#
+  ==================== TrafficManager =====================
+  .Description
+  This module contains functions for managing the Azure Traffic Manager profiles
+#>
+
+# function to add or udpate a traffic manager endpoint with a type of 
+# AzureEndpoint
+function Update-TrafficManagerAzureEndpoint {
+    
+    param(
+        [Parameter(Mandatory=$true)]
+        [Object]$webapp,
+
+        [Parameter(Mandatory=$true)]
+        [string]$trafficManagerProfile,
+
+        [Parameter(Mandatory=$true)]
+        [string]$trafficManagerResourceGroup
+    )
+
+    $EndpointType = "AzureEndpoints"
+
+    # Get exisiting traffic manager endpoint.
+    $trafficManagerEndpoint = $null
+    try {
+        $trafficManagerEndpoint = Get-AzTrafficManagerEndpoint `
+            -Name $webapp.Name `
+            -ProfileName $trafficManagerProfile `
+            -ResourceGroupName $trafficManagerResourceGroup `
+            -Type $EndpointType `
+            -ErrorAction SilentlyContinue
+    } catch {}
+
+    # Check if traffic manager endpoint already exists.
+    if ($trafficManagerEndpoint) {
+        # If traffic manager endpoint exists then update the existing endpoint
+        # target, leave other settings the same.
+        Write-Host "Updating endpoint in traffic manager"
+        $trafficManagerEndpoint.TargetResourceId = $webapp.Id
+
+        Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $trafficManagerEndpoint
+    } else {
+        # If traffic manager endpoint does not exist then add App Service to 
+        # traffic manager (as a disabled endpoint).
+        Write-Host ("Adding endpoint to traffic manager, endpoint will be added as " + 
+            "disabled. The endpoint should only be enabled when the cloud "+
+            "application has been tested on the new App Service")
+
+        New-AzTrafficManagerEndpoint `
+            -Name $webapp.Name `
+            -ProfileName $trafficManagerProfile `
+            -ResourceGroupName $trafficManagerResourceGroup `
+            -Type $EndpointType `
+            -TargetResourceId $webapp.Id `
+            -EndpointStatus Disabled
+    }
+}

package/ci/common-ci/shared-auto-complete-pr-stage.yml

@@ -2,6 +2,13 @@ parameters:
 - name: stageDependencies
   type: object
   default: []
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
 
 stages:
 # This stage check if current branch runs on a pull request merge branch,
@@ -26,10 +33,16 @@ stages:
     - checkout: self
       submodules: recursive
       persistCredentials: true
-      # Check out to access the latest release info.
-    - checkout: 'git://$(System.TeamProject)/common-ci'
-      
 
+      # Checkout the common-ci to access the latest release configuration.
+      # Special consideration is given to the cloud project as when executing 
+      # this template the git url would resolve to git://Cloud/common-ci
+      # which is not valid.
+    - ${{ if eq(parameters.project, 'cloud') }}:
+      - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+    - ${{ if ne(parameters.project, 'cloud') }}:
+      - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+      
     - powershell: |
         # Install all modules
         $Env:PSModulePath += ";$($(Get-Location).Path)\common-ci\scripts\modules"

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

@@ -1,11 +1,20 @@
 parameters:
 - name: imageName # Name of the image to run the job on
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
 
 jobs:
 # Determine the version of the current commit.
 - template: shared-git-version-job.yml
   parameters:
     imageName: ${{ parameters.imageName }}
+    commonCiRef: ${{ parameters.commonCiRef }}
+    project: ${{ parameters.project }}
     
 # Tag using the version from the gitversion job
 - template: shared-git-tag-job.yml

package/ci/common-ci/shared-docker-build-steps.yml

@@ -0,0 +1,34 @@
+# Steps to build a Docker container.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: dockerfilePath # Path to the Dockerfile.
+- name: dockerRegistryServiceConnection # A Docker registry service connection.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+
+steps:
+# Login to the Docker registry
+- task: Docker@2
+  displayName: Docker Login
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'login'
+
+# Build the docker container
+- task: Docker@2
+  displayName: Docker Build
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    repository: '${{ parameters.imageRepository }}'
+    command: 'build'
+    Dockerfile: '${{ parameters.dockerfilePath }}'
+    tags: |
+      ${{ parameters.tag }}
+      latest
+
+# Logout of the Docker registry
+- task: Docker@2
+  displayName: Docker Logout
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'logout'

package/ci/common-ci/shared-docker-push-steps.yml

@@ -0,0 +1,32 @@
+# Steps to push a Docker container to a Docker repository.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: dockerRegistryServiceConnection # A Docker registry service connection.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+
+steps:
+# Login to the Docker registry
+- task: Docker@2
+  displayName: Docker Login
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'login'
+
+# Push the docker container to the registy
+- task: Docker@2
+  displayName: Docker Push
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    repository: '${{ parameters.imageRepository }}'
+    command: 'push'
+    tags: |
+      ${{ parameters.tag }}
+      latest
+      
+# Logout of the Docker registry
+- task: Docker@2
+  displayName: Docker Logout
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'logout'

package/ci/common-ci/shared-docker-test-http-steps.yml

@@ -0,0 +1,69 @@
+# Steps to test a Docker container image which exposes an http interface.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+- name: containerPort # A tcp port for http connections exposed by the container.
+  type: number
+  default: 80
+- name: machinePort # The port to open on the machine.
+  type: number
+  default: 8080
+- name: scheme # The HTTP scheme to use when testing endpoints.
+  type: string
+  default: http
+- name: endpoints # A list of URIs to test against the docker container, these should exclude the base URL, e.g. '/api/info/name'
+  type: object
+  default: []
+- name: additionalDockerArguments # Additional arguments to pass to the docker run command
+  type: string
+  default: '' 
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: 'main'
+- name: instanceName # Name of docker instance to create.
+  type: string
+  default: 'cloudInstance'
+
+steps:
+# Checkout the common-ci repo which contains the checkSlot script.
+# Special consideration is given to the Cloud project as when executing 
+# this template the, git url would resolve to git://Cloud/common-ci
+# which is not valid.
+- ${{ if eq(parameters.project, 'cloud') }}:
+  - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+- ${{ if ne(parameters.project, 'cloud') }}:
+  - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+
+# Run the docker container in detached mode with provided ports and any additional arguments provided in the parameters.
+- task: CmdLine@2
+  inputs:
+    script: 'docker run -d ${{ format(''-p {0}:{1}'', parameters.machinePort, parameters.containerPort) }} ${{ parameters.additionalDockerArguments }} --name ${{ parameters.instanceName }} ${{ parameters.imageRepository }}:${{ parameters.tag }} '
+  displayName: Run docker container
+  
+# List all active docker container instances
+- task: CmdLine@2
+  inputs:
+    script: 'docker ps'
+  displayName: List docker containers
+
+# Check the provided endpoints against the running container.
+- ${{ each endpoint in parameters.endpoints }}:
+  - task: PowerShell@2
+    displayName: 'Test ${{ parameters.scheme }}://localhost:${{ parameters.machinePort }}${{ endpoint }}'
+    inputs:
+      filePath: '$(Build.SourcesDirectory)/common-ci/scripts/azure/checkSlot.ps1'
+      arguments: '-ModulePath $(Build.SourcesDirectory)/common-ci/scripts/modules -Uri ''${{ parameters.scheme }}://localhost:${{ parameters.machinePort }}${{ endpoint }}'''
+      failOnStderr: true
+      
+# Output the logs from container instance.
+- task: CmdLine@2
+  inputs:
+    script: 'docker logs ${{ parameters.instanceName }}'
+  displayName: Output logs
+  # Always run this to make sure logs are available in failure instances.
+  condition: always()

package/ci/common-ci/shared-git-version-job.yml

@@ -1,6 +1,13 @@
 parameters:
 - name: imageName # Name of the image to run the job on
-
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+  
 jobs:
 - job: Versioning
   
@@ -16,7 +23,13 @@ jobs:
   
   # Checkout the common-ci repo so the GitVersion config file can
   # be used.
-  - checkout: 'git://$(System.TeamProject)/common-ci'
+  # Special consideration is given to the Cloud project as when executing 
+  # this template the, git url would resolve to git://Cloud/common-ci
+  # which is not valid.
+  - ${{ if eq(parameters.project, 'cloud') }}:
+    - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+  - ${{ if ne(parameters.project, 'cloud') }}:
+    - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
 
   # NOTE: This task can be used on both Windows and Linux machine so make sure to use
   # '\' instead '/', and everything is case sensitive.
@@ -52,5 +65,7 @@ jobs:
   - powershell: |
       Write-Host "##vso[task.setvariable variable=GitVersionSemVer;isOutput=true]$(GitVersion.SemVer)"
       Write-Host "##vso[task.setvariable variable=GitVersionNuGetVer;isOutput=true]$(GitVersion.NuGetVersion)"
+      Write-Host "##vso[task.setvariable variable=GitVersionAssemblyVer;isOutput=true]$(GitVersion.AssemblySemVer)"
+      Write-Host "##vso[task.setvariable variable=GitVersionAssemblyFileVer;isOutput=true]$(GitVersion.AssemblySemFileVer)"
     name: SetGitVersionVars
     displayName: 'Export GitVersion variables'

package/ci/common-ci/shared-publish-github-stage.yml

@@ -38,60 +38,64 @@ stages:
               retryCount: 5
               
           - bash: |
-             # Copy ssh keys to expected location
-             mkdir ~/.ssh
-             mv $(githubsshkey.secureFilePath) ~/.ssh/id_rsa
-             mv $(githubsshkeypublic.secureFilePath) ~/.ssh/id_rsa.pub
-             if [ ! -f ~/.ssh/id_rsa ] && [ ! -f ~/.ssh/id_rsa ]; then
-               echo "Failed to obtain ssh keys."
-               exit 1               
-             fi
-             
-             # Have to change permissions on key files in order for SSH to work with them.
-             chmod 600 ~/.ssh/id_rsa
-             chmod 600 ~/.ssh/id_rsa.pub
-             export id_rsa_perm=`stat -c '%a' ~/.ssh/id_rsa`
-             export id_rsa_pub_perm=`stat -c '%a' ~/.ssh/id_rsa.pub`
-             if [ "$id_rsa_perm" != "600" ] && [ "$id_rsa_pub_perm" != "600" ]; then
-                echo "Failed to change permission on key files."
+              # Copy ssh keys to expected location
+              mkdir ~/.ssh
+              mv $(githubsshkey.secureFilePath) ~/.ssh/id_rsa
+              mv $(githubsshkeypublic.secureFilePath) ~/.ssh/id_rsa.pub
+              if [ ! -f ~/.ssh/id_rsa ] && [ ! -f ~/.ssh/id_rsa ]; then
+                echo "Failed to obtain ssh keys."
+                exit 1               
+              fi
+              
+              # Have to change permissions on key files in order for SSH to work with them.
+              chmod 600 ~/.ssh/id_rsa
+              chmod 600 ~/.ssh/id_rsa.pub
+              export id_rsa_perm=`stat -c '%a' ~/.ssh/id_rsa`
+              export id_rsa_pub_perm=`stat -c '%a' ~/.ssh/id_rsa.pub`
+              if [ "$id_rsa_perm" != "600" ] && [ "$id_rsa_pub_perm" != "600" ]; then
+                 echo "Failed to change permission on key files."
+                 exit 1
+              fi
+              
+              # Uncomment the line below to debug issues with SSH
+              #ssh -vT git@github.com
+              
+              echo "Cloning git repository"
+              git clone https://a:$(System.AccessToken)@dev.azure.com/51degrees/$(System.TeamProject)/_git/$(Build.Repository.Name) source
+              if [ ! -d source ]; then
+                echo "Failed to checkout repository."
+                exit 1
+              fi
+              
+              cd source
+              
+              echo "Checking out branch '$(Build.SourceBranchName)'"
+              git checkout $(Build.SourceBranchName)
+              if [ $? != 0 ]; then
+                echo "Failed to checkout branch '$(Build.SourceBranchName)'."
                 exit 1
-             fi
-             
-             # Uncomment the line below to debug issues with SSH
-             #ssh -vT git@github.com
-             
-             echo "Cloning git repository"
-             git clone https://a:$(System.AccessToken)@dev.azure.com/51degrees/$(System.TeamProject)/_git/$(Build.Repository.Name) source
-             if [ ! -d source ]; then
-               echo "Failed to checkout repository."
-               exit 1
-             fi
-             
-             cd source
-             
-             echo "Checking out branch '$(Build.SourceBranchName)'"
-             git checkout $(Build.SourceBranchName)
-             if [ $? != 0 ]; then
-               echo "Failed to checkout branch '$(Build.SourceBranchName)'."
-               exit 1
-             fi
-             
-             echo "Adding GitHub remote"
-             git remote add github git@github.com:51Degrees/$(Build.Repository.Name).git
-             if [ $? != 0 ]; then
-               echo "Failed to add GitHub remote."
-               exit 1
-             fi
-             
-             echo "Pushing branch '$(Build.SourceBranchName)' to GitHub"
-             git push github $(Build.SourceBranchName)
-             if [ $? != 0 ]; then
-               echo "Failed to push branch '$(Build.SourceBranchName)' to GitHub."
-               exit 1
-             fi
+              fi
+              
+              echo "Adding GitHub remote"
+              git remote add github git@github.com:51Degrees/$(Build.Repository.Name).git
+              if [ $? != 0 ]; then
+                echo "Failed to add GitHub remote."
+                exit 1
+              fi
+              
+              echo "Pushing branch '$(Build.SourceBranchName)' to GitHub"
+              git push github $(Build.SourceBranchName)
+              if [ $? != 0 ]; then
+                echo "Failed to push branch '$(Build.SourceBranchName)' to GitHub."
+                exit 1
+              fi
+            displayName: 'Push branch to Github'
 
           - ${{ if eq(parameters.skipTagging, false) }}:
             - bash: |
+                # Move to checkout directory in previous task.
+                cd source
+                
                 export tagName="`git tag --points-at $(Build.SourceBranchName)`"
                 
                 echo "Pushing tag '$tagName' to GitHub"
@@ -101,4 +105,3 @@ stages:
                   exit 1
                 fi
               displayName: 'Push tags to GitHub'
-              failOnStderr: true

package/ci/common-ci/shared-submodule-trigger-stage.yml

@@ -1,3 +1,24 @@
+parameters:
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: releaseConfigFile # The release config file to load.
+  displayName: 'Release Config File'
+  type: string
+  default: release-config.json
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+- name: depTeamProjectName # The DevOps project containing the dependencies.
+  displayName: 'Release Config File'
+  type: string
+  default: ''
+- name: prTeamProjectName # The project containing the repo to update.
+  displayName: 'Release Config File'
+  type: string
+  default: ''
+
 stages:
 - stage: UpdateReference
   displayName: 'Update Reference'
@@ -15,8 +36,38 @@ stages:
     - checkout: self
       submodules: recursive
       persistCredentials: true
+
       # Checkout the common-ci to access the latest release configuration.
-    - checkout: 'git://$(System.TeamProject)/common-ci'
+      # Special consideration is given to the Cloud project as when executing 
+      # this template the, git url would resolve to git://Cloud/common-ci
+      # which is not valid.
+    - ${{ if eq(parameters.project, 'cloud') }}:
+      - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+    - ${{ if ne(parameters.project, 'cloud') }}:
+      - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+
+    - task: PowerShell@2
+      inputs:
+        targetType: 'inline'
+        script: |
+          # Get the project names or IDs from parameters
+          $depTeamProjectName = "${{ parameters.depTeamProjectName }}"
+          $prTeamProjectName = "${{ parameters.prTeamProjectName }}"
+
+          # If the parameters are not set then use the default which should be
+          # the current project.
+          if(-not $depTeamProjectName -or '' -eq $depTeamProjectName){
+            $depTeamProjectName = "$(System.TeamProjectId)"
+          }
+
+          if(-not $prTeamProjectName -or '' -eq $prTeamProjectName){
+            $prTeamProjectName = "$(System.TeamProjectId)"
+          }
+          
+          # Set project name variables for use in later steps
+          echo "##vso[task.setvariable variable=depTeamProjectName]$depTeamProjectName"
+          echo "##vso[task.setvariable variable=prTeamProjectName]$prTeamProjectName"
+      name: DefaultProjectNames
       
     - powershell: |
         # Install all modules
@@ -24,7 +75,7 @@ stages:
         Write-Host "Module Path: $($Env:PsModulePath)"
         
         # Get release-config.json path
-        $configFile = "$($(Get-Location).Path)\common-ci\release-config.json"
+        $configFile = "$($(Get-Location).Path)\common-ci\${{ parameters.releaseConfigFile }}"
         
         # Cancel any previous builds
         Write-Host ""
@@ -37,7 +88,7 @@ stages:
             -PipelineName $Env:BUILD_DEFINITIONNAME `
             -Branch $Env:BUILD_SOURCEBRANCH `
             -CurrentBuildId $Env:BUILD_BUILDID `
-            -TeamProjectName $Env:SYSTEM_TEAMPROJECTID)) {
+            -TeamProjectName $(prTeamProjectName))) {
             Write-Host "# ERROR: Failed to cancel the previous builds."
             exit 1
         }
@@ -47,7 +98,8 @@ stages:
         Write-Host "# Try to update repository $Env:BUILD_REPOSITORY_NAME."
         if (!$(Update-CommitPushPull `
             -ConfigFile $configFile `
-            -TeamProjectName $Env:SYSTEM_TEAMPROJECTID)) {
+            -DepTeamProjectName $(depTeamProjectName) `
+            -PrTeamProjectName $(prTeamProjectName))) {
             Write-Host "# ERROR: Failed to update submodule references and package dependencies."
             exit 1
         }

package/ci/common-ci/shared-variables.yml

@@ -1,3 +1,7 @@
 variables:
+- name: windowsImage
+  value: 'windows-2019'
 - name: linuxImage
-  value: 'ubuntu-18.04'
+  value: 'ubuntu-18.04'
+- name: macImage
+  value: 'macOS-11'

package/ci/create-packages.yml

@@ -6,20 +6,20 @@ trigger:
 # Don't trigger for a pull request
 pr: none
 
+resources:
+  repositories:
+    - repository: ciTemplates # Id of the repository used to reference to in this script
+      type: git
+      name: common-ci # Name of the actual repository
+
 # Include shared variables
 variables:
-- template: shared-variables.yml
+- template: shared-variables.yml@ciTemplates
 - group: CIAutomation
 # Access token for the git repository. Used by the git tag task.
 - name: system_accesstoken
   value: $(System.AccessToken)
 
-resources:
-  repositories:
-    - repository: ciTemplates # Id of the repository used to reference to in this script
-      type: git
-      name: common-ci # Name of the actual repository
-
 stages:
 
 - stage: Publish

package/ci/deploy-external.yml

@@ -19,7 +19,7 @@ resources:
 
 # Include shared variables
 variables:
-- template: shared-variables.yml
+- template: shared-variables.yml@ciTemplates
 - name: targetBranch
   value: 'refs/heads/master'
 - group: CIAutomation

package/ci/deploy-internal.yml

@@ -19,7 +19,7 @@ resources:
 
 # Include shared variables
 variables:
-- template: shared-variables.yml
+- template: shared-variables.yml@ciTemplates
 - name: targetBranch
   value: 'refs/heads/master'
 - group: CIAutomation

package/ci/shared-build-and-test-stage.yml

@@ -28,6 +28,8 @@ stages:
           node_version: 12.x
         node_14_x:
           node_version: 14.x
+        node_16_x:
+          node_version: 16.x
       maxParallel: 1
     
     steps:
@@ -59,13 +61,14 @@ stages:
     # in 'InternalKeys' group
     # 2. Install dependencies.
     # 3. Run tests.
+    # TODO: Remove specific device detection version once 4.3.3 released
     - bash: |
         echo "Resource key for testing = $(SuperResourceKey)"
         export RESOURCE_KEY="$(SuperResourceKey)"
         echo "Cloud endpoint for testing = $(FOD_CLOUD_API_URL)"
         export FOD_CLOUD_API_URL="$(FOD_CLOUD_API_URL)"
         npm install
-        npm install fiftyone.devicedetection
+        npm install fiftyone.devicedetection@4.3.3-beta.1
         npm test
       displayName: 'Build and Test'
     
@@ -105,7 +108,7 @@ stages:
         echo $eslint
         echo $eslint > .eslintrc
         npm install -g eslint@6.8.0
-        eslint **/*.js
+        eslint '**/*.js'
       displayName: "Set up and run eslint"
       condition: ne(variables['node_version'], '6.x')
       failOnStderr: true

package/ci/shared-variables.yml

@@ -1,7 +1 @@
-variables:
-- name: windowsImage
-  value: 'vs2017-win2016'
-- name: linuxImage
-  value: 'ubuntu-18.04'
-- name: macImage
-  value: 'macOS-10.14'
+# Shared variables between yaml files

package/examples/examples.test.js

@@ -61,17 +61,17 @@ try {
 }
 
 if (isAsync) {
-  test('cloud getting started', (done) => {
+  test('cloud getting started', async (done) => {
     setTimeout(done, 1000);
 
     testExample({ file: (__dirname) + '/gettingStarted.js' });
   });
-  test('combining services', (done) => {
+  test('combining services', async (done) => {
     setTimeout(done, 1000);
 
     testExample({ file: (__dirname) + '/combiningServices.js' });
   });
-  test('configure from file', (done) => {
+  test('configure from file', async (done) => {
     setTimeout(done, 1000);
 
     testExample({ file: (__dirname) + '/configureFromFile.js' });