@ask-ell/back-end 0.2.5 → 0.2.6

package/src/scripts/update-dependencies-versions.program.ts

@@ -1,201 +0,0 @@
-import {
-  MaybeUndefined,
-  StringDictionnary,
-  UnknownEnvironmentVariableError,
-} from '@ask-ell/core';
-import { NestLogger } from '@ask-ell/nest';
-import { ProgramExecutionOptions, Program } from '@ask-ell/node';
-import { spawnSync } from 'node:child_process';
-import { writeFileSync } from 'node:fs';
-import { mkdir } from 'node:fs/promises';
-import { join } from 'node:path';
-
-const PROJECT_ROOT_PATH: MaybeUndefined<string> = process.env['PWD'];
-
-function makeSureThatProjectRootPathIsDefined(
-  projectRootPath: MaybeUndefined<string>
-): asserts projectRootPath is string {
-  if (!projectRootPath) {
-    throw new UnknownEnvironmentVariableError('PWD');
-  }
-}
-
-makeSureThatProjectRootPathIsDefined(PROJECT_ROOT_PATH);
-
-const NX_GRAPH_FILE_PATH: string = join(PROJECT_ROOT_PATH, 'tmp/graph.json');
-
-export type PackageContent = {
-  version: string;
-  dependencies: StringDictionnary;
-  devDependencies: StringDictionnary;
-};
-
-const ROOT_PACKAGE_FILE_PATH: string = join(PROJECT_ROOT_PATH, `package.json`);
-const ROOT_PACKAGE_CONTENT: PackageContent = require(ROOT_PACKAGE_FILE_PATH);
-
-function getOrganisationPackageFile(packageId: string): PackageContent {
-  makeSureThatProjectRootPathIsDefined(PROJECT_ROOT_PATH);
-  const packageFilePath = join(
-    PROJECT_ROOT_PATH,
-    `packages/${packageId}/package.json`
-  );
-  return require(packageFilePath);
-}
-
-export type UpdateDependenciesVersionsProgramParams = {
-  organisationPackagePrefix: string;
-  blackListedPackages: string[];
-};
-
-export type WorkspaceDependenciesMapElement = {
-  id: string;
-  dependencies: string[];
-  source: PackageContent;
-};
-
-export type WorkspaceDependenciesMap = {
-  [id: string]: WorkspaceDependenciesMapElement;
-};
-
-export class UpdateDependenciesVersionsProgram extends Program {
-  private organisationPackagePrefix: string;
-  private blackListedPackages: string[];
-  private workspaceDependenciesMap: WorkspaceDependenciesMap =
-    this.getWorkspaceDependenciesMap();
-
-  constructor({
-    organisationPackagePrefix,
-    blackListedPackages,
-  }: UpdateDependenciesVersionsProgramParams) {
-    super({
-      logger: NestLogger.fromClass(UpdateDependenciesVersionsProgram),
-      arguments: [
-        {
-          name: 'targetedPackage',
-          description: 'Target package',
-        },
-      ],
-    });
-    this.organisationPackagePrefix = organisationPackagePrefix;
-    this.blackListedPackages = blackListedPackages;
-  }
-
-  async execute({
-    logger,
-    arguments: { targetedPackage },
-  }: ProgramExecutionOptions): Promise<void> {
-    const workspaceDependenciesMapElements: WorkspaceDependenciesMapElement[] =
-      Object.values(this.workspaceDependenciesMap).filter(
-        ({ id }: WorkspaceDependenciesMapElement): boolean =>
-          this.isTargetedPackage(targetedPackage)(id)
-      );
-
-    for (const {
-      id,
-      dependencies,
-      source,
-    } of workspaceDependenciesMapElements) {
-      logger.log(`package.json file updating for project "${id}"...`);
-
-      if (!PROJECT_ROOT_PATH) {
-        throw new UnknownEnvironmentVariableError('PWD');
-      }
-      const packagePath: string = join(
-        PROJECT_ROOT_PATH,
-        `dist/packages/${id}`
-      );
-
-      await mkdir(packagePath, { recursive: true });
-      const packageFilePath: string = join(PROJECT_ROOT_PATH, 'package.json');
-
-      const packageFileContent: PackageContent = { ...source };
-
-      if (dependencies.length && !packageFileContent.dependencies) {
-        packageFileContent.dependencies = {};
-      }
-
-      dependencies.forEach((dependency: string): void => {
-        const versionTag = this.isAOrganisationPackage(dependency)
-          ? `^${
-              this.workspaceDependenciesMap[
-                dependency.replace(this.organisationPackagePrefix, '')
-              ].source.version
-            }`
-          : ROOT_PACKAGE_CONTENT.devDependencies[dependency];
-        packageFileContent.dependencies[dependency] = versionTag;
-      });
-
-      writeFileSync(
-        packageFilePath,
-        JSON.stringify(packageFileContent, null, 2) + '\n'
-      );
-
-      console.log(`package.json file updated for project "${id}"`);
-    }
-
-    console.log('Package files updated.');
-  }
-
-  getWorkspaceDependenciesMap(): WorkspaceDependenciesMap {
-    const workspaceDependenciesMap: WorkspaceDependenciesMap = {};
-
-    const nxGraphResult = spawnSync(
-      'npx',
-      ['nx', 'graph', '--file', NX_GRAPH_FILE_PATH],
-      { stdio: 'inherit' }
-    );
-    if (nxGraphResult.status !== 0) {
-      throw new Error(`"nx graph" failed with status ${nxGraphResult.status}`);
-    }
-    const nxGraph = require(NX_GRAPH_FILE_PATH);
-
-    const packageIds = Object.entries(nxGraph.graph.dependencies).map(
-      ([packageId]) => packageId
-    );
-
-    for (const packageId of packageIds.filter(this.isNotBlackListed)) {
-      console.log(`Scanning dependencies for package ${packageId}...`);
-      const packageFileContent = getOrganisationPackageFile(packageId);
-      const dependencies = packageFileContent.dependencies
-        ? Object.entries(packageFileContent.dependencies).map(
-            ([dependency]) => dependency
-          )
-        : [];
-
-      workspaceDependenciesMap[packageId] = {
-        id: packageId,
-        dependencies: [],
-        source: packageFileContent,
-      };
-      if (packageFileContent.dependencies) {
-        for (const dependency of dependencies) {
-          workspaceDependenciesMap[packageId].dependencies.push(dependency);
-        }
-      }
-    }
-
-    console.log('Dependencies scan done.');
-
-    return workspaceDependenciesMap;
-  }
-
-  private isTargetedPackage =
-    (targetPackageId: MaybeUndefined<string>) => (packageId: string) => {
-      if (targetPackageId) {
-        return packageId === targetPackageId;
-      }
-      return true;
-    };
-
-  private isAOrganisationPackage(packageName: string): boolean {
-    return packageName.includes(this.organisationPackagePrefix);
-  }
-
-  private isBlackListed(packageId: string): boolean {
-    return this.blackListedPackages.includes(packageId);
-  }
-
-  private isNotBlackListed(packageId: string): boolean {
-    return !this.isBlackListed(packageId);
-  }
-}

