chore: re-write some files to typescript - part 2 (#488)

* chore: rename sqlite-adapter to typescript

* chore: re-write sqlite-adapter to typescript

* chore: rename test-adapter to typescript

* chore: rename worker to typescript

* chore: re-write test-adapter and worker to typescript

* chore: re-write database constants to typescript

* chore: move error class to separate files and fix types in sqlite-adapter

lib/constants/database.js → lib/constants/database.ts

@@ -1,7 +1,8 @@
-'use strict';
+import type {ValueOf} from 'type-fest';
 
-const DB_TYPES = {int: 'INT', text: 'TEXT'};
-const DB_COLUMNS = {
+// TODO: change to enums
+export const DB_TYPES = {int: 'INT', text: 'TEXT'} as const;
+export const DB_COLUMNS = {
     SUITE_PATH: 'suitePath',
     SUITE_NAME: 'suiteName',
     NAME: 'name',
@@ -16,9 +17,14 @@ const DB_COLUMNS = {
     MULTIPLE_TABS: 'multipleTabs',
     STATUS: 'status',
     TIMESTAMP: 'timestamp'
-};
+} as const;
 
-const SUITES_TABLE_COLUMNS = [
+type DbColumn = {
+    name: ValueOf<typeof DB_COLUMNS>;
+    type: ValueOf<typeof DB_TYPES>;
+}
+
+export const SUITES_TABLE_COLUMNS: DbColumn[] = [
     {name: DB_COLUMNS.SUITE_PATH, type: DB_TYPES.text},
     {name: DB_COLUMNS.SUITE_NAME, type: DB_TYPES.text},
     {name: DB_COLUMNS.NAME, type: DB_TYPES.text},
@@ -35,15 +41,11 @@ const SUITES_TABLE_COLUMNS = [
     {name: DB_COLUMNS.TIMESTAMP, type: DB_TYPES.int}
 ];
 
-module.exports = {
-    DB_MAX_AVAILABLE_PAGE_SIZE: 65536, // helps to speed up queries
-    DB_SUITES_TABLE_NAME: 'suites',
-    DB_COLUMNS,
-    SUITES_TABLE_COLUMNS,
-    LOCAL_DATABASE_NAME: 'sqlite.db',
-    DATABASE_URLS_JSON_NAME: 'databaseUrls.json',
-    DB_COLUMN_INDEXES: SUITES_TABLE_COLUMNS.reduce((acc, {name}, index) => {
-        acc[name] = index;
-        return acc;
-    }, {})
-};
+export const DB_MAX_AVAILABLE_PAGE_SIZE = 65536; // helps to speed up queries
+export const DB_SUITES_TABLE_NAME = 'suites';
+export const LOCAL_DATABASE_NAME = 'sqlite.db';
+export const DATABASE_URLS_JSON_NAME = 'databaseUrls.json';
+export const DB_COLUMN_INDEXES = SUITES_TABLE_COLUMNS.reduce((acc: Record<string, number>, {name}, index) => {
+    acc[name] = index;
+    return acc;
+}, {});

lib/constants/index.ts

@@ -1,3 +1,4 @@
+export * from './database';
 export * from './diff-modes';
 export * from './paths';
 export * from './test-statuses';

lib/errors/db-not-initialized-error.ts

@@ -0,0 +1,5 @@
+export class DbNotInitializedError extends Error {
+    constructor() {
+        super('Database must be initialized before use');
+    }
+}

lib/plugin-utils.ts

@@ -1,7 +1,7 @@
-import {Suite} from './types';
+import {Suite, TestResult} from './types';
 
-export const getSuitePath = (suite: Suite): string[] => {
-    return suite.root ?
+export const getSuitePath = (suite: TestResult | Suite): string[] => {
+    return (suite as Suite).root ?
         [] :
         ([] as string[]).concat(getSuitePath(suite.parent as Suite)).concat(suite.title);
 };

lib/report-builder/static.js

@@ -6,8 +6,8 @@ const fs = require('fs-extra');
 
 const {IDLE, RUNNING, SKIPPED, FAIL, ERROR, SUCCESS} = require('../constants/test-statuses');
 const {LOCAL_DATABASE_NAME} = require('../constants/database');
-const SqliteAdapter = require('../sqlite-adapter');
-const TestAdapter = require('../test-adapter');
+const {SqliteAdapter} = require('../sqlite-adapter');
+const {TestAdapter} = require('../test-adapter');
 const {hasNoRefImageErrors} = require('../static/modules/utils');
 const {hasImage, saveStaticFilesToReportDir, writeDatabaseUrlsFile} = require('../server-utils');
 

lib/reporter-helpers.js

@@ -9,13 +9,13 @@ const utils = require('./server-utils');
 const mkReferenceId = (testId, stateName) => getShortMD5(`${testId}#${stateName}`);
 
 exports.updateReferenceImage = async (testResult, reportPath, stateName) => {
-    const currImg = testResult.getCurrImg(stateName);
+    const currImg = testResult.getCurrImg(stateName) ?? {};
 
     const src = currImg.path
         ? path.resolve(reportPath, currImg.path)
         : utils.getCurrentAbsolutePath(testResult, reportPath, stateName);
 
-    const referencePath = testResult.getRefImg(stateName).path;
+    const referencePath = testResult.getRefImg(stateName)?.path;
 
     if (utils.fileExists(referencePath)) {
         const referenceId = mkReferenceId(testResult.id, stateName);
@@ -32,11 +32,11 @@ exports.updateReferenceImage = async (testResult, reportPath, stateName) => {
 exports.revertReferenceImage = (testResult, stateName) => {
     const referenceId = mkReferenceId(testResult.id, stateName);
     const oldReferencePath = path.resolve(tmp.tmpdir, referenceId);
-    const referencePath = testResult.getRefImg(stateName).path;
+    const referencePath = testResult.getRefImg(stateName)?.path;
 
     return utils.copyFileAsync(oldReferencePath, referencePath);
 };
 
 exports.removeReferenceImage = (testResult, stateName) => {
-    return utils.deleteFile(testResult.getRefImg(stateName).path);
+    return utils.deleteFile(testResult.getRefImg(stateName)?.path);
 };

lib/server-utils.ts

@@ -6,15 +6,15 @@ import fs from 'fs-extra';
 import {logger} from './common-utils';
 import {UPDATED, RUNNING, IDLE, SKIPPED, IMAGES_PATH, TestStatus} from './constants';
 import type HtmlReporter from './plugin-api';
-import type TestAdapter from './test-adapter';
+import type {TestAdapter} from './test-adapter';
 import {CustomGuiItem, HtmlReporterApi, ReporterConfig} from './types';
 import type Hermione from 'hermione';
 
 const DATA_FILE_NAME = 'data.js';
 
-export const getReferencePath = (testResult: TestAdapter, stateName: string): string => createPath('ref', testResult, stateName);
-export const getCurrentPath = (testResult: TestAdapter, stateName: string): string => createPath('current', testResult, stateName);
-export const getDiffPath = (testResult: TestAdapter, stateName: string): string => createPath('diff', testResult, stateName);
+export const getReferencePath = (testResult: TestAdapter, stateName?: string): string => createPath('ref', testResult, stateName);
+export const getCurrentPath = (testResult: TestAdapter, stateName?: string): string => createPath('current', testResult, stateName);
+export const getDiffPath = (testResult: TestAdapter, stateName?: string): string => createPath('diff', testResult, stateName);
 
 export const getReferenceAbsolutePath = (testResult: TestAdapter, reportDir: string, stateName: string): string => {
     const referenceImagePath = getReferencePath(testResult, stateName);
@@ -40,7 +40,7 @@ export const getDiffAbsolutePath = (testResult: TestAdapter, reportDir: string,
  * @param {String} stateName - имя стэйта для теста
  * @returns {String}
  */
-export function createPath(kind: string, result: TestAdapter, stateName: string): string {
+export function createPath(kind: string, result: TestAdapter, stateName?: string): string {
     const attempt: number = result.attempt || 0;
     const imageDir = _.compact([IMAGES_PATH, result.imageDir, stateName]);
     const components = imageDir.concat(`${result.browserId}~${kind}_${attempt}.png`);
@@ -83,7 +83,7 @@ export function logError(e: Error): void {
 
 export function hasImage(formattedResult: TestAdapter): boolean {
     return !!formattedResult.getImagesInfo().length ||
-        !!formattedResult.getCurrImg().path ||
+        !!formattedResult.getCurrImg()?.path ||
         !!formattedResult.screenshot;
 }