feat: get stream rfcs were first published into

ietf/api/urls_rpc.py

@@ -9,6 +9,7 @@
     url(r"^doc/drafts/(?P<doc_id>[0-9]+)$", views_rpc.rpc_draft),
     url(r"^doc/drafts_by_names/", views_rpc.drafts_by_names),
     url(r"^doc/submitted_to_rpc/$", views_rpc.submitted_to_rpc),
+    url(r"^doc/rfc/original_stream/$", views_rpc.rfc_original_stream),
     url(r"^person/create_demo_person/$", views_rpc.create_demo_person),
     url(r"^person/(?P<person_id>[0-9]+)$", views_rpc.rpc_person),
     url(r"^persons/$", views_rpc.rpc_persons),

ietf/api/views_rpc.py

@@ -2,7 +2,7 @@
 
 import json
 
-from django.db.models import Q
+from django.db.models import OuterRef, Subquery, Q
 from django.http import (
     HttpResponse,
     HttpResponseBadRequest,
@@ -15,19 +15,23 @@
 from django.contrib.auth.models import User
 
 from ietf.api.ietf_utils import requires_api_token
-from ietf.doc.factories import WgDraftFactory # DO NOT MERGE INTO MAIN
-from ietf.doc.models import Document
-from ietf.person.factories import PersonFactory # DO NOT MERGE INTO MAIN
+from ietf.doc.factories import WgDraftFactory  # DO NOT MERGE INTO MAIN
+from ietf.doc.models import Document, DocHistory
+from ietf.person.factories import PersonFactory  # DO NOT MERGE INTO MAIN
 from ietf.person.models import Person
 
+
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
 def rpc_person(request, person_id):
     person = get_object_or_404(Person, pk=person_id)
-    return JsonResponse({
-        "id": person.id,
-        "plain_name": person.plain_name(),
-    })
+    return JsonResponse(
+        {
+            "id": person.id,
+            "plain_name": person.plain_name(),
+        }
+    )
+
 
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
@@ -36,52 +40,59 @@ def rpc_subject_person(request, subject_id):
         user_id = int(subject_id)
     except ValueError:
         return JsonResponse({"error": "Invalid subject id"}, status=400)
-    try:   
+    try:
         user = User.objects.get(pk=user_id)
     except User.DoesNotExist:
         return JsonResponse({"error": "Unknown subject"}, status=404)
-    if hasattr(user, "person"):  # test this way to avoid exception on reverse OneToOneField        
+    if hasattr(
+        user, "person"
+    ):  # test this way to avoid exception on reverse OneToOneField
         return rpc_person(request, person_id=user.person.pk)
-    return JsonResponse({"error": "Subject has no person"}, status=404) 
+    return JsonResponse({"error": "Subject has no person"}, status=404)
 
 
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
 def rpc_persons(request):
-    """ Get a batch of rpc person names"""
+    """Get a batch of rpc person names"""
     if request.method != "POST":
         return HttpResponseNotAllowed(["POST"])
-    
+
     pks = json.loads(request.body)
     response = dict()
     for p in Person.objects.filter(pk__in=pks):
         response[str(p.pk)] = p.plain_name()
     return JsonResponse(response)
 
+
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
 def rpc_draft(request, doc_id):
     if request.method != "GET":
         return HttpResponseNotAllowed(["GET"])
-    
+
     try:
         d = Document.objects.get(pk=doc_id, type_id="draft")
     except Document.DoesNotExist:
         return HttpResponseNotFound()
-    return JsonResponse({
-        "id": d.pk,
-        "name": d.name,
-        "rev": d.rev,
-        "stream": d.stream.slug,
-        "title": d.title,
-        "pages": d.pages,
-        "authors": [
-            {
-                "id": p.pk,
-                "plain_name": p.person.plain_name(),
-            } for p in d.documentauthor_set.all()
-        ]
-    })
+    return JsonResponse(
+        {
+            "id": d.pk,
+            "name": d.name,
+            "rev": d.rev,
+            "stream": d.stream.slug,
+            "title": d.title,
+            "pages": d.pages,
+            "authors": [
+                {
+                    "id": p.pk,
+                    "plain_name": p.person.plain_name(),
+                }
+                for p in d.documentauthor_set.all()
+            ],
+        }
+    )
+
 
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
@@ -92,7 +103,7 @@ def drafts_by_names(request):
         names = json.loads(request.body)
     except json.JSONDecodeError:
         return HttpResponseBadRequest()
-    docs = Document.objects.filter(type_id="draft",name__in=names)
+    docs = Document.objects.filter(type_id="draft", name__in=names)
     response = dict()
     for doc in docs:
         response[doc.name] = {
@@ -106,50 +117,91 @@ def drafts_by_names(request):
                 {
                     "id": p.pk,
                     "plain_name": p.person.plain_name(),
-                } for p in doc.documentauthor_set.all()
-            ]
+                }
+                for p in doc.documentauthor_set.all()
+            ],
         }
     return JsonResponse(response)
 
+
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
 def submitted_to_rpc(request):
