internal: implements review feedback

kontent-ai-bot · Apr 1, 2020 · 6683876 · 6683876
1 parent 92414ee
commit 6683876
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -16,13 +16,12 @@ Install package globally:
 
 | Config          | Value                                                                                                               |
 |-----------------|---------------------------------------------------------------------------------------------------------------------|
-| projectId       | Id of Kentico Kontent project (required)                                                                            |
-| apiKey          | Content management Api key (required)                                                                               |
-| action          | Action. Possible values are: 'restore' & 'backup' & 'clean' (required)                                              |
+| **projectId**       | Id of Kentico Kontent project **(required)**                                                                            |
+| **apiKey**           | Content management Api key **(required)**                                                                               |
+| **action**           | Action. Possible values are: 'restore' & 'backup' & 'clean' **(required)**                                              |
 | zipFilename     | Name of zip used for export / restoring data. E.g. 'kontent-backup'.                                            |
-| enableLog       | Indicates if default logging is enabled (useful to indicate progress)                                               |
-| importLanguages | Indicates if languages should be imported                                                                           |
-| force           | If enabled, project will we exported / restored even if there are data inconsistencies. This is enabled by default. |
+| enableLog       | Indicates if default logging is enabled (useful to indicate progress)       
+| force           | If enabled, project will we exported / restored even if there are data inconsistencies. Enabled by default. |
 
 
 ### Execution
@@ -50,7 +49,6 @@ Create a `json` configuration file in the folder where you are attempting to run
     "zipFilename": "backup",
     "action": "backup",
     "enableLog": true,
