Use Storage by tab

[Jeromearsene]

How do you envision this feature/change to look/work like?

It will be nice to have possibility to save datas by tab.

Currently I've not found how to preserve state infos of Content UI by tab.
By example, if I want preserve my Content UI sidebar width by tab, I must use storage with something like this:

{
    [tab_id_1]: 500,
    [tab_id_2]: 300,
}

Moreover, it seems necessary to retrieve tab id by message with background, like this:

// /get-tab-by-id.ts
import type { PlasmoMessaging } from "@plasmohq/messaging"

const handler: PlasmoMessaging.MessageHandler = async (req, res) => {
  res.send(req.sender.tab.id)
}

export default handler

const [currentTabId, setCurrentTabId] = useState<chrome.tabs.Tab["id"]>()

useEffect(() => {
    sendToBackground({
      name: "get-tab-id"
    }).then((tabId) => {
      setCurrentTabId(tabId)
    })
  }, [])

This is not really practice. Maybe an other solution exist but I didn't find any 😅

What is the purpose of this change/feature? Why?

Ideally, add possibility to save in storage by tab.

(OPTIONAL) Example implementations

I would like use a parameter when I save my datas to use by tab, like this:

const [sidebarWidth] = useStorage({
  key: "sidebar-width",
  instance: new Storage({
    onlyCurrentTab: true
  })
})

(OPTIONAL) Contribution

• I would like to contribute to this RFC via a PR

Verify canary release

• I verified that the issue exists in plasmo canary release

Code of Conduct

• I agree to follow this project's Code of Conduct
• I checked the current issues for duplicate problems.

[tbhaxor]

Do you know that tab ids are not persistent? They can be changed.

[Jeromearsene]

Yes, thanks for you answer. I must listen this change with chrome.tabs.onReplaced if I want to have a complete approach.

My response is based on this post.

[louisgv]

This should be user-space implementation @Jeromearsene , you can do it in the bgsw instead of the CS, and you need to define your "source of truth,"

@tbhaxor is correct, the tabid is indeterministic. You will want to use some kind of record based on href or something like that.

[Jeromearsene]

A problem already exist if I use href or domain like key: navigation between site in same tab.

This problem is a common problem:

• https://stackoverflow.com/questions/24342702/chrome-extension-storing-variables-for-a-tab-even-if-page-changes
• https://stackoverflow.com/questions/55272272/chromeextension-storage-per-tab
• https://stackoverflow.com/questions/6579598/local-storage-variable-scope-per-tab-in-google-chrome-extensions

[louisgv]

Hmm @Jeromearsene do you think it'd be helpful for /storage to exposes an abstraction of this concept? It requires a bit of integration between the pieces within chrome extension :-?...