fiftyone.geolocation 4.2.1 → 4.3.3

package/tests/geoLocationCloud.test.js

@@ -24,6 +24,40 @@ const GeoLocation = require(__dirname +
     '/..');
 const myResourceKey = process.env.RESOURCE_KEY || '!!YOUR_RESOURCE_KEY!!';
 
+const TestLat = '51.4578261';
+const TestLon = '-0.975922996290084';
+const expectedProperties = {
+  location: [
+    'javascript',
+    'building',
+    'streetnumber',
+    'road',
+    'town',
+    // For some reason, the value of the 'county' property returned
+    // by the call to the cloud is always null on the build agent,
+    // despite working correctly locally.
+    // After spending the best part of a day trying to resolve this,
+    // we've  decided to exclude the county property from this test
+    // for the moment.
+    // 'county',
+    'region',
+    'state',
+    'zipcode',
+    'country',
+    'countrycode'
+  ],
+  location_digitalelement: [
+    'javascript',
+    'town',
+    'county',
+    'region',
+    'state',
+    'zipcode',
+    'country',
+    'countrycode'
+  ]
+};
+
 // Skip the rest of the examples when async is not available
 let isAsync = true;
 
@@ -58,7 +92,165 @@ if (isAsync) {
       done();
     });
   });
+
+  test('Available Properties 51Degrees', async done => {
+    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
+      throw new Error('No resource key is present!');
+    }
+
+    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
+      resourceKey: myResourceKey,
+      locationProvider: 'fiftyonedegrees'
+    }).build();
+    var engine = pipeline.flowElements.location;
+
+    await testAvailableProperties(done, pipeline, engine);
+  });
+
+  test('Available Properties Digital Element', async done => {
+    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
+      throw new Error('No resource key is present!');
+    }
+
+    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
+      resourceKey: myResourceKey,
+      locationProvider: 'digitalelement'
+    }).build();
+    var engine = pipeline.flowElements.location_digitalelement;
+
+    await testAvailableProperties(done, pipeline, engine);
+  });
+
+  test('Value Types 51Degrees', async done => {
+    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
+      throw new Error('No resource key is present!');
+    }
+
+    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
+      resourceKey: myResourceKey,
+      locationProvider: 'fiftyonedegrees'
+    }).build();
+    var engine = pipeline.flowElements.location;
+
+    await testValueTypes(done, pipeline, engine);
+  });
+
+  test('Value Types DigitalElement', async done => {
+    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
+      throw new Error('No resource key is present!');
+    }
+
+    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
+      resourceKey: myResourceKey,
+      locationProvider: 'digitalelement'
+    }).build();
+    var engine = pipeline.flowElements.location_digitalelement;
+
+    await testValueTypes(done, pipeline, engine);
+  });
 } else {
   // Skip if async is not available (e.g node 6)
   test.skip('Workaround', () => 1);
 }
+
+async function testAvailableProperties (done, pipeline, engine) {
+  const flowData = pipeline.createFlowData();
+
+  flowData.evidence.add('query.51D_Pos_latitude', TestLat);
+  flowData.evidence.add('query.51D_Pos_longitude', TestLon);
+
+  await flowData.process();
+
+  expectedProperties[engine.dataKey].forEach(key => {
+    try {
+      var apv = flowData[engine.dataKey][key];
+      if (apv === undefined) {
+        done.fail(new Error(`Aspect property value for ${key} should not be undefined.`));
+      }
+      expect(apv).not.toBeNull();
+      expect(apv).toBeDefined();
+      if (apv.hasValue === true) {
+        if (apv.value == null || apv.value === undefined) {
+          done.fail(new Error(`${key}.value should not be null`));
+        }
+      } else {
+        if (apv.noValueMessage == null || apv.noValueMessage === undefined) {
+          done.fail(new Error(`${key}.noValueMessage should not be null`));
+        }
+      }
+    } catch (err) {
+      done.fail(err);
+    }
+  });
+  done();
+}
+
+async function testValueTypes (done, pipeline, engine) {
+  const flowData = pipeline.createFlowData();
+
+  flowData.evidence.add('query.51D_Pos_latitude', TestLat);
+  flowData.evidence.add('query.51D_Pos_longitude', TestLon);
+
+  await flowData.process();
+
+  Object.keys(engine.properties).forEach(key => {
+    if (expectedProperties[engine.dataKey].includes(key)) {
+      var property = engine.properties[key.toLowerCase()];
+      var expectedType = property.type;
+      var apv = flowData[engine.dataKey][key];
+
+      expect(apv).not.toBeNull();
+      expect(apv).toBeDefined();
+      expect(apv.hasValue, 'No value for \'' + key + '\'. (' + apv.noValueMessage + ')').toBe(true);
+      expect(apv.value).toBe51DType(key, expectedType);
+    }
+  });
+
+  done();
+}
+
+expect.extend({
+  // Method to validate a given value has the expected type.
+  toBe51DType (received, name, fodType) {
+    var valueType = typeof received;
+    var valid = false;
+
+    switch (fodType) {
+      case 'Boolean':
+        valid = valueType === 'boolean';
+        break;
+      case 'String':
+        valid = valueType === 'string';
+        break;
+      case 'JavaScript':
+        valid = valueType === 'string';
+        break;
+      case 'Int32':
+        valid = valueType === 'number';
+        break;
+      case 'Double':
+        valid = valueType === 'number';
+        break;
+      case 'Array':
+        valid = valueType === 'object' && Array.isArray(received);
+        break;
+      default:
+        valid = false;
+        break;
+    }
+
+    if (valid) {
+      return {
+        message: () =>
+          `${name}: expected node type '${valueType}' not to be equivalent to fodType '${fodType}' for value: '${received}'`,
+        pass: true
+      };
+    } else {
+      return {
+        message: () =>
+          `${name}: expected node type '${valueType}' to be equivalent to fodType '${fodType}' for value: '${received}'`,
+        pass: false
+      };
+    }
+  }
+});

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    // Change this to match your project
+    "include": ["*"],
+    "compilerOptions": {
+      // Tells TypeScript to read JS files, as
+      // normally they are ignored as source files
+      "allowJs": true,
+      // Generate d.ts files
+      "declaration": true,
+      // This compiler run should
+      // only output d.ts files
+      "emitDeclarationOnly": true,
+      // Types should go into this directory.
+      // Removing this would place the .d.ts files
+      // next to the .js files
+      "outDir": "types",
+      "lib": ["ES2015"],
+      "moduleResolution": "Node",
+      "noImplicitAny": true
+    }
+  }

