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

Jump to bottom

[Vue] Vue frontend doesn't detect custom primary key names #24686

Merged
merged 6 commits into from
Dec 30, 2023
Merged

[Vue] Vue frontend doesn't detect custom primary key names #24686

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e228b27
[Vue] Vue frontend doesn't detect custom primary key names
qmonmert Dec 28, 2023
8e7e34f
add vue-default-additional sample
mshima Dec 29, 2023
c3feb04
fix workflow samples
mshima Dec 29, 2023
520de71
fix generate-sample
mshima Dec 29, 2023
8fe1e01
Apply suggestions from code review
mshima Dec 29, 2023
f5ca452
Apply suggestions from code review
mshima Dec 29, 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
4 changes: 2 additions & 2 deletions ...es/src/main/webapp/app/entities/_entityFolder_/_entityFile_-details.component.spec.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ vitest.mock('vue-router', () => ({
useRouter: () => ({ go: routerGoMock }),
}));

const <%= entityInstance %>Sample = { id: <%- tsKeyId %> };
const <%= entityInstance %>Sample = { <%= primaryKey.name %>: <%- tsKeyId %> };

describe('Component Tests', () => {
let alertService: AlertService;
Expand Down Expand Up @@ -83,7 +83,7 @@ describe('Component Tests', () => {
<%= entityInstance %>ServiceStub.find.resolves(<%= entityInstance %>Sample);
route = {
params: {
<%= entityInstance %>Id: '' + <%- tsKeyId %>,
<%= entityInstance %><%= primaryKey.nameCapitalized %>: '' + <%- tsKeyId %>,
mshima marked this conversation as resolved.
Show resolved Hide resolved
},
};
const wrapper = shallowMount(<%= entityAngularName %>Details, { global: mountOptions });
Expand Down
4 changes: 2 additions & 2 deletions ...mplates/src/main/webapp/app/entities/_entityFolder_/_entityFile_-details.component.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ export default defineComponent({
const previousState = () => router.go(-1);
const <%= entityInstance %>: Ref<I<%= entityAngularName %>> = ref({});

const retrieve<%= entityAngularName %> = async <%= entityInstance %>Id => {
const retrieve<%= entityAngularName %> = async <%= entityInstance %><%= primaryKey.nameCapitalized %> => {
try {
const res = await <%= entityInstance %>Service().find(<%= entityInstance %>Id);
const res = await <%= entityInstance %>Service().find(<%= entityInstance %><%= primaryKey.nameCapitalized %>);
<%= entityInstance %>.value = res;
} catch (error) {
alertService.showHttpError(error.response);
Expand Down
12 changes: 6 additions & 6 deletions ...rs/vue/templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_-details.vue.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="row justify-content-center">
<div class="col-8">
<div v-if="<%= entityInstance %>">
<h2 class="jh-entity-heading" data-cy="<%= entityInstance %>DetailsHeading"><span v-text="t$('<%= i18nKeyPrefix %>.detail.title')"><%= entityAngularName %></span> {{<%= entityInstance %>.id}}</h2>
<h2 class="jh-entity-heading" data-cy="<%= entityInstance %>DetailsHeading"><span v-text="t$('<%= i18nKeyPrefix %>.detail.title')"><%= entityAngularName %></span> {{<%= entityInstance %>.<%= primaryKey.name %>}}</h2>
<dl class="row jh-entity-details">
<%_ for (field of fields.filter(field => !field.id)) {
const fieldName = field.fieldName;
Expand Down Expand Up @@ -49,20 +49,20 @@
<dd>
<%_ if (relationship.otherEntityUser) { _%>
<%_ if (relationship.relationshipManyToMany) { _%>
<span v-for="(<%= relationshipFieldName %>, i) in <%= entityInstance %>.<%= relationshipFieldNamePlural %>" :key="<%= relationshipFieldName %>.id">{{i > 0 ? ', ' : ''}}
<span v-for="(<%= relationshipFieldName %>, i) in <%= entityInstance %>.<%= relationshipFieldNamePlural %>" :key="<%= relationshipFieldName %>.<%= primaryKey.name %>">{{i > 0 ? ', ' : ''}}
mshima marked this conversation as resolved.
Show resolved Hide resolved
{{<%= relationshipFieldName %>.<%= otherEntityField %>}}
</span>
<%_ } else { _%>
{{<%= entityInstance + "." + relationshipFieldName %> ? <%= entityInstance + "." + relationshipFieldName + "." + otherEntityField%> : ''}}
<%_ } _%>
<%_ } else { _%>
<%_ if (relationship.relationshipManyToMany) { _%>
<span v-for="(<%= relationshipFieldName %>, i) in <%= entityInstance %>.<%= relationshipFieldNamePlural %>" :key="<%= relationshipFieldName %>.id">{{i > 0 ? ', ' : ''}}
<router-link :to="{name: '<%= otherEntityAngularName %>View', params: {<%= otherEntityName %>Id: <%= relationshipFieldName %>.id}}">{{<%= relationshipFieldName + "." + otherEntityField %>}}</router-link>
<span v-for="(<%= relationshipFieldName %>, i) in <%= entityInstance %>.<%= relationshipFieldNamePlural %>" :key="<%= relationshipFieldName %>.<%= primaryKey.name %>">{{i > 0 ? ', ' : ''}}
<router-link :to="{name: '<%= otherEntityAngularName %>View', params: {<%= otherEntityName %>Id: <%= relationshipFieldName %>.<%= primaryKey.name %>}}">{{<%= relationshipFieldName + "." + otherEntityField %>}}</router-link>
mshima marked this conversation as resolved.
Show resolved Hide resolved
</span>
<%_ } else { _%>
<div v-if="<%= entityInstance + '.' + relationshipFieldName %>">
<router-link :to="{name: '<%= otherEntityAngularName %>View', params: {<%= otherEntityName %>Id: <%= entityInstance + "." + relationshipFieldName %>.id}}">{{<%= entityInstance + "." + relationshipFieldName + "." + otherEntityField %>}}</router-link>
<router-link :to="{name: '<%= otherEntityAngularName %>View', params: {<%= otherEntityName %>Id: <%= entityInstance + "." + relationshipFieldName %>.<%= primaryKey.name %>}}">{{<%= entityInstance + "." + relationshipFieldName + "." + otherEntityField %>}}</router-link>
mshima marked this conversation as resolved.
Show resolved Hide resolved
</div>
<%_ } _%>
<%_ } _%>
Expand All @@ -77,7 +77,7 @@
<font-awesome-icon icon="arrow-left"></font-awesome-icon>&nbsp;<span v-text="t$('entity.action.back')"> Back</span>
</button>
<%_ if (!readOnly) { _%>
<router-link v-if="<%= entityInstance %>.id" :to="{name: '<%= entityAngularName %>Edit', params: {<%= entityInstance %>Id: <%= entityInstance %>.id}}" custom v-slot="{ navigate }">
<router-link v-if="<%= entityInstance %>.<%= primaryKey.name %>" :to="{name: '<%= entityAngularName %>Edit', params: {<%= entityInstance %>Id: <%= entityInstance %>.<%= primaryKey.name %>}}" custom v-slot="{ navigate }">
<button @click="navigate" class="btn btn-primary">
<font-awesome-icon icon="pencil-alt"></font-awesome-icon>&nbsp;<span v-text="t$('entity.action.edit')"> Edit</span>
</button>
Expand Down
4 changes: 2 additions & 2 deletions ...tes/src/main/webapp/app/entities/_entityFolder_/_entityFile_-update.component.spec.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ vitest.mock('vue-router', () => ({
useRouter: () => ({ go: routerGoMock }),
}));

const <%= entityInstance %>Sample = { id: <%- tsKeyId %> };
const <%= entityInstance %>Sample = { <%= primaryKey.name %>: <%- tsKeyId %> };

describe('Component Tests', () => {
let mountOptions: MountingOptions<<%= entityAngularName %>UpdateComponentType>['global'];
Expand Down Expand Up @@ -178,7 +178,7 @@ describe('Component Tests', () => {
// WHEN
route = {
params: {
<%= entityInstance %>Id: '' + <%= entityInstance %>Sample.<%- primaryKey.name %>,
<%= entityInstance %><%= primaryKey.nameCapitalized %>: '' + <%= entityInstance %>Sample.<%- primaryKey.name %>,
mshima marked this conversation as resolved.
Show resolved Hide resolved
},
};
const wrapper = shallowMount(<%= entityAngularName %>Update, { global: mountOptions });
Expand Down
16 changes: 8 additions & 8 deletions ...emplates/src/main/webapp/app/entities/_entityFolder_/_entityFile_-update.component.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ export default defineComponent({

const previousState = () => router.go(-1);

const retrieve<%= entityAngularName %> = async <%= entityInstance %>Id => {
const retrieve<%= entityAngularName %> = async <%= entityInstance %><%= primaryKey.nameCapitalized %> => {
try {
const res = await <%= entityInstance %>Service().find(<%= entityInstance %>Id);
const res = await <%= entityInstance %>Service().find(<%= entityInstance %><%= primaryKey.nameCapitalized %>);
<%_
for (field of fields.filter(field => !field.id)) {
const fieldName = field.fieldName;
Expand Down Expand Up @@ -190,15 +190,15 @@ _%>
const fieldName = field.fieldName;
const fieldType = field.fieldType;
} _%>
if (this.<%= entityInstance %>.id) {
if (this.<%= entityInstance %>.<%= primaryKey.name %>) {
this.<%= entityInstance %>Service().update(this.<%= entityInstance %>).then((param) => {
this.isSaving = false;
this.previousState();
this.alertService.showInfo(
<%_ if (enableTranslation) { _%>
this.t$('<%= i18nAlertHeaderPrefix %>.updated', { 'param' : param.id })
this.t$('<%= i18nAlertHeaderPrefix %>.updated', { 'param' : param.<%= primaryKey.name %> })
<%_ } else {_%>
'A <%= entityAngularName %> is updated with identifier ' + param.id
'A <%= entityAngularName %> is updated with identifier ' + param.<%= primaryKey.name %>
<%_ } _%>
);
}).catch(error => {
Expand All @@ -211,9 +211,9 @@ _%>
this.previousState();
this.alertService.showSuccess(
<%_ if (enableTranslation) { _%>
this.t$('<%= i18nAlertHeaderPrefix %>.created', { param: param.id }).toString()
this.t$('<%= i18nAlertHeaderPrefix %>.created', { param: param.<%= primaryKey.name %> }).toString()
<%_ } else {_%>
'A <%= entityAngularName %> is created with identifier ' + param.id
'A <%= entityAngularName %> is created with identifier ' + param.<%= primaryKey.name %>
<%_ } _%>
);
}).catch(error => {
Expand Down Expand Up @@ -242,7 +242,7 @@ _%>
<%_ if (relationshipsContainManyToOne) { _%>
getSelected(selectedVals, option) : any {
mshima marked this conversation as resolved.
Show resolved Hide resolved
if (selectedVals) {
return selectedVals.find(value => option.id === value.id) ?? option;
return selectedVals.find(value => option.<%= primaryKey.name %> === value.<%= primaryKey.name %>) ?? option;
mshima marked this conversation as resolved.
Show resolved Hide resolved
}
return option;
},
Expand Down
12 changes: 6 additions & 6 deletions ...ors/vue/templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_-update.vue.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<form name="editForm" role="form" novalidate v-on:submit.prevent="save()" >
<h2 id="<%= i18nKeyPrefix %>.home.createOrEditLabel" data-cy="<%= entityClass %>CreateUpdateHeading" v-text="t$('<%= i18nKeyPrefix %>.home.createOrEditLabel')">Create or edit a <%= entityAngularName %></h2>
<div>
<div class="form-group" v-if="<%= entityInstance %>.id">
<label for="id" v-text="t$('global.field.id')">ID</label>
<input type="text" class="form-control" id="id" name="id"
v-model="<%= entityInstance %>.id" readonly />
<div class="form-group" v-if="<%= entityInstance %>.<%= primaryKey.name %>">
<label for="id" v-text="t$('global.field.id')"><%= primaryKey.nameCapitalized %></label>
<input type="text" class="form-control" id="id" name="<%= primaryKey.name %>"
v-model="<%= entityInstance %>.<%= primaryKey.name %>" readonly />
</div>
<%_ for (field of fields.filter(field => !field.id)) {
const fieldName = field.fieldName;
Expand Down Expand Up @@ -139,14 +139,14 @@ _%>
<%_ } else { _%>
<option v-if="!<%= entityInstance %>.<%= relationshipName %>" v-bind:value="null" selected></option>
<%_ } _%>
<option v-bind:value="<%= entityInstance %>.<%=relationshipFieldName %> && <%=otherEntityName %>Option.id === <%= entityInstance %>.<%=relationshipFieldName %>.id ? <%= entityInstance %>.<%=relationshipFieldName %> : <%=otherEntityName %>Option" v-for="<%=otherEntityName %>Option in <%=otherEntityNamePlural %>" :key="<%=otherEntityName %>Option.id">{{<%=otherEntityName %>Option.<%=otherEntityField %>}}</option>
<option v-bind:value="<%= entityInstance %>.<%=relationshipFieldName %> && <%=otherEntityName %>Option.<%= primaryKey.name %> === <%= entityInstance %>.<%=relationshipFieldName %>.<%= primaryKey.name %> ? <%= entityInstance %>.<%=relationshipFieldName %> : <%=otherEntityName %>Option" v-for="<%=otherEntityName %>Option in <%=otherEntityNamePlural %>" :key="<%=otherEntityName %>Option.<%= primaryKey.name %>">{{<%=otherEntityName %>Option.<%=otherEntityField %>}}</option>
mshima marked this conversation as resolved.
Show resolved Hide resolved
</select>
</div>
<%_ } else if (relationship.persistableRelationship) { _%>
<div class="form-group">
<label v-text="t$('<%= translationKey %>')" for="<%= entityFileName %>-<%= relationshipName %>"><%= relationshipNameHumanized %></label>
<select class="form-control" id="<%= entityFileName %>-<%= relationshipFieldNamePlural %>" data-cy="<%= relationshipFieldName %>" multiple name="<%= relationshipName %>" v-if="<%=entityInstance %>.<%=relationshipFieldNamePlural %> !== undefined" v-model="<%=entityInstance %>.<%=relationshipFieldNamePlural %>"<% if (relationshipRequired) { %> required<% } %>>
<option v-bind:value="getSelected(<%=entityInstance %>.<%=relationshipFieldNamePlural %>, <%=otherEntityName %>Option)" v-for="<%=otherEntityName %>Option in <%=otherEntityNamePlural %>" :key="<%=otherEntityName %>Option.id">{{<%=otherEntityName %>Option.<%=otherEntityField %>}}</option>
<option v-bind:value="getSelected(<%=entityInstance %>.<%=relationshipFieldNamePlural %>, <%=otherEntityName %>Option)" v-for="<%=otherEntityName %>Option in <%=otherEntityNamePlural %>" :key="<%=otherEntityName %>Option.<%= primaryKey.name %>">{{<%=otherEntityName %>Option.<%=otherEntityField %>}}</option>
mshima marked this conversation as resolved.
Show resolved Hide resolved
</select>
</div>
<%_ } _%>
Expand Down
14 changes: 7 additions & 7 deletions .../templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_.component.spec.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ describe('Component Tests', () => {
describe('Mount', () => {
it('Should call load all on init', async () => {
// GIVEN
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ id: <%- tsKeyId %> }] });
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ <%= primaryKey.name %>: <%- tsKeyId %> }] });

// WHEN
const wrapper = shallowMount(<%= entityAngularName %>, { global: mountOptions });
Expand All @@ -95,7 +95,7 @@ describe('Component Tests', () => {

// THEN
expect(<%= entityInstance %>ServiceStub.retrieve.calledOnce).toBeTruthy();
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({id: <%- tsKeyId %>}));
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({<%= primaryKey.name %>: <%- tsKeyId %>}));
});
<%_ if (!paginationNo) { _%>

Expand Down Expand Up @@ -126,15 +126,15 @@ describe('Component Tests', () => {

it('should load a page', async () => {
// GIVEN
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ id: <%- tsKeyId %> }] });
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ <%= primaryKey.name %>: <%- tsKeyId %> }] });

// WHEN
comp.page = 2;
await comp.$nextTick();

// THEN
expect(<%= entityInstance %>ServiceStub.retrieve.called).toBeTruthy();
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({id: <%- tsKeyId %>}));
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({<%= primaryKey.name %>: <%- tsKeyId %>}));
});
<%_ if (!paginationInfiniteScroll) { _%>

Expand All @@ -152,7 +152,7 @@ describe('Component Tests', () => {
comp.page = 2;
await comp.$nextTick();
<%= entityInstance %>ServiceStub.retrieve.reset();
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ id: <%- tsKeyId %> }] });
<%= entityInstance %>ServiceStub.retrieve.resolves({ headers: {}, data: [{ <%= primaryKey.name %>: <%- tsKeyId %> }] });

// WHEN
comp.clear();
Expand All @@ -161,7 +161,7 @@ describe('Component Tests', () => {
// THEN
expect(comp.page).toEqual(1);
expect(<%= entityInstance %>ServiceStub.retrieve.callCount).toEqual(1);
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({id: <%- tsKeyId %>}));
expect(comp.<%= entityInstancePlural %>[0]).toEqual(expect.objectContaining({<%= primaryKey.name %>: <%- tsKeyId %>}));
});

it('should calculate the sort attribute for a non-id attribute', async () => {
Expand All @@ -182,7 +182,7 @@ describe('Component Tests', () => {
<%= entityInstance %>ServiceStub.delete.resolves({});

// WHEN
comp.prepareRemove({id: <%- tsKeyId %>});
comp.prepareRemove({<%= primaryKey.name %>: <%- tsKeyId %>});

comp.remove<%= entityAngularName %>();
await comp.$nextTick(); // clear components
Expand Down
2 changes: 1 addition & 1 deletion ...s/vue/templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_.component.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export default defineComponent({
const removeId: Ref<<%- primaryKey.tsType %>> = ref(null);
const removeEntity = ref<any>(null);
const prepareRemove = (instance: I<%= entityAngularName %>) => {
removeId.value = instance.id;
removeId.value = instance.<%= primaryKey.name %>;
removeEntity.value.show();
};
const closeDialog = () => {
Expand Down
2 changes: 1 addition & 1 deletion ...ue/templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_.service.spec.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ describe('Service Tests', () => {
<%_ if (!readOnly) { _%>
it('should create a <%= entityAngularName %>', async () => {
const returnedFromService = Object.assign({
id: <%- this.generateTestEntityId(primaryKey.type) %>,
<%= primaryKey.name %>: <%- this.generateTestEntityId(primaryKey.type) %>,
<%_ fields.filter(field => !field.id).forEach((field) => { _%>
<%_ if (field.fieldTypeLocalDate) { _%>
<%= field.fieldName%>: dayjs(currentDate).format(DATE_FORMAT),
Expand Down
8 changes: 4 additions & 4 deletions ...ors/vue/templates/src/main/webapp/app/entities/_entityFolder_/_entityFile_.service.ts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ export default class <%= entityAngularName %>Service {
}
<%_ } _%>

public find(id: <%- this.getTypescriptKeyType(primaryKey) %>) : Promise<I<%= entityAngularName %>> {
public find(<%= primaryKey.name %>: <%- this.getTypescriptKeyType(primaryKey) %>) : Promise<I<%= entityAngularName %>> {
return new Promise<I<%= entityAngularName %>>((resolve, reject) => {
axios.get(`${baseApiUrl}/${id}`).then(res => {
axios.get(`${baseApiUrl}/${<%= primaryKey.name %>}`).then(res => {
resolve(res.data);
}).catch(err => { reject(err); });
});
Expand All @@ -37,9 +37,9 @@ export default class <%= entityAngularName %>Service {
}
<%_ if (!readOnly) { _%>

public delete(id: <%- this.getTypescriptKeyType(primaryKey) %>) : Promise<any> {
public delete(<%= primaryKey.name %>: <%- this.getTypescriptKeyType(primaryKey) %>) : Promise<any> {
return new Promise<any>((resolve, reject) => {
axios.delete(`${baseApiUrl}/${id}`).then(res => {
axios.delete(`${baseApiUrl}/${<%= primaryKey.name %>}`).then(res => {
resolve(res);
}).catch(err => { reject(err); });
});
Expand Down
Loading