Utility to query Snaps for conditions. #520
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mrtenz
requested changes
Mar 26, 2024
.eslintrc.js
Outdated
| @@ -32,5 +32,6 @@ module.exports = { | |||
| 'dist/', | |||
| 'docs/', | |||
| '.yarn/', | |||
| 'scripts/query/', | |||
There was a problem hiding this comment.
The Query uses fs, path and process to manage local file writes, reads and env vars.
This violates the eslint rules. So we can either relax the eslint rules or we can ignore it for the Query files.
Please let me know if there is another option.
There was a problem hiding this comment.
If you change
files: ['*.js', 'scripts/*.ts'],
to
files: ['*.js', 'scripts/**/*.ts'],
a little further up in the config, and remove this line, most of the lint errors will be fixed.
There was a problem hiding this comment.
Thanks.
Fixed as per your suggestion. 👍
Co-authored-by: Maarten Zuidhoorn <[email protected]>
…registry into query-snaps-util
Mrtenz
reviewed
Mar 27, 2024
Mrtenz
reviewed
Mar 27, 2024
scripts/query/get-manifests.ts
Outdated
| ); | ||
|
|
||
| const location = detectSnapLocation(snap.id, { | ||
| versionRange: latestVersion as any, |
There was a problem hiding this comment.
Why is this type cast necessary?
Mrtenz
reviewed
Mar 27, 2024
Mrtenz
reviewed
Mar 27, 2024
Mrtenz
reviewed
Mar 27, 2024
scripts/query/query.ts
Outdated
| @@ -0,0 +1,41 @@ | |||
| import type { SnapManifest } from '@metamask/snaps-utils'; | |||
| import fs from 'fs'; | |||
There was a problem hiding this comment.
If you import from fs/promises, you can just use fs.readFile instead of fs.promises.readFile.
Suggested change
| import fs from 'fs'; | |
| import fs from 'fs/promises'; |
Co-authored-by: Maarten Zuidhoorn <[email protected]>
Co-authored-by: Maarten Zuidhoorn <[email protected]>
Mrtenz
approved these changes
Mar 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is for a Snap Query Utility.
Occasionally we have the need to query for Snaps that meet a condition or criteria - the main use-case being notifying a Snap Builder of an upcoming change or other reason.
The PR has 2 code files:
get-manifests.ts: The code in this file is used to download the manifest files of all Snaps. This will get called the first time or when a refresh of the manifests are needed. All the Snap manifests are then saved to a local JSON file (./data.json). Local storage is to avoid fetching Snap manifests every time we need to run a query.query.ts: This file contains the query logic that we are interested in, and works on the./data.jsonfile.Usage: