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.

Sign up for GitHub

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

N21-1494 Contextual info outdated CTL #4572

Merged
merged 28 commits into from
Dec 4, 2023
Merged

N21-1494 Contextual info outdated CTL #4572

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1454fda
N21-1494 WIP
mrikallab Nov 23, 2023
b28bdd0
N21-1494 remove import
mrikallab Nov 23, 2023
1021f15
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Nov 23, 2023
6659d21
N21-1494 move toolConfiguration status
mrikallab Nov 23, 2023
988deaf
N21-1494 fix tests
mrikallab Nov 23, 2023
43fbf92
N21-1494 fix tests
mrikallab Nov 23, 2023
df3f704
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Nov 24, 2023
3926f0f
N21-1494 review changes
mrikallab Nov 24, 2023
d6d9125
N21-1494 remove unused imports
mrikallab Nov 24, 2023
562068d
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Nov 24, 2023
0e82ad6
N21-1494 review changes
mrikallab Nov 27, 2023
3d55b0f
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Nov 27, 2023
3f57ec9
N21-1494 fix test
mrikallab Nov 28, 2023
607875f
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Nov 28, 2023
4028fea
N21-1494 cypress test data
mrikallab Nov 30, 2023
96b047a
N21-1494 review changes
mrikallab Dec 1, 2023
6312b9e
N21-1494 refactoring
mrikallab Dec 1, 2023
7135aed
N21-1494 fix import
mrikallab Dec 1, 2023
6fa175f
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Dec 1, 2023
08caca4
N21-1494 fix import
mrikallab Dec 1, 2023
17cd004
N21-1494 fix cy data
mrikallab Dec 1, 2023
22797b8
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Dec 1, 2023
682d1d1
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Dec 1, 2023
169ee50
N21-1494 review changes
mrikallab Dec 4, 2023
bce9afe
N21-1494 imports
mrikallab Dec 4, 2023
381810e
Merge branch 'main' into N21-1494-info-outdated-ctl-tools
mrikallab Dec 4, 2023
df4ccb5
N21-1494 cy seed data
mrikallab Dec 4, 2023
29da5c2
N21-1494 fix deprecated code
mrikallab Dec 4, 2023
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
2 changes: 1 addition & 1 deletion apps/server/src/modules/tool/common/domain/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export * from './custom-parameter.do';
export * from './custom-parameter-entry.do';
export * from '../enum/tool-configuration-status';
export * from './tool-configuration-status';
19 changes: 19 additions & 0 deletions apps/server/src/modules/tool/common/domain/tool-configuration-status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
export class ToolConfigurationStatus {
latest: boolean;
mrikallab marked this conversation as resolved.
Show resolved Hide resolved

isDisabled: boolean;

isOutdatedOnScopeSchool: boolean;

isOutdatedOnScopeContext: boolean;

isUnkown: boolean;
mrikallab marked this conversation as resolved.
Show resolved Hide resolved

constructor(props: ToolConfigurationStatus) {
this.latest = props.latest;
this.isDisabled = props.isDisabled;
this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
this.isUnkown = props.isUnkown;
}
}
2 changes: 1 addition & 1 deletion apps/server/src/modules/tool/common/enum/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ export * from './tool-context-type.enum';
export * from './custom-parameter-location.enum';
export * from './custom-parameter-scope.enum';
export * from './custom-parameter-type.enum';
export * from './tool-configuration-status';
export * from '../domain/tool-configuration-status';
5 changes: 0 additions & 5 deletions apps/server/src/modules/tool/common/enum/tool-configuration-status.ts
View file
Open in desktop

This file was deleted.

16 changes: 9 additions & 7 deletions apps/server/src/modules/tool/common/mapper/tool-status-response.mapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
import { ToolConfigurationStatusResponse } from '../../context-external-tool/controller/dto';
import { ToolConfigurationStatus } from '../enum';

export const statusMapping: Record<ToolConfigurationStatus, ToolConfigurationStatusResponse> = {
[ToolConfigurationStatus.LATEST]: ToolConfigurationStatusResponse.LATEST,
[ToolConfigurationStatus.OUTDATED]: ToolConfigurationStatusResponse.OUTDATED,
[ToolConfigurationStatus.UNKNOWN]: ToolConfigurationStatusResponse.UNKNOWN,
};