-    "importLanguages": false,
     "force": true
 }
 ```

diff --git a/src/clean/clean.service.ts b/src/clean/clean.service.ts
@@ -42,7 +42,7 @@ export class CleanService {
                 .deleteTaxonomy()
                 .byTaxonomyId(taxonomy.id)
                 .toPromise()
-                .then(m => {
+                .then(response => {
                     this.processItem(taxonomy.name, 'taxonomy', taxonomy);
                 })
                 .catch(error => this.handleCleanError(error));
@@ -57,7 +57,7 @@ export class CleanService {
                 .deleteContentTypeSnippet()
                 .byTypeId(contentTypeSnippet.id)
                 .toPromise()
-                .then(m => {
+                .then(response => {
                     this.processItem(contentTypeSnippet.name, 'contentTypeSnippet', contentTypeSnippet);
                 })
                 .catch(error => this.handleCleanError(error));
@@ -72,7 +72,7 @@ export class CleanService {
                 .deleteContentType()
                 .byTypeId(contentType.id)
                 .toPromise()
-                .then(m => {
+                .then(response => {
                     this.processItem(contentType.name, 'contentType', contentType);
                 })
                 .catch(error => this.handleCleanError(error));
@@ -128,7 +128,7 @@ export class CleanService {
                 .deleteContentItem()
                 .byItemId(contentItem.id)
                 .toPromise()
-                .then(m => {
+                .then(response => {
                     this.processItem(contentItem.name, 'contentItem', contentItem);
                 })
                 .catch(error => this.handleCleanError(error));
@@ -156,7 +156,7 @@ export class CleanService {
                 .byItemId(itemId)
                 .byLanguageId(languageId)
                 .toPromise()
-                .then(m => {
+                .then(response => {
                     this.processItem(itemId, 'languageVariant', languageVariant);
                 })
                 .catch(error => this.handleCleanError(error));

diff --git a/src/cli/app.ts b/src/cli/app.ts
@@ -81,7 +81,6 @@ const restoreAsync = async (config: ICliFileConfig) => {
         enableLog: config.enableLog,
         workflowIdForImportedItems: '00000000-0000-0000-0000-000000000000',
         process: {
-            language: item => config.importLanguages === true,
             contentItem: item => {
                 return true;
             }
@@ -105,7 +104,7 @@ const restoreAsync = async (config: ICliFileConfig) => {
     }
 };
 
-const validateConfig = (config: any) => {
+const validateConfig = (config?: ICliFileConfig) => {
     if (!config) {
         throw Error(`Invalid config file`);
     }
@@ -182,7 +181,6 @@ const getConfig = async() => {
      const apiKey: string | undefined = argv.apiKey as string | undefined;
      const enableLog: boolean | undefined = (argv.enableLog as boolean | undefined) ?? true;
      const force: boolean | undefined = (argv.force as boolean | undefined) ?? true;
-     const importLanguages: boolean | undefined = (argv.importLanguages as boolean | undefined) ?? true;
      const projectId: string | undefined = argv.projectId as string | undefined;
      const zipFilename: string | undefined = (argv.zipFilename as string | undefined) ?? getDefaultBackupFilename()
 
@@ -204,7 +202,6 @@ const getConfig = async() => {
         apiKey,
         enableLog,
         force,
-        importLanguages,
         projectId,
         zipFilename
     };

diff --git a/src/cli/sample-config.json b/src/cli/sample-config.json
@@ -4,6 +4,5 @@
     "zipFilename": "backup",
     "action": "backup",
     "enableLog": true,
-    "importLanguages": false,
     "force": false
 }
diff --git a/src/core/core.models.ts b/src/core/core.models.ts
@@ -23,7 +23,6 @@ export interface ICliFileConfig {
     action: CliAction;
     zipFilename: string;
     enableLog: boolean;
-    importLanguages: boolean;
     force: boolean;
 }
 

diff --git a/src/import/import.models.ts b/src/import/import.models.ts
@@ -40,7 +40,7 @@ export interface IImportAllResult {
     };
 }
 
-export interface IPreparedImportItem<TItem = any> {
+export interface IPreparedImportItem<TItem> {
     type: ItemType;
     codename: string;
     item: TItem;

diff --git a/src/import/import.service.ts b/src/import/import.service.ts
@@ -17,6 +17,7 @@ import {
     ManagementClient,
     TaxonomyContracts,
     TaxonomyModels,
+    SharedModels,
 } from '@kentico/kontent-management';
 
 import {
@@ -32,6 +33,11 @@ import { IBinaryFile, IImportConfig, IImportSource } from './import.models';
 export class ImportService {
     private readonly defaultLanguageId: string = '00000000-0000-0000-0000-000000000000';
     private readonly client: IManagementClient;
+
+    /**
+     * Maximum allowed size of asset in Bytes.
+     * Currently 1e8 = 100 MB
+     */
     private readonly maxAllowedAssetSizeInBytes: number = 1e8;
 
     constructor(private config: IImportConfig) {
@@ -75,7 +81,9 @@ export class ImportService {
         if (this.config.enableLog) {
             console.log(`Removing skipped items`);
         }
-        // once ids are translated, remove skipped items from import
+
+        // this is an optional step where users can exclude certain objects from being
+        // imported via import configuration.
         this.removeSkippedItemsFromImport(sourceData);
 
         if (this.config.enableLog) {
@@ -417,7 +425,7 @@ export class ImportService {
         >[] = [];
 
         for (const contentType of contentTypes) {
-            const createdContentType = await this.client
+            await this.client
                 .addContentType()
                 .withData(builder => {
                     return contentType;
@@ -540,8 +548,7 @@ export class ImportService {
         >[] = [];
 
         for (const contentTypeSnippet of contentTypeSnippets) {
-            // not yet processed ones
-            const createdContentTypeSnippet = await this.client
+            await this.client
                 .addContentTypeSnippet()
                 .withData(builder => {
                     return {
@@ -591,9 +598,9 @@ export class ImportService {
         return importedItems;
     }
 
-    private handleImportError(error: any): void {
+    private handleImportError(error: any | SharedModels.ContentManagementBaseKontentError): void {
         console.log(error);
-        throw Error(error);
+        throw error;
     }
 
     private processItem(title: string, type: ItemType, data: any): void {

diff --git a/src/services/index.ts b/src/services/index.ts
diff --git a/src/zip/zip.service.ts b/src/zip/zip.service.ts
@@ -134,6 +134,10 @@ export class ZipService {
         return binaryFiles;
     }
 
+    /**
+     * Gets path to asset within zip folder. Uses tree format using asset ids such as:
+     * "files/3b4/3b42f36c-2e67-4605-a8d3-fee2498e5224/image.jpg"
+     */
     private getFullAssetPath(assetId: string, filename: string): string {
         return `${this.filesName}/${assetId.substr(0, 3)}/${assetId}/${filename}`;
     }