feat: add ability to create a File object from URL#2432
Merged
ddelgrosso1 merged 3 commits intogoogleapis:mainfrom Apr 15, 2024
Merged
feat: add ability to create a File object from URL#2432ddelgrosso1 merged 3 commits intogoogleapis:mainfrom
ddelgrosso1 merged 3 commits intogoogleapis:mainfrom
Conversation
danielbankhead
approved these changes
Apr 4, 2024
Contributor
danielbankhead
left a comment
There was a problem hiding this comment.
Looks great! One optional suggestion
Comment on lines
+2372
to
+2391
| static from( | ||
| publicUrlOrGsUrl: string, | ||
| storageInstance: Storage, | ||
| options?: FileOptions | ||
| ): File { | ||
| const gsMatches = [...publicUrlOrGsUrl.matchAll(GS_UTIL_URL_REGEX)]; | ||
| const httpsMatches = [...publicUrlOrGsUrl.matchAll(HTTPS_PUBLIC_URL_REGEX)]; | ||
|
|
||
| if (gsMatches.length > 0) { | ||
| const bucket = new Bucket(storageInstance, gsMatches[0][1]); | ||
| return new File(bucket, gsMatches[0][2], options); | ||
| } else if (httpsMatches.length > 0) { | ||
| const bucket = new Bucket(storageInstance, httpsMatches[0][2]); | ||
| return new File(bucket, httpsMatches[0][3], options); | ||
| } else { | ||
| throw new Error( | ||
| 'URL string must be of format gs://bucket/file or https://storage.googleapis.com/bucket/file' | ||
| ); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Alternatively, we could parse the URL, then use protocol to determine the logic. Here's an example with an optional storage param:
Suggested change
| static from( | |
| publicUrlOrGsUrl: string, | |
| storageInstance: Storage, | |
| options?: FileOptions | |
| ): File { | |
| const gsMatches = [...publicUrlOrGsUrl.matchAll(GS_UTIL_URL_REGEX)]; | |
| const httpsMatches = [...publicUrlOrGsUrl.matchAll(HTTPS_PUBLIC_URL_REGEX)]; | |
| if (gsMatches.length > 0) { | |
| const bucket = new Bucket(storageInstance, gsMatches[0][1]); | |
| return new File(bucket, gsMatches[0][2], options); | |
| } else if (httpsMatches.length > 0) { | |
| const bucket = new Bucket(storageInstance, httpsMatches[0][2]); | |
| return new File(bucket, httpsMatches[0][3], options); | |
| } else { | |
| throw new Error( | |
| 'URL string must be of format gs://bucket/file or https://storage.googleapis.com/bucket/file' | |
| ); | |
| } | |
| } | |
| static from( | |
| publicUrlOrGsUrl: string | URL, | |
| storage?: Storage, | |
| options?: FileOptions | |
| ): File { | |
| const url = new URL(publicUrlOrGsUrl); | |
| if (url.protocol === 'gs:') { | |
| const storageInstance = storage ?? new Storage(); | |
| const bucket = new Bucket(storageInstance, url.host); | |
| return new File(bucket, url.pathname.slice(1), options); | |
| } else if (url.protocol === 'http:' || url.protocol === 'https:') { | |
| const {groups: {bucketName, fileName}} = /\/(?<bucket>[^/]*)\/(?<filename>.*)/.exec(u.pathname); | |
| const storageInstance = storage ?? new Storage({apiEndpoint: url.hostname}); | |
| const bucket = new Bucket(storageInstance, bucketName); | |
| return new File(bucket, fileName, options); | |
| } else { | |
| throw new Error( | |
| 'URL string must be of format gs://bucket/file or https://storage.googleapis.com/bucket/file' | |
| ); | |
| } | |
| } |
If we do this we'll need to make a small change to storage.ts on line ~180 to prevent accidental custom apiEndpoint when provided.
From:
if (options.apiEndpoint) {To:
if (options.apiEndpoint && options.apiEndpoint !== apiEndpoint) {
Contributor
Author
There was a problem hiding this comment.
Good suggestion, I'm apt to leave this using the regexs to make it a bit more concise and avoid the apiEndpoint logic. It also matches how it was done in the python client (not that consistency is SUPER important).
Contributor
|
let's gooooo 🚀 so excited to see this feature get implemented! |
This was referenced Sep 3, 2024
This was referenced Sep 12, 2024
This was referenced Sep 14, 2024
This was referenced Sep 21, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #1898 🦕