feat(metrics): retrieve metrics for builders and schematics (AmadeusI…

…TGroup#1183)

## Proposed change
AmadeusITGroup#1201
Retrieve metrics for builders and schematics

packages/@ama-sdk/core/schematics/ng-add/index.spec.ts

@@ -9,7 +9,7 @@ describe('Ng add @ama-sdk/core', () => {
     const initialTree = Tree.empty();
     initialTree.create('angular.json', readFileSync(join(__dirname, 'mocks', 'angular.mocks.json')));
     initialTree.create('src/example.ts', readFileSync(join(__dirname, 'mocks', 'example.ts.mock')));
-    const context: any = { addTask: jest.fn() };
+    const context: any = { addTask: jest.fn(), logger: { debug: jest.fn() }, schematic: { description: { name: 'schematic', collection: { name: '@scope/test' }}}};
     const tree = await firstValueFrom(callRule(ngAdd, initialTree, context));
     const newContent = tree.readText('src/example.ts');
     expect(newContent).not.toContain('@dapi/sdk-core');

packages/@ama-sdk/core/schematics/ng-add/index.ts

@@ -1,13 +1,14 @@
 import {chain, type Rule} from '@angular-devkit/schematics';
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import * as ts from 'typescript';
 import * as path from 'node:path';
 
 /**
  * Rule to import all the necessary dependency to run an @ama-sdk based application
  * Helps to migrate from previous versions with an import replacement
  */
-export function ngAdd(): Rule {
+function ngAddFn(): Rule {
 
   const checkSchematicsDependency: Rule = async (_, context) => {
     try {
@@ -79,3 +80,9 @@ export function ngAdd(): Rule {
     addMandatoryPeerDeps
   ]);
 }
+
+/**
+ * Rule to import all the necessary dependency to run an @ama-sdk based application
+ * Helps to migrate from previous versions with an import replacement
+ */
+export const ngAdd = createSchematicWithMetricsIfInstalled(ngAddFn);

packages/@ama-sdk/create/package.json

@@ -19,9 +19,12 @@
     "@angular-devkit/core": "~17.0.3",
     "@angular-devkit/schematics": "~17.0.3",
     "@angular-devkit/schematics-cli": "~17.0.3",
+    "@angular/cli": "~17.0.3",
+    "@o3r/schematics": "workspace:^",
     "@openapitools/openapi-generator-cli": "~2.7.0",
     "@schematics/angular": "~17.0.3",
     "minimist": "^1.2.6",
+    "rxjs": "^7.8.1",
     "typescript": "~5.2.2"
   },
   "devDependencies": {

packages/@ama-sdk/create/src/index.ts

@@ -91,7 +91,7 @@ const run = () => {
   ];
 
   const errors = steps
-    .map((step) => spawnSync(process.execPath, step.args, { stdio: 'inherit', cwd: step.cwd || process.cwd() }))
+    .map((step) => spawnSync(process.execPath, step.args, { stdio: 'pipe', cwd: step.cwd || process.cwd() }))
     .map(({error}) => error)
     .filter((err) => !!err);
 

packages/@ama-sdk/schematics/package.json

@@ -34,6 +34,9 @@
     "@angular-devkit/schematics-cli": {
       "optional": true
     },
+    "@angular/cli": {
+      "optional": true
+    },
     "@angular/compiler": {
       "optional": true
     },
@@ -46,6 +49,8 @@
     "@angular-devkit/core": "~17.0.0",
     "@angular-devkit/schematics": "~17.0.0",
     "@angular-devkit/schematics-cli": "^17.0.1",
+    "@angular/cli": "^17.0.1",
+    "@o3r/schematics": "workspace:^",
     "@openapitools/openapi-generator-cli": "~2.7.0",
     "@schematics/angular": "~17.0.0"
   },

packages/@ama-sdk/schematics/schematics/api-extension/index.ts

@@ -8,13 +8,14 @@ import {
   template, Tree,
   url
 } from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import { NgGenerateApiExtensionSchematicsSchema } from './schema';
 
 /**
  * Generate a Extension of a API core definition
  * @param options
  */
-export function ngGenerateApiExtension(options: NgGenerateApiExtensionSchematicsSchema): Rule {
+function ngGenerateApiExtensionFn(options: NgGenerateApiExtensionSchematicsSchema): Rule {
 
   return (tree: Tree) => mergeWith(apply(url('./templates'), [
     template({
@@ -26,3 +27,9 @@ export function ngGenerateApiExtension(options: NgGenerateApiExtensionSchematics
   ]), MergeStrategy.Overwrite);
 
 }
+
+/**
+ * Generate a Extension of a API core definition
+ * @param options
+ */
+export const ngGenerateApiExtension = createSchematicWithMetricsIfInstalled(ngGenerateApiExtensionFn);

packages/@ama-sdk/schematics/schematics/java/client-core/index.ts

@@ -2,7 +2,9 @@ import {
   chain,
   Rule,
   SchematicContext,
-  Tree} from '@angular-devkit/schematics';
+  Tree
+} from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import { promises as fs } from 'node:fs';
 import * as path from 'node:path';
 import { treeGlob } from '../../helpers/tree-glob';
@@ -16,7 +18,7 @@ const jarBasePath = path.resolve(__dirname, 'swagger-codegen-java-client', 'targ
  * Generate a Java client SDK source code base on swagger specification
  * @param options
  */
-export function ngGenerateJavaClientCore(options: NgGenerateJavaClientCoreSchematicsSchema): Rule {
+function ngGenerateJavaClientCoreFn(options: NgGenerateJavaClientCoreSchematicsSchema): Rule {
 
   const specPath = path.resolve(process.cwd(), options.specPath);
   /**
@@ -84,3 +86,10 @@ export function ngGenerateJavaClientCore(options: NgGenerateJavaClientCoreSchema
     })
   ]);
 }
+
+
+/**
+ * Generate a Java client SDK source code base on swagger specification
+ * @param options
+ */
+export const ngGenerateJavaClientCore = createSchematicWithMetricsIfInstalled(ngGenerateJavaClientCoreFn);

packages/@ama-sdk/schematics/schematics/ng-add/index.ts

@@ -1,5 +1,6 @@
 import { isJsonObject } from '@angular-devkit/core';
 import { chain, externalSchematic, Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import * as path from 'node:path';
 import { readFileSync } from 'node:fs';
 import { lastValueFrom } from 'rxjs';
@@ -159,9 +160,8 @@ const registerPackageSchematics = async (tree: Tree, context: SchematicContext)
 
 /**
  * Add Otter ama-sdk-schematics to a Project
- * @param options
  */
-export function ngAdd(): Rule {
+function ngAddFn(): Rule {
 
   return (tree, context) => chain([
     registerPackageSchematics,
@@ -173,3 +173,8 @@ export function ngAdd(): Rule {
     }
   ])(tree, context);
 }
+
+/**
+ * Add Otter ama-sdk-schematics to a Project
+ */
+export const ngAdd = createSchematicWithMetricsIfInstalled(ngAddFn);

packages/@ama-sdk/schematics/schematics/typescript/core/index.ts

@@ -12,6 +12,7 @@ import {
   url
 } from '@angular-devkit/schematics';
 import type { Operation, PathObject } from '@ama-sdk/core';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import {existsSync, readFileSync} from 'node:fs';
 import * as path from 'node:path';
 import * as semver from 'semver';
@@ -39,7 +40,7 @@ const getPathObjectTemplate = (pathObj: PathObject) => {
  * Generate a typescript SDK source code base on swagger specification
  * @param options
  */
-export function ngGenerateTypescriptSDK(options: NgGenerateTypescriptSDKCoreSchematicsSchema): Rule {
+function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKCoreSchematicsSchema): Rule {
 
   const specPath = path.resolve(process.cwd(), options.specPath);
   const targetPath = options.directory || '';
@@ -150,3 +151,9 @@ export function ngGenerateTypescriptSDK(options: NgGenerateTypescriptSDKCoreSche
     runGeneratorRule
   ]);
 }
+
+/**
+ * Generate a typescript SDK source code base on swagger specification
+ * @param options
+ */
+export const ngGenerateTypescriptSDK = createSchematicWithMetricsIfInstalled(ngGenerateTypescriptSDKFn);

packages/@ama-sdk/schematics/schematics/typescript/mock/index.ts

@@ -11,8 +11,8 @@ import {
   Tree,
   url
 } from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import * as path from 'node:path';
-
 import {NgGenerateMockSchematicsSchema} from './schema';
 
 
@@ -56,7 +56,7 @@ export function getDasherizeModelName(modelName: string): string {
  * Add mock
  * @param options
  */
-export function ngGenerateMock(options: NgGenerateMockSchematicsSchema): Rule {
+function ngGenerateMockFn(options: NgGenerateMockSchematicsSchema): Rule {
   const dasherizeModelName = getDasherizeModelName(options.apiModel);
 
   const generateRootBarrel: Rule = (tree: Tree) => {
@@ -97,3 +97,9 @@ export function ngGenerateMock(options: NgGenerateMockSchematicsSchema): Rule {
 
   return chain(rules);
 }
+
+/**
+ * Add mock
+ * @param options
+ */
+export const ngGenerateMock = createSchematicWithMetricsIfInstalled(ngGenerateMockFn);

packages/@ama-sdk/schematics/schematics/typescript/shell/index.spec.ts

@@ -78,7 +78,7 @@ describe('Typescript Shell Generator', () => {
       skipInstall: true,
       packageManager: 'npm'
     }, Tree.empty());
-  }, 10000);
+  }, 15000);
 
   it('should generate basic SDK package', () => {
     expect(yarnTree.files.sort()).toEqual(baseFileList.sort());

packages/@ama-sdk/schematics/schematics/typescript/shell/index.ts

@@ -10,16 +10,18 @@ import {
   Tree,
   url
 } from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import {dump, load} from 'js-yaml';
 import {isAbsolute, posix, relative} from 'node:path';
 import {getPackageManagerName, NpmInstall} from '../../helpers/node-install';
 import {readPackageJson} from '../../helpers/read-package';
 import type {NgGenerateTypescriptSDKShellSchematicsSchema} from './schema';
 
 /**
+ * Generate Typescript SDK shell
  * @param options
  */
-export function ngGenerateTypescriptSDK(options: NgGenerateTypescriptSDKShellSchematicsSchema): Rule {
+function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKShellSchematicsSchema): Rule {
 
   const installRule = (_tree: Tree, context: SchematicContext) => {
     const workingDirectory = options.directory ? (isAbsolute(options.directory) ? relative(process.cwd(), options.directory) : options.directory) : '.';
@@ -49,7 +51,8 @@ export function ngGenerateTypescriptSDK(options: NgGenerateTypescriptSDKShellSch
       'ts-jest': amaSdkSchematicsPackageJson.devDependencies!['ts-jest'],
       'globby': amaSdkSchematicsPackageJson.devDependencies!.globby,
       'typescript': amaSdkSchematicsPackageJson.devDependencies!.typescript,
-      '@openapitools/openapi-generator-cli': amaSdkSchematicsPackageJson.devDependencies!['@openapitools/openapi-generator-cli']
+      '@openapitools/openapi-generator-cli': amaSdkSchematicsPackageJson.devDependencies!['@openapitools/openapi-generator-cli'],
+      'rxjs': amaSdkSchematicsPackageJson.dependencies!.rxjs
     };
     const openApiSupportedVersion = typeof amaSdkSchematicsPackageJson.openApiSupportedVersion === 'string' &&
       amaSdkSchematicsPackageJson.openApiSupportedVersion.replace(/\^|~/, '');
@@ -108,3 +111,9 @@ export function ngGenerateTypescriptSDK(options: NgGenerateTypescriptSDKShellSch
     ...(options.skipInstall ? [] : [installRule])
   ]);
 }
+
+/**
+ * Generate Typescript SDK shell
+ * @param options
+ */
+export const ngGenerateTypescriptSDK = createSchematicWithMetricsIfInstalled(ngGenerateTypescriptSDKFn);

packages/@ama-sdk/schematics/schematics/typescript/shell/templates/base/package.json.template

@@ -71,6 +71,7 @@
     "@angular-eslint/eslint-plugin-template": "<%= angularEslintVersion %>",
     "@angular-eslint/utils": "<%= angularEslintVersion %>",
     "@angular/compiler": "<%= angularVersion %>",
+    "@angular/cli": "<%= angularVersion %>",
     "@commitlint/cli": "^17.0.0",
     "@schematics/angular": "<%= angularVersion %>",
     "@commitlint/config-conventional": "^17.0.0",
@@ -102,6 +103,7 @@
     "lint-staged": "^13.0.0",
     "minimist": "^1.2.6",
     "rimraf": "^5.0.1",
+    "rxjs": "<%= versions['rxjs'] %>",
     "standard-version": "^9.0.0",
     "ts-jest": "<%= versions['ts-jest'] %>",
     "typedoc": "~0.25.0",

packages/@o3r/analytics/schematics/analytics-to-component/index.spec.ts

@@ -3,7 +3,7 @@ import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
 import * as path from 'node:path';
 import * as fs from 'node:fs';
 import { firstValueFrom } from 'rxjs';
-import { ngAddAnalytics } from './index';
+import { ngAddAnalyticsFn } from './index';
 
 const collectionPath = path.join(__dirname, '..', '..', 'collection.json');
 const o3rComponentPath = '/src/components/test/test.component.ts';
@@ -100,7 +100,7 @@ export class NgComponent {}
     it('should throw if no Otter component', async () => {
       const runner = new SchematicTestRunner('schematics', collectionPath);
 
-      await expect(firstValueFrom(runner.callRule(ngAddAnalytics({
+      await expect(firstValueFrom(runner.callRule(ngAddAnalyticsFn({
         path: ngComponentPath,
         skipLinter: false,
         activateDummy: false

packages/@o3r/analytics/schematics/analytics-to-component/index.ts

@@ -20,6 +20,7 @@ import {
   addInterfaceToClassTransformerFactory,
   applyEsLintFix,
   askConfirmationToConvertComponent,
+  createSchematicWithMetricsIfInstalled,
   generateClassElementsFromString,
   getO3rComponentInfoOrThrowIfNotFound,
   isNgClassDecorator,
@@ -66,10 +67,9 @@ const checkAnalytics = (componentPath: string, tree: Tree, baseFileName: string)
 
 /**
  * Add analytics to an existing component
- *
  * @param options
  */
-export function ngAddAnalytics(options: NgAddAnalyticsSchematicsSchema): Rule {
+export function ngAddAnalyticsFn(options: NgAddAnalyticsSchematicsSchema): Rule {
   return async (tree: Tree, context: SchematicContext) => {
     try {
       const baseFileName = basename(options.path, '.component.ts');
@@ -236,11 +236,17 @@ export function ngAddAnalytics(options: NgAddAnalyticsSchematicsSchema): Rule {
             externalSchematic('@o3r/core', 'convert-component', {
               path: options.path
             }),
-            ngAddAnalytics(options)
+            ngAddAnalyticsFn(options)
           ]);
         }
       }
       throw e;
     }
   };
 }
+
+/**
+ * Add analytics to an existing component
+ * @param options
+ */
+export const ngAddAnalytics = createSchematicWithMetricsIfInstalled(ngAddAnalyticsFn);

packages/@o3r/analytics/schematics/ng-add/index.ts

@@ -1,11 +1,15 @@
 import type { Rule } from '@angular-devkit/schematics';
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 
 /**
  * Add Otter analytics to an Angular Project
- *
- * @param options
  */
-export function ngAdd(): Rule {
+function ngAddFn(): Rule {
   /* ng add rules */
   return () => {};
 }
+
+/**
+ * Add Otter analytics to an Angular Project
+ */
+export const ngAdd = createSchematicWithMetricsIfInstalled(ngAddFn);

packages/@o3r/apis-manager/schematics/ng-add/index.ts

@@ -1,13 +1,13 @@
 import { chain, noop, Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
-
+import { createSchematicWithMetricsIfInstalled } from '@o3r/schematics';
 import * as path from 'node:path';
 import { NgAddSchematicsSchema } from './schema';
 
 /**
  * Add Otter apis manager to an Angular Project
  * @param options
  */
-export function ngAdd(options: NgAddSchematicsSchema): Rule {
+function ngAddFn(options: NgAddSchematicsSchema): Rule {
   return async (tree: Tree, context: SchematicContext) => {
     try {
       const { ngAddPackages, getO3rPeerDeps, applyEsLintFix, getWorkspaceConfig, getProjectNewDependenciesType } = await import('@o3r/schematics');
@@ -45,3 +45,8 @@ export function ngAdd(options: NgAddSchematicsSchema): Rule {
 
 }
 
+/**
+ * Add Otter apis manager to an Angular Project
+ * @param options
+ */
+export const ngAdd = createSchematicWithMetricsIfInstalled(ngAddFn);