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.

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

Fix Project Creation #395

Merged
merged 3 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions services/apps/projects/src/container/container.handler.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import {Project} from "../project/project.schema";
import {OnEvent} from "@nestjs/event-emitter";
import {Injectable} from "@nestjs/common";
import {ContainerService} from "./container.service";


@Injectable()
export class ContainerHandler {
constructor(
private containerService: ContainerService,
) {
}

@OnEvent('projects.*.deleted')
onProjectDeleted(project: Project) {
this.containerService.deleteStorage(project._id.toString());
}
}
3 changes: 2 additions & 1 deletion services/apps/projects/src/container/container.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {ProjectModule} from '../project/project.module';
import {ContainerController} from './container.controller';
import {ContainerService} from './container.service';
import {HttpModule} from "@nestjs/axios";
import {ContainerHandler} from "./container.handler";

@Module({
imports: [
Expand All @@ -12,7 +13,7 @@ import {HttpModule} from "@nestjs/axios";
HttpModule
],
controllers: [ContainerController],
providers: [ContainerService],
providers: [ContainerService, ContainerHandler],
})
export class ContainerModule {
}
33 changes: 27 additions & 6 deletions services/apps/projects/src/container/container.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@
import {Extract} from 'unzipper';
import {environment} from '../environment';
import {Project} from '../project/project.schema';
import {ProjectService} from '../project/project.service';

Check warning on line 17 in services/apps/projects/src/container/container.service.ts

View workflow job for this annotation

GitHub Actions / Services

'ProjectService' is defined but never used

Check warning on line 17 in services/apps/projects/src/container/container.service.ts

View workflow job for this annotation

GitHub Actions / Services

'ProjectService' is defined but never used
import {allowedFilenameCharacters, ContainerDto, CreateContainerDto} from './container.dto';

const projectStorageTypes = ['projects', 'config'] as const;
type ProjectStorageType = typeof projectStorageTypes[number];
const userStorageTypes = ['users'] as const;
type UserStorageType = typeof userStorageTypes[number];
const bindPrefix = path.resolve(environment.docker.bindPrefix);

