Manifest V3 + multiple feature requests #46

gantoine · 2023-07-28T03:27:15Z

Soooooo what started as a small change to replace permissions: ["http://*/*", "https://*/*"] quickly devolved into an evening-long refactor and enhancement of the extension. 🙃

QA

If you're interested in testing these changes but don't want to pull and build locally, you can use these builds:

chrome-2.0.0.zip: download and extract, then "Load unpacked" in chrome://extensions/
firefox-2.0.0.zip: download the zip file, then "Load temporary add-on" in about:debugging#/runtime/this-firefox

Manifest V3

With the switch to manifest V3, the spec for Chrome and Firefox splits; those differences need to be taken into consideration when building a manifest.json. Therefore, this PR takes the approach of splitting the manifest into 3 files: manifest.COMMON.json, manifest.FIREFOX.json and manifest.CHROME.json. During the build process, the COMMON file and one the browser files are merged using jq, and the output is saved as manifest.json (which is no longer tracked in git).

background is now split as Chrome now uses a service worker to run the background script
Renamed browser_action to action
Shortcut text removed from default_title
browser_style set to false since now deprecated
browser_specific_settings.id required for Firefox (set to random UUIDv4)
New permission required to support new functionality:
- storage: localStorage is deprecated in extension contexts
- contextMenus + notifications: quick add link via right-click
- scripting + activeTab: get highlighted text for notes

And one more thing: the build script now outputs both packaged and unpackaged builds to /artifacts/chrome and /artifacts/firefox.

Major Changes

Granular permissions

By marking ["http://*/*", "https://*/*"] as optional_host_permissions, we can request only the permission(s) we need to connect to the Linkding instance. When first configuring the extension, you'll be prompted to grant permission to the page that hosts Linkding.

Firefox	Chrome

Dark mode

The extension popup and settings will appear in dark mode, based on the appearance/theme settings of your browser/OS, via the prefers-color-scheme media feature. I may get around to adding a small toggle in the settings to allow for manual control. Closes #41

Context menu entry

Right-clicking on a link will give you the option to quick-add it to your bookmarks, without having to visit the page. A notification is displayed if it's been added, or if it was already bookmarked. Closes #35

Context menu	Notification

Starred pinned badge

On bookmarked pages, a yellow star will appear on the badge (bottom-right on Chrome, top-right on Firefox). The star should appear as soon as a page is bookmarked, or when a new tab is opened. Closes #30

Other smaller changes