package/src/secrets/docker.secret.getter.ts

@@ -1,9 +0,0 @@
-import { FileSecretGetter, fileSecretGetter } from './file.secret.getter';
-
-const DOCKER_SECRETS_DIRECTORY = '/run/secrets';
-
-export const dockerSecretGetter: FileSecretGetter = fileSecretGetter(
-  DOCKER_SECRETS_DIRECTORY
-)(
-  'Application is not running inside Docker container. Docker secrets will be unavailable.'
-);

package/src/secrets/file.secret.getter.ts

@@ -1,27 +0,0 @@
-import { Dirent, existsSync, readdirSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { ILogger } from '@ask-ell/core';
-
-import { SecretGetter } from './types';
-
-export type FileSecretGetter = (logger: ILogger) => SecretGetter;
-
-export const fileSecretGetter =
-  (rootDirectoryPath: string) =>
-  (warningMessage: string): FileSecretGetter =>
-  (logger: ILogger): SecretGetter =>
-  (): object => {
-    const isDirectoryExists: boolean = existsSync(rootDirectoryPath);
-    if (!isDirectoryExists) {
-      logger.warn(warningMessage);
-      return {};
-    }
-
-    return readdirSync(rootDirectoryPath, { withFileTypes: true })
-      .filter((entry: Dirent<string>): boolean => entry.isFile())
-      .reduce((secrets: Record<string, string>, entry): object => {
-        const filePath: string = join(rootDirectoryPath, entry.name);
-        secrets[entry.name] = readFileSync(filePath, 'utf-8').trim();
-        return secrets;
-      }, {});
-  };

package/src/secrets/local.secret.getter.ts

@@ -1,9 +0,0 @@
-import { fileSecretGetter, FileSecretGetter } from './file.secret.getter';
-
-const LOCAL_SECRETS_DIRECTORY = '.secrets';
-
-export const localSecretGetter: FileSecretGetter = fileSecretGetter(
-  LOCAL_SECRETS_DIRECTORY
-)(
-  'Secrets directory not exists on this project. Local secrets will be unavailable.'
-);

package/src/tmp.ts

@@ -1,15 +0,0 @@
-import { ILogger } from '@ask-ell/core';
-import { existsSync, mkdirSync } from 'node:fs';
-import { join } from 'node:path';
-
-export const TMP_FOLDER_PATH: string = join(process.cwd(), 'tmp');
-
-export const createTmpFolder = (logger: ILogger): void => {
-  const isTmpFolderExists: boolean = existsSync(TMP_FOLDER_PATH);
-  if (isTmpFolderExists) {
-    logger.info(`"${TMP_FOLDER_PATH}" folder already exists.`);
-    return;
-  }
-  mkdirSync(TMP_FOLDER_PATH);
-  logger.info(`"${TMP_FOLDER_PATH}" folder created.`);
-};

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ],
-  "compilerOptions": {
-    "ignoreDeprecations": "6.0"
-  }
-}

package/tsconfig.lib.json

@@ -1,18 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": "src",
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "emitDeclarationOnly": false,
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "forceConsistentCasingInFileNames": true,
-    "types": ["node"],
-    "ignoreDeprecations": "6.0"
-  },
-  "include": ["src/**/*.ts"],
-  "references": [],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/jest",
-    "types": ["jest", "node"],
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "forceConsistentCasingInFileNames": true,
-    "ignoreDeprecations": "6.0",
-    "rootDir": "."
-  },
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    }
-  ]
-}