Docs for saveState and restoreState #89

sonic16x · 2025-09-24T09:54:47Z

No description provided.

shadowusr

Let's fix typos and add command params tables

shadowusr · 2025-10-07T12:46:28Z

docs/commands/browser/saveState.mdx

+
+## Usage {#usage}
+
+Command return state dump from page, it will include cookie, localStorage and sessionStorage.


Command returns

It will include cookies

etc. I think it would be good to let some LLM scan this for typos and improve wording

I don't see any changes in this sentence, it still has mistakes, isn't it?

shadowusr · 2025-10-07T12:51:51Z

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/saveState.mdx

+
+## Использование {#usage}
+
+Команда вернёт объект включающий cookie, localStorage и sessionStorage.


I think it would be nice to have "Command Parameters" table like we do on other pages, e.g. https://testplane.io/docs/v8/commands/browser/setMeta/

shadowusr · 2025-10-07T12:55:23Z

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/restoreState.mdx

+
+## Использование {#usage}
+
+Вы можете восстановить данные из файла (используя параметр `path`) или из объекта (используя параметр`data`)


A lot of typos here e.g. "нуд=жные" and I'd use more structured language here. Again, I'd just use LLM to improve spelling and wording here

github-actions · 2025-10-15T05:49:52Z

✅ Successfully deployed static

shadowusr

A great result overall! 🔥

Though I think at least some of the issues I raised need to be addressed, because docs are the face of the product

shadowusr · 2025-10-20T13:21:34Z

docs/commands/browser/restoreState.mdx

+
+Browser command that restores session state (cookies, local and session storages) from a file or variable.
+
+<Admonition type="warning">


Is this warning still needed?

shadowusr · 2025-10-20T13:25:02Z

docs/commands/browser/saveState.mdx

+
+## Usage {#usage}
+
+Command return state dump from page, it will include cookie, localStorage and sessionStorage.


I don't see any changes in this sentence, it still has mistakes, isn't it?

shadowusr · 2025-10-20T13:40:16Z

docs/commands/browser/saveState.mdx

+Command return state dump from page; it will include cookie, localStorage, and sessionStorage.
+But using params, you can disable some data.
+Also, if you provide the `path` param, you can get a dump in a file.
+After saving the state, you can use it in the [restoreState](../restoreState) command.


Besides spelling mistakes, the way this section is structured makes it hard to follow.

I strongly suggest to use LLM to improve this section. For example, I used this prompt:

Improve spelling and wording of this documentation section. Make it easy to follow and clear. Respond only with markdown of corrected doc section.

And got:

This command returns a snapshot of the page state, including cookies, localStorage, and sessionStorage.
You can use parameters to exclude specific types of data if needed.

If you provide the path parameter, the state dump will be saved to a file.
The saved state can later be restored using the restoreState command.

shadowusr · 2025-10-20T13:42:04Z

docs/commands/browser/saveState.mdx

