ref(script): Improve attribute creation script (#129)

Author: Lms24

package.json

@@ -7,18 +7,13 @@
     "lint": "biome check",
     "fix": "biome check --write",
     "test": "vitest",
-
     "build": "yarn build:js && yarn build:python && yarn build:tarball",
-
     "build:js": "(cd javascript/sentry-conventions && yarn build)",
-
     "lint:python": "(cd python && uv run pyflakes src/ && uv run black src/ && uv run isort src/ && uv run mypy .)",
     "build:python": "(cd python && uv build)",
-
     "build:tarball": "yarn build:tarball:js && yarn build:python && yarn build:tarball:model",
     "build:tarball:js": "(cd javascript/sentry-conventions && yarn build:tarball)",
     "build:tarball:model": "tsx scripts/gzip_folder.ts model model/sentry-conventions-json.tgz",
-
     "create:attribute": "tsx scripts/create_attribute.ts",
     "generate": "tsx scripts/generate.ts"
   },
@@ -27,6 +22,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
+    "@clack/prompts": "^0.11.0",
     "@types/node": "^22.15.3",
     "@types/tar": "^6.1.13",
     "ajv": "^8.17.1",

scripts/create_attribute.ts

@@ -1,8 +1,8 @@
 import { execSync } from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
-import readline from 'node:readline';
 import { parseArgs } from 'node:util';