@Injectable()
export class ContainerService {
docker = new Dockerode({
Expand All @@ -28,7 +34,6 @@

constructor(
private readonly httpService: HttpService,
private readonly projectService: ProjectService,
) {
}

Expand Down Expand Up @@ -81,14 +86,14 @@

let projectPath: string | undefined;
if (dto.projectId) {
projectPath = this.projectService.getStoragePath('projects', dto.projectId);
projectPath = this.getStoragePath('projects', dto.projectId);
options.HostConfig!.Binds!.push(`${projectPath}:${workspace}`);
options.Env!.push(`PROJECT_ID=${dto.projectId}`);
options.Labels!['org.fulib.project'] = dto.projectId;
}

if (user) {
const usersPath = this.projectService.getStoragePath('users', user.sub);
const usersPath = this.getStoragePath('users', user.sub);

/* create 'settings.json' files if they don't exist already
code server will write the user/machine settings there
Expand Down Expand Up @@ -177,7 +182,7 @@
}

private async getProjectExtensions(projectId: string): Promise<string[]> {
const extensionsListPath = `${this.projectService.getStoragePath('config', projectId)}/extensions.txt`;
const extensionsListPath = `${this.getStoragePath('config', projectId)}/extensions.txt`;

const fileBuffer = await fs.promises.readFile(extensionsListPath).catch(() => '');
if (!fileBuffer) {
Expand Down Expand Up @@ -308,7 +313,7 @@

private async saveExtensions(container: Dockerode.Container, projectId: string) {
const stream = await this.containerExec(container, ['code-server', '--list-extensions', '--show-versions']);
const extensionsList = `${this.projectService.getStoragePath('config', projectId)}/extensions.txt`;
const extensionsList = `${this.getStoragePath('config', projectId)}/extensions.txt`;
await createFile(extensionsList);

const writeStream = fs.createWriteStream(extensionsList);
Expand Down Expand Up @@ -353,13 +358,29 @@
}

async unzip(projectId: string, zip: Express.Multer.File): Promise<void> {
const storagePath = this.projectService.getStoragePath('projects', projectId);
const storagePath = this.getStoragePath('projects', projectId);
const stream = new Readable();
stream.push(zip.buffer);
stream.push(null);
await stream.pipe(Extract({path: storagePath})).promise();
await new Promise((resolve, reject) => chownr(storagePath, 1000, 1000, err => err ? reject(err) : resolve(undefined)));
}

deleteStorage(id: string) {
for (const type of projectStorageTypes) {
fs.promises.rm(this.getStoragePath(type, id), {recursive: true}).catch(e => {
console.error(`Failed to remove project '${id}' storage '${type}': ${e.message}`);
});
}
}

getStoragePath(type: ProjectStorageType | UserStorageType, projectId: string): string {
return `${bindPrefix}/${type}/${this.idBin(projectId)}/${projectId}/`;
}

private idBin(projectId: string) {
return projectId.slice(-2); // last 2 hex chars
}
}

/** https://github.com/apocas/dockerode/issues/534 stream.on("end", resolve) workaround */
Expand Down
3 changes: 3 additions & 0 deletions services/apps/projects/src/environment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,7 @@ export const environment = {
algorithms: (process.env.AUTH_ALGORITHMS || 'RS256').split(','),
issuer: process.env.AUTH_ISSUER || 'https://se.uniks.de/auth/realms/fulib.org',
},
nats: {
servers: process.env.NATS_URL || 'nats://localhost:4222',
},
};
14 changes: 11 additions & 3 deletions services/apps/projects/src/project/project.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ export class ProjectController {
@Body() dto: CreateProjectDto,
@AuthUser() user: UserToken,
): Promise<Project> {
return this.projectService.create(dto, user.sub);
return this.projectService.create({
...dto,
userId: user.sub,
created: new Date(),
});
}

@Get()
Expand All @@ -38,7 +42,11 @@ export class ProjectController {
@AuthUser() user: UserToken,
): Promise<Project[]> {
const members = await this.memberService.findAll({user: user.sub});
return this.projectService.findAll({_id: {$in: members.map(m => m.parent)}});
return this.projectService.findAll({
_id: {$in: members.map(m => m.parent)},
}, {
sort: {name: 1},
});
}

@Get(':id')
Expand Down Expand Up @@ -69,6 +77,6 @@ export class ProjectController {
async remove(
@Param('id', ObjectIdPipe) id: Types.ObjectId,
): Promise<Project | null> {
return this.projectService.remove(id);
return this.projectService.delete(id);
}
}
64 changes: 9 additions & 55 deletions services/apps/projects/src/project/project.service.ts
Original file line number Diff line number Diff line change
@@ -1,71 +1,25 @@
import {UserToken} from '@app/keycloak-auth';
import {Injectable} from '@nestjs/common';
import {InjectModel} from '@nestjs/mongoose';
import * as fs from 'fs';
import {FilterQuery, Model, Types} from 'mongoose';
import * as path from 'path';
import {environment} from '../environment';
import {CreateProjectDto, UpdateProjectDto} from './project.dto';
import {Model} from 'mongoose';
import {Project, ProjectDocument} from './project.schema';

const projectStorageTypes = ['projects', 'config'] as const;
type ProjectStorageType = typeof projectStorageTypes[number];
const userStorageTypes = ['users'] as const;
type UserStorageType = typeof userStorageTypes[number];
const bindPrefix = path.resolve(environment.docker.bindPrefix);
import {EventRepository, EventService, MongooseRepository} from "@mean-stream/nestx";

@Injectable()
export class ProjectService {
@EventRepository()
export class ProjectService extends MongooseRepository<Project> {
constructor(
@InjectModel(Project.name) private model: Model<Project>,
@InjectModel(Project.name) model: Model<Project>,
private eventService: EventService,
) {
super(model);
}

async create(dto: CreateProjectDto, userId: string): Promise<ProjectDocument> {
return this.model.create({
...dto,
userId,
created: new Date(),
});
}

async findAll(where: FilterQuery<Project> = {}): Promise<Project[]> {
return this.model.find(where).sort('+name').exec();
}

async findOne(id: Types.ObjectId): Promise<ProjectDocument | null> {
return this.model.findById(id).exec();
}

async update(id: Types.ObjectId, dto: UpdateProjectDto): Promise<Project | null> {
return this.model.findByIdAndUpdate(id, dto, {new: true}).exec();
}

async remove(id: Types.ObjectId): Promise<ProjectDocument | null> {
const project = await this.model.findByIdAndDelete(id).exec();
if (project) {
this.removeStorage(id.toString());
}
return project;
}

private removeStorage(id: string) {
for (const type of projectStorageTypes) {
fs.promises.rm(this.getStoragePath(type, id), {recursive: true}).catch(e => {
console.error(`Failed to remove project '${id}' storage '${type}': ${e.message}`);
});
}
emit(event: string, project: ProjectDocument) {
this.eventService.emit(`projects.${project._id}.${event}`, project);
}

isAuthorized(project: Project, user: UserToken) {
return project.userId === user.sub;
}

getStoragePath(type: ProjectStorageType | UserStorageType, projectId: string): string {
return `${bindPrefix}/${type}/${this.idBin(projectId)}/${projectId}/`;
}

private idBin(projectId: string) {
return projectId.slice(-2); // last 2 hex chars
}
}
2 changes: 2 additions & 0 deletions services/apps/projects/src/projects.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ import {ProjectModule} from './project/project.module';
import {ScheduleModule} from "@nestjs/schedule";
import {SentryInterceptor, SentryModule} from "@ntegral/nestjs-sentry";
import {APP_INTERCEPTOR} from "@nestjs/core";
import {EventModule} from "@app/event/event.module";

@Module({
imports: [
MongooseModule.forRoot(environment.mongo.uri, environment.mongo.options),
AuthModule.register(environment.auth),
EventModule.forRoot({nats: environment.nats}),
ProjectModule,
MemberModule,
ContainerModule,
Expand Down
Loading