Skip to content

feat: add "log" option to hide displayed log of cy.origin() #31114

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

Closed
wants to merge 2 commits into from
Closed

feat: add "log" option to hide displayed log of cy.origin() #31114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e10e4db
feat: add "log" option to hide displayed log of cy.origin()
XavierBoubert Feb 16, 2025
739bb29
Merge branch 'develop' into develop
jennifer-shehane Feb 17, 2025
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
4 changes: 4 additions & 0 deletions cli/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

_Released 2/25/2025 (PENDING)_

**Features:**

- Add `log: boolean` option to hide the `cy.origin()` log. Addressed in [#31114](https://github.com/cypress-io/cypress/pull/31114).

## 14.0.3

_Released 2/11/2025_
Expand Down
2 changes: 1 addition & 1 deletion cli/types/cypress.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1663,7 +1663,7 @@ declare namespace Cypress {
* expect(foo).to.equal('foo')
* })
*/
origin<T, S extends any>(urlOrDomain: string, options: {
origin<T, S extends any>(urlOrDomain: string, options: Partial<Loggable> & {
args: T
}, fn: (args: T) => void): Chainable<S>

Expand Down
2 changes: 2 additions & 0 deletions cli/types/tests/cypress-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,6 +1012,8 @@ namespace CypressOriginTests {
cy.origin('example.com', { args: 'value' }, (value: string) => { })
cy.origin('example.com', { args: 1 }, (value: number) => { })
cy.origin('example.com', { args: true }, (value: boolean) => { })
cy.origin('example.com', { args: true, log: true }, (value: boolean) => { })
cy.origin('example.com', { args: true, log: false }, (value: boolean) => { })

cy.origin() // $ExpectError
cy.origin('example.com') // $ExpectError
Expand Down
4 changes: 3 additions & 1 deletion packages/driver/src/cy/commands/origin/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const normalizeOrigin = (urlOrDomain) => {
return $Location.normalize(origin)
}

type OptionsOrFn<T> = { args: T } | (() => {})
type OptionsOrFn<T> = (Partial<Cypress.Loggable> & { args: T }) | (() => {})
type Fn<T> = (args?: T) => {}

export default (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy, state: StateFunc, config: Cypress.InternalConfig) => {
Expand Down Expand Up @@ -57,6 +57,7 @@ export default (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy, state: State
callbackFn = optionsOrFn
options = {
args: undefined,
log: undefined,
}
}

Expand All @@ -67,6 +68,7 @@ export default (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy, state: State
type: 'parent',
message: urlOrDomain,
timeout,
log: !(options.log === false),
// @ts-ignore TODO: revisit once log-grouping has more implementations
}, (_log) => {
log = _log
Expand Down