+import { confirm, intro, isCancel, log, outro, select, text } from '@clack/prompts';
 import Ajv from 'ajv';
 
 const HELP_TEXT = `
@@ -29,17 +29,6 @@ Examples:
   yarn run create:attribute --key http.route --description "The route pattern of the request" --type string --has_pii false --is_in_otel true --example "/users/:id" --alias "url.template"
 `;
 
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
-
-const question = (query: string): Promise<string> => {
-  return new Promise((resolve) => {
-    rl.question(query, resolve);
-  });
-};
-
 const validateSchema = (data: unknown) => {
   const schema = JSON.parse(fs.readFileSync('schemas/attribute.schema.json', 'utf-8'));
   const ajv = new Ajv();
@@ -74,6 +63,8 @@ const createAttribute = async () => {
       process.exit(0);
     }
 
+    intro('Create new attribute');
+
     // If any required option is provided, we'll use non-interactive mode
     const isInteractive = !(values.key || values.description || values.type || values.has_pii || values.is_in_otel);
 
@@ -87,14 +78,14 @@ const createAttribute = async () => {
     let sdks: string | undefined;
 
     if (isInteractive) {
-      key = await question('Enter the attribute key (e.g. http.route): ');
-      description = await question('Enter a description: ');
-      type = await question('Enter the type (string/boolean/integer/double/string[]/boolean[]/integer[]/double[]): ');
-      piiKey = await question('Does this attribute contain PII? (true/maybe/false): ');
-      isInOtel = await question('Is this attribute in OpenTelemetry? (true/false): ');
-      example = await question('Enter an example value (optional): ');
-      alias = await question('Enter attributes that alias to this attribute (comma-separated, optional): ');
-      sdks = await question('Enter SDKs that use this attribute (comma-separated, optional): ');
+      key = await askForAttributeName();
+      description = await askForAttributeDescription();
+      type = await askForAttributeType();
+      piiKey = await askForAttributePii();
+      isInOtel = String(await askForAttributeIsInOtel());
+      example = await askForAttributeExample();
+      alias = await askForAttributeAlias();
+      sdks = await askForAttributeSdks();
     } else {
       key = values.key;
       description = values.description;
@@ -163,26 +154,140 @@ const createAttribute = async () => {
     }
 
     fs.writeFileSync(filePath, `${JSON.stringify(attribute, null, 2)}\n`);
-    console.log(`Successfully created attribute file at: ${filePath}`);
+    log.success(`Successfully created attribute file at: ${filePath}`);
 
     // Ask if user wants to generate docs
-    const generateDocs = await question('\nWould you like to generate documentation? (y/n): ');
-    if (generateDocs.toLowerCase() === 'y') {
-      console.log('Generating documentation...');
+    const generateDocs = await askForGenerateDocs();
+    if (generateDocs) {
+      log.info('Generating documentation...');
       try {
         execSync('yarn run generate', { stdio: 'inherit' });
-        console.log('Documentation generated successfully!');
+        log.success('Documentation generated successfully!');
       } catch (error) {
-        console.error('Error generating documentation:', error);
+        log.error(`Error generating documentation: ${error}`);
         process.exit(1);
       }
     }
   } catch (error) {
-    console.error('Error creating attribute:', error);
+    log.error(`Error creating attribute: ${error}`);
     process.exit(1);
   } finally {
-    rl.close();
+    outro('Attribute creation done!');
   }
 };
 
 createAttribute();
+
+async function askForAttributeName() {
+  return abortIfCancelled(
+    text({
+      message: 'Enter the attribute key',
+      placeholder: 'http.route',
+      validate: (value) => {
+        if (!value) {
+          return 'Attribute key is required';
+        }
+        return undefined;
+      },
+    }),
+  );
+}
+
+async function askForAttributeDescription() {
+  return abortIfCancelled(
+    text({
+      message: 'Enter the attribute description',
+      placeholder: 'The route pattern of the request',
+      validate: (value) => {
+        if (!value) {
+          return 'Attribute description is required';
+        }
+        return undefined;
+      },
+    }),
+  );
+}
+
+async function askForAttributeType() {
+  return abortIfCancelled(
+    select({
+      message: 'Enter the type',
+      options: [
+        { value: 'string', label: 'String' },
+        { value: 'integer', label: 'Integer' },
+        { value: 'boolean', label: 'Boolean' },
+        { value: 'double', label: 'Double' },
+        { value: 'string[]', label: 'String Array' },
+        { value: 'integer[]', label: 'Integer Array' },
+        { value: 'boolean[]', label: 'Boolean Array' },
+        { value: 'double[]', label: 'Double Array' },
+      ],
+    }),
+  );
+}
+
+async function askForAttributePii() {
+  return abortIfCancelled(
+    select({
+      message: 'Does the attribute contain PII?',
+      options: [
+        { value: 'true', label: 'Yes' },
+        { value: 'false', label: 'No' },
+        { value: 'maybe', label: 'Maybe' },
+      ],
+    }),
+  );
+}
+
+async function askForAttributeIsInOtel() {
+  return abortIfCancelled(
+    confirm({
+      message: 'Is the attribute in OpenTelemetry?',
+      initialValue: true,
+    }),
+  );
+}
+
+async function askForAttributeExample() {
+  return abortIfCancelled(
+    text({
+      message: 'Enter an example value (optional)',
+      placeholder: 'GET /users/:id',
+    }),
+  );
+}
+
+async function askForAttributeAlias() {
+  return abortIfCancelled(
+    text({
+      message: 'Enter attributes that alias to this attribute (comma-separated, optional)',
+      placeholder: 'url.route,http.routename',
+    }),
+  );
+}
+
+async function askForAttributeSdks() {
+  return abortIfCancelled(
+    text({
+      message: 'Enter SDKs that use this attribute (comma-separated, optional)',
+      placeholder: 'javascript-browser,javascript-node',
+    }),
+  );
+}
+
+async function askForGenerateDocs() {
+  return abortIfCancelled(
+    confirm({
+      message: 'Would you like to generate documentation?',
+      initialValue: true,
+    }),
+  );
+}
+
+async function abortIfCancelled<T>(input: T | Promise<T>): Promise<Exclude<T, symbol>> {
+  if (isCancel(await input)) {
+    process.exit(0);
+  } else {
+    return input as Exclude<T, symbol>;
+  }
+}

yarn.lock

@@ -70,6 +70,23 @@
   resolved "https://registry.yarnpkg.com/@biomejs/cli-win32-x64/-/cli-win32-x64-1.9.4.tgz#4c7afa90e3970213599b4095e62f87e5972b2340"
   integrity sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA==
 
+"@clack/[email protected]":
+  version "0.5.0"
+  resolved "https://registry.yarnpkg.com/@clack/core/-/core-0.5.0.tgz#970df024a927d6af90111667a0384e233b5ffa1a"
+  integrity sha512-p3y0FIOwaYRUPRcMO7+dlmLh8PSRcrjuTndsiA0WAFbWES0mLZlrjVoBRZ9DzkPFJZG6KGkJmoEAY0ZcVWTkow==
+  dependencies:
+    picocolors "^1.0.0"
+    sisteransi "^1.0.5"
+
+"@clack/prompts@^0.11.0":
+  version "0.11.0"
+  resolved "https://registry.yarnpkg.com/@clack/prompts/-/prompts-0.11.0.tgz#5c0218f2b46626a50d72d8a485681eb8d94bd2a7"
+  integrity sha512-pMN5FcrEw9hUkZA4f+zLlzivQSeQf5dRGJjSUbvVYDLvpKCdQx5OaknvKzgbtXOizhP+SJJJjqEbOe55uKKfAw==
+  dependencies:
+    "@clack/core" "0.5.0"
+    picocolors "^1.0.0"
+    sisteransi "^1.0.5"
+
 "@esbuild/[email protected]":
   version "0.25.2"
   resolved "https://registry.yarnpkg.com/@esbuild/aix-ppc64/-/aix-ppc64-0.25.2.tgz#b87036f644f572efb2b3c75746c97d1d2d87ace8"
@@ -1511,6 +1528,11 @@ siginfo@^2.0.0:
   resolved "https://registry.yarnpkg.com/siginfo/-/siginfo-2.0.0.tgz#32e76c70b79724e3bb567cb9d543eb858ccfaf30"
   integrity sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==
 
+sisteransi@^1.0.5:
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed"
+  integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==
+
 source-map-js@^1.0.1, source-map-js@^1.2.1:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46"