export class ToolStatusResponseMapper {
static mapToResponse(status: ToolConfigurationStatus): ToolConfigurationStatusResponse {
return statusMapping[status];
const configurationStatus: ToolConfigurationStatusResponse = new ToolConfigurationStatusResponse({
latest: status.latest,
isDisabled: status.isDisabled,
isOutdatedOnScopeSchool: status.isOutdatedOnScopeSchool,
isOutdatedOnScopeContext: status.isOutdatedOnScopeContext,
isUnkown: status.isUnkown,
});

return configurationStatus;
}
}
84 changes: 70 additions & 14 deletions apps/server/src/modules/tool/common/service/common-tool.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.LATEST', () => {
it('should return is latest', () => {
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -45,7 +45,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.LATEST);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: true,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: false,
isOutdatedOnScopeSchool: false,
})
);
});
});

Expand All @@ -62,7 +70,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.OUTDATED', () => {
it('should return isOutdatedOnScopeContext and isOutdatedOnScopeSchool true', () => {
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -71,7 +79,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.OUTDATED);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: false,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: true,
isOutdatedOnScopeSchool: true,
})
);
});
});

Expand All @@ -88,7 +104,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.OUTDATED', () => {
it('should return isOutdatedOnScopeContext true', () => {
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -97,7 +113,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.OUTDATED);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: false,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: true,
isOutdatedOnScopeSchool: true,
})
);
});
});

Expand All @@ -114,7 +138,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.OUTDATED', () => {
it('should return isOutdatedOnScopeContext true', () => {
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -123,7 +147,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.OUTDATED);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: false,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: true,
isOutdatedOnScopeSchool: true,
})
);
});
});

Expand All @@ -140,7 +172,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.LATEST', () => {
it('should return is latest', () => {
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -149,7 +181,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.LATEST);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: true,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: false,
isOutdatedOnScopeSchool: false,
})
);
});
});

Expand All @@ -166,7 +206,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.LATEST', () => {
it('should return is latest', () => {
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -175,7 +215,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.LATEST);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: true,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: false,
isOutdatedOnScopeSchool: false,
})
);
});
});

Expand All @@ -192,7 +240,7 @@ describe('CommonToolService', () => {
};
};

it('should return ToolConfigurationStatus.LATEST', () => {
it('should return is latest', () => {
const { externalTool, schoolExternalTool, contextExternalTool } = setup();

const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
Expand All @@ -201,7 +249,15 @@ describe('CommonToolService', () => {
contextExternalTool
);

expect(result).toBe(ToolConfigurationStatus.LATEST);
expect(result).toStrictEqual(
new ToolConfigurationStatus({
latest: true,
isUnkown: false,
isDisabled: false,
isOutdatedOnScopeContext: false,
isOutdatedOnScopeSchool: false,
})
);
});
});
});
Expand Down
14 changes: 12 additions & 2 deletions apps/server/src/modules/tool/common/service/common-tool.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,25 @@ export class CommonToolService {
schoolExternalTool: SchoolExternalTool,
contextExternalTool: ContextExternalTool
): ToolConfigurationStatus {
const configurationStatus: ToolConfigurationStatus = new ToolConfigurationStatus({
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
latest: false,
isDisabled: false,
isOutdatedOnScopeContext: true,
isOutdatedOnScopeSchool: true,
isUnkown: false,
});

if (
this.isLatest(schoolExternalTool, externalTool) &&
this.isLatest(contextExternalTool, schoolExternalTool) &&
this.isLatest(contextExternalTool, externalTool)
) {
return ToolConfigurationStatus.LATEST;
configurationStatus.latest = true;
configurationStatus.isOutdatedOnScopeContext = false;
configurationStatus.isOutdatedOnScopeSchool = false;
}

return ToolConfigurationStatus.OUTDATED;
return configurationStatus;
}

