chore: 🤖 tweak oidc attributes serialization

addons/api/addon/models/fragment-auth-method-attributes.js

@@ -9,10 +9,10 @@ export default class FragmentAuthMethodAttributesModel extends Fragment {
   @attr('string') issuer;
   @attr('string') client_id;
   @attr('string') client_secret;
-  @attr('string') client_secret_hmac;
+  @attr('string', { readOnly: true }) client_secret_hmac;
   @attr('number') max_age;
   @attr('string') api_url_prefix;
-  @attr('string') callback_url;
+  @attr('string', { readOnly: true }) callback_url;
   @attr('boolean') disable_discovered_config_validation;
   @attr('boolean') dry_run;
 

addons/api/addon/serializers/fragment-auth-method-attributes.js

@@ -0,0 +1,26 @@
+import JSONSerializer from '@ember-data/serializer/json';
+
+export default class FragmentAuthMethodAttributesSerializer extends JSONSerializer {
+  /**
+   * If an attribute is annotated as readOnly in the model, don't serialize it.
+   * Otherwise delegate to default attribute serializer.
+   *
+   * @override
+   * @method serializeAttribute
+   * @param {Snapshot} snapshot
+   * @param {Object} json
+   * @param {String} key
+   * @param {Object} attribute
+   */
+  serializeAttribute(snapshot, json, key, attribute) {
+    const { type, options } = attribute;
+    let value = super.serializeAttribute(...arguments);
+    // Convert empty strings to null.
+    if (type === 'string' && json[key] === '') json[key] = null;
+    // Do not serialize read-only attributes.
+    if (options.readOnly) delete json[key];
+    // Client secret cannot be unset.  If it's falsy, it must be removed.
+    if (key === 'client_secret' && !json[key]) delete json[key];
+    return value;
+  }
+}

addons/api/app/serializers/fragment-auth-method-attributes.js

@@ -0,0 +1 @@
+export { default } from 'api/serializers/fragment-auth-method-attributes';

addons/api/mirage/generated/factories/auth-method.js

@@ -23,6 +23,8 @@ export default Factory.extend({
           client_id: 'YTwdJBB55LpKnuXb9n65',
           client_secret_hmac: 'GY7blb4ynM5TEPNi_qnphJ9aDWhW8FpmN3D-eP_L7Zk',
           issuer: 'http://127.0.0.1:57070',
+          max_age: 1800,
+          disable_discovered_config_validation: false,
           state: 'active-public',
           account_claim_maps: ['oid=sub', 'full_name=name'],
           claims_scopes: ['profile', 'email'],

addons/api/package.json

@@ -28,7 +28,7 @@
     "ember-cli-htmlbars": "^5.3.1",
     "ember-cli-mirage": "^1.1.8",
     "ember-data": "^3.20.0",
-    "ember-data-model-fragments": "5.0.0-beta.0",
+    "ember-data-model-fragments": "5.0.0-beta.2",
     "ember-fetch": "^8.0.1"
   },
   "devDependencies": {

addons/api/tests/unit/serializers/auth-method-test.js

@@ -47,6 +47,13 @@ module('Unit | Serializer | auth method', function (hooks) {
           { value: 'certificate-1234' },
           { value: 'certificate-5678' },
         ],
+        api_url_prefix: 'protocol://host:port/foo',
+        client_id: 'id123',
+        client_secret: 'secret456',
+        disable_discovered_config_validation: true,
+        dry_run: true,
+        issuer: 'http://www.example.net',
+        max_age: 500,
       },
     });
 
@@ -62,15 +69,13 @@ module('Unit | Serializer | auth method', function (hooks) {
         signing_algorithms: ['RS256', 'RS384'],
         allowed_audiences: ['www.alice.com', 'www.alice.com/admin'],
         idp_ca_certs: ['certificate-1234', 'certificate-5678'],
-        api_url_prefix: null,
-        callback_url: null,
-        client_id: null,
-        client_secret: null,
-        client_secret_hmac: null,
-        disable_discovered_config_validation: false,
-        dry_run: false,
-        issuer: null,
-        max_age: null,
+        api_url_prefix: 'protocol://host:port/foo',
+        client_id: 'id123',
+        client_secret: 'secret456',
+        disable_discovered_config_validation: true,
+        dry_run: true,
+        issuer: 'http://www.example.net',
+        max_age: 500,
       },
     });
   });

addons/api/tests/unit/serializers/fragment-auth-method-attributes-test.js

@@ -0,0 +1,37 @@
+import { module, test } from 'qunit';
+import { setupTest } from 'ember-qunit';
+
+module('Unit | Serializer | fragment auth method attributes', function (hooks) {
+  setupTest(hooks);
+
+  test('it serializes empty strings to null', function (assert) {
+    assert.expect(1);
+    const store = this.owner.lookup('service:store');
+    const record = store.createRecord('user', {
+      name: '',
+      description: '',
+      version: null,
+    });
+    let serializedRecord = record.serialize();
+    assert.deepEqual(serializedRecord, {
+      name: null,
+      description: null,
+    });
+  });
+
+  test('it does not serialize client_secret if present but falsy', function (assert) {
+    assert.expect(1);
+    const store = this.owner.lookup('service:store');
+    const record = store.createRecord('user', {
+      name: '',
+      description: '',
+      version: null,
+      client_secret: false,
+    });
+    let serializedRecord = record.serialize();
+    assert.deepEqual(serializedRecord, {
+      name: null,
+      description: null,
+    });
+  });
+});