Skip to content

Commit

Permalink
feat: add experimental subscription support via PubSub (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
schettn authored Nov 8, 2024
1 parent de29921 commit a87d141
Show file tree
Hide file tree
Showing 14 changed files with 407 additions and 15 deletions.
15 changes: 15 additions & 0 deletions examples/nodejs-subscriptions/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
node_modules
Dockerfile*
docker-compose*
.dockerignore
.git
.gitignore
README.md
LICENSE
.vscode
Makefile
helm-charts
.env
.editorconfig
.idea
coverage*
175 changes: 175 additions & 0 deletions examples/nodejs-subscriptions/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
\*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
\*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

\*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

\*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.cache
.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

.cache/

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp
.cache

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.\*

# wrangler project

.dev.vars
.wrangler/

# Pylon project
.pylon
45 changes: 45 additions & 0 deletions examples/nodejs-subscriptions/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Use the official Node.js 20 image as the base
FROM node:20-alpine as base

LABEL description="Offical docker image for Pylon services (Node.js)"
LABEL org.opencontainers.image.source="https://github.com/getcronit/pylon"
LABEL maintainer="office@cronit.io"

WORKDIR /usr/src/pylon

# install dependencies into a temp directory
# this will cache them and speed up future builds
FROM base AS install
RUN mkdir -p /temp/dev
COPY package.json package-lock.json /temp/dev/
RUN cd /temp/dev && npm ci

# install with --production (exclude devDependencies)
RUN mkdir -p /temp/prod
COPY package.json package-lock.json /temp/prod/
RUN cd /temp/prod && npm ci --only=production

# copy node_modules from temp directory
# then copy all (non-ignored) project files into the image
FROM install AS prerelease
COPY --from=install /temp/dev/node_modules node_modules
COPY . .

# [optional] tests & build
ENV NODE_ENV=production

# Create .pylon folder (mkdir)
RUN mkdir -p .pylon
# RUN npm test
RUN npm run pylon build

# copy production dependencies and source code into final image
FROM base AS release
COPY --from=install /temp/prod/node_modules node_modules
COPY --from=prerelease /usr/src/pylon/.pylon .pylon
COPY --from=prerelease /usr/src/pylon/package.json .

# run the app
USER node
EXPOSE 3000/tcp
ENTRYPOINT [ "node", "/usr/src/pylon/.pylon/index.js" ]
23 changes: 23 additions & 0 deletions examples/nodejs-subscriptions/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "nodejs-subscriptions",
"private": true,
"version": "0.0.1",
"type": "module",
"description": "Generated with `npm create pylon`",
"scripts": {
"dev": "pylon dev -c \"node --enable-source-maps .pylon/index.js\"",
"build": "pylon build"
},
"dependencies": {
"@getcronit/pylon": "^2.0.0",
"@hono/node-server": "^1.12.2"
},
"devDependencies": {
"@getcronit/pylon-dev": "^1.0.0"
},
"repository": {
"type": "git",
"url": "https://github.com/getcronit/pylon.git"
},
"homepage": "https://pylon.cronit.io"
}
7 changes: 7 additions & 0 deletions examples/nodejs-subscriptions/pylon.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import '@getcronit/pylon'

declare module '@getcronit/pylon' {
interface Bindings {}

interface Variables {}
}
43 changes: 43 additions & 0 deletions examples/nodejs-subscriptions/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import {app, experimentalCreatePubSub, ID} from '@getcronit/pylon'
import {serve} from '@hono/node-server'
import {randomUUID} from 'crypto'

enum Events {
postCreated = 'postCreated'
}

const pubSub = experimentalCreatePubSub<{
[Events.postCreated]: [post: Post]
}>()

class Post {
static create = (title: string, content: string) => {
const post = new Post(randomUUID(), title, content)
posts.push(post)
pubSub.publish(Events.postCreated, post)
return post
}

constructor(public id: ID, public title: string, public content: string) {}
}

const posts = [
new Post(randomUUID(), 'Hello, world!', 'This is the first post'),
new Post(randomUUID(), 'Hello, world!', 'This is the second post')
]

export const graphql = {
Query: {
posts
},
Mutation: {
createPost: Post.create
},
Subscription: {
postCreated: () => pubSub.subscribe(Events.postCreated)
}
}

serve(app, info => {
console.log(`Server running at ${info.port}`)
})
4 changes: 4 additions & 0 deletions examples/nodejs-subscriptions/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"extends": "@getcronit/pylon/tsconfig.pylon.json",
"include": ["pylon.d.ts", "src/**/*.ts"]
}
10 changes: 9 additions & 1 deletion packages/pylon-builder/src/schema/builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,19 +114,27 @@ export class SchemaBuilder {

const queryProperty = sfiType.getProperty('Query')
const mutationProperty = sfiType.getProperty('Mutation')
const subscriptionProperty = sfiType.getProperty('Subscription')

const queryType = queryProperty
? this.checker.getTypeOfSymbolAtLocation(queryProperty, this.sfiFile)
: undefined
const mutationType = mutationProperty
? this.checker.getTypeOfSymbolAtLocation(mutationProperty, this.sfiFile)
: undefined
const subscriptionType = subscriptionProperty
? this.checker.getTypeOfSymbolAtLocation(
subscriptionProperty,
this.sfiFile
)
: undefined

const parser = new SchemaParser(this.checker, this.sfiFile, this.program)

parser.parse({
Query: queryType,
Mutation: mutationType
Mutation: mutationType,
Subscription: subscriptionType
})

return {
Expand Down
Loading

1 comment on commit a87d141

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for pylon-docs ready!

✅ Preview
https://pylon-docs-54sp0e411-schettns-projects.vercel.app

Built with commit a87d141.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.