package/types/geoLocationCloud.d.ts

@@ -0,0 +1,7 @@
+export = GeoLocationCloud;
+declare const GeoLocationCloud_base: typeof import("fiftyone.pipeline.cloudrequestengine/types/cloudEngine");
+declare class GeoLocationCloud extends GeoLocationCloud_base {
+    constructor({ locationProvider }: {
+        locationProvider: any;
+    }, ...args: any[]);
+}

package/types/geoLocationPipelineBuilder.d.ts

@@ -0,0 +1,17 @@
+export = GeoLocationPipelineBuilder;
+declare const GeoLocationPipelineBuilder_base: typeof import("fiftyone.pipeline.core/types/pipelineBuilder");
+declare class GeoLocationPipelineBuilder extends GeoLocationPipelineBuilder_base {
+    /**
+       * Extension of pipelineBuilder class that allows for the quick generation of a geo-location pipeline. Adds share usage, caching with simple paramater changes
+       * @param {Object} options
+       * @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".
+       *
+      */
+    constructor({ shareUsage, resourceKey, locationProvider, baseURL }: {
+        shareUsage: boolean;
+        resourceKey: string;
+        locationProvider: string;
+    }, ...args: any[]);
+}

package/types/index.d.ts

@@ -0,0 +1,2 @@
+export const GeoLocationCloud: typeof import("./geoLocationCloud");
+export const GeoLocationPipelineBuilder: typeof import("./geoLocationPipelineBuilder");

package/build-and-test.yml

@@ -1,112 +0,0 @@
-trigger: none
-
-pr:
-  - master
-  - develop
-  - release/*  
-
-pool:
-  vmImage: 'ubuntu-latest'
-
-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
-
-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.
-- script: |
-    echo "Resource key for testing = $(LocationResourceKey)"
-    export RESOURCE_KEY="$(LocationResourceKey)"
-    npm install
-    npm install fiftyone.devicedetection
-    npm test
-  displayName: 'Build and Test'
-
-- script: |
-    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')
-
-- task: PublishTestResults@2
-  condition: succeededOrFailed()
-  inputs:
-    testRunner: JUnit
-    testResultsFiles: '**/test_results.xml'
-    testRunTitle: 'Node $(node_version)'
-
-- task: PublishCodeCoverageResults@1
-  inputs: 
-    codeCoverageTool: Cobertura
-    summaryFileLocation: '$(System.DefaultWorkingDirectory)/**/*coverage.xml'
-    reportDirectory: '$(System.DefaultWorkingDirectory)/**/coverage'
-

package/publish-packages.yml

@@ -1,87 +0,0 @@
-trigger:
-  - master
-  - develop
-  - release/*  
-    
-pool:
-  vmImage: 'ubuntu-latest'
-
-variables: 
-  - group: PackageFeedAccessToken
-    # Access token for the git repository. Used by the git tag task.
-  - name: system_accesstoken
-    value: $(System.AccessToken)
-
-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
-
-- 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'
-  inputs:
-    command: 'custom'
-    workingDir: '$(System.DefaultWorkingDirectory)'
-    verbose: true
-    customCommand: 'version --no-git-tag-version $(GitVersion.SemVer)'
-  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
-  displayName: 'Copy tgz files'
-  condition: succeededOrFailed()
-
-- task: CopyFiles@2
-  inputs:
-    sourceFolder: '$(Build.SourcesDirectory)'
-    contents: '**/package.json' 
-    targetFolder: $(Build.ArtifactStagingDirectory)/npm
-  displayName: 'Copy package.json files'
-  condition: succeededOrFailed()
-
-- script: |
-    ls $(Build.ArtifactStagingDirectory)/**/*
-  displayName: 'List artifact staging contents'
-  condition: succeededOrFailed()
-
-# 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:
-    pathtoPublish: '$(Build.ArtifactStagingDirectory)/npm'
-    artifactName: npm
-  displayName: 'Publish npm artifact'
-  condition: succeededOrFailed()