@contember/engine-server 1.1.0-alpha.5 → 1.1.0-alpha.8

package/package.json

@@ -1,31 +1,31 @@
 {
   "name": "@contember/engine-server",
-  "version": "1.1.0-alpha.5",
+  "version": "1.1.0-alpha.8",
   "license": "Apache-2.0",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
   "scripts": {
-    "test": "uvu dist/tests/cases/ \\.js$"
+    "test-e2e": "vitest --no-threads tests/e2e"
   },
   "dependencies": {
-    "@contember/authorization": "^1.1.0-alpha.5",
-    "@contember/config-loader": "^1.1.0-alpha.5",
-    "@contember/database": "^1.1.0-alpha.5",
-    "@contember/database-migrations": "^1.1.0-alpha.5",
-    "@contember/dic": "^1.1.0-alpha.5",
-    "@contember/engine-common": "^1.1.0-alpha.5",
-    "@contember/engine-content-api": "^1.1.0-alpha.5",
-    "@contember/engine-http": "^1.1.0-alpha.5",
-    "@contember/engine-plugins": "^1.1.0-alpha.5",
-    "@contember/engine-s3-plugin": "^1.1.0-alpha.5",
-    "@contember/engine-system-api": "^1.1.0-alpha.5",
-    "@contember/engine-tenant-api": "^1.1.0-alpha.5",
-    "@contember/engine-vimeo-plugin": "^1.1.0-alpha.5",
-    "@contember/queryable": "^1.1.0-alpha.5",
-    "@contember/schema": "^1.1.0-alpha.5",
-    "@contember/schema-definition": "^1.1.0-alpha.5",
-    "@contember/schema-migrations": "^1.1.0-alpha.5",
-    "@contember/schema-utils": "^1.1.0-alpha.5",
+    "@contember/authorization": "^1.1.0-alpha.8",
+    "@contember/config-loader": "^1.1.0-alpha.8",
+    "@contember/database": "^1.1.0-alpha.8",
+    "@contember/database-migrations": "^1.1.0-alpha.8",
+    "@contember/dic": "^1.1.0-alpha.8",
+    "@contember/typesafe": "^1.1.0-alpha.8",
+    "@contember/engine-content-api": "^1.1.0-alpha.8",
+    "@contember/engine-http": "^1.1.0-alpha.8",
+    "@contember/engine-plugins": "^1.1.0-alpha.8",
+    "@contember/engine-s3-plugin": "^1.1.0-alpha.8",
+    "@contember/engine-system-api": "^1.1.0-alpha.8",
+    "@contember/engine-tenant-api": "^1.1.0-alpha.8",
+    "@contember/engine-vimeo-plugin": "^1.1.0-alpha.8",
+    "@contember/queryable": "^1.1.0-alpha.8",
+    "@contember/schema": "^1.1.0-alpha.8",
+    "@contember/schema-definition": "^1.1.0-alpha.8",
+    "@contember/schema-migrations": "^1.1.0-alpha.8",
+    "@contember/schema-utils": "^1.1.0-alpha.8",
     "@koa/cors": "^3.1.0",
     "@sentry/node": "^6.8.0",
     "graphql": "^15.4.0",
@@ -37,11 +37,10 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@contember/engine-api-tester": "^1.1.0-alpha.5",
+    "@contember/engine-api-tester": "^1.1.0-alpha.8",
     "@types/koa-compress": "^4.0.1",
     "@types/node": "^17.0.5",
     "@types/supertest": "^2.0.8",
-    "supertest": "^6.0.1",
-    "uvu": "^0.5.3"
+    "supertest": "^6.0.1"
   }
 }

package/src/config/configSchema.ts

@@ -1,4 +1,4 @@
-import { Typesafe } from '@contember/engine-common'
+import * as Typesafe from '@contember/typesafe'
 import { MailerOptions } from '@contember/engine-tenant-api'
 import { upperCaseFirst } from '../utils'
 
