Skip to content

#1702 - Allow institution to specify custom regulatory body #1763

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

Merged
merged 15 commits into from
Mar 1, 2023
Merged

#1702 - Allow institution to specify custom regulatory body #1763

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
13e1537
Form Update
sh16011993 Feb 24, 2023
39e3195
Form Updates
sh16011993 Feb 24, 2023
ecd21fb
Form Update
sh16011993 Feb 25, 2023
6cbab2a
Created institution with the other regulating body
sh16011993 Feb 24, 2023
4762b6a
Worked on displaying other regulating institution
sh16011993 Feb 24, 2023
8858b28
Worked on displaying Other Regulating Body on AEST portal
sh16011993 Feb 25, 2023
074df33
Completed #1702
sh16011993 Feb 26, 2023
78631ab
Merge remote-tracking branch 'origin/1702_allow_institution_to_specif…
sh16011993 Feb 26, 2023
668cfd5
Removed my changes related to prettier from .eslintrc.js
sh16011993 Feb 26, 2023
2ee42f3
Removed redundant line change from InstitutionProfile.vue
sh16011993 Feb 26, 2023
d36349a
Updated the EOF formatter - CRLF to LF
sh16011993 Feb 27, 2023
d0956ef
Added the DB Migration file and the script files for the same
sh16011993 Feb 27, 2023
73f2c37
Updated code with all the review comments.
sh16011993 Feb 28, 2023
1d44db2
Updated the code with the comments from code review (Revision 2)
sh16011993 Feb 28, 2023
4e3a8be
Updated the code with the comments from code review (Revision 3)
sh16011993 Mar 1, 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
1 change: 1 addition & 0 deletions ...ages/backend/apps/api/src/route-controllers/institution/institution.controller.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export class InstitutionControllerService {
primaryEmail: institutionDetail.primaryEmail,
website: institutionDetail.website,
regulatingBody: institutionDetail.regulatingBody,
otherRegulatingBody: institutionDetail.otherRegulatingBody,
institutionType: institutionDetail.institutionType.id,
institutionTypeName: institutionDetail.institutionType.name,
establishedDate: institutionDetail.establishedDate,
Expand Down
7 changes: 7 additions & 0 deletions ...ces/packages/backend/apps/api/src/route-controllers/institution/models/institution.dto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ export class CreateInstitutionAPIInDTO {
website: string;
@IsNotEmpty()
regulatingBody: string;
@ValidateIf((e) => e.regulatingBody === "other")
@IsNotEmpty()
otherRegulatingBody: string;
@IsDateString()
establishedDate: string;
@IsPositive()
Expand Down Expand Up @@ -102,6 +105,9 @@ export class InstitutionProfileAPIInDTO extends InstitutionContactAPIInDTO {
website: string;
@IsNotEmpty()
regulatingBody: string;
@ValidateIf((e) => e.regulatingBody === "other")
@IsNotEmpty()
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same max length validation needs to added here as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I apologize, I missed it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

No problem.

otherRegulatingBody: string;
@IsDateString()
establishedDate: string;
@IsPositive()
Expand All @@ -114,6 +120,7 @@ export class InstitutionProfileAPIOutDTO extends InstitutionContactAPIOutDTO {
primaryEmail: string;
website: string;
regulatingBody: string;
otherRegulatingBody: string;
establishedDate: string;
institutionType: number;
}
Expand Down
2 changes: 2 additions & 0 deletions sources/packages/backend/apps/api/src/services/institution/institution.service.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export interface UpdateInstitution {
primaryEmail?: string;
website?: string;
regulatingBody?: string;
otherRegulatingBody?: string;
establishedDate?: string;
institutionType?: number;
primaryContactEmail: string;
Expand Down Expand Up @@ -34,6 +35,7 @@ export interface InstitutionFormModel {
primaryEmail: string;
website: string;
regulatingBody: string;
otherRegulatingBody: string;
establishedDate: string;
primaryContactFirstName: string;
primaryContactLastName: string;
Expand Down
2 changes: 2 additions & 0 deletions sources/packages/backend/apps/api/src/services/institution/institution.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ export class InstitutionService extends RecordDataModelService<Institution> {
institution.primaryEmail = institutionModel.primaryEmail;
institution.website = institutionModel.website;
institution.regulatingBody = institutionModel.regulatingBody;
institution.otherRegulatingBody = institutionModel.otherRegulatingBody;
institution.establishedDate = institutionModel.establishedDate;
institution.institutionType = {
id: institutionModel.institutionType,
Expand Down Expand Up @@ -853,6 +854,7 @@ export class InstitutionService extends RecordDataModelService<Institution> {
institution.primaryEmail = updateInstitution.primaryEmail;
institution.website = updateInstitution.website;
institution.regulatingBody = updateInstitution.regulatingBody;
institution.otherRegulatingBody = updateInstitution.otherRegulatingBody;
institution.establishedDate = updateInstitution.establishedDate;
institution.institutionType = {
id: updateInstitution.institutionType,
Expand Down
18 changes: 18 additions & 0 deletions .../db-migrations/src/migrations/1677528030804-InstitutionsTableCreateOtherRegulatingBody.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { MigrationInterface, QueryRunner } from "typeorm";
import { getSQLFileData } from "../utilities/sqlLoader";

export class InstitutionsTableCreateOtherRegulatingBody1677528030804
implements MigrationInterface
{
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
getSQLFileData("Add-col-other-regulating-body.sql", "Institution"),
);
}

public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
getSQLFileData("Drop-col-other-regulating-body.sql", "Institution"),
);
}
}
4 changes: 4 additions & 0 deletions ...packages/backend/apps/db-migrations/src/sql/Institution/Add-col-other-regulating-body.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
-- Add other_regulating_body column to institutions table
ALTER TABLE sims.institutions ADD COLUMN IF NOT EXISTS other_regulating_body VARCHAR(100);

COMMENT ON COLUMN sims.institutions.other_regulating_body IS 'Allows the user to enter the description if the option other is selected from the regulating body dropdown';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please add a period at the end of the sentence.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks. Will do.

2 changes: 2 additions & 0 deletions ...ackages/backend/apps/db-migrations/src/sql/Institution/Drop-col-other-regulating-body.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-- Drop other_regulating_body column from institutions table
ALTER TABLE sims.institutions DROP COLUMN IF EXISTS other_regulating_body;
6 changes: 6 additions & 0 deletions sources/packages/backend/libs/sims-db/src/entities/institution.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,17 @@ export class Institution extends RecordDataModel {
name: "website",
})
website: string;

@Column({
name: "regulating_body",
})
regulatingBody: string;

@Column({
name: "other_regulating_body",
})
otherRegulatingBody: string;

@Column({
Copy link
Collaborator

Choose a reason for hiding this comment

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

The comment is missing for the property. I know that this is a very old entity model that is why it is missing the comments for all the properties of the class.

Here is the Wiki for comment standards we follow on entity models.
https://github.com/bcgov/SIMS/wiki/Development---Standards,-Decisions,-and-Troubleshooting#typeorm-database-models

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds good. Will do the change

name: "established_date",
type: "date",
Expand Down
Loading