Show links to the RFC-Ed and Auth-48 pages when the document is in the right states

[ietf-svn-bot]

owner:jennifer@painless-security.com resolution_fixed type_enhancement | by rjsparks@nostrum.com

---

When a document is in an RFC-Editor state, add links to the RFC-Ed and Auth-48 pages next to the state.

---

Issue migrated from trac:2722 at 2022-03-04 07:10:54 +0000

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

A few questions to get oriented on this:

Is this referring to the draft page (/doc/<draft-name>/)?

What URL is meant by "to the RFC-Ed"? There seems to be a link to the RFC editor queue (of the form https://www.rfc-editor.org/queue2.html#<draft-name>) as "EDIT" in the RFC Editor. Is there a different link needed?

It looks to me like the Auth-48 URL is recognized when the RFC editor status is parsed, added to a StateDocEvent description, then otherwise discarded. I guess this needs to be persisted (or parsed back out of the event description later, but that feels fragile). I see there is a DocumentURL class attached to documents that seems to be intended to capture miscellaneous links; would it be appropriate to persist the Auth-48 URL in a new type of DocumentURL?

If so, I guess the URL could be parsed out of the StateDocEvent for existing documents unless there's a way to construct or retrieve these on demand. Is that needed, or are these things ephemeral enough that existing documents in that state can be left alone?

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

Yes, it's referring to /doc/

The link to to queue2.html# is a good start. I remembered there being a document specific page, but I can't find it now.

The AUTH-48 URL is only valid while the document is in AUTH48 (it is ephemeral as you note). I would rather go with having the URL land in a DocEvent instead of a !DocumentURL. Perhaps what should be dropped is a Auth48DocStateEvent (extending StateDocEvent). Code could then see if the most recent Auth48DocStateEvent was the current rfc-editor StateDocEvent, using latest_event on Document.

We already have, for example:

In 3598137fef9a41f40f0b5b6fa31667d73b2307ca: d = Document.objects.get(name='draft-kanugovi-intarea-mams-framework')
In dc22fb842160a0c0387457a61838e807e01c8c4a: d.latest_event(StateDocEvent, state_type='draft-rfceditor').state
Outdc22fb842160a0c0387457a61838e807e01c8c4a: <State: AUTH48>

so I could see something like

    if d.latest_event(Auth48StateDocEvent)==d.latest_event(StateDocEvent, state_type='draft-rfceditor'):

being used to determine if the doc is currently in AUTH48.

The link to that AUTH48 URL should only be shown while the document is actually in AUTH48.

It would be nice if a migration populated this for existing docs in the auth48 state at the time of migration, but if that gets far to messy, we can let the feature age-in.

[ietf-svn-bot]

@rjsparks@nostrum.com changed status from new to assigned

[ietf-svn-bot]

@rjsparks@nostrum.com changed owner from `` to jennifer@painless-security.com

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

In the RFC editor queue XML, it seems that both 'AUTH48' and 'AUTH48-DONE' entries have auth48 URLs. Should this link be shown when in the 'AUTH48-DONE' state, or only 'AUTH48'?

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

Both is fine to start with

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

What about long term? :-)

I got this working for AUTH48 states only before noticing that the AUTH48-DONE state also has the URL, so if that's ultimately preferable behavior, it's actually easier.

It also seems that the URL is dead for the one doc showing up in the AUTH48-DONE state.

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

Go with the path of least resistance (i.e. what you already have). We can change things, if needed, based on feedback once people start seeing these.

I expect that we'll see some pressure on how the auth48 pages are maintained (and exposed) based on how this gets used.

[ietf-svn-bot]

@jennifer@painless-security.com changed status from assigned to closed

[ietf-svn-bot]

@jennifer@painless-security.com changed resolution from `` to fixed

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

Fixed in 0b12481:

Store Auth48 URL during rfceditor import and display when doc in RFC-Editor state. Migrates old data when URL available. Fixes #2722; Commit ready for merge.

[ietf-svn-bot]

@rjsparks@nostrum.com changed status from closed to reopened

[ietf-svn-bot]

@rjsparks@nostrum.com changed resolution from fixed to ``

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

Hi Jennifer -

During merge review, Henrik convinced me that we should change direction on how we solved this. The extension of StateDocEvent is likely to become problematic in the long run (the extra joins that come from Docevent<-StateDocEvent<-Auth48StateDocEvent is what caught his eye).

Your original suggestion is closer to what we should do for now. Could we please rework this so that we're just adding StateDocEvents and when the URL comes into existence, store it as a DocumentURL, and when we leave the AUTH48 state, remove the DocumentURL?

I can set up a bridge if we need to talk about this. Please don't let it interrupt what you have currently underway - it can go in the queue again.

[ietf-svn-bot]

@jennifer@painless-security.com changed status from reopened to closed