private isLatest(tool1: ToolVersion, tool2: ToolVersion): boolean {
Expand Down
16 changes: 14 additions & 2 deletions ...ver/src/modules/tool/context-external-tool/controller/api-test/tool-reference.api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,13 @@ describe('ToolReferenceController (API)', () => {
{
contextToolId: contextExternalToolEntity.id,
displayName: contextExternalToolEntity.displayName as string,
status: ToolConfigurationStatusResponse.LATEST,
status: new ToolConfigurationStatusResponse({
latest: true,
isDisabled: false,
isOutdatedOnScopeSchool: false,
isOutdatedOnScopeContext: false,
isUnkown: false,
}),
logoUrl: `http://localhost:3030/api/v3/tools/external-tools/${externalToolEntity.id}/logo`,
openInNewTab: externalToolEntity.openNewTab,
},
Expand Down Expand Up @@ -277,7 +283,13 @@ describe('ToolReferenceController (API)', () => {
expect(response.body).toEqual<ToolReferenceResponse>({
contextToolId: contextExternalToolEntity.id,
displayName: contextExternalToolEntity.displayName as string,
status: ToolConfigurationStatusResponse.LATEST,
status: new ToolConfigurationStatusResponse({
latest: true,
isDisabled: false,
isOutdatedOnScopeSchool: false,
isOutdatedOnScopeContext: false,
isUnkown: false,
}),
logoUrl: `http://localhost:3030/api/v3/tools/external-tools/${externalToolEntity.id}/logo`,
openInNewTab: externalToolEntity.openNewTab,
});
Expand Down
29 changes: 25 additions & 4 deletions ...c/modules/tool/context-external-tool/controller/dto/tool-configuration-status.response.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
export enum ToolConfigurationStatusResponse {
LATEST = 'Latest',
OUTDATED = 'Outdated',
UNKNOWN = 'Unknown',
import { ApiProperty } from '@nestjs/swagger';

export class ToolConfigurationStatusResponse {
@ApiProperty()
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
latest: boolean;

@ApiProperty()
isDisabled: boolean;

@ApiProperty()
isOutdatedOnScopeSchool: boolean;
mrikallab marked this conversation as resolved.
Show resolved Hide resolved

@ApiProperty()
isOutdatedOnScopeContext: boolean;

@ApiProperty()
isUnkown: boolean;

constructor(props: ToolConfigurationStatusResponse) {
this.latest = props.latest;
this.isDisabled = props.isDisabled;
this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
this.isUnkown = props.isUnkown;
}
}
4 changes: 1 addition & 3 deletions apps/server/src/modules/tool/context-external-tool/controller/dto/tool-reference.response.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@ export class ToolReferenceResponse {
openInNewTab: boolean;

@ApiProperty({
enum: ToolConfigurationStatusResponse,
enumName: 'ToolConfigurationStatusResponse',
type: ToolConfigurationStatusResponse,
nullable: false,
required: true,
description: 'The status of the tool',
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can you explain, why this could not be correct? I added also required, because we could need these Informations

})
status: ToolConfigurationStatusResponse;
Expand Down
3 changes: 2 additions & 1 deletion apps/server/src/modules/tool/context-external-tool/controller/tool-reference.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ export class ToolReferenceController {

const toolReferenceResponses: ToolReferenceResponse[] =
ContextExternalToolResponseMapper.mapToToolReferenceResponses(toolReferences);
const toolReferenceListResponse = new ToolReferenceListResponse(toolReferenceResponses);

const toolReferenceListResponse: ToolReferenceListResponse = new ToolReferenceListResponse(toolReferenceResponses);

return toolReferenceListResponse;
}
Expand Down
18 changes: 16 additions & 2 deletions apps/server/src/modules/tool/context-external-tool/service/tool-reference.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,15 @@ describe('ToolReferenceService', () => {
contextExternalToolService.findById.mockResolvedValueOnce(contextExternalTool);
schoolExternalToolService.findById.mockResolvedValueOnce(schoolExternalTool);
externalToolService.findById.mockResolvedValueOnce(externalTool);
toolVersionService.determineToolConfigurationStatus.mockResolvedValue(ToolConfigurationStatus.OUTDATED);
toolVersionService.determineToolConfigurationStatus.mockResolvedValue(
new ToolConfigurationStatus({
mrikallab marked this conversation as resolved.
Show resolved Hide resolved
latest: false,
isDisabled: false,
isOutdatedOnScopeSchool: true,
isOutdatedOnScopeContext: false,
isUnkown: false,
})
);
externalToolLogoService.buildLogoUrl.mockReturnValue(logoUrl);

return {
Expand Down Expand Up @@ -123,7 +131,13 @@ describe('ToolReferenceService', () => {
logoUrl,
displayName: contextExternalTool.displayName as string,
openInNewTab: externalTool.openNewTab,
status: ToolConfigurationStatus.OUTDATED,
status: new ToolConfigurationStatus({
latest: false,
isDisabled: false,
isOutdatedOnScopeSchool: true,
isOutdatedOnScopeContext: false,
isUnkown: false,
}),
contextToolId: contextExternalToolId,
});
});
Expand Down
Loading
Loading