-    """ Return documents in datatracker that have been submitted to the RPC but are not yet in the queue
-    
+    """Return documents in datatracker that have been submitted to the RPC but are not yet in the queue
+
     Those queries overreturn - there may be things, particularly not from the IETF stream that are already in the queue.
     """
-    ietf_docs = Q(states__type_id="draft-iesg",states__slug__in=["ann"])
-    irtf_iab_ise_docs = Q(states__type_id__in=["draft-stream-iab","draft-stream-irtf","draft-stream-ise"],states__slug__in=["rfc-edit"])
-    #TODO: Need a way to talk about editorial stream docs
-    docs = Document.objects.filter(type_id="draft").filter(ietf_docs|irtf_iab_ise_docs)
+    ietf_docs = Q(states__type_id="draft-iesg", states__slug__in=["ann"])
+    irtf_iab_ise_docs = Q(
+        states__type_id__in=[
+            "draft-stream-iab",
+            "draft-stream-irtf",
+            "draft-stream-ise",
+        ],
+        states__slug__in=["rfc-edit"],
+    )
+    # TODO: Need a way to talk about editorial stream docs
+    docs = Document.objects.filter(type_id="draft").filter(
+        ietf_docs | irtf_iab_ise_docs
+    )
     response = {"submitted_to_rpc": []}
     for doc in docs:
-        response["submitted_to_rpc"].append({"name":doc.name, "pk": doc.pk, "stream": doc.stream_id, "submitted": f"{doc.sent_to_rfc_editor_event().time:%Y-%m-%d}"}) #TODO reconcile timezone
+        response["submitted_to_rpc"].append(
+            {
+                "name": doc.name,
+                "pk": doc.pk,
+                "stream": doc.stream_id,
+                "submitted": f"{doc.sent_to_rfc_editor_event().time:%Y-%m-%d}",
+            }
+        )  # TODO reconcile timezone
 
     return JsonResponse(response)
 
 
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
-def create_demo_person(request):
-    """ Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION
+def rfc_original_stream(request):
+    """Return the stream that an rfc was first published into for all rfcs"""
+    rfcs = Document.objects.filter(type="rfc").annotate(
+        orig_stream_id=Subquery(
+            DocHistory.objects.filter(doc=OuterRef("pk"))
+            .exclude(stream__isnull=True)
+            .order_by("time")
+            .values_list("stream_id", flat=True)[:1]
+        )
+    )
+    response = {"original_stream": []}
+    for rfc in rfcs:
+        response["original_stream"].append(
+            {
+                "rfc_number": rfc.rfc_number,
+                "stream": (
+                    rfc.orig_stream_id
+                    if rfc.orig_stream_id is not None
+                    else rfc.stream_id
+                ),
+            }
+        )
+    return JsonResponse(response)
 
-    """
+
+@csrf_exempt
+@requires_api_token("ietf.api.views_rpc")
+def create_demo_person(request):
+    """Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION"""
     if request.method != "POST":
         return HttpResponseNotAllowed(["POST"])
-    
+
     request_params = json.loads(request.body)
     name = request_params["name"]
     person = Person.objects.filter(name=name).first() or PersonFactory(name=name)
-    return JsonResponse({"user_id":person.user.pk,"person_pk":person.pk})
+    return JsonResponse({"user_id": person.user.pk, "person_pk": person.pk})
 
 
 @csrf_exempt
 @requires_api_token("ietf.api.views_rpc")
 def create_demo_draft(request):
-    """ Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION
-
-    """
+    """Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION"""
     if request.method != "POST":
         return HttpResponseNotAllowed(["POST"])
 
@@ -168,8 +220,14 @@ def create_demo_draft(request):
             kwargs["states"] = states
         if rev:
             kwargs["rev"] = rev
-        doc = WgDraftFactory(**kwargs) # Yes, things may be a little strange if the stream isn't IETF, but until we nned something different...
+        doc = WgDraftFactory(
+            **kwargs
+        )  # Yes, things may be a little strange if the stream isn't IETF, but until we nned something different...
         event_type = "iesg_approved" if stream_id == "ietf" else "requested_publication"
-        if not doc.docevent_set.filter(type=event_type).exists(): # Not using get_or_create here on purpose - these are wobbly facades we're creating
-            doc.docevent_set.create(type=event_type, by_id=1, desc="Sent off to the RPC")
-    return JsonResponse({ "doc_id":doc.pk, "name":doc.name })
+        if not doc.docevent_set.filter(
+            type=event_type
+        ).exists():  # Not using get_or_create here on purpose - these are wobbly facades we're creating
+            doc.docevent_set.create(
+                type=event_type, by_id=1, desc="Sent off to the RPC"
+            )
+    return JsonResponse({"doc_id": doc.pk, "name": doc.name})

rpcapi.yaml

@@ -172,7 +172,20 @@ paths:
                             schema:
                                 type: object
                                 additionalProperties:
-                                    $ref:'#/components/schemas/Draft'          
+                                    $ref:'#/components/schemas/Draft'
+
+    /doc/rfc/original_stream/:
+        get:
+            operationId: get_rfc_original_streams
+            summary: Get the streams rfcs were originally published into
+            description: returns a list of dicts associating an rfc with its originally published stream
+            responses:
+                '200':
+                    description: OK
+                    content:
+                        application/json:
+                            schema:
+                                $ref: '#/components/schemas/OriginalStream'   
 
     /subject/{subjectId}/person:
         get:
@@ -262,6 +275,18 @@ components:
                     items:
                         $ref: '#/components/schemas/Person'
 
+        OriginalStream:
+            type: object
+            properties:
+                original_stream:
+                    type: list
+                    items:
+                        properties:
+                            rfc_number:
+                                type: integer
+                            stream:
+                                type: string
+
     securitySchemes: 
         ApiKeyAuth:
             type: apiKey