fiftyone.geolocation 4.2.1 → 4.3.3

package/ci/create-packages.yml

@@ -0,0 +1,109 @@
+trigger:
+  - master
+  - develop
+  - release/*  
+
+# Don't trigger for a pull request
+pr: none
+
+# Include shared variables
+variables:
+- template: shared-variables.yml
+- 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
+
+  jobs:
+  - template: shared-git-version-job.yml@ciTemplates
+    parameters:
+      imageName: $(linuxImage)
+
+  - job: Publish
+    displayName: Publish Packages
+    dependsOn: Versioning
+    condition: and(succeeded(), ne(variables['CreatePackages'], 'Off'))
+
+    pool:
+      vmImage: $(linuxImage)
+    
+    variables:
+      - group: PackageFeedAccessToken
+      - name: GitVersionSemVer
+        value: $[ dependencies.Versioning.outputs['SetGitVersionVars.GitVersionSemVer'] ]
+    
+    steps:
+    # The lines below are needed to allow the pipeline access to the
+    # OAuth access token that controls write access to the git repository. 
+    # (Required for GitTag task)
+    - checkout: self
+      lfs: true
+      submodules: recursive
+      persistCredentials: true
+    
+    # Set version number.
+    - task: Npm@1
+      displayName: 'npm version fiftyone.geolocation'
+      inputs:
+        command: 'custom'
+        workingDir: '$(System.DefaultWorkingDirectory)'
+        verbose: true
+        customCommand: 'version --no-git-tag-version $(GitVersionSemVer)'
+      continueOnError: true
+      condition: succeededOrFailed()
+    
+    # Create packages
+    - script: |
+        npm pack
+      displayName: 'Create npm package for later release'
+      condition: succeededOrFailed()
+    
+    # Copy artifacts contents.
+    - task: CopyFiles@2
+      inputs:
+        sourceFolder: '$(Build.SourcesDirectory)'
+        contents: '**/*.tgz' 
+        targetFolder: $(Build.ArtifactStagingDirectory)/npm/fiftyone.geolocation
+      displayName: 'Copy tgz files'
+      condition: succeededOrFailed()
+    
+    - task: CopyFiles@2
+      inputs:
+        sourceFolder: '$(Build.SourcesDirectory)'
+        contents: '**/package.json' 
+        targetFolder: $(Build.ArtifactStagingDirectory)/npm/fiftyone.geolocation
+      displayName: 'Copy package.json files'
+      condition: succeededOrFailed()
+    
+    - script: |
+        ls $(Build.ArtifactStagingDirectory)/npm/fiftyone.geolocation/*fiftyone.geolocation*.tgz
+        if [ $? -ne 0 ]; then
+          echo "ERROR: Could not find packed module."
+          exit 1
+        fi
+      displayName: 'List artifact staging contents'
+      condition: succeededOrFailed()
+      failOnStderr: true
+    
+    # Publish artifacts to DevOps
+    - task: PublishBuildArtifacts@1
+      inputs:
+        pathtoPublish: '$(Build.ArtifactStagingDirectory)/npm'
+        artifactName: npm
+      displayName: 'Publish npm artifact'
+      condition: succeededOrFailed()
+
+  - template: shared-git-tag-job.yml@ciTemplates
+    parameters:
+      imageName: $(linuxImage)
+      jobDependencies: [Versioning,Publish]

package/ci/deploy-external.yml

@@ -0,0 +1,55 @@
+# Disable automatic runs of this pipeline when changes are pushed to the repository.
+trigger: none
+
+# Disable automatic runs of this pipeline when a PR is create.
+pr: none
+
+# Add the pipeline that builds the packages as a resource.
+# This allows the deployment pipeline to be triggered whenever
+# the build pipeline completes.
+resources:
+  pipelines:
+  - pipeline: build-pipeline   # The name for the triggering build pipeline within this script
+    source: location-node-create-packages # Name of the pipeline from here: https://51degrees.visualstudio.com/Pipeline/_build
+    trigger: true 
+  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
+- name: targetBranch
+  value: 'refs/heads/master'
+- group: CIAutomation
+
+stages:
+              
+- stage: publish_npm
+  displayName: Publish to NPM
+  condition: eq(variables['build.sourceBranch'], variables['targetBranch'])
+  jobs:
+  - deployment: deploy_npm
+    displayName: Deploy to NPM
+    pool:
+      vmImage: $(linuxImage)
+      workspace:
+        clean: all
+    environment: npm
+    strategy:
+      runOnce:
+        deploy:
+          steps: 
+          
+          - template: node/shared-extract-and-publish-packages.yml@ciTemplates
+            parameters:
+              publishConnection: 'NPM publish connection'
+              packageName: 'fiftyone.geolocation'
+              internalFeedId: $(InternalFeedId)
+
+
+- template: shared-publish-github-stage.yml@ciTemplates
+  parameters:
+    imageName: $(linuxImage)
+    branchName: ${{ variables.targetBranch }}

package/ci/deploy-internal.yml

@@ -0,0 +1,50 @@
+# Disable automatic runs of this pipeline when changes are pushed to the repository.
+trigger: none
+
+# Disable automatic runs of this pipeline when a PR is create.
+pr: none
+
+# Add the pipeline that builds the packages as a resource.
+# This allows the deployment pipeline to be triggered whenever
+# the build pipeline completes.
+resources:
+  pipelines:
+  - pipeline: build-pipeline   # The name for the triggering build pipeline within this script
+    source: location-node-create-packages # Name of the pipeline from here: https://51degrees.visualstudio.com/Pipeline/_build
+    trigger: true 
+  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
+- name: targetBranch
+  value: 'refs/heads/master'
+- group: CIAutomation
+
+stages:
+- stage: publish_internal
+  displayName: Publish Internal
+  jobs:
+  # Note - A 'deployment' job will automatically download the artifacts created by the triggering pipeline.
+  - deployment: deploy_internal
+    displayName: Deploy Internal
+    pool:
+      vmImage: $(linuxImage)
+      workspace:
+        clean: all
+    environment: packages-internal
+    strategy:
+      runOnce:
+        deploy:
+          steps:
+          #- bash: 'ls -R "$(PIPELINE.WORKSPACE)"'
+          #  displayName: 'List files and directories'
+          
+          - template: node/shared-extract-and-publish-packages.yml@ciTemplates
+            parameters:
+              publishConnection: 'NPM internal'
+              packageName: 'fiftyone.geolocation'
+              internalFeedId: $(InternalFeedId)

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

@@ -0,0 +1,26 @@
+parameters:
+- name: windowsImage
+- name: linuxImage
+- name: macImage
+- name: runTests
+  type: string
+  default: 'On'
+
+stages:
+- template: shared-build-and-test-stage.yml
+  parameters:
+    stageName: Windows
+    imageName: ${{ parameters.windowsImage }}
+    runTests: ${{ parameters.runTests }}
+
+- template: shared-build-and-test-stage.yml
+  parameters:
+    stageName: Linux
+    imageName: ${{ parameters.linuxImage }}
+    runTests: ${{ parameters.runTests }}
+    
+- template: shared-build-and-test-stage.yml
+  parameters:
+    stageName: MacOS
+    imageName: ${{ parameters.macImage }}
+    runTests: ${{ parameters.runTests }}

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

@@ -0,0 +1,128 @@
+parameters:
+- name: stageName
+- name: imageName
+- name: runTests
+  type: string
+  default: 'On'
+
+stages:
+- stage: ${{ parameters.stageName }}
+  dependsOn: []
+
+  jobs:
+  - job: Build_and_Test
+    displayName: Build and Test
+    condition: ne(${{ parameters.runTests }}, 'Off')
+
+    pool:
+      vmImage: ${{ parameters.imageName }}
+    
+    variables:
+      - group: InternalKeys
+      
+    strategy:
+      matrix:
+        node_10_x:
+          node_version: 10.x
+        node_12_x:
+          node_version: 12.x
+        node_14_x:
+          node_version: 14.x
+        node_16_x:
+          node_version: 16.x
+      maxParallel: 1
+    
+    steps:
+    - checkout: self
+      lfs: true
+      submodules: recursive
+    
+    - task: NodeTool@0
+      inputs:
+        versionSpec: $(node_version)
+      displayName: 'Install Node.js'
+    
+    # The secure file to download will be stored in the 
+    # Pipelines/Library/SecureFiles section in Azure DevOps.
+    - task: DownloadSecureFile@1
+      displayName: 'Download .npmrc'
+      name: npmrc
+      inputs:
+        secureFile: '.npmrc'
+    
+    - task: CopyFiles@2
+      displayName: 'Copy .npmrc to working directory'
+      inputs:
+        sourceFolder: '$(Agent.TempDirectory)'
+        targetFolder: '$(System.DefaultWorkingDirectory)'
+        contents: '.npmrc'
+    
+    # 1. Set resource key environment variable from location resource key value 
+    # 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@4.3.3-beta.1
+        npm test
+      displayName: 'Build and Test'
+    
+    - bash: |
+        eslint='{
+            "env": {
+                "browser": true,
+                "commonjs": true,
+                "es6": true
+            },
+            "extends": [
+                "standard"
+            ],
+            "globals": {
+                "Atomics": "readonly",
+                "SharedArrayBuffer": "readonly",
+                "test": true,
+                "jest": true,
+                "expect": true,
+                "resourceKey": true
+            },
+            "parserOptions": {
+                "ecmaVersion": 2018
+            },
+            "rules": {
+              "node/no-deprecated-api": "off",
+              "no-throw-literal": "off",
+              "no-path-concat": "off",
+              "no-prototype-builtins": "off",
+              "no-eval": "off",
+              "semi": [
+                  2,
+                  "always"
+              ]
+            }
+          }'
+        echo $eslint
+        echo $eslint > .eslintrc
+        npm install -g eslint@6.8.0
+        eslint '**/*.js'
+      displayName: "Set up and run eslint"
+      condition: ne(variables['node_version'], '6.x')
+      failOnStderr: true
+    
+    - task: PublishTestResults@2
+      condition: succeededOrFailed()
+      inputs:
+        testRunner: JUnit
+        testResultsFiles: '**/test_results.xml'
+        testRunTitle: 'Node $(node_version) ${{ parameters.stageName }}'
+    
+    - task: PublishCodeCoverageResults@1
+      inputs: 
+        codeCoverageTool: Cobertura
+        summaryFileLocation: '$(System.DefaultWorkingDirectory)/**/*coverage.xml'
+        reportDirectory: '$(System.DefaultWorkingDirectory)/**/coverage'
+