@@ -25,9 +25,9 @@ export const tenantConfigSchema = Typesafe.intersection(
 			port: Typesafe.number,
 			user: Typesafe.string,
 			password: Typesafe.string,
-		}), (value, input): MailerOptions => {
+		}), (value, input): MailerOptions & Typesafe.JsonObject => {
 			return {
-				...(input as MailerOptions),
+				...(input as any),
 				...value,
 				...(value.user ? { auth: { user: value.user, pass: value.password } } : {}),
 			}
@@ -64,7 +64,7 @@ export const serverConfigSchema = Typesafe.intersection(
 	}),
 	Typesafe.partial({
 		workerCount: Typesafe.union(Typesafe.number, Typesafe.string),
-		projectGroup: (val, path) => Typesafe.valueAt(val, ['domainMapping']) === undefined
+		projectGroup: (val: unknown, path: PropertyKey[] = []) => Typesafe.valueAt(val, ['domainMapping']) === undefined
 			? undefined
 			: Typesafe.intersection(
 				Typesafe.object({
@@ -78,14 +78,15 @@ export const serverConfigSchema = Typesafe.intersection(
 	}),
 )
 
-export const stageConfig = Typesafe.map(
+export const stageConfig = Typesafe.record(
+	Typesafe.string,
 	Typesafe.intersection(
 		Typesafe.object({
 			name: Typesafe.union(
 				Typesafe.string,
-				(_, path = []) => upperCaseFirst(String(path[path.length - 2])),
+				(_: unknown, path: PropertyKey[] = []) => upperCaseFirst(String(path[path.length - 2])),
 			),
-			slug: (_, path = []) => String(path[path.length - 2]),
+			slug: (_: unknown, path: PropertyKey[] = []) => String(path[path.length - 2]),
 		}),
 		Typesafe.partial({
 			schema: Typesafe.string,
@@ -96,7 +97,7 @@ export const stageConfig = Typesafe.map(
 export const projectConfigSchema = Typesafe.object({
 	name: Typesafe.union(
 		Typesafe.string,
-		(_, path = []) => upperCaseFirst(String(path[path.length - 2])).replace(/-/g, ' '),
+		(_: unknown, path: PropertyKey[] = []) => upperCaseFirst(String(path[path.length - 2])).replace(/-/g, ' '),
 	),
 	slug: (_, path = []) => String(path[path.length - 2]),
 	stages: (input, path = []) => Object.values(stageConfig(input, path)),

package/src/config/projectConfigResolver.ts

@@ -1,7 +1,7 @@
 import { ProjectConfig, ProjectSecrets } from '@contember/engine-http'
 import { ConfigProcessor } from '@contember/engine-plugins'
 import { Merger, ParametersResolver, resolveParameters, UndefinedParameterError } from '@contember/config-loader'
-import { Typesafe } from '@contember/engine-common'
+import * as Typesafe from '@contember/typesafe'
 import { projectConfigSchema } from './configSchema'
 import { TenantConfig } from './config'
 
@@ -27,9 +27,12 @@ export const createProjectConfigResolver = (env: Env, config: any, configProcess
 		const resolvedConfig = resolveParameters(mergedConfig, createProjectParametersResolver(slug, env, secrets))
 
 		const projectConfigSchemaWithPlugins = configProcessors.reduce(
-			(schema, current) => (
-				current.getProjectConfigSchema ? Typesafe.intersection(schema, current.getProjectConfigSchema(slug)) : schema
-			),
+			(schema, current) => {
+				if (!current.getProjectConfigSchema) {
+					return schema
+				}
+				return Typesafe.intersection(schema, current.getProjectConfigSchema(slug))
+			},
 			projectConfigSchema,
 		)
 		const projectConfig = projectConfigSchemaWithPlugins(resolvedConfig, ['project', slug])

package/src/tsconfig.json

@@ -54,6 +54,9 @@
 		},
 		{
 			"path": "../../engine-vimeo-plugin/src"
+		},
+		{
+			"path": "../../typesafe/src"
 		}
 	]
 }

package/tests/e2e/http.test.ts

@@ -0,0 +1,303 @@
+import supertest from 'supertest'
+import * as nodeAssert from 'assert'
+import { assert, beforeAll, test } from 'vitest'
+import { MigrationFilesManager, MigrationsResolver } from '@contember/schema-migrations'
+import { getExampleProjectDirectory } from '@contember/engine-api-tester'
+
+
+const rootToken = String(process.env.CONTEMBER_ROOT_TOKEN)
+const loginToken = String(process.env.CONTEMBER_LOGIN_TOKEN)
+const apiUrl = String(process.env.CONTEMBER_API_URL)
+let projectSlug = ''
+
+// Used to allow prettier formatting of GraphQL queries
+const gql = (strings: TemplateStringsArray) => {
+	nodeAssert.strictEqual(strings.length, 1)
+	return strings[0]
+}
+
+
+const executeGraphql = (
+	query: string,
+	options: { authorizationToken?: string; path?: string; variables?: Record<string, any> } = {},
+) => {
+	return supertest(apiUrl)
+		.post(options.path || `/content/${projectSlug}/live`)
+		.set('Authorization', 'Bearer ' + (options.authorizationToken || rootToken))
+		.send({
+			query,
+			variables: options.variables || {},
+		})
+}
+
+const signIn = async (email: string, password: string): Promise<string> => {
+	const response2 = await executeGraphql(
+		gql`
+			mutation ($email: String!, $password: String!) {
+				signIn(email: $email, password: $password) {
+					ok
+					result {
+						token
+					}
+				}
+			}
+		`,
+		{
+			variables: { email, password },
+			authorizationToken: loginToken,
+			path: '/tenant',
+		},
+	)
+
+	return response2.body.data.signIn.result.token
+}
+
+beforeAll(async () => {
+	projectSlug = 'test' + Date.now()
+	const result = await executeGraphql(`
+		mutation($projectSlug: String!, $config: Json!) {
+			createProject(projectSlug: $projectSlug, config: $config) {
+				ok
+				error { code }
+			}
+		}
+	`,
+	{
+		path: '/tenant',
+		variables: {
+			projectSlug: projectSlug,
+			config: {},
+		},
+	})
+		.expect(response => {
+			assert.isOk(response.body)
+			assert.isOk(response.body.data)
+			assert.isOk(response.body.data.createProject)
+			if (!response.body.data.createProject.ok) {
+				assert.equal(response.body.data.createProject.error.code, 'ALREADY_EXISTS')
+			}
+		})
+		.expect(200)
+	if (!result.body.data.createProject.ok) {
+		return
+	}
+	const migrationFilesManager = new MigrationsResolver(MigrationFilesManager.createForProject(getExampleProjectDirectory(), 'sample'))
+	const migrations = await migrationFilesManager.getMigrations()
+	assert.isAtLeast(migrations.length, 2)
+	await executeGraphql(`
+		mutation($migrations: [Migration!]!) {
+			migrate(migrations: $migrations) {
+				ok
+				error { code }
+			}
+		}
+	`,
+	{
+		path: '/system/' + projectSlug,
+		variables: {
+			migrations,
+		},
+	})
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, {
+				migrate: {
+					error: null,
+					ok: true,
+				},
+			})
+		})
+})
+
+test('show homepage', async () => {
+	await supertest(apiUrl)
+		.get('/')
+		.expect(200)
+		.expect('App is running')
+})
+
+test('Content API: create & read tag', async () => {
+	await executeGraphql(
+		gql`
+			mutation {
+				createTag(data: { label: "graphql" }) {
+					ok
+				}
+			}
+		`,
+	)
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, {
+				createTag: {
+					ok: true,
+				},
+			})
+		})
+		.expect(200)
+
+	await executeGraphql(
+		gql`
+			query {
+				listTag(filter: { label: { eq: "graphql" } }) {
+					label
+				}
+			}
+		`,
+	)
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, {
+				listTag: [
+					{
+						label: 'graphql',
+					},
+				],
+			})
+		})
+		.expect(200)
+})
+
+test('Content API: X-Contember-Ref header', async () => {
+	await executeGraphql(
+		gql`
+			mutation {
+				createTag(data: { label: "typescript" }) {
+					ok
+				}
+			}
+		`,
+	).expect(200)
+
+	const response = await executeGraphql(
+		gql`
+			query {
+				listTag(filter: { label: { eq: "typescript" } }) {
+					label
+				}
+			}
+		`,
+	)
+		.set('X-Contember-Ref', 'None')
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, {
+				listTag: [
+					{
+						label: 'typescript',
+					},
+				],
+			})
+		})
+		.expect(200)
+	const eventKey = response.get('X-Contember-Ref')
+	await executeGraphql(
+		gql`
+			query {
+				listTag {
+					label
+				}
+			}
+		`,
+	)
+		.set('X-Contember-Ref', eventKey)
+		.expect(304)
+
+	// ignored for mutation
+	await executeGraphql(
+		gql`
+			mutation {
+				createTag(data: { label: "typescript" }) {
+					ok
+				}
+			}
+		`,
+	)
+		.set('X-Contember-Ref', eventKey)
+		.expect(200)
+})
+
+test('Content API: invalid schema error', async () => {
+	await executeGraphql(
+		gql`
+			mutation {
+				createFoo(data: { label: "graphql" }) {
+					ok
+				}
+			}
+		`,
+	)
+		.expect(400)
+		.expect(response => {
+			assert.deepStrictEqual(
+				response.body.errors[0].message,
+				'Cannot query field "createFoo" on type "Mutation". Did you mean "createPost" or "createTag"?',
+			)
+		})
+})
+
+test('Tenant API: sign up, add to a project and check project access', async () => {
+	const email = `john+${Date.now()}@doe.com`
+	const signUpResponse = await executeGraphql(
+		gql`
+			mutation($email: String!) {
+				signUp(email: $email, password: "123456") {
+					ok
+					result {
+						person {
+							identity {
+								id
+							}
+						}
+					}
+				}
+			}
+		`,
+		{
+			path: '/tenant',
+			variables: { email },
+		},
+	).expect(200)
+
+	const identityId = signUpResponse.body.data.signUp.result.person.identity.id
+
+	const authKey = await signIn(email, '123456')
+	await executeGraphql(
+		gql`
+			query {
+				listTag {
+					id
+				}
+			}
+		`,
+		{ authorizationToken: authKey },
+	)
+		.expect(404)
+		.expect({ errors: [{ message: `Project ${projectSlug} NOT found`, code: 404 }] })
+
+	await executeGraphql(
+		gql`
+			mutation ($identity: String!, $projectSlug: String!) {
+				addProjectMember(identityId: $identity, projectSlug: $projectSlug, memberships: [{ role: "admin", variables: [] }]) {
+					ok
+				}
+			}
+		`,
+		{ path: '/tenant', variables: { identity: identityId, projectSlug } },
+	)
+		.expect(200)
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, { addProjectMember: { ok: true } })
+		})
+
+	await executeGraphql(
+		gql`
+			query {
+				listAuthor {
+					id
+				}
+			}
+		`,
+		{ authorizationToken: authKey },
+	)
+		.expect(response => {
+			assert.deepStrictEqual(response.body.data, { listAuthor: [] })
+		})
+		.expect(200)
+})

package/tests/start-server.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+node ./packages/engine-server/dist/src/start.js &
+
+max_retry=20
+counter=0
+until curl --silent --fail localhost:${CONTEMBER_PORT:-4000}/;
+do
+   sleep 1
+   [[ counter -eq $max_retry ]] && echo "Failed!" && exit 1
+   echo "Trying again. Try #$counter"
+   ((counter++))
+done
+
+echo "Ok!"
+exit 0

package/vite.config.js

@@ -0,0 +1,3 @@
+import { createViteConfig } from '../../scripts/vite/createViteConfig'
+
+export default createViteConfig()

package/dist/tests/cases/http.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=http.d.ts.map

package/dist/tests/cases/http.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../tests/cases/http.ts"],"names":[],"mappings":""}