UI: Ember-data upgrade 5.3.2 prep: use custom service instead of exte…

…nding ember-data store (#28695) * rename store to pagination, remove store extension * initial update of service test * remove superfluous helper * replace store with pagination service in main app * update kmip engine syntax * add pagination to kmip engine * update to pagination in config-ui engine * update sync engine to use pagination service * use pagination service in kv engine * use pagination service in ldap engine * use pagination in pki engine * update renaming clearDataset functions * link to jira VAULT-31721 * remove comment
hashicorp · Oct 17, 2024 · 1fbbf9d · 1fbbf9d
1 parent f2041b0
commit 1fbbf9d
Show file tree

Hide file tree

Showing 58 changed files with 481 additions and 429 deletions.
diff --git a/ui/app/app.js b/ui/app/app.js
@@ -21,6 +21,7 @@ export default class App extends Application {
           'namespace',
           { 'app-router': 'router' },
           'store',
+          'pagination',
           'version',
           'custom-messages',
         ],
@@ -60,6 +61,7 @@ export default class App extends Application {
           'path-help',
           { 'app-router': 'router' },
           'store',
+          'pagination',
           'version',
           'secret-mount-path',
         ],
@@ -78,7 +80,14 @@ export default class App extends Application {
     },
     ldap: {
       dependencies: {
-        services: [{ 'app-router': 'router' }, 'store', 'secret-mount-path', 'flash-messages', 'auth'],
+        services: [
+          { 'app-router': 'router' },
+          'store',
+          'pagination',
+          'secret-mount-path',
+          'flash-messages',
+          'auth',
+        ],
         externalRoutes: {
           secrets: 'vault.cluster.secrets.backends',
         },
@@ -95,6 +104,7 @@ export default class App extends Application {
           { 'app-router': 'router' },
           'secret-mount-path',
           'store',
+          'pagination',
           'version',
         ],
         externalRoutes: {
@@ -114,6 +124,7 @@ export default class App extends Application {
           { 'app-router': 'router' },
           'secret-mount-path',
           'store',
+          'pagination',
           'version',
         ],
         externalRoutes: {
@@ -125,7 +136,7 @@ export default class App extends Application {
     },
     sync: {
       dependencies: {
-        services: ['flash-messages', 'flags', { 'app-router': 'router' }, 'store', 'version'],
+        services: ['flash-messages', 'flags', { 'app-router': 'router' }, 'store', 'pagination', 'version'],
         externalRoutes: {
           kvSecretOverview: 'vault.cluster.secrets.backend.kv.secret.index',
           clientCountOverview: 'vault.cluster.clients',

diff --git a/ui/app/components/console/ui-panel.js b/ui/app/components/console/ui-panel.js
@@ -28,7 +28,7 @@ export default Component.extend({
   console: service(),
   router: service(),
   controlGroup: service(),
-  store: service(),
+  pagination: service(),
   'data-test-component': 'console/ui-panel',
   attributeBindings: ['data-test-component'],
 
@@ -108,7 +108,7 @@ export default Component.extend({
     const currentRoute = owner.lookup(`router:main`).currentRouteName;
 
     try {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       yield this.router.transitionTo(currentRoute);
       this.logAndOutput(null, { type: 'success', content: 'The current screen has been refreshed!' });
     } catch (error) {

diff --git a/ui/app/components/generated-item-list.js b/ui/app/components/generated-item-list.js
@@ -26,13 +26,13 @@ import { tracked } from '@glimmer/tracking';
 
 export default class GeneratedItemList extends Component {
   @service router;
-  @service store;
+  @service pagination;
   @tracked itemToDelete = null;
 
   @action
   refreshItemList() {
     const route = getOwner(this).lookup(`route:${this.router.currentRouteName}`);
-    this.store.clearDataset();
+    this.pagination.clearDataset();
     route.refresh();
   }
 }
diff --git a/ui/app/components/keymgmt/distribute.js b/ui/app/components/keymgmt/distribute.js
@@ -37,6 +37,7 @@ const VALID_TYPES_BY_PROVIDER = {
   azurekeyvault: ['rsa-2048', 'rsa-3072', 'rsa-4096'],
 };
 export default class KeymgmtDistribute extends Component {
+  @service pagination;
   @service store;
   @service flashMessages;
   @service router;
@@ -191,7 +192,7 @@ export default class KeymgmtDistribute extends Component {
       .then(() => {
         this.flashMessages.success(`Successfully distributed key ${key} to ${provider}`);
         // update keys on provider model
-        this.store.clearDataset('keymgmt/key');
+        this.pagination.clearDataset('keymgmt/key');
         const providerModel = this.store.peekRecord('keymgmt/provider', provider);
         providerModel.fetchKeys(providerModel.keys?.meta?.currentPage || 1);
         this.args.onClose();

diff --git a/ui/app/mixins/unload-model-route.js b/ui/app/mixins/unload-model-route.js
@@ -5,10 +5,12 @@
 
 import Mixin from '@ember/object/mixin';
 import removeRecord from 'vault/utils/remove-record';
+import { service } from '@ember/service';
 
 // removes Ember Data records from the cache when the model
 // changes or you move away from the current route
 export default Mixin.create({
+  store: service(),
   modelPath: 'model',
   unloadModel() {
     const { modelPath } = this;

diff --git a/ui/app/models/keymgmt/provider.js b/ui/app/models/keymgmt/provider.js
@@ -44,7 +44,7 @@ const validations = {
 
 @withModelValidations(validations)
 export default class KeymgmtProviderModel extends Model {
-  @service store;
+  @service pagination;
   @attr('string') backend;
   @attr('string', {
     label: 'Provider name',
@@ -128,7 +128,7 @@ export default class KeymgmtProviderModel extends Model {
     } else {
       // try unless capabilities returns false
       try {
-        this.keys = await this.store.lazyPaginatedQuery('keymgmt/key', {
+        this.keys = await this.pagination.lazyPaginatedQuery('keymgmt/key', {
           backend: this.backend,
           provider: this.name,
           responsePath: 'data.keys',

diff --git a/ui/app/routes/vault/cluster/access/identity/aliases/index.js b/ui/app/routes/vault/cluster/access/identity/aliases/index.js
@@ -8,12 +8,12 @@ import ListRoute from 'core/mixins/list-route';
 import { service } from '@ember/service';
 
 export default Route.extend(ListRoute, {
-  store: service(),
+  pagination: service(),
 
   model(params) {
     const itemType = this.modelFor('vault.cluster.access.identity');
     const modelType = `identity/${itemType}-alias`;
-    return this.store
+    return this.pagination
       .lazyPaginatedQuery(modelType, {
         responsePath: 'data.keys',
         page: params.page,
@@ -38,12 +38,12 @@ export default Route.extend(ListRoute, {
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (!transition || transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },

diff --git a/ui/app/routes/vault/cluster/access/identity/index.js b/ui/app/routes/vault/cluster/access/identity/index.js
@@ -8,12 +8,12 @@ import ListRoute from 'core/mixins/list-route';
 import { service } from '@ember/service';
 
 export default Route.extend(ListRoute, {
-  store: service(),
+  pagination: service(),
 
   model(params) {
     const itemType = this.modelFor('vault.cluster.access.identity');
     const modelType = `identity/${itemType}`;
-    return this.store
+    return this.pagination
       .lazyPaginatedQuery(modelType, {
         responsePath: 'data.keys',
         page: params.page,
@@ -38,12 +38,12 @@ export default Route.extend(ListRoute, {
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },

diff --git a/ui/app/routes/vault/cluster/access/leases/list.js b/ui/app/routes/vault/cluster/access/leases/list.js
@@ -9,6 +9,7 @@ import Route from '@ember/routing/route';
 import { service } from '@ember/service';
 
 export default Route.extend({
+  pagination: service(),
   store: service(),
 
   queryParams: {
@@ -26,7 +27,7 @@ export default Route.extend({
     const prefix = params.prefix || '';
     if (this.modelFor('vault.cluster.access.leases').canList) {
       return hash({
-        leases: this.store
+        leases: this.pagination
           .lazyPaginatedQuery('lease', {
             prefix,
             responsePath: 'data.keys',
@@ -104,7 +105,7 @@ export default Route.extend({
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },

diff --git a/ui/app/routes/vault/cluster/access/method/item/list.js b/ui/app/routes/vault/cluster/access/method/item/list.js
@@ -9,7 +9,7 @@ import { singularize } from 'ember-inflector';
 import ListRoute from 'vault/mixins/list-route';
 
 export default Route.extend(ListRoute, {
-  store: service(),
+  pagination: service(),
   pathHelp: service('path-help'),
 
   getMethodAndModelInfo() {
@@ -25,7 +25,7 @@ export default Route.extend(ListRoute, {
     const { page, pageFilter } = this.paramsFor(this.routeName);
     const modelType = `generated-${singularize(itemType)}-${type}`;
 
-    return this.store
+    return this.pagination
       .lazyPaginatedQuery(modelType, {
         responsePath: 'data.keys',
         page: page,
@@ -46,12 +46,12 @@ export default Route.extend(ListRoute, {
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },

diff --git a/ui/app/routes/vault/cluster/access/namespaces/index.js b/ui/app/routes/vault/cluster/access/namespaces/index.js
@@ -8,6 +8,7 @@ import Route from '@ember/routing/route';
 import UnloadModel from 'vault/mixins/unload-model-route';
 
 export default Route.extend(UnloadModel, {
+  pagination: service(),
   store: service(),
 
   queryParams: {
@@ -27,7 +28,7 @@ export default Route.extend(UnloadModel, {
 
   model(params) {
     if (this.version.hasNamespaces) {
-      return this.store
+      return this.pagination
         .lazyPaginatedQuery('namespace', {
           responsePath: 'data.keys',
           page: Number(params?.page) || 1,
@@ -74,12 +75,12 @@ export default Route.extend(UnloadModel, {
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (!transition || transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },

diff --git a/ui/app/routes/vault/cluster/policies/index.js b/ui/app/routes/vault/cluster/policies/index.js
@@ -9,7 +9,7 @@ import ClusterRoute from 'vault/mixins/cluster-route';
 import ListRoute from 'core/mixins/list-route';
 
 export default Route.extend(ClusterRoute, ListRoute, {
-  store: service(),
+  pagination: service(),
   version: service(),
 
   shouldReturnEmptyModel(policyType, version) {
@@ -21,7 +21,7 @@ export default Route.extend(ClusterRoute, ListRoute, {
     if (this.shouldReturnEmptyModel(policyType, this.version)) {
       return;
     }
-    return this.store
+    return this.pagination
       .lazyPaginatedQuery(`policy/${policyType}`, {
         page: params.page,
         pageFilter: params.pageFilter,
@@ -65,12 +65,12 @@ export default Route.extend(ClusterRoute, ListRoute, {
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (!transition || transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },

diff --git a/ui/app/routes/vault/cluster/secrets/backend/list.js b/ui/app/routes/vault/cluster/secrets/backend/list.js
@@ -30,6 +30,7 @@ function getValidPage(pageParam) {
 }
 
 export default Route.extend({
+  pagination: service(),
   store: service(),
   templateName: 'vault/cluster/secrets/backend/list',
   pathHelp: service('path-help'),
@@ -131,7 +132,7 @@ export default Route.extend({
 
     return hash({
       secret,
-      secrets: this.store
+      secrets: this.pagination
         .lazyPaginatedQuery(modelType, {
           id: secret,
           backend,
@@ -163,7 +164,7 @@ export default Route.extend({
     const has404 = this.has404;
     // only clear store cache if this is a new model
     if (secret !== controller?.baseKey?.id) {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
     }
     controller.set('hasModel', true);
     controller.setProperties({
@@ -220,12 +221,12 @@ export default Route.extend({
     willTransition(transition) {
       window.scrollTo(0, 0);
       if (transition.targetName !== this.routeName) {
-        this.store.clearDataset();
+        this.pagination.clearDataset();
       }
       return true;
     },
     reload() {
-      this.store.clearDataset();
+      this.pagination.clearDataset();
       this.refresh();
     },
   },