feat(internet): update to simplified modern user-agent list (#3324)

* feat(internet): update to simplified modern user-agent list

* fix reviews suggestions, fix extraneous }

---------

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

Author: matthewmayer

src/definitions/internet.ts

@@ -31,4 +31,9 @@ export type InternetDefinition = LocaleEntry<{
   http_status_code: Record<HTTPStatusCodeType, number[]>;
 
   jwt_algorithm: string[];
+
+  /**
+   * List of user agent patterns.
+   */
+  user_agent_pattern: string[];
 }>;

src/locales/base/internet/index.ts

@@ -6,11 +6,13 @@ import type { InternetDefinition } from '../../..';
 import emoji from './emoji';
 import http_status_code from './http_status_code';
 import jwt_algorithm from './jwt_algorithm';
+import user_agent_pattern from './user_agent_pattern';
 
 const internet: InternetDefinition = {
   emoji,
   http_status_code,
   jwt_algorithm,
+  user_agent_pattern,
 };
 
 export default internet;

src/locales/base/internet/user_agent_pattern.ts

@@ -0,0 +1,22 @@
+export default [
+  //typical IE user agent on Windows
+  'Mozilla/5.0 (compatible; MSIE {{number.int({"min":6,"max":10})}}.0; Windows NT {{helpers.arrayElement(["5.1","5.2","6.0","6.1","6.2","6.3","10.0"])}}; Trident/{{number.int({"min":4,"max":7})}}.0)',
+  //typical Edge user agent on Windows
+  'Mozilla/5.0 (Windows NT {{helpers.arrayElement(["5.1","5.2","6.0","6.1","6.2","6.3","10.0"])}}; Win64; x64) AppleWebKit/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}} (KHTML, like Gecko) Chrome/{{number.int({"min":55,"max":131})}}.{{system.semver}} Safari/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}} Edg/{{number.int({"min":110,"max":131})}}.{{system.semver}}',
+  //typical Safari user agent on MacOS
+  'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}.{{number.int({"min":0,"max":99})}} (KHTML, like Gecko) Version/16.1 Safari/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}.{{number.int({"min":0,"max":99})}}',
+  //typical Firefox user agent on MacOS
+  'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:{{number.int({"min":75, "max":133})}}.0) Gecko/20100101 Firefox/{{number.int({"min":75, "max":133})}}.0',
+  //typical Chrome user agent on MacOS
+  'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_15_7) AppleWebKit/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}.{{number.int({"min":0,"max":99})}} (KHTML, like Gecko) Chrome/{{number.int({"min":55,"max":131})}}.{{system.semver}} Safari/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}.{{number.int({"min":0,"max":99})}}',
+  //typical Firefox user agent on Linux
+  'Mozilla/5.0 (X11; Linux x86_64; rv:{{number.int({"min":75,"max":133})}}.0) Gecko/20100101 Firefox/{{number.int({"min":75,"max":133})}}.0',
+  //typical user agent for a bot
+  'FakerBot/{{system.semver}}',
+  //typical Googlebot user agent
+  'Googlebot/2.1 (+http://www.google.com/bot.html)',
+  //typical Safari user agent on iOS
+  'Mozilla/5.0 (iPhone; CPU iPhone OS {{number.int({"min":10,"max":18})}}_{{number.int({"min":0,"max":4})}} like Mac OS X) AppleWebKit/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}.{{number.int({"min":0,"max":99})}} (KHTML, like Gecko) Version/{{number.int({"min":10,"max":18})}}_{{number.int({"min":0,"max":4})}} Mobile/15E148 Safari/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}',
+  //typical Chrome user agent on Android
+  'Mozilla/5.0 (Linux; Android {{number.int({"min":5,"max":13})}}; {{helpers.arrayElement(["SM-G998U","SM-G998B","SM-G998N","SM-G998P","SM-T800"])}}) AppleWebKit/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}} (KHTML, like Gecko) Chrome/{{number.int({"min":55,"max":131})}}.{{system.semver}} Mobile Safari/{{number.int({"min":536,"max":605})}}.{{number.int({"min":0,"max":99})}}',
+];

