Skip to content

fixing model updates related to secret handling after prepare model action #63

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 2 commits into from
Jan 3, 2022
Merged

fixing model updates related to secret handling after prepare model action #63

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
ad46fcc
fixing model updates related to secret handling after prepare model a…
robertpatrick Dec 29, 2021
9aa1b37
removing internal url from package-lock.json
robertpatrick Dec 30, 2021
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: 2 additions & 0 deletions electron/app/locales/en/webui.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,8 @@
"ingress-design-add-route-label": "Add Route",
"ingress-design-edit-route-label": "Edit Route",
"ingress-design-delete-route-label": "Delete Route",
"ingress-design-delete-route-warning-title": "Deleting Ingress Route",
"ingress-design-delete-route-warning-message": "Ingress route is only deleted from the table. If it already exists in the Kubernetes cluster, you must manually delete it from the cluster",

"ingress-installer-aborted-error-title": "Ingress Controller Installation Aborted",
"ingress-installer-not-install-message": "The Install Ingress Controller option is off so there is nothing to do.",
Expand Down
9 changes: 4 additions & 5 deletions webui/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 19 additions & 4 deletions webui/src/js/models/k8s-domain-definition.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut

// update the secrets list when any model content changes.
wdtModel.modelContentChanged.subscribe(() => {
wktLogger.debug('modelContentChanged event calling updateSecrets()');
this.updateSecrets();
});

Expand Down Expand Up @@ -132,15 +133,20 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut
};

