Merge pull request #20213 from mozilla/FXA-13225

feat(auth): Add client_id and service tags to StatsD, Sentry, and security events

Author: vbudhram

libs/accounts/oauth/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/accounts/oauth/README.md

@@ -0,0 +1,11 @@
+# oauth
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build oauth` to build the library.
+
+## Running unit tests
+
+Run `nx test oauth` to execute the unit tests via [Jest](https://jestjs.io).

libs/accounts/oauth/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'oauth',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/accounts/oauth',
+};

libs/accounts/oauth/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@fxa/accounts/oauth",
+  "version": "0.0.1",
+  "private": true,
+  "type": "commonjs",
+  "main": "./index.cjs",
+  "types": "./index.d.ts",
+  "dependencies": {}
+}

libs/accounts/oauth/project.json

@@ -0,0 +1,28 @@
+{
+  "name": "oauth",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/accounts/oauth/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/accounts/oauth",
+        "main": "libs/accounts/oauth/src/index.ts",
+        "tsConfig": "libs/accounts/oauth/tsconfig.lib.json",
+        "assets": ["libs/accounts/oauth/*.md"],
+        "format": ["cjs"],
+        "generatePackageJson": true
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/accounts/oauth/jest.config.ts"
+      }
+    }
+  }
+}

libs/accounts/oauth/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/oauth';

libs/accounts/oauth/src/lib/oauth.spec.ts

@@ -0,0 +1,22 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { OAuthNativeClients, OAuthNativeServices } from './oauth';
+
+describe('OAuthNativeClients', () => {
+  it('has expected client IDs', () => {
+    expect(OAuthNativeClients.FirefoxDesktop).toEqual('5882386c6d801776');
+    expect(OAuthNativeClients.FirefoxIOS).toEqual('1b1a3e44c54fbb58');
+    expect(OAuthNativeClients.Fenix).toEqual('a2270f727f45f648');
+  });
+});
+
+describe('OAuthNativeServices', () => {
+  it('has expected service names', () => {
+    expect(OAuthNativeServices.Sync).toEqual('sync');
+    expect(OAuthNativeServices.Relay).toEqual('relay');
+    expect(OAuthNativeServices.Vpn).toEqual('vpn');
+    expect(OAuthNativeServices.SmartWindow).toEqual('smartwindow');
+  });
+});

libs/accounts/oauth/src/lib/oauth.ts

@@ -0,0 +1,24 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+export enum OAuthNativeClients {
+  FirefoxIOS = '1b1a3e44c54fbb58',
+  FirefoxDesktop = '5882386c6d801776',
+  Fenix = 'a2270f727f45f648',
+  Fennec = '3332a18d142636cb',
+  // For Android testing
+  ReferenceBrowser = '3c49430b43dfba77',
+  // TODO: handle Thunderbird case better, FXA-10848
+  Thunderbird = '8269bacd7bbc7f80',
+}
+
+/**
+ * These come through via data.service (a query parameter).
+ */
+export enum OAuthNativeServices {
+  Sync = 'sync',
+  Relay = 'relay',
+  SmartWindow = 'smartwindow',
+  Vpn = 'vpn',
+}

libs/accounts/oauth/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "importHelpers": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/accounts/oauth/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}