chore: replacing all generic errors with FuelError

[msensys]

Closes #2001

[danielbate]

@msensys does this pick up all occurences?

[petertonysmith94]

@msensys does this pick up all occurences?

It believe not - hence the "Relates to"?

[danielbate]

Sorry @msensys was just trying to validate why the validate changeset CI stage hadn't run so converted to draft

[msensys]

@msensys does this pick up all occurences?

Maybe not. I will send some commits to pick up all occurrences.

[nedsalk]

Thanks for the work!

To fully wrap this up, can you please go to the tests that are expecting these errors and use the expectToThrowFuelError utility?

For example, for this error, there exists this test. You'd change the test to look like this:

it('throws when setting configurable but predicate has none', async () => {
  await expectToThrowFuelError(
    () =>
      new Predicate({
        bytecode: predicateBytesTrue,
        abi: predicateAbiTrue,
        provider: wallet.provider,
        inputData: ['NADA'],
        configurableConstants: {
          constant: 'NADA',
        },
      }),
    new FuelError(
      ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
      'Predicate has no configurable constants to be set'
    )
  );
});

You can do a repo-wide search for the expected error message on each error you changed and there should be a corresponding test which you'd change as shown above. If a test doesn't exist for the error, you're welcome to add it.

[msensys]

Hey @nedsalk! The way that I found to resolve the problem of the test was this:

    it('throws when setting configurable but predicate has none', async () => {
      await expectToThrowFuelError(
        () =>
          new Predicate({
            bytecode: predicateBytesTrue,
            abi: predicateAbiTrue,
            provider: wallet.provider,
            inputData: ['NADA'],
            configurableConstants: {
              constant: 'NADA',
            },
          }),
        {
          code: ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
          message: expect.stringContaining('Predicate has no configurable constants to be set'),
        }
      );
    });

[arboleya]

@msensys It looks like this PR will actually close this, correct?

• Replace all occurrences of Error to FuelError #2001

If so, please change the description to Close #NNN instead of Relates to #NNN.

Also, if you add a comment on #2001, we can assign it to you.

[msensys]

@msensys It looks like this PR will actually close this, correct?

• Replace all occurrences of Error to FuelError #2001

If so, please change the description to Close #NNN instead of Relates to #NNN.

Also, if you add a comment on #2001, we can assign it to you.

@arboleya, can I consider it as fix?

I associated this as patch due to what @petertonysmith94 said in its comment.

[arboleya]

@msensys Oh, I assumed it would handle all generic errors, not only a subset.

Isn't that the case? If not, it won't be enough to close #2001.

[msensys]

@msensys Oh, I assumed it would handle all generic errors, not only a subset.

Isn't that the case? If not, it won't be enough to close #2001.

I'll cover them all, but I want to know about the name to proceed :D

[arboleya]

@msensys What do you mean by "name"?

[msensys]

@msensys What do you mean by "name"?

Change the label of commit.

Btw, some tests use Error in the mock part. So changing this might not make sense.

[nedsalk]

@msensys the expectToThrowFuelError utility internally checks for message (and any other property) equality. You shouldn't be passing this as its second argument:

{
  code: ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
  message: expect.stringContaining('Predicate has no configurable constants to be set'),
}

but rather this:

new FuelError(
  ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
  'Predicate has no configurable constants to be set'
)

[msensys]

I don't know why, but the test isn't passing

[msensys]

@nedsalk look at here:

- [FuelError: Predicate has no configurable constants to be set]
+ Object {
+   "VERSIONS": Object {
+     "FORC": "0.60.0",
+     "FUELS": "0.90.0",
+     "FUEL_CORE": "0.30.0",
+   },
+   "code": "invalid-configurable-constants",
+   "metadata": Object {},
+   "name": "FuelError",
+ }

[arboleya]

I don't see any failing tests; CI is green for all workflows.

But as @nedsalk said, you should not assert the error with an Object:

fuels-ts/packages/fuel-gauge/src/predicate/predicate-configurables.test.ts

Lines 211 to 214 in 06aadf6

	{
	code: ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
	message: expect.stringContaining('Predicate has no configurable constants to be set'),
	}

Instead, you should use FuelError, as you did on the other occurrences:

fuels-ts/packages/fuel-gauge/src/predicate/predicate-configurables.test.ts

Lines 230 to 233 in 06aadf6

	new FuelError(
	ErrorCode.INVALID_CONFIGURABLE_CONSTANTS,
	`Error setting configurable constants: No configurable constant named 'NOPE' found in the Predicate.`
	)

[msensys]

I committed the change you mentioned. Take a look at CI

[nedsalk]

@msensys the test is failing because of this line catching and rethrowing the error with an updated message. To fix the failing test, change the expected message in your test to Error setting configurable constants: Predicate has no configurable constants to be set.; you were missing the Error setting configurable constants: part. We should maybe rethink this try/catch here, but it's out of the scope of this issue. Just changing the expected message is enough.

[maschad]

@msensys I see that this PR still needs some work as there are quite a few places we still throw Error as opposed to FuelError (at least in 41 files). I'm going to move this PR to draft and you can re-open it to review once it's ready.

[arboleya]

@msensys I see that this PR still needs some work as there are quite a few places we still throw Error as opposed to FuelError (at least in 41 files). I'm going to move this PR to draft and you can re-open it to review once it's ready.

Note that we should use the UNKNOWN code for unmapped errors.

However, to apply this, you'll need to wait until we merge this:

• chore: add UNKNOWN error code #2562

cc @maschad

[arboleya]

Note that we should use the UNKNOWN code for unmapped errors.

Also, UNKNOWN errors must contain the rawError (see comment).