this.setCredentialPathsForSecretsTable = (json) => {
wktLogger.debug('entering setCredentialPathsForSecretsTable() with secrets table length = %s', this.secrets.value.length);
if (this.secrets.value.length > 0) {
if (!json.credentialPaths) {
wktLogger.debug('creating credentialPaths array');
json.credentialPaths = [];
}
for (const secret of this.secrets.value) {
wktLogger.debug('working on secret path %s', `${name}.secrets.${secret.uid}`);
if (secret.username) {
wktLogger.debug('setting secret %s', `${name}.secrets.${secret.uid}.username`);
json.credentialPaths.push(`${name}.secrets.${secret.uid}.username`);
}
if (secret.password) {
wktLogger.debug('setting secret %s', `${name}.secrets.${secret.uid}.password`);
json.credentialPaths.push(`${name}.secrets.${secret.uid}.password`);
}
}
Expand Down Expand Up @@ -207,10 +213,18 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut

this.handlePrepareModelSecrets = (secrets) => {
if (secrets && secrets.secrets && secrets.secrets.length) {
wktLogger.debug('handlePrepareModelSecrets() working on %d secrets', secrets.secrets.length);
for (const secret of secrets.secrets) {
const existingSecretObject = findSecretByName(secret.name, this.secrets.observable());
wktLogger.debug('working on secret %s', secret.name);

// The secret should always exist already because prepare model updated the model first,
// which triggers updating the secrets ListProperty. If not, something is broken...
//
const existingSecretObject = findSecretByName(this.uid.value, secret.name, this.secrets.observable());
updateSecretFromPrepareModelResults(existingSecretObject, secret.keys);
}
} else {
wktLogger.debug('handlePrepareModelSecrets() has nothing to do');
}
};

Expand All @@ -222,7 +236,7 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut

this.getFieldValueFromExistingSecrets = (uid, fieldName, defaultValue) => {
let result = defaultValue;
for (const domainSecret of this.secrets.value) {
for (const domainSecret of this.secrets.observable()) {
if (domainSecret.uid === uid) {
if (domainSecret[fieldName]) {
result = domainSecret[fieldName];
Expand Down Expand Up @@ -269,10 +283,11 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut
}
}

function findSecretByName(secretName, secretsList) {
function findSecretByName(domainUid, secretName, secretsList) {
let result;
const domainQualifiedSecretName = `${domainUid}-${secretName}`;
for (const secret of secretsList) {
if (secret.name === secretName) {
if (secret.name === domainQualifiedSecretName || secret.name === secretName) {
result = secret;
break;
}
Expand Down
31 changes: 27 additions & 4 deletions webui/src/js/models/wdt-model-definition.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,24 @@ define(['knockout', 'utils/observable-properties', 'js-yaml', 'utils/validation-
const secretName = matches.groups.name;
const secretEnvVar = matches.groups.envvar;
const secretField = matches.groups.field;

const secretKey = secretEnvVar ? `${secretEnvVar}-${secretName}` : secretName;
wktLogger.debug('found matching secret %s with envVar = %s and field = %s', secretName, secretEnvVar, secretField);

// While this key is never used outside this function, we need the key to
// match the resolved secret name. For example, if the DOMAIN_UID is mydomain,
// the following two secret fields should be part of the same secret:
//
// JDBCDriverParams:
// URL: '@@PROP:JDBC.myds.URL@@'
// PasswordEncrypted: '@@SECRET:@@ENV:DOMAIN_UID@@-jdbc-myds:password@@'
// DriverName: com.mysql.cj.jdbc.Driver
// Properties:
// user:
// Value: '@@SECRET:mydomain-jdbc-myds:username@@'
//
let secretKey = secretName;
if (secretEnvVar) {
secretKey = secretName.startsWith('-') ? `${secretEnvVar}${secretName}` : `${secretEnvVar}-${secretName}`;
}

let secretData;
if (secretsMap.has(secretKey)) {
Expand All @@ -125,6 +141,8 @@ define(['knockout', 'utils/observable-properties', 'js-yaml', 'utils/validation-
}
secretData[secretField] = '';
secretsMap.set(secretKey, secretData);
} else {
wktLogger.debug('skipping matching secret %s', matches.groups.name);
}
});
return [...secretsMap.values()];
Expand Down Expand Up @@ -287,14 +305,19 @@ define(['knockout', 'utils/observable-properties', 'js-yaml', 'utils/validation-
*/
this.setModelFileContents = modelContent => {
this.modelFileContents = {};
this.modelContent('');

const models = modelContent['models'];
if(models) {
if (models) {
for (const [file, contents] of Object.entries(models)) {
this.recordModelFile(file, contents);
}
this.modelContent(this.getCurrentModelFileContents() || '');
} else {
// Only empty the model content where explicitly told to do so
// since setting this field generates an event that triggers
// other code to run (e.g., k8s-domain-definition.updateSecrets()).
//
this.modelContent('');
}
};

Expand Down
4 changes: 2 additions & 2 deletions webui/src/js/utils/observable-properties.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,8 +438,8 @@ define(['knockout', 'utils/common-utilities', 'utils/validation-helper', 'utils/
}
}

addNewItem() {
this.observable.push(this.createArrayItem(this, arguments.length === 0 ? {} : arguments[0]));
addNewItem(item) {
this.observable.push(this.createArrayItem(this, !!item ? item : {}));
}

get observable() {
Expand Down
5 changes: 2 additions & 3 deletions webui/src/js/viewModels/ingress-design-view-impl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,8 @@ function(i18n, accUtils, ko, ArrayDataProvider, BufferingDataProvider, project,
this.handleDeleteRoute = (event, context) => {
const index = context.item.index;
this.routes.observable.splice(index, 1);
const title = i18n.t('ingress-installer-delete-route-warning-title');
const message = i18n.t('ingress-installer-delete-route-warning-message');
const title = i18n.t('ingress-design-delete-route-warning-title');
const message = i18n.t('ingress-design-delete-route-warning-message');
window.api.ipc.invoke('show-error-message', title, message);
};

Expand Down Expand Up @@ -235,7 +235,6 @@ function(i18n, accUtils, ko, ArrayDataProvider, BufferingDataProvider, project,
this.getEnabledText = (value) => {
return this.anyLabelMapper(value ? 'dialog-button-yes' : 'dialog-button-no');
};

}

/*
Expand Down