The state of the popup changes from "Save" to "Update" on first save
Add a trash button to delete a saved bookmark
Add link to main site (closes Add link to open linkding web site #29)
Highlighted text is saved to notes when creating/updating a bookmark (closes Put selected text in the description #20)
Update all dependencies to their latest versions
- Required the removal of the Commonjs plugin in favour of ESM

As always, thoughts, questions and concerns are welcome!

Bonus screenshots

Settings	A bookmarked page

gantoine · 2023-07-28T03:39:34Z

manifests/manifest.FIREFOX.json

+	},
+   "browser_specific_settings": {
+		"gecko": {
+         "id": "{6bc19aa2-7d91-4791-b5d4-8d84b5f3cdad}",


I'm not exactly sure what this UUID actually means, but setting a unique one like this does allow the build to pass 🤔

gantoine · 2023-07-28T03:43:54Z

src/browser.js

+    return { url: "", title: "" };
+  }
+
+  return tab;


This is so I can access more properties on the tab (like id)

gantoine · 2023-07-28T03:45:28Z

src/form.svelte

+      title: title || titlePlaceholder,
+      description: description || descriptionPlaceholder,


I think this may be a bug in the current extension, but in any case this change also works as expected.

bsecker · 2023-07-28T15:15:24Z

Dude, you're a legend! Thanks so much for this PR, it adds so many feature requests I've been following in one fell swoop 🚀

gantoine · 2023-07-28T17:27:45Z

@bsecker Glad to hear it! If you're interested in testing the changes but don't want to pull and build locally, let me know and I can upload builds for Chrome and Firefox. Any QA would be appreciated. 🙇🏼

bsecker · 2023-07-28T17:29:40Z

@gantoine I'll happily test it. A build for Firefox would be awesome!

gantoine · 2023-07-28T17:43:55Z

Awesome, and thank you! Here are the builds and instructions, which I've also added to the body of the PR.

chrome-2.0.0.zip: download and extract, then "Load unpacked" in chrome://extensions/
firefox-2.0.0.zip: download the zip file, then "Load temporary add-on" in about:debugging#/runtime/this-firefox

sissbruecker · 2023-07-29T08:56:16Z

Hey, thanks for the effort here, but this PR contains way too many changes for me to properly review it. Could you please extract individual features into separate PRs? Likewise for refactorings / manifest + build changes / etc.

Some quick notes:

The Chrome extension already uses Manifest V3, there is a chrome branch with the relevant changes to the manifest that I just rebase for a release. Your solution would be more convenient though, so I'd take a look at a PR for that.
There's probably a lot that I'd change about the dark theme to the point that I should probably do it myself rather than go into an exhausting review loop. Let's exclude this for now.

bsecker · 2023-07-29T09:27:21Z

Initial impressions from 10 mins of playing around:

I get a small blue dot that appears on each page, which disappears after I click the extension.

I don't get any context menu when right clicking to save a bookmark
there also doesn't seem to be any links to the linkding instance (also after saving the link):

If it helps here's a dump of my troubleshooting info

gantoine · 2023-07-29T12:50:44Z

Could you please extract individual features into separate PRs?

Yes absolutely! Since some of the work builds onto itself, I'll start by opening a PR just for the manifest changes that covers permissions.

There's probably a lot that I'd change about the dark theme to the point that I should probably do it myself rather than go into an exhausting review loop

I took a "something-is-better-then-nothing" approach to dark mode that could be done quickly. I'd love to see a more robust dark mode at some point, but until then I'll open a split PR for dark mode.

gantoine · 2023-07-29T12:58:36Z

I get a small blue dot that appears on each page, which disappears after I click the extension.

My understanding is that the dot appears for websites where explicit permission isn't granted in the manifest. I see it as well, and I believe is has to do with the "tabs" permission. If you reload a page where the dot was removed after clicking it, it comes back.

"After installing an extension, if you navigate to a website that requires permissions for the extension to work, the extensions button will display a notification dot. If the extension is already pinned in the toolbar, the notification dot will appear below the extension icon."

https://support.mozilla.org/en-US/kb/extensions-button

I don't get any context menu when right clicking to save a bookmark
there also doesn't seem to be any links to the linkding instance

This makes me think it's interacting with the old linkding extension (I assume) you had installed in Firefox. Could you try installing Firefox Developer Edition and testing it there, as it allows for installing unsigned add-ons (instead of having to load it temporarily)?

@bsecker Thanks for taking the time to test it!

Georges-Antoine Assi added 12 commits July 27, 2023 18:19

Split builds for firefox and chrome

83b0493

Fix manifest for both browsers + remove commands

4f58c91

Custom artifact folder for output

ba0c522

Update readme for changes + readd action

0c85cdb

Add support for dark mode (sissbruecker#41)

1968e2d

Add entry to context menu (sissbruecker#35)

abe1a83

Add post-save state to insta-update bookmark

ad5cd6e

Add star to bage when page bookmarked (sissbruecker#30)

0f3a22a

Add link to main site (sissbruecker#29)

712b62e

Add option to delete bookmark

874b74a

Highlighted text saved to notes on creation (sissbruecker#20)

ac789e5

Bump package version

8436a55

gantoine mentioned this pull request Jul 28, 2023

Close popup window after bookmark saved (#13) #39

Closed

gantoine commented Jul 28, 2023

View reviewed changes

src/browser.js

return { url: "", title: "" };

}

return tab;

Copy link

Author

gantoine Jul 28, 2023

Choose a reason for hiding this comment

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

This is so I can access more properties on the tab (like id)

gantoine commented Jul 28, 2023

View reviewed changes

Changes + comments from self-review

03fd599

This was referenced Jul 28, 2023

[Feature request] Dark mode support #41

Closed

[Feature request] Save links from right click menu #35

Closed

Graphical feedback of linkding bookmark button #30

Closed

Put selected text in the description #20

Open

Add link to open linkding web site #29

Open

Fix starring behaviour on tab state changes

4686d0c

Uncomment npm isntallm in build

dcd276a

gantoine closed this Jul 29, 2023

gantoine mentioned this pull request Jul 30, 2023

Manifest V3 migration #47

Closed

jonathan-s mentioned this pull request Jan 20, 2024

Add a star badge for already bookmarked websites #64

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Manifest V3 + multiple feature requests #46

Manifest V3 + multiple feature requests #46

gantoine commented Jul 28, 2023 •

edited

Loading

gantoine Jul 28, 2023

gantoine Jul 28, 2023

gantoine Jul 28, 2023

bsecker commented Jul 28, 2023

gantoine commented Jul 28, 2023

bsecker commented Jul 28, 2023

gantoine commented Jul 28, 2023

sissbruecker commented Jul 29, 2023

bsecker commented Jul 29, 2023

gantoine commented Jul 29, 2023

gantoine commented Jul 29, 2023 •

edited

Loading

		title: title \|\| titlePlaceholder,
		description: description \|\| descriptionPlaceholder,

Manifest V3 + multiple feature requests #46

Manifest V3 + multiple feature requests #46

Conversation

gantoine commented Jul 28, 2023 • edited Loading

QA

Manifest V3

Major Changes

Granular permissions

Dark mode

Context menu entry

Starred pinned badge

Other smaller changes

Bonus screenshots

gantoine Jul 28, 2023

Choose a reason for hiding this comment

gantoine Jul 28, 2023

Choose a reason for hiding this comment

gantoine Jul 28, 2023

Choose a reason for hiding this comment

bsecker commented Jul 28, 2023

gantoine commented Jul 28, 2023

bsecker commented Jul 28, 2023

gantoine commented Jul 28, 2023

sissbruecker commented Jul 29, 2023

bsecker commented Jul 29, 2023

gantoine commented Jul 29, 2023

gantoine commented Jul 29, 2023 • edited Loading

gantoine commented Jul 28, 2023 •

edited

Loading

gantoine commented Jul 29, 2023 •

edited

Loading