+```typescript
+import type { SaveStateData } from "testplane";
+
+const stateDump: SaveStateData = await browser.saveState({


It would be really nice to briefly comment what's exactly inside that SaveStateData object. Or, if the SaveStateData interface is simple enough, we can include it right in the example.

shadowusr · 2025-10-20T13:42:57Z

docs/commands/browser/saveState.mdx

+    <tr><td>**Name**</td><td>**Type**</td><td>**Description**</td></tr>
+    </thead>
+    <tbody>
+    <tr><td>path</td><td>String</td><td>Path to file where state will be saved.</td></tr>


Let's use Typescript-style types here and wrap them in backticks: string, boolean, etc.

In another docs tables we have this style, but ok here I changed to typescript style

shadowusr · 2025-10-20T14:40:15Z

docs/commands/browser/restoreState.mdx

+You can restore state from file (using the `path` param) or from object (using the `data` param).
+But if you provide both, the file will have the highest priority.
+Also, you can provide `cookies`, `localStorage` and `sessionStorage` params to restore only what you need.
+Data for restore state you can get from the [saveState](../saveState) command.


here as well spelling and wording needs to be improved (see comment below). IMO starting sentences from "but" and "also" doesn't quite fit the docs writing style

docs/config/before-all.mdx

shadowusr · 2025-10-20T14:44:15Z

docs/config/after-all.mdx

+Here is an example of suing this hook for logout.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";


I think this example is useless in practice. No one would want to restore tests after all tests are done executing.

A more useful example would be some kind of cleanup, like stopping a server, restoring files, etc.

Change to example where we remove state file

shadowusr · 2025-10-20T14:44:49Z

docs/config/after-all.mdx

+
+## Usage Example {#example}
+
+Here is an example of suing this hook for logout.


typos

I strongly suggest to use either LLM or some editor to auto-detect and fix them. There are a lot of them

shadowusr · 2025-10-20T14:46:00Z

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/restoreState.mdx

All comments from english versions of these articles apply to ru localization as well

sonic16x had a problem deploying to CI September 24, 2025 09:56 — with GitHub Actions Error

sonic16x force-pushed the users/rocketraccoon/TESTPLANE-705.save-state-doc branch from c601228 to 134cf1d Compare September 24, 2025 09:59

sonic16x had a problem deploying to CI September 24, 2025 09:59 — with GitHub Actions Error

feat(testplane): docs for saveState and restoreState

7e531b0

sonic16x force-pushed the users/rocketraccoon/TESTPLANE-705.save-state-doc branch from 134cf1d to 7e531b0 Compare September 24, 2025 10:09

sonic16x had a problem deploying to CI September 24, 2025 10:09 — with GitHub Actions Error

sonic16x had a problem deploying to CI October 7, 2025 09:19 — with GitHub Actions Error

shadowusr requested changes Oct 7, 2025

View reviewed changes

feat(testplane): Fixed

5f69c27

sonic16x had a problem deploying to CI October 15, 2025 05:47 — with GitHub Actions Failure

feat(testplane): add afterAll/beforeAll docs

a21253e

sonic16x had a problem deploying to CI October 15, 2025 06:39 — with GitHub Actions Failure

sonic16x mentioned this pull request Oct 15, 2025

Add beforeAll/afterAll hooks gemini-testing/testplane#1147

Merged

feat(testplane): add cookieFilter

ba553af

sonic16x had a problem deploying to CI October 15, 2025 06:48 — with GitHub Actions Failure

feat(testplane): fixed

c18d65e

sonic16x temporarily deployed to CI October 15, 2025 06:57 — with GitHub Actions Inactive

shadowusr requested changes Oct 20, 2025

View reviewed changes

feat(testplane): fixes

7e48133

sonic16x temporarily deployed to CI October 21, 2025 09:33 — with GitHub Actions Inactive

feat(testplane): fixes

fc1ed2b

sonic16x temporarily deployed to CI October 21, 2025 09:42 — with GitHub Actions Inactive

feat(testplane): fixes

ca3ba6a

sonic16x had a problem deploying to CI October 21, 2025 10:17 — with GitHub Actions Failure

sonic16x had a problem deploying to CI October 21, 2025 10:27 — with GitHub Actions Failure

feat(testplane): fixes

92087ad

sonic16x force-pushed the users/rocketraccoon/TESTPLANE-705.save-state-doc branch from bc2dbda to 92087ad Compare October 21, 2025 10:36

sonic16x deployed to CI October 21, 2025 10:37 — with GitHub Actions Active


		## Usage {#usage}

		Command return state dump from page, it will include cookie, localStorage and sessionStorage.


		## Использование {#usage}

		Команда вернёт объект включающий cookie, localStorage и sessionStorage.


		## Использование {#usage}

		Вы можете восстановить данные из файла (используя параметр `path`) или из объекта (используя параметр`data`)


		Browser command that restores session state (cookies, local and session storages) from a file or variable.

		<Admonition type="warning">


		## Usage Example {#example}

		Here is an example of suing this hook for logout.

Docs for saveState and restoreState #89

Are you sure you want to change the base?

Docs for saveState and restoreState #89

Uh oh!

Conversation

sonic16x commented Sep 24, 2025

Uh oh!

shadowusr left a comment

Choose a reason for hiding this comment

Uh oh!

shadowusr Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Successfully deployed static

Uh oh!

shadowusr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shadowusr Oct 7, 2025 •

edited

Loading

github-actions bot commented Oct 15, 2025 •

edited

Loading