From 263e4abef6e237831aaa82b34944d1bc1e801c1c Mon Sep 17 00:00:00 2001 From: Tobbe Lundberg Date: Sat, 12 Mar 2022 13:59:45 +0100 Subject: [PATCH 01/18] Check for gql documents before running codegen --- .../fixtures/empty-project/.gitignore | 13 ++ .../empty-project/.vscode/extensions.json | 14 ++ .../empty-project/.vscode/launch.json | 11 ++ .../empty-project/.vscode/settings.json | 11 ++ .../fixtures/empty-project/README.md | 27 ++++ .../empty-project/api/db/schema.prisma | 18 +++ .../fixtures/empty-project/api/jest.config.js | 8 + .../fixtures/empty-project/api/package.json | 9 ++ .../empty-project/api/server.config.js | 23 +++ .../requireAuth/requireAuth.test.ts | 18 +++ .../src/directives/requireAuth/requireAuth.ts | 22 +++ .../src/directives/skipAuth/skipAuth.test.ts | 10 ++ .../api/src/directives/skipAuth/skipAuth.ts | 16 ++ .../api/src/functions/graphql.ts | 19 +++ .../empty-project/api/src/graphql/.keep | 0 .../empty-project/api/src/lib/auth.ts | 25 ++++ .../fixtures/empty-project/api/src/lib/db.ts | 21 +++ .../empty-project/api/src/lib/logger.ts | 17 +++ .../empty-project/api/src/services/.keep | 0 .../fixtures/empty-project/api/tsconfig.json | 34 +++++ .../fixtures/empty-project/graphql.config.js | 5 + .../fixtures/empty-project/jest.config.js | 8 + .../fixtures/empty-project/package.json | 24 +++ .../fixtures/empty-project/prettier.config.js | 18 +++ .../fixtures/empty-project/redwood.toml | 16 ++ .../fixtures/empty-project/scripts/.keep | 0 .../fixtures/empty-project/scripts/seed.ts | 40 +++++ .../empty-project/scripts/tsconfig.json | 36 +++++ .../fixtures/empty-project/web/jest.config.js | 8 + .../fixtures/empty-project/web/package.json | 23 +++ .../empty-project/web/public/README.md | 36 +++++ .../empty-project/web/public/favicon.png | Bin 0 -> 1741 bytes .../empty-project/web/public/robots.txt | 2 + .../fixtures/empty-project/web/src/App.tsx | 19 +++ .../fixtures/empty-project/web/src/Routes.tsx | 20 +++ .../empty-project/web/src/components/.keep | 0 .../fixtures/empty-project/web/src/index.css | 0 .../fixtures/empty-project/web/src/index.html | 17 +++ .../empty-project/web/src/layouts/.keep | 0 .../pages/FatalErrorPage/FatalErrorPage.tsx | 60 ++++++++ .../src/pages/NotFoundPage/NotFoundPage.tsx | 44 ++++++ .../fixtures/empty-project/web/tsconfig.json | 36 +++++ .../src/__tests__/typeDefinitions.test.ts | 24 +++ .../internal/src/generate/typeDefinitions.ts | 138 +++++++++++++----- 44 files changed, 853 insertions(+), 37 deletions(-) create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/.gitignore create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/.vscode/extensions.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/.vscode/launch.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/.vscode/settings.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/README.md create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/db/schema.prisma create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/jest.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/package.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/server.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.test.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.test.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/functions/graphql.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/graphql/.keep create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/auth.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/db.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/logger.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/src/services/.keep create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/api/tsconfig.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/graphql.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/jest.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/package.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/prettier.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/redwood.toml create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/scripts/.keep create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/scripts/seed.ts create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/scripts/tsconfig.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/jest.config.js create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/package.json create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/public/README.md create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/public/favicon.png create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/public/robots.txt create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/App.tsx create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/Routes.tsx create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/components/.keep create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/index.css create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/index.html create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/layouts/.keep create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/pages/FatalErrorPage/FatalErrorPage.tsx create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/src/pages/NotFoundPage/NotFoundPage.tsx create mode 100644 packages/internal/src/__tests__/fixtures/empty-project/web/tsconfig.json diff --git a/packages/internal/src/__tests__/fixtures/empty-project/.gitignore b/packages/internal/src/__tests__/fixtures/empty-project/.gitignore new file mode 100644 index 000000000000..750eb28bae6d --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/.gitignore @@ -0,0 +1,13 @@ +.idea +.DS_Store +.env +.netlify +.redwood +dev.db* +dist +dist-babel +node_modules +yarn-error.log +web/public/mockServiceWorker.js +web/types/graphql.d.ts +api/types/graphql.d.ts diff --git a/packages/internal/src/__tests__/fixtures/empty-project/.vscode/extensions.json b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/extensions.json new file mode 100644 index 000000000000..7fc50a119fc6 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/extensions.json @@ -0,0 +1,14 @@ +{ + "recommendations": [ + "dbaeumer.vscode-eslint", + "eamodio.gitlens", + "ofhumanbondage.react-proptypes-intellisense", + "mgmcdermott.vscode-language-babel", + "wix.vscode-import-cost", + "pflannery.vscode-versionlens", + "editorconfig.editorconfig", + "prisma.prisma", + "graphql.vscode-graphql" + ], + "unwantedRecommendations": [] +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/.vscode/launch.json b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/launch.json new file mode 100644 index 000000000000..25c2825e55da --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "command": "yarn redwood dev", + "name": "launch development", + "request": "launch", + "type": "node-terminal" + } + ] +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/.vscode/settings.json b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/settings.json new file mode 100644 index 000000000000..bb0578ddbbf8 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/.vscode/settings.json @@ -0,0 +1,11 @@ +{ + "editor.tabSize": 2, + "files.trimTrailingWhitespace": true, + "editor.formatOnSave": false, + "editor.codeActionsOnSave": { + "source.fixAll.eslint": true + }, + "[prisma]": { + "editor.formatOnSave": true + } +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/README.md b/packages/internal/src/__tests__/fixtures/empty-project/README.md new file mode 100644 index 000000000000..3f3f4f3d79a2 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/README.md @@ -0,0 +1,27 @@ +# Redwood + +> **NOTICE:** RedwoodJS is very close to a stable version 1.0. In the last two years, +> the project has matured significantly and is already used in production by a number +> of startups. We intend to have a 1.0 release candidate before the end of 2021 and +> to release a truly production-ready 1.0 in early 2022. + +## Getting Started +- [Tutorial](https://redwoodjs.com/tutorial/welcome-to-redwood): getting started and complete overview guide. +- [Docs](https://redwoodjs.com/docs/introduction): using the Redwood Router, handling assets and files, list of command-line tools, and more. +- [Redwood Community](https://community.redwoodjs.com): get help, share tips and tricks, and collaborate on everything about RedwoodJS. + +### Setup + +We use Yarn as our package manager. To get the dependencies installed, just do this in the root directory: + +```terminal +yarn install +``` + +### Fire it up + +```terminal +yarn redwood dev +``` + +Your browser should open automatically to `http://localhost:8910` to see the web app. Lambda functions run on `http://localhost:8911` and are also proxied to `http://localhost:8910/.redwood/functions/*`. diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/db/schema.prisma b/packages/internal/src/__tests__/fixtures/empty-project/api/db/schema.prisma new file mode 100644 index 000000000000..3dea71a68f23 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/db/schema.prisma @@ -0,0 +1,18 @@ +datasource db { + provider = "sqlite" + url = env("DATABASE_URL") +} + +generator client { + provider = "prisma-client-js" + binaryTargets = "native" +} + +// Define your own datamodels here and run `yarn redwood prisma migrate dev` +// to create migrations for them and apply to your dev DB. +// TODO: Please remove the following example: +model UserExample { + id Int @id @default(autoincrement()) + email String @unique + name String? +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/jest.config.js b/packages/internal/src/__tests__/fixtures/empty-project/api/jest.config.js new file mode 100644 index 000000000000..932fc82dce93 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/jest.config.js @@ -0,0 +1,8 @@ +// More info at https://redwoodjs.com/docs/project-configuration-dev-test-build + +const config = { + rootDir: '../', + preset: '@redwoodjs/testing/config/jest/api', +} + +module.exports = config diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/package.json b/packages/internal/src/__tests__/fixtures/empty-project/api/package.json new file mode 100644 index 000000000000..843a955d5f68 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/package.json @@ -0,0 +1,9 @@ +{ + "name": "api", + "version": "0.0.0", + "private": true, + "dependencies": { + "@redwoodjs/api": "0.49.1", + "@redwoodjs/graphql-server": "0.49.1" + } +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/server.config.js b/packages/internal/src/__tests__/fixtures/empty-project/api/server.config.js new file mode 100644 index 000000000000..9fa6aaa05871 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/server.config.js @@ -0,0 +1,23 @@ +/** + * This file allows you to configure the Fastify Server settings + * used by the RedwoodJS dev server. + * + * It also applies when running the api server with `yarn rw serve`. + * + * For the Fastify server options that you can set, see: + * https://www.fastify.io/docs/latest/Reference/Server/#factory + * + * Examples include: logger settings, timeouts, maximum payload limits, and more. + * + * Note: This configuration does not apply in a serverless deploy. + */ + +/** @type {import('fastify').FastifyServerOptions} */ +const config = { + requestTimeout: 15_000, + logger: { + level: process.env.NODE_ENV === 'development' ? 'debug' : 'warn', + }, +} + +module.exports = config diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.test.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.test.ts new file mode 100644 index 000000000000..0f01aa367a85 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.test.ts @@ -0,0 +1,18 @@ +import { mockRedwoodDirective, getDirectiveName } from '@redwoodjs/testing/api' + +import requireAuth from './requireAuth' + +describe('requireAuth directive', () => { + it('declares the directive sdl as schema, with the correct name', () => { + expect(requireAuth.schema).toBeTruthy() + expect(getDirectiveName(requireAuth.schema)).toBe('requireAuth') + }) + + it('requireAuth has stub implementation. Should not throw when current user', () => { + // If you want to set values in context, pass it through e.g. + // mockRedwoodDirective(requireAuth, { context: { currentUser: { id: 1, name: 'Lebron McGretzky' } }}) + const mockExecution = mockRedwoodDirective(requireAuth, { context: {} }) + + expect(mockExecution).not.toThrowError() + }) +}) diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.ts new file mode 100644 index 000000000000..df6083b143e9 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/requireAuth/requireAuth.ts @@ -0,0 +1,22 @@ +import gql from 'graphql-tag' + +import { createValidatorDirective } from '@redwoodjs/graphql-server' + +import { requireAuth as applicationRequireAuth } from 'src/lib/auth' + +export const schema = gql` + """ + Use to check whether or not a user is authenticated and is associated + with an optional set of roles. + """ + directive @requireAuth(roles: [String]) on FIELD_DEFINITION +` + +const validate = ({ directiveArgs }) => { + const { roles } = directiveArgs + applicationRequireAuth({ roles }) +} + +const requireAuth = createValidatorDirective(schema, validate) + +export default requireAuth diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.test.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.test.ts new file mode 100644 index 000000000000..88d99a56eab2 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.test.ts @@ -0,0 +1,10 @@ +import { getDirectiveName } from '@redwoodjs/testing/api' + +import skipAuth from './skipAuth' + +describe('skipAuth directive', () => { + it('declares the directive sdl as schema, with the correct name', () => { + expect(skipAuth.schema).toBeTruthy() + expect(getDirectiveName(skipAuth.schema)).toBe('skipAuth') + }) +}) diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.ts new file mode 100644 index 000000000000..e85b94ae8b89 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/directives/skipAuth/skipAuth.ts @@ -0,0 +1,16 @@ +import gql from 'graphql-tag' + +import { createValidatorDirective } from '@redwoodjs/graphql-server' + +export const schema = gql` + """ + Use to skip authentication checks and allow public access. + """ + directive @skipAuth on FIELD_DEFINITION +` + +const skipAuth = createValidatorDirective(schema, () => { + return +}) + +export default skipAuth diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/functions/graphql.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/functions/graphql.ts new file mode 100644 index 000000000000..f395c3b0f852 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/functions/graphql.ts @@ -0,0 +1,19 @@ +import { createGraphQLHandler } from '@redwoodjs/graphql-server' + +import directives from 'src/directives/**/*.{js,ts}' +import sdls from 'src/graphql/**/*.sdl.{js,ts}' +import services from 'src/services/**/*.{js,ts}' + +import { db } from 'src/lib/db' +import { logger } from 'src/lib/logger' + +export const handler = createGraphQLHandler({ + loggerConfig: { logger, options: {} }, + directives, + sdls, + services, + onException: () => { + // Disconnect from your database with an unhandled exception. + db.$disconnect() + }, +}) diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/graphql/.keep b/packages/internal/src/__tests__/fixtures/empty-project/api/src/graphql/.keep new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/auth.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/auth.ts new file mode 100644 index 000000000000..276427c4c9f2 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/auth.ts @@ -0,0 +1,25 @@ +/** + * Once you are ready to add authentication to your application + * you'll build out requireAuth() with real functionality. For + * now we just return `true` so that the calls in services + * have something to check against, simulating a logged + * in user that is allowed to access that service. + * + * See https://redwoodjs.com/docs/authentication for more info. + */ +export const isAuthenticated = () => { + return true +} + +export const hasRole = ({ roles }) => { + return roles !== undefined +} + +// This is used by the redwood directive +// in ./api/src/directives/requireAuth + +// Roles are passed in by the requireAuth directive if you have auth setup +// eslint-disable-next-line @typescript-eslint/no-unused-vars +export const requireAuth = ({ roles }) => { + return isAuthenticated() +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/db.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/db.ts new file mode 100644 index 000000000000..5006d00aae49 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/db.ts @@ -0,0 +1,21 @@ +// See https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-client/constructor +// for options. + +import { PrismaClient } from '@prisma/client' + +import { emitLogLevels, handlePrismaLogging } from '@redwoodjs/api/logger' + +import { logger } from './logger' + +/* + * Instance of the Prisma Client + */ +export const db = new PrismaClient({ + log: emitLogLevels(['info', 'warn', 'error']), +}) + +handlePrismaLogging({ + db, + logger, + logLevels: ['info', 'warn', 'error'], +}) diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/logger.ts b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/logger.ts new file mode 100644 index 000000000000..150a309767c5 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/src/lib/logger.ts @@ -0,0 +1,17 @@ +import { createLogger } from '@redwoodjs/api/logger' + +/** + * Creates a logger with RedwoodLoggerOptions + * + * These extend and override default LoggerOptions, + * can define a destination like a file or other supported pino log transport stream, + * and sets whether or not to show the logger configuration settings (defaults to false) + * + * @param RedwoodLoggerOptions + * + * RedwoodLoggerOptions have + * @param {options} LoggerOptions - defines how to log, such as redaction and format + * @param {string | DestinationStream} destination - defines where to log, such as a transport stream or file + * @param {boolean} showConfig - whether to display logger configuration on initialization + */ +export const logger = createLogger({}) diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/src/services/.keep b/packages/internal/src/__tests__/fixtures/empty-project/api/src/services/.keep new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/api/tsconfig.json b/packages/internal/src/__tests__/fixtures/empty-project/api/tsconfig.json new file mode 100644 index 000000000000..8dd67d0a9267 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/api/tsconfig.json @@ -0,0 +1,34 @@ +{ + "compilerOptions": { + "noEmit": true, + "allowJs": true, + "esModuleInterop": true, + "target": "esnext", + "module": "esnext", + "moduleResolution": "node", + "baseUrl": "./", + "rootDirs": [ + "./src", + "../.redwood/types/mirror/api/src" + ], + "paths": { + "src/*": [ + "./src/*", + "../.redwood/types/mirror/api/src/*" + ], + "types/*": ["./types/*", "../types/*"], + "@redwoodjs/testing": ["../node_modules/@redwoodjs/testing/api"] + }, + "typeRoots": [ + "../node_modules/@types", + "./node_modules/@types" + ], + "types": ["jest"], + }, + "include": [ + "src", + "../.redwood/types/includes/all-*", + "../.redwood/types/includes/api-*", + "../types" + ] +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/graphql.config.js b/packages/internal/src/__tests__/fixtures/empty-project/graphql.config.js new file mode 100644 index 000000000000..2da7862f6b57 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/graphql.config.js @@ -0,0 +1,5 @@ +const { getPaths } = require('@redwoodjs/internal') + +module.exports = { + schema: getPaths().generated.schema, +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/jest.config.js b/packages/internal/src/__tests__/fixtures/empty-project/jest.config.js new file mode 100644 index 000000000000..c6b395cb762a --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/jest.config.js @@ -0,0 +1,8 @@ +// This the Redwood root jest config +// Each side, e.g. ./web/ and ./api/ has specific config that references this root +// More info at https://redwoodjs.com/docs/project-configuration-dev-test-build + +module.exports = { + rootDir: '.', + projects: ['/{*,!(node_modules)/**/}/jest.config.js'], +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/package.json b/packages/internal/src/__tests__/fixtures/empty-project/package.json new file mode 100644 index 000000000000..64546492f032 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/package.json @@ -0,0 +1,24 @@ +{ + "private": true, + "workspaces": { + "packages": [ + "api", + "web", + "packages/*" + ] + }, + "devDependencies": { + "@redwoodjs/core": "0.49.1" + }, + "eslintConfig": { + "extends": "@redwoodjs/eslint-config", + "root": true + }, + "engines": { + "node": ">=14.17 <=16.x", + "yarn": ">=1.15 <2" + }, + "prisma": { + "seed": "yarn rw exec seed" + } +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/prettier.config.js b/packages/internal/src/__tests__/fixtures/empty-project/prettier.config.js new file mode 100644 index 000000000000..45058f7aa2a8 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/prettier.config.js @@ -0,0 +1,18 @@ +// https://prettier.io/docs/en/options.html +/** @type {import('prettier').RequiredOptions} */ +module.exports = { + trailingComma: 'es5', + bracketSpacing: true, + tabWidth: 2, + semi: false, + singleQuote: true, + arrowParens: 'always', + overrides: [ + { + files: 'Routes.*', + options: { + printWidth: 999, + }, + }, + ], +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/redwood.toml b/packages/internal/src/__tests__/fixtures/empty-project/redwood.toml new file mode 100644 index 000000000000..11270a20be22 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/redwood.toml @@ -0,0 +1,16 @@ +# This file contains the configuration settings for your Redwood app. +# This file is also what makes your Redwood app a Redwood app. +# If you remove it and try to run `yarn rw dev`, you'll get an error. +# +# For the full list of options, see the "App Configuration: redwood.toml" doc: +# https://redwoodjs.com/docs/app-configuration-redwood-toml + +[web] + title = "Redwood App" + port = 8910 + apiUrl = "/.redwood/functions" # you can customise graphql and dbauth urls individually too: see https://redwoodjs.com/docs/app-configuration-redwood-toml#api-paths + includeEnvironmentVariables = [] # any ENV vars that should be available to the web side, see https://redwoodjs.com/docs/environment-variables#web +[api] + port = 8911 +[browser] + open = true diff --git a/packages/internal/src/__tests__/fixtures/empty-project/scripts/.keep b/packages/internal/src/__tests__/fixtures/empty-project/scripts/.keep new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/scripts/seed.ts b/packages/internal/src/__tests__/fixtures/empty-project/scripts/seed.ts new file mode 100644 index 000000000000..466ba5458de8 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/scripts/seed.ts @@ -0,0 +1,40 @@ +import type { Prisma } from '@prisma/client' +import { db } from 'api/src/lib/db' + +export default async () => { + try { + // + // Manually seed via `yarn rw prisma db seed` + // Seeds automatically with `yarn rw prisma migrate dev` and `yarn rw prisma migrate reset` + // + // Update "const data = []" to match your data model and seeding needs + // + const data: Prisma.UserExampleCreateArgs['data'][] = [ + // To try this example data with the UserExample model in schema.prisma, + // uncomment the lines below and run 'yarn rw prisma migrate dev' + // + // { name: 'alice', email: 'alice@example.com' }, + // { name: 'mark', email: 'mark@example.com' }, + // { name: 'jackie', email: 'jackie@example.com' }, + // { name: 'bob', email: 'bob@example.com' }, + ] + console.log( + "\nUsing the default './scripts/seed.{js,ts}' template\nEdit the file to add seed data\n" + ) + + // Note: if using PostgreSQL, using `createMany` to insert multiple records is much faster + // @see: https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#createmany + Promise.all( + // + // Change to match your data model and seeding needs + // + data.map(async (data: Prisma.UserExampleCreateArgs['data']) => { + const record = await db.userExample.create({ data }) + console.log(record) + }) + ) + } catch (error) { + console.warn('Please define your seed data.') + console.error(error) + } +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/scripts/tsconfig.json b/packages/internal/src/__tests__/fixtures/empty-project/scripts/tsconfig.json new file mode 100644 index 000000000000..6a5faed2eed9 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/scripts/tsconfig.json @@ -0,0 +1,36 @@ +{ + "compilerOptions": { + "noEmit": true, + "allowJs": true, + "esModuleInterop": true, + "target": "esnext", + "module": "esnext", + "moduleResolution": "node", + "baseUrl": "./", + "paths": { + "$api/*": [ + "../api/*", + ], + "api/*": [ + "../api/*", + ], + "$web/*": [ + "../web/*", + ], + "web/*": [ + "../web/*", + ], + "$web/src/*": [ + "../web/src/*", + "../.redwood/types/mirror/web/src/*" + ], + "web/src/*": [ + "../web/src/*", + "../.redwood/types/mirror/web/src/*" + ], + "types/*": ["../types/*", "../web/types/*", "../api/types/*"], + }, + "typeRoots": ["../node_modules/@types"], + "jsx": "preserve", + }, +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/jest.config.js b/packages/internal/src/__tests__/fixtures/empty-project/web/jest.config.js new file mode 100644 index 000000000000..0e54869ebdcb --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/jest.config.js @@ -0,0 +1,8 @@ +// More info at https://redwoodjs.com/docs/project-configuration-dev-test-build + +const config = { + rootDir: '../', + preset: '@redwoodjs/testing/config/jest/web', +} + +module.exports = config diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/package.json b/packages/internal/src/__tests__/fixtures/empty-project/web/package.json new file mode 100644 index 000000000000..089536c0c7fa --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/package.json @@ -0,0 +1,23 @@ +{ + "name": "web", + "version": "0.0.0", + "private": true, + "browserslist": { + "development": [ + "last 1 version" + ], + "production": [ + "defaults", + "not IE 11", + "not IE_Mob 11" + ] + }, + "dependencies": { + "@redwoodjs/forms": "0.49.1", + "@redwoodjs/router": "0.49.1", + "@redwoodjs/web": "0.49.1", + "prop-types": "15.8.1", + "react": "17.0.2", + "react-dom": "17.0.2" + } +} diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/public/README.md b/packages/internal/src/__tests__/fixtures/empty-project/web/public/README.md new file mode 100644 index 000000000000..6df2fa250b09 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/public/README.md @@ -0,0 +1,36 @@ +# Static Assets +Use this folder to add static files directly to your app. All included files and folders will be copied directly into the `/dist` folder (created when Webpack builds for production). They will also be available during development when you run `yarn rw dev`. +>Note: files will *not* hot reload while the development server is running. You'll need to manually stop/start to access file changes. + +### Example Use +A file like `favicon.png` will be copied to `/dist/favicon.png`. A folder containing a file such as `static-files/my-logo.jpg` will be copied to `/dist/static-files/my-logo.jpg`. These can be referenced in your code directly without any special handling, e.g. +``` + +``` +and +``` + alt="Logo" /> +``` + +Behind the scenes, we are using Webpack's ["copy-webpack-plugin"](https://github.com/webpack-contrib/copy-webpack-plugin). + +## Best Practices +Because assets in this folder are bypassing the javascript module system, **this folder should be used sparingly** for assets such as favicons, robots.txt, manifests, libraries incompatible with Webpack, etc. + +In general, it's best to import files directly into a template, page, or component. This allows Webpack to include that file in the bundle, which ensures Webpack will correctly process and move assets into the distribution folder, providing error checks and correct paths along the way. + +### Example Asset Import with Webpack +Instead of handling our logo image as a static file per the example above, we can do the following: +``` +import React from "react" +import logo from "./my-logo.jpg" + + +function Header() { + return Logo +} + +export default Header +``` + +Behind the scenes, we are using Webpack's ["file-loader"](https://webpack.js.org/loaders/file-loader/) and ["url-loader](https://webpack.js.org/loaders/url-loader/) (for files smaller than 10kb). diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/public/favicon.png b/packages/internal/src/__tests__/fixtures/empty-project/web/public/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..47414294173cb0795dcafb8813599fc382282556 GIT binary patch literal 1741 zcmV;;1~U1HP)u3dvWaK1Jt7p7xtk~lm38V(vb%~9EcN4itP(!;||l>?RBBL}g^A8<`Fn z=_ofw?w2~Qt#0f9Ac3O;;Nt1}TFWmPb1YZ9hDBXZ zTK55jh;jRpRArCUs~@6m!BMLSuZE&5;HTqrDc^;f)?K|FaV6o1RTFbt+uA;);7z?5 z9axBZCgX!V;dhWl*HZCE&V7oz;oZ;*lOh^wZ2aYlLI<1rXkc0&HH!|5!S0|*s- zM*~yi#Ef4dES_G+_-z+`S<%x__Ulk8{Z?I!;wv8DmN?3t1H$+fJ*q^w!} z8`oOx{i(WL4oLgKN0~^gQyJ3t#+tnIhR=h}6@BVu1&_1g7*O6j$-5z)KLsPi3dqCH zq+n<+)2a$Afvr|B97(#s5f6-oU6qYHP<2rWEKfC)aEc=?j9nPwEyIiT4XCI%BScNpoU1Cro6M@BSt>YU4@z^JQPbj- zbMl0tf(CkBNTVH0run?8E#6lyouay;Bf8|_ud%WyA2Dkqc}nAEGkyiO!|#6>OX~jC z_3u?iQ>Xm%XNGGb_3~zzqyj(lHYRC##{sV_zNQl$KP40jQHRR#WeJ!akxfaL;HU(y z@6A7KA;pjflPx?{&_wwQ<6?f(Uld(h*XSf+Ct`QR3EDfau;y#nNiKfJ`Ny24=O+_9 z{chAh!5R0T(`<1ayxDvCtBZ?9Rn)QBoddzqchGPN4C8rB2tQ(*#m6zlySN7XwxM)X zNo%g}Q*?B_&%_K;!PvNxj9-D>BYn6zcIb@VGE=-?gP+zjpQ4x$*@_cm*TL-MtWeV+ z%v$Vh+2e#jDJ4Yc3NPgE9Uhr~V;6)j#bgMC+5!L2yYdX5ef->+k9d_?db{`}fWW+F zU&GKd9pW?cv0e8pA%20doi=OgaTV=dLOHx7cgAQlYDkLWaAUksGbO`Z7+>qo}~5K=?ZI!b@vaF5}r7- zyP2aiwSn}KbwGhrQ0A?W4L_Jwg?C#vAElLzpK~}}&ny0d@_GVhUqVEfXX9}XI8%B; z;BYTG$dM}6WS8urD4fqn$733@mNss6jB7yHY*76e*L=X6apM|Dgg^tZhpge9{Ojy9 z{Sl&x=vUbHU+7KFQEas^U*jQ8^rj_XAzI=0y_Nmx3ChT&K?_-b!N10g5+C9TqMGZ@!a>mh#`}nJM>Cu2v@32F*rQ(x05Xb64 zV-ML!u$4W31M7A@mi~3fnSOQSZ->>TC+02Mt+0csMl0*2TCklB$VOH11pW{4 zD1)V+^h4n@OYlO&;Z!-dk{(LVtA%;(o#!>jYgG>s%eL0iXx~jJsrfL3rwo;cc52kP zRnvwZId>`-FV`PUvUKk4gU&nzX&+gTEm1bNsCdaXc zvaOny-3X43Fs?Jn;>*U?jaR1`9KIVP?p(?ulraQZc;T0UKos^SChGJoJYVu1%?E0v zDGNOfZKPrPKtyFYEU~bZZ~rB{4X2ko>_VJlJw3rw-!>TIT6R!3;POq5yNZdnfu$Ao j!CVlN4fQVi0D=DiS&&%ubg+{I00000NkvXXu0mjf8bDG2 literal 0 HcmV?d00001 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/public/robots.txt b/packages/internal/src/__tests__/fixtures/empty-project/web/public/robots.txt new file mode 100644 index 000000000000..eb0536286f30 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/public/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/App.tsx b/packages/internal/src/__tests__/fixtures/empty-project/web/src/App.tsx new file mode 100644 index 000000000000..97fb5e02520d --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/src/App.tsx @@ -0,0 +1,19 @@ +import { FatalErrorBoundary, RedwoodProvider } from '@redwoodjs/web' +import { RedwoodApolloProvider } from '@redwoodjs/web/apollo' + +import FatalErrorPage from 'src/pages/FatalErrorPage' +import Routes from 'src/Routes' + +import './index.css' + +const App = () => ( + + + + + + + +) + +export default App diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/Routes.tsx b/packages/internal/src/__tests__/fixtures/empty-project/web/src/Routes.tsx new file mode 100644 index 000000000000..2c8f02ab4fe2 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/src/Routes.tsx @@ -0,0 +1,20 @@ +// In this file, all Page components from 'src/pages` are auto-imported. Nested +// directories are supported, and should be uppercase. Each subdirectory will be +// prepended onto the component name. +// +// Examples: +// +// 'src/pages/HomePage/HomePage.js' -> HomePage +// 'src/pages/Admin/BooksPage/BooksPage.js' -> AdminBooksPage + +import { Router, Route } from '@redwoodjs/router' + +const Routes = () => { + return ( + + + + ) +} + +export default Routes diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/components/.keep b/packages/internal/src/__tests__/fixtures/empty-project/web/src/components/.keep new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/index.css b/packages/internal/src/__tests__/fixtures/empty-project/web/src/index.css new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/index.html b/packages/internal/src/__tests__/fixtures/empty-project/web/src/index.html new file mode 100644 index 000000000000..4baaaeaeb6e1 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/src/index.html @@ -0,0 +1,17 @@ + + + + + + + + + + +
+ + <%= prerenderPlaceholder %> +
+ + + diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/layouts/.keep b/packages/internal/src/__tests__/fixtures/empty-project/web/src/layouts/.keep new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/internal/src/__tests__/fixtures/empty-project/web/src/pages/FatalErrorPage/FatalErrorPage.tsx b/packages/internal/src/__tests__/fixtures/empty-project/web/src/pages/FatalErrorPage/FatalErrorPage.tsx new file mode 100644 index 000000000000..0d1dcc8d8d44 --- /dev/null +++ b/packages/internal/src/__tests__/fixtures/empty-project/web/src/pages/FatalErrorPage/FatalErrorPage.tsx @@ -0,0 +1,60 @@ +// This page will be rendered when an error makes it all the way to the top of the +// application without being handled by a Javascript catch statement or React error +// boundary. +// +// You can modify this page as you wish, but it is important to keep things simple to +// avoid the possibility that it will cause its own error. If it does, Redwood will +// still render a generic error page, but your users will prefer something a bit more +// thoughtful. =) + +// Ensures that production builds do not include the error page +let RedwoodDevFatalErrorPage = undefined +if (process.env.NODE_ENV === 'development') { + RedwoodDevFatalErrorPage = require('@redwoodjs/web').DevFatalErrorPage +} + +export default RedwoodDevFatalErrorPage || + (() => ( +
+