Update versioning and user agent handling (#14)

- Bump extension and task version
- Added postbuild script to update version from task.json
- Included User-Agent header in GitHub API requests
- Added tests for User-Agent header format

Author: tspascoal

create-github-app-token/package.json

@@ -6,6 +6,7 @@
     "build": "tsc",
     "clean": "rm -rf ./dist ./lib",
     "prebuild": "npm run clean",
+    "postbuild": "node scripts/update-version.js",
     "test": "jest --coverage",
     "package": "npm run build && ncc build dist/src/tasks/run.js -o lib/run && ncc build dist/src/tasks/post.js -o lib/post"
   },

create-github-app-token/scripts/update-version.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Updates the VERSION constant in version.ts with the version from task.json
+ * This script is run during the build process to ensure the user agent includes the correct version
+ */
+
+const taskJsonPath = path.join(__dirname, '..', 'task.json');
+const versionPath = path.join(__dirname, '..', 'dist', 'src', 'utils', 'version.js');
+
+try {
+    // Read task.json to get the version
+    const taskJsonContent = fs.readFileSync(taskJsonPath, 'utf8');
+    console.log('Task.json file read successfully');
+    
+    let taskJson;
+    try {
+        taskJson = JSON.parse(taskJsonContent);
+    } catch (parseError) {
+        console.error('Error parsing task.json:');
+        console.error('Parse error:', parseError.message);
+        console.error('File content length:', taskJsonContent.length);
+        console.error('Content around error position:');
+        if (parseError.message.includes('position')) {
+            const position = parseInt(parseError.message.match(/position (\d+)/)?.[1] || '0');
+            const start = Math.max(0, position - 50);
+            const end = Math.min(taskJsonContent.length, position + 50);
+            console.error(taskJsonContent.substring(start, end));
+        }
+        process.exit(1);
+    }
+    
+    const version = `${taskJson.version.Major}.${taskJson.version.Minor}.${taskJson.version.Patch}`;
+    
+    console.log(`Updating version to: ${version}`);
+    
+    // Check if the version file exists
+    if (!fs.existsSync(versionPath)) {
+        console.error(`Version file not found at: ${versionPath}`);
+        console.error('Make sure to run TypeScript compilation first');
+        process.exit(1);
+    }
+    
+    // Read the compiled version.js file
+    let versionContent = fs.readFileSync(versionPath, 'utf8');
+    
+    // Replace the VERSION export
+    const versionRegex = /exports\.VERSION = ['"]dev['"];/;
+    const replacement = `exports.VERSION = "${version}";`;
+    
+    if (!versionRegex.test(versionContent)) {
+        console.error('Could not find VERSION export in version.js');
+        console.error('Expected pattern: exports.VERSION = "dev";');
+        process.exit(1);
+    }
+    
+    versionContent = versionContent.replace(versionRegex, replacement);
+    
+    // Write the updated content back
+    fs.writeFileSync(versionPath, versionContent, 'utf8');
+    
+    console.log('Version updated successfully in version.js');
+    
+} catch (error) {
+    console.error('Error updating version:', error.message);
+    process.exit(1);
+}

create-github-app-token/src/core/github-service.ts

@@ -4,6 +4,7 @@ import * as jwt from 'jsonwebtoken';
 import { ProxyConfig } from './proxy-config';
 import { validateRepositoryName } from '../utils/validation';
 import * as constants from '../utils/constants';
+import { VERSION, USER_AGENT } from '../utils/version';
 
 export interface GitHubServiceOptions {
     proxy?: ProxyConfig;
@@ -21,7 +22,8 @@ export class GitHubService {
 
         const axiosOptions: any = {
             headers: {
-                'Accept': 'application/vnd.github.v3+json'
+                'Accept': 'application/vnd.github.v3+json',
+                'User-Agent': `${USER_AGENT}/${VERSION}`
             }
         };
 

create-github-app-token/src/utils/version.ts

@@ -0,0 +1,3 @@
+// Version information - updated during build process
+export const VERSION = 'dev'; // This will be replaced during build with actual version from task.json
+export const USER_AGENT = 'azure-pipelines-create-github-app-token-task';

create-github-app-token/task.json

@@ -10,7 +10,7 @@
     "version": {
         "Major": 1,
         "Minor": 0,
-        "Patch": 5
+        "Patch": 6
     },
     "instanceNameFormat": "Create GitHub App Installation Token",
     "inputs": [
@@ -20,7 +20,7 @@
             "label": "GitHub App Connection",
             "defaultValue": "",
             "required": false,
-            "helpMarkDown": "The GitHub App connection to use. If not set, the other inputs will be used instead. This is the preferred way to use this task.",
+            "helpMarkDown": "The GitHub App connection to use. If not set, the other inputs will be used instead. This is the preferred way to use this task."
         },
         {
             "name": "owner",

create-github-app-token/test/core/github-service.test.ts

@@ -686,6 +686,26 @@ mockprivatekeydata
     });
   });
 
+  describe('user agent header', () => {
+    it('should include user agent header with correct format', async () => {
+      const userAgentPattern = /^azure-pipelines-create-github-app-token-task\/[\w.-]+$/;
+      
+      const scope = nock(baseUrl)
+        .get('/orgs/test-org/installation')
+        .matchHeader('user-agent', userAgentPattern)
+        .reply(200, { 
+          id: 12345,
+          repository_selection: 'all',
+          permissions: { contents: 'read' }
+        });
+
+      const service = new GitHubService(baseUrl);
+      await service.getInstallationId(mockJwtToken, 'test-app-id', 'test-org', 'org');
+
+      expect(scope.isDone()).toBe(true);
+    });
+  });
+
   describe('advanced integration scenarios', () => {
     it('should handle enterprise GitHub URL normalization', () => {
       const enterpriseUrl = 'https://github.enterprise.com/api/v3/';

vss-extension.json

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "create-github-app-token",
     "name": "GitHub App Token Generator",
-    "version": "1.0.6",
+    "version": "1.0.7",
     "publisher": "INSERT YOUR PUBLISHER HERE",
     "public": false,
     "targets": [