fiftyone.geolocation 4.3.0 → 4.3.5

package/ci/create-packages.yml

@@ -6,40 +6,41 @@ trigger:
 # Don't trigger for a pull request
 pr: none
 
-# Schedule to run overnight
-schedules:
-- cron: "0 20 * * *"
-  displayName: Daily overnight build
-  branches:
-    include:
-    - develop
-
 # 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:
-- template: shared-build-and-test-platforms.yml
-  parameters:
-    windowsImage: $(windowsImage)
-    linuxImage: $(linuxImage)
-    macImage: $(macImage)
 
 - stage: Publish
-  dependsOn: [Windows,Linux,MacOS]
 
   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
-        # Access token for the git repository. Used by the git tag task.
-      - name: system_accesstoken
-        value: $(System.AccessToken)
+      - name: GitVersionSemVer
+        value: $[ dependencies.Versioning.outputs['SetGitVersionVars.GitVersionSemVer'] ]
     
     steps:
     # The lines below are needed to allow the pipeline access to the
@@ -50,13 +51,6 @@ 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
-      inputs:
-        preferBundledVersion: false
-    
     # Set version number.
     - task: Npm@1
       displayName: 'npm version fiftyone.geolocation'
@@ -64,7 +58,7 @@ stages:
         command: 'custom'
         workingDir: '$(System.DefaultWorkingDirectory)'
         verbose: true
-        customCommand: 'version --no-git-tag-version $(GitVersion.SemVer)'
+        customCommand: 'version --no-git-tag-version $(GitVersionSemVer)'
       continueOnError: true
       condition: succeededOrFailed()
     
@@ -101,17 +95,6 @@ stages:
       condition: succeededOrFailed()
       failOnStderr: true
     
-    # Add a tag to the git repository with the version number of
-    # the package that has just been published
-    - task: ATP.ATP-GitTag.GitTag.GitTag@5
-      displayName: 'Tag Repo With Version Number'
-      inputs:
-        tagUser: 'Azure DevOps'
-        tagEmail: 'CIUser@51Degrees.com'
-    # Only create the tag if we also published a package as defined in 
-    # the previous task.
-      condition: succeeded()
-    
     # Publish artifacts to DevOps
     - task: PublishBuildArtifacts@1
       inputs:
@@ -119,3 +102,8 @@ stages:
         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.yml → deploy-internal.yml}

@@ -22,6 +22,7 @@ variables:
 - template: shared-variables.yml
 - name: targetBranch
   value: 'refs/heads/master'
+- group: CIAutomation
 
 stages:
 - stage: publish_internal
@@ -42,35 +43,8 @@ stages:
           #- bash: 'ls -R "$(PIPELINE.WORKSPACE)"'
           #  displayName: 'List files and directories'
           
-          - template: shared-extract-and-publish-packages.yml
+          - template: node/shared-extract-and-publish-packages.yml@ciTemplates
             parameters:
               publishConnection: 'NPM internal'
               packageName: 'fiftyone.geolocation'
-              
-- stage: publish_npm
-  displayName: Publish to NPM
-  dependsOn: []
-  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: shared-extract-and-publish-packages.yml
-            parameters:
-              publishConnection: 'NPM publish connection'
-              packageName: 'fiftyone.geolocation'
-
-
-- template: shared-publish-github-stage.yml@ciTemplates
-  parameters:
-    imageName: $(linuxImage)
-    branchName: ${{ variables.targetBranch }}
+              internalFeedId: $(InternalFeedId)

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

@@ -2,19 +2,25 @@ 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 }}
+    imageName: ${{ parameters.macImage }}
+    runTests: ${{ parameters.runTests }}

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

@@ -1,6 +1,9 @@
 parameters:
 - name: stageName
 - name: imageName
+- name: runTests
+  type: string
+  default: 'On'
 
 stages:
 - stage: ${{ parameters.stageName }}
@@ -9,6 +12,7 @@ stages:
   jobs:
   - job: Build_and_Test
     displayName: Build and Test
+    condition: ne(${{ parameters.runTests }}, 'Off')
 
     pool:
       vmImage: ${{ parameters.imageName }}
@@ -24,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:
@@ -55,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'
     
@@ -101,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/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/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,14 +20,6 @@
  * 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 = require('fiftyone.pipeline.cloudrequestengine').CloudRequestEngine;
 const PipelineBuilder = require('fiftyone.pipeline.core').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,6 +1,6 @@
 {
   "name": "fiftyone.geolocation",
-  "version": "4.3.0",
+  "version": "4.3.5",
   "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.0",
-    "fiftyone.pipeline.core": "^4.3.0",
-    "fiftyone.pipeline.engines": "^4.3.0",
-    "fiftyone.pipeline.engines.fiftyone": "^4.3.0"
+    "fiftyone.pipeline.cloudrequestengine": "^4.3.6",
+    "fiftyone.pipeline.core": "^4.3.6",
+    "fiftyone.pipeline.engines": "^4.3.6",
+    "fiftyone.pipeline.engines.fiftyone": "^4.3.6"
   },
   "devDependencies": {
     "@types/node": "^15.12.2",
@@ -30,7 +30,7 @@
     "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"
   },
@@ -42,7 +42,11 @@
     "outputName": "test_results.xml"
   },
   "jest": {
-    "setupTestFrameworkScriptFile": "jest-expect-message",
+    "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