package/ci/shared-variables.yml

@@ -0,0 +1,7 @@
+variables:
+- name: windowsImage
+  value: 'vs2017-win2016'
+- name: linuxImage
+  value: 'ubuntu-18.04'
+- name: macImage
+  value: 'macOS-10.14'

package/ci/submodule-trigger.yml

@@ -0,0 +1,12 @@
+trigger: none
+
+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
+
+stages:
+- template: shared-submodule-trigger-stage.yml@ciTemplates

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.2
+PROJECT_NUMBER         = 4.3
 
 # 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.2/index.html
+PROJECT_URL            = ../../documentation/4.3/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.2
+HTML_OUTPUT            = 4.3
 
 # 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.2/index.html"/>
+    <tab type="user" visible="yes" title="General Docs" url="../../documentation/4.3/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/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' });

package/geoLocationPipelineBuilder.js

@@ -20,18 +20,10 @@
  * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
-const require51 = (requestedPackage) => {
-  try {
-    return require(__dirname + '/../' + requestedPackage);
-  } catch (e) {
-    return require(requestedPackage);
-  }
-};
-
 const GeoLocationCloud = require('./geoLocationCloud');
-const CloudRequestEngine = require51('fiftyone.pipeline.cloudrequestengine').CloudRequestEngine;
-const PipelineBuilder = require51('fiftyone.pipeline.core').PipelineBuilder;
-const ShareUsageElement = require51('fiftyone.pipeline.engines.fiftyone').ShareUsage;
+const CloudRequestEngine = require('fiftyone.pipeline.cloudrequestengine').CloudRequestEngine;
+const PipelineBuilder = require('fiftyone.pipeline.core').PipelineBuilder;
+const ShareUsageElement = require('fiftyone.pipeline.engines.fiftyone').ShareUsage;
 
 class GeoLocationPipelineBuilder extends PipelineBuilder {
   /**
@@ -40,9 +32,17 @@ class GeoLocationPipelineBuilder extends PipelineBuilder {
      * @param {Boolean} options.shareUsage // include share usage element?
      * @param {String} options.resourceKey // resourceKey for cloud
      * @param {String} options.locationProvider // the provider to request data from. Either "fiftyonedegrees" or "digitalelement".
+     * @param {string} options.cloudRequestOrigin The value to set the
+     * Origin header to when making requests to the cloud service
      *
     */
-  constructor ({ shareUsage = true, resourceKey = null, locationProvider = 'fiftyonedegrees', baseURL = null }) {
+  constructor ({
+    shareUsage = true,
+    resourceKey = null,
+    locationProvider = 'fiftyonedegrees',
+    baseURL = null,
+    cloudRequestOrigin = null
+  }) {
     super(...arguments);
 
     // Check if share usage enabled and add it to the pipeline if so
@@ -53,7 +53,10 @@ class GeoLocationPipelineBuilder extends PipelineBuilder {
 
     // First we need the cloudRequestEngine
 
-    const cloudRequestEngineOptions = { resourceKey: resourceKey };
+    const cloudRequestEngineOptions = {
+      resourceKey: resourceKey,
+      cloudRequestOrigin: cloudRequestOrigin
+    };
     if (baseURL !== null) {
       cloudRequestEngineOptions.baseURL = baseURL;
     }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "fiftyone.geolocation",
-  "version": "4.2.1",
+  "version": "4.3.3",
   "description": "Geo-location services for the 51Degrees Pipeline API",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "directories": {
     "test": "tests"
   },
@@ -16,19 +17,21 @@
     "Joseph Dix <joseph@51degrees.com> (https://51degrees.com)"
   ],
   "dependencies": {
-    "fiftyone.pipeline.cloudrequestengine": "^4.2.1",
-    "fiftyone.pipeline.core": "^4.2.1",
-    "fiftyone.pipeline.engines": "^4.2.1",
-    "fiftyone.pipeline.engines.fiftyone": "^4.2.1"
+    "fiftyone.pipeline.cloudrequestengine": "^4.3.5",
+    "fiftyone.pipeline.core": "^4.3.5",
+    "fiftyone.pipeline.engines": "^4.3.5",
+    "fiftyone.pipeline.engines.fiftyone": "^4.3.5"
   },
   "devDependencies": {
+    "@types/node": "^15.12.2",
     "eslint": "^6.8.0",
     "eslint-config-standard": "^14.1.1",
     "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
-    "jest": "^24.9.0",
+    "jest": "^27.0.6",
+    "jest-expect-message": "^1.0.2",
     "jest-junit": "^9.0.0"
   },
   "license": "EUPL-1.2",
@@ -39,6 +42,11 @@
     "outputName": "test_results.xml"
   },
   "jest": {
+    "testRunner": "jest-jasmine2",
+    "setupFilesAfterEnv": [
+      "./setup.js",
+      "jest-expect-message"
+    ],
     "globals": {
       "resourceKey": "!!YOUR_RESOURCE_KEY!!"
     }

package/setup.js

@@ -0,0 +1 @@
+jest.setTimeout(10000); // in milliseconds