fix: analytics error due arcgis user agent parsing BM-1430 (#3562)

### Motivation

Analytics lambda error due to ua parsing failure

### Modifications

guard against no version

### Verification

test

---------

Co-authored-by: Blayne Chard <bchard@linz.govt.nz>

Author: ccbblin

packages/lambda-analytic-cloudfront/src/__test__/analytics.test.ts

@@ -125,7 +125,7 @@ describe('analytic lambda', () => {
     const files = [...memory.files.keys()];
     assert.equal(files.length, 2); // two files one input one output
 
-    assert.ok(files[1].startsWith(`mem://cache/errors-${new Date().toISOString().slice(0, 12)}`));
+    assert.ok(files[1].startsWith(`mem://cache/errors/${new Date().toISOString().slice(0, 12)}`));
 
     const data = await fsa.read(new URL(files[1]));
     assert.ok(data.toString().includes(JSON.stringify('Hello')));

packages/lambda-analytic-cloudfront/src/handler.ts

@@ -10,6 +10,7 @@ import { byDay, getOneHourAgo } from './date.js';
 import { Elastic } from './elastic.js';
 import { FileProcess, toFullDate } from './log.reader.js';
 import { LogStats } from './log.stats.js';
+import { ParserErrors } from './useragent/parser.js';
 
 const gzipPromise = promisify(gzip);
 
@@ -140,11 +141,18 @@ export async function main(req: LambdaRequest): Promise<void> {
 
     // If anything fails to index write the errors out to a log file at the cache location
     if (Elastic.errors.length > 0) {
-      const errorLocation = new URL(`./errors-${new Date().toISOString()}.json`, CacheLocation);
+      const errorLocation = new URL(`./errors/${new Date().toISOString()}-elastic.json`, CacheLocation);
       req.log.fatal({ errorLocation: errorLocation.href }, 'log:index:failed');
       await fsa.write(errorLocation, JSON.stringify(Elastic.errors));
     }
 
+    // If any user agents cause a error when parsing, write them out
+    if (ParserErrors.size > 0) {
+      const errorLocation = new URL(`./errors/${new Date().toISOString()}-user-agent.json`, CacheLocation);
+      req.log.warn({ errorLocation: errorLocation.href }, 'log:parse:failed');
+      await fsa.write(errorLocation, JSON.stringify([...ParserErrors]));
+    }
+
     let failed = false;
     for (const ret of rets) {
       if (ret.status !== 'rejected') continue;

packages/lambda-analytic-cloudfront/src/useragent/__test__/parser.test.ts

@@ -2,6 +2,7 @@ import assert from 'node:assert';
 import { describe, it } from 'node:test';
 
 import { UaParser } from '../agent.js';
+import { ParserErrors } from '../parser.js';
 
 describe('UserAgents', () => {
   it('should parse common browsers', () => {
@@ -112,6 +113,19 @@ describe('UserAgents', () => {
       variant: 'pro',
       version: '2.8',
     });
+
+    assert.deepEqual(UaParser.parse('ArcGISRuntime-iOS'), {
+      name: 'arcgis',
+      variant: 'ios',
+      os: 'unknown',
+      version: 'unknown',
+    });
+  });
+
+  it('should return error on fatal errors', () => {
+    const ret = UaParser.parse('ArcGISRuntime-/');
+    assert.equal(ret?.name, 'error');
+    assert.equal([...ParserErrors], 'ArcGISRuntime-/');
   });
 
   it('should handle software', () => {

packages/lambda-analytic-cloudfront/src/useragent/agents/gis.ts

@@ -13,6 +13,7 @@ const ArcGis: Record<string, UserAgentParser> = {
   'ArcGISRuntime-': (ua: string) => {
     const chunks = ua.split('/');
     const variant = chunks[0].slice('ArcGISRuntime-'.length).toLowerCase();
+    if (chunks.length === 1) return { name: 'arcgis', variant };
     const version = chunks[1].slice(0, chunks[1].indexOf('.'));
     const os = chunks[1].split(' ')[1].slice(1);
     if (isValidOs(os)) return { name: 'arcgis', variant, version, os };

packages/lambda-analytic-cloudfront/src/useragent/parser.ts

@@ -5,6 +5,9 @@ import { UserAgentInfo, UserAgentOs, UserAgentParser } from './parser.types.js';
 const OsMap: Record<string, UserAgentOs> = { ubuntu: 'linux' };
 const UaParser: ParserConfig = { name: 'ua-parser-js', hit: 0 };
 const Skipped: ParserConfig = { name: 'skipped', hit: 0 };
+const ParserError: ParserConfig = { name: 'error', hit: 0 };
+export const ParserErrors = new Set();
+
 interface ParserConfig {
   name: string;
   hit: number;
@@ -34,16 +37,25 @@ export class UserAgentParsers {
       existing.parser.hit++;
       return existing.value;
     }
-    const ret = this._parse(userAgent);
-    if (ret.value) {
-      if (ret.value.version == null) ret.value.version = 'unknown';
-      if (ret.value.variant == null) ret.value.variant = 'unknown';
-      if (ret.value.os == null) ret.value.os = 'unknown';
+
+    try {
+      const ret = this._parse(userAgent);
+      if (ret.value) {
+        if (ret.value.version == null) ret.value.version = 'unknown';
+        if (ret.value.variant == null) ret.value.variant = 'unknown';
+        if (ret.value.os == null) ret.value.os = 'unknown';
+      }
+      ret.hit++;
+      ret.parser.hit++;
+      this.cache.set(userAgent, ret);
+      return ret.value;
+    } catch (e) {
+      const val = { value: { name: 'error' }, parser: ParserError, hit: 0 };
+      ParserErrors.add(userAgent);
+      if (ParserErrors.size > 100) ParserErrors.clear(); // Only track last 100 Errors
+      this.cache.set(userAgent, val);
+      return val.value;
     }
-    ret.hit++;
-    ret.parser.hit++;
-    this.cache.set(userAgent, ret);
-    return ret.value;
   }
 
   _parse(userAgent: string | undefined): ParserCache {

packages/lambda-analytics/src/__tests__/ua.test.ts

@@ -76,6 +76,7 @@ describe('UserAgent', () => {
       ),
       'arcgis-ios_100',
     );
+    assert.equal(getUserAgent('ArcGISRuntime-iOS'), 'arcgis-ios_unknown');
   });
 
   it('should parse arcgis pro', () => {

packages/lambda-analytics/src/ua.ts

@@ -52,7 +52,7 @@ function isGis(userAgent: string): string | void {
   if (userAgent.startsWith('ArcGISRuntime-')) {
     const chunks = userAgent.split('/');
     const variant = chunks[0].replace('ArcGISRuntime-', '').toLowerCase();
-    const version = chunks[1].slice(0, chunks[1].indexOf('.'));
+    const version = chunks[1]?.split('.')[0] || 'unknown';
     return 'arcgis-' + variant + '_' + version;
   }