Skip to content

Conversation

@jbalidiong
Copy link
Contributor

Update the reference doc for assertSucceed and align it to the public doc.

per: https://firebase.google.com/docs/rules/unit-tests#rut-v2-common-methods

The function asserts that the supplied Promise wrapping an emulator operation will be resolved with no Security Rules violations.

Proposed fix for #6306

@changeset-bot
Copy link

changeset-bot bot commented Jun 16, 2022

⚠️ No Changeset found

Latest commit: 1895d5d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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


/**
* Assert the promise to be rejected with a "permission denied" error.
* Assert the promise to be successful with no Security Rules error.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the additional part after "successful" is confusing and is explained in further detail below. "Assert the promise to be successful" should be good enough here. Thanks!

@hsubox76 hsubox76 merged commit d3336a9 into firebase:master Jun 23, 2022
@firebase firebase locked and limited conversation to collaborators Jul 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants