fix when you create-amplify absolute path, raised error

[magisystem0408]

Problem

**Issue number, if available: **
fixes: #827

Related pull requests: #857

Changes

Corresponding docs PR, if applicable:

when you do create-amplify absolute path (ex. '/user/test'), raised error and log.

Validation

Checklist

• If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
• If this PR requires a change to the Project Architecture README, I have included that update in this PR.
• If this PR requires a docs update, I have linked to that docs PR above.
• If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[changeset-bot]

🦋 Changeset detected

Latest commit: 7cc3407

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
create-amplify	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[sobolk]

Note to other reviewers: this change was discussed in #857 and got moved to new PR.

[Amplifiyer]

In what conditions would a projectRoot not be an absolute path?

https://github.com/aws-amplify/amplify-backend/pull/1071/files#diff-17a8da21bcc08aa19a0287db1113f604841ad4119d227505260fdc18ac081181R26-R28

[magisystem0408]

@Amplifiyer
I can't think of a case at the moment where projectRoot not be an absolute path, but I put it in explicitly.

Is it necessary?

[Amplifiyer]

if there is no situation where projectRoot wouldn't be an absolute path than this if statement is irrelevant and we should throw an AmplifyError with the right messaging here.

cc: @edwardfoyle

[edwardfoyle]

Based on the upstream validation, I would say we can remove this conditional

[magisystem0408]

Thank you feedback !!! @edwardfoyle @Amplifiyer

I try to do this task!

• remove condition
• add AmplifyError (change test case)

[magisystem0408]

@Amplifiyer @edwardfoyle

I came up with three error pattern.
should select plan3 right?

// plan1: use printer
try {
    await fsp.mkdir(projectRoot, {recursive: true});
} catch (err) {
    printer.log(
        `Failed to create directory at ${projectRoot}. Ensure this is the correct path and you have write permissions to this location.`,
        LogLevel.ERROR
    );
    throw err;
}

// plan2: direct throw new Error
try {
    await fsp.mkdir(projectRoot, {recursive: true});
} catch (err) {
    throw new Error(`Failed to create directory at ${projectRoot}. Ensure this is the correct path and you have write permissions to this location.`);
}

// plan3: use AmplifyUserError
import {AmplifyUserError} from '@aws-amplify/platform-core';

try {
    await fsp.mkdir(projectRoot, {recursive: true});
} catch (err) {
    throw new AmplifyUserError('MultipleSingletonResourcesError', {
        message:
            `Failed to create directory at ${projectRoot}. Ensure this is the correct path and you have write permissions to this location.`,
        resolution: 'Change relative path or Absolute path under root',
    });
}

[Amplifiyer]

Yes plan3 is correct. Make the error name something like ProjectDirectoryCreateError and change the message and resolution to something like

try {
    await fsp.mkdir(projectRoot, {recursive: true});
} catch (err) {
    throw new AmplifyUserError('MultipleSingletonResourcesError', {
        message:
            `Failed to create project directory`,
        resolution: 'Ensure that ${projectRoot} is the correct path and you have write permissions to this location.',
    });
}

[magisystem0408]

@Amplifiyer

I modified the test code and AmplifyError with reference to the following.
please check🙇‍♀️🙇‍♀️🙇‍♀️🙇‍♀️🙇‍♀️

amplify-backend/packages/platform-core/src/errors/amplify_error.test.ts

Lines 20 to 27 in 8d9a7a4

	const actual = AmplifyError.fromStderr(sampleStderr);
	assert.deepStrictEqual(actual?.name, testError.name);
	assert.deepStrictEqual(actual?.classification, testError.classification);
	assert.deepStrictEqual(actual?.message, testError.message);
	assert.deepStrictEqual(actual?.details, testError.details);
	assert.deepStrictEqual(actual?.cause?.name, testError.cause?.name);
	assert.deepStrictEqual(actual?.cause?.message, testError.cause?.message);
	});

[Amplifiyer]

You don't need all this. Just assert on the err that the name, message and resolution is correct.

[magisystem0408]

@Amplifiyer
thank you feedback!!!!!
I try change test case

[Amplifiyer]

something like below

Suggested change

	await assert.rejects(
	() => getProjectRoot(),
	(err: Error) => {
	const sampleStderr = `some random stderr
	before the actual error message
	${util.inspect(err, { depth: null })}
	and some after the error message`;
	const actual = AmplifyError.fromStderr(sampleStderr);
	assert.deepStrictEqual(actual?.name, expectedError.name);
	assert.deepStrictEqual(actual?.message, expectedError.message);
	assert.deepStrictEqual(actual?.resolution, expectedError.resolution);
	return true;
	}
	);
	assert.equal(fsMkDirSyncMock.mock.callCount(), 1);
	assert.equal(
	fsMkDirSyncMock.mock.calls[0].arguments[0],
	path.resolve(userInput)
	);
	await assert.throws(
	() => getProjectRoot(),
	expectedError
	);
	assert.equal(fsMkDirSyncMock.mock.callCount(), 1);
	assert.equal(
	fsMkDirSyncMock.mock.calls[0].arguments[0],
	path.resolve(userInput)
	);

[magisystem0408]

@Amplifiyer

I've made a few modifications.
at d7226b6

[magisystem0408]

I came up with idea.

const expectedError = new AmplifyUserError('ProjectDirectoryCreateError', {
      message: `Failed to create project directory`,
      resolution: `Ensure that ${
        userInput
      } is the correct path and you have write permissions to this location.`,
    });
    fsMkDirSyncMock.mock.mockImplementationOnce(() => {
      throw expectedError;
    });

    await assert.rejects(() => getProjectRoot(), {
      name: expectedError.name,
      message: expectedError.message,
    });