refactor: keto

.yarnrc.yml

@@ -44,7 +44,7 @@ packageExtensions:
     dependencies:
       '@babel/runtime': '*'
   '@ory/keto-grpc-client@*':
-     peerDependencies:
-       grpc: '*'
+    peerDependencies:
+      grpc: '*'
 
 yarnPath: .yarn/releases/yarn-remote.cjs

packages/dataloader/src/interceptors/data-loader.interceptor.ts

@@ -9,8 +9,8 @@ import { GraphQLExecutionContext }      from '@nestjs/graphql'
 
 import { Observable }                   from 'rxjs'
 
-import { GET_LOADER_CONTEXT_KEY } from '../constants'
-import { NestDataLoader }         from '../interfaces'
+import { GET_LOADER_CONTEXT_KEY }       from '../constants'
+import { NestDataLoader }               from '../interfaces'
 
 @Injectable()
 export class DataLoaderInterceptor implements NestInterceptor {

packages/dataloader/src/interfaces/nest-dataloader.interfaces.ts

@@ -1,5 +1,5 @@
 import DataLoader from 'dataloader'
 
 export interface NestDataLoader {
-  generateDataLoader(): DataLoader<any,any>
+  generateDataLoader(): DataLoader<any, any>
 }

packages/grpc-keto/src/decorators/index.ts

@@ -1,5 +1,5 @@
-export *                            from './guarded-by-keto.decorator'
-export { GuardedByKetoFunction }    from './guarded-by-keto.interfaces'
+export * from './guarded-by-keto.decorator'
+export { GuardedByKetoFunction } from './guarded-by-keto.interfaces'
 export { GetGuardingRelationTuple } from './guarded-by-keto.interfaces'
-export { GUARDED_BY_METADATA_KEY }  from './guarded-by-keto.constants'
+export { GUARDED_BY_METADATA_KEY } from './guarded-by-keto.constants'
 export { getGuardingRelationTuple } from './get-guarding-relation.helper'

packages/keto/integration/src/index.ts

@@ -0,0 +1 @@
+export * from './keto-integration.module'

packages/keto/integration/src/keto-integration.controller.ts

@@ -0,0 +1,21 @@
+import { UseGuards }     from '@nestjs/common'
+import { Controller }    from '@nestjs/common'
+import { Get }           from '@nestjs/common'
+
+import { GuardedByKeto } from '../../src'
+import { KetoGuard }     from '../../src'
+
+@Controller()
+export class KetoIntegrationController {
+  @Get('/allowed')
+  async allow() {
+    return true
+  }
+
+  @Get('/protected-by-keto')
+  @GuardedByKeto((user) => `Group:admin#members@${user}`)
+  @UseGuards(KetoGuard)
+  async protect() {
+    return true
+  }
+}

packages/keto/integration/src/keto-integration.module.ts

@@ -0,0 +1,14 @@
+import { Module }                    from '@nestjs/common'
+
+import { KetoModule }                from '../../src'
+import { KetoIntegrationController } from './keto-integration.controller'
+
+@Module({
+  imports: [
+    KetoModule.register({
+      basePath: '127.0.0.1:4466',
+    }),
+  ],
+  controllers: [KetoIntegrationController],
+})
+export class KetoIntegrationModule {}

packages/keto/integration/test/client-read.test.ts

@@ -0,0 +1,95 @@
+/**
+ * @jest-environment node
+ */
+
+import { INestApplication }      from '@nestjs/common'
+import { TestingModule }         from '@nestjs/testing'
+import { Test }                  from '@nestjs/testing'
+
+import request                   from 'supertest'
+import { log }                   from 'testcontainers'
+import { Network }               from 'testcontainers'
+import { Wait }                  from 'testcontainers'
+import { StartedTestContainer }  from 'testcontainers'
+import { GenericContainer }      from 'testcontainers'
+
+import { KETO_MODULE_CONFIGURATION }   from '../../src'
+import { KetoIntegrationModule } from '../src'
+import { KETO_WRITE_PORT }       from './test.constants'
+import { KETO_READ_PORT }        from './test.constants'
+import { APP_PORT }              from './test.constants'
+import { KETO_FILES }            from './test.constants'
+import { KETO_ENVIRONMENT }      from './test.constants'
+import { DB_PORT }               from './test.constants'
+import { DB_ENVIRONMENT }        from './test.constants'
+import { KETO_START_COMMAND }    from './test.constants'
+import { KETO_INIT_COMMAND }     from './test.constants'
+import { KETO_MIGRATE_COMMAND }  from './test.constants'
+
+jest.setTimeout(15000)
+
+describe('Keto read client', () => {
+  let app: INestApplication
+  let url: string
+  let module: TestingModule
+
+  let dbContainer: StartedTestContainer
+  let ketoContainer: StartedTestContainer
+
+  beforeAll(async () => {
+    const network = await new Network().start()
+
+    dbContainer = await new GenericContainer('bitnami/postgresql')
+      .withWaitStrategy(Wait.forLogMessage('database system is ready to accept connections'))
+      .withEnvironment(DB_ENVIRONMENT)
+      .withNetwork(network)
+      .withNetworkAliases('db')
+      .withExposedPorts(DB_PORT)
+      .start()
+
+    await new GenericContainer('oryd/keto')
+      .withEnvironment(KETO_ENVIRONMENT)
+      .withCopyFilesToContainer(KETO_FILES)
+      .withNetwork(network)
+      .withCommand(KETO_MIGRATE_COMMAND)
+      .start()
+
+    ketoContainer = await new GenericContainer('oryd/keto')
+      .withEnvironment(KETO_ENVIRONMENT)
+      .withCopyFilesToContainer(KETO_FILES)
+      .withNetwork(network)
+      .withExposedPorts(KETO_READ_PORT, KETO_WRITE_PORT)
+      .withCommand(KETO_START_COMMAND)
+      .start()
+
+    await ketoContainer.exec(KETO_INIT_COMMAND)
+
+    module = await Test.createTestingModule({
+      imports: [KetoIntegrationModule],
+    })
+      .overrideProvider(KETO_MODULE_CONFIGURATION)
+      .useValue({
+        basePath: `http://localhost:${ketoContainer.getMappedPort(KETO_READ_PORT)}`,
+      })
+      .compile()
+
+    app = module.createNestApplication()
+
+    await app.init()
+    await app.listen(APP_PORT)
+
+    url = await app.getHttpServer()
+  })
+
+  afterAll(async () => {
+    await app.close()
+
+    await dbContainer.stop()
+    await ketoContainer.stop()
+  })
+
+  it('allowed', async () => request(url).get('/allowed').expect(200))
+
+  it('allows if relation tuple is ok', async () =>
+    request(url).get('/protected-by-keto').set('x-user', 'testUser').expect(200))
+})

packages/keto/integration/test/keto.yml

@@ -0,0 +1,34 @@
+version: v0.11.1-alpha.0
+
+dsn: memory
+
+serve:
+  read:
+    host: 0.0.0.0
+    cors:
+      enabled: false
+      allow_credentials: true
+      debug: true
+  write:
+    host: 0.0.0.0
+    cors:
+      enabled: false
+      allow_credentials: true
+      debug: true
+
+  opl:
+    host: localhost
+    cors:
+      enabled: false
+      allow_credentials: true
+      debug: true
+
+namespaces:
+  location: file:///home/ory/namespaces.keto.ts
+
+log:
+  level: debug
+  format: text
+  leak_sensitive_values: true
+
+$schema: file:///config/keto/schema.json

packages/keto/integration/test/namespaces.keto.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+
+// @ts-ignore
+class User implements Namespace {}
+
+// @ts-ignore
+class Group implements Namespace {
+  related: {
+    members: User[]
+  }
+}

packages/keto/integration/test/relationships.json

@@ -0,0 +1,6 @@
+{
+  "namespace": "Group",
+  "object": "admin",
+  "relation": "members",
+  "subject_id": "testUser"
+}

packages/keto/integration/test/test.constants.ts

@@ -0,0 +1,54 @@
+import { FileToCopy } from 'testcontainers/build/types'
+
+export const KETO_MIGRATE_COMMAND = ['migrate', 'up', '--yes']
+
+export const KETO_START_COMMAND = ['serve']
+
+export const KETO_INIT_COMMAND = [
+  'keto',
+  'relation-tuple',
+  'create',
+  '/home/ory/relationships',
+  '--insecure-disable-transport-security',
+  '--insecure-skip-hostname-verification',
+]
+
+export const DB_ENVIRONMENT = {
+  POSTGRESQL_PASSWORD: 'password',
+  POSTGRESQL_DATABASE: 'db',
+  POSTGRESQL_USER: 'postgres',
+}
+
+export const DB_PORT = 5432
+
+export const KETO_ENVIRONMENT = {
+  KETO_WRITE_REMOTE: 'localhost:4467',
+  KETO_READ_REMOTE: 'localhost:4466',
+  LOG_LEVEL: 'debug',
+  DSN: `postgres://${DB_ENVIRONMENT.POSTGRESQL_USER}:${DB_ENVIRONMENT.POSTGRESQL_PASSWORD}@${
+    DB_ENVIRONMENT.POSTGRESQL_DATABASE
+  }:${DB_PORT.toString()}/db?sslmode=disable&max_conns=20&max_idle_conns=4`,
+}
+
+export const KETO_READ_PORT = 4466
+
+export const KETO_WRITE_PORT = 4467
+
+const PROJECT_PATH =
+  '/Users/nikoroach/Documents/Typescript/atlantis/nestjs/packages/keto/integration/test'
+
+export const KETO_FILES: FileToCopy[] = [
+  {
+    source: `${PROJECT_PATH}/keto.yml`,
+    target: '/home/ory/keto.yml',
+  },
+  {
+    source: `${PROJECT_PATH}/namespaces.keto.ts`,
+    target: '/home/ory/namespaces.keto.ts',
+  },
+  {
+    source: `${PROJECT_PATH}/relationships.json`,
+    target: '/home/ory/relationships/relationships.json',
+  },
+]
+export const APP_PORT = 3000

packages/keto/package.json

@@ -12,25 +12,29 @@
     "postpack": "rm -rf dist"
   },
   "dependencies": {
-    "@oryd/keto-client": "^0.5.6-alpha.1"
+    "@ory/keto-client": "0.11.0-alpha.0"
   },
   "devDependencies": {
     "@nestjs/common": "patch:@nestjs/common@npm%3A10.2.5#~/.yarn/patches/@nestjs-common-npm-10.2.5-816dceeade.patch",
     "@nestjs/core": "10.2.5",
-    "@nestjs/graphql": "^7.0.0",
-    "@types/node": "17.0.18",
-    "apollo-server-core": "^3.3.0",
-    "graphql": "^15.5.3",
-    "reflect-metadata": "0.1.13",
+    "@nestjs/graphql": "12.0.10",
+    "@nestjs/testing": "10.2.5",
+    "@types/node": "18.19.6",
+    "@types/supertest": "6",
+    "apollo-server-core": "3.3.0",
+    "graphql": "16.8.1",
+    "reflect-metadata": "0.2.1",
     "rimraf": "3.0.2",
-    "rxjs": "^7.5.4",
-    "typescript": "^3.8.3"
+    "rxjs": "7.8.1",
+    "supertest": "6.3.3",
+    "testcontainers": "10.4.0",
+    "typescript": "4.6.4"
   },
   "peerDependencies": {
-    "@nestjs/common": "^8.0.4",
-    "@nestjs/core": "^8.0.4",
-    "reflect-metadata": "^0.1.12",
-    "rxjs": "^7.2.0"
+    "@nestjs/common": "*",
+    "@nestjs/core": "*",
+    "reflect-metadata": "*",
+    "rxjs": "*"
   },
   "publishConfig": {
     "main": "dist/index.js",

packages/keto/src/decorators/get-guarding-relation.helper.ts

@@ -0,0 +1,9 @@
+import { GUARDED_BY_METADATA_KEY }  from './guarded-by-keto.constants'
+import { ReplaceGenerator }         from './guarded-by-keto.interfaces'
+import { GetGuardingRelationTuple } from './guarded-by-keto.interfaces'
+
+export const getGuardingRelationTuple: GetGuardingRelationTuple = (reflector, handler) =>
+  reflector.get<string | ReplaceGenerator, typeof GUARDED_BY_METADATA_KEY>(
+    GUARDED_BY_METADATA_KEY,
+    handler
+  ) ?? null

packages/keto/src/decorators/guarded-by-keto.constants.ts

@@ -0,0 +1 @@
+export const GUARDED_BY_METADATA_KEY = Symbol('GuardedByKeto')

packages/keto/src/decorators/guarded-by-keto.decorator.ts

@@ -0,0 +1,7 @@
+import { SetMetadata }             from '@nestjs/common'
+
+import { GUARDED_BY_METADATA_KEY } from './guarded-by-keto.constants'
+import { GuardedByKetoFunction }   from './guarded-by-keto.interfaces'
+
+export const GuardedByKeto: GuardedByKetoFunction = (relationTuple) =>
+  SetMetadata(GUARDED_BY_METADATA_KEY, relationTuple)

packages/keto/src/decorators/guarded-by-keto.interfaces.ts

@@ -0,0 +1,13 @@
+import { CustomDecorator } from '@nestjs/common'
+import { Reflector }       from '@nestjs/core'
+
+export type GetGuardingRelationTuple = (
+  reflector: Reflector,
+  handler: Parameters<Reflector['get']>[1]
+) => string | ReplaceGenerator
+
+export type ReplaceGenerator = (value: string) => string
+
+export type GuardedByKetoFunction = (
+  relationTuple: string | ReplaceGenerator
+) => CustomDecorator<symbol>

packages/keto/src/decorators/index.ts

@@ -1 +1,5 @@
-export * from './access-policy.decorator'
+export * from './guarded-by-keto.decorator'
+export { GuardedByKetoFunction } from './guarded-by-keto.interfaces'
+export { GetGuardingRelationTuple } from './guarded-by-keto.interfaces'
+export { GUARDED_BY_METADATA_KEY } from './guarded-by-keto.constants'
+export { getGuardingRelationTuple } from './get-guarding-relation.helper'

packages/keto/src/exceptions/exception-message.constants.ts

@@ -0,0 +1,4 @@
+export enum KetoExceptionMessage {
+  GENERAL_ERROR = 'General Keto error',
+  RELATION_TUPLE_INVALID = 'Provided relation tuple is invalid',
+}

packages/keto/src/exceptions/general.exception.ts

@@ -0,0 +1,9 @@
+import { AssertionError }       from 'assert'
+
+import { KetoExceptionMessage } from './exception-message.constants'
+
+export class KetoGeneralException extends AssertionError {
+  constructor(message: string) {
+    super({ message: `${KetoExceptionMessage.GENERAL_ERROR}: ${message}` })
+  }
+}

packages/keto/src/exceptions/index.ts

@@ -0,0 +1,2 @@
+export * from './general.exception'
+export * from './relation-tuple-invalid.exception'