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

Fix bug in observation inserts and updates #1320

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Fix bug in observation inserts and updates #1320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
901cb5c
fix bug when upserting observations
mauberti-bc Jul 5, 2024
7a2e382
Delete unused function.
NickPhura Jul 8, 2024
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
4 changes: 2 additions & 2 deletions api/src/paths/project/{projectId}/survey/{surveyId}/observations/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ describe('insertUpdateManualSurveyObservations', () => {
surveyObservations
};

const requestHandler = observationRecords.insertUpdateManualSurveyObservations();
const requestHandler = observationRecords.putObservations();

await requestHandler(mockReq, mockRes, mockNext);

Expand Down Expand Up @@ -126,7 +126,7 @@ describe('insertUpdateManualSurveyObservations', () => {
};

try {
const requestHandler = observationRecords.insertUpdateManualSurveyObservations();
const requestHandler = observationRecords.putObservations();

await requestHandler(mockReq, mockRes, mockNext);
expect.fail();
Expand Down
13 changes: 8 additions & 5 deletions api/src/paths/project/{projectId}/survey/{surveyId}/observations/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const PUT: Operation = [
]
};
}),
insertUpdateManualSurveyObservations()
putObservations()
];

GET.apiDoc = {
Expand Down Expand Up @@ -168,7 +168,8 @@ PUT.apiDoc = {
type: 'integer',
minimum: 1,
nullable: true,
description: 'The survey observation ID. If provided observation, the record will be updated.'
description:
'The survey observation ID. If provided, the matching existing observation record will be updated. If not provided, a new observation record will be inserted.'
},
itis_tsn: {
type: 'integer'
Expand Down Expand Up @@ -229,9 +230,11 @@ PUT.apiDoc = {
],
properties: {
observation_subcount_id: {
type: 'number',
type: 'integer',
minimum: 1,
nullable: true,
description: 'The observation subcount ID. If provided, the subcount record will be updated.'
description:
'The observation subcount ID. If provided, the mataching existing subcount record will be updated. If not provided, a new subcount record will be inserted.'
},
subcount: {
type: 'number',
Expand Down Expand Up @@ -407,7 +410,7 @@ export function getSurveyObservations(): RequestHandler {
* @export
* @return {*} {RequestHandler}
*/
export function insertUpdateManualSurveyObservations(): RequestHandler {
export function putObservations(): RequestHandler {
return async (req, res) => {
const surveyId = Number(req.params.surveyId);

Expand Down
4 changes: 3 additions & 1 deletion api/src/repositories/observation-repository/observation-repository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,9 @@ export class ObservationRepository extends BaseRepository {
observations
.map((observation) => {
return `(${[
'survey_observation_id' in observation ? observation.survey_observation_id : 'DEFAULT',
'survey_observation_id' in observation && observation.survey_observation_id
? observation.survey_observation_id
: 'DEFAULT',
surveyId,
observation.survey_sample_site_id ?? 'NULL',
observation.survey_sample_method_id ?? 'NULL',
Expand Down
91 changes: 1 addition & 90 deletions api/src/services/observation-service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@ import chai, { expect } from 'chai';
import sinon from 'sinon';
import sinonChai from 'sinon-chai';
import {
InsertObservation,
ObservationRecord,
ObservationRecordWithSamplingAndSubcountData,
ObservationRepository,
UpdateObservation
ObservationRepository
} from '../repositories/observation-repository/observation-repository';
import * as file_utils from '../utils/file-utils';
import { getMockDBConnection } from '../__mocks__/db';
Expand All @@ -28,92 +25,6 @@ describe('ObservationService', () => {
expect(observationService).to.be.instanceof(ObservationService);
});

describe('insertUpdateDeleteSurveyObservations', () => {
it('deletes, creates, and updates observation records', async () => {
const mockDBConnection = getMockDBConnection();

const deleteObservationsNotInArrayStub = sinon
.stub(ObservationRepository.prototype, 'deleteObservationsNotInArray')
.resolves();

const mockInsertUpdateResponse: ObservationRecord[] = [
{
survey_observation_id: 11,
survey_id: 1,
latitude: 3,
longitude: 4,
count: 5,
itis_tsn: 6,
itis_scientific_name: 'itis_scientific_name',
observation_date: '2023-01-01',
observation_time: '12:00:00',
create_date: '2023-04-04',
create_user: 1,
update_date: null,
update_user: null,
revision_count: 0,
survey_sample_site_id: 1,
survey_sample_method_id: 1,
survey_sample_period_id: 1
},
{
survey_observation_id: 6,
survey_id: 1,
latitude: 8,
longitude: 9,
count: 10,
itis_tsn: 6,
itis_scientific_name: 'itis_scientific_name',
observation_date: '2023-02-02',
observation_time: '13:00:00',
create_date: '2023-03-03',
create_user: 1,
update_date: '2023-04-04',
update_user: 2,
revision_count: 1,
survey_sample_site_id: 1,
survey_sample_method_id: 1,
survey_sample_period_id: 1
}
];
const insertUpdateSurveyObservationsStub = sinon
.stub(ObservationRepository.prototype, 'insertUpdateSurveyObservations')
.resolves(mockInsertUpdateResponse);

const surveyId = 1;
const observations: (InsertObservation | UpdateObservation)[] = [
{
survey_id: 1,
latitude: 3,
longitude: 4,
count: 5,
itis_tsn: 6,
itis_scientific_name: 'itis_scientific_name',
observation_date: '2023-01-01',
observation_time: '12:00:00'
} as InsertObservation,
{
survey_observation_id: 6,
latitude: 8,
longitude: 9,
count: 10,
itis_tsn: 6,
itis_scientific_name: 'itis_scientific_name',
observation_date: '2023-02-02',
observation_time: '13:00:00'
} as UpdateObservation
];

const observationService = new ObservationService(mockDBConnection);

const response = await observationService.insertUpdateDeleteSurveyObservations(surveyId, observations);

expect(deleteObservationsNotInArrayStub).to.have.been.calledOnceWith(surveyId, [6]);
expect(insertUpdateSurveyObservationsStub).to.have.been.calledOnceWith(surveyId, observations);
expect(response).to.eql(mockInsertUpdateResponse);
});
});

describe('getSurveyObservationsWithSupplementaryAndSamplingDataAndAttributeData', () => {
it('Gets observations by survey id', async () => {
const mockDBConnection = getMockDBConnection();
Expand Down
25 changes: 0 additions & 25 deletions api/src/services/observation-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,31 +140,6 @@ export class ObservationService extends DBService {
return this.observationRepository.findObservations(isUserAdmin, systemUserId, filterFields, pagination);
}

/**
* Performs an upsert for all observation records belonging to the given survey, while removing
* any records associated for the survey that aren't included in the given records, then
* returns the updated rows
*
* @param {number} surveyId
* @param {((Observation | ObservationRecord)[])} observations
* @return {*} {Promise<ObservationRecord[]>}
* @memberof ObservationService
*/
async insertUpdateDeleteSurveyObservations(
surveyId: number,
observations: (InsertObservation | UpdateObservation)[]
): Promise<ObservationRecord[]> {
const retainedObservationIds = observations
.filter((observation): observation is UpdateObservation => {
return 'survey_observation_id' in observation && Boolean(observation.survey_observation_id);
})
.map((observation) => observation.survey_observation_id);

await this.observationRepository.deleteObservationsNotInArray(surveyId, retainedObservationIds);

return this.observationRepository.insertUpdateSurveyObservations(surveyId, observations);
}

/**
* Upserts the given observation records and their associated measurements.
*
Expand Down