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.

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

[WIP, ECO-4821] Gather further private API usage info #1784

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Jun 5, 2024

This PR is based on top of #1756. Gathering data on private API usage in tests for ECO-4821, so that we can see what work needs to be done to reuse them as the unified test suite.

@lawrence-forooghian lawrence-forooghian changed the base branch from main to ECO-4786-document-private-API-usage June 5, 2024 11:50
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 11:50 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 11:51 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 11:51 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 12:07 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 12:08 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 12:08 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 13:01 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 13:02 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 13:02 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 14:41 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 14:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 14:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 17:16 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 17:17 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 17:17 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 17:51 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 17:51 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 17:51 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 18:09 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 18:10 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 18:10 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 19:01 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 19:01 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 19:01 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 19:33 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 5, 2024 19:34 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 19:34 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 5, 2024 20:08 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 5, 2024 20:08 Inactive
It isn’t intended be called as a constructor.
TODO figure out what should be class method; at the moment everything is
instance except for the ones that have a .skip because that wasn't
implementable for an instance method, and also because these clearly
aren’t going to be called at a per-test level. But there may well be
other stuff (e.g. stuff that's used at a non-test level, or it might
just be that the instance doesn't always have a test)
there's no private api use, these are uncontroversial
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4821-gather-further-private-API-usage-info branch from cc2b8a8 to 1207f4b Compare June 12, 2024 14:42
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 12, 2024 14:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 12, 2024 14:43 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 12, 2024 14:43 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4821-gather-further-private-API-usage-info branch from 1207f4b to 81524a7 Compare June 12, 2024 14:59
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 12, 2024 14:59 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 12, 2024 15:00 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 12, 2024 15:00 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4821-gather-further-private-API-usage-info branch from 81524a7 to c2f8591 Compare June 12, 2024 15:02
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 12, 2024 15:03 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 12, 2024 15:03 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 12, 2024 15:03 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4821-gather-further-private-API-usage-info branch from c2f8591 to 9986dc4 Compare June 12, 2024 18:51
@github-actions github-actions bot temporarily deployed to staging/pull/1784/features June 12, 2024 18:52 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/bundle-report June 12, 2024 18:52 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1784/typedoc June 12, 2024 18:52 Inactive
@lawrence-forooghian
Copy link
Collaborator Author

lawrence-forooghian commented Jun 12, 2024

Here's the data gathered at commit 9986dc4 from this job: private-api-usage-9986dc4.json. We’ll do something with it in ECO-4834.

TODO incorporate into 3a10b09. Context: when, in a later commit, I
attempted to modify `this.helper` inside an `it` to add to its
helperStack (for e.g. the tests generated by testOnAllTransports), it
seemed to have some weird global effect; i.e. the helper then became
used by other tests.

- in test, `this` is `Context { _runnable: Test, test: Test }`
- in root hook, `this` is `Context { currentTest: Test, _runnable: Hook }`

Setting it on the `Test` object instead of on `this` seems to fix it.
Preparation for logging private API usage.
For ECO-4821 (getting better information on private API usage, in the
context of reusing this test suite as a unified test suite).

(Note I haven't been very consistent with how many times per test I
record the usage of a given private API; it’s not a stat I’m
particularly interested in here. But for the most part I’m doing it at
the point of each invocation of the private API.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant