Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Validation of project and integration root directories. #4608

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Validation of project and integration root directories. #4608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
50835e9
Added cli tool validation for serve command.
Nov 13, 2020
8b4b3a6
Added new Exception and better handling of cli errors.
Nov 13, 2020
1268f2f
Revert of exisiting changes after new feedback.
Nov 14, 2020
9620abb
Added exception when directory path is not accessible.
Nov 21, 2020
e473d8f
Added path validations for integrations.
Nov 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/@ionic/cli/src/lib/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ export class BuildCLIProgramNotFoundException extends BaseException {}

export class ServeCLIProgramNotFoundException extends BaseException {}

export class DirectoryNotAccessibleException extends FatalException {}

export class SessionException extends BaseException {}

export class RunnerException extends BaseException {}
Expand Down
27 changes: 22 additions & 5 deletions packages/@ionic/cli/src/lib/project/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseConfig, BaseConfigOptions, PackageJson, ParsedArgs } from '@ionic/c
import { PromptModule } from '@ionic/cli-framework-prompts';
import { resolveValue } from '@ionic/cli-framework/utils/fn';
import { ERROR_INVALID_PACKAGE_JSON, compileNodeModulesPaths, isValidPackageName, readPackageJsonFile } from '@ionic/cli-framework/utils/node';
import { ensureDir, findBaseDirectory, readFile, writeFile, writeJson } from '@ionic/utils-fs';
import { ensureDir, findBaseDirectory, pathExistsSync, readFile, writeFile, writeJson } from '@ionic/utils-fs';
import { TTY_WIDTH, prettyPath, wordWrap } from '@ionic/utils-terminal';
import * as Debug from 'debug';
import * as lodash from 'lodash';
Expand All @@ -12,7 +12,7 @@ import { PROJECT_FILE, PROJECT_TYPES } from '../../constants';
import { IAilmentRegistry, IClient, IConfig, IIntegration, ILogger, IMultiProjectConfig, IProject, IProjectConfig, ISession, IShell, InfoItem, IntegrationName, IonicContext, IonicEnvironmentFlags, ProjectIntegration, ProjectPersonalizationDetails, ProjectType } from '../../definitions';
import { isMultiProjectConfig, isProjectConfig } from '../../guards';
import { ancillary, failure, input, strong } from '../color';
import { BaseException, FatalException, IntegrationNotFoundException, RunnerNotFoundException } from '../errors';
import { BaseException, DirectoryNotAccessibleException, FatalException, IntegrationNotFoundException, RunnerNotFoundException } from '../errors';
import { BaseIntegration } from '../integrations';
import { CAPACITOR_CONFIG_FILE, CapacitorConfig } from '../integrations/capacitor/config';
import { Color } from '../utils/color';
Expand Down Expand Up @@ -420,7 +420,10 @@ export abstract class Project implements IProject {
readonly details: ProjectDetailsResult,
protected readonly e: ProjectDeps
) {
this.rootDirectory = path.dirname(details.configPath);
this.rootDirectory = path.dirname(details.configPath);
if (!pathExistsSync(this.rootDirectory)) {
throw new DirectoryNotAccessibleException(`Path ${input(this.rootDirectory)} is not aschessible.`);
}
}

get filePath(): string {
Expand All @@ -434,7 +437,13 @@ export abstract class Project implements IProject {
return this.rootDirectory;
}

return path.resolve(this.rootDirectory, root);
const resolvedPath = path.resolve(this.rootDirectory, root);

if (!pathExistsSync(resolvedPath)) {
throw new DirectoryNotAccessibleException(`Project root ${input(resolvedPath)} is not accessible.`);
}

return resolvedPath;
}

get pathPrefix(): string[] {
Expand Down Expand Up @@ -733,9 +742,17 @@ export abstract class Project implements IProject {
const integration = this.config.get('integrations')[name];

if (integration) {
let rootDirectory = this.directory;

if (integration.root) {
rootDirectory = path.resolve(this.rootDirectory, integration.root);
if (!pathExistsSync(rootDirectory)) {
throw new DirectoryNotAccessibleException(`Integration root ${input(rootDirectory)} is not accessible.`);
}
}
return {
enabled: integration.enabled !== false,
root: integration.root === undefined ? this.directory : path.resolve(this.rootDirectory, integration.root),
root: rootDirectory,
};
}
}
Expand Down