src/modules/internet/index.ts

@@ -4,7 +4,6 @@ import { toBase64Url } from '../../internal/base64';
 import { deprecated } from '../../internal/deprecated';
 import { ModuleBase } from '../../internal/module-base';
 import { charMapping } from './char-mappings';
-import * as random_ua from './user-agent';
 
 export type EmojiType =
   | 'smiley'
@@ -798,12 +797,14 @@ export class InternetModule extends ModuleBase {
    *
    * @example
    * faker.internet.userAgent()
-   * // 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_8_8)  AppleWebKit/536.0.2 (KHTML, like Gecko) Chrome/27.0.849.0 Safari/536.0.2'
+   * // 'Mozilla/5.0 (iPhone; CPU iPhone OS 11_1 like Mac OS X) AppleWebKit/537.19.86 (KHTML, like Gecko) Version/18_3 Mobile/15E148 Safari/598.43'
    *
    * @since 2.0.1
    */
   userAgent(): string {
-    return random_ua.generate(this.faker);
+    return this.faker.helpers.fake(
+      this.faker.definitions.internet.user_agent_pattern
+    );
   }
 
   /**

src/modules/internet/user-agent.ts

@@ -110,7 +110,7 @@ exports[`internet > 42 > url > with slash appended 1`] = `"https://hospitable-un
 
 exports[`internet > 42 > url > without slash appended and with http protocol 1`] = `"http://hospitable-unit.net"`;
 
-exports[`internet > 42 > userAgent 1`] = `"Mozilla/5.0 (X11; Linux i686; rv:13.5) Gecko/20100101 Firefox/13.5.1"`;
+exports[`internet > 42 > userAgent 1`] = `"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:131.0) Gecko/20100101 Firefox/118.0"`;
 
 exports[`internet > 42 > userName > noArgs 1`] = `"Garnet.Reynolds-Miller15"`;
 
@@ -254,7 +254,7 @@ exports[`internet > 1211 > url > with slash appended 1`] = `"https://velvety-tar
 
 exports[`internet > 1211 > url > without slash appended and with http protocol 1`] = `"http://velvety-tarragon.biz"`;
 
-exports[`internet > 1211 > userAgent 1`] = `"Mozilla/5.0 (Windows NT 6.1; Trident/7.0; rv:11.0) like Gecko"`;
+exports[`internet > 1211 > userAgent 1`] = `"Mozilla/5.0 (Linux; Android 13; SM-G998B) AppleWebKit/605.67 (KHTML, like Gecko) Chrome/107.7.3.6 Mobile Safari/592.76"`;
 
 exports[`internet > 1211 > userName > noArgs 1`] = `"Tito67"`;
 
@@ -398,7 +398,7 @@ exports[`internet > 1337 > url > with slash appended 1`] = `"https://fatal-co-pr
 
 exports[`internet > 1337 > url > without slash appended and with http protocol 1`] = `"http://fatal-co-producer.biz"`;
 
-exports[`internet > 1337 > userAgent 1`] = `"Mozilla/5.0 (Windows NT 5.3; WOW64; rv:8.4) Gecko/20100101 Firefox/8.4.3"`;
+exports[`internet > 1337 > userAgent 1`] = `"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/547.27.45 (KHTML, like Gecko) Version/16.1 Safari/558.51.26"`;
 
 exports[`internet > 1337 > userName > noArgs 1`] = `"Devyn.Gottlieb"`;
 

test/modules/__snapshots__/internet.spec.ts.snap

@@ -841,9 +841,7 @@ describe('internet', () => {
           expect(ua).toBeTruthy();
           expect(ua).toBeTypeOf('string');
           expect(ua.length).toBeGreaterThanOrEqual(1);
-          expect(ua).toMatch(
-            /^(([^\d]+\/[\dA-Za-z.]+(\s\(.*\)))|([^\d]+\/[\dA-Za-z.]+(\s\(.*\)*))(\s[^\d]+\/[\dA-Za-z.]+(\s\(.*\)*))*)$/
-          );
+          expect(ua).includes('/');
         });
       });