Skip to content

set null observations_count values to zero #559

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

Open
OdileVidrine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

set null observations_count values to zero #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 lib/controllers/v1/computervision_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ const ComputervisionController = class ComputervisionController {
static async delegatedScoresProcessing( req, visionApiResponse ) {
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
2 changes: 1 addition & 1 deletion lib/controllers/v1/identifications_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ const IdentificationsController = class IdentificationsController {
};
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
6 changes: 3 additions & 3 deletions lib/controllers/v1/observations_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,7 @@ ObservationsController.iconicTaxaCounts = async req => {
) );
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down Expand Up @@ -1036,7 +1036,7 @@ ObservationsController.iconicTaxaSpeciesCounts = async req => {

const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down Expand Up @@ -1739,7 +1739,7 @@ ObservationsController.similarSpecies = async req => {
} ) );
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
2 changes: 1 addition & 1 deletion lib/controllers/v1/search_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ SearchController.search = async req => {
// returned in _index, so use a string match instead of equality here
if ( _.includes( h._index, "taxa" ) ) {
const t = new Taxon( h._source );
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
return {
score,
type: "Taxon",
Expand Down
8 changes: 4 additions & 4 deletions lib/controllers/v1/taxa_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ TaxaController.searchQuery = async ( req, opts = { } ) => {
h._source.matched_term = highlighted[0].replace( /<\/?em>/g, "" );
}
const t = new Taxon( h._source );
t.prepareForResponse( localeOpts, mainTaxonOptions );
t.prepareForV1Response( localeOpts, mainTaxonOptions );
return t;
} );
const wikiOpts = { ...options, ...localeOpts };
Expand Down Expand Up @@ -1231,7 +1231,7 @@ TaxaController.suggest = async req => {
response.queryTaxon = await Taxon.findByID( req.suggestParams.taxon_id );
if ( response.queryTaxon ) {
response.queryTaxon = new Taxon( response.queryTaxon );
response.queryTaxon.prepareForResponse( localeOpts );
response.queryTaxon.prepareForV1Response( localeOpts );
await TaxaController.assignPlaces( [response.queryTaxon] );
}
}
Expand Down Expand Up @@ -1395,7 +1395,7 @@ TaxaController.nearby = async req => {
}
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonSourceExcludes = ["photos"];
if ( !req.query.all_photos ) {
Expand Down Expand Up @@ -1478,7 +1478,7 @@ TaxaController.lifelistMetadata = async req => {

const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
5 changes: 5 additions & 0 deletions lib/controllers/v2/search_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
const _ = require( "lodash" );
const Place = require( "../../models/place" );
const ctrlv1 = require( "../v1/search_controller" );

const search = async req => {
const v1Response = await ctrlv1.search( req );
_.each( v1Response.results, result => {
const { type } = result;
if ( type === "Place" ) {
result.record = new Place( result.record );
result.record.prepareForV2Response();
}
result[_.snakeCase( type )] = result.record;
result.type = _.snakeCase( type );
delete result.record;
Expand Down
2 changes: 1 addition & 1 deletion lib/models/identification.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const Identification = class Identification extends Model {

static async preloadInto( req, arr, localeOpts ) {
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
4 changes: 2 additions & 2 deletions lib/models/observation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ const Observation = class Observation extends Model {
const taxonOpts = {
foreignKey: "community_taxon_id",
attrName: "community_taxon",
modifier: t => t.prepareForResponse( localeOpts ),
modifier: t => t.prepareForV1Response( localeOpts ),
source: Taxon.esReturnFields
};
await ESModel.fetchBelongsTo( withProjects, Project, { source: Project.returnFields } );
Expand All @@ -245,7 +245,7 @@ const Observation = class Observation extends Model {

static async preloadMinimal( req, obs, localeOpts ) {
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
const taxonOpts = {
modifier: prepareTaxon,
Expand Down
6 changes: 6 additions & 0 deletions lib/models/place.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ const esClient = require( "../es_client" );
const util = require( "../util" );

const Place = class Place extends Model {
prepareForV2Response() {
if ( _.isNull( this.observations_count ) ) {
this.observations_count = 0;
}
}

static async findByID( id, options = { } ) {
if ( _.isEmpty( id ) && !_.isNumber( id ) ) { return null; }
let lookupID = id;
Expand Down
2 changes: 1 addition & 1 deletion lib/models/project.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ const Project = class Project extends Model {
}
}
const taxonOpts = {
modifier: t => t.prepareForResponse( options.localeOpts ),
modifier: t => t.prepareForV1Response( options.localeOpts ),
source: { excludes: ["taxon_photos"] },
foreignKey: "operand_id"
};
Expand Down
6 changes: 3 additions & 3 deletions lib/models/taxon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ const Taxon = class Taxon extends Model {
return localMeans || ancestorMeans;
}

prepareForResponse( localeOptions = { }, opts = { } ) {
prepareForV1Response( localeOptions = { }, opts = { } ) {
const localeOpts = { ...localeOptions };
const options = { ...opts };
const userPreferredCommonNames = this.preferredCommonNames( localeOpts );
Expand Down Expand Up @@ -519,7 +519,7 @@ const Taxon = class Taxon extends Model {

static async preloadIntoTaxonPhotos( taxa, options ) {
options = options || { };
const prepareTaxon = t => t.prepareForResponse( options.localeOpts );
const prepareTaxon = t => t.prepareForV1Response( options.localeOpts );
// const taxonPhotos = _.flatten( _.map( taxa, t => t.taxon_photos ) );
_.each( taxa, taxon => {
_.each( taxon.taxon_photos, taxonPhoto => {
Expand Down Expand Up @@ -623,7 +623,7 @@ const Taxon = class Taxon extends Model {
static esQueryOptions( req ) {
const localeOpts = util.localeOpts( req );
const prepareTaxon = t => {
t.prepareForResponse( localeOpts );
t.prepareForV1Response( localeOpts );
};
return {
modifier: prepareTaxon,
Expand Down
30 changes: 15 additions & 15 deletions test/models/taxon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ describe( "Taxon", ( ) => {
position: 1
}]
};
t.prepareForResponse( { userSession } );
t.prepareForV1Response( { userSession } );
expect( t.preferred_common_name ).to.eq( "BestEnglish · BestSpanish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[1].name ).to.eq( "BestSpanish" );
Expand All @@ -175,7 +175,7 @@ describe( "Taxon", ( ) => {
position: 1
}]
};
t.prepareForResponse( { userSession } );
t.prepareForV1Response( { userSession } );
expect( t.preferred_common_name ).to.be.undefined;
expect( t.preferred_common_names ).to.be.undefined;
} );
Expand All @@ -190,7 +190,7 @@ describe( "Taxon", ( ) => {
position: 1
}]
};
t.prepareForResponse( { userSession } );
t.prepareForV1Response( { userSession } );
expect( t.preferred_common_name ).to.eq( "BestSpanish · BestEnglish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestSpanish" );
expect( t.preferred_common_names[1].name ).to.eq( "BestEnglish" );
Expand All @@ -203,7 +203,7 @@ describe( "Taxon", ( ) => {
position: 0
}]
};
t.prepareForResponse( { userSession } );
t.prepareForV1Response( { userSession } );
expect( t.preferred_common_name ).to.be.undefined;
expect( t.preferred_common_names ).to.be.empty;
} );
Expand All @@ -215,11 +215,11 @@ describe( "Taxon", ( ) => {
position: 0
}]
};
t.prepareForResponse( { locale: "en", userSession } );
t.prepareForV1Response( { locale: "en", userSession } );
expect( t.preferred_common_name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestEnglish" );
t = _.cloneDeep( stubTaxon );
t.prepareForResponse( { locale: "es", userSession } );
t.prepareForV1Response( { locale: "es", userSession } );
expect( t.preferred_common_name ).to.eq( "BestSpanish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestSpanish" );
} );
Expand All @@ -235,19 +235,19 @@ describe( "Taxon", ( ) => {
}]
};
// en
t.prepareForResponse( { locale: "en", userSession } );
t.prepareForV1Response( { locale: "en", userSession } );
expect( t.preferred_common_name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[1].name ).to.eq( "BestEnglish" );
// es
t = _.cloneDeep( stubTaxon );
t.prepareForResponse( { locale: "es", userSession } );
t.prepareForV1Response( { locale: "es", userSession } );
expect( t.preferred_common_name ).to.eq( "BestEnglish · BestSpanish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[1].name ).to.eq( "BestSpanish" );
// es-mx
t = _.cloneDeep( stubTaxon );
t.prepareForResponse( { locale: "es-mx", userSession } );
t.prepareForV1Response( { locale: "es-mx", userSession } );
expect( t.preferred_common_name ).to.eq( "BestEnglish · BestSpanish" );
expect( t.preferred_common_names[0].name ).to.eq( "BestEnglish" );
expect( t.preferred_common_names[1].name ).to.eq( "BestSpanish" );
Expand All @@ -261,7 +261,7 @@ describe( "Taxon", ( ) => {
place_id: 222
}]
};
t.prepareForResponse( { locale: "en", userSession } );
t.prepareForV1Response( { locale: "en", userSession } );
expect( t.preferred_common_name ).to.eq( "BestInCalifornia" );
expect( t.preferred_common_names[0].name ).to.eq( "BestInCalifornia" );
} );
Expand All @@ -274,7 +274,7 @@ describe( "Taxon", ( ) => {
place_id: 222
}]
};
t.prepareForResponse( { locale: "de", userSession } );
t.prepareForV1Response( { locale: "de", userSession } );
expect( t.preferred_common_name ).to.be.undefined;
expect( t.preferred_common_names ).to.be.empty;
} );
Expand All @@ -288,7 +288,7 @@ describe( "Taxon", ( ) => {
ancestor_place_ids: [111, 333]
}]
};
t.prepareForResponse( { locale: "en", userSession } );
t.prepareForV1Response( { locale: "en", userSession } );
expect( t.preferred_common_name ).to.eq( "BestInAmerica" );
expect( t.preferred_common_names[0].name ).to.eq( "BestInAmerica" );
} );
Expand All @@ -300,7 +300,7 @@ describe( "Taxon", ( ) => {
position: 0
}]
};
t.prepareForResponse( { locale: "en", userSession } );
t.prepareForV1Response( { locale: "en", userSession } );
expect( t.preferred_common_name ).to.be.undefined;
expect( t.preferred_common_names ).to.be.empty;
} );
Expand Down Expand Up @@ -360,14 +360,14 @@ describe( "Taxon", ( ) => {
describe( "prepareForResponse", ( ) => {
it( "skips listed taxa without means", ( ) => {
const t2 = new Taxon( t );
t2.prepareForResponse( );
t2.prepareForV1Response( );
// expect( t2.preferred_common_name ).to.eq( "BestEnglish" );
// TODO I'm not sure how the above tested anything related to listed taxa
} );

it( "defaults to strict locale check", ( ) => {
const t2 = new Taxon( t );
t2.prepareForResponse( { locale: "de" } );
t2.prepareForV1Response( { locale: "de" } );
expect( t2.preferred_common_name ).to.be.undefined;
} );
} );
Expand Down