Adds ability to search for templates by title/description messages. #28

JeffreyDoyle · 2023-10-18T22:39:06Z

Adds ability to search for templates by title/description messages.

eg:

POST /v2/templates/search/messages

Body: 
{
    "searchMessagesTitleENUS": "tokens",
    "searchMessagesDescriptionENUS": "transfer"
}

returns:

{
    "page": 0,
    "range": 100,
    "count": 1,
    "results": [
        {
            "f_type": "InteractionTemplate",
            "f_version": "1.0.0",
            "id": "290b6b6222b2a77b16db896a80ddf29ebd1fa3038c9e6625a933fa213fce51fa",
            "data": {
                "type": "transaction",
                "interface": "",
                "messages": {
                    "title": {
                        "i18n": {
                            "en-US": "Transfer Tokens"
                        }
                    },
                    "description": {
                        "i18n": {
                            "en-US": "Transfer tokens from one account to another"
                        }
                    }
                },
                "cadence": "import FungibleToken from 0xFUNGIBLETOKENADDRESS\ntransaction(amount: UFix64, to: Address) {\nlet vault: @FungibleToken.Vault\nprepare(signer: AuthAccount) {\nself.vault <- signer\n.borrow<&{FungibleToken.Provider}>(from: /storage/flowTokenVault)!\n.withdraw(amount: amount)\n}\nexecute {\ngetAccount(to)\n.getCapability(/public/flowTokenReceiver)!\n.borrow<&{FungibleToken.Receiver}>()!\n.deposit(from: <-self.vault)\n}\n}",
                "dependencies": {
                    "0xFUNGIBLETOKENADDRESS": {
                        "FungibleToken": {
                            "mainnet": {
                                "address": "0xf233dcee88fe0abe",
                                "fq_address": "A.0xf233dcee88fe0abe.FungibleToken",
                                "contract": "FungibleToken",
                                "pin": "83c9e3d61d3b5ebf24356a9f17b5b57b12d6d56547abc73e05f820a0ae7d9cf5",
                                "pin_block_height": 34166296
                            },
                            "testnet": {
                                "address": "0x9a0766d93b6608b7",
                                "fq_address": "A.0x9a0766d93b6608b7.FungibleToken",
                                "contract": "FungibleToken",
                                "pin": "83c9e3d61d3b5ebf24356a9f17b5b57b12d6d56547abc73e05f820a0ae7d9cf5",
                                "pin_block_height": 74776482
                            }
                        }
                    }
                },
                "arguments": {
                    "amount": {
                        "index": 0,
                        "type": "UFix64",
                        "messages": {
                            "title": {
                                "i18n": {
                                    "en-US": "The amount of FLOW tokens to send"
                                }
                            }
                        },
                        "balance": ""
                    },
                    "to": {
                        "index": 1,
                        "type": "Address",
                        "messages": {
                            "title": {
                                "i18n": {
                                    "en-US": "The Flow account the tokens will go to"
                                }
                            }
                        },
                        "balance": ""
                    }
                }
            }
        }
    ]
}

vercel · 2023-10-18T22:39:11Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flow-interaction-template-service	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2023 10:56pm

chasefleming

Some responses return strings and others objects. Should have consistent formatting.

chasefleming · 2023-10-18T23:14:00Z

api/src/routes/template-v2.ts

