feat: make client changelog preservable (#198)

When generating any model, the changelog within to model shouldn't be reset. This change will preserve the CHANGELOG.md when regenerating the package.

Author: AllanZhengYP

models/importexport/2010-06-01/service-2.json

@@ -6,6 +6,7 @@
     "endpointPrefix":"importexport",
     "globalEndpoint":"importexport.amazonaws.com",
     "serviceFullName":"AWS Import/Export",
+    "serviceId":"ImportExport",
     "signatureVersion":"v2",
     "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/",
     "protocol":"query"

packages/package-generator/src/ModuleGenerator.spec.ts

@@ -1,4 +1,5 @@
 import {ModuleGenerator} from "./ModuleGenerator";
+import * as fs from 'fs';
 
 describe('ModuleGenerator', () => {
     describe('expected files', () => {
@@ -148,4 +149,33 @@ ${description}`
             }
         );
     });
+
+    describe('CHANGELOG.md', () => {
+        it('should inherit previous change log if exists', () => {
+            jest.spyOn(fs, 'readFileSync').mockImplementationOnce(() => '###changelog###');
+            const name = 'name';
+            const generator = new ModuleGenerator({name});
+            let generated = false;
+            for (const [filename, contents] of generator) {
+                if (filename === 'CHANGELOG.md') {
+                    generated = true;
+                    expect(contents).toBe('###changelog###');
+                }
+            }
+            expect(generated).toBe(true);
+        });
+
+        it('should not add changelog if no changelog exists previously', () => {
+            jest.spyOn(fs, 'readFileSync').mockImplementationOnce(() => {throw new Error('ENOENT')});
+            const name = 'name';
+            const generator = new ModuleGenerator({name});
+            let generated = false;
+            for (const [filename, contents] of generator) {
+                if (filename === 'CHANGELOG.md') {
+                    generated = true;
+                }
+            }
+            expect(generated).toBe(false);
+        })
+    });
 });

packages/package-generator/src/ModuleGenerator.ts

@@ -6,6 +6,8 @@ import {
     DEFAULT_TSCONFIG,
     JsonDocument,
 } from './constants';
+import { join, dirname } from 'path';
+import { readFileSync } from 'fs';
 
 export interface CustomModuleInit {
     name: string;
@@ -36,6 +38,8 @@ export class ModuleGenerator {
         yield ['LICENSE', APACHE_2_LICENSE];
         yield ['tsconfig.json', JSON.stringify(this.tsconfig(), null, 4)];
         yield ['tsconfig.test.json', JSON.stringify(this.testTsconfig(), null, 4)];
+        const changelog = this.changelog();
+        if (changelog) yield ['CHANGELOG.md', changelog];
     }
 
     protected gitignore(): string {
@@ -90,4 +94,17 @@ ${this.description || ''}
     protected tsconfig(): {[key: string]: any} {
         return DEFAULT_TSCONFIG;
     }
+
+    protected changelog(): string | undefined {
+        const previousChangelog = join(
+            dirname(dirname(__dirname)),
+            this.name.replace(/^@aws-sdk\//, ''),
+            'CHANGELOG.md'   
+        );
+        try {
+            return readFileSync(previousChangelog).toString();
+        } catch(e) {
+            return undefined;
+        }
+    }
 }

packages/package-generator/src/commands/ImportModelsCommand.ts

@@ -53,7 +53,7 @@ export const ImportModelsCommand: yargs.CommandModule = {
         console.log(`Generating ${services.size} SDK packages...`);
 
         for (const [identifier, {model, smoke}] of services) {
-            for (const runtime of ['node', 'browser', 'universal']) {
+            for (const runtime of ['node', 'browser']) {
                 console.log(`Generating ${runtime} ${clientModuleIdentifier(model.metadata)} SDK`);
                 ImportClientPackageCommand.handler({ model, runtime, smoke });
             }