watchlist worker

[newraina]

Ref: #64

test: watchlist.0xxmmvv.workers.dev

APIs:

• GET /watchlists - list all watchlists
• POST /watchlists - create watchlist
• GET /watchlists/:id - get one watchlist
• PUT /watchlists/:id - update one watchlist (only name can be updated for now)
• DELETE /watchlists/:id - delete watchlist
• GET /watchlists/:id/chains/:chain_id/items - list items in watchlist
• POST /watchlists/:id/chains/:chain_id/items - add to watchlist
• GET /watchlists/:id/chains/:chain_id/items/:item_id/exists - check if item exists in watchlist
• DELETE /watchlists/:id/chains/:chain_id/items/:item_id - remove from watchlist

request headers:

• x-auth-address address of user

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@cloudflare/workers-types@4.20240405.0	None	0	3.49 MB	wrangler-publisher
npm/@polkadot/util-crypto@12.6.2	None	+20	6.61 MB	polkadotjs
npm/@types/node@20.12.7	None	+1	2.1 MB	types
npm/better-sqlite3@9.5.0	filesystem Transitive: environment, network, shell	+37	10.7 MB	joshuawise
npm/camelcase-keys@9.1.3	None	+4	358 kB	sindresorhus
npm/hono@4.2.3	None	0	781 kB	yusukebe
npm/kysely-codegen@0.14.2	environment, filesystem, unsafe Transitive: shell	+41	2.31 MB	robinblomberg
npm/kysely@0.27.3	network	0	2.69 MB	koskimas
npm/nanoid@5.0.7	None	0	10.9 kB	ai
npm/prettier@3.2.5	environment, filesystem, unsafe	0	8.39 MB	prettier-bot
npm/typescript@5.4.5	None	0	32.4 MB	typescript-bot
npm/wrangler@3.50.0	Transitive: environment, filesystem, network, shell, unsafe	+78	786 MB	wrangler-publisher

🚮 Removed packages: npm/@rollup/plugin-commonjs@17.1.0, npm/@rollup/plugin-node-resolve@11.2.1, npm/@rollup/plugin-typescript@8.3.0, npm/@types/is-odd@3.0.0, npm/@types/jest@26.0.24

View full report↗︎

[vikiival]

Please follow README.md

[vikiival]

Does not follow contributing standards

[newraina]

Please follow README.md

@vikiival added the kysely-codegen part and reorganized routes by files.

[vikiival]

~

[vikiival]

I checked the ref issues and it not written correctly:

• Bookmarking/Watchlist worker #64 (comment)

Please let me know if something is unclear for you, I can expand

[newraina]

I checked the ref issues and it not written correctly:

• Bookmarking/Watchlist worker #64 (comment)

Please let me know if something is unclear for you, I can expand

Thanks! will fix them in this week

[newraina]

@vikiival I've overhauled all APIs using a two-entity approach. Given our watchlist UI currently doesn't support multiple watchlists, I introduced a 'default' watchlist for simplicity.

While it may seem like I've created many APIs, only a handful will be used in our UI's initial version:

• GET /watchlists/default/chains/:chain_id/items - list items in default watchlist
• POST /watchlists/default/chains/:chain_id/items - add to default watchlist
• DELETE /watchlists/default/chains/:chain_id/items/:item_id - remove from default watchlist
• GET /watchlists/default/chains/:chain_id/items/:item_id/exists - check if item exists in default watchlist

[vikiival]

try is adress valid from the same package ;))

[newraina]

Changed to use isAddress

[vikiival]

The main problem I have is the default watchlist,

the name of default should be the same as the address :).

and therefore you do not need a ton of checks

[newraina]

the name of default should be the same as the address, and therefore you do not need a ton of checks

@vikiival Could you clarify this for me? Sorry I'm a bit confused how does setting the default watchlist's name as 'address' reduce the number of checks we need to perform?

[vikiival]

Could you clarify this for me?

there should be no routes with 'default' watchlist. Default watchlist for user should have name = address

E.g. My default watchlist should be 5FFG7GHAR2F2xCb5bqaLQrdgNGdtEL64tYgZimRBHDjuxVuA

reduce the number of checks we need to perform

You are doing a magic in the code to 'handle' is default :)

[newraina]

@vikiival Got it, how about this approach:

The ID of default watchlist = address, rather than the name = address. This means I won't have to look up the ID by name every time I get URLs like /watchlists/5FFG7GHAR2F2x.../*. It helps me avoid having to write code like the example below:

if (req.params.watchlistId === address) {
  // it's user's default watchlist
  const id = findWatchlistIdByName(address)
  ...
}

[vikiival]

Sounds good are you planning to continue on this one @newraina ?

[newraina]

@vikiival sure, I can continue in next week

[newraina]

@vikiival removed all routes associated with the 'default' watchlist. To achieve this, I introduced a new publicId field for the watchlist. The publicId for user-created watchlists is a random string, while the publicId for a user's default watchlist is their address.

publicId will appear in the URL as the identifier ID for the watchlist: GET /watchlists/:public_id/.... Primary key id in the database will be only used to associate watchlist items and not be exposed to the user.