+    let template;
+    try {
+      template = await templateService.getTemplateByCadenceASTHash(
+        await genHash(cadenceAST),


You're awaiting the genHash function multiple times for the same input. Compute it once.

chasefleming · 2023-10-18T23:14:44Z

api/src/routes/template-v2.ts

@@ -0,0 +1,185 @@
+import express, { Request, Response, Router } from "express";
+import { body } from "express-validator";


chasefleming · 2023-10-18T23:19:31Z

api/src/routes/template-v2.ts

+    let templateId: string = "";
+    let _name: string = name;
+    while (_name !== undefined) {
+      let foundName = namesJSONFile[_name];


Are names guaranteed to be unique?

In the names json file, yes

chasefleming · 2023-10-18T23:21:28Z

@JeffreyDoyle this also needs documentation on the readme or something

chasefleming · 2023-10-18T23:23:45Z

api/src/routes/template-v2.ts

+    try {
+      const templates = await templateService.searchTemplates(
+        page ?? 0,
+        range ?? 100,


You need a max range or someone could slam it with too large a number

bthaile · 2023-10-18T23:47:47Z

Vercel preview link doesn't work. Is it suppose to?

chasefleming · 2023-10-19T00:04:15Z

Also, is there a library you can use to make search better? Exact text match does not seem ideal. Tagging may be a better option since search is hard.

bartolomej

Hey, I'm coming from this issue #18 (comment).

As I mentioned, Flowser app would benefit from this kind of functionality greatly. Exciting stuff!

Added a few thoughts of my own below.

bartolomej · 2023-11-04T16:12:43Z

api/src/routes/template-v2.ts

+    return res.send(template);
+  });
+
+  router.post("/templates/search/messages", async (req: Request, res: Response) => {


Nit: The endpoint path is a bit confusing to me, as it could also be interpreted as searching for a "message" resource. But that's not true, I think it's only searching by "message" fields like title/description.

Could it make more sense for it to be named /templates/search or even just GET /templates?search={query} (where an empty query or no query parameter present could list all templates)? Using the GET verb could also make sense (semantically at least), since this only reads data.

I can see there is also an endpoint for searching by the AST hash. Maybe that could instead just be another query parameter like /templates/search?cadence_ast_hash?

It could lead to simpler API if there was a single endpoint that supported different search options, as opposed to multiple endpoints, each supporting a different search option.

Another search option could be searching by "dependencies", as I mentioned here: #18 (comment)

Thoughts?

bartolomej · 2023-11-04T16:22:33Z

api/src/services/template.ts

+    }
+
+    if (searchMessagesDescriptionENUS) {
+      queryBuilder = queryBuilder.where("messages_description_enUS", "like", `%${searchMessagesDescriptionENUS}%`)


Wondering if it would be possible to do full-text, instead of searching for exact substring matches?

I can see that SQLite does support some kind of full-text search capabilities: https://www.sqlite.org/fts5.html. But I'm not sure if this feature is available in better-sqlite3 which is used in this project.

bartolomej · 2023-11-04T16:59:34Z

api/src/routes/template-v2.ts

Should we update the documentation in README with v2 endpoints?

JeffreyDoyle added 6 commits October 18, 2023 15:34

Adds DB columns for title/description messages

450ed24

Adds messages columns to template model

088081b

Adds ability to search for templates that match a title/description

84b2348

Correct config

67b73b5

Split template routes into versioned api

182d50c

Use versioned template routes

7fd647d

vercel bot deployed to Preview October 18, 2023 22:39 View deployment

Revert to v1 template

8b1f283

vercel bot deployed to Preview October 18, 2023 22:45 View deployment

Remove logging

3f2ac88

vercel bot deployed to Preview October 18, 2023 22:56 View deployment

chasefleming requested changes Oct 18, 2023

View reviewed changes

chasefleming reviewed Oct 18, 2023

View reviewed changes

bartolomej reviewed Nov 4, 2023

View reviewed changes

api/src/routes/template-v2.ts

Copy link

bartolomej Nov 4, 2023 •

edited

Loading

Choose a reason for hiding this comment

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

Should we update the documentation in README with v2 endpoints?

bartolomej mentioned this pull request Nov 11, 2023

List all templates (MVP) onflowser/flow-interaction-template-service#2

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds ability to search for templates by title/description messages. #28

Adds ability to search for templates by title/description messages. #28

JeffreyDoyle commented Oct 18, 2023

vercel bot commented Oct 18, 2023 •

edited

Loading

chasefleming left a comment

chasefleming Oct 18, 2023

chasefleming Oct 18, 2023

chasefleming Oct 18, 2023

JeffreyDoyle Oct 19, 2023

chasefleming commented Oct 18, 2023

chasefleming Oct 18, 2023

bthaile commented Oct 18, 2023

chasefleming commented Oct 19, 2023

bartolomej left a comment

bartolomej Nov 4, 2023 •

edited

Loading

bartolomej Nov 4, 2023 •

edited

Loading

bartolomej Nov 4, 2023

bartolomej Nov 4, 2023 •

edited

Loading

		@@ -0,0 +1,185 @@
		import express, { Request, Response, Router } from "express";
		import { body } from "express-validator";

Adds ability to search for templates by title/description messages. #28

Are you sure you want to change the base?

Adds ability to search for templates by title/description messages. #28

Conversation

JeffreyDoyle commented Oct 18, 2023

vercel bot commented Oct 18, 2023 • edited Loading

chasefleming left a comment

Choose a reason for hiding this comment

chasefleming Oct 18, 2023

Choose a reason for hiding this comment

chasefleming Oct 18, 2023

Choose a reason for hiding this comment

chasefleming Oct 18, 2023

Choose a reason for hiding this comment

JeffreyDoyle Oct 19, 2023

Choose a reason for hiding this comment

chasefleming commented Oct 18, 2023

chasefleming Oct 18, 2023

Choose a reason for hiding this comment

bthaile commented Oct 18, 2023

chasefleming commented Oct 19, 2023

bartolomej left a comment

Choose a reason for hiding this comment

bartolomej Nov 4, 2023 • edited Loading

Choose a reason for hiding this comment

bartolomej Nov 4, 2023 • edited Loading

Choose a reason for hiding this comment

bartolomej Nov 4, 2023

Choose a reason for hiding this comment

bartolomej Nov 4, 2023 • edited Loading

Choose a reason for hiding this comment

vercel bot commented Oct 18, 2023 •

edited

Loading

bartolomej Nov 4, 2023 •

edited

Loading

bartolomej Nov 4, 2023 •

edited

Loading

bartolomej Nov 4, 2023 •

edited

Loading