add client version to ServiceMetadata; add default user agent header customization

Author: AllanZhengYP

packages/package-generator/src/ClientModuleGenerator.ts

@@ -59,7 +59,6 @@ export class ClientModuleGenerator extends ModuleGenerator {
             model,
             runtime,
             customizations,
-            version
         );
 
         if (smoke) {
@@ -293,7 +292,12 @@ tsconfig.test.json
     }
 
     private *modelFiles() {
-        yield* new ModelGenerator(this.model, this.circularDependencies);
+        for (let [file, generated] of new ModelGenerator(this.model, this.circularDependencies)) {
+            if (file === 'ServiceMetadata') {
+                generated += `\nexport const clientVersion: string = '${this.version}';`
+            }
+            yield [file, generated];
+        }
         yield* new OperationGenerator(this.model);
     }
 

packages/service-types-generator/src/ClientGenerator.ts

@@ -20,13 +20,11 @@ export class ClientGenerator {
     private readonly client: Client;
     private readonly classicClient: ClassicClient;
     private readonly configuration: Configuration;
-    private readonly version: string = '0.1.0';
 
     constructor(
         model: TreeModel,
         target: RuntimeTarget,
         customizations: Array<CustomizationDefinition> = [],
-        version: string,
     ) {
         customizations = customizations
             .concat(getServiceCustomizations(model, target).client);
@@ -37,8 +35,7 @@ export class ClientGenerator {
         this.configuration = new Configuration(
             this.client.prefix,
             target,
-            this.getConcattedConfig(customizations),
-            version,
+            this.getConcattedConfig(customizations)
         );
     }
 

packages/service-types-generator/src/Components/Client/Client.ts

@@ -62,6 +62,7 @@ export class Client {
 ${configurationImports.toString()}
 import {InputTypesUnion} from './types/InputTypesUnion';
 import {OutputTypesUnion} from './types/OutputTypesUnion';
+import {clientVersion, ServiceMetadata} from './model/ServiceMetadata';
 
 export class ${this.className} {
     protected readonly config: ${this.prefix}ResolvedConfiguration;

packages/service-types-generator/src/Components/Client/Configuration.ts

@@ -11,7 +11,6 @@ export class Configuration {
         private readonly prefix: string,
         private readonly target: RuntimeTarget,
         private readonly config: ConfigurationDefinition,
-        private readonly version: string = '0.1.0',
     ) {}
 
     get className() {

packages/service-types-generator/src/ServiceCustomizations/customizationsFromModel/index.spec.ts

@@ -63,4 +63,11 @@ describe('customizationsFromModel', () => {
             }
         );
     }
+
+    it(`should return a property definition for user-agent header`, () => {
+        const {client} = customizationsFromModel(model, 'universal');
+        const [customization, ...rest] = client.reverse();
+        expect(client[0]).toHaveProperty('type');
+        expect(client[0].type).toBe('Middleware');
+    });
 });

packages/service-types-generator/src/ServiceCustomizations/customizationsFromModel/index.ts

@@ -29,6 +29,7 @@ import {
     TreeModel,
 } from '@aws-sdk/build-types';
 import { retryMiddleware } from './retryMiddleware';
+import { userAgentCustomization } from './userAgentCustomization';
 
 /**
  * Collect the "customizations" that must be applied to a service client based
@@ -63,6 +64,7 @@ export function customizationsFromModel(
             ],
             commands: {},
         },
-        signatureCustomizations(model, target)
+        signatureCustomizations(model, target),
+        userAgentCustomization(target),
     );
 }

packages/service-types-generator/src/ServiceCustomizations/customizationsFromModel/setUserAgentMiddleware.ts

@@ -0,0 +1,28 @@
+import { RuntimeTarget, ServiceCustomizationDefinition } from '@aws-sdk/build-types';
+import { IMPORTS } from '../../internalImports';
+import { packageNameToVariable } from '../../packageNameToVariable';
+
+export function userAgentCustomization(
+    runtime: RuntimeTarget
+): ServiceCustomizationDefinition {
+    const imports = [
+        IMPORTS['middleware-header-default']
+    ];
+    if (runtime === 'node') {
+        imports.push(IMPORTS['util-user-agent-node']);
+    } else {
+        imports.push(IMPORTS['util-user-agent-browser']);
+    }
+    const defaultValuePackageName = runtime === 'node' ? '@aws-sdk/util-user-agent-node' : '@aws-sdk/util-user-agent-browser';
+    return {
+        client: [{
+            type: 'Middleware',
+            step: 'build',
+            priority: 0,
+            imports,
+            expression: `${packageNameToVariable('@aws-sdk/middleware-header-default')}({'${runtime === 'node' ? 'User-Agent' : 'X-Amz-User-Agent'}': ${packageNameToVariable(defaultValuePackageName)}.defaultUserAgent(ServiceMetadata.serviceId || ServiceMetadata.endpointPrefix, clientVersion)})`,
+            tags: '{USERAGENT: true}'
+        }],
+        commands: {}
+    }
+}

packages/service-types-generator/src/ServiceCustomizations/customizationsFromModel/userAgentCustomization.ts

@@ -412,6 +412,14 @@ export const IMPORTS: {[key: string]: Import} = {
         package: '@aws-sdk/util-uri-escape',
         version: '^0.1.0-preview.1',
     },
+    'util-user-agent-browser': {
+        package: '@aws-sdk/util-user-agent-browser',
+        version: '^0.1.0-preview.1',
+    },
+    'util-user-agent-node': {
+        package: '@aws-sdk/util-user-agent-node',
+        version: '^0.1.0-preview.1',
+    },
     'util-utf8-browser': {
         package: '@aws-sdk/util-utf8-browser',
         version: '^0.1.0-preview.1',