Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(WIP) Update templates/examples for SDK v3 #319

Merged
merged 12 commits into from
Jan 28, 2025
Merged

(WIP) Update templates/examples for SDK v3 #319

merged 12 commits into from
Jan 28, 2025

Conversation

karthik2804
Copy link
Collaborator

@karthik2804 karthik2804 commented Jan 27, 2025 •
edited by mikkelhegn
Loading

This PR updates the HTTP template to use the new V3 SDK. It currently points at 3.0.0-rc1.

To currently try out the templates, one can install it using

$ spin templates install --update --git https://github.com/karthik2804/spin-js-sdk --branch update_templates_samples_v3

TODOS:

  • Swap to point at v3.0.0 once we have a stable release
  • Update the examples to use the new template.
  • Once there is a stable v3.0.0 update all examples and generate a package-lock.json

@karthik2804 karthik2804 force-pushed the update_templates_samples_v3 branch from 0efb6dd to e181b8e Compare January 27, 2025 12:29
@karthik2804 karthik2804 marked this pull request as ready for review January 27, 2025 21:39
radu-matei
radu-matei approved these changes Jan 28, 2025
View reviewed changes
examples/aws/s3/README.md
@@ -30,18 +22,15 @@ npm install

```typescript
const client = new S3Client({
region: "<>",
Copy link
Member

Choose a reason for hiding this comment

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

Is this intended?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah good catch - this changed in the example because I rewrote the example to use the router to both be able to list objects and also stream objects for which I hardcoded the region. I will update the readme to use the hardcoded version for now if that is acceptable.

examples/aws/s3/src/index.ts
secretAccessKey: '<>',
sessionToken: '<>',
},
region: 'us-west-2',
Copy link
Member

Choose a reason for hiding this comment

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

same as above

examples/aws/sqs/spin.toml
@@ -3,17 +3,17 @@ spin_manifest_version = 2
[application]
authors = ["karthik2804 <[email protected]>"]
description = ""
name = "s3"
name = "sqs"
Copy link
Member

Choose a reason for hiding this comment

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

Good catch.

@karthik2804 karthik2804 mentioned this pull request Jan 28, 2025
Merged
@tschneidereit tschneidereit changed the title (WIP) Update templaes/examples for SDK v3 (WIP) Update templates/examples for SDK v3 Jan 28, 2025
tschneidereit
tschneidereit approved these changes Jan 28, 2025
View reviewed changes
Copy link
Contributor

@tschneidereit tschneidereit left a comment

Choose a reason for hiding this comment

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

This looks great! Thank you for being extremely diligent in applying changes uniformly.

I left a bunch of suggestions, but none of them are really blocking—except for updating to 3.0 of the SDK: I think we should land this once we've published that. Alternatively we can land it now without a new release, and plan for a very quick follow-up

examples/aws/s3/README.md Outdated Show resolved Hide resolved
examples/aws/s3/package.json Outdated Show resolved Hide resolved
examples/aws/s3/spin.toml Show resolved Hide resolved
examples/aws/s3/webpack.config.js Outdated Show resolved Hide resolved
examples/aws/sqs/src/index.ts
// Any unmatched route will return a 404
router
.get("/", async () => {
let command = new SendMessageCommand(params);
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this dynamically make use of request state somehow? If not, we should move it outside the request handler, so it happens at wizening time.

examples/spin-host-apis/spin-kv/webpack.config.js Outdated Show resolved Hide resolved
examples/spin-host-apis/spin-llm/webpack.config.js Outdated Show resolved Hide resolved
examples/spin-host-apis/spin-mqtt/webpack.config.js Outdated Show resolved Hide resolved
examples/upstash/qstash/src/index.ts Outdated Show resolved Hide resolved
examples/upstash/vector/src/index.ts Outdated Show resolved Hide resolved
itowlson
itowlson reviewed Jan 28, 2025
View reviewed changes
Copy link

@itowlson itowlson left a comment

Choose a reason for hiding this comment

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

I love the way you've got rid of the spin.ts file, and re-established a distinction between Spin stuff and third-party stuff like the router. I left notes on a couple of things I was puzzled by, but they're nits: this is storming stuff.

templates/http-js/content/src/index.js Outdated Show resolved Hide resolved
templates/http-js/content/src/index.js Outdated Show resolved Hide resolved
templates/http-ts/content/spin.toml Show resolved Hide resolved
@karthik2804
bump templates to use v3.0.0-rc1 and depend on itty router directly
1b968f6 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update common pattern examples
374382e 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update github examples
3a701a8 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update upstash examples
b13db01 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update drizzle example and update tsconfig to be ES2020
593d50d 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
fix outbound url for upstash
1d8dea7 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update aws examples
dd8eebd 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update blob-storage
60cc082 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update serverlessdb examples
4ae5ae2 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update spin host api examples
b37b97c 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
update spin package and checkin package-lock for examples
2f223d2 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804
address review comments
045f9b3 
Signed-off-by: karthik2804 <[email protected]>
@karthik2804 karthik2804 force-pushed the update_templates_samples_v3 branch from d951c50 to 045f9b3 Compare January 28, 2025 22:02
@karthik2804 karthik2804 merged commit cb6a784 into spinframework:main Jan 28, 2025
5 checks passed
@karthik2804 karthik2804 deleted the update_templates_samples_v3 branch January 28, 2025 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@itowlson itowlson itowlson left review comments

@tschneidereit tschneidereit tschneidereit approved these changes

@radu-matei radu-matei radu-matei approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@karthik2804 @tschneidereit @itowlson @radu-matei